C头和源文件结构

时间:2015-11-02 00:06:34

标签: c architecture header

我正在编写一个数学库,我想稍后将其作为渲染管道的一部分。

修改 我想坚持使用C99。

我计划编写同一个库的3个版本,一个通用的标量版本,一个用于移动平台的霓虹版本和一个支持该版本的平台的SSE实现。

我想知道如何构建我的文件以拥有一个接口,但依赖于编译器标志有不同的实现。

为简单起见,我将使用基本的数学函数。

basic_math_scalar

标题basic_math_scalar.h

typedef struct scalar_struct {
    ...
    ...
};
int add(scalar_struct* out, const int* in_a, int* in_b);
int sub(scalar_struct* out, const int* in_a, int* in_b);
int mult(scalar_struct* out, const int* in_a, int* in_b);
int div(scalar_struct* out, const int* in_a, int* in_b);

basic_math_sse

标题basic_math_sse.h

typedef struct sse_struct {
    ...
    ...
};
int add(sse_struct* out, const int* in_a, int* in_b);
int sub(sse_struct* out, const int* in_a, int* in_b);
int mult(sse_struct* out, const int* in_a, int* in_b);
int div(sse_struct* out, const int* in_a, int* in_b);

basic_math_neon

标题basic_math_neon.h

typedef struct neon_struct {
    ...
    ...
};
int add(neon_struct* out, const int* in_a, int* in_b);
int sub(neon_struct* out, const int* in_a, int* in_b);
int mult(neon_struct* out, const int* in_a, int* in_b);
int div(neon_struct* out, const int* in_a, int* in_b);

上述每个文件都将在.c文件中实现。

现在我将有一个类main.c来实现这些并基于编译器标志进行切换。

main.c中
#include <stdlib.h>
#include <stdio.h>
#include "basic_math.h"

int main(int argc, char** argv) {

    basic_math_struct* a = create_bms();

    a = add(1, 2);
    printf("value of a: %d\n",bms_value(a)); //should equal 3

    cleanup_bms(a);

    return 0;
}

上面的代码中缺少一大块。我有实际的数学函数,然后我有main.c使用那些数学函数,但是我有一个中间步骤,我在设计时遇到了麻烦,basic_math.h

让我们说basic_math.h看起来像这样。

#ifdef SSE
  #include "basic_math_sse.h"
  typedef sse_struct basic_math_struct;
#elif NEON
   #include "basic_math_neon.h"
   typedef neon_struct basic_math_struct;
#else
   #include "basic_math_scalar.h"
   typedef scalar_struct basic_math_struct;
#endif

basic_math_struct add(basic_math_struct* out, const int* in_a, int* in_b);
basic_math_struct sub(basic_math_struct* out, const int* in_a, int* in_b);
basic_math_struct mult(basic_math_struct* out, const int* in_a, int* in_b);
basic_math_struct div(basic_math_struct* out, const int* in_a, int* in_b);

基本上我想使用文件basic_math.h隐藏底层函数的所有实现,这样一旦我包含头文件,就不再需要弄乱底层文件了。

然后可以在编译时生成标量,sse或者氖构建类型,并且该库的用户永远不必担心在他们的文件中添加#ifdefs。

basic_math.h模块必须是所有#ifdef所在的位置,但如果您使用main.c中的文件则不应该关注。

此外,如果我忽略了任何内容,我也希望得到反馈。

1 个答案:

答案 0 :(得分:2)

一个明显的问题是,在C中的单个程序中只能有一个具有任何给定名称的函数(在没有动态加载和通过函数指针访问的情况下);没有函数重载。在有功能重载的C ++中,你想要做的事情可能会更容易。

basic_math.h中函数的返回类型是意外的:

basic_math_struct add(basic_math_struct* out, const int* in_a, int* in_b);

在其他标头中,add的返回类型为int。我们不清楚为什么in_a参数是const int *in_b是非常数int *

调用代码是否会通过内存分配函数实例化其中一个结构?也就是说,调用代码是否可以写:

basic_math_struct x;

或者它总是被限制为总是使用指针:

basic_math_struct *px = bms_create();

或多或少如您的代码所示?请注意,使用bms_作为前缀而不是_bms作为后缀更常规,但使用后缀并不完全站不住脚。

请注意,您的示例main()包括:

basic_math_struct* a = create_bms();

a = add(1, 2);

这不是对问题中任何add函数的调用。从表面上看,您可能有意:

*a = add(a, 1, 2);

这将匹配标头中的add函数,但代码非常可疑。如果函数返回int,如scalarsseneon代码,则会更有意义:

if (add(a, 1, 2) != 0)
    …report BMS error…

如果调用代码永远不会分配结构(它只会包含指向结构的指针),并且它永远不会尝试取消引用指针来获取结构中的元素(它只会使用API​​调用来获取数据),那么你可以避免将类型的内部完全暴露给调用代码,只需使用 opaque类型

不透明类型

basic_math.h

typedef struct basic_math_struct basic_math_struct;

int bms_add(basic_math_struct *out, const int *in_a, int *in_b);
int bms_sub(basic_math_struct *out, const int *in_a, int *in_b);
int bms_mul(basic_math_struct *out, const int *in_a, int *in_b);
int bms_div(basic_math_struct *out, const int *in_a, int *in_b);

basic_math_struct *bms_create(void);

请注意,这明确地包含任何特定标题。

用户可以相应地编写代码:

basic_math_struct *a = bms_create();

if (bms_add(a, 1, 2) != 0)
    …deal with BMS error…

三个系统的实现代码将包含basic_math.h标头,然后适当地定义struct basic_math_struct

#include "basic_math.h"

struct basic_math_struct
{
    ...
    ...
};

并将相应地实现代码:

int bms_add(basic_math_struct *out, const int *in_a, int *in_b)
{
    …implementation for scalar, or neon, or sse…
}

只要没有版本需要在程序的同一次运行中拥有多种类型,这是好的和直截了当的。那么你会有问题,但那还不是你所描述的。

查找不透明类型&#39;在标签为的SO上(因此请在SO搜索栏中输入[c] opaque type)。你应该找到许多相关的问题和正确的答案。