명명 충돌을 피하는 C 프로젝트

중형 C 라이브러리 프로젝트의 함수 명명 규칙에 대한 실용적인 실제 조언을 찾기 위해 고심하고 있습니다. 내 라이브러리 프로젝트는 자체 헤더가있는 몇 개의 모듈과 하위 모듈로 구분되며 OO 스타일을 느슨하게 따릅니다 (모든 함수는 전역을 제외하고 특정 인수를 첫 번째 인수로 사용합니다). 그것은 우리에게 다음과 같은 것을 놓았습니다.

MyLib
  - Foo
    - foo.h
    - foo_internal.h
    - some_foo_action.c
    - another_foo_action.c
    - Baz
      - baz.h
      - some_baz_action.c
  - Bar
    - bar.h
    - bar_internal.h
    - some_bar_action.c

일반적으로 기능 (예를 들어) 스틱 너무 크다 some_foo_action과 another_foo_action하나 개 foo.c, 구현 파일 대부분의 기능 정적을하고, 하루에 전화.

클라이언트 프로그램과 사용자의 충돌을 피하기 위해 라이브러리를 빌드 할 때 내부 ( "모듈 개인") 심볼을 제거 할 수 있지만 문제는 라이브러리에서 심볼의 이름을 지정하는 방법입니다. 지금까지 나는하고있다 :

struct MyLibFoo;
void MyLibFooSomeAction(MyLibFoo *foo, ...);

struct MyLibBar;
void MyLibBarAnAction(MyLibBar *bar, ...);

// Submodule
struct MyLibFooBaz;
void MyLibFooBazAnotherAction(MyLibFooBaz *baz, ...);

그러나 나는 미친 긴 기호 이름으로 끝납니다 (예보다 훨씬 길다). 이름 앞에 "가짜 네임 스페이스"를 붙이지 않으면 모듈의 내부 심볼 이름이 모두 충돌합니다.

참고 : 낙타 케이스 / 파스칼 케이스 등은 신경 쓰지 않고 이름 자체 만 신경 쓰십시오.

접두사 (잘, 부착)는 실제로 유일한 옵션입니다. 표시되는 일부 패턴 <library>_<name>(예 : OpenGL, ObjC 런타임), <module/class>_<name>(예 : Linux의 일부) <library>_<module/class>_<name>(예 : GTK +)이 있습니다. 당신의 계획은 완벽하게 합리적입니다.

긴 이름이 예측 가능한 경우 반드시 나쁜 것은 아닙니다. 단일 소스 파일에서 관련 기능을 고수하기에 너무 긴 미친 이름과 기능 으로 끝나는 사실 은 다른 우려를 불러 일으 킵니다. 좀 더 구체적인 예가 있습니까?

C 라이브러리의 일반적인 규칙은 라이브러리 이름을 외부 적으로 사용 가능한 이름의 접두사로 사용하는 것입니다.

struct MyLibFoo;
void MyLibAFooAction(...);

라이브러리의 여러 단위에서 여전히 액세스 가능한 라이브러리 내부 이름의 경우 엄격한 규칙은 없지만 라이브러리 이름의 접두사와 내부 함수임을 나타내는 표시를 사용합니다. 예를 들면 다음과 같습니다.

struct MyLibInternalFooBaz;
void MyLibInternalFooBazAction();

나는 이것이 길고 입력하기 어려운 이름으로 이어질 수 있지만, 불행히도 C ++ 네임 스페이스와 같은 메커니즘이 없기 때문에 지불 해야하는 가격입니다. 이름의 길이를 줄이려면 명확성을 기하기 위해 이름에 약어를 사용하도록 선택할 수 있지만 장단점을 신중하게 고려해야합니다.

긴 접두사를 피하려면 iOS 및 OS X에서 Apple이하는 것과 같은 라이브러리 이름을 약어로 사용할 수 있습니다.

• NSString은 OS의 NextStep 루트에있는 문자열입니다.
• CALayer는 핵심 애니메이션 레이어입니다

함수 포인터로 전역 구조 변수를 미리 채우는 것은 어떻습니까?

lib.h

#pragma once

typedef struct
{
    void (*doFoo)(int x);
    const char *(*doBar)(void *p);
} YourApi;

extern const YourApi yourApi;

lib.c :

#include "lib.h"

#include <stdio.h>

static void doFoo(int x)
{
    printf("Doing foo %d\n", x);
}

static const char *doBar(void *p)
{
    printf("Doing bar: %p\n", p);
    return "Hello";
}

const YourApi yourApi = {
    doFoo,
    doBar};

마구:

#include "lib.h"

int main()
{
    yourApi.doFoo(42);
    yourApi.doBar("asd");
}

정적 키워드는 범위를 번역 단위로 제한하므로 다른 키워드와 충돌하지 않습니다.

사용자는 다음과 같은 포인터를 사용하여이 단축 될 수 있습니다 YourApi *ya = &yourApi다음, 사용 ya->doFoo(...).

또한 테스트를 위해 라이브러리를 조롱하는 좋은 방법을 제공합니다.