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 并编译的流程如下:
- 编写 CMake 配置文件 CMakeLists.txt 。
- 执行命令
cmake PATH
或者ccmake PATH
生成 Makefile 1 1ccmake
和cmake
的区别在于前者提供了一个交互式的界面。。其中,PATH
是 CMakeLists.txt 所在的目录。 - 使用
make
命令进行编译。
本文将从实例入手,一步步讲解 CMake 的常见用法,文中所有的实例代码可以在这里找到。如果你读完仍觉得意犹未尽,可以继续学习我在文章末尾提供的其他资源。
入门案例:单个源文件
本节对应的源代码所在目录:Demo1。
对于简单的项目,只需要写几行代码就可以了。例如,假设现在我们的项目中只有一个源文件 main.cc ,该程序的用途是计算一个数的指数幂。
|
<p>#include <stdio.h></p>
<p>#include <stdlib.h></p>
<p>/**</p>
<p>* power - Calculate the power of number.</p>
<p>* @param base: Base value.</p>
<p>* @param exponent: Exponent value.</p>
<p>*</p>
<p>* @return base raised to the power exponent.</p>
<p>*/</p>
<p>double power(double base, int exponent)</p>
<p>{</p>
<p>int result = base;</p>
<p>int i;</p>
<p>if (exponent == 0) {</p>
<p>return 1;</p>
<p>}</p>
<p>for(i = 1; i < exponent; ++i){</p>
<p>result = result * base;</p>
<p>}</p>
<p>return result;</p>
<p>}</p>
<p>int main(int argc, char *argv[])</p>
<p>{</p>
<p>if (argc < 3){</p>
<p>printf("Usage: %s base exponent \n", argv[0]);</p>
<p>return 1;</p>
<p>}</p>
<p>double base = atof(argv[1]);</p>
<p>int exponent = atoi(argv[2]);</p>
<p>double result = power(base, exponent);</p>
<p>printf("%g ^ %d is %g\n", base, exponent, result);</p>
<p>return 0;</p>
<p>}</p>
</td>
</tr></tbody></table></div><p> </p>
编写 CMakeLists.txt
首先编写 CMakeLists.txt 文件,并保存在与 main.cc 源文件同个目录下:
|
<p># CMake 最低版本号要求</p>
<p>cmake_minimum_required (VERSION 2.8)</p>
<p># 项目信息</p>
<p>project (Demo1)</p>
<p># 指定生成目标</p>
<p>add_executable(Demo main.cc)</p>
</td>
</tr></tbody></table></div><p> </p>
CMakeLists.txt 的语法比较简单,由命令、注释和空格组成,其中命令是不区分大小写的。符号 #
后面的内容被认为是注释。命令由命令名称、小括号和参数组成,参数之间使用空格进行间隔。
对于上面的 CMakeLists.txt 文件,依次出现了几个命令:
cmake_minimum_required
:指定运行此配置文件所需的 CMake 的最低版本;project
:参数值是Demo1
,该命令表示项目的名称是Demo1
。add_executable
: 将名为 main.cc 的源文件编译成一个名称为 Demo 的可执行文件。
编译项目
之后,在当前目录执行 cmake .
,得到 Makefile 后再使用 make
命令编译得到 Demo1 可执行文件。
|
<p>[ehome@xman Demo1]$ cmake .</p>
<p>-- The C compiler identification is GNU 4.8.2</p>
<p>-- The CXX compiler identification is GNU 4.8.2</p>
<p>-- Check for working C compiler: /usr/sbin/cc</p>
<p>-- Check for working C compiler: /usr/sbin/cc -- works</p>
<p>-- Detecting C compiler ABI info</p>
<p>-- Detecting C compiler ABI info - done</p>
<p>-- Check for working CXX compiler: /usr/sbin/c++</p>
<p>-- Check for working CXX compiler: /usr/sbin/c++ -- works</p>
<p>-- Detecting CXX compiler ABI info</p>
<p>-- Detecting CXX compiler ABI info - done</p>
<p>-- Configuring done</p>
<p>-- Generating done</p>
<p>-- Build files have been written to: /home/ehome/Documents/programming/C/power/Demo1</p>
<p>[ehome@xman Demo1]$ make</p>
<p>Scanning dependencies of target Demo</p>
<p>[100%] Building C object CMakeFiles/Demo.dir/main.cc.o</p>
<p>Linking C executable Demo</p>
<p>[100%] Built target Demo</p>
<p>[ehome@xman Demo1]$ ./Demo 5 4</p>
<p>5 ^ 4 is 625</p>
<p>[ehome@xman Demo1]$ ./Demo 7 3</p>
<p>7 ^ 3 is 343</p>
<p>[ehome@xman Demo1]$ ./Demo 2 10</p>
<p>2 ^ 10 is 1024</p>
</td>
</tr></tbody></table></div><p> </p>
多个源文件
同一目录,多个源文件
本小节对应的源代码所在目录:Demo2。
上面的例子只有单个源文件。现在假如把 power
函数单独写进一个名为 MathFunctions.c
的源文件里,使得这个工程变成如下的形式:
|
<p>./Demo2</p>
<p>|</p>
<p>+--- main.cc</p>
<p>|</p>
<p>+--- MathFunctions.cc</p>
<p>|</p>
<p>+--- MathFunctions.h</p>
</td>
</tr></tbody></table></div><p> </p>
这个时候,CMakeLists.txt 可以改成如下的形式:
|
<p># CMake 最低版本号要求</p>
<p>cmake_minimum_required (VERSION 2.8)</p>
<p># 项目信息</p>
<p>project (Demo2)</p>
<p># 指定生成目标</p>
<p>add_executable(Demo main.cc MathFunctions.cc)</p>
</td>
</tr></tbody></table></div><p> </p>
唯一的改动只是在 add_executable
命令中增加了一个 MathFunctions.cc
源文件。这样写当然没什么问题,但是如果源文件很多,把所有源文件的名字都加进去将是一件烦人的工作。更省事的方法是使用 aux_source_directory
命令,该命令会查找指定目录下的所有源文件,然后将结果存进指定变量名。其语法如下:
|
<p>aux_source_directory(<dir> <variable>)</p>
</td>
</tr></tbody></table></div><p> </p>
因此,可以修改 CMakeLists.txt 如下:
|
<p># CMake 最低版本号要求</p>
<p>cmake_minimum_required (VERSION 2.8)</p>
<p># 项目信息</p>
<p>project (Demo2)</p>
<p># 查找当前目录下的所有源文件</p>
<p># 并将名称保存到 DIR_SRCS 变量</p>
<p>aux_source_directory(. DIR_SRCS)</p>
<p># 指定生成目标</p>
<p>add_executable(Demo ${DIR_SRCS})</p>
</td>
</tr></tbody></table></div><p> </p>
这样,CMake 会将当前目录所有源文件的文件名赋值给变量 DIR_SRCS
,再指示变量 DIR_SRCS
中的源文件需要编译成一个名称为 Demo 的可执行文件。
多个目录,多个源文件
本小节对应的源代码所在目录:Demo3。
现在进一步将 MathFunctions.h 和 MathFunctions.cc 文件移动到 math 目录下。
|
<p>./Demo3</p>
<p>|</p>
<p>+--- main.cc</p>
<p>|</p>
<p>+--- math/</p>
<p>|</p>
<p>+--- MathFunctions.cc</p>
<p>|</p>
<p>+--- MathFunctions.h</p>
</td>
</tr></tbody></table></div><p> </p>
对于这种情况,需要分别在项目根目录 Demo3 和 math 目录里各编写一个 CMakeLists.txt 文件。为了方便,我们可以先将 math 目录里的文件编译成静态库再由 main 函数调用。
根目录中的 CMakeLists.txt :
|
<p># CMake 最低版本号要求</p>
<p>cmake_minimum_required (VERSION 2.8)</p>
<p># 项目信息</p>
<p>project (Demo3)</p>
<p># 查找当前目录下的所有源文件</p>
<p># 并将名称保存到 DIR_SRCS 变量</p>
<p>aux_source_directory(. DIR_SRCS)</p>
<p># 添加 math 子目录</p>
<p>add_subdirectory(math)</p>
<p># 指定生成目标</p>
<p>add_executable(Demo main.cc)</p>
<p># 添加链接库</p>
<p>target_link_libraries(Demo MathFunctions)</p>
</td>
</tr></tbody></table></div><p> </p>
该文件添加了下面的内容: 第3行,使用命令 add_subdirectory
指明本项目包含一个子目录 math,这样 math 目录下的 CMakeLists.txt 文件和源代码也会被处理 。第6行,使用命令 target_link_libraries
指明可执行文件 main 需要连接一个名为 MathFunctions 的链接库 。
子目录中的 CMakeLists.txt:
|
<p># 查找当前目录下的所有源文件</p>
<p># 并将名称保存到 DIR_LIB_SRCS 变量</p>
<p>aux_source_directory(. DIR_LIB_SRCS)</p>
<p># 生成链接库</p>
<p>add_library (MathFunctions ${DIR_LIB_SRCS})</p>
</td>
</tr></tbody></table></div><p> </p>
在该文件中使用命令 add_library
将 src 目录中的源文件编译为静态链接库。
自定义编译选项
本节对应的源代码所在目录:Demo4。
CMake 允许为项目增加编译选项,从而可以根据用户的环境和需求选择最合适的编译方案。
例如,可以将 MathFunctions 库设为一个可选的库,如果该选项为 ON
,就使用该库定义的数学函数来进行运算。否则就调用标准库中的数学函数库。
修改 CMakeLists 文件
我们要做的第一步是在顶层的 CMakeLists.txt 文件中添加该选项:
|
<p># CMake 最低版本号要求</p>
<p>cmake_minimum_required (VERSION 2.8)</p>
<p># 项目信息</p>
<p>project (Demo4)</p>
<p># 加入一个配置头文件,用于处理 CMake 对源码的设置</p>
<p>configure_file (</p>
<p>"${PROJECT_SOURCE_DIR}/config.h.in"</p>
<p>"${PROJECT_BINARY_DIR}/config.h"</p>
<p>)</p>
<p># 是否使用自己的 MathFunctions 库</p>
<p>option (USE_MYMATH</p>
<p>"Use provided math implementation" ON)</p>
<p># 是否加入 MathFunctions 库</p>
<p>if (USE_MYMATH)</p>
<p>include_directories ("${PROJECT_SOURCE_DIR}/math")</p>
<p>add_subdirectory (math)</p>
<p>set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)</p>
<p>endif (USE_MYMATH)</p>
<p># 查找当前目录下的所有源文件</p>
<p># 并将名称保存到 DIR_SRCS 变量</p>
<p>aux_source_directory(. DIR_SRCS)</p>
<p># 指定生成目标</p>
<p>add_executable(Demo ${DIR_SRCS})</p>
<p>target_link_libraries (Demo ${EXTRA_LIBS})</p>
</td>
</tr></tbody></table></div><p> </p>
其中:
- 第7行的
configure_file
命令用于加入一个配置头文件 config.h ,这个文件由 CMake 从 config.h.in 生成,通过这样的机制,将可以通过预定义一些参数和变量来控制代码的生成。 - 第13行的
option
命令添加了一个USE_MYMATH
选项,并且默认值为ON
。 - 第17行根据
USE_MYMATH
变量的值来决定是否使用我们自己编写的 MathFunctions 库。
修改 main.cc 文件
之后修改 main.cc 文件,让其根据 USE_MYMATH
的预定义值来决定是否调用标准库还是 MathFunctions 库:
|
<p>#include</p>
<p>#include</p>
<p>#include "config.h"</p>
<p>#ifdef USE_MYMATH</p>
<p>#include "math/MathFunctions.h"</p>
<p>#else</p>
<p>#include</p>
<p>#endif</p>
<p>int main(int argc, char *argv[])</p>
<p>{</p>
<p>if (argc < 3){</p>
<p>printf("Usage: %s base exponent \n", argv[0]);</p>
<p>return 1;</p>
<p>}</p>
<p>double base = atof(argv[1]);</p>
<p>int exponent = atoi(argv[2]);</p>
<p>#ifdef USE_MYMATH</p>
<p>printf("Now we use our own Math library. \n");</p>
<p>double result = power(base, exponent);</p>
<p>#else</p>
<p>printf("Now we use the standard library. \n");</p>
<p>double result = pow(base, exponent);</p>
<p>#endif</p>
<p>printf("%g ^ %d is %g\n", base, exponent, result);</p>
<p>return 0;</p>
<p>}</p>
</td>
</tr></tbody></table></div><p> </p>
编写 config.h.in 文件
上面的程序值得注意的是第2行,这里引用了一个 config.h 文件,这个文件预定义了 USE_MYMATH
的值。但我们并不直接编写这个文件,为了方便从 CMakeLists.txt 中导入配置,我们编写一个 config.h.in 文件,内容如下:
|
<p>#cmakedefine USE_MYMATH</p>
</td>
</tr></tbody></table></div><p> </p>
这样 CMake 会自动根据 CMakeLists 配置文件中的设置自动生成 config.h 文件。
编译项目
现在编译一下这个项目,为了便于交互式的选择该变量的值,可以使用 ccmake
命令 2 2也可以使用 cmake -i
命令,该命令会提供一个会话式的交互式配置界面。:
从中可以找到刚刚定义的 USE_MYMATH
选项,按键盘的方向键可以在不同的选项窗口间跳转,按下 enter
键可以修改该选项。修改完成后可以按下 c
选项完成配置,之后再按 g
键确认生成 Makefile 。ccmake 的其他操作可以参考窗口下方给出的指令提示。
我们可以试试分别将 USE_MYMATH
设为 ON
和 OFF
得到的结果:
USE_MYMATH 为 ON
运行结果:
|
<p>[ehome@xman Demo4]$ ./Demo</p>
<p>Now we use our own MathFunctions library.</p>
<p>7 ^ 3 = 343.000000</p>
<p>10 ^ 5 = 100000.000000</p>
<p>2 ^ 10 = 1024.000000</p>
</td>
</tr></tbody></table></div><p> </p>
此时 config.h 的内容为:
|
<p>#define USE_MYMATH</p>
</td>
</tr></tbody></table></div><p> </p>
USE_MYMATH 为 OFF
运行结果:
|
<p>[ehome@xman Demo4]$ ./Demo</p>
<p>Now we use the standard library.</p>
<p>7 ^ 3 = 343.000000</p>
<p>10 ^ 5 = 100000.000000</p>
<p>2 ^ 10 = 1024.000000</p>
</td>
</tr></tbody></table></div><p> </p>
此时 config.h 的内容为:
|
<p>/* #undef USE_MYMATH */</p>
</td>
</tr></tbody></table></div><p> </p>
安装和测试
本节对应的源代码所在目录:Demo5。
CMake 也可以指定安装规则,以及添加测试。这两个功能分别可以通过在产生 Makefile 后使用 make install
和 make test
来执行。在以前的 GNU Makefile 里,你可能需要为此编写 install
和 test
两个伪目标和相应的规则,但在 CMake 里,这样的工作同样只需要简单的调用几条命令。
定制安装规则
首先先在 math/CMakeLists.txt 文件里添加下面两行:
|
<p># 指定 MathFunctions 库的安装路径</p>
<p>install (TARGETS MathFunctions DESTINATION bin)</p>
<p>install (FILES MathFunctions.h DESTINATION include)</p>
</td>
</tr></tbody></table></div><p> </p>
指明 MathFunctions 库的安装路径。之后同样修改根目录的 CMakeLists 文件,在末尾添加下面几行:
|
<p># 指定安装路径</p>
<p>install (TARGETS Demo DESTINATION bin)</p>
<p>install (FILES "${PROJECT_BINARY_DIR}/config.h"</p>
<p>DESTINATION include)</p>
</td>
</tr></tbody></table></div><p> </p>
通过上面的定制,生成的 Demo 文件和 MathFunctions 函数库 libMathFunctions.o 文件将会被复制到 /usr/local/bin
中,而 MathFunctions.h 和生成的 config.h 文件则会被复制到 /usr/local/include
中。我们可以验证一下3 3顺带一提的是,这里的 /usr/local/
是默认安装到的根目录,可以通过修改 CMAKE_INSTALL_PREFIX
变量的值来指定这些文件应该拷贝到哪个根目录。:
|
<p>[ehome@xman Demo5]$ sudo make install</p>
<p>[ 50%] Built target MathFunctions</p>
<p>[100%] Built target Demo</p>
<p>Install the project...</p>
<p>-- Install configuration: ""</p>
<p>-- Installing: /usr/local/bin/Demo</p>
<p>-- Installing: /usr/local/include/config.h</p>
<p>-- Installing: /usr/local/bin/libMathFunctions.a</p>
<p>-- Up-to-date: /usr/local/include/MathFunctions.h</p>
<p>[ehome@xman Demo5]$ ls /usr/local/bin</p>
<p>Demo libMathFunctions.a</p>
<p>[ehome@xman Demo5]$ ls /usr/local/include</p>
<p>config.h MathFunctions.h</p>
</td>
</tr></tbody></table></div><p> </p>
为工程添加测试
添加测试同样很简单。CMake 提供了一个称为 CTest 的测试工具。我们要做的只是在项目根目录的 CMakeLists 文件中调用一系列的 add_test
命令。
|
<p># 启用测试</p>
<p>enable_testing()</p>
<p># 测试程序是否成功运行</p>
<p>add_test (test_run Demo 5 2)</p>
<p># 测试帮助信息是否可以正常提示</p>
<p>add_test (test_usage Demo)</p>
<p>set_tests_properties (test_usage</p>
<p>PROPERTIES PASS_REGULAR_EXPRESSION "Usage: .* base exponent")</p>
<p># 测试 5 的平方</p>
<p>add_test (test_5_2 Demo 5 2)</p>
<p>set_tests_properties (test_5_2</p>
<p>PROPERTIES PASS_REGULAR_EXPRESSION "is 25")</p>
<p># 测试 10 的 5 次方</p>
<p>add_test (test_10_5 Demo 10 5)</p>
<p>set_tests_properties (test_10_5</p>
<p>PROPERTIES PASS_REGULAR_EXPRESSION "is 100000")</p>
<p># 测试 2 的 10 次方</p>
<p>add_test (test_2_10 Demo 2 10)</p>
<p>set_tests_properties (test_2_10</p>
<p>PROPERTIES PASS_REGULAR_EXPRESSION "is 1024")</p>
</td>
</tr></tbody></table></div><p> </p>
上面的代码包含了四个测试。第一个测试 test_run
用来测试程序是否成功运行并返回 0 值。剩下的三个测试分别用来测试 5 的 平方、10 的 5 次方、2 的 10 次方是否都能得到正确的结果。其中 PASS_REGULAR_EXPRESSION
用来测试输出是否包含后面跟着的字符串。
让我们看看测试的结果:
|
<p>[ehome@xman Demo5]$ make test</p>
<p>Running tests...</p>
<p>Test project /home/ehome/Documents/programming/C/power/Demo5</p>
<p>Start 1: test_run</p>
<p>1/4 Test #1: test_run ......................... Passed 0.00 sec</p>
<p>Start 2: test_5_2</p>
<p>2/4 Test #2: test_5_2 ......................... Passed 0.00 sec</p>
<p>Start 3: test_10_5</p>
<p>3/4 Test #3: test_10_5 ........................ Passed 0.00 sec</p>
<p>Start 4: test_2_10</p>
<p>4/4 Test #4: test_2_10 ........................ Passed 0.00 sec</p>
<p>100% tests passed, 0 tests failed out of 4</p>
<p>Total Test time (real) = 0.01 sec</p>
</td>
</tr></tbody></table></div><p> </p>
如果要测试更多的输入数据,像上面那样一个个写测试用例未免太繁琐。这时可以通过编写宏来实现:
|
<p># 定义一个宏,用来简化测试工作</p>
<p>macro (do_test arg1 arg2 result)</p>
<p>add_test (test_${arg1}_${arg2} Demo ${arg1} ${arg2})</p>
<p>set_tests_properties (test_${arg1}_${arg2}</p>
<p>PROPERTIES PASS_REGULAR_EXPRESSION ${result})</p>
<p>endmacro (do_test)</p>
<p># 使用该宏进行一系列的数据测试</p>
<p>do_test (5 2 "is 25")</p>
<p>do_test (10 5 "is 100000")</p>
<p>do_test (2 10 "is 1024")</p>
</td>
</tr></tbody></table></div><p> </p>
关于 CTest 的更详细的用法可以通过 man 1 ctest
参考 CTest 的文档。
支持 gdb
让 CMake 支持 gdb 的设置也很容易,只需要指定 Debug
模式下开启 -g
选项:
|
<p>set(CMAKE_BUILD_TYPE "Debug")</p>
<p>set(CMAKE_CXX_FLAGS_DEBUG "$ENV{CXXFLAGS} -O0 -Wall -g -ggdb")</p>
<p>set(CMAKE_CXX_FLAGS_RELEASE "$ENV{CXXFLAGS} -O3 -Wall")</p>
</td>
</tr></tbody></table></div><p> </p>
之后可以直接对生成的程序使用 gdb 来调试。
添加环境检查
本节对应的源代码所在目录:Demo6。
有时候可能要对系统环境做点检查,例如要使用一个平台相关的特性的时候。在这个例子中,我们检查系统是否自带 pow 函数。如果带有 pow 函数,就使用它;否则使用我们定义的 power 函数。
添加 CheckFunctionExists 宏
首先在顶层 CMakeLists 文件中添加 CheckFunctionExists.cmake 宏,并调用 check_function_exists
命令测试链接器是否能够在链接阶段找到 pow
函数。
|
<p># 检查系统是否支持 pow 函数</p>
<p>include (${CMAKE_ROOT}/Modules/CheckFunctionExists.cmake)</p>
<p>check_function_exists (pow HAVE_POW)</p>
</td>
</tr></tbody></table></div><p> </p>
将上面这段代码放在 configure_file
命令前。
预定义相关宏变量
接下来修改 config.h.in 文件,预定义相关的宏变量。
|
<p>// does the platform provide pow function?</p>
<p>#cmakedefine HAVE_POW</p>
</td>
</tr></tbody></table></div><p> </p>
在代码中使用宏和函数
最后一步是修改 main.cc ,在代码中使用宏和函数:
|
<p>#ifdef HAVE_POW</p>
<p>printf("Now we use the standard library. \n");</p>
<p>double result = pow(base, exponent);</p>
<p>#else</p>
<p>printf("Now we use our own Math library. \n");</p>
<p>double result = power(base, exponent);</p>
<p>#endif</p>
</td>
</tr></tbody></table></div><p> </p>
添加版本号
本节对应的源代码所在目录:Demo7。
给项目添加和维护版本号是一个好习惯,这样有利于用户了解每个版本的维护情况,并及时了解当前所用的版本是否过时,或是否可能出现不兼容的情况。
首先修改顶层 CMakeLists 文件,在 project
命令之后加入如下两行:
|
<p>set (Demo_VERSION_MAJOR 1)</p>
<p>set (Demo_VERSION_MINOR 0)</p>
</td>
</tr></tbody></table></div><p> </p>
分别指定当前的项目的主版本号和副版本号。
之后,为了在代码中获取版本信息,我们可以修改 config.h.in 文件,添加两个预定义变量:
|
<p>// the configured options and settings for Tutorial</p>
<p>#define Demo_VERSION_MAJOR @Demo_VERSION_MAJOR@</p>
<p>#define Demo_VERSION_MINOR @Demo_VERSION_MINOR@</p>
</td>
</tr></tbody></table></div><p> </p>
这样就可以直接在代码中打印版本信息了:
|
<p>#include <stdio.h></p>
<p>#include <stdlib.h></p>
<p>#include <math.h></p>
<p>#include "config.h"</p>
<p>#include "math/MathFunctions.h"</p>
<p>int main(int argc, char *argv[])</p>
<p>{</p>
<p>if (argc < 3){</p>
<p>// print version info</p>
<p>printf("%s Version %d.%d\n",</p>
<p>argv[0],</p>
<p>Demo_VERSION_MAJOR,</p>
<p>Demo_VERSION_MINOR);</p>
<p>printf("Usage: %s base exponent \n", argv[0]);</p>
<p>return 1;</p>
<p>}</p>
<p>double base = atof(argv[1]);</p>
<p>int exponent = atoi(argv[2]);</p>
<p>#if defined (HAVE_POW)</p>
<p>printf("Now we use the standard library. \n");</p>
<p>double result = pow(base, exponent);</p>
<p>#else</p>
<p>printf("Now we use our own Math library. \n");</p>
<p>double result = power(base, exponent);</p>
<p>#endif</p>
<p>printf("%g ^ %d is %g\n", base, exponent, result);</p>
<p>return 0;</p>
<p>}</p>
</td>
</tr></tbody></table></div><p> </p>
生成安装包
本节对应的源代码所在目录:Demo8。
本节将学习如何配置生成各种平台上的安装包,包括二进制安装包和源码安装包。为了完成这个任务,我们需要用到 CPack ,它同样也是由 CMake 提供的一个工具,专门用于打包。
首先在顶层的 CMakeLists.txt 文件尾部添加下面几行:
|
<p># 构建一个 CPack 安装包</p>
<p>include (InstallRequiredSystemLibraries)</p>
<p>set (CPACK_RESOURCE_FILE_LICENSE</p>
<p>"${CMAKE_CURRENT_SOURCE_DIR}/License.txt")</p>
<p>set (CPACK_PACKAGE_VERSION_MAJOR "${Demo_VERSION_MAJOR}")</p>
<p>set (CPACK_PACKAGE_VERSION_MINOR "${Demo_VERSION_MINOR}")</p>
<p>include (CPack)</p>
</td>
</tr></tbody></table></div><p> </p>
上面的代码做了以下几个工作:
- 导入 InstallRequiredSystemLibraries 模块,以便之后导入 CPack 模块;
- 设置一些 CPack 相关变量,包括版权信息和版本信息,其中版本信息用了上一节定义的版本号;
- 导入 CPack 模块。
接下来的工作是像往常一样构建工程,并执行 cpack
命令。
- 生成二进制安装包:
|
<p>cpack -C CPackConfig.cmake</p>
</td>
</tr></tbody></table></div><p> </p>
- 生成源码安装包
|
<p>cpack -C CPackSourceConfig.cmake</p>
</td>
</tr></tbody></table></div><p> </p>
我们可以试一下。在生成项目后,执行 cpack -C CPackConfig.cmake
命令:
|
<p>[ehome@xman Demo8]$ cpack -C CPackSourceConfig.cmake</p>
<p>CPack: Create package using STGZ</p>
<p>CPack: Install projects</p>
<p>CPack: - Run preinstall target for: Demo8</p>
<p>CPack: - Install project: Demo8</p>
<p>CPack: Create package</p>
<p>CPack: - package: /home/ehome/Documents/programming/C/power/Demo8/Demo8-1.0.1-Linux.sh generated.</p>
<p>CPack: Create package using TGZ</p>
<p>CPack: Install projects</p>
<p>CPack: - Run preinstall target for: Demo8</p>
<p>CPack: - Install project: Demo8</p>
<p>CPack: Create package</p>
<p>CPack: - package: /home/ehome/Documents/programming/C/power/Demo8/Demo8-1.0.1-Linux.tar.gz generated.</p>
<p>CPack: Create package using TZ</p>
<p>CPack: Install projects</p>
<p>CPack: - Run preinstall target for: Demo8</p>
<p>CPack: - Install project: Demo8</p>
<p>CPack: Create package</p>
<p>CPack: - package: /home/ehome/Documents/programming/C/power/Demo8/Demo8-1.0.1-Linux.tar.Z generated.</p>
</td>
</tr></tbody></table></div><p> </p>
此时会在该目录下创建 3 个不同格式的二进制包文件:
|
<p>[ehome@xman Demo8]$ ls Demo8-*</p>
<p>Demo8-1.0.1-Linux.sh Demo8-1.0.1-Linux.tar.gz Demo8-1.0.1-Linux.tar.Z</p>
</td>
</tr></tbody></table></div><p> </p>
这 3 个二进制包文件所包含的内容是完全相同的。我们可以执行其中一个。此时会出现一个由 CPack 自动生成的交互式安装界面:
|
<p>[ehome@xman Demo8]$ sh Demo8-1.0.1-Linux.sh</p>
<p>Demo8 Installer Version: 1.0.1, Copyright (c) Humanity</p>
<p>This is a self-extracting archive.</p>
<p>The archive will be extracted to: /home/ehome/Documents/programming/C/power/Demo8</p>
<p>If you want to stop extracting, please press <ctrl-C>.</p>
<p>The MIT License (MIT)</p>
<p>Copyright (c) 2013 Joseph Pan(http://hahack.com)</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of</p>
<p>this software and associated documentation files (the "Software"), to deal in</p>
<p>the Software without restriction, including without limitation the rights to</p>
<p>use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of</p>
<p>the Software, and to permit persons to whom the Software is furnished to do so,</p>
<p>subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all</p>
<p>copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</p>
<p>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS</p>
<p>FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR</p>
<p>COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER</p>
<p>IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</p>
<p>CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<p>Do you accept the license? [yN]:</p>
<p>y</p>
<p>By default the Demo8 will be installed in:</p>
<p>"/home/ehome/Documents/programming/C/power/Demo8/Demo8-1.0.1-Linux"</p>
<p>Do you want to include the subdirectory Demo8-1.0.1-Linux?</p>
<p>Saying no will install in: "/home/ehome/Documents/programming/C/power/Demo8" [Yn]:</p>
<p>y</p>
<p>Using target directory: /home/ehome/Documents/programming/C/power/Demo8/Demo8-1.0.1-Linux</p>
<p>Extracting, please wait...</p>
<p>Unpacking finished successfully</p>
</td>
</tr></tbody></table></div><p> </p>
完成后提示安装到了 Demo8-1.0.1-Linux 子目录中,我们可以进去执行该程序:
|
<p>[ehome@xman Demo8]$ ./Demo8-1.0.1-Linux/bin/Demo 5 2</p>
<p>Now we use our own Math library.</p>
<p>5 ^ 2 is 25</p>
</td>
</tr></tbody></table></div><p> </p>
关于 CPack 的更详细的用法可以通过 man 1 cpack
参考 CPack 的文档。
将其他平台的项目迁移到 CMake
CMake 可以很轻松地构建出在适合各个平台执行的工程环境。而如果当前的工程环境不是 CMake ,而是基于某个特定的平台,是否可以迁移到 CMake 呢?答案是可能的。下面针对几个常用的平台,列出了它们对应的迁移方案。
autotools
- am2cmake 可以将 autotools 系的项目转换到 CMake,这个工具的一个成功案例是 KDE 。
- Alternative Automake2CMake 可以转换使用 automake 的 KDevelop 工程项目。
- Converting autoconf tests
qmake
- qmake converter 可以转换使用 QT 的 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 平台。
相关链接
类似工具
- SCons:Eric S. Raymond、Timothee Besset、Zed A. Shaw 等大神力荐的项目架构工具。和 CMake 的最大区别是使用 Python 作为执行脚本。