C语言 具有一些私有操作的不透明结构



我正在设计一个库,遇到了一个关于分离公共和库私有操作的问题。我有以下库接口:

libmylib.h

typedef struct lib_context lib_context;
int init_library_context(const char **paths, 
                         size_t path_num, 
                         lib_context **ctx_out);
void release_context(lib_context *ctx);

出于测试目的,我想提供一个为单元测试中使用的不透明结构分配内存的函数。但是由于客户端不需要这个函数,我决定把它设为私有(并将结构的定义也放在那里(:

lib_context_internal.h

//the definition is simplified for brevity sake
struct lib_context{
   size_t paths_num;
   const char *path[];
};
lib_context * allocate_context(size_t paths_num);

但是函数的定义在 libmylib.c 中提供(没有lib_context_internal.c文件(:

libmylib.c

#include "limylib.h"
#include "lib_context_internal.h"
lib_context * allocate_context(size_t paths_num){
   size_t size = sizeof(struct lib_context) + sizeof(const char *[paths_num]);
   return calloc(1, size);
}
void release_context(lib_context *ctx){
    //release all strings in the lib_ctx
    free(ctx);
}
int init_library_context(const char **paths, 
                     size_t path_num, 
                     lib_context **ctx_out){
   //open sockets, init epoll, etc...
   *ctx_out = allocate_context(paths_num);
   return 0;
}

困扰我的是,我将与相同数据结构相关的分配/释放函数放在不同的标头中(即使(我在同一个.c文件中定义了它们。做这样的事情不是很常见吗?

像这样有一个单独的标题很好。 如果库中的其他实现文件需要访问其中定义的类型或函数,则它们也可以包含该标头。 只要该内部标头不与编译库一起分发,您就可以了。

我要做的一件事是将公共标头包含在私有标头中。 这样,实现文件只需要担心包含私有标头。

lib_context_internal.h:

#include "limylib.h"
//the definition is simplified for brevity sake
struct lib_context{
   size_t paths_num;
   const char *path[];
};
lib_context * allocate_context(size_t paths_num);

libmylib.c:

#include "lib_context_internal.h"
lib_context * allocate_context(size_t paths_num){
   size_t size = sizeof(struct lib_context) + sizeof(const char *[paths_num]);
   return calloc(1, size);
}
...

最新更新