cmake 设置头文件的包含路径

在 CMake 中设置头文件的包含路径是通过 include_directories 命令或 target_include_directories 命令来实现的。这两个命令都用于指定编译器在查找头文件时应该搜索的目录。

使用 include_directories

include_directories 命令为整个项目或指定目标（如库或可执行文件）设置包含路径。它会将这些路径添加到编译器的全局包含目录中。

# 为整个项目设置包含路径
include_directories(${CMAKE_SOURCE_DIR}/include)

# 或者为特定目标设置包含路径（不推荐，因为这种方式不够局部化）
add_executable(my_executable main.cpp)
include_directories(my_executable ${CMAKE_SOURCE_DIR}/include)

然而，include_directories 是一种较为陈旧的方法，因为它会影响所有后续定义的目标，这可能不是你想要的。更好的做法是使用 target_include_directories。

使用 target_include_directories

target_include_directories 命令允许你为特定的目标（如库或可执行文件）设置包含路径。这样，这些路径就只会应用于该目标，而不会影响其他目标。

# 定义可执行文件
add_executable(my_executable main.cpp)

# 为 my_executable 设置包含路径
target_include_directories(my_executable PRIVATE ${CMAKE_SOURCE_DIR}/include)

在 target_include_directories 命令中，你可以使用以下关键字来指定包含路径的作用域：

• PRIVATE：包含路径仅对当前目标可见。这是最常用的选项。
• PUBLIC：包含路径对当前目标和依赖它的目标都可见。
• INTERFACE：包含路径仅对依赖当前目标的目标可见。这对于库来说很有用，因为你可以隐藏库的内部实现细节，只暴露接口给使用者。

示例

假设你的项目结构如下：

my_project/
├── CMakeLists.txt
├── include/
│   └── my_header.h
└── src/
    └── main.cpp

你的 CMakeLists.txt 文件可能看起来像这样：

cmake_minimum_required(VERSION 3.10)
project(MyProject)

# 设置 C++ 标准
set(CMAKE_CXX_STANDARD 11)

# 添加可执行文件
add_executable(my_executable src/main.cpp)

# 为 my_executable 设置包含路径
target_include_directories(my_executable PRIVATE ${CMAKE_SOURCE_DIR}/include)

这样，当编译器编译 my_executable 时，它就会在 ${CMAKE_SOURCE_DIR}/include 目录中查找头文件，如 my_header.h。