cmake笔记

最新推荐文章于 2024-03-26 07:26:06 发布
最新推荐文章于 2024-03-26 07:26:06 发布
阅读量756 收藏 1
点赞数
分类专栏： C++ 文章标签： cmake c++ linux 跨平台编译
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yucicheung/article/details/81125117
版权

主要内容

  • cmake简介;
  • 简单语法;
  • 几个项目示例。
    本文主要参考cmake practice,项目代码在我的仓库(因为原书内容有点过时，所以代码做出了修正)，笔记中加入了自己的理解。
    另，原书未更新完，所以这里只有前六章内容，但是日常也够用了。

简单的HelloWorld(文件夹t1)

cmake以指定目录下的CMakeLists.txt为根据生成相应的中间文件(包括CMakeCache.txt,cmake_install.cmake,Makefile,CMakeFiles文件夹)，之后运行make（或者运行make VERBOSE=1观察make命令构建的详细过程）。

基本语法规则

CMakeLists.txt必须在工程的每个目录下都存在一份，其最基本语法规则为：

  • 变量用${}方式取值，但在IF控制语句中直接使用变量名;
  • 指令(参数1 参数2)，参数用空格或分号分开;
  • 指令大小写无关，但是变量名大小写相关，但推荐全部使用大写指令;
  • 运行make clean即可对构建结果进行清理(二进制可执行文件);make distclean在cmake中不可用(因为中间文件不可追踪，于是干脆禁用命令)。

注意：
1. 工程名和生成的可执行文件名之间没有关系(因为一个项目中可以生成多个可执行文件)。
2. 推荐外部构建(out-of-source build)而不推荐内部构建(in-source-build)，这样在需要重新构建时将整个构建文件夹删除即可。(最主要删除CMakeCache.txt)

更像工程的HelloWorld(文件夹t2)

一些注意：

  • 代码安装时用cmake -DCMAKE_INSTALL_PREFIX=/tmp/t2/usr ..选项;默认的CMAKE_INSTALL_PREFIX=/usr/local
  • 在INSTALL后，注意文件的权限会发生变更。

默认以后采用外部构建方式。要使项目更像工程：
1. 添加一个子目录src存放工程源代码;
- 主目录下CMakeLists.txt填写ADD_SUBDIRECTORY(src bin);
- 子目录下用ADD_EXECUTABLE();
2. 添加一个子目录doc存放工程文档;
3. 工程目录下添加文本文件COPYRIGHT,README;
4. 工程目录添加一个runhello.sh脚本用于调用hello二进制文件;
5. 安装这些文件：将hello二进制文件与runhello.sh安装至/usr/bin，将doc目录内容及COPYRIGHT/README安装到/usr/share/doc/cmake/t2。
- 方式1:make install;方式2:打包时指定目录安装。
- 对于cmake,需要使用指令INSTALL和一个很有用的变量CMAKE_INSTALL_PREFIX，下面具体说明

cmake install

cmake需要使用指令INSTALL和一个很有用的变量CMAKE_INSTALL_PREFIX：
1. INSTALL指令用于定义安装规则，安装内容可以包括目标二进制、动态库、静态库以及文件、目录、脚本等，具体安装指令在下面介绍;
2. CMAKE_INSTALL_PREFIX的使用格式一般是cmake -DCMAKE_INSTALL_PREFIX=/usr .

INSTALL命令

INSTALL命令(不管是make install或者install命令)，都是负责copy files and set attributes。

1.目标文件(动态静态库及可执行文件)的安装

INSTALL(TARGET targets...           #TARGETS后面跟ADD_EXECUTABLE/ADD_LIBRARY定义的目标文件，可能是可执行二进制、动态库、静态库，targets可以有多个
        [[ARCHIVE|LIBRARY|RUNTIME]  # 对应目标类型为ARCHIVE静态库、LIBRARY动态库、RUNTIME可执行目标二进制
        [DESTINATION <dir>]         # 如果路径以/开头，那么就是绝对路径，此时CMAKE_INSTALL_PREFIX无效;相对路径不要以/开头，则${CMAKE_INSTALL_PREFIX}/<DESTINATION>为安装后的路径
        [PERMISSIONS perssions...]
        [CONFIGURATIONS [Debug|Release|...]]
        [COMPONENT <component>] [OPTIONAL]]
        [...]
)

举个例子

INSTALL (TARGETS myrun  mylib mystaticlib
        RUNTIME DESTINATION bin         # 将二进制myrun安装到${CMAKE_INSTALL_PREFIX}/bin目录
        LIBRARY DESTINATION lib         # 动态库libmylib安装到${CMAKE_INSTALL_PREFIX}/lib目录
        ARCHIVE DESTINATION libstatic   # 静态库libmystaticlib安装到${CMAKE_INSTALL_PREFIX}/libstatic目录
    )

上述例子中，不需要写出库文件生成的全称(lib-)，而只要写出库文件的名字即可。

2.普通文件的安装

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

其中，文件名(FILES)是此指令所在路径下的相对路径，默认PERMISSIONS为644权限，cmake中描述为OWNER_WRITE,OWNER_READ,GROUP_READ,WORLD_READ。

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

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

跟上述FILES指令使用方法一致，唯一不同的是安装后的权限为：OWNER_EXECUTE,GROUP_EXECUTE,WORLD_EXECUTE,即755权限。

4.目录的安装

INSTALL(DIRECTORY dirs... DESTINATION <dir>
    [FILE_PERMISSIONS permissions...]       # permissions总是需要一连串指令指明
    [DIRECTORY_PERMISSIONS permissions...]
    [USE_SOURCE_PERMISSIONS]
    [CONFIGUTATIONS [Debug|Release|...]]
    [COMPONENT <component>]
    [[PATTERN <pattern> | REGREX <regex>]
    [EXECLUDE] [PERMISSIONS permissions...]] [...])

其中

  • DIRECTORY:后面接所在Source目录的相对路径，但注意：abc表示将整个目录拷贝，abc/表示将目录下的所有文件拷贝过去;
  • PATTERN:用于正则表达式过滤;
  • PERMISSIONS：用于指定对前面的正则表达式过滤出来的文件的权限。

举个例子：

INSTALL(DIRECTORY icons scripts/ DESTINATION share/myproj
        PATTERN "CVS" EXECLUDE
        PATTERN "scripts/*" PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ
        # 可以看到每次出现一个关键词，将其后面的内容存储为其中内容，直到碰到下一个关键词
)

上述执行结果会是：icons目录安装到/share/myproj，将scripts/文件夹中所有内容安装到/share/myproj;对含有”CVS”的目录不包含，对符合srcipts/*模式的文件。
如果要换个地方存放目标二进制，可以通过SET命令重新定义EXECUTABLE_OUTPUT_PATH/LIBRARY_OUTPUT_PATH变量来指定最终的目标二进制的位置(指最终生成的二进制可执行文件或最终共享库，不包含编译生成的中间文件。记住:在哪里ADD_EXECUTABLE()/ADD_LIBRARY()，就在哪里加入上述修改目标文件夹的定义。

静态库与动态库构建(t3文件夹)

任务

  1. 建立一个静态库和动态库，提供HelloFunc函数供其他程序编程使用，HelloFunc向终端输出Hello World字符串。
  2. 安装头文件及共享库。

相关指令

  • ADD_LIBRARY添加构建动态静态库
ADD_LIBRARY(libname [SHARED|STATIC|MODULE] [EXCLUDE_FROM_ALL] source1 source2 ... sourceN)

其中，

  • libname不需要写全libhello.so，只需要写hello就可以，cmake会自动生成libhello.X;
  • 库的三种类型
    • SHARED动态库(.so后缀)
    • STATIC静态库(.a后缀)
    • MODULE在使用dyld的系统有效，如果不支持dyld，则被当作SHARED对待

  • EXCLUDE_FROM_ALL表示该库不会被默认构建，除非有其他组建依赖或者手工构建
    问题：要构建的TARGET(可执行二进制文件/动态静态链接库等)是不能重名的，但是输出库的名字可以被修改,以使输出的动态静态库可以同名。

  • SET_TARGET_PROPERTIES设置输出的名称，对于动态库还可以用来指定动态库版本和API版本

SET_TARGET_PROPERTIES(target1 target2 ...
        PROPERTIES prop1 value1
        prop2 value2...)

在/t3/build中进行cmake，就可以同时输出libhello.so和libhello.a两个库。
举几个例子

SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")#以下命令用来表示不清除文件中的同名目标,但在3.5.1中已经可以生成同名的目标文件而不会被清除
SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUPUT 1)

问题：动态库一般是包含一个版本号的，如果我们想生成以下链接，我们应该怎么实现呢?

libhello.so.1.2
libhello.so->libhello.so.1
libhell.so.1->libhello.so.1.2
  • 采用以下指令添加动态库版本:
SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1) #SOVERSION表示API版本，VERSION表示动态库版本

最终我们需要将动态库和头文件案安装到系统目录，才能被人开发使用，按照如下命令将hello共享库安装到/lib目录，将hello.h安装到/include/hello目录下。为下一节准备，将文件安装在/usr/lib和/usr/include/hello下。

使用外部共享库和头文件(t4目录)

按照构建可执行二进制文件的方式构建文件夹，此时#include<hello.h>需要用<>符号(因为已经在系统文件夹中,但是不在系统标准的头文件路径/usr/include中)，因此直接在cmake、make之后会出现错误,改用make VERBOSE=1来构建。
注意：其实只要写成#include<hello/hello.h>会在/usr/include下查找相应文件。

此时我们要引入头文件搜索所路径，用指令INCLUDE_DIRECTORIES或者是CMAKE_INCLUDE_PATH选项

  • INCLUDE_DIRECTORIES
    • 用于向工程添加多个特定的头文件搜索路径，多个路径之间用空格分割，如果路径中包含空格，可以用双括号括起来，默认的行为是追加到当前的头文件搜索路径后面;
    • 可以通过两种方式来进行控制搜索路径添加的方式:
      1. CMAKE_INCLUDE_DIRECTORIES_BEFORE,通过SET这个cmake变量为on，可以将添加的头文件搜索路径放在已有路径的前面;
      2. 通过AFTER或者BEFORE参数，也可以控制是追加或者是置前。
INCLUDE_DIRECTORIES([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)

问题：上述步骤完成后，会出现一个新的错误undefined reference to 'HelloFunc'，因为还没有link到共享库libhello上（gcc -lhello）。

  • TARGET_LINK_LIBRARIES用于为target(库/可执行二进制文件)添加需要链接的共享库。
TARGET_LINK_LIBRARIES(target library1
                    <debug | optimized> library2
                    ...)

其中library可以写成hello(会优先链接到动态库.so)或者库全称libhello.so/libhello.a。
以下还有另外一个命令：

  • LINK_DIRECTORIES添加非标准的共享库搜索路径。
    • 如在工程内部同时存在共享库和可执行二进制，在编译时就需要指定一下这些共享库的路径。
LINK_DIRECTORIES(directory1 directory2 ...)
  • 特殊的环境变量CMAKE_INCLUDE_PATH和CMAKE_LIBRARY_PATH
    • 两个环境变量可以设置到.bashrc中并且export生效，或者在CMakeLists.txt中用SET设置相应变量值;
    • CMAKE_INCLUDE_PATH配合FIND_PATH(用来在指定路径中搜索文件名)使用;
    • 当头文件没有存在常规路径/usr/include,usr/local/include中时，可以通过这些变量弥补。
    • CMAKE_LIBRARY_PATH配合FIND_LIBRARY(在指定路径中搜索库名)使用。
      则更自动化的INCLUDE_DIRECTORIES()如下：
SET(CMAKE_INCLUDE_PATH /usr/include/hello)
FIND_PATH(myHeader hello.h)
IF(myHeader)
INCLUDE_DIRECTORIES(${myHeader})
ENDIF(myHeader)

模块的使用和自定义模块

对于系统与定义的Find.cmake模块，使用方法如下：
每一个模块都会定义以下几个变量(系统预定义)：

  • _FOUND:判断模块是否找到
  • _INCLUDE_DIR or _INCLUDES：存储include路径，当FOUND为真，INCLUDE_DIRECTORIES();
  • _LIBRARY or _LIBRARIES：存储library路径,当FOUND为真时，TARGET_LINK_LIBRARIES()。

以下看一个复杂的例子，用_FOUND控制工程特性：

SET(mySources viewer.c)
SET(optionalSources)
SET(optionalLibs)


FIND_PACKAGE(JPEG)# 当输入选项-DENABLE_JPEG_SUPPORT以下代码生效
IF(JPEG_FOUND)
    SET(optionalSources ${optionalSources} jpegview.c)
    INCLUDE_DIRECTORIES(${JPEG_INCLUDE_DIR})
    SET(optionalLibs ${optionalLibs} ${JPEG_LIBRARIES})
    ADD_DEFINITIONS(-DENABLE_JPEG_SUPPORT)
ENDIF(JPEG_FOUND)


FIND_PACKGAE(PNG)# 当输入选项-DENABLE_PNG_SUPPORT以下代码生效
IF(PNG_FOUND)
    SET(optionalSources ${optionalSources} pngview.c)
    INCLUDE_DIRECTORIES(${PNG_INCLUDE_DIR})
    SET(optionalLibs ${optionalLibs} ${PNG_LIBRATIES})
    ADD_DEFINITIONS(-DENABLE_PNG_SUPPORT)
ENDIF(PNG_FOUND)

ADD_EXECUTABLE(viewer ${mySources} ${optionalSources})
TARGET_LINK_LIBRARIES(viewer ${optionalLibs})

编写自己的FindHello模块(t6目录)

在CMakeLists.txt中调用的是.cmake模块中的变量，而cmake模块中的变量可以系统定义，也可以用户自己定义。

  • FIND_PACKAGE(<name> [major.minor] [QUIET] [NO_MODULE] [REQUIRED|COMPONENTS] [components...]])
    • 如果指定QUIET参数，就对应编写的FindHELLO.cmake中的HELLO_FIND_QUIETLY;
    • 指定REQUIRED参数，则找不到该链接库时不能编译，对应FindHELLO.cmake中的HELLO_FIND_REQUIRED变量。

基本指令汇总

项目中用到的指令如下：

  • PROJECT(projectname [CXX] [C] [JAVA])
    • 语言列表可以忽略，默认支持所有语言;
    • 两个隐式的cmake变量，<projectname>_BINARY_DIR、<projectname>_SOURCE_DIR,或者就直接用PROJECT_BINARY_dir、PROJECT_SOURCE_DIR;
  • SET(VAR [VALUE] [CACHE TYPE DOCSTRING [FORCE]])
    • 如给SRC_LIST设置变量时main.cpp/"main.cpp"均可;
  • MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR] "message to display"...)
    • SEND_ERROR，产生错误，生成过程被跳过;
    • STATUS，输出前缀为--的信息;
    • FATAL_ERROR，立即终止所有cmake过程。
  • ADD_EXECUTABLE(hello ${SRC_LIST})
yucicheung
关注
专栏目录
make 学习笔记
码基的博客
11-26 687
Learn Makefiles Makefiles笔记 整理自己学习的一些知识点 并且加入自己的理解 Getting Started Makefiles的作用 make是以中项目构建工具，Makefile是其输入。make按照Makefile里的步骤一次构建项目。 在软件开发项目中，Makefile用来决定哪些文件需要编译，文件之间的依赖关系，所要执行的命令以及并按照依赖关系依次执行。Makefile在管理依赖关系时，是以文件为单位。make命令可以解析Makefile并按照定义的依赖关系依次执行相应的sh
make学习笔记
ithink16的博客
05-18 240
编写Makefile makefile文件命令开始不是空格，是tab键 make命令会自动查找当前目录下名为的Makefile的文件，找到之后会解析Makefile文件，并执行文件的内容。 Makefile文件中的内容： 执行make命令： Makefile默认只执行第一个标号，其他标号不执行，若要执行其他标号：make 标号名 make -f指定文件 make -f aa （不用make...
Linux 下 make 命令 及 make 笔记
weixin_30484247的博客
03-26 332
Linux 下make命令是系统管理员和程序员用的最频繁的命令之一。管理员用它通过命令行来编译和安装很多开源的工具，程序员用它来管理他们大型复杂的项目编译问题。本文我们将用一些实例来讨论 make 命令背后的工作机制。 Make 如何工作的 对于不知道背后机理的人来说，make 命令像命令行参数一样接收目标。这些目标通常存放在以 “Makefile” 来...
make的学习笔记
小石头会长成大石头么？
05-16 166
这个笔记是在终端中的man make的笔记 语法: make [option]... [target] 描述: make是用来自动地决定大规模程序中的哪个小部分程序被重新编译的工具.它常常用于C语言的编译,但是也可以用于其它语言,只要这个语言的编译器可以从shell中调用.实际上,make不只是适用于程序,当一些文件发生了改变,另外一些依赖于这些文件的文件就需要被更新的任务都可以使用make. 在使用make前,你需要写一个Makefile文件,这个文件用来描述你的程序中的文件的关系和更新每个文件的命令的状
cmake笔记 cmake 笔记 cmake笔记 cmake
02-01
笔记cmake笔记 cmake 笔记cmake笔记 cmake 笔记笔记cmake笔记 cmake 笔记cmake笔记 cmake 笔记笔记cmake笔记 cmake 笔记cmake笔记 cmake 笔记
CMake笔记之将任意官方库作为third_party完整地包含在工程项目中使用的通用模板
小勇博客
03-20 923
— 杭州 2024-03-20 凌晨1:06。
CMake笔记：add_custom_command不执行
SunnyZhou-1024的博客
01-22 3705
0x00. 前言 在网上看别人做一些手工教程视频，经常能看到这样的评论： 脑子：我感觉我会了。 手：你行你来。 之前一直通过编译脚本去寻找代码入口，感觉我已经懂得CMake的语法了，直到今天寄己要写一个脚本去编译一个工程才发现，事情并不简单：脚本并没有按照我期望的去执行。 此工程需要用到Protocol Buffer，因此当代码构建的时候需要使用使用Protocol Buffer编译器去编译.proto文件获得对应的生成文件。理论上，想要达到这个目的，我们只需要在CMakeLists.txt中使用add
cmake自定义模块使用示例
11-08
cmake中经常使用find_package寻找模块，使用起来非常方便．find_package的原理是什么呢？如何自己写个模块提供给别人使用?如果别人希望用find_package的形式使用你的模块中的库，我该如何用cmake写这个库呢？ 这个例子能够弄清楚以上的问题. 示例中的myapp程序通过find_package调用mylib中的库
make学习笔记（一）
xinianbuxiu的博客
07-09 646
1、   由于实际开发中，一个程序往往是由多个源文件组成的，所以单用gcc调试往往是很麻烦的，加上若在调试过程中只修改了部分源文件，用gcc命令编译的话会将连同没被修改的源文件一起编译，这大大地降低了编译效率，由此引入了make工程管理器。 2、   make是一个半自动化的工程管理器，它需要依赖Makefile对程序进行编译。他有以下两方面的优越性; (1)   使用方便；通过命令make就
1.make学习笔记
107
06-12 9696
makefile入门1.学习makefile2.通配符3.伪目标4.多目标5.makefile特征：6.变量7.makefile常用的字符串函数调用7:文件名操作函数8.隐式规则9:模式规则 1.学习makefile make---->自动确定工程的那部分源程序文件需要重新编译，编译多个源文件; 用法：make [options] [target] ... -f filename -C -e -k -s -S makefile----自动化编译 实例1： all:main.c foo.
make的简单应用笔记
大西瓜Blog
05-12 399
make clean与make distclean的区别 make clean ： 清除之前编译的可执行文件及配置文件。 make distclean： 要清除所有生成的文件。 Makefie 在符合GNU Makefiel惯例的Makefile中，包含了一些基本的预先定义的操作： make根据Makefile编译源代码，连接，生成目标文件，可执行文件。 make clean清除上次的make命令
CMake使用关键点
zhang_shuaifeng的博客
02-23 440
CMake常用指令、常用变量、环境变量、 Find.cmake
CMake | 安装项目用到的那些命令与函数
该用户还没想到好的昵称的博客
03-16 4020
一、输出目录 二、GNUInstallDirs.cmake模块 三、file(TO_NATIVE_PATH "" ) 四、file(RELATIVE_PATH ) 五、set_target_properties 五、RPATH 1.CMAKE_INSTALL_RPATH 2.INSTALL_RPATH 六、install命令
CMakeFile命令之file
热门推荐
山庄来客的专栏
05-03 2万+
file:文件操作命令. file(WRITE filename "message towrite"... ) WRITE 将一则信息写入文件’filename’中，如果该文件存在，它会覆盖它，如果不存在，它会创建该文件。 file(APPEND filename "message to write"... ) APPEND 如同WRITE，区别在于它将信息内容追加到文件末尾。
[cmake]cmake命令之install
最新发布
FL1768317420的博客
03-26 2553
intall()命令为工程生成安装规则，同一个源文件目录下的安装规则按照intall()命令的调用顺序在安装时(也就是使用时)执行。intall()命令有多个形式，其中有一些是针对文件和目标对象定义安装选项。指定文件将要安装的目录，可以是相对路径也可以是绝对路径。如果是相对路径，会以变量（Unix/Linux下默认值是/usr/localWindows下的默认值是）内容为前缀。类Unix系统下可以在安装时通过DESTDIR环境变量（参考DESTDIRDESTDIR是的缩写）重定位整个安装路径。
CMake知识：生成install工程
gongdiwudu的专栏
04-14 8124
一、函数介绍 install用于指定在安装时运行的规则。它可以用来安装很多内容，可以包括目标二进制、动态库、静态库以及文件、目录、脚本等。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值