如何编辑ROS2中使用的CMakeLists.txt文件

在ROS 2中，CMakeLists.txt文件用于定义构建系统的配置和指令。以下是一些常见的编辑CMakeLists.txt文件的示例操作：

添加依赖项：

如果您的ROS 2包依赖其他的软件包，您需要在CMakeLists.txt文件中添加这些依赖项。找到find_package或ament_target_dependencies行，根据需要添加或修改依赖项。例如，如果您的包依赖std_msgs和geometry_msgs，可以使用以下方式添加：

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)
find_package(geometry_msgs REQUIRED)

# ...

ament_target_dependencies(your_node
  rclcpp
  std_msgs
  geometry_msgs
)

添加源文件：

如果您有新的源文件需要编译，您需要在CMakeLists.txt文件中添加这些文件。在适当的位置添加add_executable或add_library行，指定要编译的源文件列表。例如，如果您有一个名为my_node.cpp的源文件，可以使用以下方式添加：

add_executable(your_node
  src/my_node.cpp
)

链接库和依赖项：

如果您的包需要链接其他库或依赖项，您可以使用target_link_libraries指令进行配置。找到适当的位置，并添加对应的库。例如，如果您的包需要链接一个名为your_library的库，可以使用以下方式添加：

target_link_libraries(your_node
  your_library
)

安装目标：

在ROS 2中，您可以使用ament_target_dependencies指令指定要安装的目标。确保在install部分中正确设置安装目标。例如，要安装名为your_node的目标，可以使用以下方式添加：

install(TARGETS
  your_node
  DESTINATION lib/${PROJECT_NAME}
)

添加编译选项：

您可以在CMakeLists.txt文件中添加编译选项以控制构建过程。例如，您可以使用add_compile_options指令添加特定的编译标志。例如，要添加调试符号和启用优化，可以添加以下行：

1 2	`add_compile_options(-g -O2)`

您可以使用CMAKE_INSTALL_PREFIX变量来定义安装目录。例如，如果您希望将软件包安装到/opt/ros2目录下，可以添加以下行：

1 2	`set(CMAKE_INSTALL_PREFIX "/opt/ros2")`

添加依赖库路径：

如果您的包依赖于其他库，并且这些库位于非标准路径下，您可以使用link_directories指令添加这些依赖库的路径。例如，如果您的依赖库位于/path/to/lib目录下，可以添加以下行：

1 2	`link_directories(/path/to/lib)`

设置包含路径：

如果您的包需要包含其他头文件路径，您可以使用include_directories指令添加这些路径。例如，如果您的头文件位于/path/to/include目录下，可以添加以下行：

1 2	`include_directories(/path/to/include)`

添加编译目标：

如果您需要在构建过程中生成其他目标（例如静态库或共享库），您可以使用add_library或add_executable指令来定义这些目标。例如，如果您想构建一个名为my_library的静态库，可以添加以下行：

add_library(my_library STATIC
  src/my_library.cpp
)

添加自定义目标：

您可以使用add_custom_target指令添加自定义目标，以便在构建过程中执行特定的自定义命令。例如，如果您希望在构建过程中运行一个脚本，可以添加以下行：

add_custom_target(my_target
  COMMAND ${CMAKE_SOURCE_DIR}/scripts/my_script.sh
)

设置安装规则：

通过使用install指令，您可以指定在安装软件包时安装哪些文件或目标。例如，如果您想安装config文件夹下的所有文件，可以添加以下行：

install(DIRECTORY config/
  DESTINATION share/${PROJECT_NAME}/config
)

导出依赖关系：

如果您的ROS 2包作为其他包的依赖项，您可以使用ament_export_dependencies指令将依赖关系导出给其他包使用。例如，如果您的包依赖std_msgs和geometry_msgs，可以添加以下行：

find_package(std_msgs REQUIRED)
find_package(geometry_msgs REQUIRED)

# ...

ament_export_dependencies(
  std_msgs
  geometry_msgs
)

添加测试：

您可以在CMakeLists.txt文件中添加测试以验证您的ROS 2包的功能和正确性。使用ament_add_gtest或ament_add_gtest_executable指令可以方便地添加Google Test单元测试。例如，如果您想添加一个名为test_my_node.cpp的测试文件，可以添加以下行：

ament_add_gtest(test_my_node
  test/test_my_node.cpp
)
target_link_libraries(test_my_node your_library)

添加安装规则：

除了安装目标之外，您还可以添加其他安装规则来安装其他文件或目录。例如，如果您想安装launch文件夹下的所有文件，可以添加以下行：

install(DIRECTORY launch/
  DESTINATION share/${PROJECT_NAME}/launch
)

定义编译选项：

您可以使用add_compile_definitions指令添加预定义的编译选项，例如在编译过程中定义特定的宏。例如，如果您想定义一个名为DEBUG_MODE的宏，可以添加以下行：

1 2	`add_compile_definitions(DEBUG_MODE)`

使用ament扩展：

ROS 2提供了许多ament扩展宏和函数，用于更方便地配置和构建ROS 2软件包。例如，您可以使用ament_package宏来自动填充软件包的元数据。例如：

1
2
3

find_package(ament_cmake REQUIRED)
ament_package()

添加资源文件：

如果您的ROS 2包需要包含其他资源文件（如配置文件、数据文件等），您可以使用ament_python_install_package指令来添加这些资源文件。例如，如果您希望安装config.yaml和data.txt文件，可以添加以下行：

ament_python_install_package(
  package_name
  PACKAGE_DIR src/package_name
  FILES
    config.yaml
    data.txt
)

设置编译目标属性：

您可以使用set_target_properties指令设置编译目标的属性，如输出名称、编译标志等。例如，如果您想设置生成的可执行文件的输出名称为my_executable，可以添加以下行：

1 2	`set_target_properties(my_executable PROPERTIES OUTPUT_NAME my_executable)`

添加依赖包的导入：

如果您的ROS 2包依赖其他已安装的软件包，您可以使用ament_target_dependencies指令导入这些依赖包。这样可以确保在构建和运行过程中正确处理依赖关系。例如：

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)

# ...

ament_target_dependencies(your_node
  rclcpp
  std_msgs
)

定义构建类型：

您可以使用ament_package宏中的ament_package_config选项来定义构建类型（例如CMake、ament_cmake、ament_python等）。例如，要定义构建类型为ament_cmake，可以添加以下行：

1 2	`ament_package_config()`

添加自定义构建规则：

您可以使用add_custom_command指令添加自定义的构建规则。这允许您在构建过程中执行特定的自定义命令。例如，如果您想在构建过程中运行一个脚本来生成一些文件，可以添加以下行：

add_custom_command(
  OUTPUT generated_file.cpp
  COMMAND ${CMAKE_SOURCE_DIR}/scripts/generate_file.py
  DEPENDS script_file.py
)

这将在构建期间执行generate_file.py脚本，并生成generated_file.cpp文件。

添加编译器标志：

您可以使用target_compile_options指令添加特定的编译器标志。这使您可以设置编译过程中使用的标志。例如，要添加警告标志，可以添加以下行：

1 2	`target_compile_options(your_node PRIVATE -Wall -Wextra)`

这将在编译your_node目标时启用额外的警告。

您可以使用install(DIRECTORY …)指令安装整个目录，包括其中的文件和子目录。例如，如果您想安装resources目录下的所有内容，可以添加以下行：

install(DIRECTORY resources/
  DESTINATION share/${PROJECT_NAME}/resources
)

这将安装resources目录及其下的所有内容到相应的安装目录。

添加环境变量：

如果您需要在构建过程中设置特定的环境变量，您可以使用ament_environment_hooks指令添加环境变量设置的钩子。例如，如果您需要在构建期间设置MY_VARIABLE环境变量为my_value，可以添加以下行：

ament_environment_hooks(
  "${ament_cmake_package_templates_ENVIRONMENT_HOOK_LIBRARY_PATH}"
  "${CMAKE_CURRENT_SOURCE_DIR}/env-hooks/my_env_hook.sh"
)

这将在构建期间执行my_env_hook.sh脚本，设置环境变量。

添加编译目标的依赖关系：

如果您的ROS 2包的编译目标依赖于其他目标，您可以使用add_dependencies指令添加这些依赖关系。这样可以确保在构建目标时正确处理依赖关系。例如，如果您的your_node目标依赖于dependency_node目标，可以添加以下行：

1 2	`add_dependencies(your_node dependency_node)`

设置编译目标的属性：

您可以使用set_target_properties指令设置编译目标的属性，如链接标志、编译定义等。例如，如果您要为your_node目标添加特定的编译定义YOUR_DEFINE，可以添加以下行：

1 2	`set_target_properties(your_node PROPERTIES COMPILE_DEFINITIONS YOUR_DEFINE)`

导入其他软件包的CMake模块：

如果您的ROS 2包依赖于其他软件包并且需要使用其提供的CMake模块，您可以使用find_package()指令导入这些模块。例如，如果您的包依赖于ament_cmake软件包，可以添加以下行：

1 2	`find_package(ament_cmake REQUIRED)`

添加动态运行时依赖关系：

如果您的ROS 2包需要在运行时加载其他共享库或软件包，您可以使用ament_target_dependencies指令添加这些动态运行时依赖关系。例如，如果您的包在运行时依赖于rclcpp和std_msgs，可以添加以下行：

find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)

# ...

ament_target_dependencies(your_node
  rclcpp
  std_msgs
)

ROS2

#原创

如何编辑ROS2中使用的CMakeLists.txt文件

https://qiangsun89.github.io/2023/06/07/如何编辑ROS2中使用的CMakeLists-txt文件/

作者

Qiang Sun

发布于

2023年6月7日

许可协议

计算多边形的最小包络矩形上一篇

创建ros2 package并编译下一篇