CMake(2)-详解-编译-安装-支持GDB-添加环境检查-添加版本号-生成安装包

目录

1.什么是CMake    

1.1 编译流程CMakeLists.txt

a) 最简单 demo1

b) 常用demo2

c) 单目录，源文件-输出文件 DIR_SRCS中

d)多目录，多源文件

1.2.执行命令：

1.3.自定义编译选项

2.安装和测试

3.支持GDB

4.添加环境检查

5.添加版本号

6.生成安装包

7.其它工具

7.1qmake

7.2Visual Studio

▌

---

1.什么是CMake

 

      它首先允许开发者编写一种平台无关的 CMakeList.txt 文件来定制整个编译流程，然后再根据目标用户的平台进一步生成所需的本地化 Makefile 和工程文件。

1.1编译流程CMakeLists.txt

a) 最简单 demo1

CMakeLists.txt 文件，并保存在与 http://main.cc 源文件同个目录下
demo1

# cmake 最低版本号要求
cmake_minimum_required(VERSION 2.8)#项目信息
project(Demo1)#指定生成目标
add_executable(Demo main.cpp)# 多文件 
# 查找当前目录下的所有源文件
# 并将名称保存到 DIR_SRCS 变量
aux_source_directory(<dir> <variable>)
aux_source_directory(. DIR_SRCS)
# 指定生成目标
add_executable(Demo ${DIR_SRCS})

b) 常用demo2

#1.编译器                   cmake_minimum_reqired(VERSION 2.8)
#2.项目名称                 project(test)
#3.头文件的搜索路径         include_directories
#4.用变量代替值             set(variable value)#5.源文件                   add_executable(hello, main.cpp)
#6.源文件生成的链接库文件   add_library(libname STATIC/SHARED sources)
#7.链接库文件               target_link_libraries( target library1 library2 ...)
#8.工程中添加：子目录       add_subdirectory(source_dir)
#9.工程中查找源文件         aux_source_directory(dir varname)# 打印输出                  message(mode "message text")#10.搜索第三方库            find_package(packageName version EXACT/QUIET/REQUIRED)
# EXACT:要求该版本号必须精确匹配  QUIET：禁止显示没有找到时的  REQUIRED:包没有找到，cmake过程终止
#11.列表操作 LIST(APPEND CMAKE_MODULE_PATH ${ PROJECT_SOURCE_DIR}/cmake_modules)
（读、搜索、修改、排序）#12.追加例子 #13.判断语句 if,elseif,endif
#14.循环指令 foreach,endforeach

c) 单目录，源文件-输出文件 DIR_SRCS中
 

# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)# 项目信息
project (Demo2)# 查找当前目录下的所有源文件
# 并将名称保存到 DIR_SRCS 变量
aux_source_directory(. DIR_SRCS)# 指定生成目标
add_executable(Demo ${DIR_SRCS})

d)多目录，多源文件

# CMake 最低版本号要求
cmake_minimum_required (VERSION 2.8)# 项目信息
project (Demo3)#1.多源：添加链接库  指明可执行文件 main 需要连接一个名为 MathFunctions 的链接库
target_link_libraries(Demo MathFunctions)
#1.多源：当前目录
aux_source_directory(. DIR_SRCS)
#1.多源：子目录 
add_subdirectory(math)#2.生成目标： 单个文件
add_executable(Demo main.cc)
#2.生成目标： 生成链接库
aux_source_directory(. DIR_LIB_SRCS)
add_library (MathFunctions ${DIR_LIB_SRCS})

1.2.执行命令：

cmake PATH ,ccmake PATH 生成Makefile。

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

cmake
make
./Demo

1.3.自定义编译选项

 

1.修改cmakelist.txt 添加该选项
2.修改.cc文件
3.编写 config.h.in
4.编译项目 
5.运用配置，不用配置

1.修改cmakelist.txt 添加该选项
 

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)aux_source_directory(. DIR_SRCS)
add_executable(Demo ${DIR_SRCS})
target_link_libraries (Demo  ${EXTRA_LIBS})

2.修改.cc文件

 

#include <stdio.h>
#include <stdlib.h>
#include "config.h"#ifdef USE_MYMATH#include "math/MathFunctions.h"
#else#include <math.h>
#endifint 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_MYMATHprintf("Now we use our own Math library. \n");double result = power(base, exponent);
#elseprintf("Now we use the standard library. \n");double result = pow(base, exponent);
#endifprintf("%g ^ %d is %g\n", base, exponent, result);return 0;
}

3.编写 config.h.in
 

#cmakedefine USE_MYMATH

4.编译项目 

 

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

5.运用配置，不用配置

2.安装和测试

   CMake 也可以指定安装规则，以及添加测试。这两个功能分别可以通过在产生 Makefile 后使用 make install 和 make test 来执行。

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

# 指定 MathFunctions 库的安装路径
install (TARGETS MathFunctions DESTINATION bin)
install (FILES MathFunctions.h DESTINATION include)# 指定安装路径
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 中。

我们可以验证一下（顺带一提的是，这里的 /usr/local/ 是默认安装到的根目录，可以通过修改 CMAKE_INSTALL_PREFIX 变量的值来指定这些文件应该拷贝到哪个根目录）：

测试：
 

# 启用测试
enable_testing()# 测试程序是否成功运行
add_test (test_run Demo 5 2)# 测试帮助信息是否可以正常提示
add_test (test_usage Demo)
set_tests_properties (test_usagePROPERTIES PASS_REGULAR_EXPRESSION "Usage: .* base exponent")# 测试 5 的平方
add_test (test_5_2 Demo 5 2)set_tests_properties (test_5_2PROPERTIES PASS_REGULAR_EXPRESSION "is 25")# 测试 10 的 5 次方
add_test (test_10_5 Demo 10 5)set_tests_properties (test_10_5PROPERTIES PASS_REGULAR_EXPRESSION "is 100000")# 测试 2 的 10 次方
add_test (test_2_10 Demo 2 10)set_tests_properties (test_2_10PROPERTIES PASS_REGULAR_EXPRESSION "is 1024")

cmd ：make test

# 定义一个宏，用来简化测试工作
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")

3.支持GDB

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")

 

4.添加环境检查

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

 

# 检查系统是否支持 pow 函数
include (${CMAKE_ROOT}/Modules/CheckFunctionExists.cmake)
check_function_exists (pow HAVE_POW)

4.2预定义相关宏变量
 

#cmakedefine HAVE_POW

4.3在代码中使用宏和函数

 

#ifdef HAVE_POWprintf("Now we use the standard library. \n");double result = pow(base, exponent);
#elseprintf("Now we use our own Math library. \n");double result = power(base, exponent);
#endif

5.添加版本号

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

set (Demo_VERSION_MAJOR 1)
set (Demo_VERSION_MINOR 0)

修改 http://config.h.in 文件，添加两个预定义变量：
 

// the configured options and settings for Tutorial
#define Demo_VERSION_MAJOR @Demo_VERSION_MAJOR@
#define Demo_VERSION_MINOR @Demo_VERSION_MINOR@

#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 infoprintf("%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);
#elseprintf("Now we use our own Math library. \n");double result = power(base, exponent);
#endifprintf("%g ^ %d is %g\n", base, exponent, result);return 0;
}

6.生成安装包

 

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

# 构建一个 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 命令。

• 生成二进制安装包：

cpack -C CPackConfig.cmake

生成源码安装包
 

cpack -C CPackSourceConfig.cmake

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

[ehome@xman Demo8]$ ls Demo8-*
Demo8-1.0.1-Linux.sh  Demo8-1.0.1-Linux.tar.gz  Demo8-1.0.1-Linux.tar.Z

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

[ehome@xman Demo8]$ ./Demo8-1.0.1-Linux/bin/Demo 5 2
Now we use our own Math library. 
5 ^ 2 is 25

7.其它工具

7.1qmake
 

converter 可以转换使用 QT 的 qmake 的工程.
 

7.2Visual Studio

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

▌