01-CMake常用指令

CMake

常用指令

cmake_minimum_required

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

project(test)

• 设置当前项目名称为test

CMAKE_BUILD_TYPE

1. Debug：调试模式，输出调试信息，不做优化
2. release：发布模式，没有调试信息，全优化
3. RelwithDebInfo：类似于Release，但包括调试模式
4. MinSizeRel：一种特殊的Release模式，会特别优化库的大小

CMAKE_CXX_FLAGS

1. 编译CXX的设置标志，比如 -std=c++11， -Wall， -O3（优化，使用向量化、CPU流水线、cache等提高代码速度）
2. 编译过程中输出警告（warnings）：set(CMAKE_CXX_FLAGS “-Wall”)
3. 追加，不会丢失之前的定义：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(variable 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
• 如果两个有target有依赖关系，并且依赖库也是通过编译源码产生的。这时候用该指令可以在编译上层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”)

一些预定义好的指令：
PEOJECT_NAME:项目名称，与peoject(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)

• 功能：采用两种模式（FindXXX.cmake和XXXConfig.cmake）搜索外部库
• 示例：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_CINLUDE_DIRS和XXX_LIBRARIES两个变量赋值的操作由XXXConfig.cmake模块完成。
• 两种模式看起来似乎差不多，不过cmake默认采取Module模式，如果Module模式未找到库，才会采用Config模式。
• 如果XXX_DIR路径下找不到XXXConfig.cmake文件，则会找/usr/local/lib/cmake/XXX/中的XXXConfig.cmake文件。总之，Config模式是一个备选策略。通常，库安装时会拷贝一份XXXConfig.cmake到系统目录，因此在没有显式指定搜索路径时也可以顺利找到。
• 若XXX安装时没有安装到系统目录，则无法自动找到XXXConfig.cmake，需要在CMakeLists.txt最前面添加XXX的搜索路径。
• set(XXX_DIR /home/zzx/3rdParty/OpenCV 3.1/build) #添加OpenCV的搜索路径
• 当find_package找到一个库的时候，以下变量会自动初始化：
• NAME_FOUND:显示是否找到库的标记
• NAME_INCLUDE_DIRS或NAME_INCLUDES:头文件路径
• NAME_LIBRARIES或NAME_LIBRARIES或NAME_LIBS:库文件

list

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

if,elesif,endif

• 判断语句，使用和C语言一致

foreach

• 循环

CMake指令查询

https://cmake.org/cmake/help/latest/genindex.html#

静态库和共享库

静态库

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

共享库

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

最后

研究SLAM的朋友欢迎一起讨论学习~