Соглашения об именах библиотек C

Ответ 1

Я не C гуру, но из библиотек, которые я использовал, довольно часто используется префикс для разделения функций.

Например, SDL будет использовать SDL, OpenGL будет использовать gl и т.д.

Ответ 2

Структурный способ, который упоминает Кен, будет выглядеть примерно так:

struct MyCoolApi
{
  int (*add)(int x, int y);
};

MyCoolApi * my_cool_api_initialize(void);

Затем клиенты будут делать:

#include <stdio.h>
#include <stdlib.h>

#include "mycoolapi.h"

int main(void)
{
  struct MyCoolApi *api;

  if((api = my_cool_api_initialize()) != NULL)
  {
    int sum = api->add(3, 39);

    printf("The cool API considers 3 + 39 to be %d\n", sum);
  }
  return EXIT_SUCCESS;
}

У этого по-прежнему есть "пространства имен"; имя struct (называемое тегом struct) должно быть уникальным, и вы не можете объявлять вложенные структуры, которые полезны сами по себе. Это хорошо работает для сбора функций, но это техника, которую вы часто видите в C.

ОБНОВЛЕНИЕ: Здесь, как может выглядеть сторона реализации, это было запрошено в комментарии:

#include "mycoolapi.h"

/* Note: This does **not** pollute the global namespace,
 * since the function is static.
*/
static int add(int x, int y)
{
  return x + y;
}

struct MyCoolApi * my_cool_api_initialize(void)
{
  /* Since we don't need to do anything at initialize,
   * just keep a const struct ready and return it.
  */
  static const struct MyCoolApi the_api = {
    add
  };

  return &the_api;
}

Ответ 3

Это позор, который вы испугали на С++, поскольку у него есть пространства имен, чтобы справиться именно с этой проблемой. В C вы в значительной степени ограничены использованием префиксов - вы, безусловно, не можете "поместить операции api в структуру".

Изменить: В ответ на ваш второй вопрос относительно того, как пользователи могут указать свой собственный префикс, я бы избегал его, как чума. 99,9% пользователей будут довольны любым префиксом, который вы предоставляете (при условии, что он не слишком глупый), и будет очень НЕОПРЕДЕЛЕННО на обручах (макросы, структуры и т.д.), Которые им придется преодолевать, чтобы удовлетворить оставшиеся 0,1%.

Ответ 4

Как пользователь библиотеки, вы можете легко определить свои сокращенные пространства имен через препроцессор; результат будет немного странным, но он работает:

#define ns(NAME) my_cool_namespace_ ## NAME

позволяет писать

ns(foo)(42)

вместо

my_cool_namespace_foo(42)

Как автор библиотеки, вы можете предоставить сокращенные имена как описано здесь.

Если вы следуете удалять советы и создаете структуру API, вы должны сделать константы компиляции времени указателей функций, чтобы сделать inlinig возможным, то есть в вашем файле .h, используйте следующий код:

// canonical name
extern int my_cool_api_add(int x, int y);

// API structure
struct my_cool_api
{
    int (*add)(int x, int y);
};

typedef const struct my_cool_api *MyCoolApi;

// define in header to make inlining possible
static MyCoolApi my_cool_api_initialize(void)
{
    static const struct my_cool_api the_api = { my_cool_api_add };
    return &the_api;
}

Ответ 5

К сожалению, нет уверенного способа избежать столкновений имен в C. Поскольку в нем не хватает пространств имен, вы остаетесь с префиксом имен глобальных функций и переменных. Большинство библиотек выбирают короткий и "уникальный" префикс (уникальные в кавычках по понятным причинам), и надеемся, что никаких столкновений не произойдет.

Следует отметить, что большая часть кода библиотеки может быть статически объявлена ​​- это означает, что она не будет сталкиваться с аналогичными именованными функциями в других файлах. Но экспортируемые функции действительно должны быть тщательно префиксны.

Ответ 6

Поскольку вы открываете функции с тем же именем, клиент не может включать файлы заголовков библиотеки вместе с другими файлами заголовков, которые имеют коллизию имен. В этом случае перед прототипом функции вы добавите следующее в файл заголовка, и это не повлияет на использование клиента.

#define add myuniquelibname_add

Обратите внимание: это быстрое решение и должно быть последним вариантом.

Ответ 7

Для действительно огромного примера метода struct взгляните на ядро ​​Linux; 30-нечетный миллион строк C в этом стиле.

Ответ 8

Префиксы - это только выбор на уровне C.

На некоторых платформах (поддерживающих отдельные пространства имен для компоновщиков, таких как Windows, OS X и некоторые коммерческие структуры, но не Linux и FreeBSD), вы можете обходить конфликты, набирая код в библиотеке и экспортировать только символы из библиотеки, которую вы очень нужно. (и, например, сглаживание в importlib в случае возникновения конфликтов в экспортируемых символах)