CMake 教程

CMake是一个跨平台的程序构建工具，比如起自己编写Makefile方便很多。

介绍：http://baike.baidu.com/view/1126160.htm

本文件不介绍CMake的基本语法，下面是篇不错的入门教程：

http://www.ibm.com/developerworks/cn/linux/l-cn-cmake/

一，首先构建比较简单的工程，来对CMake有个简单的了解

1.构建一个工程的时候，需要做的几件事情（如果下面几件事你知道怎么做了，多大的工程就都不是问题了）：

A.源代码在哪里？

B.头文件在哪里？

C.怎么生成静态或者动态库？

D.程序链接的静态库在哪里？

E.如果工程的代码存放在很多地方，那又该怎么找到它们呢？

2.下面从一个最简单的HelloWorld开始，然后一步一步构建一个比较复杂的工程：

A.工程文件如下(只有一个helloworld.cpp源文件):

[email protected]:~/my_projects/test$ tree .
└── helloworld.cpp

B.这时候，我们要写一个CMakeLists.txt（就3句代码）：

PROJECT(hello)                                             #定义整个CMake的工程名
FILE(GLOB SOURCE "./*.cpp")                      #告诉CMake：工程的源文件在哪里？
ADD_EXECUTABLE(hello ${SOURCE})         #告诉CMake：我们要生成可执行文件（hello），并且源文件是由上面定义的

这样就可以在目录下生成一个hello可执行文件了。

3.下面，我们讲一个带头文件的，而且文件都是存放在不同地方：

A.代码分布如下（main.cpp是main函数，里面调用了hello.h声明的SayHello，定义在hello.cpp中）：

[email protected]:~/my_projects/test$ tree .
├── CMakeLists.txt
├── hello
│   └── hello.cpp
├── include
│   └── hello.h
└── main
    └── main.cpp

B.main的代码：

#include "hello.h“
  int main()
   {
       SayHello();
       return 0;
   }

C.CMakeLists.txt:

1 PROJECT(hello_2)
2 
3 FILE(GLOB SOURCE_1 "${CMAKE_SOURCE_DIR}/main/*.cpp") //下面2句告诉CMake，源文件在哪里？main.cpp
4 FILE(GLOB SOURCE_2 "${CMAKE_SOURCE_DIR}/hello/*.cpp")//程序必须链接到hello.cpp里面的SayHello
5 
6 INCLUDE_DIRECTORIES("${CMAKE_SOURCE_DIR}/include/")//告诉CMake头文件在哪里？
7 
8 ADD_EXECUTABLE(hello_2 ${SOURCE_1} ${SOURCE_2})

4.最后来一个复杂的工程：

A.工程描述：

该工程由一个静态库和一个可执行文件组成，头文件和源文件都不在同一个目录，并且CMake也是独立在一个目录

B.代码分布：

[email protected]:~/my_projects/test$ tree .
test                                                         //工程根目录
├── cmake                                           //CMake目录：代码和CMake编译目录分离
│   ├── bin
│   │   └── main                                  //生成后的可执行文件
│   ├── CMakeLists.txt
│   ├── lib
│   │   └── libhello.a                          //生成后的静态库
│   └── src
│       ├── CMakeLists.txt
│       ├── hello
│       │   └── CMakeLists.txt
│       └── main
│           └── CMakeLists.txt
├── hello                                              //hello静态库的源代码
│   └── hello.cpp
├── include                                          //头文件
│   └── hello.h
└── main                                              //可执行文件的源代码目录
    └── main.cpp
可以看出，CMake里面的每一个子目录都有一个CMakeLists.txt

C.编译该工程的过程：

（a）.首先，需要给CMake的一个总入口，这个CMake设置一些全局的变量(cmake/CMakeLists.txt)：

PROJECT(hello_3)

SET(PROJECT_ROOT_PATH "${CMAKE_SOURCE_DIR}/../")                 #工程的根目录，即test
SET(EXECUTABLE_OUTPUT_PATH "${CMAKE_SOURCE_DIR}/bin/")    #可执行生成后存放的目录(CMAKE_SOURCE_DIR是cmake目录)
SET(LIBRARY_OUTPUT_PATH "${CMAKE_SOURCE_DIR}/lib/")             #静态库生成后存放的目录

INCLUDE_DIRECTORIES("${PROJECT_ROOT_PATH}/include/")            #告诉CMake头文件在哪里？

LINK_DIRECTORIES("${CMAKE_SOURCE_DIR}/lib/")                             #告诉CMake静态库在哪里？

ADD_SUBDIRECTORY(src)                                                                     #多目录，把src目录加进来，src里面才是真正编译main和hello的

(b).src目录下的CMakeList.txt，这个CMake只是简单地把main目录和hello目录链接起来：

ADD_SUBDIRECTORY(main)
ADD_SUBDIRECTORY(hello)

(c).hello静态库：

FILE(GLOB SOURCE_1 "${PROJECT_ROOT_PATH}/hello/*.cpp")      #告诉CMake源文件在哪里？
ADD_LIBRARY(hello STATIC ${SOURCE_1})                                       #告诉CMake生成的是一个静态库

(d).main可执行文件：

FILE(GLOB SOURCE_1 "${PROJECT_ROOT_PATH}/main/*.cpp")     #告诉CMake源文件在哪里？

ADD_EXECUTABLE(main ${SOURCE_1})                                          #告诉CMake生成一个main可执行文件
TARGET_LINK_LIBRARIES(main hello)                                              #告诉CMake静态库在哪里？

整个编译的过程就是这样了，最主要的是记住上面”构建一个工程的时候，需要做的几件事情：头文件，源文件，静态库这个元素“，那么再复杂的工程都是这样一步一步构建的

什么是 CMake

All problems in computer science can be solved by another level of indirection.

David Wheeler

你或许听过好几种 Make 工具，例如 GNU Make ，QT 的 qmake ，微软的 MS nmake，BSD Make（pmake），Makepp， 等等。这些 Make 工具遵循着不同的规范和标准，所执行的 Makefile 格式也千差万别。这样就带来了一个严峻的问题：如果软件想跨平台，必须要保证能够在不同平台编译。而如果使用上面的 Make 工具，就得为每一种标准写一次 Makefile ，这将是一件让人抓狂的工作。

CMake图 1 CMake就 是针对上面问题所设计的工具：它首先允许开发者编写一种平台无关的 CMakeList.txt 文件来定制整个编译流程，然后再根据目标用户的平台进一步生成所需的本地化 Makefile 和工程文件，如 Unix 的 Makefile 或 Windows 的 Visual Studio 工程。从而做到“Write once, run everywhere”。显然，CMake 是一个比上述几种 make 更高级的编译配置工具。一些使用 CMake 作为项目架构系统的知名开源项目有 VTK、ITK、KDE、OpenCV、OSG 等 1。

在 linux 平台下使用 CMake 生成 Makefile 并编译的流程如下：

  1. 编写 CMake 配置文件 CMakeLists.txt 。
  2. 执行命令 cmake PATH 或者 ccmake PATH 生成 Makefile 1 1ccmake 和 cmake 的区别在于前者提供了一个交互式的界面。 。其中， PATH 是 CMakeLists.txt 所在的目录。
  3. 使用 make 命令进行编译。

本文将从实例入手，一步步讲解 CMake 的常见用法，文中所有的实例代码可以在这里找到。如果你读完仍觉得意犹未尽，可以继续学习我在文章末尾提供的其他资源。

入门案例：单个源文件

本节对应的源代码所在目录：Demo1。

对于简单的项目，只需要写几行代码就可以了。例如，假设现在我们的项目中只有一个源文件 main.cc ，该程序的用途是计算一个数的指数幂。


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34


#include

#include

/**

* power - Calculate the power of number.

* @param base: Base value.

* @param exponent: Exponent value.

*

* @return base raised to the power exponent.

*/

double power(double base, int exponent)

{

int result = base;

int i;

for(i = 1; i < exponent; ++i){

result = result * base;

}

return result;

}

int main(int argc, char *argv[])

{

if (argc < 3){

printf("Usage: %s base exponent \n", argv[0]);

return 1;

}

double base = atof(argv[1]);

int exponent = atoi(argv[2]);

double result = power(base, exponent);

printf("%g ^ %d is %g\n", base, exponent, result);

return 0;

}

编写 CMakeLists.txt

首先编写 CMakeLists.txt 文件，并保存在与 main.cc 源文件同个目录下：


1

2

3

4

5

6

7

8


# CMake 最低版本号要求

cmake_minimum_required (VERSION 2.8)

# 项目信息

project (Demo1)

# 指定生成目标

add_executable(Demo main.cc)

CMakeLists.txt 的语法比较简单，由命令、注释和空格组成，其中命令是不区分大小写的。符号 # 后面的内容被认为是注释。命令由命令名称、小括号和参数组成，参数之间使用空格进行间隔。

对于上面的 CMakeLists.txt 文件，依次出现了几个命令：

  1. cmake_minimum_required：指定运行此配置文件所需的 CMake 的最低版本；
  2. project：参数是 main，该命令表示项目的名称是 main 。
  3. add_executable： 将名为 main.cc 的源文件编译成一个名称为 Demo 的可执行文件。

编译项目

之后，在当前目录执行 cmake . ，得到 Makefile 后再使用 make 命令编译得到 Demo1 可执行文件。


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25


[[email protected] Demo1]$ cmake .

-- The C compiler identification is GNU 4.8.2

-- The CXX compiler identification is GNU 4.8.2

-- Check for working C compiler: /usr/sbin/cc

-- Check for working C compiler: /usr/sbin/cc -- works

-- Detecting C compiler ABI info

-- Detecting C compiler ABI info - done

-- Check for working CXX compiler: /usr/sbin/c++

-- Check for working CXX compiler: /usr/sbin/c++ -- works

-- Detecting CXX compiler ABI info

-- Detecting CXX compiler ABI info - done

-- Configuring done

-- Generating done

-- Build files have been written to: /home/ehome/Documents/programming/C/power/Demo1

[[email protected] Demo1]$ make

Scanning dependencies of target Demo

[100%] Building C object CMakeFiles/Demo.dir/main.cc.o

Linking C executable Demo

[100%] Built target Demo

[[email protected] Demo1]$ ./Demo 5 4

5 ^ 4 is 625

[[email protected] Demo1]$ ./Demo 7 3

7 ^ 3 is 343

[[email protected] Demo1]$ ./Demo 2 10

2 ^ 10 is 1024

多个源文件

同一目录，多个源文件

本小节对应的源代码所在目录：Demo2。

上面的例子只有单个源文件。现在假如把 power 函数单独写进一个名为 MathFunctions.c 的源文件里，使得这个工程变成如下的形式：


1

2

3

4

5

6

7


./Demo2

|

+--- main.cc

|

+--- MathFunctions.cc

|

+--- MathFunctions.h

这个时候，CMakeLists.txt 可以改成如下的形式：


1

2

3

4

5

6

7

8


# CMake 最低版本号要求

cmake_minimum_required (VERSION 2.8)

# 项目信息

project (Demo2)

# 指定生成目标

add_executable(Demo main.cc MathFunctions.cc)

唯一的改动只是在 add_executable 命令中增加了一个 MathFunctions.cc 源文件。这样写当然没什么问题，但是如果源文件很多，把所有源文件的名字都加进去将是一件烦人的工作。更省事的方法是使用 aux_source_directory 命令，该命令会查找指定目录下的所有源文件，然后将结果存进指定变量名。其语法如下：


1
aux_source_directory()

因此，可以修改 CMakeLists.txt 如下：


1

2

3

4

5

6

7

8

9

10

11

12


# CMake 最低版本号要求

cmake_minimum_required (VERSION 2.8)

# 项目信息

project (Demo2)

# 查找当前目录下的所有源文件

# 并将名称保存到 DIR_SRCS 变量

aux_source_directory(. DIR_SRCS)

# 指定生成目标

add_executable(Demo ${DIR_SRCS})

这样，CMake 会将当前目录所有源文件的文件名赋值给变量 DIR_SRCS ，再指示变量 DIR_SRCS 中的源文件需要编译成一个名称为 Demo 的可执行文件。

多个目录，多个源文件

本小节对应的源代码所在目录：Demo3。

现在进一步将 MathFunctions.h 和 MathFunctions.cc 文件移动到 math 目录下。


1

2

3

4

5

6

7

8

9


./Demo3

|

+--- main.cc

|

+--- math/

|

+--- MathFunctions.cc

|

+--- MathFunctions.h

对于这种情况，需要分别在项目根目录 Demo3 和 math 目录里各编写一个 CMakeLists.txt 文件。为了方便，我们可以先将 math 目录里的文件编译成静态库再由 main 函数调用。

根目录中的 CMakeLists.txt ：


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18


# CMake 最低版本号要求

cmake_minimum_required (VERSION 2.8)

# 项目信息

project (Demo3)

# 查找当前目录下的所有源文件

# 并将名称保存到 DIR_SRCS 变量

aux_source_directory(. DIR_SRCS)

# 添加 math 子目录

add_subdirectory(math)

# 指定生成目标

add_executable(Demo main.cc)

# 添加链接库

target_link_libraries(Demo MathFunctions)

该文件添加了下面的内容: 第3行，使用命令 add_subdirectory 指明本项目包含一个子目录 math，这样 math 目录下的 CMakeLists.txt 文件和源代码也会被处理 。第6行，使用命令 target_link_libraries 指明可执行文件 main 需要连接一个名为 MathFunctions 的链接库 。

子目录中的 CMakeLists.txt：


1

2

3

4

5

6


# 查找当前目录下的所有源文件

# 并将名称保存到 DIR_LIB_SRCS 变量

aux_source_directory(. DIR_LIB_SRCS)

# 生成链接库

add_library (MathFunctions ${DIR_LIB_SRCS})

在该文件中使用命令 add_library 将 src 目录中的源文件编译为静态链接库。

自定义编译选项

本节对应的源代码所在目录：Demo4。

CMake 允许为项目增加编译选项，从而可以根据用户的环境和需求选择最合适的编译方案。

例如，可以将 MathFunctions 库设为一个可选的库，如果该选项为 ON ，就使用该库定义的数学函数来进行运算。否则就调用标准库中的数学函数库。

修改 CMakeLists 文件

我们要做的第一步是在顶层的 CMakeLists.txt 文件中添加该选项：


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30


# CMake 最低版本号要求

cmake_minimum_required (VERSION 2.8)

# 项目信息

project (Demo4)

# 加入一个配置头文件，用于处理 CMake 对源码的设置

configure_file (

"${PROJECT_SOURCE_DIR}/config.h.in"

"${PROJECT_BINARY_DIR}/config.h"

)

# 是否使用自己的 MathFunctions 库

option (USE_MYMATH

"Use provided math implementation" ON)

# 是否加入 MathFunctions 库

if (USE_MYMATH)

include_directories ("${PROJECT_SOURCE_DIR}/math")

add_subdirectory (math)

set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)

endif (USE_MYMATH)

# 查找当前目录下的所有源文件

# 并将名称保存到 DIR_SRCS 变量

aux_source_directory(. DIR_SRCS)

# 指定生成目标

add_executable(Demo ${DIR_SRCS})

target_link_libraries (Demo ${EXTRA_LIBS})

其中：

  1. 第7行的 configure_file 命令用于加入一个配置头文件 config.h ，这个文件由 CMake 从 config.h.in 生成，通过这样的机制，将可以通过预定义一些参数和变量来控制代码的生成。
  2. 第13行的 option 命令添加了一个 USE_MYMATH 选项，并且默认值为 ON 。
  3. 第17行根据 USE_MYMATH 变量的值来决定是否使用我们自己编写的 MathFunctions 库。

修改 main.cc 文件

之后修改 main.cc 文件，让其根据 USE_MYMATH 的预定义值来决定是否调用标准库还是 MathFunctions 库：


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30


#include

#include

#include "config.h"

#ifdef USE_MYMATH

#include "math/MathFunctions.h"

#else

#include

#endif

int main(int argc, char *argv[])

{

if (argc < 3){

printf("Usage: %s base exponent \n", argv[0]);

return 1;

}

double base = atof(argv[1]);

int exponent = atoi(argv[2]);

#ifdef USE_MYMATH

printf("Now we use our own Math library. \n");

double result = power(base, exponent);

#else

printf("Now we use the standard library. \n");

double result = pow(base, exponent);

#endif

printf("%g ^ %d is %g\n", base, exponent, result);

return 0;

}

编写 config.h.in 文件

上面的程序值得注意的是第2行，这里引用了一个 config.h 文件，这个文件预定义了 USE_MYMATH 的值。但我们并不直接编写这个文件，为了方便从 CMakeLists.txt 中导入配置，我们编写一个 config.h.in 文件，内容如下：


1
#cmakedefine USE_MYMATH

这样 CMake 会自动根据 CMakeLists 配置文件中的设置自动生成 config.h 文件。

编译项目

现在编译一下这个项目，为了便于交互式的选择该变量的值，可以使用 ccmake 命令 2 2也可以使用 cmake -i 命令，该命令会提供一个会话式的交互式配置界面。 ：

CMake的交互式配置界面

从中可以找到刚刚定义的 USE_MYMATH 选项，按键盘的方向键可以在不同的选项窗口间跳转，按下 enter 键可以修改该选项。修改完成后可以按下 c 选项完成配置，之后再按 g 键确认生成 Makefile 。ccmake 的其他操作可以参考窗口下方给出的指令提示。

我们可以试试分别将 USE_MYMATH 设为 ON 和 OFF 得到的结果：

USE_MYMATH 为 ON

运行结果：


1

2

3

4

5


[[email protected] Demo4]$ ./Demo

Now we use our own MathFunctions library.

7 ^ 3 = 343.000000

10 ^ 5 = 100000.000000

2 ^ 10 = 1024.000000

此时 config.h 的内容为：


1
#define USE_MYMATH
USE_MYMATH 为 OFF

运行结果：


1

2

3

4

5


[[email protected] Demo4]$ ./Demo

Now we use the standard library.

7 ^ 3 = 343.000000

10 ^ 5 = 100000.000000

2 ^ 10 = 1024.000000

此时 config.h 的内容为：


1
/* #undef USE_MYMATH */

安装和测试

本节对应的源代码所在目录：Demo5。

CMake 也可以指定安装规则，以及添加测试。这两个功能分别可以通过在产生 Makefile 后使用 make install 和 make test 来执行。在以前的 GNU Makefile 里，你可能需要为此编写 install 和 test 两个伪目标和相应的规则，但在 CMake 里，这样的工作同样只需要简单的调用几条命令。

定制安装规则

首先先在 math/CMakeLists.txt 文件里添加下面两行：


1

2

3


# 指定 MathFunctions 库的安装路径

install (TARGETS MathFunctions DESTINATION bin)

install (FILES MathFunctions.h DESTINATION include)

指明 MathFunctions 库的安装路径。之后同样修改根目录的 CMakeLists 文件，在末尾添加下面几行：


1

2

3

4


# 指定安装路径

install (TARGETS Demo DESTINATION bin)

install (FILES "${PROJECT_BINARY_DIR}/config.h"

DESTINATION include)

通过上面的定制，生成的 Demo 文件和 MathFunctions 函数库 libMathFunctions.o 文件将会被复制到 /usr/local/bin 中，而 MathFunctions.h 和生成的 config.h 文件则会被复制到 /usr/local/include 中。我们可以验证一下3 3顺带一提的是，这里的 /usr/local/ 是默认安装到的根目录，可以通过修改 CMAKE_INSTALL_PREFIX 变量的值来指定这些文件应该拷贝到哪个根目录。：


1

2

3

4

5

6

7

8

9

10

11

12

13


[[email protected] Demo5]$ sudo make install

[ 50%] Built target MathFunctions

[100%] Built target Demo

Install the project...

-- Install configuration: ""

-- Installing: /usr/local/bin/Demo

-- Installing: /usr/local/include/config.h

-- Installing: /usr/local/bin/libMathFunctions.a

-- Up-to-date: /usr/local/include/MathFunctions.h

[[email protected] Demo5]$ ls /usr/local/bin

Demo libMathFunctions.a

[[email protected] Demo5]$ ls /usr/local/include

config.h MathFunctions.h

为工程添加测试

添加测试同样很简单。CMake 提供了一个称为 CTest 的测试工具。我们要做的只是在项目根目录的 CMakeLists 文件中调用一系列的 add_test 命令。


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28


# 启用测试

enable_testing()

# 测试程序是否成功运行

add_test (test_run Demo 5 2)

# 测试帮助信息是否可以正常提示

add_test (test_usage Demo)

set_tests_properties (test_usage

PROPERTIES PASS_REGULAR_EXPRESSION "Usage: .* base exponent")

# 测试 5 的平方

add_test (test_5_2 Demo 5 2)

set_tests_properties (test_5_2

PROPERTIES PASS_REGULAR_EXPRESSION "is 25")

# 测试 10 的 5 次方

add_test (test_10_5 Demo 10 5)

set_tests_properties (test_10_5

PROPERTIES PASS_REGULAR_EXPRESSION "is 100000")

# 测试 2 的 10 次方

add_test (test_2_10 Demo 2 10)

set_tests_properties (test_2_10

PROPERTIES PASS_REGULAR_EXPRESSION "is 1024")

上面的代码包含了四个测试。第一个测试 test_run 用来测试程序是否成功运行并返回 0 值。剩下的三个测试分别用来测试 5 的 平方、10 的 5 次方、2 的 10 次方是否都能得到正确的结果。其中 PASS_REGULAR_EXPRESSION 用来测试输出是否包含后面跟着的字符串。

让我们看看测试的结果：


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15


[[email protected] Demo5]$ make test

Running tests...

Test project /home/ehome/Documents/programming/C/power/Demo5

Start 1: test_run

1/4 Test #1: test_run ......................... Passed 0.00 sec

Start 2: test_5_2

2/4 Test #2: test_5_2 ......................... Passed 0.00 sec

Start 3: test_10_5

3/4 Test #3: test_10_5 ........................ Passed 0.00 sec

Start 4: test_2_10

4/4 Test #4: test_2_10 ........................ Passed 0.00 sec

100% tests passed, 0 tests failed out of 4

Total Test time (real) = 0.01 sec

如果要测试更多的输入数据，像上面那样一个个写测试用例未免太繁琐。这时可以通过编写宏来实现：


1

2

3

4

5

6

7

8

9

10

11


# 定义一个宏，用来简化测试工作

macro (do_test arg1 arg2 result)

add_test (test_${arg1}_${arg2} Demo ${arg1} ${arg2})

set_tests_properties (test_${arg1}_${arg2}

PROPERTIES PASS_REGULAR_EXPRESSION ${result})

endmacro (do_test)

# 使用该宏进行一系列的数据测试

do_test (5 2 "is 25")

do_test (10 5 "is 100000")

do_test (2 10 "is 1024")

关于 CTest 的更详细的用法可以通过 man 1 ctest 参考 CTest 的文档。

支持 gdb

让 CMake 支持 gdb 的设置也很容易，只需要指定 Debug 模式下开启 -g 选项：


1

2

3


set(CMAKE_BUILD_TYPE "Debug")

set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} -O0 -Wall -g -ggdb")

set(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} -O3 -Wall")

之后可以直接对生成的程序使用 gdb 来调试。

添加环境检查

本节对应的源代码所在目录：Demo6。

有时候可能要对系统环境做点检查，例如要使用一个平台相关的特性的时候。在这个例子中，我们检查系统是否自带 pow 函数。如果带有 pow 函数，就使用它；否则使用我们定义的 power 函数。

添加 CheckFunctionExists 宏

首先在顶层 CMakeLists 文件中添加 CheckFunctionExists.cmake 宏，并调用 check_function_exists 命令测试链接器是否能够在链接阶段找到 pow 函数。


1

2

3


# 检查系统是否支持 pow 函数

include (${CMAKE_ROOT}/Modules/CheckFunctionExists.cmake)

check_function_exists (pow HAVE_POW)

将上面这段代码放在 configure_file 命令前。

预定义相关宏变量

接下来修改 config.h.in 文件，预定义相关的宏变量。


1

2


// does the platform provide pow function?

#cmakedefine HAVE_POW

在代码中使用宏和函数

最后一步是修改 main.cc ，在代码中使用宏和函数：


1

2

3

4

5

6

7


#ifdef HAVE_POW

printf("Now we use the standard library. \n");

double result = pow(base, exponent);

#else

printf("Now we use our own Math library. \n");

double result = power(base, exponent);

#endif

添加版本号

本节对应的源代码所在目录：Demo7。

给项目添加和维护版本号是一个好习惯，这样有利于用户了解每个版本的维护情况，并及时了解当前所用的版本是否过时，或是否可能出现不兼容的情况。

首先修改顶层 CMakeLists 文件，在 project 命令之后加入如下两行：


1

2


set (Demo_VERSION_MAJOR 1)

set (Demo_VERSION_MINOR 0)

分别指定当前的项目的主版本号和副版本号。

之后，为了在代码中获取版本信息，我们可以修改 config.h.in 文件，添加两个预定义变量：


1

2

3


// the configured options and settings for Tutorial

#define Demo_VERSION_MAJOR @[email protected]

#define Demo_VERSION_MINOR @[email protected]

这样就可以直接在代码中打印版本信息了：


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31


#include <stdio.h>

#include <stdlib.h>

#include <math.h>

#include "config.h"

#include "math/MathFunctions.h"

int main(int argc, char *argv[])

{

if (argc < 3){

// print version info

printf("%s Version %d.%d\n",

argv[0],

Demo_VERSION_MAJOR,

Demo_VERSION_MINOR);

printf("Usage: %s base exponent \n", argv[0]);

return 1;

}

double base = atof(argv[1]);

int exponent = atoi(argv[2]);

#if defined (HAVE_POW)

printf("Now we use the standard library. \n");

double result = pow(base, exponent);

#else

printf("Now we use our own Math library. \n");

double result = power(base, exponent);

#endif

printf("%g ^ %d is %g\n", base, exponent, result);

return 0;

}

生成安装包

本节对应的源代码所在目录：Demo8。

本节将学习如何配置生成各种平台上的安装包，包括二进制安装包和源码安装包。为了完成这个任务，我们需要用到 CPack ，它同样也是由 CMake 提供的一个工具，专门用于打包。

首先在顶层的 CMakeLists.txt 文件尾部添加下面几行：


1

2

3

4

5

6

7


# 构建一个 CPack 安装包

include (InstallRequiredSystemLibraries)

set (CPACK_RESOURCE_FILE_LICENSE

"${CMAKE_CURRENT_SOURCE_DIR}/License.txt")

set (CPACK_PACKAGE_VERSION_MAJOR "${Demo_VERSION_MAJOR}")

set (CPACK_PACKAGE_VERSION_MINOR "${Demo_VERSION_MINOR}")

include (CPack)

上面的代码做了以下几个工作：

  1. 导入 InstallRequiredSystemLibraries 模块，以便之后导入 CPack 模块；
  2. 设置一些 CPack 相关变量，包括版权信息和版本信息，其中版本信息用了上一节定义的版本号；
  3. 导入 CPack 模块。

接下来的工作是像往常一样构建工程，并执行 cpack 命令。

  • 生成二进制安装包：

1
cpack -C CPackConfig.cmake
  • 生成源码安装包

1
cpack -C CPackSourceConfig.cmake

我们可以试一下。在生成项目后，执行 cpack -C CPackConfig.cmake 命令：


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19


[[email protected] Demo8]$ cpack -C CPackSourceConfig.cmake

CPack: Create package using STGZ

CPack: Install projects

CPack: - Run preinstall target for: Demo8

CPack: - Install project: Demo8

CPack: Create package

CPack: - package: /home/ehome/Documents/programming/C/power/Demo8/Demo8-1.0.1-Linux.sh generated.

CPack: Create package using TGZ

CPack: Install projects

CPack: - Run preinstall target for: Demo8

CPack: - Install project: Demo8

CPack: Create package

CPack: - package: /home/ehome/Documents/programming/C/power/Demo8/Demo8-1.0.1-Linux.tar.gz generated.

CPack: Create package using TZ

CPack: Install projects

CPack: - Run preinstall target for: Demo8

CPack: - Install project: Demo8

CPack: Create package

CPack: - package: /home/ehome/Documents/programming/C/power/Demo8/Demo8-1.0.1-Linux.tar.Z generated.

此时会在该目录下创建 3 个不同格式的二进制包文件：


1

2


[[email protected] Demo8]$ ls Demo8-*

Demo8-1.0.1-Linux.sh Demo8-1.0.1-Linux.tar.gz Demo8-1.0.1-Linux.tar.Z

这 3 个二进制包文件所包含的内容是完全相同的。我们可以执行其中一个。此时会出现一个由 CPack 自动生成的交互式安装界面：


1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40


[[email protected] Demo8]$ sh Demo8-1.0.1-Linux.sh

Demo8 Installer Version: 1.0.1, Copyright (c) Humanity

This is a self-extracting archive.

The archive will be extracted to: /home/ehome/Documents/programming/C/power/Demo8

If you want to stop extracting, please press <ctrl-C>.

The MIT License (MIT)

Copyright (c) 2013 Joseph Pan(http://hahack.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of

this software and associated documentation files (the "Software"), to deal in

the Software without restriction, including without limitation the rights to

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of

the Software, and to permit persons to whom the Software is furnished to do so,

subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS

FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR

COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER

IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Do you accept the license? [yN]:

y

By default the Demo8 will be installed in:

"/home/ehome/Documents/programming/C/power/Demo8/Demo8-1.0.1-Linux"

Do you want to include the subdirectory Demo8-1.0.1-Linux?

Saying no will install in: "/home/ehome/Documents/programming/C/power/Demo8" [Yn]:

y

Using target directory: /home/ehome/Documents/programming/C/power/Demo8/Demo8-1.0.1-Linux

Extracting, please wait...

Unpacking finished successfully

完成后提示安装到了 Demo8-1.0.1-Linux 子目录中，我们可以进去执行该程序：


1

2

3


[[email protected] Demo8]$ ./Demo8-1.0.1-Linux/bin/Demo 5 2

Now we use our own Math library.

5 ^ 2 is 25

关于 CPack 的更详细的用法可以通过 man 1 cpack 参考 CPack 的文档。

将其他平台的项目迁移到 CMake

CMake 可以很轻松地构建出在适合各个平台执行的工程环境。而如果当前的工程环境不是 CMake ，而是基于某个特定的平台，是否可以迁移到 CMake 呢？答案是可能的。下面针对几个常用的平台，列出了它们对应的迁移方案。

autotools

qmake

Visual Studio

  • vcproj2cmake.rb 可以根据 Visual Studio 的工程文件（后缀名是 .vcproj 或 .vcxproj）生成 CMakeLists.txt 文件。
  • vcproj2cmake.ps1 vcproj2cmake 的 PowerShell 版本。
  • folders4cmake 根据 Visual Studio 项目文件生成相应的 “source_group” 信息，这些信息可以很方便的在 CMake 脚本中使用。支持 Visual Studio 9/10 工程文件。

CMakeLists.txt 自动推导

  • gencmake 根据现有文件推导 CMakeLists.txt 文件。
  • CMakeListGenerator 应用一套文件和目录分析创建出完整的 CMakeLists.txt 文件。仅支持 Win32 平台。

相关链接

  1. 官方主页
  2. 官方文档
  3. 官方教程
  4. Wiki
  5. FAQ
  6. bug tracker
  7. 邮件列表：
  8. 其他推荐文章

类似工具

  • SCons：Eric S. Raymond、Timothee Besset、Zed A. Shaw 等大神力荐的项目架构工具。和 CMake 的最大区别是使用 Python 作为执行脚本。

cmake jiaocheng:

http://www.ibm.com/developerworks/cn/linux/l-cn-cmake/

blog.chinaunix.net/uid-28458801-id-3501768.html

http://blog.atime.me/note/cmake.html

http://ericge.iteye.com/blog/1187282

www.cppblog.com/tx7do/archive/2010/08/19/124000.html

时间： 2024-12-19 13:15:10

CMake 教程的相关文章

CMAKE 教程前两章节学习

原文 https://cmake.org/cmake-tutorial/ 以下是一个循序渐进的教程,它覆盖了CMAKE帮助改进的通常的构建系统的话题.许多话题在<掌握CMAKE>(<Mastering CMake>)已经作为单独话题介绍,但是在一个示例工程中运用它们会更有帮助于学习.教程可以再本项目开源代码Tests/Tutorial 目录下找到代码树.每一步操作都有包含完整代码的子目录. 第一步 基础起点 最基础的工程就是从代码中构建一个执行文件.对于简单工程来说,仅仅需要两行C

cmake教程

1 教程 cmake界的hello world[2] 进阶的入门教程参考[3] 2 引用 [1] cmake官网 [2] 在 linux 下使用 CMake 构建应用程序 [3] Valgrind官网 原文地址:https://www.cnblogs.com/sword03/p/9379716.html

cmake用法

1.使用cmake的时候,显示cmake不是内部或外部命令,也不是可执行的程序.解决办法参考: https://blog.csdn.net/zmdsjtu/article/details/52296522 2.cmake教程参考:https://www.hahack.com/codes/cmake/ 原文地址:https://www.cnblogs.com/yibeimingyue/p/10406402.html

图像处理简单实例［OpenCV 笔记1］

几个入门的简单程序,和对应的CMakeList, 虽然简单重新测一下写一下也是好的. CMake教程传送门 图像显示 ShowImage.cxx #include <opencv2/opencv.hpp> #include <opencv2/highgui/highgui.hpp> #include <opencv2/imgcodecs/imgcodecs.hpp> int main(){ cv::Mat srcImage = cv::imread("1.jp

最全的增量更新入门 包含linux端和Android

简介 增量更新大量用于 Android各大应用市场.本文想做网络上从服务器到app客户端完整讲解.app用eclipse和android studio 最新版cmark开发ndk 如下图: 以前一直好奇怎么做的直到知道了bsdiff库. 地址附上: bsdiff源码地址和简介 大家可以从简介看到bsdiff是基于bzip2源码(bsdiff和bspatch一个用于生成差异文件补丁,另一个用于差异文件和旧文件合成新文件) 下载地址说明 应用市场原理说明 假设你用的是"XXX市场"点击更新

构建项目makefile

之前没有足够的心理准备,没有想到构建一个项目的makefile这么让人崩溃. 纯手写的话,我的能力还不足. 尝试找工具,autoconf&automake or cmake. 经过大概一天的时间,比较之后,决定使用cmake. 可以从网络上找到足够多的cmake教程,不过都不是很详尽.毕竟够将项目之初这样令人崩溃的活,真正需要去干的人也不是很多. cmake的使用心得会后续慢慢写上,对于我来讲,第一步要知道cmake有什么,然后在实践中练习吧. 还好,对于我来讲,cmake和其他脚本语言并没有太

[转载] CMake Official Tutorial——教程还是官方的好

CMake官方教程传送门:https://cmake.org/cmake-tutorial/ 以下的内容跟官方教程基本一致,少数地方根据自己的测试有所改动: A Basic Starting Point (Step1) The most basic project is an executable built from source code files. For simple projects a two line CMakeLists.txt file is all that is requ

CMake快速入门教程-实战

http://www.ibm.com/developerworks/cn/linux/l-cn-cmake/ http://blog.csdn.net/dbzhang800/article/details/6314073 http://www.cnblogs.com/coderfenghc/archive/2013/01/20/2846621.html http://blog.sina.com.cn/s/blog_4aa4593d0100q3bt.html http://hahack.com/c

CMake使用教程

转: CMake使用教程 CMake是一个比make更高级的编译配置工具,它可以根据不同平台.不同的编译器,生成相应的Makefile或者vcproj项目.通过编写CMakeLists.txt,可以控制生成的Makefile,从而控制编译过程.CMake自动生成的Makefile不仅可以通过make命令构建项目生成目标文件,还支持安装(make install).测试安装的程序是否能正确执行(make test,或者ctest).生成当前平台的安装包(make package).生成源码包(ma