CMakeconfigure_file

configure_file 是 CMake 中的一个命令，用于在构建过程中生成文件。它的主要作用是将一个输入文件（通常是模板文件）复制到输出文件，并在复制过程中替换文件中的变量或表达式。这在配置头文件、脚本文件或其他需要根据构建环境动态生成的文件时非常有用。

基本语法 configure_file(<input> <output> [@ONLY] [ESCAPE_QUOTES] [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF]]) <input>：输入文件的路径，通常是模板文件。<output>：输出文件的路径，生成的文件将放在这个位置。@ONLY：可选参数，表示只替换 @VAR@ 形式的变量，而不替换 ${VAR} 形式的变量。ESCAPE_QUOTES：可选参数，用于转义双引号。NEWLINE_STYLE：可选参数，指定生成文件的换行符风格（如 UNIX 的 LF 或 Windows 的 CRLF）。 示例

假设我们有一个模板文件 config.h.in，内容如下：

#define VERSION "@VERSION@" #define BUILD_TYPE "@BUILD_TYPE@"

我们希望在 CMake 构建过程中生成一个 config.h 文件，并将 @VERSION@ 和 @BUILD_TYPE@ 替换为实际的值。

CMakeLists.txt 文件 cmake_minimum_required(VERSION 3.10) project(MyProject) # 定义变量 set(VERSION "1.0.0") set(BUILD_TYPE "Release") # 使用 configure_file 生成 config.h configure_file(config.h.in config.h @ONLY) 生成的文件 config.h

在构建过程中，CMake 会生成 config.h 文件，内容如下：

#define VERSION "1.0.0" #define BUILD_TYPE "Release" 解释 模板文件：config.h.in 是一个模板文件，其中包含了一些占位符（如 @VERSION@ 和 @BUILD_TYPE@）。CMakeLists.txt：在 CMakeLists.txt 中，我们使用 set 命令定义了 VERSION 和 BUILD_TYPE 变量。然后，通过 configure_file 命令将 config.h.in 复制为 config.h，并替换其中的占位符。生成文件：生成的 config.h 文件中的占位符被替换为实际的值。 其他用法 @ONLY 参数：如果你只想替换 @VAR@ 形式的变量，而不替换 ${VAR} 形式的变量，可以使用 @ONLY 参数。换行符风格：如果你需要指定生成文件的换行符风格，可以使用 NEWLINE_STYLE 参数。 总结

configure_file 是一个非常实用的 CMake 命令，特别适合在构建过程中生成配置文件或头文件。通过定义变量并使用 configure_file，你可以轻松地将模板文件中的占位符替换为实际的值，从而生成所需的文件。

---

当然可以！configure_file 的用法不仅限于简单的变量替换，它还可以结合 CMake 的其他功能实现更高级的用法。以下是一些更深入的用法和技巧：

---

1. 条件替换

你可以在模板文件中使用 CMake 的条件语句（如 #if、#ifdef 等），结合 configure_file 生成动态内容。

示例：根据条件生成不同的代码

CMakeLists.txt

cmake_minimum_required(VERSION 3.10) project(MyProject) # 定义一个布尔变量 option(ENABLE_FEATURE "Enable a special feature" ON) # 使用 configure_file 生成 config.h configure_file(config.h.in config.h @ONLY)

config.h.in

#define VERSION "1.0.0" // 根据 CMake 变量生成条件代码 #if @ENABLE_FEATURE@ #define FEATURE_ENABLED 1 #else #define FEATURE_ENABLED 0 #endif

生成的 config.h 如果 ENABLE_FEATURE 为 ON，生成的 config.h 文件内容如下：

#define VERSION "1.0.0" // 根据 CMake 变量生成条件代码 #if 1 #define FEATURE_ENABLED 1 #else #define FEATURE_ENABLED 0 #endif

如果 ENABLE_FEATURE 为 OFF，生成的 config.h 文件内容如下：

#define VERSION "1.0.0" // 根据 CMake 变量生成条件代码 #if 0 #define FEATURE_ENABLED 1 #else #define FEATURE_ENABLED 0 #endif

---

2. 嵌套变量替换

configure_file 支持嵌套变量替换，即变量值中可以包含其他变量。

示例：嵌套变量

CMakeLists.txt

cmake_minimum_required(VERSION 3.10) project(MyProject) # 定义变量 set(PROJECT_NAME "MyProject") set(VERSION "1.0.0") set(FULL_NAME "${PROJECT_NAME} v${VERSION}") # 使用 configure_file 生成 config.h configure_file(config.h.in config.h @ONLY)

config.h.in

#define PROJECT_FULL_NAME "@FULL_NAME@"

生成的 config.h

#define PROJECT_FULL_NAME "MyProject v1.0.0"

---

3. 生成脚本文件

configure_file 不仅可以生成头文件，还可以生成脚本文件（如 Bash、Python 等），并在其中替换变量。

示例：生成 Bash 脚本

CMakeLists.txt

cmake_minimum_required(VERSION 3.10) project(MyProject) # 定义变量 set(INSTALL_DIR "/usr/local/bin") set(SCRIPT_NAME "my_script.sh") # 使用 configure_file 生成脚本 configure_file(script.sh.in ${SCRIPT_NAME} @ONLY)

script.sh.in

#!/bin/bash echo "Installing to @INSTALL_DIR@" cp my_program @INSTALL_DIR@

生成的 script.sh

#!/bin/bash echo "Installing to /usr/local/bin" cp my_program /usr/local/bin

---

4. 处理复杂表达式

你可以在模板文件中使用 CMake 的表达式或函数生成更复杂的内容。

示例：生成带时间戳的文件

CMakeLists.txt

cmake_minimum_required(VERSION 3.10) project(MyProject) # 获取当前时间 string(TIMESTAMP CURRENT_TIME "%Y-%m-%d %H:%M:%S") # 使用 configure_file 生成文件 configure_file(timestamp.txt.in timestamp.txt @ONLY)

timestamp.txt.in

This file was generated on @CURRENT_TIME@.

生成的 timestamp.txt

This file was generated on 2023-10-05 14:30:45.

---

5. 处理多行内容

如果需要在模板文件中插入多行内容，可以使用 CMake 的 string 命令生成多行字符串，然后将其传递给 configure_file。

示例：生成多行内容

CMakeLists.txt

cmake_minimum_required(VERSION 3.10) project(MyProject) # 定义多行内容 set(MULTILINE_CONTENT "Line 1\nLine 2\nLine 3") # 使用 configure_file 生成文件 configure_file(multiline.txt.in multiline.txt @ONLY)

multiline.txt.in

@MULTILINE_CONTENT@

生成的 multiline.txt

Line 1 Line 2 Line 3

---

6. 自定义生成路径

你可以将生成的文件放到特定的目录中，而不是默认的构建目录。

示例：自定义输出路径

CMakeLists.txt

cmake_minimum_required(VERSION 3.10) project(MyProject) # 定义变量 set(VERSION "1.0.0") # 指定输出路径 set(OUTPUT_DIR "${CMAKE_BINARY_DIR}/generated") file(MAKE_DIRECTORY ${OUTPUT_DIR}) # 使用 configure_file 生成文件 configure_file(config.h.in ${OUTPUT_DIR}/config.h @ONLY)

生成的 config.h 文件会被放到 ${CMAKE_BINARY_DIR}/generated 目录中。

---

7. 处理特殊字符

如果模板文件中包含特殊字符（如 @ 或 ${}），可以通过 ESCAPE_QUOTES 或自定义替换规则来处理。

示例：处理特殊字符

CMakeLists.txt

cmake_minimum_required(VERSION 3.10) project(MyProject) # 定义变量 set(SPECIAL_TEXT "This is a @ symbol and a ${VAR}") # 使用 configure_file 生成文件 configure_file(special.txt.in special.txt ESCAPE_QUOTES)

special.txt.in

Special text: @SPECIAL_TEXT@

生成的 special.txt

Special text: This is a @ symbol and a ${VAR}

---

总结

configure_file 是一个非常强大的工具，可以用于生成各种类型的文件（如头文件、脚本文件、配置文件等）。通过结合 CMake 的变量、条件语句、函数和表达式，你可以实现非常灵活的代码生成逻辑。无论是简单的变量替换，还是复杂的动态内容生成，configure_file 都能胜任。