Объявить структуру в заголовочном файле

Question

У меня есть определение fifo_t в моем fifo.c файл, как показано ниже. Что должно быть объявлением этого типа в файле заголовка fifo.h? Я хочу, чтобы содержимое этой структуры было известно только в файле fifo.c. Кроме того, я не хочу, чтобы создать экземпляр этой структуры через struct struct_name var;. Только действительный путь должен быть fifo_t var;

typedef struct { 
    uint8_t *buffer, 
    uint8_t indexRead, 
    uint8_t indexWrite, 
    uint8_t used, 
    uint8_t size 
} fifo_t; 

Answer 1

вы не можете скрыть содержимое fifo_t, если вы хотите, чтобы иметь возможность создать его в стек, как fifo_t var;, потому что sizeof(fifo_t) неизвестно

Вы можете сделать FORVARD декларацию fifo_t в заголовке: struct fifo_t;. В других файлов, которые вы будете иметь возможность создавать poiners для fifo_t и работать с ними, используя функции, которые должны быть реализованы в & fifo.c

fifo_t *var; 
create(&var); 
do_work(var); 
destroy(var); 

Answer 2

Если вы хотите, чтобы только быть в состоянии передавать указатели на fifo_t вокруг, то вы можете только переслать-объявить его в файл заголовка. Однако typedef для неназванных структур действует только при определении содержимого структуры. Поэтому, если вы не хотите компилировать struct fifo_t var;, вам придётся использовать какое-то контр-интуитивное имя, может быть, что-то вроде fifo_t_. Например:

typedef struct fifo_t_ fifo_t; 
void fifo_use(fifo_t*); // ok, just uses pointer 

А затем в файле .c, делать (и, пожалуйста, обратите внимание, что при использовании запятой для отдельных членов не является допустимым синтаксисом):

struct fifo_t_ { 
    uint8_t *buffer; 
    uint8_t indexRead; 
    uint8_t indexWrite; 
    uint8_t used; 
    uint8_t size; 
}; 

void fifo_use(fifo_t* f) { 
    f->indexRead = 1; 
} 

Кроме того, обратите внимание, что fifo_t var; не будет потому что вам нужно знать размер структуры, чтобы выделить место для нее. То, что вы могли сделать, это использовать указатели внутри, таким образом, прозрачно для пользователя:

// in .h file: 

typedef struct fifo_t_* fifo_t; 

void fifo_init(fifo_t*); 
void fifo_free(fifo_t); 
void fifo_use(fifo_t); 

// in .c file: 

struct fifo_t_{ 
    uint8_t *buffer; 
    uint8_t indexRead; 
    uint8_t indexWrite; 
    uint8_t used; 
    uint8_t size; 
}; 

void fifo_init(fifo_t* f) { 
    *f = (fifo_t)malloc(sizeof(struct fifo_t_)); 
} 

void fifo_free(fifo_t f) { 
    free(f); 
} 

void fifo_use(fifo_t f) { 
    f->indexRead = 1; 
} 


// somewhere else 

int main() { 
    fifo_t fifo; 
    fifo_init(&fifo); 
    fifo_use(fifo); 
    fifo_free(fifo); 
} 

Answer 3

Если вы хотите, чтобы сделать определение структуры в fifo.h это путь :

fifo.h

... 
#ifdef FIFO 
typedef struct { 
    uint8_t *buffer, 
    uint8_t indexRead, 
    uint8_t indexWrite, 
    uint8_t used, 
    uint8_t size 
} fifo_t; 
#else 
... 
#endif 
... 

fifo.c

#define FIFO 
#include "fifo.h" 
... 

так fifo.h все еще может быть включать в других исходных файлах, но тип структуры является скрыть, это видно только с fifo.c