cmake学习笔记6-catkin的CmakeList.txt讲解

引用
cmake学习笔记-cmakelist.txt创建项目示例
cmake的介绍和使用 Cmake实践
推荐cmake手册详解
严重推荐CMake构建系统的骨架
catkin_make做了什么

基础变量

• 例如：

我在/home/yuhs/novatel_ws建立了一个novatel的工作空间

在我的电脑上有如下目录地址：
/home/yuhs/novatel_ws/devel/lib
/home/yuhs/novatel_ws/devel/lib/novatel
/home/yuhs/novatel_ws/devel/lib/novatel/novatel_node

/home/yuhs/novatel_ws/src/novatel/include/novatel
/usr/local/include/novatel

打印这些catkin系统变量信息如下：
CATKIN_PACKAGE_LIB_DESTINATION:lib
CATKIN_PACKAGE_BIN_DESTINATION:lib/novatel
CATKIN_PACKAGE_INCLUDE_DESTINATION:include/novatel

基础知识

• CMakeList.txt 文件中，命令名字是不区分大小写的，而参数和变量是大小写相关的

• ros的包 catkin_make后，可执行文件在./devel/lib/proj_name/proj_name_node

catkin_package()

• 参数解析
  在Extracted CMake API reference文档中搜索catkin_package()可以查看官方的说明doc，加深对以下参数的理解
  1、INCLUDE_DIRS：
  2、LIBRARIES：lib_name,这个lib_name的库会出现在这个catkin的catkin_LIBRARIES宏变量中，同时也会出现在${PROJECT_NAME}_LIBRARIES宏变量中，别的工程是可以通过find_package找到这个lib_name库的，
  3、CATKIN_DEPENDS：proj_name，此list中的内容，本质是catkin的项目，同时也是被此项目(这个cmakelist所在的这个工程项目)所依赖的catkin工程项目，此项目会通过find_package()或pkg-config来调用这些list中的内容；
  4、DEPENDS：proj_name，此list中的内容，本质是cmake的项目，同时也是被此项目(这个cmakelist所在的这个工程项目)所依赖的cmake工程项目，此项目会通过find_package()或pkg-config来调用这些list中的内容；
  5、CFG_EXTRAS：外部配置文件
  6、EXPORTED_TARGETS
  7、SKIP_CMAKE_CONFIG_GENERATION
  8、SKIP_PKG_CONFIG_GENERATION

catkin_package(
      INCLUDE_DIRS include
      LIBRARIES novatel
      CATKIN_DEPENDS serial roslib roscpp rosconsole tf gps_msgs nav_msgs sensor_msgs
      DEPENDS Boost
    )

FIND_PACKAGE

• FIND_PACKAGE 功能解释：
  会在全局，全盘寻找指定name的库，然后找到了后，就会将name_xxxx等变量赋值，就可以用对应的变量了，举例说明吧
  比如下面这些变量，就会被赋值

_FOUND 
_INCLUDE_DIRS or _INCLUDES
_LIBRARIES or _LIBS
_DEFINITIONS

• 命令用法：
  find_package( [version] [EXACT] [QUIET]
  [[REQUIRED|COMPONENTS] [components...]]
  [NO_POLICY_SCOPE])

• 例如：
  find_package(Boost 1.49.0 COMPONENTS unit_test_framework serialization)
  Boost就是package,COMPONENTS 后面跟着的就是列出的一些与包相关的部件清单，这句话我也没太理解，以后再补充，

当找到package后，Boost_INCLUDE_DIR这个变量就是被赋值了的，这都是自动化完成的

• REQUIRED 参数
  其含义是指是否是工程必须的，表示如果报没有找到的话，cmake的过程会终止，并输出警告信息。对应于

• COMPONENTS
  如何理解这个参数

  
  
  

  COMPONENTS参数的含义

• version参数
  需要一个版本号，它是正在查找的包应该兼容的版本号（格式是major[.minor[.patch[.tweak]]]）。

• EXACT选项
  要求版本号必须精确匹配。如果在find-module内部对该命令的递归调用没有给定[version]参数，那么[version]和EXACT选项会自动地从外部调用前向继承。对版本的支持目前只存在于包和包之间（详见下文）。

QUIET 参数：
会禁掉包没有被发现时的警告信息。对应于Find.cmake模块中的 NAME_FIND_QUIETLY。

• 和catkin相关的查找包
  如下所示：

find_package(catkin COMPONENTS serial roslib roscpp rosconsole tf gps_msgs nav_msgs sensor_msgs)

加入了catkin的关键字，每个ros的包都至少有一个find_package需要依赖catkin这个包
上面命令解释：查找catkin包，并且这个catkin包依赖组件：serial roslib roscpp rosconsole tf gps_msgs nav_msgs sensor_msgs

project()

如果子文件夹Cmakelists.txt当中没有project(name_xxx1)，那么使用PROJECT_NAME就会继承父文件夹当中的project(name_xxx)定的 name_xxx1，如果子目录当中的Cmakelists.txt当中定义过project(name_xxx2)，那么子目录当中的Cmakelists.txt当中的 PROJECT_NAME就会是子Cmakelists.txt定义的这个name_xxx

add_subdirectory()

add_subdirectory 会去这个指定的目录寻找子cmakelists.txt
在交叉目录 需要寻找头文件的时候，调用者的目录当中的CMakeLists.txt当中添加头文件路径

include_directories()

• 增加单个目录
  include_directories(include)
• 增加多个目录
  include_directories(include ${catkin_INCLUDE_DIRS} ${Boost_INCLUDE_DIRS})

库相关的指令

引用：跟库相关的几个命令讲解的帖子
http://blog.csdn.net/arackethis/article/details/43488177
http://blog.csdn.net/michaelhan3/article/details/69568362

1、ADD_LIBRARY

ADD_LIBRARY 告诉工程，生成一个库，并将源码链接到具体名字的库当中
例如：
add_library(lib_name ${SRC_LISTS}) #将集合里的所有的源文件生成一个静态库，该静态库的名字lib_name，注意，在整个CmakeLists里都要用lib_name这个

• BUILD_SHARED_LIBS
  这个参数属于catkin系统的参数，如果是on，则add_library构建的则是SHARED类型的库，就是动态库，如果是off，那么就是static的库
• 位置
  这个命令构建完毕的动态库所在位置如下所示()：
  /home/yuhs/novatel_ws/devel/lib/libnovatel.so

2、TARGET_LINK_LIBRARIES

• TARGET_LINK_LIBRARIES

语法：TARGET_LINK_LIBRARIES(targetlibrary1 library2 ..)

比如（以下写法（包括备注中的）都可以）：
TARGET_LINK_LIBRARIES(myProject hello)，连接libhello.so库到myProject(可执行文件)当中
TARGET_LINK_LIBRARIES(myProject libhello.a)
TARGET_LINK_LIBRARIES(myProject libhello.so)

再如：
TARGET_LINK_LIBRARIES(myProject libeng.so)　　#将libeng.so链接到myProject中。
TARGET_LINK_LIBRARIES(myProject eng)
TARGET_LINK_LIBRARIES(myProject -leng)

target_link_libraries(lib_name #链接静态库需要的依赖库
${OpenCV_LIBS}
${PROJECT_SOURCE_DIR}/lib/libCommonUtilities.so
${PROJECT_SOURCE_DIR}/lib/libInuStreams.so
)
从这个例子当中可以看出target_link_libraries功能，如果第一个是静态库(因为没有用shared相关的关键词，所以为静态)，那么就是把其他库也连接到这个静态库当中，第一个参数也可以是执行文件，然后将库链接到可执行的应用文件中，如下例子所示

3、LINK_DIRECTORIES（添加需要链接的库文件目录，这个是增加目录）

语法：
link_directories(directory1 directory2 ...)
它相当于g++命令的-L选项的作用，也相当于环境变量中增加LD_LIBRARY_PATH的路径的作用。
比如：
LINK_DIRECTORIES("/opt/MATLAB/R2012a/bin/glnxa64")
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$MATLAB/bin/glnxa64

4、LINK_LIBRARIE（添加需要链接的库文件的全路径，这个是增加具体的库文件）

List of direct link dependencies.
比如：
LINK_LIBRARIES("/opt/MATLAB/R2012a/bin/glnxa64/libeng.so")
LINK_LIBRARIES("/opt/MATLAB/R2012a/bin/glnxa64/libmx.so")
也可以写成：
LINK_LIBRARIES("/opt/MATLAB/R2012a/bin/glnxa64/libeng.so"　"/opt/MATLAB/R2012a/bin/glnxa64/libmx.so")

不同命令之间的关系讲解

1、生成可执行文件和链接库之间

先生成可执行文件，后把库连接到可执行文件中即可
add_executable(hello ${APP_SRC})
target_link_libraries(hello libhello)

链接工程的各种方法

1、把子模块的src源码 先链接为库，在把库连接到main可执行文件中

• 理解

• 例子说明，如下所示：

project(HELLO)
set(LIB_SRC hello.c)
set(APP_SRC main.c)
add_library(libhello ${LIB_SRC})
add_executable(hello ${APP_SRC})
target_link_libraries(hello libhello)

里面有一点不爽，对不？
因为我的可执行程序(add_executable)占据了 hello 这个名字，所以 add_library 就不能使用这个名字了
然后，我们去了个libhello 的名字，这将导致生成的库为 libhello.lib(或 liblibhello.a)，很不爽
想生成 hello.lib(或libhello.a) 怎么办?
添加一行
set_target_properties(libhello PROPERTIES OUTPUT_NAME "hello")
就可以了

2、源码添加到APP_SRC这种变量中，然后利用add_executable统一链接到main的可执行文件中

• 理解
• 例子说明

list

• list(APPEND [ ...])
  将element内容追加到list当中

install

cmake:install学习

• 1、install(TARGETS detect_cl img_tool test_detect
  RUNTIME DESTINATION bin
  LIBRARY DESTINATION lib
  ARCHIVE DESTINATION lib/static)
  【命令解析】：
  将生成的target安装到指定目录下，这里 detect_cl,img_tool是动态库,test_detect是可执行程序,
  cmake会自动根据target的类型将可执行程序(如.exe)和动态库(如.dll)作为RUNTIME类型复制到bin下,
  将动态库的导入库(.lib .a)作为ARCHIVE类型复制lib/static目录下
• install(DIRECTORY include/${PROJECT_NAME}/
  DESTINATION ${CATKIN_PACKAGE_INCLUDE_DESTINATION}
  FILES_MATCHING PATTERN ".h" PATTERN ".svn" EXCLUDE )
  【命令解析】：
  1、DESTINATION 会被${CATKIN_PACKAGE_INCLUDE_DESTINATION}替代
  2、include/${PROJECT_NAME}/
  DESTINATION ${CATKIN_PACKAGE_INCLUDE_DESTINATION} = include/novatel/include/novatel
  具体可以参照文章开头的描述信息，我的工作空间是以novatel作为例子分析
  3、FILES_MATCHING PATTERN ".h"意思：匹配所有.h的文件
  4、PATTERN ".svn" EXCLUDE意思：后面加了exclude，表明排除.svn的匹配