cmake的介绍和使用

痛定思痛。 2022-06-18 08:47 189阅读 0赞

转自：http://www.cppblog.com/Roger/archive/2011/11/17/160368.html

Cmake优点：

1.       开发源代码，实用类BSD许可发布。

2.       跨平台，并可以生成native编译配置文件，在linux/unix平台，生成makefile，在mac平台可以生成xcode，在windows平台可以生成msvc工程的配置文件。

3.       能够管理大型项目

4.       简化编译构建过程和编译过程，只需要cmake+make就可以

5.       高效率

6.       可扩展，可以为cmake编写特定功能的模块，扩充cmake功能

如何安装cmake

1.       Cmake的安装可以使用autotools进行安装，点击[cmake-2.8.6.tar.gz][] 链接，可以对软件进行下载。

2.       ./configure

3.       make

4.       sudo make install

Cmake的原理

Helloworld cmake

//main.cpp

\#include<cstdio>

int main()

printf("hello world from main\\n");

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\_SOURCE\_DIR\})

ADD\_EXECUTABLE(hello $\{SRC\_LIST\})

运行以下命令：

cmake . (别忘记加上这个点，表示当前目录)

![1.jpg][]

注意执行完这句话之后会生成几个文件如下：

![2.jpg][]

CMakeFiles, CMakeCache.txt, cmake\_install.cmake等文件，并且生成了Makefile

然后执行make 就可以生成可执行文件hello

![3.jpg][]

这是当前目录下就会生成可执行文件如下图：

![4.png][]

对例子的解释：

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\_SOURCE\_DIR\})

ADD\_EXECUTABLE(hello $\{SRC\_LIST\})

Project的指令的语法是：

PROJECT(projectname \[CXX\] \[C\] \[JAVA\])

这个执行是用来定义工程的名称的和定义工程支持的语言。这个指令也隐式的定义了两个cmake变量：<projectname>\_BINARY\_DIR以及<projectname>\_BINARY\_DIR,这里就是HELLO\_BINARY\_DIR和HELLO\_SOURCE\_DIR，两个变量指的都是当前工程的路径。

SET指令的语法：

SET（VAR\[VALUE\] \[CACHE TYPE DOCSTRING \[FORCE\]\]）

Set指令是用来显式的定义变量的，我们之前用到的是SET(SRC\_LIST main.cpp)如果有多个源文件，也可以定义成SET(SRC\_LIST main.cpp t1.cpp t2.cpp)。

MESSAGE指令的语法是：

MESSAGE(\[SEND\_ERROR | STATUS | FATAL\_ERROR\] "message to display" ...)

这个指令用于向终端输出用户信息，包含三种类型：

SEND\_ERROR，产生错误，生成过程被跳过。

SATUS,输出前缀为-的信息。

FATAL\_ERROR，立即终止所有cmake过程。

我们在这里使用的是STATUS信息输出，显示了由PROJECT指令顶一顶两个饮食变量HELLO\_BINARY\_DIR和HELLO\_SOURCE\_DIR。

ADD\_EXECUTABLE(hello $\{SRC\_LIST\})

定义了这个工程会生成一个文件名为hello的可执行文件，相关的源文件是SRC\_LIST中定义的源文件列表，本例中你可以直接写成ADD\_EXECUTABLE(hello main.c)。

将本例改写成一个最简化的CMakeLists.txt：

PROJECT(HELLO)

ADD\_EXECUTABLE(hello main.c)

下面我们介绍一个比较实用的例子，即包含生成静态库又包含引入外部头文件和链接库的cmake demo。

先按照工程规范建立工程目录，并编写代码，以下面的工程目录为例进行解释这个例子,工程的目录结构为：

![5.jpg][]

编译工程要实现的目标：

1. 添加子目录doc，用以放置这个工程的文档hello.txt

2. 生成hello的静态库，并在main可执行程序链接hello静态库

3. 在这个工程中添加COPYRIGHT,README

4. 在工程目录中添加一个run.sh的脚本，用以调用生成的二进制可执行文件

5. 将生成的二进制文件生成到bin子目录中

6. 编写安装程序

1. 编写CMakeLists.txt

由于一个工程目录中包含多个项目，其中在此项目中包含util项目和main项目，其中util项目是用以生成main程序需要的静态库，main是用以生成可执行文件。

在工程项目中的父目录向有一个CMakeLists.txt是用以声明定义工程需要的Cmake设置还定义了子目录src，用以递归的调用src中的MakeLists.txt。其中工程目录的CMakeLists.txt内容定义如下：

PROJECT(HELLO)

ADD\_SUBDIRECTORY(src)

在src里面的CMakeLists.txt是用以定义src目录包含的两个工程的依赖关系分别进行编译。

util目录里面的CMakeLists.txt是用以定义生成util静态库的规则，其中内容如下：

SET(LIBRARY\_OUTPUT\_PATH $\{HELLO\_SOURCE\_DIR\}/lib)

SET(CMAKE\_C\_COMPILER g++)

SET(SRC\_LIST hello.c)

INCLUDE\_DIRECTORIES($\{HELLO\_SOURCE\_DIR\}/include)

ADD\_LIBRARY(util STATIC $\{SRC\_LIST\})

其中SET(LIBRARY\_OUTPUT\_PATH $\{HELLO\_SOURCE\_DIR\}/lib)定义了库生成的路径，LIBRARY\_OUTPUT\_PATH是一个内部变量，存放库生成路径。

SET(SRC\_LIST hello.c)是用来定义库文件需要的源文件。

INCLUDE\_DIRECTORIES($\{HELLO\_SOURCE\_DIR\}/include)是用来定义非标准库头文件要搜索的路径。其中INCLUDE\_DIRECTORIES命令的格式为：

INCLUDE\_DIRECTORIES(\[AFTER|BEFORE\] \[SYSTEM\] dir1 dir2 ...)

ADD\_LIBRARY(util STATIC $\{SRC\_LIST\})是用来定义生成的库的名字，以及生成库的类型和生成库需要的源文件，其中ADD\_LIBRARY命令格式为：

ADD\_LIBRARY(libname    \[SHARED|STATIC|MODULE\]

\[EXCLUDE\_FROM\_ALL\]

source1 source2 ... sourceN)

SET(CMAKE\_C\_COMPILER g++)是用来定义c的编译器为g++，防止出现C和C++代码在不指定C编译器的情况下默认使用gcc，导致系统编译混乱。

在main目录中的CMakeLists.txt是用来定义可执行程序编译和链接时所需要的一些命令或环境。内容如下：

SET(EXECUTABLE\_OUTPUT\_PATH $\{HELLO\_SOURCE\_DIR\}/bin)

SET(SRC\_LIST main.cpp)

INCLUDE\_DIRECTORIES($\{HELLO\_SOURCE\_DIR\}/include)

LINK\_DIRECTORIES($\{HELLO\_SOURCE\_DIR\}/lib)

ADD\_EXECUTABLE(hello $\{SRC\_LIST\})

TARGET\_LINK\_LIBRARIES(hello util)

INCLUDE\_DIRECTORIES命令是定义工程的include文件夹，其中存放使用到的库的头文件，LINK\_DIRECTORIES是定义工程的库文件，其中存放着库文件，ADD\_EXECUTABLE是定义生成的可执行文件，TARGET\_LINK\_LIBRARIES用以定义链接时需要的库文件。

2．在工程目录下创建build目录，并采用out-of-source方式编译项目。执行命令make ..，执行结果如下：

![6.jpg][]

执行make，这时在build目录下生成了中间编译文件：

![7.jpg][]

执行make命令，结果如下：

![8.jpg][]

可以看到工程创建和编译成功了。

2. 安装

在工程目录下添加COPYRIGHT、README、和run.sh，重新编辑工程目录下的CMakeLists.txt。在CMakeLists.txt中添加如下命令：

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

INSTALL(PROGRAMS run.sh DESTINATION bin)

INSTALL(PROGRAMS bin/hello DESTINATION bin)

INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake\_demo)

这些命令表示在执行make install命令时，安装程序会拷贝相应的文件、目录或程序到指定的前缀开始的目录中，cmake执行命令如下：

cmake -DCMAKE\_INSTALL\_PREFIX=~/data/cmake\_demo ..这时将工程目录安装到~/data/cmake\_demo目录下。执行结果如下：

![9.jpg][]

其中cmake编译c、c++工程完毕。

[cmake-2.8.6.tar.gz]: http://www.cmake.org/files/v2.8/cmake-2.8.6.tar.gz
[1.jpg]: /images/20220618/0aeeacc3189542689d6aee35ec68ac45.png
[2.jpg]: /images/20220618/8a863389724c4431b92c65e5e084bea7.png
[3.jpg]: /images/20220618/7269e77bf60b4182a9178c82f6f82f34.png
[4.png]: /images/20220618/36c057ac75204786b15fe02339a4ebc2.png
[5.jpg]: /images/20220618/42d050b266924f82abe5d6678f85106c.png
[6.jpg]: /images/20220618/dd04e919b3bb48d2b43e359341d2a144.png
[7.jpg]: /images/20220618/9782bb706c3e4849b8d4af7defd2b28b.png
[8.jpg]: /images/20220618/73c9af2e0bf64d9eab0dae6652643de5.png
[9.jpg]: /images/20220618/d621060c90af42e0aace4afa31ba02bc.png