ли это распространенный способ определения интерфейса в C

Question

Я нахожу foo.h файл, имеющий:

typedef STRUCT_s STRUCT; 

STRUCT *foo(); 

и foo.c файл:

#include "i_foo.h" 

struct STRUCT_s{ 
//... 
}; 

#define STRUCT struct STRUCT_s 
STRUCT *foo() 
{ 
    STRUCT *s; 
    //... 
    return s; 
} 

ли это общий способ скрыть определение структуры в C? Если да, то интересно, если структура не объявлена ​​в заголовке, как клиент должен ее использовать?

Answer 1

Это общий способ скрыть определение структуры в C. И клиент не должен использовать структуру напрямую. Он должен использовать только предлагаемые функции из интерфейса для взаимодействия с данными: создавать, устанавливать или получать значения, запускать на нем, ...

Таким образом, реализация полностью скрыта для клиента. Таким образом, клиент не ограничивается изменениями в реализации. Библиотека может развиваться по мере необходимости, не беспокоя клиента, без изменения интерфейса.

Answer 2

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

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

Answer 3

Да, это распространенный способ объявления абстрактного типа данных (ATD). ADT используется только через интерфейс, который представлен функциями, объявленными в файле заголовка. Клиент не имеет доступа к полям напрямую. Также рекомендуется добавить префикс ко всем экспортированным идентификаторам. Это позволяет избежать конфликтов имен и дает понять, откуда приходит импортированный идентификатор.

Пример:

Stacks.h

typedef struct Stacks_StackDesc *Stacks_Stack; 

Stack Stacks_New(void); 

void Stacks_Push(int x, Stacks_Stack s); 

void Stacks_Pop(Stacks_Stack s, int *top); 

Stacks.c

#include "Stacks.h" 

struct Stacks_StackDesc { 
    ... 
}; 

Stack Stacks_New(void) 
{ 
    ... 
} 

void Stacks_Push(int x, Stacks_Stack s) 
{ 
    ... 
} 

void Stacks_Pop(Stacks_Stack s, int *top) 
{ 
    ... 
}