CMake 笔记 | [28] 记录项目版本信息以便报告

2024-01-31 2024-01-31 约 1406 字预计阅读 3 分钟 - 次阅读

注意

本文最后更新于 2024-01-31，文中内容可能已过时。

一、导言

导言

代码版本很重要，不仅是为了可重复性，还为了记录API功能或简化支持请求和bug报告。源代码通常处于某种版本控制之下，例如可以使用Git标记附加额外版本号。然而，不仅需要对源代码进行版本控制，而且可执行文件还需要记录项目版本，以便将其打印到代码输出或用户界面上。

本篇，将在CMake源文件中定义版本号。我们的目标是在配置项目时将程序版本记录到头文件中。然后，生成的头文件可以包含在代码的正确位置和时间，以便将代码版本打印到输出文件或屏幕上。

二、项目结构

1
2
3
4
.
├── CMakeLists.txt
├── version.h.in
└── example.cpp

项目地址：

https://gitee.com/jiangli01/tutorials/tree/master/cmake-tutorial/chapter6/02

三、相关源码

example.cpp

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#include "version.h"

#include <iostream>

int main() {
  std::cout << "This is output from code " << PROJECT_VERSION << std::endl;
  std::cout << "Major version number: " << PROJECT_VERSION_MAJOR << std::endl;
  std::cout << "Minor version number: " << PROJECT_VERSION_MINOR << std::endl;

  std::cout << "Hello CMake world!" << std::endl;
}

这里，假设PROJECT_VERSION_MAJOR、PROJECT_VERSION_MINOR和PROJECT_VERSION是在version.h中定义的。目标是从以下模板中生成version.h.in:

version.h.in

1
2
3
4
5
6
#pragma once

#define PROJECT_VERSION_MAJOR @PROJECT_VERSION_MAJOR@
#define PROJECT_VERSION_MINOR @PROJECT_VERSION_MINOR@
#define PROJECT_VERSION_PATCH @PROJECT_VERSION_PATCH@
#define PROJECT_VERSION "v@PROJECT_VERSION@"

这里使用预处理器定义，也可以使用字符串或整数常量来提高类型安全性。

CMakeLists.txt

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
cmake_minimum_required(VERSION 3.10 FATAL_ERROR)

project(example VERSION 2.0.1 LANGUAGES CXX)

configure_file(
  version.h.in
  generated/version.h
  @ONLY
)

add_executable(${PROJECT_NAME} example.cpp)
target_include_directories(${PROJECT_NAME}
  PRIVATE
      ${CMAKE_CURRENT_BINARY_DIR}/generated
)

当使用版本参数调用CMake的project时，CMake将为项目设置PROJECT_VERSION_MAJOR、PROJECT_VERSION_MINOR和PROJECT_VERSION_PATCH。

configure_file接受一个输入文件(本例中是version.h.in)，通过将@之间的占位符替换成对应的CMake变量，生成一个输出文件(本例中是generate/version.h)。它将@PROJECT_VERSION_MAJOR@替换为2，以此类推。使用关键字@ONLY，我们将configure_file限制为只替换@variables@，而不修改${variables}。

四、结果

1
2
3
4
5
6
7
8
9
mkdir build & cd build
cmake ..
cmake --build .
./example

This is output from code v2.0.1
Major version number: 2
Minor version number: 0
Hello CMake world!

生成版本信息

1
2
3
4
5
6
#pragma once

#define PROJECT_VERSION_MAJOR 2
#define PROJECT_VERSION_MINOR 0
#define PROJECT_VERSION_PATCH 1
#define PROJECT_VERSION "v2.0.1"

五、补充内容

CMake以x.y.z格式给出的版本号，并将变量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),将分别设置为X, Y, Z和t。

为了确保只有当CMake变量被认为是一个真正的常量时，才定义预处理器变量，可以使用configure_file，在配置的头文件中使用#cmakedefin而不是#define。

根据是否定义了CMake变量并将其计算为一个真正的常量，#cmakedefine YOUR_VARIABLE将被替换为#define YOUR_VARIABLE …或者/* #undef YOUR_VARIABLE */。还有#cmakedefine01，将根据变量是否定义，将变量设置为0或1。

Buy me a coffee~

赞赏

支付宝

微信