用户库(C模块的集合)：为每个C模块提供可覆盖配置的最佳方法？

Question

我希望创建和共享一个新的C用户库(使用最佳实践)。它是用户程序可以编译和链接的C模块的集合。每个模块都有一个默认配置，但是用户程序必须能够覆盖默认配置(只有当它愿意的时候)。此外，不能强迫用户程序为它不使用的C模块提供配置。

我希望将C模块文件组合在同一个库目录(例如module.h、module_cfg.h & module.c)中，以最小化库用户的学习曲线。

这是我对这个问题的解决方案，但我想知道这是否是糟糕的形式，是否有更好的解决方案。

让我们调用新的C库FancyLib，并使用前缀"fl“来防止名称空间与其他库或用户代码发生冲突。库中有一个timer模块。它有一个默认的配置文件，但是被用户提供的配置文件覆盖。库中还有一个名为foo的模块，用户程序不使用它。

包括库在内的整个用户项目由以下文件组成：

• libs/fl/fl_lib.h
• libs/fl/utils/fl_tmr.h
• libs/fl/utils/fl_tmr_cfg.h <-默认
• libs/fl/utils/fl_tmr.c
• libs/fl/utils/fl_foo.h
• libs/fl/utils/fl_foo_cfg.h <-默认
• libs/fl/utils/fl_foo.c
• cfg/fl_tmr_cfg.h <-重写
• src/main.c

src/main.c的内容如下：

#include <fl_lib.h>

int main(int argc, char *argv[])
{
    fl_tmr_init();
}

libs/fl/fl_lib.h的含量为：

#ifndef __FL_LIB_H__
#define __FL_LIB_H__

#include <utils/fl_tmr.h>
#include <utils/fl_foo.h>

#endif

libs/fl/utils/fl_tmr.h的内容是：

#ifndef __FL_TMR_H__
#define __FL_TMR_H__

// Include configuration (default or user supplied)
#include <fl_tmr_cfg.h>

void fl_tmr_init(void);

#endif

libs/fl/utils/fl_tmr.c的内容是：

#include "fl_tmr.h" // <-- Need to be quotes

void fl_tmr_init(void)
{
    // Initialise timer
}

libs/fl/utils/fl_foo.h的内容是：

#ifndef __FL_FOO_H__
#define __FL_FOO_H__

// Include configuration (default or user supplied)
#include <fl_foo_cfg.h>

#endif

编译器的搜索路径指定为"-Icfg -Isrc -Ilibs/fl"。这确保首先找到用户提供的配置文件(cfg/fl_tmr_cfg.h)，并重写库中的默认文件(libs/fl/utils/fl_tmr_cfg.h)。

这是最好的办法吗？

此解决方案仅在使用#include <> (带尖括号)时才有效，因为它“强制”编译器遵循指定的包含目录优先级，而不使用它首先在*.c文件所在的目录中找到的文件(例如，在编译libs/fl/utils/fl_tmr.c时)。

#include "" (引号)和#include <> (尖括号)的用法已经在这里中进行了深入的讨论，但我仍然对GCC文档页面感到困惑，认为#include <> (尖括号)应该只用于系统文件，例如#include <stdio.h>。

一个参考示例是boost库，它广泛地使用了#include <filename>，但出现了异常。下面是一个示例：

boost\libs\math\src\tr1\acosh.cpp：

#include <boost/math/tr1.hpp>
#include <boost/math/special_functions/acosh.hpp> // <-- Angle brackets
#include "c_policy.hpp" // <-- Quotes

注意：c_policy.hpp与acosh.cpp位于同一个目录中。

讨论中提到的一个缺陷是，只为#include ""文件而不是#include <>文件生成依赖关系。这意味着，如果在库中更改了文件，则需要从头开始重建整个项目。

提前谢谢你，

彼特

任何其他指针/提示/链接/示例创建一个良好的(嵌入式)C库将不胜感激。

Answer 1

使用尖括号，#include <mylib.h>需要找到mylib.h的路径才能为IDE (编译器)所知。

使用引号不需要这样做。

使用什么可能取决于您如何组织您的文件。如果它们非常本地，并且相对于您的主程序，那么最好使用引号，这使得您的开发目录树更易于传输。

Answer 2

没什么太复杂的。

当您使用#include <someFile.h>时，GCC将搜索它的包含路径(默认路径类似于系统标题路径(用于前/usr/include/)，或者使用命令行上的-I<path>选项显式指定。

另一方面，当您使用#include "someFile.h"时，GCC将搜索相对于当前文件的上述文件。因此，如果当前文件是include/test.h，并且其中包含行#include "test2.h"，那么GCC将检查文件include/test2.h的存在并将其包括在内。

因此，在您的示例中，由于要分发库，所以使用""样式引用属于库的头文件。如果您使用其他库，那么最好使用<>。