CMakeFile学习笔记之常用CMake命令

2023-05-16

写在前面

本文主要是记录自己学习使用过程中遇到的CMake 指令，在此做一个总结，大部分内容来自与其他博主的总结博客，已在文中标明，如有侵权，请联系删除。

一、add_library 命令

参考链接:
[1] cmake学习笔记之add_library、target_link_libraries和link_directories https://blog.csdn.net/bigdog_1027/article/details/79113342

二、file命令

file(GLOB variable [RELATIVE path] [globbingexpressions]...)

GLOB 会产生一个由所有匹配globbing表达式的文件组成的列表，并将其保存到变量中。Globbing 表达式与正则表达式类似，但更简单。如果指定了RELATIVE 标记，返回的结果将是与指定的路径相对的路径构成的列表。 (通常不推荐使用GLOB命令来从源码树中收集源文件列表。原因是：如果CMakeLists.txt文件没有改变，即便在该源码树中添加或删除文件，产生的构建系统也不会知道何时该要求CMake重新产生构建文件。globbing 表达式包括：

   *.cxx     - match all files with extension cxx
   *.vt?      - match all files with extension vta,...,vtz
   f[3-5].txt - match files f3.txt,f4.txt, f5.txt

参考链接：
[1] CMakeFile命令之file https://blog.csdn.net/fuyajun01/article/details/8880121

三、include 命令

include(CMakeDependentOption) cmake内置，包含cmake_dependent_option方法。include(CheckCXXCompilerFlag) cmake内置，包含CHECK_CXX_COMPILER_FLAG用于检查C++标准支持情况。

参考链接：
[1] CMake 常用命令 https://zhuanlan.zhihu.com/p/258118287

四、Cmake命令之add_subdirectory介绍

命令格式

add_subdirectory (source_dir [binary_dir] [EXCLUDE_FROM_ALL]) #添加一个子目录并构建该子目录。

命令解析

source_dir
必选参数。该参数指定一个子目录，子目录下应该包含CMakeLists.txt文件和代码文件。子目录可以是相对路径也可以是绝对路径，如果是相对路径，则是相对当前目录的一个相对路径。
binary_dir
可选参数。该参数指定一个目录，用于存放输出文件。可以是相对路径也可以是绝对路径，如果是相对路径，则是相对当前输出目录的一个相对路径。如果该参数没有指定，则默认的输出目录使用source_dir。
EXCLUDE_FROM_ALL
可选参数。当指定了该参数，则子目录下的目标不会被父目录下的目标文件包含进去，父目录的CMakeLists.txt不会构建子目录的目标文件，必须在子目录下显式去构建。例外情况：当父目录的目标依赖于子目录的目标，则子目录的目标仍然会被构建出来以满足依赖关系（例如使用了target_link_libraries）。

参考链接：
[1] Cmake命令之add_subdirectory介绍 https://www.jianshu.com/p/07acea4e86a3

五、cmake命令之install介绍

INSTALL指令

安装的需要有两种，一种是从代码编译后直接make install安装，一种是打包时的指定目录安装。
这里需要引入一个新的cmake 指令 INSTALL和一个非常有用的变量CMAKE_INSTALL_PREFIX。
CMAKE_INSTALL_PREFIX变量类似于configure脚本的 –prefix，常见的使用方法看
起来是这个样子：
cmake -DCMAKE_INSTALL_PREFIX=/usr .

INSTALL指令用于定义安装规则，安装的内容可以包括目标二进制、动态库、静态库以及
文件、目录、脚本等。

INSTALL指令包含了各种安装类型，我们需要一个个分开解释

目标文件的安装：

INSTALL(TARGETS targets...
        [[ARCHIVE|LIBRARY|RUNTIME]
                   [DESTINATION <dir>]
                   [PERMISSIONS permissions...]
                   [CONFIGURATIONS
        [Debug|Release|...]]
                   [COMPONENT <component>]
                   [OPTIONAL]
                ] [...])

参数中的TARGETS后面跟的就是我们通过ADD_EXECUTABLE或者ADD_LIBRARY定义的
目标文件，可能是可执行二进制、动态库、静态库。

目标类型也就相对应的有三种，ARCHIVE特指静态库，LIBRARY特指动态库，RUNTIME
特指可执行目标二进制。

DESTINATION定义了安装的路径，如果路径以/开头，那么指的是绝对路径，这时候
CMAKE_INSTALL_PREFIX其实就无效了。如果你希望使用CMAKE_INSTALL_PREFIX来
定义安装路径，就要写成相对路径，即不要以/开头，那么安装后的路径就是
${CMAKE_INSTALL_PREFIX}/<DESTINATION定义的路径>

举个简单的例子：

INSTALL(TARGETS myrun mylib mystaticlib
       RUNTIME DESTINATION bin
       LIBRARY DESTINATION lib
       ARCHIVE DESTINATION libstatic
)

上面的例子会将：
可执行二进制myrun安装到 ${CMAKE_INSTALL_PREFIX}/bin目录
动态库libmylib安装到 ${CMAKE_INSTALL_PREFIX}/lib目录
静态库libmystaticlib安装到 ${CMAKE_INSTALL_PREFIX}/libstatic目录
特别注意的是你不需要关心TARGETS具体生成的路径，只需要写上TARGETS名称就可以了。

普通文件的安装

INSTALL(FILES files... DESTINATION <dir>
         [PERMISSIONS permissions...]
         [CONFIGURATIONS [Debug|Release|...]]
         [COMPONENT <component>]
         [RENAME <name>] [OPTIONAL])
可用于安装一般文件，并可以指定访问权限，文件名是此指令所在路径下的相对路径。
如果默认不定义权限PERMISSIONS，安装后的权限为,OWNER_WRITE,OWNER_READ,
GROUP_READ,和WORLD_READ，即644权限。

非目标文件的可执行程序安装(比如脚本之类)

INSTALL(PROGRAMS files... DESTINATION <dir>
     [PERMISSIONS permissions...]
     [CONFIGURATIONS [Debug|Release|...]]
     [COMPONENT <component>]
     [RENAME <name>] [OPTIONAL])

跟上面的FILES指令使用方法一样，唯一的不同是安装后权限为:
OWNER_EXECUTE, GROUP_EXECUTE, 和WORLD_EXECUTE，即755权限

INSTALL(DIRECTORY dirs... DESTINATION <dir>
     [FILE_PERMISSIONS permissions...]
     [DIRECTORY_PERMISSIONS permissions...]
     [USE_SOURCE_PERMISSIONS]
     [CONFIGURATIONS [Debug|Release|...]]
     [COMPONENT <component>]
     [[PATTERN <pattern> | REGEX <regex>]
      [EXCLUDE] [PERMISSIONS permissions...]] [...])

这里主要介绍其中的DIRECTORY、PATTERN以及PERMISSIONS参数。
DIRECTORY后面连接的是所在Source目录的相对路径，但务必注意：
abc和abc/有很大的区别。
abc意味着abc这个目录会安装在目标路径下；
abc/意味着abc这个目录的内容会被安装在目标路径下；
如果目录名不以/结尾，那么这个目录将被安装为目标路径下的abc，如果目录名以/结尾，
代表将这个目录中的内容安装到目标路径，但不包括这个目录本身。
PATTERN用于使用正则表达式进行过滤，
PERMISSIONS用于指定PATTERN过滤后的文件权限。

我们来看一个例子:

INSTALL(DIRECTORY icons scripts/ DESTINATION share/myproj
        PATTERN "CVS" EXCLUDE
        PATTERN "scripts/*"
        PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ
        GROUP_EXECUTE GROUP_READ)

这条指令的执行结果是：
将icons目录安装到 /share/myproj，将scripts/中的内容安装到
/share/myproj
不包含目录名为CVS的目录，对于scripts/*文件指定权限为 OWNER_EXECUTE
OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ.

安装时cmake脚本的执行

INSTALL([[SCRIPT <file>] [CODE <code>]] [...])
SCRIPT参数用于在安装时调用cmake脚本文件（也就是<abc>.cmake文件）
CODE参数用于执行CMAKE指令，必须以双引号括起来。比如：
INSTALL(CODE "MESSAGE(\"Sample install message.\")")

转载链接：
[1] CMake总结 - 4 INSTALL https://blog.csdn.net/yangfeng2014/article/details/50638601

六、add_definitions()

将 -D 定义标志添加到源文件的编译中。

add_definitions(-DFOO -DBAR ...)

为当前目录及以下目录中的源文件添加定义到编译器命令行。此命令可用于添加任何标志，但它旨在添加预处理器定义。以 -D 或/D开头的看起来像预处理器定义的标志会自动添加到COMPILE_DEFINITIONS 当前目录的目录中。具有非平凡值的定义可能会留在标志集中，而不是出于向后兼容性的原因进行转换。

简单来说就是：
之前在程序中需要使用宏定义 #define DEBUG 来实现，那么现在也可以在 CMakeLists.txt 中 add_definitions(-DDEBUG) 实现同样的功能。
在对应的程序源码中，可以这样进行使用：

#ifdef DEBUG
...
#endif

参考链接：
[1] 官方解释： https://cmake.org/cmake/help/v3.0/command/add_definitions.html#command:add_definitions
[2] 古路. CMakeLists中的add_definitions()函数 [EB/OL]. https://blog.csdn.net/fb_941219/article/details/107376017, 2020-07-16/2022-08-07.

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)