CMake中选择备选头文件位置的惯用方案咨询

针对UUID头文件的特定解决方案 #

直接利用CMake内置的头文件检测模块，配合预编译宏让源文件自动选择正确的头文件，步骤如下：

1. 在CMakeLists.txt中添加检测逻辑 #

include(CheckIncludeFile)

# 分别检测两个头文件的存在性
check_include_file("linux/uuid.h" HAVE_LINUX_UUID_H)
check_include_file("uuid/uuid.h" HAVE_UUID_UUID_H)

# 可选：强制要求至少找到一个头文件，避免后续编译错误
if(NOT HAVE_LINUX_UUID_H AND NOT HAVE_UUID_UUID_H)
    message(FATAL_ERROR "未找到可用的UUID头文件：linux/uuid.h 或 uuid/uuid.h")
endif()

# 将检测结果通过预编译宏传递给目标代码
target_compile_definitions(你的目标名称
    PRIVATE
        $<$<BOOL:${HAVE_LINUX_UUID_H}>:HAVE_LINUX_UUID_H>
        $<$<BOOL:${HAVE_UUID_UUID_H}>:HAVE_UUID_UUID_H>
)

2. 在C源文件中使用条件编译 #

#ifdef HAVE_LINUX_UUID_H
#include <linux/uuid.h>
#elif defined(HAVE_UUID_UUID_H)
#include <uuid/uuid.h>
#else
#error "未找到合适的UUID头文件"
#endif

通用场景的惯用方案 #

这种多候选头文件选择的场景，通用解决思路是CMake配置阶段检测头文件可用性，通过预编译宏传递结果给源文件，核心步骤如下：

• 引入检测模块：使用CMake内置的CheckIncludeFile（针对C）或CheckIncludeFileCXX（针对C++）模块，无需额外依赖。
• 逐个检测候选头文件：对每个可能的头文件调用check_include_file(<头文件路径> <宏名称>)，CMake会自动生成对应的宏（头文件存在则宏为ON，否则为OFF）。
• 传递预编译宏：通过target_compile_definitions将宏添加到目标的私有编译定义中，确保仅当前目标可见。
• 源文件分支处理：用C/C++的条件编译指令（#ifdef/#elif）选择包含正确的头文件。

进阶：检测头文件可用性（而非仅存在） #

如果某些头文件存在但依赖其他库/头文件才能正常编译，可以用try_compile自定义检测逻辑：

1. 编写一个简单的测试源码（比如check_header_valid.c）：

#include <目标头文件路径>

// 添加简单的代码验证头文件可正常使用，比如调用头文件中的函数或定义变量
int main() {
    // 示例：验证UUID头文件的可用性
    uuid_t tmp_uuid;
    uuid_generate(tmp_uuid);
    return 0;
}

2. 在CMakeLists.txt中调用try_compile：

try_compile(
    HEADER_VALID
    ${CMAKE_BINARY_DIR}/check_header_dir
    SOURCES ${CMAKE_SOURCE_DIR}/check_header_valid.c
    OUTPUT_VARIABLE COMPILE_OUTPUT
)

if(HEADER_VALID)
    target_compile_definitions(你的目标名称 PRIVATE HAVE_VALID_HEADER)
else()
    message(WARNING "头文件存在但无法正常编译：${COMPILE_OUTPUT}")
endif()

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