CMake入门教程

一、CMake简介

不同Make工具,如GNU Make、QT的qmake、微软的MS nmake、BSD Make(pmake)等,遵循着不同的规范和标准,所执行的Makefile格式也不同。如果软件想跨平台,必须要保证能够在不同平台编译。而如果使用Make工具,必须为不同的Make工具编写不同的Makefile。
CMake是一个比Make工具更高级的编译配置工具,是一个跨平台的、开源的构建系统(BuildSystem)。CMake允许开发者编写一种平台无关的CMakeList.txt文件来定制整个编译流程,然后再根据目标用户的平台进一步生成所需的本地化Makefile和工程文件,如:为Unix平台生成Makefile文件(使用GCC编译),为Windows MSVC生成projects/workspaces(使用VS IDE编译)或Makefile文件(使用nmake编译)。使用CMake作为项目架构系统的知名开源项目有VTK、ITK、KDE、OpenCV、OSG等。

二、CMake管理工程

在Linux平台下使用CMake生成Makefile并编译的流程如下:
A、编写CMake配置文件CMakeLists.txt
B、执行命令cmake PATH生成Makefile,PATH是CMakeLists.txt所在的目录。
C、使用make命令进行编译。
D、使用make install命令进行安装
E、使用make test命令进行测试
F、使用CPack命令进行打包

三、单个源文件工程

1、源文件编写

假设项目CMakeDemo中只有一个StrCmp.cpp源文件,程序用途是比较两个字符串是否匹配

#include <stdio.h>

 int my_strcmp (const char *src, const char *dst)
 {
     int ret = 0 ;
     while(!(ret = *(unsigned char *)src - *(unsigned char *)dst) && *dst)
     {
         ++src;
         ++dst;
     }
     if ( ret < 0 )
     	ret = -1;
     else if ( ret > 0 )
        ret = 1 ;

    return( ret );
 }

int main(int argc,char *argv[])
{
    if (argc < 3){
      fprintf(stdout,"Usage: %s str1 str2\n", argv[0]);
      return 1;
    }
    int ret = my_strcmp(argv[1], argv[2]);
    if ( ret== 0) {
	    printf("str1和str2相同!\n");
	}
	else {
	    printf("str1和str2不相同!\n");
	}

	return 0;
}

2、编写CMakeLists.txt

在StrCmp.cpp源文件目录CMakeDemo下编写CMakeLists.txt文件。

#CMake最低版本号要求
cmake_minimum_required (VERSION 2.8)

#项目信息
project (StrCmp)

#指定生成目标
add_executable (${PROJECT_NAME} StrCmp.cpp)

CMakeLists.txt由命令、注释和空格组成,其中命令是不区分大小写。符号#后的内容被认为是注释。命令由命令名称、小括号和参数组成,参数之间使用空格进行间隔。
本例中CMakeLists.txt文件的命令如下:
cmake_minimum_required:指定运行本配置文件所需的CMake的最低版本;
project:参数值是StrCmp,表示项目的名称是StrCmp。
add_executable:将名为StrCmp.cpp的源文件编译成一个名称为StrCmp的可执行文件。${PROJECT_NAME}返回通过 PROJECT 指令定义的项目名称

3、编译工程

在源码根目录下创建一个build目录,进入build目录,执行cmake …,生成Makefile,再使用make命令编译得到StrCmp可执行文件。
通常,建议在源码根目录下创建一个独立的build构建编译目录,将构建过程产生的临时文件等文件与源码隔离,避免源码被污染。

# cd ./build
# cmake ..
# make

四、单目录多源文件工程

1、源文件编写

假如把my_strcmp函数单独写进一个名为StringFunctions.cpp的源文件里,使得这个工程变成如下的形式:
在这里插入图片描述

StringFunctions.h文件:

#ifndef STRINGFUNCTION_H_
#define STRINGFUNCTION_H_

int my_strcmp (const char *src, const char *dst);

#endif // STRINGFUNCTION_H_

MathFunctions.cpp文件:

#include "StringFunctions.h"

int my_strcmp (const char *src, const char *dst)
{
     int ret = 0 ;
     while(!(ret = *(unsigned char *)src - *(unsigned char *)dst) && *dst)
     {
         ++src;
         ++dst;
     }
     if ( ret < 0 )
        ret = -1;
    else if ( ret > 0 )
        ret = 1 ;

    return( ret );
}

StrCmp.cpp文件:

#include <stdio.h>
#include "StringFunctions.h"

int main(int argc,char *argv[])
{
    if (argc < 3){
      fprintf(stdout,"Usage: %s str1 str2\n", argv[0]);
      return 1;
    }
    int ret = my_strcmp(argv[1], argv[2]);
    if ( ret== 0) {
	    printf("str1和str2相同!\n");
	}
	else {
	    printf("str1和str2不相同!\n");
	}

	return 0;
}

2、编写CMakeLists.txt

#CMake最低版本号要求
cmake_minimum_required (VERSION 2.8)

#项目信息
project (StrCmp)

#查找当前目录下的所有源文件,并将名称保存到DIR_SRCS变量
aux_source_directory(. DIR_SRCS)

#指定生成目标
add_executable (${PROJECT_NAME} ${DIR_SRCS})

aux_source_directory命令会查找指定目录下的所有源文件,然后将结果存进指定变量名。其语法如下:
aux_source_directory(dir variable)
CMake会将当前目录所有源文件的文件名赋值给变量DIR_SRCS ,再指示变量DIR_SRCS中的源文件需要编译成一个名称为StrCmp的可执行文件。

3、编译工程

# cd ./build
# cmake ..
# make

五、多文件多目录工程

1、源码文件编写

创建一个tools目录,将StringFunctions.h和StringFunctions.cpp文件移动到tools目录下。在工程目录根目录CMakeDemo和子目录tools里各编写一个CMakeLists.txt文件,可以先将tools目录里的文件编译成静态库再由main函数调用。
在这里插入图片描述

2、编写CMakeLists.txt

根目录的CMakeLists.txt文件:

#CMake最低版本号要求
cmake_minimum_required (VERSION 2.8)

#项目信息
project (StrCmp)

#查找当前目录下的所有源文件,并将名称保存到DIR_SRCS变量
aux_source_directory(. DIR_SRCS)

#添加tools子目录
add_subdirectory (tools)

#指定生成目标
add_executable (${PROJECT_NAME} ${DIR_SRCS})

# 添加链接库
target_link_libraries (${PROJECT_NAME}  StringFunctions)

add_subdirectory命令指明本工程包含一个子目录tools,tools目录下的 CMakeLists.txt文件和源代码也会被处理 。target_link_libraries命令指明可执行文件StrCmp需要连接一个名为StringFunctions的链接库 。

tools子目录的CMakeLists.txt文件:

#查找当前目录下的所有源文件,并将名称保存到DIR_LIB_SRCS变量
aux_source_directory (. DIR_LIB_SRCS)

#生成链接库
add_library (StringFunctions ${DIR_LIB_SRCS})

add_library命令将tools目录中的源文件编译为静态链接库。

3、编译工程

# cd ./build
# cmake ..
# make

六、自定义编译选项

1、自定义编译选项简介

CMake允许为工程增加编译选项,从而可以根据用户的环境和需求选择最合适的编译方案。
例如,可以将StringFunctions库设为一个可选的库,如果该选项为ON ,就使用StringFunctions库定义的字符串函数进行比较,否则就调用标准库中的字符串函数库。

2、编写CMakeLists.txt

在根目录的CMakeLists.txt文件指定自定义编译选项:

#CMake最低版本号要求
cmake_minimum_required (VERSION 2.8)

#项目信息
project (StrCmp)

set(CMAKE_INCLUDE_CURRENT_DIR ON)

# 加入一个配置头文件,用于处理CMake对源码的设置
configure_file (
  "${PROJECT_SOURCE_DIR}/config.h.in"
  "${PROJECT_BINARY_DIR}/config.h"
  )

# 是否使用自己的StringFunctions库
option (USE_MYSTRING
           "Use provided string implementation" ON)
           
# 是否加入StringFunctions 库
if (USE_MYSTRING)
    #添加tools子目录头文件路径
    include_directories ("${PROJECT_SOURCE_DIR}/tools")
    #添加tools子目录
    add_subdirectory (tools)
    #添加EXTRA_LIBS 变量,设置值为StringFunctions
    set (EXTRA_LIBS ${EXTRA_LIBS} StringFunctions)
endif (USE_MYSTRING)

#查找当前目录下的所有源文件,并将名称保存到DIR_SRCS变量
aux_source_directory(. DIR_SRCS)

#指定生成目标
add_executable (${PROJECT_NAME} ${DIR_SRCS})

# 添加链接库
target_link_libraries (${PROJECT_NAME} ${EXTRA_LIBS})

设置CMAKE_INCLUDE_CURRENT_DIR 的值为ON,
将自动添加CMAKE_CURRENT_BINARY_DIR和CMAKE_CURRENT_SOURCE_DIR到当前处理的CMakeLists.txt,相当于在每个CMakeLists.txt加入:INCLUDE_DIRECTORIES(${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR})

configure_file命令用于加入一个配置头文件config.h,config.h文件由CMake从config.h.in生成,通过预定义一些参数和变量来控制代码的生成。
option命令添加了一个USE_MYSTRING选项,并且默认值为ON。
根据USE_MYSTRING变量的值来决定是否使用自己编写的StringFunctions库。

3、修改源文件的调用

修改main.cpp文件,让其根据USE_MYSTRING的预定义值来决定是否调用标准库还是StringFunctions库。

#include <stdio.h>
#include <config.h>

#ifdef USE_MYSTRING
#include "StringFunctions.h"
#else
#include <string.h>
#endif

int main(int argc,char *argv[])
{
    if (argc < 3){
      fprintf(stdout,"Usage: %s str1 str2\n", argv[0]);
      return 1;
    }

    #ifdef USE_MYSTRING
        printf("Now we use our own String library. \n");
        int ret = my_strcmp(argv[1], argv[2]);
    #else
        printf("Now we use the standard library. \n");
        int ret = strcmp(argv[1], argv[2]);
    #endif

    if ( ret== 0) {
	    printf("str1和str2相同!\n");
	}
	else {
	    printf("str1和str2不相同!\n");
	}

	return 0;
}

4、编写config.h.in文件

StrCmp.cpp文件包含了一个config.h文件,config.h文件预定义了USE_MYSTRING 的值。但不需要直接编写config.h文件,为了方便从CMakeLists.txt中导入配置,通常编写一个config.h.in文件,内容如下:

#cmakedefine USE_MYMATH

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

5、编译工程

1、修改CMakeLists.txt文件,USE_MYSTRING为OFF,使用标准库。

# 是否使用自己的StringFunctions库
option (USE_MYSTRING
           "Use provided string implementation" OFF)

在build目录下cmake …,make,执行程序:

# cd ./build
# cmake ..
# make

在这里插入图片描述

2、修改CMakeLists.txt文件,USE_MYSTRING为ON,使用自己的函数库。

# 是否使用自己的StringFunctions库
option (USE_MYSTRING
           "Use provided string implementation" ON)

在build目录下cmake …,make,执行程序:
在这里插入图片描述

七、安装和测试

1、定制安装规则

1、在tools/CMakeLists.txt文件指定StringFunctions库的安装规则:

#指定StringFunctions库的安装路径
install(TARGETS StringFunctions DESTINATION lib)
install(FILES StringFunctions.h DESTINATION include)

2、修改根目录的CMakeLists.txt文件指定目标文件的安装规则:

#设置程序安装的目录
set (CMAKE_INSTALL_PREFIX ${PROJECT_BINARY_DIR})

#指定安装路径
install(TARGETS StrCmp DESTINATION bin)
install(FILES "${PROJECT_BINARY_DIR}/config.h" DESTINATION include)

2、编译工程

# cd ./build
# cmake ..
# make & make install

在这里插入图片描述

通过对安装规则的定制,生成的目标文件和StringFunctions函数库 libStringFunctions.o文件将会被拷贝到当前编译目录下的/bin中,而StringFunctions.h和生成的config.h文件则会被复制到当前编译目录下的/include中。
/usr/local是默认安装到的根目录,可以通过修改 CMAKE_INSTALL_PREFIX 变量的值来指定文件应该拷贝到哪个根目录。

3、为工程添加测试

CMake提供了一个CTest测试工具。在项目根目录的CMakeLists.txt文件中调用一系列的add_test 命令。

#启用测试
enable_testing()

#测试程序是否成功运行
add_test(test_run StrCmp "abc" "abc")

#测试帮助信息是否可以正常提示
add_test(test_usage StrCmp)
set_tests_properties(test_usage
      PROPERTIES PASS_REGULAR_EXPRESSION "Usage: .* str1 str2")
      
#测试相同的字符串
add_test(test_abc_abc StrCmp "abc" "abc")
set_tests_properties(test_abc_abc
     PROPERTIES PASS_REGULAR_EXPRESSION "str1和str2相同")
     
#测试不相同的字符串
add_test(test_abc_acb StrCmp "abc" "acb")
set_tests_properties(test_abc_acb
     PROPERTIES PASS_REGULAR_EXPRESSION "str1和str2不相同")

4、编译测试

# cd ./build
# cmake ..
# make & make test

在这里插入图片描述

第一个测试test_run用来测试程序是否成功运行并返回0值。剩下的三个测试分别用来测试帮助信息是否可以正常提示、测试相同的字符串、测试不相同的字符串是否都能得到正确的结果。其中PASS_REGULAR_EXPRESSION用来测试输出是否包含后面跟着的字符串。

如果要测试更多的输入数据,可以通过编写宏来实现:

# 定义一个宏,用来简化测试工作
macro (do_test arg1 arg2 result)
    add_test (test_${arg1}_${arg2} StrCmp ${arg1} ${arg2})
    set_tests_properties (test_${arg1}_${arg2}
        PROPERTIES PASS_REGULAR_EXPRESSION ${result})
endmacro (do_test)

# 利用 do_test 宏,测试一系列数据
do_test ("abc" "abc" "str1和str2相同")
do_test ("abc" "acb" "str1和str2不相同")
do_test ("abc" "ABC" "str1和str2不相同")

重新编译测试

# cd ./build
# cmake ..
# make & make test

在这里插入图片描述

八、GDB支持

让CMake支持gdb的设置只需要指定Debug模式下开启-g选项:

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来调试。

九、添加环境检查

使用平台相关的特性时,需要对系统环境做检查。检查系统是否自带strcmp函数,如果有strcmp函数,就使用;否则使用自定义的my_strcmp函数。

1、添加 CheckFunctionExists 宏

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

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

#check_function_exists需要放在configure_file命令前。
check_function_exists (strcmp HAVE_STRCMP)

2、预定义相关宏变量

修改 config.h.in 文件,预定义相关的宏变量。

// does the platform provide strcmp function?
#cmakedefine HAVE_STRCMP

3、在代码中使用宏和函数

修改 StrCmp.cpp文件 ,在代码中使用宏和函数。

#include <stdio.h>
#include <config.h>

#ifndef HAVE_STRCMP
#include "StringFunctions.h"
#else
#include <string.h>
#endif

int main(int argc,char *argv[])
{
    if (argc < 3){
      fprintf(stdout,"Usage: %s str1 str2\n", argv[0]);
      return 1;
    }

    #ifndef HAVE_STRCMP
        printf("Now we use our own String library. \n");
        int ret = my_strcmp(argv[1], argv[2]);
    #else
        printf("Now we use the standard library. \n");
        int ret = strcmp(argv[1], argv[2]);
    #endif

    if ( ret== 0) {
	    printf("str1和str2相同!\n");
	}
	else {
	    printf("str1和str2不相同!\n");
	}

	return 0;
}

4、编译工程

# cd ./build
# cmake ..
# make & make install

在这里插入图片描述

十、添加版本号

1、修改顶层CMakeLists.txt文件,在project命令后分别指定当前的项目的主版本号和副版本号。

#设置主版本号和副版本号
set (StrCmp_VERSION_MAJOR 1)
set (StrCmp_VERSION_MINOR 0)

2、分别指定当前的项目的主版本号和副版本号。
为了在代码中获取版本信息,可以修改 config.h.in 文件,添加两个预定义变量:

//the configured options and settings for Tutorial
#define StrCmp_VERSION_MAJOR @StrCmp_VERSION_MAJOR@
#define StrCmp_VERSION_MINOR @StrCmp_VERSION_MINOR@

3、直接在源码中使用:

#include <stdio.h>
#include <config.h>

#ifndef HAVE_STRCMP
#include "StringFunctions.h"
#else
#include <string.h>
#endif

int main(int argc,char *argv[])
{
    if (argc < 3){
        // print version info
        printf("%s Version %d.%d\n",
               argv[0],
               StrCmp_VERSION_MAJOR,
               StrCmp_VERSION_MINOR);
      fprintf(stdout,"Usage: %s str1 str2\n", argv[0]);
      return 1;
    }

    #ifndef HAVE_STRCMP
        printf("Now we use our own String library. \n");
        int ret = my_strcmp(argv[1], argv[2]);
    #else
        printf("Now we use the standard library. \n");
        int ret = strcmp(argv[1], argv[2]);
    #endif

    if ( ret== 0) {
	    printf("str1和str2相同!\n");
	}
	else {
	    printf("str1和str2不相同!\n");
	}

	return 0;
}

4、编译工程

# cd ./build
# cmake ..
# make & make install

在这里插入图片描述

十一、生成安装包

1、增加CPack模块

CMake提供了一个专门用于打包的工具CPack,用于配置生成各种平台上的安装包,包括二进制安装包和源码安装包。

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

# 构建一个 CPack 安装包
include (InstallRequiredSystemLibraries)
set (CPACK_RESOURCE_FILE_LICENSE
  "${CMAKE_CURRENT_SOURCE_DIR}/License.txt")
set (CPACK_PACKAGE_VERSION_MAJOR "${StrCmp_VERSION_MAJOR}")
set (CPACK_PACKAGE_VERSION_MINOR "${StrCmp_VERSION_MINOR}")
include (CPack)

导入InstallRequiredSystemLibraries模块,便于导入CPack模块;
设置一些CPack相关变量,包括版权信息和版本信息
导入CPack模块。

2、在顶层目录下创建License.txt文件内如如下:

The MIT License (MIT)

Copyright (c) 2018 Scorpio Studio

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.

2、生成安装包

1、生成二进制安装包:

# cd ./build
# cmake ..
# make & make install
# mkdir packages
# cd ./packages
# cpack -G ZIP -C Debug --config ../CPackConfig.cmake

2、生成源码安装包:

# cd ./build
# cmake ..
# make & make install
# mkdir packages
# cd ./packages
cpack -C Debug --config ../CPackSourceConfig.cmake

上述两个命令都会在packages目录下创建3个不同格式的二进制包文件:
StrCmp-1.0.1-Linux.tar.gz
StrCmp-1.0.1-Linux.tar.Z
StrCmp-1.0.1-Linux.sh
3个二进制包文件所包含的内容是完全相同的。

3、指定生成器生成安装包

# cd ./build
# cmake ..
# make & make install
# mkdir packages
# cd ./packages
# cpack -G ZIP -C Release --config ../CPackConfig.cmake

上述两个命令都会在packages目录下创建1个zip后缀格式的二进制包文件:
StrCmp-1.0.1-Source.zip

4、生成RPM的安装包

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

# 构建一个 CPack 安装包
include (InstallRequiredSystemLibraries)
set (CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/License.txt")
#设置程序包安装的目录
set(CPACK_PACKAGING_INSTALL_PREFIX ${PROJECT_BINARY_DIR}/install)

# 以下为RPM信息的设置,包名,概述,供应者,版本, 分组等等信息,通过其变量名称可以知道意思
set(CPACK_PACKAGE_NAME "CMakeDemo-StrCmp")
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Simple CPack Tutorial")
set(CPACK_PACKAGE_VENDOR "Apache")
set(CPACK_PACKAGE_VERSION "1.0.0")
set(CPACK_PACKAGE_VERSION_MAJOR "${StrCmp_VERSION_MAJOR}")
set(CPACK_PACKAGE_VERSION_MINOR "${StrCmp_VERSION_MINOR}")
set(CPACK_PACKAGE_VERSION_PATCH "0")
set(CPACK_RPM_PACKAGE_GROUP "CMake")
#set(CPACK_RPM_PACKAGE_URL "https://cmake.org/")
set(CPACK_RPM_PACKAGE_DESCRIPTION "Redhat Server Dependencies")
set(CPACK_PACKAGE_RELEASE 1)
set(CPACK_RPM_PACKAGE_LICENSE "MIT Licence")

# 设置默认生成器,RPM生成器会构建RPM安装包,其它还有TGZ/ZIP等
set(CPACK_GENERATOR "RPM")

include (CPack)

编译生成RPM包

# cd ./build
# cmake ..
# make & make install
# mkdir packages
# cd ./packages
# cpack  -C Release --config ../CPackConfig.cmake

查看未安装RMP包描述:

 # rpm -qip CMakeDemo-StrCmp-1.0.0-Linux.rpm

在这里插入图片描述

查看安装包包含的文件:

 # rpm -qlp CMakeDemo-StrCmp-1.0.0-Linux.rpm

在这里插入图片描述

安装RPM包:

 # sudo rpm -ivh CMakeDemo-StrCmp-1.0.0-Linux.rpm

在这里插入图片描述

卸载RPM包:

 # sudo rpm -e cmakedemo-strcmp

文章引用与参考

【1】http://blog.51cto.com/9291927/2115399
【2】https://wetest.qq.com/lab/view/180.html
【3】http://www.hahack.com/codes/cmake/
【4】https://blog.csdn.net/z_h_s/article/details/50699905
【5】https://www.cnblogs.com/zhoug2020/p/5904206.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值