CMake 与CmakeLists.txt语法

原文链接

• 0 CMAKE 常量与变量
• 2 给工程添加依赖

• 添加依赖库
• 添加依赖的头文件

• 3 顺序、循环、选择结构

• 选择结构

• 4.文件操作

• 文件列表
• 文件拷贝
• 文件添加一个软链接
• 生成库
• 生成可执行文件

#什么是CMake

CMake是一个比make更高级的编译配置工具，它可以根据不同平台、不同的编译器，生成相应的Makefile或者vcproj项目。
通过编写CMakeLists.txt，可以控制生成的Makefile，从而控制编译过程。CMake自动生成的Makefile不仅可以通过make命令构建项目生成目标文件，还支持安装（make install）、测试安装的程序是否能正确执行（make test，或者ctest）、生成当前平台的安装包（make package）、生成源码包（make package_source）、产生Dashboard显示数据并上传等高级功能，只要在CMakeLists.txt中简单配置，就可以完成很多复杂的功能，包括写测试用例。
 

① gcc是GNU Compiler Collection（就是GNU编译器套件），
也可以简单认为是编译器，当你有一个源码文件时就可以直接调用gcc来编译;

② 但是当你的程序包含很多个源文件时，用gcc命令逐个去编译时，你就很容易混乱而且工作量大，
这时候就需要make工具了，但make本身并没有编译和链接的功能，而是用类似于批处理的方式通过调用makefile文件中用户指定的命令来进行编译和链接的。

③ makefile是什么？简单的说就像一本菜谱， make工具就像厨师，
厨师按照菜谱知道了一道菜该如何操作， make工具就根据makefile中的命令进行编译和链接的。

④ makefile在一些简单的工程完全可以人工手下，但是当工程非常大的时候，手写makefile也是非常麻烦的，如果换了个平台makefile又要重新修改。

⑤ 这时候就需要cmake这个工具， cmake可以更加简单的生成makefile文件给make用。
当然cmake还可以跨平台生成对应平台能用的makefile，你不用再自己去修改了。

⑥ cmake根据什么生成makefile呢？它又要根据CMakeLists.txt文件去生成makefile，这个CMakeLists.txt

所以只要我们学会了CmakeLists.txt文件的编写，就可以构建我们的大型程序了。
 

---

#Cmake–CMakeList.txt的语法规则

1. cmake变量使用${变量名}方式取值,但是在IF控制语句中是直接使用变量名
2. 环境变量使用$ENV{}方式取值,使用SET(ENV{VAR} VALUE)赋值
3. 指令参数(参数1 参数2…)，使用括弧括起,参数之间使用空格或分号分开
4. cmake不区分大小写，project等同于PROJECT ,add_executable等同于ADD_EXECUTABLE

0 CMAKE 常量与变量

##1. CmakeLists.txt基本配置

限定Cmake 版本

cmake_minimum_required(VERSION 2.8)

设定工程名

project(my-project)

添加版本号

// The version number.
set (Tutorial_VERSION_MAJOR 1)
set (Tutorial_VERSION_MINOR 0)

configure_file (
"${PROJECT_SOURCE_DIR}/TutorialConfig.h.in"
"${PROJECT_BINARY_DIR}/TutorialConfig.h"
)

然后在工程目录下新建一个TutorialConfig.h.in文件

 

 

// the configured options and settings for Tutorial
#define Tutorial_VERSION_MAJOR @Tutorial_VERSION_MAJOR@
#define Tutorial_VERSION_MINOR @Tutorial_VERSION_MINOR@

然后程序中包含#include "TutorialConfig.h"的头文件 Tutorial_VERSION_MAJOR, Tutorial_VERSION_MINOR)就会被替换成相应的整形版本值　　%d.%d => 1.0

 

 

 

2 给工程添加依赖

添加依赖库

find_package(<packager> [version] )
find_package命令是cmake提供的寻找某个库的头文件和库文件的命令。
如果在CMakeLists.txt中想添加某一个安装的库的头文件和库文件，
使用find_package()命令，如果cmake能找到它，就会提供头文件和库文件所在目录的变量。
例如：

find_package( Sophus REQUIRED )
include_directories( ${Sophus_INCLUDE_DIRS})　　　　#添加头文件目录

add_executable( useSophus useSophus.cpp)　　　　　#添加可执行文件
target_link_libraries( useSophus ${Sophus_LIBRARIES} )　#添加库文件目录

find_package 查找有两种方式

Module模式：搜索CMAKE_MODULE_PATH指定路径下的FindXXX.cmake文件，执行该文件从而找到XXX库。其中，具体查找库并给XXX_INCLUDE_DIRS和XXX_LIBRARIES两个变量赋值的操作由FindXXX.cmake模块完成。

Config模式：搜索XXX_DIR指定路径下的XXXConfig.cmake文件，执行该文件从而找到XXX库。其中具体查找库并给XXX_INCLUDE_DIRS和XXX_LIBRARIES两个变量赋值的操作由XXXConfig.cmake模块完成。

所以通常可以在find_package前面加一个set

set(OpenCV_DIR  ~/ssd/software/opencv3.3.1/build)   #添加OpenCVConfig.cmake的搜索路径
find_package( OpenCV 3 REQUIRED )

添加依赖的头文件

###添加子文件夹
add_subdirectory(source_dir [binary_dir] [EXCLUDE_FROM_ALL])

 

• source-dir指定添加文件夹的路径 里面可以包含源文件和CmakeLists.txt
• binary-dir 指定目标文件夹

 3 顺序、循环、选择结构

 

###循环
使用的场景：

• 拷贝某个文件夹下的数据到另一个地方，比如include文件、image文件等

foreach循环 foreach(loop_var RANGE total) 中间的操作…… endforeach(loop_var)

 选择结构

＃选择条件　宏定义，是否添加某一个库
# should we use our own math functions?
option (USE_MYMATH 
        "Use tutorial provided math implementation" ON) 

# add the MathFunctions library?

if (USE_MYMATH)
  include_directories ("${PROJECT_SOURCE_DIR}/MathFunctions")
  add_subdirectory (MathFunctions)
  set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)
endif (USE_MYMATH)
 
# add the executable
add_executable (Tutorial tutorial.cxx)
target_link_libraries (Tutorial  ${EXTRA_LIBS})

##然后在　
可执行文件的源文件中包含库的头文件　这个例子是说是否
#include <math.h>
#ifdef USE_MYMATH
#include "MathFunctions.h"
＃endif

或者在前面说的TutorialConfig.h.in　文件中宏定义
#cmakedefine USE_MYMATH

4.文件操作

文件列表

file(GLOB variable_name [RELATIVE path] [globbingexpressions]…) 产生一个路径中文件组成的列表，并将其保存到变量中 file(COPY files… DESTINATION dir） 将文件拷贝到目标文件夹dir

## lib file list
 file(GLOB gstcam_source  lib/gstreamer/*cpp  lib/image/*cpp lib/cuda/*cpp lib/cuda/*cu  lib/opengl/*cpp  )
 file(GLOB gstcam_include lib/gstreamer/*h  lib/image/*h lib/cuda/*h lib/opengl/*h)


 foreach(sources ${gstcam_source})
 MESSAGE("-- the ${PROJECT_NAME}  contion ${sources}")     
 endforeach(sources ${})

文件拷贝

configure_file(input-file output-file_or_dir COPYONLY)
file(COPY input-file DESTINATION output_dir})

# copy image data
file(GLOB imageData ${PROJECT_SOURCE_DIR}/data/images/*)
## 先设置一个文件列表 例如这里的imageData
## 使用foreach循环
foreach(image ${imageData})
	message("-- Copying ${image}")
	file(COPY ${image} DESTINATION ${CMAKE_RUNTIME_OUTPUT_DIRECTORY})
endforeach()

文件添加一个软链接

# create symbolic link for network data
execute_process( COMMAND "${CMAKE_COMMAND}" "-E" "create_symlink" "${PROJECT_SOURCE_DIR}/data/networks" "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/networks" )
# 前面是源文件的路径，后面是目标文件的路径

##生成目标

生成库

add_library(MathFunctions mysqrt.cxx)
指定库的名称，后面是库所需要的原文件文件

add_library(lib-name
  src/gstcamera.cpp
)
add_dependencies(gstcamera ${${PROJECT_NAME}_EXPORTED_TARGETS} ${catkin_EXPORTED_TARGETS})
target_link_libraries(gstcamera
  ${catkin_LIBRARIES}
  ${GSTREAMER_LIBRARIES}
 ${GST_APP_LIBRARIES} 
 # ${GSTREAMER_LIBRARIES}
 # ${GST_APP_LIBRARIES}
)

生成可执行文件

# add the executable
add_executable (Tutorial tutorial.cxx)  
#哪个可执行文件用到了这个依赖库，给他链接上
target_link_libraries (Tutorial MathFunctions)

###安装

install (TARGETS MathFunctions DESTINATION bin)
install (FILES MathFunctions.h DESTINATION include)

# add the install targets
install (TARGETS Tutorial DESTINATION bin)
install (FILES "${PROJECT_BINARY_DIR}/TutorialConfig.h"        
         DESTINATION include)

参考文档：
cmake使用示例与整理总结