CMake

CMake是什么

是一个高级编译配置工具，当一个项目工程过大时，使用传统的配置手段很难组织起生成最终的可执行程序，CMake可以帮助解决大型工程中编译前的配置，并自动生成makefile文件。

使用环境

多个人用不同的语言或者编译器开发一个大项目，最重要输出一个可执行文件或共享库（dll，so等），如果使用gcc等会非常麻烦，所有操作均通过编译CMakeLists.txt来完成的。

安装

brew install cmake

cmake --version

开始

写一个helloworld程序--main.cpp

#include <iostream>
using namespace std;

int main(){
    cout << "hello world" << endl;
    return 0;
}

写一个CMakeLists.txt文件：

PROJECT (HELLO)
SET(SRC_LIST main.cpp)
MESSAGE(STATUS "This is BINARY dir" ${HELLO_BINARY_DIR})
MESSAGE(STATUS "This is SOURCE dir" ${HELLO_BINARY_DIR})
ADD_EXECUTABLE(hello ${SRC_LIST})

当前目录下使用如下命令生成makefile文件：

kongds@kongds ~/Desktop/cmake01$ cmake .                                                     
-- The C compiler identification is AppleClang 13.1.6.13160021
-- The CXX compiler identification is AppleClang 13.1.6.13160021
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working C compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/cc - skipped
-- Detecting C compile features
-- Detecting C compile features - done
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Check for working CXX compiler: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/c++ - skipped
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- This is BINARY dir/Users/kongds/Desktop/cmake01
-- This is SOURCE dir/Users/kongds/Desktop/cmake01
-- Configuring done
-- Generating done
-- Build files have been written to: /Users/kongds/Desktop/cmake01

kongds@kongds ~/Desktop/cmake01$ ll                                                          
total 72
-rw-r--r--   1 kongds  staff    14K  8 18 16:43 CMakeCache.txt
drwxr-xr-x@ 13 kongds  staff   416B  8 18 16:43 CMakeFiles
-rw-r--r--   1 kongds  staff   187B  8 18 16:39 CMakeLists.txt
-rw-r--r--   1 kongds  staff   5.1K  8 18 16:43 Makefile
-rw-r--r--   1 kongds  staff   1.5K  8 18 16:43 cmake_install.cmake
-rw-r--r--   1 kongds  staff    99B  8 18 16:35 main.cpp

使用make命令执行编译：

kongds@kongds ~/Desktop/cmake01$ make
[ 50%] Building CXX object CMakeFiles/hello.dir/main.cpp.o
[100%] Linking CXX executable hello
[100%] Built target hello

kongds@kongds ~/Desktop/cmake01$ ./hello                                                     
hello world

语法介绍

PROJECT关键字

可以用来指定工程的名字和支持的语言，默认支持所有语言

如：PROJECT(HELLO) 指定工程名，且支持所有语言

PROJECT(HELLO CXX) 指定工程名，且指定支持的语言为C++

PROJECT(HELLO C CXX) 指定工程名，且指定支持的语言为C和C++

这个关键字指定的语句隐式定义了两个CMAKE变量

_BINARY_DIR，本例中具体为HELLO_BINARY_DIR

_SOURCE_DIR，本例中具体为HELLO_SOURCE_DIR

SET关键字

用来显式指定源文件

SET(SRC_LIST main.

的意思就是SRC_LIST变量包含了main.cpp

如果包含多个源文件，则：

SET(SRC_LIST main.cpp t1.cpp t2.cpp)

MESSAGE关键字

向终端输出用户自定义的信息

主要包含以下三种信息：

SEND_ERROR，产生错误，生成过程被跳过
STATUS，输出前缀为一的信息
FATAL_ERROR，立即终止所有cmake过程

ADD_EXECUTABLE关键字

生成可执行文件

ADD_EXECUTABLE(hello ${SRC_LIST})

即生成的可执行文件名为hello，源文件从变量SRC_LIST中读取内容。

其实也可以直接这样：

ADD_EXECUTABLE(hello main.cpp)

注意，工程名的HELLO和生成的可执行文件名无任何关系

以上示例最简单的可以写成以下这样，其他不是必须的：

PROJECT (HELLO)
ADD_EXECUTABLE(hello ${SRC_LIST})

基本规则

读取变量使用${}方式，但是在IF控制语句中直接使用变量名
指令（参数1 参数2...）。
指令是大小写无关的，参数和变量是大小写相关的，但推荐使用大写指令。

注意事项

SET(SRC_LIST main.cpp)

可以写成

SET(SRC_LIST "main.cpp")

如果源文件名中含有空格，就必须要加双引号

ADD_EXECUTABLE(hello main)

后缀可以不写，cmake会自动寻找.c和.cpp，但最好不要这样写

内部构建和外部构建

以上实例就是内部构建，产生的临时文件多，不方便清理
外部构建：会把生成的额临时文件放在build目录下，不会对源文件有任何影响，强烈建议使用外部构建方式

让hello world看起来更像一个工程

创建src目录，放置工程源文件
创建子目录doc，放置工程文档如hello.txt
工程目录添加文本文件如COPYRIGHT，README
工程目录添加一个runhello.sh脚本，用来调用hello二进制文件
将构建后的目标文件放入构建目录的bin子目录
将doc目录的内容及COPYRIGHT/RRADME安装到/usr/share/doc/cmake/

将目标文件放入构建目录的bin子目录

每个目录下都要有一个CMakeLists.txt说明

kongds@kongds ~/Desktop/cmake01$ tree                                          
.
├── CMakeLists.txt
├── build
└── src
    ├── CMakeLists.txt
    └── main.cpp

2 directories, 3 files

外层工程目录下CMakeLists.txt

PROJECT(HELLO)
ADD_SUBDIRECTORY(src bin)

src下的CMakeLists.txt

ADD_EXECUTABLE(hello main.cpp)

ADD_SUBDIRECTORY指令

ADD_SUBDIRECTORY（[source_dir] [binary_dir] [EXCLUDE_FROM_ALL])

这个指令用于向当前工程添加存放源文件的子目录，冰可以指定中间二进制和目标二进制存放的位置
EXCLUDE_FROM_ALL函数是将写的目录从编译中删除，如程序中的example
ADD_SUBDIRECTORY(src bin)将src子目录加入工程并指定编译输出（包含编译中间结果）路径为bin目录；如果不进行bin目录的指定，那么编译结果（包括中间结果）都将存放在build/src目录

更改二进制的保存路径

SET指令重新定义EXECUTABLE_OUTPUT_PATH和LIBRARY_OUTPUT_PATH变量来指定最终的目标二进制的位置
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)
SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)

安装

一种是从代码编译后直接make install安装
另一种是打包的时候指定目录安装
- 简单指定目录：make install DESTDIR=/tmp/test
- 其他指定方式：./configure --prefix=/usr/local

如何安装hello world

使用cmake指令：INSTALL

INSTALL的安装可以包括：二进制、动态库、静态库及文件、目录、脚本等。

使用cmake一个新变量：CMAKE_INSTALL_PREFIX--用来指定安装路径

kongds@kongds ~/Desktop/cmake01$ tree                                          
.
├── CMakeLists.txt
├── COPYRIGHT
├── README
├── build
├── doc
│   └── hello.txt
├── runhello.sh
└── src
    ├── CMakeLists.txt
    └── main.cpp

3 directories, 7 files

安装文件`COPYRIGHT`和`README`

INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake/)

FILES：文件

DESTINATION：

写绝对路径
可以写相对路径，相对路径实际上是：${CMAKE_INSTALL_PREFIX}/<DESTINATION 定义的路径>

CMAKE_INSTALL_PREFIX 默认在/usr/local/

cmake -DCMAKE_INSTALL_PREFIX=/usr 在cmake的时候指定CMAKE_INSTALL_PREFIX变量的路径

安装脚本runhello.sh

PROGRAMS：非目标文件的可执行程序安装（比如脚本）

INSTALL(PROGRAMS runhello.sh DESTINATION bin)

说明：实际安装到的路径是/usr/bin

安装doc中的hello.txt

通过在doc目录建立CMakeLists.txt，通过install下的file
或直接在工程目录通过INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake)

DIRECTORY后面连接的是所在source目录的相对路径

注意：abc和abc/有很大区别

目录名不以/结尾：这个目录将被安装为目标路径下的abc

目录名以/结尾：将这个目录中的内容安装到目标路径

静态库和动态库的构建

任务：

建立一个静态库和动态库，提供HelloFunc函数供其他程序编程使用，HelloFunc向终端输出hello world字符串
安装头文件与共享库

静态库和动态库的区别

静态库扩展名一般为.a或.lib，动态库扩展名一般为.so或.dll
静态库在编译时会直接整合到目标程序中，编译成功的可执行文件可独立运行
动态库在编译时不会放到连接的目标程序中，即可执行文件无法单独运行，需要如-lssl -lcrypto

构建实例

root@kali:/usr/local/kong/cmake02# tree
.
├── build
├── CMakeLists.txt
└── lib
    ├── CMakeLists.txt
    ├── hello.cpp
    └── hello.h

2 directories, 4 file

hello.h

#ifdef HELLO_H
#define HELLO_H

void HelloFunc();

#endif

hello.cpp

#include <iostream>
#include "hello.h"

void HelloFunc(){
  std::cout << "Hello World" << std::endl;
}

项目中CMakeLists.txt内容

PROJECT(HELLO)
ADD_SUBDIRECTORY(lib bin)

lib中CMakeLists.txt内容

SET(LIBHELLO_SRC hello.cpp)
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

ADD_LIBRARY

ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

hello：正常的库名，生成的名字前会加上lib，最终产生的文件是libhello.so
SHARED 动态库
STATIC 静态库
${LIBHELLO_SRC}：源文件

同时构建静态和动态库

// 如果使用这种方式，只会构建一个动态库，不会构建出动态库，虽然静态库后缀是.a
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
ADD_LIBRARY(hello STATIC ${LIBHELLO_SRC})

// 修改静态库的名字，这样是可以的，但是我们往往希望静态库和动态库名称相同
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

SET_TARGET_PROPERTIES

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

同时构建静态库和动态库

SET(LIBHELLO_SRC hello.cpp)

ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

// 对hello_static重命名为hello
SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")
// cmake在构建一个新的target时，会尝试清理掉其他使用这个名字的库，因为在构建libhello.so时，就会清理掉libhello.a
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)

ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

SET_TARGET_PROPERTIES(hello PROPERTIES   OUTPUT_NAME "hello")
SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)

动态库版本号

一般动态库都有一个版本号的关联

libhello.so.1.2
libhello.so -> libhello.so.1
libhello.so.1 -> libhello.so.1.2

CMakeLists.txt插入如下

SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)

VERSION指定动态库版本，SOVERSION指定API版本

安装共享库和头文件

本例中将hello 的动态库安装到

/lib目录

将hello.h安装到/include/hello目录

// 文件放到该目录下

INSTALL(FILES hello.h DESTINATION include/hello)

// 二进制，静态库，动态库安装到都用TARGETS
// ARCHIVE 特指静态库，LIBRARY 特指动态库，RUNTIME 特指可执行目标二进制文件
INSTALL(TARGETS hello hello_static LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)

注意：

安装的时候，指定一下路径，

cmake -D CMAKE_INSTALL_PREFIX=/usr ..

使用外部共享库和头文件

准备工作，新建一个目录来使用外部共享库和头文件

root@kali:/usr/local/kong/cmake03# tree
.
├── build
├── CMakeLists.txt
└── src
    ├── CMakeLists.txt
    └── main.cpp

2 directories, 3 files

main.cpp

#include "hello.h"

int main(){
    HelloFunc();
}

解决：make之后找不到的问题

若使用#include "hello/hello.h" 是可以的，但是一般项目中不会这样用，
使用关键字：INCLUDE_DIRECTORIES 这条指令可用来向工程添加多个特定的头文件搜索路径，路径之间用空格分割

在CMakeLists.txt中加入头文件搜索路径

INCLUDE_DIRECTORIES(/usr/include/hello)

解决引用函数库

使用关键字LINK_DIRECTORIES 添加非标准的共享库搜索路径
- 指定第三方库所在路径，LINK_DIRECTORIES(/home/myproject/libs)
或使用关键字TARGET_LINK_LIBRARIES 添加需要链接的共享库
- TARGET_LINK_LIBRARIES使用的时候，只需要给出动态链接库名称即可

在CMakeLists.txt中插入链接共享库，主要插在executable后面

TARGET_LINK_LIBRARIES(main lib hello.so)

查看可执行文件hello的链接情况

root@kali:/usr/local/kong/cmake03/build/bin# ldd hello 
    linux-vdso.so.1 (0x00007ffda31b3000)
    libhello.so => /lib/libhello.so (0x00007f83c95c5000)
    libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007f83c93eb000)
    libstdc++.so.6 => /lib/x86_64-linux-gnu/libstdc++.so.6 (0x00007f83c91ce000)
    /lib64/ld-linux-x86-64.so.2 (0x00007f83c95e7000)
    libm.so.6 => /lib/x86_64-linux-gnu/libm.so.6 (0x00007f83c908b000)
    libgcc_s.so.1 => /lib/x86_64-linux-gnu/libgcc_s.so.1 (0x00007f83c906b000)

链接静态库

TARGET_LINK_LIBRARIES(main libhello.a)

特殊的环境变量

注意：这两个是linux的环境变量，而不是cmake变量的

上述实例使用绝对路径INCLUDE_DIRECTORIES(/usr/include/hello)来指明include路径

还可以使用另一种方式，即使用环境变量export CMAKE_INCLUDE_PATH=/usr/include/hello

产生debug版本的方法：

cmake .. -DCMAKE_BUILD_TYPE=debug

该文章内容由作者“樱花狗子”提供，并非商业用途，转载请申明私自转载将依法追究其法律责任

cmake入门

CMake

CMake是什么

使用环境

安装

开始

语法介绍

基本规则

注意事项

内部构建和外部构建

更改二进制的保存路径

安装

如何安装hello world

安装文件`COPYRIGHT`和`README`

安装脚本runhello.sh

安装doc中的hello.txt

静态库和动态库的构建

构建实例

同时构建静态和动态库

动态库版本号

安装共享库和头文件

使用外部共享库和头文件

解决引用函数库

链接静态库

特殊的环境变量

数组和指针

顺序表

agony

Comments | NOTHING

Cancel Reply

CMake

CMake是什么

使用环境

安装

开始

语法介绍

基本规则

注意事项

内部构建和外部构建

更改二进制的保存路径

安装

如何安装hello world

安装文件COPYRIGHT和README

安装脚本runhello.sh

安装doc中的hello.txt

静态库和动态库的构建

构建实例

同时构建静态和动态库

动态库版本号

安装共享库和头文件

使用外部共享库和头文件

解决引用函数库

链接静态库

特殊的环境变量

数组和指针

顺序表

agony

Comments | NOTHING

Cancel Reply

安装文件`COPYRIGHT`和`README`