编译时拼接const数组：寻求无复杂宏的枚举直接索引方案

需求背景 #

需要从用户可修改的两个独立文件file1.c/h和file2.c/h中的配置定义，生成struct config类型的const数组，以及用于直接索引该数组的enum pin枚举。以下先展示三种已有实现思路并分析其缺点，再探索解决问题的第四种方案。

方案1 #

///////////////////////////
// file1.h

#define LIST1 \
    ePin1,    \
    ePin2,    \
    ePin3,

///////////////////////////
// file1.c

#include "file1.h"

enum pin1
{
    LIST1
};

const struct config array1[] =
{
    [ePin1] = {aaa},
    [ePin2] = {bbb},
    [ePin3] = {ccc},
};

///////////////////////////
// file2.h

#define LIST2 \
    ePin4,    \
    ePin5,

///////////////////////////
// file2.c

#include "file2.h"

enum pin2
{
    LIST2
};

const struct config array2[] =
{
    [ePin4] = {ddd},
    [ePin5] = {eee},
};

///////////////////////////
// main.h

#include "file1.h"
#include "file2.h"

enum pin
{
    LIST1
    LIST2
};

///////////////////////////
// main.c

#include "main.h"

#define ARRAY_SIZE(array)       (sizeof(array) / sizeof((array)[0]))
#define LIST_SIZE(type, list)   ARRAY_SIZE(((const type[]){list})) 

#define LIST1_SIZE LIST_SIZE(enum pin, LIST1)
#define LIST2_SIZE LIST_SIZE(enum pin, LIST2)

extern const struct config array1[];
extern const struct config array2[];

const struct config * get_config(enum pin pin)
{
    if (pin >= 0 && pin < LIST1_SIZE)
    {
        return &array1[pin];
    }
    else
    {
        return &array2[pin - LIST1_SIZE];
    }
}

缺点 #

• 必须在file1和file2中创建本地枚举，用于生成数组的0基索引
• 获取配置时需要根据枚举值判断索引哪个数组

方案2 #

///////////////////////////
// file1.h

#define LIST1 \
    ePin1,    \
    ePin2,    \
    ePin3,

///////////////////////////
// file1.c

#include "file1.h"

enum pin1
{
    LIST1
};

__attribute__((used)) static const struct config array1[] =
{
    [ePin1] = {aaa},
    [ePin2] = {bbb},
    [ePin3] = {ccc},
};

///////////////////////////
// file2.h

#define LIST2 \
    ePin4,    \
    ePin5,

///////////////////////////
// file2.c

#include "file2.h"

enum pin2
{
    LIST2
};

__attribute__((used)) static const struct config array2[] =
{
    [ePin4] = {ddd},
    [ePin5] = {eee},
};

///////////////////////////
// linker_script.lsl
// 在链接脚本中确保array2[]紧跟在array1[]之后
// 同时将合并后的数组地址暴露给C代码，命名为array_all

///////////////////////////
// main.h

#include "file1.h"
#include "file2.h"

enum pin
{
    LIST1
    LIST2
};

///////////////////////////
// main.c

#include "main.h"

extern const struct config array_all[]; // 从链接脚本暴露的符号

const struct config * get_config(enum pin pin)
{
    return &array_all[pin];
}

缺点 #

• 仍需创建本地枚举生成数组的0基索引
• 依赖链接脚本修改，不具备完全可移植性

优点 #

• 获取配置仅需直接索引单个数组

方案3 #

///////////////////////////
// file1.h

#define LIST1     \
    X(ePin1, aaa) \
    X(ePin2, bbb) \
    X(ePin3, ccc)


///////////////////////////
// file2.h

#define LIST2     \
    X(ePin4, ddd) \
    X(ePin5, eee)

///////////////////////////
// main.h

#include "file1.h"
#include "file2.h"

enum pin
{
#define X(pin, ...) pin,
    LIST1
    LIST2
#undef X
};

///////////////////////////
// main.c

#include "main.h"

static const struct config array_all[] =
{
#define X(pin, ...) [pin] = {__VA_ARGS__},
    LIST1
    LIST2
#undef X
};

const struct config * get_config(enum pin pin)
{
    return &array_all[pin];
}

缺点 #

• X宏可能不符合MISRA-C规范（尽管有说法称符合MISRA-C:2012）
• X宏对新手来说较难理解和调试

优点 #

• 用户仅需定义列表，无需手动编写数组
• 生成的数组无冗余，仅包含枚举对应的元素
• 获取配置仅需直接索引单个数组
• 数组为static类型，仅在main.c中可见

方案4：基于枚举偏移与链接段合并的实现 #

当前X宏方案是最优选择，但希望减少函数式宏的使用以提升可读性。以下是一种兼顾可读性、可移植性（适度依赖链接器）的实现方式：

核心思路 #

1. 全局集中维护枚举值，每个配置文件直接使用全局枚举定义对应配置项
2. 将每个配置文件的数组放入自定义链接段，通过链接器合并为连续内存块
3. 全局枚举值直接对应合并后数组的索引，无需额外计算

代码实现 #

1. 全局枚举头文件（pin_enum.h）

#ifndef PIN_ENUM_H
#define PIN_ENUM_H

enum pin
{
    // 按配置文件分组定义全局枚举值
    ePin1,
    ePin2,
    ePin3,
    ePin4,
    ePin5,
    PIN_COUNT // 总数量，用于编译时检查
};

#endif // PIN_ENUM_H

2. file1.h（用户修改的配置头文件）

#ifndef FILE1_H
#define FILE1_H

#include "pin_enum.h"
#include "config.h" // 包含struct config的定义

// 配置项直接绑定全局枚举值
#define FILE1_CONFIGS \
    [ePin1] = {aaa}, \
    [ePin2] = {bbb}, \
    [ePin3] = {ccc}

#endif // FILE1_H

3. file1.c

#include "file1.h"

// 将数组放入自定义链接段
const struct config file1_configs[] __attribute__((section(".config_pins"))) =
{
    FILE1_CONFIGS
};

// 编译时检查：数组覆盖的枚举范围是否正确
_Static_assert(sizeof(file1_configs)/sizeof(file1_configs[0]) == (ePin3 - ePin1 + 1), 
               "File1 config array size mismatch with enum range");

4. file2.h（用户修改的配置头文件）

#ifndef FILE2_H
#define FILE2_H

#include "pin_enum.h"
#include "config.h"

#define FILE2_CONFIGS \
    [ePin4] = {ddd}, \
    [ePin5] = {eee}

#endif // FILE2_H

5. file2.c

#include "file2.h"

const struct config file2_configs[] __attribute__((section(".config_pins"))) =
{
    FILE2_CONFIGS
};

_Static_assert(sizeof(file2_configs)/sizeof(file2_configs[0]) == (ePin5 - ePin4 + 1), 
               "File2 config array size mismatch with enum range");

6. 链接脚本修改（适度可移植）

在链接脚本中合并自定义段，并暴露起始/结束地址：

SECTIONS
{
    ...
    .config_pins : ALIGN(4)
    {
        __config_pins_start = .;
        *(.config_pins)
        __config_pins_end = .;
    } > FLASH
    ...
}

7. main.h

#ifndef MAIN_H
#define MAIN_H

#include "pin_enum.h"
#include "config.h"

// 声明合并后的配置数组
extern const struct config config_pins[];

#endif // MAIN_H

8. main.c

#include "main.h"

// 从链接脚本导入段起始地址
extern const struct config __config_pins_start[];
#define config_pins __config_pins_start

// 编译时检查：合并后数组大小是否与枚举总数匹配
_Static_assert((__config_pins_end - __config_pins_start)/sizeof(struct config) == PIN_COUNT, 
               "Total config array size mismatch with PIN_COUNT");

const struct config * get_config(enum pin pin)
{
    // 可选：边界检查
    if (pin >= PIN_COUNT) return NULL;
    return &config_pins[pin];
}

方案4的优缺点 #

优点

• 无复杂函数式宏，可读性强，新手易理解
• 全局枚举直接对应数组索引，无需任何索引运算
• 编译时静态检查确保配置与枚举的一致性，减少运行时错误
• 仅适度依赖链接段定义，主流编译器（GCC、Clang、ARMCC）均支持，可移植性较好

缺点

• 全局枚举需集中维护，新增/删除配置项时需同步更新枚举
• 链接脚本需做少量修改，不同平台语法略有差异，但修改量极小

内容的提问来源于stack exchange，提问作者user1806687