CMake入门实战 笔记

最新推荐文章于 2023-07-18 15:44:24 发布
最新推荐文章于 2023-07-18 15:44:24 发布
阅读量690 收藏 4
点赞数 1
分类专栏： ▶ Linux/嵌入式 # ▶ C/C++ 文章标签： CMake
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43455581/article/details/116716525
版权

文章目录

1. 基本模板

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

# 项目名称
project (Demo1)

# 指定生成目标
add_executable(Demo main.cc)

编译命令如下：

$ camke . # 如果是编译上一层目录，则 cmake ..
$ make

先生成Makefile文件，再make编译！

2. 同一目录多个源文件

# 查找指定目录下的所有源文件
aux_source_directory(<dir> <variable>)

$ aux_source_directory(. DIR_SRCS)
$ add_executable(Demo ${DIR_SRCS})

3. 多目录多源文件

  • 生成链接库
    add_library (MathFunctions ${DIR_LIB_SRCS})
add_library(common STATIC util.cpp) # 生成静态库
add_library(common SHARED util.cpp) # 生成动态库或共享库
  • 添加math子目录，这样就能同时处理math子目录下的CMakeLists.txt和源代码了
    add_subdirectory(math)
  • 添加链接库
    target_link_libraries(test MathFunctions)

注意：如果是两个CMakeLists.txt文件，应该注意子目录下名称变量不能与主目录下重复，否则报错！

4. 自定义编译选项

CMakeLists.txt内容如下：

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

# 项目信息
project (Demo4)

set(CMAKE_INCLUDE_CURRENT_DIR ON)

# 是否使用自己的 MathFunctions 库
option (USE_MYMATH
	   "Use provided math implementation" ON)

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

# 是否加入 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})

源代码中也要通过宏定义实现修改：

#ifdef USE_MYMATH
  #include <MathFunctions.h>
#else
  #include <math.h>
#endif

配置文件config.h.in的内容如下，CMake会自动根据此内容生成config.h文件，如果选项为OFF，则config.h内容会自动生成为#undef USE_MYMATH

#cmakedefine USE_MYMATH

编译时，使用ccmake进入交互式配置界面，通过选项c进入修改配置界面，通过回车键进行配置修改，修改完后通过c返回上层界面，然后选择g选项生成Makefile，最后make生成可执行文件即可。

5. 安装和测试

定义库的安装路径：

# 指定安装路径,默认安装在/usr/local/下
install (TARGETS Demo DESTINATION bin)
install (FILES "${PROJECT_BINARY_DIR}/config.h"
         DESTINATION include)

如果自定义指定安装路径，则在install之前添加：

# 设置上一层目录下的install_file文件夹为安装目录
set(CMAKE_INSTALL_PREFIX ../install_file)

安装指令为：

make install

添加测试：

# 启用测试
enable_testing()

# 测试程序是否成功运行
add_test(test_5_2 Demo 5 2)
# 测试是否能够正常打印
set_tests_properties(test_5_2  PROPERTIES PASS_REGULAR_EXPRESSION "is 25")

编写宏，简化测试：

# 定义宏
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 2 "is 100")
do_test(2 10 "is 1024")

测试指令为：

make test

注意：必须make生成可执行文件后才能进行测试，测试生成的报告位于"编译目录/Testing/Temporary/"下

6. 支持gdb

如果没有设置支持gdb，则查看代码时会提示：

(gdb) l
没有符号表被读取。请使用 "file" 命令。
(gdb)

只需要指定Debug模式下开启-g选项即可完成CMake支持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")

7. 添加环境检查

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

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

注意：由于我们在代码中会通过一些宏定义来调用不同环境下的函数，因此我们要在config.h.in文件里定义#cmakedefine HAVE_POW，因此，检查语句要放在configure_file命令之前。

8. 添加版本号

#项目信息
project (Demo7)
set(Demo_VERSION_MAJOR 2) # 指定当前项目的主版本号
set(Demo_VERSION_MINOR 3) # 指定当前项目的副版本号
set(Demo_VERSION_PATCH 1) # 指定当前项目的补丁等级

为了在代码中能够获取版本信息，修改config.h.in文件：

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

在代码中，即可通过打印宏定义实现版本获取。

9. 生成二进制安装包和源码安装包

在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)
  • 生成二进制安装包
cpack -C CPackConfig.cmake
  • 生成源码安装包
cpack -C CPackSourceConfig.cmake

执行以后，会在执行目录下生成3个不同格式的二进制包文件：

  • 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目录下，有bin、include、lib三个文件夹，即我们在CMakeLists.txt中设置的内容。

更多CPack的详细用法可通过man 1 cpack或cpack --help查看。

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

  • autotools
    • am2cmake工具：将autotools系的项目转换到CMake
    • Alternative Automake2CMake工具：可以转换使用automake的KDevelop工程项目
  • 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 平台。

11. 完整Demo

cmake_minimum_required (VERSION 2.8)

# 项目信息
project (Demo8)
set (Demo_VERSION_MAJOR 1)
set (Demo_VERSION_MINOR 0)

set (CMAKE_INCLUDE_CURRENT_DIR ON)

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

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

# 是否加入 MathFunctions 库
if (NOT HAVE_POW)
  include_directories ("${PROJECT_SOURCE_DIR}/math")
  add_subdirectory (math)  
  set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)
endif (NOT HAVE_POW)

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

# 指定生成目标
add_executable(Demo ${DIR_SRCS})
target_link_libraries (Demo  ${EXTRA_LIBS})

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

# 启用测试
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")

# 定义一个宏，用来简化测试工作
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 宏，测试一系列数据
do_test (5 2 "is 25")
do_test (10 5 "is 100000")
do_test (2 10 "is 1024")

# 构建一个 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)

参考文献：

  • CMake入门实战_HaHack
罗伯特祥
关注
专栏目录
小白入门笔记：CMake编译过程详解
3D视觉工坊
04-12 754
作者丨Sky Shaw@知乎点击进入—>3D视觉工坊学习交流群1、你好，CMake1.1 CMake是什么？我觉得针对这个问题最简单（但不是最正确的）的回答应该是：“CMake是服务于将源代111码转换成可执行的文件的工具”。将源码转换为可工作应用会比较神奇。不仅是效果本身(即设计并赋予生命的工作机制)，而且是将理念付诸于过程的行为本身。CMake本身是一个工具集，由五个可执行的程序组成：c...
cmake -- 笔记
tianyu的专栏 - Linux site:blog.csdn.net/wishfly
07-15 1533
cmake
Cmake的使用 (一)
RGBMarco的博客
05-07 300
如果不想用IDE构建项目,cmake和qmake是最好构建项目工具,接下来我会通过一系列的练习和大家一起学习cmake Test 1: 一般项目分为内部构建和外部构建,内部构建会将构建中间文件放在项目中,这使得我们重新构建时,清理中间文件非常麻烦,外部构建是将中间文件存放在特定目录中,使得中间文件不与项目文件弄混，且一般便于清理,第一个练习我采用内部构建的方式,来熟悉cmake的语法 首先创...
【cmake】如何使用cmake生成构建项目vcxproj
最新发布
Michael
07-18 1219
您也可以使用其他版本的 Visual Studio，只需将 “Visual Studio 15 2017” 替换为您要使用的版本。这将使用 Visual Studio 2017 生成项目文件，并将其保存在当前目录中。其中，-T 参数指定使用的工具集版本，-A 参数指定目标平台。生成项目文件后，您可以在 Visual Studio 中打开它，并使用 Visual Studio 构建和运行您的项目。
cmocka的学习(2)
github_19061021的博客
08-11 857
cmocka的学习(2)-配置头文件config.h生成脚本 目录cmocka的学习(2)-配置头文件config.h生成脚本重点函数说明check_include_file(file.ext VAR)check_function_exists(calloc HAVE_CALLOC)check_symbol_exists(snprintf stdio.h HAVE_SNPRINTF)cmocka源码 重点函数说明 check_include_file(file.h VAR) check_function_
CMake(2)-详解-编译-安装-支持GDB-添加环境检查-添加版本号-生成安装包
aggie4628的专栏
04-28 1751
它首先允许开发者编写一种平台无关的 CMakeList.txt 文件来定制整个编译流程，然后再根据目标用户的平台进一步生成所需的本地化 Makefile 和工程文件。1.1编译流程a) 最简单 demo1CMakeLists.txt 文件，并保存在与源文件同个目录下demo1# cmake 最低版本号要求#项目信息#指定生成目标# 多文件# 查找当前目录下的所有源文件# 并将名称保存到 DIR_SRCS 变量# 指定生成目标b) 常用demo2。
vs编译linux内核,VS2008项目移植到Linux
weixin_34394265的博客
04-30 296
不少人都遇到过这种情况:在Windows下用Visual Studio工具开发的程序需要移植到Linux系统中,做成Linux版本的,但程序比较大,在Linux上又离不开Make,手动编写Makefile文件的工作量又太大.在这里提供一种方法仅供参考.由于VS的解决方案文件“*.sln”和项目文件“*.vcproj”文件中保存了源代码的依赖关系和编译信息,只要把它转换成Makefile文件就行了,...
CMake——入门到精通.pdf
04-20
在内容描述中，“cmake入门到精通，cmake练习，实践”强调了这是一份面向实战的教程，不仅仅关注理论知识的灌输，更加重视通过实际操作来加深理解。文档中提到，作者在学习CMake的过程中发现了官方文档的不足，并...
CMake入门学习+实战<一>
enaxM的博客
06-26 754
文章整合自： CMake Practice http://sewm.pku.edu.cn/src/paradise/reference/CMake%20Practice.pdf CMake 官方文档 https://cmake.org/cmake/help/latest/ 以及其他网络资料 目标： 代码移植 静动态库编译调用 文章为CMake Practice的笔记以及一
Cmake从入门到精通（pdf教程）
04-28
本文档是边学习边编写的成果，更像是一个学习笔记和Tutorial，因此难免有失误或者理解不够透彻的地 方，比如，我仍然不能理解为什么绝大部分使用变量的情况要通过${}引用，而在IF语句中却必须直接 使用变量名。...
sln2mak_bin.zip
03-30
vs工程移植到linuxvs工程移植到linuxvs工程移植到linuxvs工程移植到linuxvs工程移植到linux
CMake常用命令（二） project命令
qq_26849933的博客
09-04 2720
project命令用于指定cmake工程的名称，实际上，它还可以指定cmake工程的版本号（VERSION关键字）、简短的描述（DESCRIPTION关键字）、主页URL（HOMEPAGE_URL关键字）和编译工程使用的语言（LANGUAGES关键字）。该选项可以有两种调用方式：一种是直接跟在工程名后面，可以省略LANGUAGES关键字；另一种是跟在其他关键字（例如VERSION）后面，LANGUAGES关键字不能省略。假设当前系统的cmake版本为3.10.2。除示例1 中的变量更改外，还会更改。
Visual Studio 2022+Cmake+VTK
weixin_39383160的博客
07-24 2609
Visual Studio 2022; Cmake; VTK
Visual Studio 现已支持 CMake
weixin_34348111的博客
06-02 1217
Visual C++ 团队在他们的官方博客上宣布 Visual Studio 现已支持 CMake。 什么是CMake？ CMake 是一个跨平台的开源工具，通过抽象本地构建环境和编译器以管理建立跨多平台程序。CMake解析一个CMake脚本，作者在一个选择好的构建环境中创造并生成一个构建计划。（例如在Visual studio 项目, make 脚本,...
VS跨平台编译-根据vcxproj生成cmake文件
The Coding World
11-26 4346
# -*- coding: UTF-8 -*- # 根据vcxproj生成cmake文件，便于linux下程序编译 import os import sys import xml.etree.ElementTree as ET import codecs import re class cmake_tool(object): def __init__(self): ...
CMake 入门实战
pegasusliuyong的专栏
07-16 156
CMake 入门实战
Cmake详解
zdaiot的博客
10-15 1443
什么是 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 工具遵循着...
【转】CMAKE 初步
weixin_30575309的博客
04-22 169
如果你觉得makefile看着就头痛，如果当工程越来越大，你越来越手足无措，如果你厌倦了在编译的时候打上一大堆命令，那么你有必要花十分钟来看一下下面的内容。 一、HelloWorld 首先创建一个test1文件夹，里面创建一个main.c文件，内容如下： #include <stdio.h>int main(){printf("Hello World!\n");return ...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值