CMake 添加头文件搜索路径 include_directories, target_include_directories

目录

• include_directories
• target_include_directories
  • AFTER或BEFORE
  • INTERFACE，PUBLIC，PRIVATE
  • SYSTEM
• include_directories与target_include_directories区别
• 参考

include_directories

将指定目录添加到编译器的头文件搜索路径，指定的目录被解释成当前源码路径的相对路径。

语法格式：

include_directories ([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])

默认情况下，include_directories命令会将目录添加到列表最后（AFTER选项）。不过，可通过命令设置CMAKE_INCLUDE_DIRECTORIES_BEFORE为ON来改变其默认行为，而将目录添加到列表前面。也可以在每次调用include_directories命令时使用AFTER或BEFORE选项，来指定添加到列表前面或者后面。如果使用SYSTEM选项，会把指定目录当成系统的搜索目录。

该命令作用范围只在当前CMakeLists.txt。

例如，在Linux下，C编译器默认搜索路径：

/usr/include
/usr/local/include

如果我们项目的根目录下，有公共头文件目录include1、include2需要添加到C编译器的默认搜索路径，可在CMakeLists.txt中添加：

include_directories(include1) # 相对路径: 当前CMakeLists.txt和include1必须在同一目录下
include_directories(${PROJECT_SOURCE_DIR}/include2) # 绝对路径: 通过源码根目录来定位include2

target_include_directories

为指定目标（target）添加搜索路径。指定目标，是指通过如add_executable()，add_library()这样的命令生成的，并且决不能是alias target（引用目标，别名目标）。
语法格式：

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

AFTER或BEFORE

AFTER或BEFORE选项，可以选择让添加的路径位于搜索列表的开头或结尾。缺省时，默认是AFTER。

INTERFACE，PUBLIC，PRIVATE

INTERFACE，PUBLIC，PRIVATE指定接下来的参数item（即路径）的作用域：

• INTERFACE target对应的头文件才能使用，会指定target的属性INTERFACE_INCLUDE_DIRECTORIES
• PUBLIC target对应头文件和源文件都能使用，会指定target的属性INCLUDE_DIRECTORIES 和INTERFACE_INCLUDE_DIRECTORIES
• PRIVATE target对应源文件使用，会指定target的属性INCLUDE_DIRECTORIES

注意：
1）所谓使用，是指添加头文件搜索路径（item）。
2）target的属性可以通过set_property()修改。

例如，单独为目标projectA添加搜索路径include1。

# 注意当前CMakeLists.txt与include1路径的相对位置关系
target_include_directories(projectA PRIVATE ./include1)

add_executable(projectA main.cpp)

SYSTEM

如果指定SYSTEM，在一些平台上，编译器会将路径作系统包含目录路径，可能对包含的头文件在依赖计算时的警告或者忽略，有一些影响。如果SYSTEM和PUBLIC或INTERFACE同时指定，target的属性INTERFACE_SYSTEM_INCLUDE_DIRECTORIES将填充指定目录。

include_directories与target_include_directories区别

include_directories 会为当前CMakeLists.txt的所有目标，以及之后添加的所有子目录的目标添加头文件搜索路径。因此，慎用target_include_directories，因为会影响全局target。

target_include_directories 只会为指定目标包含头文件搜索路径。如果想为不同目标设置不同的搜索路径，那么用target_include_directories更合适。

参考

https://cmake.org/cmake/help/latest/command/target_include_directories.html