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

问题描述 投票:1回答:1

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

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.cfile):

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文件中定义它们。做那样的事情不常见吗?

c software-design opaque-pointers
1个回答
4
投票

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

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

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);
}

...
© www.soinside.com 2019 - 2024. All rights reserved.