CMAKE学习笔记

CMAKE官方文档：https://cmake.org/cmake/help/latest/genindex.html#

CMAKE常用指令

CMake最低版本要求

CMAKE_MINIMUM_REQUIRED( VERSION 2.8 )

项目名称

PROJECT(  项目名称  )  

定义的项目名称存放到了变量 ${PROJECT_NAME}中。
包含CMakeLists.txt所在的文件夹目录路径存放到了变量 ${PROJECT_SOURCE_DIR}中。
用 ${ } 来引用变量

设置编译方式

SET( CMAKE_BUILD_TRPE Release )

编译方式有以下几种：
● Debug：调试模式，输出调试信息，不做优化
● Release：发布模式，没有调试信息，全优化
● RelWithDeblnfo：类似Release，但包括调试信息
● MinSizeRel：一种特殊的Release模式，会特别优化库的大小

编译CXX的设置标志

SET ( CMAKE_CXX_FLAGS " -Wall  " )

编译CXX时需要优化的配置，比如：
● -std=c++11：支持C++11
● -Wall：编译过程输出警告
● -O3：优化，提高代码速度
语句会覆盖CMakeLists.txt中前面的标志，如果要追加配置，要用在双引号里面追加之前的变量 ${CMAKE_CXX_FLAGS} ：

SET ( CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall" )

搜索外部库

//查找系统OpenCV3以上版本

FIND_PACKAGE( 外部库 版本 EXACT/QUIET/REQUIRED )
FIND_PACKAGE( OpenCV 3 REQUIRED )

参数意义：
● EXACT：要求该版本号必须精确匹配。
● QUIET：禁掉没有找到时的警告信息。
● REQUIRED：版本至少在这个之上。如果包没有找到时，CMake会终止并输出警告信息。
找到包以后，下面的变量会自动初始化：
● ${<NAME>_FOUND} ：显示是否找到库的标记。
● ${<NAME>_INCLUDE_DIRS} 或 ${<NAME>_INCLUDES} ：就是 的头文件路径（对应库的include）。
● ${<NAME>_LIBS} 或 ${<NAME>_LIBRARIES} ：库文件
FIND_PACKAGE两种寻找模式：

1. Module模式：搜索 ${CMAKE_MODULE_PATH}指定路径下的FindXXX.cmake文件，执行改文件从而找到XXX库。其中，具体查找库并给 ${XXX_INCLUDE_DIRS}和 ${XXX_LIBRARIES}两个变量赋值的操作均由FindXXX.cmake完成。
2. Config模式：搜索 ${XXX_DIR} 指定路径下的XXXConfig.cmake文件从而找到XXX库。其中具体查找库并给${XXX_INCLUDE_DIRS}和 ${XXX_LIBRARIES} 两个变量赋值的操作均由XXXConfig.cmake完成。如果${XXX_DIR}下未找到XXXConfig.cmake文件，则会找/usr/local/lib/cmake/XXX/目录下是否存在。如果库安装时没有安装到系统目录，则无法自动找到XXXConfig.cmake，需要手动添加搜索路径：

SET( XXX_DIR /home/nvidia/opencv/build )

● 注意：两种模式默认采用Module模式，如果未找到库，才会采取Config模式。

添加源文件子目录

ADD_SUBDIRECTORY( 子目录 )

目录可以使相对路径也可以是绝对路径。
之后，${CMAKE_SOURCE_DIR} 为源文件所在的绝对路径。

?查找源文件

AUX_SOURCE_DIRECTORY( 目录 文件名 )

生成可执行文件

ADD_EXECUTABLE( 可执行文件名  源文件 )

之后，${EXECUTABLE_OUTPUT_PATH}为可执行文件输出路径。

生成链接库文件

ADD_LIBRARY( 库文件名 STATIC/SHARED  源文件 )

STATIC表示静态链接库，SHARED表示共享链接库。
之后，${LIBRARY_OUTPUT_PATH} 为库文件输出路径。

静态库
● 原理：在编译时将源代码复制到程序中，运行时不用库文件依旧可以运行
● 优点：运行已有代码，运行时不用再用库；无需加载库，运行更快
● 缺点：占用更多的空间和磁盘；静态库升级，需要重新编译程序

动态库
● 原理：编译时仅仅记录用哪一个库里面的哪一个负号，不复制相关代码
● 优点：不复制代码，占空间小；多个程序可以同时调用一个库；升级方便，无需重新编译
● 缺点：程序运行需要加载库，耗费一定时间

为可执行文件链接库

TARGET_LINK_LIBRARIES( 可执行文件 库 )

指定头文件搜索路径

INCLUDE_DIRECTORIES( /usr/local/include )

.cpp 文件要引用头文件时，在设置的目录下搜索。

SET定义变量

SET( 变量 值 )
SET( SRC_LST main.cpp other.cpp )

用变量代替值，上面的语句意思是用变量SRC_LST代替后面两个cpp

LIST列表操作

LIST( 参数 <list> 内容 )

常用的参数有：
● APPEND：对追加 内容
● FILTER
● GET
● LENGTH
● JOIN
● SUBLIST
● FIND
● INSERT

判断语句

IF
ELSEIF
ENDIF

与C语言使用相同。

循环语句

FOREACH( <loop_var> <items> )
FOREACH( i 0 1 2 3 )
    message(STATUS "current is ${i} " )
ENDFOREACH(i)

使用注意事项

● 工程存在多个目录，可以每个目录都放一个CMakeLists.txt，也可以只用一个CMakeLists.txt。
● 指令不区分大小写

实例

一个图像去畸变函数，结构如下：
● include/base.h(opencv required)
● src/undistort.cpp(base.h opencv required)
● test/main.cpp
其中，main中调用undistort中函数，undistort需要链接opencv。
CMakeLists.txt如下：

# CMake 最低版本号要求
cmake_minimum_required( VERSION 2.8 )

# 项目名称
project( image_undistort )

# 设置编译方式
set( CMAKE_BUILD_TYPE Release )

#支持C++11
set( CMAKE_CXX_FLAGS "-std=c++11" )

# 查找系统里的OpenCV
find_package( OpenCV 3 REQUIRED )

# 添加项目包含路径
include_directories( 
	${PROJECT_SOURCE_DIR}/include/
	${OpenCV_INCLUDE_DIRS} 
	)

message("PROJECT_SOURCE_DIR = " ${PROJECT_SOURCE_DIR})
set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR}/bin)
set(LIBRARY_OUTPUT_PATH  ${CMAKE_BINARY_DIR}/lib)
message("CMAKE_BINARY_DIR = " ${CMAKE_BINARY_DIR})
message("CMAKE_SOURCE_DIR = " ${CMAKE_SOURCE_DIR})

# 将指定的源文件生成链接库文件。STATIC 为静态链接库，SHARED 为共享链接库
add_library(lib_undistort ${PROJECT_SOURCE_DIR}/source/undistort.cpp)

# 为库或可执行文件添加库链接
target_link_libraries( lib_undistort
	${OpenCV_LIBS}
	)

# 用指定的源文件为工程添加可执行文件，名字为undistort_image
add_executable( ${PROJECT_NAME} ${PROJECT_SOURCE_DIR}/testBed/main.cpp )

# 为库或可执行文件添加库链接
target_link_libraries( ${PROJECT_NAME}
	${OpenCV_LIBS}
	lib_undistort 
	)

首先第一部分，cmake版本、工程名、编译方式、CXX_FLAG
第二部分，查找第三方库、设置包含路径、设置bin或lib文件输出路径
第三部分，生成库、为库链接、生成可执行文件、为可执行文件链接