cmake Tutorial 摘要(1) Step1-6

最新推荐文章于 2023-10-19 22:35:44 发布
最新推荐文章于 2023-10-19 22:35:44 发布
阅读量192 收藏 1
点赞数
分类专栏： C++
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/irving512/article/details/108362861
版权

文章目录

0. 前言

Step 1 - A Basic Starting Point

1.1. 基本功能

  • cmake 的基本功能就是三个命令，下面简单介绍。
  • cmake_minimum_required(VERSION 3.10)
  • project(Tutorial)
    • 作用：提供项目名称、版本、使用编译语言等信息
    • 官方文档
project(<PROJECT-NAME>
        [VERSION <major>[.<minor>[.<patch>[.<tweak>]]]]
        [DESCRIPTION <project-description-string>]
        [HOMEPAGE_URL <url-string>]
        [LANGUAGES <language-name>...])
  • add_executable(Toturial tutorial.cxx) 
add_executable(<name> [WIN32] [MACOSX_BUNDLE]
               [EXCLUDE_FROM_ALL]
               [source1] [source2 ...])

1.2. 添加版本号

  • 设置版本好就是在 project 命中中指定 VERSION。
  • 值得一提的是，在设置过VERSION属性后，几个cmake变量会自动定义：
    • PROJECT_VERSION, <PROJECT-NAME>_VERSION
    • PROJECT_VERSION_MAJOR, <PROJECT-NAME>_VERSION_MAJOR
    • PROJECT_VERSION_MINOR, <PROJECT-NAME>_VERSION_MINOR
    • PROJECT_VERSION_PATCH, <PROJECT-NAME>_VERSION_PATCH
    • PROJECT_VERSION_TWEAK, <PROJECT-NAME>_VERSION_TWEAK.
  • 之后，可通过 configure_file 命令，将版本号写入对应的头文件中。具体方法分为三步
    • 第一步：定义模版文件，即本例中的 TutorialConfig.h.in，如下。
    • 第二步：通过 configure_file(TutorialConfig.h.in TutorialConfig.h) 将模版中的参数转换为 PROJECT 命令中的VERSION。
      • configure_file 的功能就是将模版文件所有 @VAR@ 转换为cmake参数 ${VAR}
      • 下面源码中的 @Tutorial_VERSION_MAJOR@ 就是之前cmake自动定义的变量。
    • 第三步：将生成的 TutorialConfig.h 添加到项目中，即target_include_directories(Tutorial PUBLIC "${PROJECT_BINARY_DIR}")
      • target_include_directories：将头文件目录添加到一个target中
// the configured options and settings for Tutorial
#define Tutorial_VERSION_MAJOR @Tutorial_VERSION_MAJOR@
#define Tutorial_VERSION_MINOR @Tutorial_VERSION_MINOR@

1.3. 设置C++标准

  • 设置C++版本的本质就是指定若干cmake参数
    • CMAKE_CXX_STANDARD & CMAKE_CXX_STANDARD_REQUIRED
# specify the C++ standard
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED True)

Step 2 - Adding a Library

2.1. 基本功能

  • 目标：添加第三方库。
    • 这个第三方库指的是源码（需要编译），而不是动态库、静态库。
  • 基本流程：
    • 第一步：准备好第三方库的源码，并在第三方项目中建立 CMakeLists.txt。
      • CMakeLists.txt文件中添加 add_library() 指令。
    • 第二步：在原始项目 CMakeLists.txt 文件中关联第三方项目以及添加头文件。
  • 项目根目录的 CMakeLists.txt 中添加依赖有以下几个内容
    • 通过 add_subdirectory 添加第三方库路径，这样才会编译、构建第三方项目。
    • 通过 target_link_libraries 添加库的名称。这个名称就是在第三方库的add_library中定义的。
    • 通过 target_include_directories 添加第三方库的头文件。

2.2. 其他功能

  • 本例中实现了一些其他功能：
    • 有两个版本的sqrt实现，一个是C++标准库，一个是我们自己实现的第三方库。
    • 在CMake中采用了一个option来指定sqrt的来源。
  • 为了实现这个功能，需要在 CMakeLists.txt 文件以及C++源码进行一些修改。
  • CMakeLists.txt 文件中
# 添加选项，用来选择是否使用自定义第三方库
option(USE_MYMATH "Use tutorial provided math implementation" ON)

# 通过条件语句，选择是否将第三方库添加到项目中
if(USE_MYMATH)
  add_subdirectory(MathFunctions) 
  list(APPEND EXTRA_LIBS MathFunctions)
  list(APPEND EXTRA_INCLUDES "${PROJECT_SOURCE_DIR}/MathFunctions")
endif()
  • C++ 源码中，使用 #ifdef USE_MYMATH #endif 来指定使用的第三方库。

Step 3 - Adding Usage Requirements for Library

  • Usage requirements
    • 不知道该怎么翻译。直译就是“使用要求”。
    • 看后面的内容，大概意思就是在为target添加各类内容（如头文件、libs）的同时，做一些其他工作。
  • 主要影响的命令有：
    • target_compile_definitions()
    • target_compile_options()
    • target_include_directories()
    • target_link_libraries()
  • 下面举个例子：
    • 一个假设：对于所有要添加的libs，都要添加对应的头文件所在路径。
    • 上一个sample中存在的问题：需要分别手动添加libs与头文件目录。
    • 修改第三方库的CMakeLists.txt文件
      • 通过INTERFACE，为第三方库的target指定头文件。
target_include_directories(MathFunctions
          INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}
          )

Step 4 - Installing and Testing

  • 功能：添加 install 以及 test 相关内容

4.1. install

  • 本质就是将文件复制/移动到目标位置。
  • 本例中就是将动态库so文件与头文件移动到对应的 lib 以及 include 文件夹中
    • install 命令官方文档
    • 实现的功能：
      • 将第三方库中的so文件放到lib目录下，头文件放到include目录下。
      • 将根目录中头文件放到include目录下，可执行文件放到bin目录下。
    • 其中，DESTINATION 指定的 lib/include/bin 目录，如果是绝对路径则直接使用，如果是相对路径则要与 CMAKE_INSTALL_PREFIX 配合使用。
# 第三方库，末尾添加
install(TARGETS MathFunctions DESTINATION lib)
install(FILES MathFunctions.h DESTINATION include)

# 根目录，末尾添加
install(TARGETS Tutorial DESTINATION bin)
install(FILES "${PROJECT_BINARY_DIR}/TutorialConfig.h"
  DESTINATION include
  )

4.2. Testing

  • 简单说，就是测试构建出来的可执行文件。
  • 主要实现方式就是 add_test 命令 
add_test(NAME <name> COMMAND <command> [<arg>...]
         [CONFIGURATIONS <config>...]
         [WORKING_DIRECTORY <dir>]
         [COMMAND_EXPAND_LISTS])
  • 在根目录CMakeLists.txt后添加以下内容
    • 重新构建项目后，可通过 ctest 命令进行测试，如 ctest -N 判断一共有那几个测试，ctest -VV 执行测试并输出过程结果。
    • 下面有的测试是判断程序是否能够正常运行，有的判断输出结果。
enable_testing()

# does the application run
add_test(NAME Runs COMMAND Tutorial 25)

# does the usage message work?
add_test(NAME Usage COMMAND Tutorial)
set_tests_properties(Usage
  PROPERTIES PASS_REGULAR_EXPRESSION "Usage:.*number"
  )

# define a function to simplify adding tests
function(do_test target arg result)
  add_test(NAME Comp${arg} COMMAND ${target} ${arg})
  set_tests_properties(Comp${arg}
    PROPERTIES PASS_REGULAR_EXPRESSION ${result}
    )
endfunction(do_test)

# do a bunch of result based tests
do_test(Tutorial 4 "4 is 2")
do_test(Tutorial 9 "9 is 3")
do_test(Tutorial 5 "5 is 2.236")
do_test(Tutorial 7 "7 is 2.645")
do_test(Tutorial 25 "25 is 5")
do_test(Tutorial -25 "-25 is [-nan|nan|0]")
do_test(Tutorial 0.0001 "0.0001 is 0.01")

Step 5 - Adding System Introspection

  • 目标：根据某些库、函数是否存在进行不同的操作。
    • 例如，如果某库不存在，则到某处加载。

5.1. 基本实现

  • 主要命令：CheckSymbolExists
    • 格式：check_symbol_exists(<symbol> <files> <variable>)
    • 功能：判断symbol在files中是否存在，将结果保存到variable中。
  • CMakeLists.txt 中的修改
# 根目录下添加
# 注意，要放到 add_subdirectory(MathFunctions) 后，configure_file(TutorialConfig.h.in TutorialConfig.h)前
include(CheckSymbolExists)
check_symbol_exists(log "math.h" HAVE_LOG)
check_symbol_exists(exp "math.h" HAVE_EXP)
if(NOT (HAVE_LOG AND HAVE_EXP))
  unset(HAVE_LOG CACHE)
  unset(HAVE_EXP CACHE)
  set(CMAKE_REQUIRED_LIBRARIES "m")
  check_symbol_exists(log "math.h" HAVE_LOG)
  check_symbol_exists(exp "math.h" HAVE_EXP)
  if(HAVE_LOG AND HAVE_EXP)
    target_link_libraries(MathFunctions PRIVATE m)
  endif()
endif()
  • 之后通过 #cmakedefine HAVE_EXP 来定义宏。

5.2. 进阶实现

  • 前一种方法不太方便：
    • 需要通过 #cmakedefine 在头文件中定义宏
    • 需要在原文件中引入头文件
  • 建议使用 target_compile_definitions
    • 作用：为目标添加宏
    • 基本形式如下
target_compile_definitions(<target>
  <INTERFACE|PUBLIC|PRIVATE> [items1...]
  [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...])
  • 本例中的代码如下
# add compile definitions
if(HAVE_LOG AND HAVE_EXP)
  target_compile_definitions(MathFunctions
                             PRIVATE "HAVE_LOG" "HAVE_EXP")
endif()

6. Adding a Custom Command and Generated File

  • 目标：通过自定义命令行生成文件。
  • 实现细节：
    • 编写C++程序生成文件。
    • 通过配置cmake命令，先编译上述c++程序，并通过命令行调用该程序生成文件。
    • 本例中，生成的是一个头文件，所以需要修改cmake将该头文件导入到项目中。
  • 要实现上述功能，主要就是修改第三方库的 CMakeLists.txt。
# 生成命令，并调用该命令生成文件
add_executable(MakeTable MakeTable.cxx)
add_custom_command(
  OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Table.h
  COMMAND MakeTable ${CMAKE_CURRENT_BINARY_DIR}/Table.h
  DEPENDS MakeTable
  )

# 将上述文件导入项目中
add_library(MathFunctions
            mysqrt.cxx
            ${CMAKE_CURRENT_BINARY_DIR}/Table.h
            )
target_include_directories(MathFunctions
          INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}
          PRIVATE ${CMAKE_CURRENT_BINARY_DIR}
          )

add_custom_command(OUTPUT output1 [output2 ...]
                   COMMAND command1 [ARGS] [args1...]
                   [COMMAND command2 [ARGS] [args2...] ...]
                   [MAIN_DEPENDENCY depend]
                   [DEPENDS [depends...]]
                   [BYPRODUCTS [files...]]
                   [IMPLICIT_DEPENDS <lang1> depend1
                                    [<lang2> depend2] ...]
                   [WORKING_DIRECTORY dir]
                   [COMMENT comment]
                   [DEPFILE depfile]
                   [JOB_POOL job_pool]
                   [VERBATIM] [APPEND] [USES_TERMINAL]
                   [COMMAND_EXPAND_LISTS])
清欢守护者
关注
专栏目录
cmake gui安装教程_CMake教程 总
weixin_42525369的博客
01-13 2047
CMake 教程 01介绍这篇CMake教程提供了手把手的指导，涵盖了CMake中大部分构建问题。查看示例项目中的不同主题一起工作非常有用的。这个教程文档和示例可以在CMake提供的源代码的Help/guide/tutorial目录中找到。每个步骤都是包含着代码的子目录构成，可以作为学习的启动步骤。这个教程的例子是循序渐进的，每一步都为前一步提供解决方案。第1步，基础起始点最基础的工程是从源代码构...
cmake gui安装教程_CMake安装使用教程
weixin_42168341的博客
12-23 1828
CMake是一个比make更高级的编译配置工具，它可以根据不同平台、不同的编译器，生成相应的Makefile或者vcproj项目。通过编写CMakeLists.txt，可以控制生成的Makefile，从而控制编译过程。CMake自动生成的Makefile不仅可以通过make命令构建项目生成目标文件，还支持安装(makeinstall)、测试安装的程序是否能正确执行(make test，或者ctes...
CMake：Tutorial-Step1
进击的码力的博客
10-22 198
Step1： A basic Starting Point（基本初步） 0最简单的CMakeLists.txt 在文件夹下编译单个文件，要编译的是tutorial.cxx这个文件。 其中CMakeLists.txt 文件内容如下： cmake_minimum_required(VERSION 3.10) #set the project name and version project(Tutorial) #add the executable add_executable(Tutorial tutor
cmake tutorial
TedOne_LZ的博客
04-15 476
CMake tutorial refer link: https://cmake.org/cmake-tutorial/ 源码地址：https://github.com/pluslin/cmake_tutorial/ 注：每一个version对应一个源码的git分支 CMake tutorial Getting start version 1（simplest）...
CMake 学习笔记（生成头文件）
Ivan 的专栏
07-17 670
1 就是 MAJOR，CMake 会自动生成一个变量 Tutorial_VERSION_MAJOR 存放这个值，0 是MINOR，同理放在 Tutorial_VERSION_MINOR。这句告诉 cmake， 我们要根据 TutorialConfig.h.in 来生成 TutorialConfig.h。一般命名为 config.h。这个文件是 CMake 生成的。生成这个文件我们需要一个模板文件 TutorialConfig.h.in。这个例子是将软件的版本号传入了 TutorialConfig.h。
[CMake Tutorial] Step1总结
weixin_39452975的博客
11-29 78
CMake学习的笔记，包括add_executable()，cmake_minimum_required()，project()，CMAKE_CXX_STANDARD，CMAKE_CXX_STANDARD_REQUIRED，set()，_VERSION_MAJOR，_VERSION_MINOR，configure_file()，target_include_directories()等命令的用法
Ubuntu学习心得——翻译篇——CMake教程（官方文档中文版）
whl970831的博客
07-25 1087
Ubuntu学习心得——翻译篇——CMake官方使用手册 FOR THE SIGMA FOR THE GTINDER FOR THE ROBOMASTER 简介： 该篇以翻译https://cmake.org/cmake-tutorial/ 的官网文档为主，该篇配搭https://blog.csdn.net/whl970831/article/details/97157693教程食用更加美味。 操...
cmake_tutorial_helen
08-14
本教程“cmake_tutorial_helen”将引导你逐步了解如何使用CMake构建你的项目，从基础的Step1到进阶的Step7，涵盖了CMake的基本用法和常见配置。 Step1通常是设置项目的基本信息，包括项目的名称、版本以及源代码...
cmake教程
02-16
方向 在这一点上，我们应该能够执行以下操作来构建和运行Tutorial可执行文件： mkdir step1_build ... cmake ../Step1 . cmake --build . ./Tutorial ./Tutorial 100 或运行/cmake/build_step1.sh
cmake使用教程（一）-起步，flutter开发视频播放器
sa3221sa的博客
01-11 262
这个系列的文章翻译自官方cmake教程：cmake tutorial。 示例程序地址：github.com/rangaofei/t… 不会仅仅停留在官方教程。本人作为一个安卓开发者，实在是没有linux c程序开发经验，望大佬们海涵。教程是在macos下完成，大部分linux我也测试过，有特殊说明的我会标注出来。本教程基于cmake-3.10.2，同时认为你已经安装好cmake。 基本语法 一个最基本的CmakeLists.txt文件最少需要包含以下三行： cmake_minimum_required (V
CMake教程-第 8 步：添加自定义命令和生成文件
最新发布
天使之翼
10-19 1033
CMake 教程提供了一个循序渐进的指南，涵盖了 CMake 可帮助解决的常见构建系统问题。在一个示例项目中了解各个主题是如何协同工作的，会非常有帮助。
cmake-tutorial cmake入门指引
along
08-14 444
转自：https://cmake.org/cmake-tutorial/ 虽然讲解不深，但盛在全面 Below is a step-by-step tutorial covering common build system use cases that CMake helps to address. Many of these topics have been introduced in...
CMake教程－Step5（添加系统自检）
IoT的搬运工！！！
07-30 259
https://cmake.org/cmake/help/latest/guide/tutorial/index.html 添加系统自检（步骤5） 让我们考虑将一些代码添加到我们的项目中，这取决于目标平台可能不具备的功能。 对于此示例，我们将添加一些代码，具体取决于目标平台是否具有log和exp函数。 当然，几乎每个平台都具有这些功能，但对于本教程而言，它们并不常见。 如果平台具有log和exp，那么我们将使用它们来计算mysqrt函数中的平方根。 我们首先使用顶级CMakeLists.txt中的Ch
CMake Tutorial(5)——Adding a Generated File and Generator
六炅的专栏
03-20 400
这一节，我将向你展示如何将一个生成的源文件添加至应用程序的构建过程中。在本次示例，我们会创建一个预计算数值平方根的表（文本文件），将其作为构建过程的一部分，然后将这个表编译到你的应用程序中。为了实现该功能，我需要一个用于生成该表的程序，我们在MathFunctions目录中创建一个MakeTable.cxx文件内容如下：这里写代码片// A simple program that builds a
CMake官方Tutorial中英对照翻译
weixin_34397291的博客
01-08 598
2019独角兽企业重金招聘Python工程师标准>>> ...
CMake教程---添加库（第二课）
sxpsxp12的博客
02-21 793
文章目录自定义库使用自定义库构建可选项总结add_library普通的库导入的库对象库别名库接口库add_subdirectorytarget_link_librariesoption CMake教程版本号：3.16.3 英文原文链接： https://cmake.org/cmake/help/latest/guide/tutorial/index.html#id2 github示例代码...
cmake
fanre的专栏
03-12 145
https://cmake.org/cmake/help/latest/guide/tutorial/index.html ############################################################################################################ # MathFunctions/CMakeLists.txt add_library(MathFunctions mysqrt.cxx)#生成链接库，(链接库名称，
5、添加系统自省
diskman的博客
06-27 110
添加系统自省 让我们考虑向项目中添加一些代码，这些代码取决于目标平台可能不具备的特性。对于本例，我们将添加一些代码，这些代码取决于目标平台是否具有log和exp函数。当然，几乎每个平台都有这些功能，但是对于本教程，假设它们并不常见。 如果平台有log和exp，那么我们将使用它们来计算mysqrt函数中的平方根。我们首先使用MathFunctions/CMakeLists.txt中的CheckSymbolExists模块测试这些函数的可用性。在某些平台上，我们需要链接到m库。如果最初没有找到log和exp，则
CMake教程－Step2（添加库）
IoT的搬运工！！！
07-29 518
https://cmake.org/cmake/help/latest/guide/tutorial/index.html 添加库（步骤2） 现在，我们将向我们的项目添加一个库。 该库将包含我们自己的实现，用于计算数字的平方根。 然后可执行文件可以使用此库而不是编译器提供的标准平方根函数。 在本教程中，我们将库放入名为MathFunctions的子目录中。 该目录已包含头文件MathFunctions.h和源文件mysqrt.cxx。 源文件具有一个称为mysqrt的函数，该函数提供与编译器的sqrt
cmake-3.24.1-linux-x86_64
08-09
cmake-3.24.1-linux-x86_64是一款面向跨平台的开源构建工具，主要用于自动化构建和管理C / C ++项目。它可以根据用户提供的项目源代码生成适于不同操作系统和编译器的构建系统文件，如Makefile或Visual Studio项目文件。 cmake-3.24.1-linux-x86_64版本是适用于Linux操作系统的64位架构的版本。这意味着它可以在支持64位处理器和Linux操作系统的计算机上运行。 使用cmake-3.24.1-linux-x86_64可以帮助开发人员更方便地管理和构建他们的项目。CMake使用简单的命令和语法来描述项目的构建过程，并且可以自动生成相应的构建系统文件。这可以减少手动配置和维护构建过程的工作量。 通过使用cmake-3.24.1-linux-x86_64，开发人员可以实现跨平台的项目构建，无需手动修改构建系统文件。它还提供了一些其他功能，如自动检测系统依赖项、支持测试和安装目标等。 总之，cmake-3.24.1-linux-x86_64是一款强大的构建工具，可帮助开发人员自动化构建和管理他们的C / C ++项目。通过使用cmake，开发人员可以更高效地开发、测试和部署他们的代码。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值