ROS学习:ROS文件系统--CMakeLists.txt

ROS 中最常见到的 CMakelists.txt 是 ROS 系统内很重要的文件,下面就对这个文件进行学习吧!

CMakeLists.txt作用

CMakeLists.txt 原本是 Cmake 编译系统的规则文件,而 Catkin 编译系统基本沿用了 CMake 的
编译风格,只是针对ROS工程添加了一些宏定义。所以在写法上,catkin 的 CMakeLists.txt 与 CMake 的基本一致。
这个文件直接规定了这个 package 要依赖哪些 package ,要编译生成哪些目标,如何编译等等流程。所以 CMakeLists.txt 非常重要,它指定了由源码到目标文件的规则,catkin 编译系统在工作时首先会找到每个 package 下的 CMakeLists.txt ,然后按照规则来编译构建。

CMakeLists.txt的写法

CMakeLists.txt 的基本语法都还是按照 CMake,而 Catkin 在其中加入了少量的宏,总体的结构如下:

cmake_minimum_required()      #CMake的版本号
project()                     #项目名称
find_package()                #找到编译需要的其他CMake/Catkin package
catkin_python_setup()         #catkin新加宏,打开catkin的Python Module的支持
add_message_files()           #catkin新加宏,添加自定义Message/Service/Action文件
add_service_files()
add_action_files()
generate_message()            #catkin新加宏,生成不同语言版本的msg/srv/action接口
catkin_package()              #catkin新加宏,生成当前package的cmake配置,供依赖本包的其他软件包调用
add_library()                 #生成库
add_executable()              #生成可执行二进制文件
add_dependencies()            #定义目标文件依赖于其他目标文件,确保其他目标已被构建
target_link_libraries()       #链接
catkin_add_gtest()            #catkin新加宏,生成测试
install()                     #安装至本机

如果你从未接触过CMake的语法,请阅读《CMake实践》:https://github.com/Akagi201/learning-cmake/blob/master/docs/cmake-practice.pdf 。掌握CMake语法对于理解ROS工程很有帮助。

CMakeLists例子

为了详细的解释 CMakeLists.txt 的写法,我们以 turtlesim 小海龟这个 pacakge 为例,读者可roscd
到 tuetlesim 包下查看,在 turtlesim/CMakeLists.txt 的写法如下:

cmake_minimum_required(VERSION 2.8.3)       
#CMake至少为2.8.3版

project(turtlesim)
#项目(package)名称为turtlesim,在后续文件中可使用变量 ${PROJECT_NAME} 来引用项目名称 turltesim

find_package(catkin REQUIRED COMPONENTS geometry_msgs message_generation rosconsole ro
scpp roscpp_serialization roslib rostime std_msgs std_srvs)
#cmake宏,指定依赖的其他pacakge,实际是生成了一些环境变量,如<NAME>_FOUND,,<NAME>_INCLUDE_DIRS
,<NAME>_LIBRARYIS          
#此处catkin是必备依赖其余的 geometry_msgs... 为组件

find_package(Qt5Widgets REQUIRED) 
find_package(Boost REQUIRED COMPONENTS thread)

include_directories(include ${catkin_INCLUDE_DIRS} ${Boost_INCLUDE_DIRS})
#指定C++的头文件路径
link_directories(${catkin_LIBRARY_DIRS})
#指定链接库的路径

add_message_files(DIRECTORY msg FILES
Color.msg Pose.msg)
#自定义msg文件

add_service_files(DIRECTORY srv FILES
Kill.srv
SetPen.srv
Spawn.srv
TeleportAbsolute.srv
TeleportRelative.srv)
#自定义srv文件

generate_messages(DEPENDENCIES geometry_msgs std_msgs std_srvs)
#在 add_message_files、add_service_files 宏之后必须加上这句话,用于生成 srv msg 头文件 /module,生成的文件位于devel/include中

catkin_package(CATKIN_DEPENDS geometry_msgs message_runtime std_msgs std_srvs)
# catkin 宏命令,用于配置 ROS的package 配置文件和 CMake 文件
# 这个命令必须在 add_library() 或者 add_executable() 之前调用,该函数有5个可选参数:
# (1) INCLUDE_DIRS    - 导出包的include路径
# (2) LIBRARIES       - 导出项目中的库
# (3) CATKIN_DEPENDS  - 该项目依赖的其他catkin项目
# (4) DEPENDS         - 该项目所依赖的非catkin CMake项目。
# (5) CFG_EXTRAS      - 其他配置选项

set(turtlesim_node_SRCS
src/turtlesim.cpp
src/turtle.cpp
src/turtle_frame.cpp
)
set(turtlesim_node_HDRS
include/turtlesim/turtle_frame.h
)
#指定turtlesim_node_SRCS、turtlesim_node_HDRS变量

qt5_wrap_cpp(turtlesim_node_MOCS ${turtlesim_node_HDRS})
add_executable(turtlesim_node ${turtlesim_node_SRCS} ${turtlesim_node_MOCS})
# 指定可执行文件目标turtlesim_node

target_link_libraries(turtlesim_node Qt5::Widgets ${catkin_LIBRARIES} ${Boost_LIBRARIE
S})
# 指定链接可执行文件

add_dependencies(turtlesim_node turtlesim_gencpp)

add_executable(turtle_teleop_key tutorials/teleop_turtle_key.cpp)
target_link_libraries(turtle_teleop_key ${catkin_LIBRARIES})
add_dependencies(turtle_teleop_key turtlesim_gencpp)

add_executable(draw_square tutorials/draw_square.cpp)
target_link_libraries(draw_square ${catkin_LIBRARIES} ${Boost_LIBRARIES})
add_dependencies(draw_square turtlesim_gencpp)

add_executable(mimic tutorials/mimic.cpp)
target_link_libraries(mimic ${catkin_LIBRARIES})
add_dependencies(mimic turtlesim_gencpp)
# 同样指定可执行目标、链接、依赖

install(TARGETS turtlesim_node turtle_teleop_key draw_square mimic
RUNTIME DESTINATION ${CATKIN_PACKAGE_BIN_DESTINATION})
# 安装目标文件到本地系统

install(DIRECTORY images
DESTINATION ${CATKIN_PACKAGE_SHARE_DESTINATION}
FILES_MATCHING PATTERN "*.png" PATTERN "*.svg")

=============================================================================
本文作为笔记查阅之用,无涉其他用途。

发布了25 篇原创文章 · 获赞 9 · 访问量 1万+

猜你喜欢

转载自blog.csdn.net/qq_43667745/article/details/90137283
今日推荐