CMake Day 4 —— 设置头文件路径和链接库
# CMake Day 4 —— 设置头文件路径和链接库
# 设置头文件搜索路径
在项目中我们会经常会调用头文件（自己写的或者第三方库的），我们首先可以通过相对路径的方式去调用，例如#include "../../xxx.h"，但这样不灵活，如果被调用的头文件位置发生了变动，那就需要去调用的地方一一更改。在 CMake 代码中，我们可以通过include_directories和target_include_directories命令去包含头文件搜索路径，这样在代码中可以直接调用头文件，而不需要加路径。
语法：
include_directories([AFTER|BEFORE] [SYSTEM] dir1 [dir2 ...])
target_include_directories(<target> [SYSTEM] [BEFORE]
<INTERFACE|PUBLIC|PRIVATE> [items1...]
[<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
2
3
4
5
6
这里的相对路径将会被解释为相对于当前源目录。
include_directories是全局包含的，项目中所有子目录都能够引用。
target_include_directories是针对某个二进制文件的，能够更好的控制访问的粒度。
AFTER:表示指定目录会附加到当前目录列表之后，默认是AFTER；BEFORE:表示指定目录会添加到当前目录列表之前；SYSTEM:表示指定目录是系统包含目录；
这里要指出一点：头文件路径列表中的第一条路径是根路径(root_dir)，#include "xx.h"是相对于这个根路径的，相当于#include "root_dir/xx.h"。
<target>:是 add_executable()或者 add_library()创建的目标；
PRIVATE: 私有，指这里引用的头文件路径仅仅被这个目标使用，目标不会对外暴露引用的头文件路径；
PUBLIC: 公有，指这里引用的头文件路径不仅被这个目标使用，目标还会对外暴露引用的头文件路径;
INTERFACE:接口，指这里引用的头文件路径不被这个目标使用，但目标会对外暴露引用的头文件路径;
我们可以通过INCLUDE_DIRECTORIES(PUBLIC, PRIVATE)和INTERFACE_INCLUDE_DIRECTORIES(PUBLIC, INTERFACE)属性查看添加的头文件搜索路径。
用法：
include_directories(./include)
include_directories(./include/gtest)
include_directories(BEFORE ./include/gmock)
# 打印指定的头文件搜索路径
get_property(dirs DIRECTORY ${CMAKE_SOURCE_DIR} PROPERTY INCLUDE_DIRECTORIES)
message("${dirs}")
2
3
4
5
6
7
target_include_directories(demo PUBLIC ./person)
# 打印指定的头文件搜索路径
get_property(public_private_dirs TARGET demo PROPERTY INCLUDE_DIRECTORIES)
message("public_private_dirs: ${public_private_dirs}")
get_property(public_interface_dirs TARGET person PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
message("public_interface_dirs: ${public_interface_dirs}")
2
3
4
5
6
7
8
结果：
public_private_dirs: /home/Pro/cmake-demo/cmake-day-4/person/../add
public_private_dirs: /home/Pro/cmake-demo/cmake-day-4/./person
public_interface_dirs: /home/Pro/cmake-demo/cmake-day-4/person/../print
2
3
# 链接库
当需要调用第三方库时，可以使用link_directories()/target_link_directories()和target_link_libraries()来指定链接器搜索路径和需要链接的库。
语法：
link_directories([AFTER|BEFORE] directory1 [directory2 ...])
target_link_directories(<target> [BEFORE]
<INTERFACE|PUBLIC|PRIVATE> [items1...]
[<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
2
3
4
5
这里的相对路径将会被解释为相对于当前源目录。
他们指定的路径将会被target_link_libraries()直接使用。
link_directories是全局的，target_link_directories是针对某个二进制文件的，能够更好的控制访问的粒度。
PRIVATE: 私有，指这里引用的库文件路径仅仅被这个目标使用，目标不会对外暴露引用的库文件路径；
PUBLIC: 公有，指这里引用的库文件路径不仅被这个目标使用，目标还会对外暴露引用的库文件路径;
INTERFACE:接口，指这里引用的库文件路径不被这个目标使用，但目标会对外暴露引用的库文件路径;
target_link_libraries(<target>
<PRIVATE|PUBLIC|INTERFACE> <item>...
[<PRIVATE|PUBLIC|INTERFACE> <item>...]...)
2
3
<target>:是 add_executable()或者 add_library()创建的目标；
PRIVATE: 私有，指被链接的库(item)仅仅被目标(target)使用，目标(target)不对外暴露这个被链接的库(item)的接口；
PUBLIC: 公有，指被链接的库(item)不仅被目标(target)使用，目标(target)还对外暴露这个被链接的库(item)的接口;
INTERFACE:接口，指被链接的库(item)不被目标(target)使用，但目标(target)对外暴露这个被链接的库(item)的接口;
用法：
add_executable(demo main.cpp)
target_include_directories(demo PUBLIC ./person)
target_link_directories(demo PUBLIC ./person)
target_link_libraries(demo PUBLIC person)
2
3
4
5
6
7
# 完整示例
https://github.com/AZMDDY/cmake-demo/tree/main/cmake-day-4 (opens new window)