target_include_directories 的作用和使用方法

target_include_directories命令在CMake中用于为特定的目标（如可执行文件或库）指定包含（头文件）目录。这些指定的目录在编译时会被添加到编译器的搜索路径中，使得编译器可以找到目标的源文件包含的头文件。

作用

当项目包含多个目录，并且源文件在不同目录下分布时，target_include_directories能够帮助编译器找到这些分散的头文件。这对于保持项目的组织结构清晰、解决头文件依赖问题非常有用。

使用方法

target_include_directories的基本语法如下：

target_include_directories(<target>
  [BEFORE]
  <INTERFACE|PUBLIC|PRIVATE> [items1...]
  [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])

• <target>: 目标的名称，可以是可执行文件或库。
• BEFORE: 可选关键字，指定包含目录应该在默认目录之前被添加到编译器的搜索路径。
• <INTERFACE|PUBLIC|PRIVATE>: 指定包含目录的范围：
  • PRIVATE: 目录仅对该目标可见，不会影响依赖该目标的其他目标。
  • INTERFACE: 目录不会添加到该目标的编译选项中，但会添加到链接该目标的其他目标中。
  • PUBLIC: 目录既会添加到该目标的编译选项中，也会添加到链接该目标的其他目标中。
• [items...]: 要添加为包含目录的路径列表。

示例

假设有一个库mylib和一个可执行文件myapp，mylib在lib/目录下，而myapp需要包含mylib的头文件来使用它。

# 定义库目标
add_library(mylib SHARED lib/mylib.cpp)

# 将lib目录（相对于当前CMakeLists.txt文件的路径）添加到mylib的包含目录中
target_include_directories(mylib PRIVATE lib)

# 定义可执行文件目标
add_executable(myapp src/main.cpp)

# 为myapp添加包含目录，假设它需要包含mylib的公共头文件
target_include_directories(myapp PRIVATE lib)

# 链接myapp与mylib
target_link_libraries(myapp PRIVATE mylib)

在这个例子中，myapp需要访问mylib的头文件，所以为myapp目标添加了lib目录作为私有包含目录。同时，mylib也将其源文件所在的lib目录作为私有包含目录，以确保编译器能找到其内部头文件。