一只捡星星的熊

想说的话

没什么要说的，只是一个单纯的学习内容记录而已

了解更多

标签

一只捡星星的熊

想说的话

没什么要说的，只是一个单纯的学习内容记录而已

了解更多

标签

一只捡星星的熊

想说的话

没什么要说的，只是一个单纯的学习内容记录而已

了解更多

标签

音乐播放器

分类

站点统计

文章

42

分类

17

标签

29

总字数

343,408

运行天数

0 天

最后活动

0 天前

分类

音乐播放器

429 字

1 分钟

cmake文件配置

2025-11-28

构建工具

cmake

一、基础#

1.基础语法#

1.指定Cmake最低版本

1
cmake_minimum_required(VERSION 3.10)

2.定义项目的名称和使用的编程语言：

1
project(<project_name> [<language>...])

3.指定要生成的可执行文件和其源文件：

1
add_executable(<target> <source_files>...)

4.创建一个库（静态库或动态库）及其源文件：

1
add_library(<target> <source_files>...)

5.链接目标文件与其他库：

1
target_link_libraries(<target> <libraries>...)

6.添加头文件搜索路径：

1
include_directories(<dirs>...)

7.设置变量的值：

1
set(<variable> <value>...)

8.设置目标属性：

1
target_include_directories(TARGET target_name
2
                          [BEFORE | AFTER]
3
                          [SYSTEM] [PUBLIC | PRIVATE | INTERFACE]
4
                          [items1...])

9.安装规则：

1
install(TARGETS target1 [target2 ...]
2
        [RUNTIME DESTINATION dir]
3
        [LIBRARY DESTINATION dir]
4
        [ARCHIVE DESTINATION dir]
5
        [INCLUDES DESTINATION [dir ...]]
6
        [PRIVATE_HEADER DESTINATION dir]
7
        [PUBLIC_HEADER DESTINATION dir])

10.条件语句 (if, elseif, else, endif 命令)

1
if(expression)
2
  # Commands
3
elseif(expression)
4
  # Commands
5
else()
6
  # Commands
7
endif()

11.自定义命令 (add_custom_command 命令)：

1
add_custom_command(
2
   TARGET target
3
   PRE_BUILD | PRE_LINK | POST_BUILD
4
   COMMAND command1 [ARGS] [WORKING_DIRECTORY dir]
5
   [COMMAND command2 [ARGS]]
6
   [DEPENDS [depend1 [depend2 ...]]]
7
   [COMMENT comment]
8
   [VERBATIM]
9
)

2.变量缓存#

定义变量：

1
set(MY_VAR "Hello World")

使用变量：

1
message(STATUS "Variable MY_VAR is ${MY_VAR}")

定义缓存变量：

1
set(MY_CACHE_VAR "DefaultValue" CACHE STRING "A cache variable")

使用缓存变量：

1
message(STATUS "Cache variable MY_CACHE_VAR is ${MY_CACHE_VAR}")

3.查找库和包#

find_package() 指令

基本用法：

1
find_package(Boost REQUIRED)

指定版本：

1
find_package(Boost 1.70 REQUIRED)

查找库并指定路径：

1
find_package(OpenCV REQUIRED PATHS /path/to/opencv)

使用查找到的库：

1
target_link_libraries(MyExecutable Boost::Boost)

1
include_directories(${Boost_INCLUDE_DIRS})
2
link_directories(${Boost_LIBRARY_DIRS})

二、ROS2 的 ament 语法#

1.基础语法#

项目初始化

1
cmake_minimum_required(VERSION 3.8)
2
project(my_project)  # 必须与 package.xml 中的包名一致

编译器标准配置

1
if(NOT CMAKE_C_STANDARD)
2
  set(CMAKE_C_STANDARD 99)
3
endif()
4
if(NOT CMAKE_CXX_STANDARD)
5
  set(CMAKE_CXX_STANDARD 17)
6
endif()
7

8
# 编译器警告选项
9
if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
10
  add_compile_options(-Wall -Wextra -Wpedantic)
11
endif()

最终调用

1
ament_package()  # 必须放在 CMakeLists.txt 的最后

2.依赖管理语法#

查找依赖包

1
find_package(ament_cmake REQUIRED)
2
find_package(rclcpp REQUIRED)
3
find_package(plansys2_executor REQUIRED)

为目标添加依赖

1
ament_target_dependencies(<目标名称> [SYSTEM] [INTERFACE|PUBLIC] <依赖包1> <依赖包2> ...)
2

3
#示例：
4
add_executable(my_node src/my_node.cpp)
5
ament_target_dependencies(my_node
6
  rclcpp
7
  plansys2_executor
8
  plansys2_planner
9
)

这个宏自动处理三件事：

添加依赖项的头文件路径
链接依赖项的库
处理传递性依赖

注意：官方文档指出，ament_target_dependencies() 现在已被标记为废弃，推荐使用 target_link_libraries() 配合现代 CMake 目标
```
1
target_link_libraries(my_node PUBLIC
2
  ${rclcpp_TARGETS}
3
  ${plansys2_executor_TARGETS}
4
)
```

3.导出语法#

导出目标

1
ament_export_targets(export_${PROJECT_NAME} HAS_LIBRARY_TARGET)

导出依赖

1
ament_export_dependencies(rclcpp plansys2_executor)

导出包含目录

1
ament_export_include_directories(include)

导出库

1
ament_export_libraries(my_library)

完整导出示例：

1
# 安装头文件
2
install(
3
DIRECTORY include/
4
DESTINATION include/${PROJECT_NAME}
5
)
6

7
# 安装目标并导出
8
install(
9
TARGETS my_library
10
EXPORT export_${PROJECT_NAME}
11
LIBRARY DESTINATION lib
12
ARCHIVE DESTINATION lib
13
RUNTIME DESTINATION bin
14
INCLUDES DESTINATION include
15
)
16

17
ament_export_targets(export_${PROJECT_NAME} HAS_LIBRARY_TARGET)
18
ament_export_dependencies(rclcpp)

4.其他导出语法#

导出Cmake接口目标

1
ament_export_interfaces()

导出编译器定义

1
ament_export_definitions()

导出链接器标志

1
ament_export_link_flags()

5.自动化工具语法（ament_cmake_auto）#

自动查找依赖

1
ament_auto_find_build_dependencies()  # 自动从 package.xml 查找所有构建依赖
2
ament_auto_find_test_dependencies()   # 自动查找测试依赖

自动添加目标

1
ament_auto_add_library(my_library SRCS src/my_library.cpp)
2
ament_auto_add_executable(my_node src/my_node.cpp)

自动添加测试

1
ament_auto_add_gtest(test_my_library test/test_my_library.cpp)
2
ament_auto_add_gmock(test_my_mock test/test_my_mock.cpp)

自动打包

1
ament_auto_package(INSTALL_TO_SHARE config launch)

6.完整示例#

1
cmake_minimum_required(VERSION 3.8)
2
project(robot_planer)
3

4
if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
5
  add_compile_options(-Wall -Wextra -Wpedantic)
6
endif()
7

8
# 查找依赖
9
find_package(ament_cmake REQUIRED)
10
find_package(rclcpp REQUIRED)
11
find_package(plansys2_executor REQUIRED)
12
find_package(plansys2_planner REQUIRED)
13
find_package(plansys2_msgs REQUIRED)
14

15
# 添加可执行文件
16
add_executable(patrol_expert src/patrol_expert.cpp)
17

18
# 添加依赖（推荐使用 target_link_libraries）
19
target_link_libraries(patrol_expert PUBLIC
20
  ${rclcpp_TARGETS}
21
  ${plansys2_executor_TARGETS}
22
  ${plansys2_planner_TARGETS}
23
)
24

25
# 或者使用 ament_target_dependencies（传统方式）
26
ament_target_dependencies(patrol_expert
27
  rclcpp
28
  plansys2_executor
29
  plansys2_planner
30
  plansys2_msgs
31
)
32

33
# 安装
34
install(TARGETS patrol_expert DESTINATION lib/${PROJECT_NAME})
35

36
# 最终调用
37
ament_package()