【CMake入门】第二节——CMake常用指令介绍

系列文章：
【CMake入门】第一节——CMake的安装与简单样例

CMake常用指令介绍

cmake_minimum_required

• 指定要求最小的cmake版本，如果版本小于该要求，程序终止

project(test)

• 设置当前项目名称为test

CMAKE_BUILD_TYPE

• 用于设置CMake构建时的类型：
  • Debug：调试模式，输出调试信息，不做优化
  • Release：发布模式，没有调试信息，全优化
  • RelWithDebInfo：类似Release，但包括调试信息
  • MinSizeRel：一种特殊的Release模式，会特别优化库的大小

CMAKE_CXX_FLAGS

• 编译CXX的设置标志，比如 -std=c++11, -Wall, -O3（优化，使用向量化、CPU流水线，cache等提高代码速度）
• 编译过程中输出警告（warnings）：set(CMAKE_CXX_FLAGS “-Wall”)，但是这样设置会覆盖掉先前的所有标记
• 追加，不会丢失之前的定义：set(CMAKE_CXX_FLAGS “${CMAKE_CXX_FLAGS} -Wall”)

include_directories

• 指定头文件的搜索路径，编译器查找对应头文件

举例：文件main.cpp中使用到路径/usr/local/include/opencv/cv.h中这个文件

CMakeLists.txt:

include_directories(/usr/local/include)

main.cpp：

#include "opencv/cv.h"

set(value_name value)

• 用变量代替值
• set(SRC_LST main.cpp other.cpp) 表示定义SRC_LST代替后面的两个cpp文件

add_executable(hello main.cpp)

• 用指定的源文件为工程添加可执行文件
• 工程会用main.cpp生成一个文件名为hello的可执行文件

add_library(libname STATIC/SHARED sources)

• 将指定的源文件生成链接库文件。STATIC为静态链接库，SHARED为共享链接库

target_link_libraries(target library1 library2 …)

• 为库或二进制可执行文件添加库连接，要用在add_executable之后

target_link_libraries(myProject libhello.a)

add_dependencies(target_name depend)

• 为上层target添加一来，一般不用
• 若只有一个targets有依赖关系，一般选择使用target_link_libraries
• 如果两个targets有依赖关系，并且依赖库也是通过编译源码产生的。这时候用该指令可以在编译上层target时，自动检查下层依赖库是否已经生成

add_subdirectory(source_dir)

• 向当前工程添加存放源文件的子目录，目录可以是绝对路径或相对路径

aux_source_directory(dir varname)

• 在目录下查找所有源文件

message(mode “message text”)

• 打印输入信息，mode包括FATAL_ERROR、WARNING、STATUS、DEBUG等
• message(STATUS “Set debug mode”)

一些预定义好的指令

• PROJECT_NAME：项目名称，与project(xxx)一致
• PROJECT_SOURCE_DIR：即内含project()指令的CMakeLists所在的文件夹
• EXECUTABLE_OUTPUT_PATH：可执行文件输出路径
• LIBRARY_OUTPUT_PATH：库文件输出路径
• CMAKE_BINARY_DIR：默认是build文件夹所在的绝对路径
• CMAKE_SOURCE_DIR：源文件所在绝对路径

find_package(package version EXACT/QUIET/REQUIRED)

• 示例：find_package(OpenCV 3.4 REQUIRED)

• version：指定查找库的版本号

• EXACT：要求该版本号必须精确匹配

• QUIET：禁掉没有找到时的警告消息

• REQUIRED：包如果没有找到的话，CMake的过程会终止，并输出警告信息

• 搜索有两种模式：

  • 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找到一个库的时候，以下变量会自动初始化：

  • < NAME >_FOUND：显示是否找到库的标记
  • < NAME >_INCLUDE_DIRS或< NAME >_INCLUDES：头文件路径
  • < NAME >_LIBRARIES或< NAME >_LIBRARIES或< NAME >_LIBS：库文件

If，elseif，endif

• 判断语句，使用与C语言一直

list

• 列表操作：读、搜索、修改、排序
• 追加例子：LIST(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake_modules)
  

foreach

• 循环指令
• 格式如下：

foreach(< loop_var > < items >)
endforeach()

指令查询

官网指令查询入口