将函数指针表的索引与表内容同步

Question

在我正在开发的嵌入式系统中，我们使用函数指针表来支持专有的动态库。

我们有一个头文件，它使用命名常量（#define）作为函数指针索引。这些值用于计算函数地址表中的位置。

示例：

(export_table.c)

// Assume each function in the table has an associated declaration
typedef void (*Function_Ptr)(void);

Function_Ptr    Export_Function_Table[] =
{
  0,
  Print,
  Read,
  Write,
  Process,
};

这是头文件：
export_table.h

#define ID_PRINT_FUNCTION 1
#define ID_READ_FUNCTION  2
#define ID_WRITE_FUNCTION 3
#define ID_PROCESS_FUNCTION 4

我正在寻找一种方案来根据命名常量在数组中的位置来定义它们，以便当函数的顺序发生变化时，常量也会发生变化。
（另外，我希望编译器或预处理器计算索引以避免打字等人为错误。）

Answer 1

使用 C99，您可以使用指定的初始值设定项：

enum {
    ID_PRINT_FUNCTION   = 1,
    ID_READ_FUNCTION    = 2,
    ID_WRITE_FUNCTION   = 3,
    ID_PROCESS_FUNCTION = 4,
};

（C99 中允许使用尾随逗号；从技术上讲，C90 中不允许使用尾随逗号。）

// Assume each function in the table has an associated declaration
typedef void (*Function_Ptr)(void);

Function_Ptr Export_Function_Table[] =
{
    [ID_READ_FUNCTION]    = Read,
    [ID_WRITE_FUNCTION]   = Write,
    [ID_PROCESS_FUNCTION] = Process,
    [ID_PRINT_FUNCTION]   = Print,
};

请注意，我故意重新排序 - 并且编译器将其排序。另外，虽然我将“#define”值重写为“enum”值，但它可以与任何一个一起使用。

请注意，据我所知，Windows 上的 MSVC 不支持此表示法。这意味着我无法在必须在 Linux 和 Windows 之间移植的代码中使用它——这让我很恼火。

Answer 2

请参阅这个答案< /a> 强制预处理器为您执行此操作的方法。

Answer 3

您可以为每个函数指针定义一个包含命名元素的结构，而不是数组：

struct call_table {
    Function_Ptr reserved;    
    Function_Ptr print_fcn;    
    Function_Ptr read_fcn;    
    Function_Ptr write_fcn;    
    Function_Ptr process_fcn;    
};

Answer 4

我的建议是：不要直接使用C。从以某种本地定义的 DSL 编写的输入文件生成 .c 和 .h 文件作为构建过程的一部分。然后，您只需维护一个源文件（用 DSL 编写），并且 DSL 编译器可确保导出的索引与数组的实现相匹配。

我们在这里采用了这种技术。 DSL 基本上是一个带注释的 C 文件，如下所示：

@@generate .h
#ifndef __HEADER_H
#define __HEADER_H

@export FN_LIST

#endif
@@generate .c
#include "foo.h"

@define FN_LIST
int myArray[] = 
{
    @FN_INDEX_FOO
    12,
    @FN_INDEX_BAR
    13,
    @FN_INDEX_BAZ
    14,
}

它将生成一个如下所示的 foo.h

#ifndef __HEADER_H
#define __HEADER_H

#define FN_INDEX_FOO 0
#define FN_INDEX_BAR 1
#define FN_INDEX_BAZ 2

#endif

和一个如下所示的 foo.c

#include "foo.h"

int myArray[] = 
{
    /* FN_INDEX_FOO = 0 */
    12,
    /* FN_INDEX_BAR = 1 */
    13,
    /* FN_INDEX_BAZ = 2 */
    14,
}

：具有计算大括号嵌套和逗号的能力，以计算 C 数组中每个元素的索引。

Answer 5

X 宏可以提供帮助。例如，创建一个新文件export_table_x.h，其中包含：

X_MACRO(Print),
X_MACRO(Read),
X_MACRO(Write),
X_MACRO(Process)

然后在export_table.h中使用：

#define X_MACRO(x) ID_ ## x ## _FUNCTION
enum
{
    ID_INVALID = 0,
    #include "export_table_x.h"
};
#undef X_MACRO

在export_table.c中写入：

#include "export_table.h"

// ...

#define X_MACRO(x) x
Function_Ptr Export_Function_Table[] =
{
    0,
    #include "export_table_x.h"
};

对原始功能的一项更改是ID_PRINT_FUNCTION现在是ID_Print_FUNCTION，等等

。文件很烦人，但是您可以通过使用 #ifdef 并将所有内容放入原始头文件中来避免这种情况，尽管这不太清楚。

Answer 6

很少有 C 程序员会利用 #undef 的强大功能，专门为您当前的目的重新定义宏。这使您可以在单个可读表中设置所有数据，并且可以在 1 个位置更新和修改该表。

#define FUNCTION_MAP { \
   MAP(ID_NOP_FUNCTION,     NULL), \
   MAP(ID_PRINT_FUNCTION,   Print), \
   MAP(ID_READ_FUNCTION,    Read), \
   MAP(ID_WRITE_FUNCTION,   Write), \
   MAP(ID_PROCESS_FUNCTION, Process), \
}

#define MAP(x,y) x
enum function_enums FUNCTION_MAP;
#undef MAP

#define MAP(x,y) y
Function_Ptr Export_Function_Table[] = FUNCTION_MAP;
#undef MAP

但是等等，还有更多 0 美元的超低价格以及免费的 S&H，您可以在 1 个地方完成所有函数头的繁琐操作。

#define FUNCTION_MAP  \
   /*   ENUM              Function, return, Arguments ...                  */ \
   MAP(ID_PRINT_FUNCTION,   Print,  int,    char *fmt, va_list *ap          ) \
   MAP(ID_READ_FUNCTION,    Read,   int,    int fd,    char *buf, size_t len) \
   MAP(ID_WRITE_FUNCTION,   Write,  int,    int fd,    char *buf, size_t len) \
   MAP(ID_PROCESS_FUNCTION, Process,int,    int                             )

//function enums
#define MAP(x,y,...) x,
enum function_enums { FUNCTION_MAP };
#undef MAP

//function pre-definitions with unspecified number of args for function table
#define MAP(x,fn_name,ret,...) ret fn_name();
FUNCTION_MAP
#undef MAP

//function tables with unspecified number of arguments
#define MAP(x,y,...) y,
typedef int (*Function_Ptr)();
Function_Ptr Export_Function_Table[] = { FUNCTION_MAP };
#undef MAP

//function definitions with actual parameter types
#define MAP(x,fn_name,ret,...) ret fn_name(__VA_ARGS__);
FUNCTION_MAP
#undef MAP

//function strings ... just in case we want to print them
#define MAP(x,y,...) #y,
const char *function_strings[] = { FUNCTION_MAP };
#undef MAP

//function enum strings ... just in case we want to print them
#define MAP(x,y,...) #x,
const char *function_enum_strings[] = { FUNCTION_MAP };
#undef MAP
#undef FUNCTION_MAP

现在，您可以将每个新函数添加到此标头顶部的一个位置，如果您想保留作为库的向后兼容性，最好添加到 FUNCTION_MAP 的末尾...否则您可以按字母顺序列出它们。