6.4 记录项目版本信息以便报告

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

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

    将使用以下C文件()打印版本信息:

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

    1. #pragma once
    3. #define PROJECT_VERSION_MAJOR @PROJECT_VERSION_MAJOR@
    4. #define PROJECT_VERSION_MINOR @PROJECT_VERSION_MINOR@
    5. #define PROJECT_VERSION_PATCH @PROJECT_VERSION_PATCH@
    6. #define PROJECT_VERSION "v@PROJECT_VERSION@"

    我们将按照以下步骤，在模板头文件中对版本进行注册:

    1. 要跟踪代码版本，我们可以在CMakeLists.txt中调用CMake的project时定义项目版本:

    2. 然后，基于version.h.in生成version.h:

      1. configure_file(
      2.   version.h.in
      3.   generated/version.h
      4.   @ONLY
      5.   )

    3. 最后，我们定义了可执行文件，并提供了目标包含路径:

    生成的头文件可以包含在示例代码中，可以打印版本信息:

    1. $ cd build
    2. $ cmake ..
    3. $ cmake --build .
    4. $ ./example
    6. This is output from code v2.0.1
    7. Major version number: 2
    8. Minor version number: 0
    9. Hello CMake world!

    NOTE:CMake以x.y.z格式给出的版本号，并将变量和<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。