configure_file¶
复制文件到另一个位置并修改其内容。
configure_file(<input> <output>
[NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS |
FILE_PERMISSIONS <permissions>...]
[COPYONLY] [ESCAPE_QUOTES] [@ONLY]
[NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF]])
复制 <input> 文件到 <output> 文件，同时对输入文件内容执行转换。
如果输入文件被修改，构建系统将重新运行 CMake 以重新配置文件并再次生成构建系统。只有当生成文件的内容发生更改时，才会在后续的 cmake 运行时修改生成文件并更新其时间戳。
选项¶
选项包括：
<input>输入文件的路径。相对路径相对于
CMAKE_CURRENT_SOURCE_DIR的值处理。输入路径必须是文件，而不是目录。<output>输出文件或目录的路径。相对路径相对于
CMAKE_CURRENT_BINARY_DIR的值处理。如果路径指定一个现有目录，则输出文件将放置在该目录中，文件名与输入文件相同。如果路径包含不存在的目录，则会创建这些目录。NO_SOURCE_PERMISSIONS在版本 3.19 中添加。
不要将输入文件的权限转移到输出文件。复制文件的权限默认为标准的 644 值 (-rw-r--r--)。
USE_SOURCE_PERMISSIONS在版本 3.20 中添加。
将输入文件的权限转移到输出文件。如果未给出三个与权限相关的关键字（
NO_SOURCE_PERMISSIONS、USE_SOURCE_PERMISSIONS或FILE_PERMISSIONS），这已经是默认行为。USE_SOURCE_PERMISSIONS关键字主要用于使调用站点的预期行为更清晰。FILE_PERMISSIONS <permissions>...在版本 3.20 中添加。
忽略输入文件的权限，并为输出文件使用指定的
<permissions>。COPYONLY复制文件，不替换任何变量引用或其他内容。此选项不能与
NEWLINE_STYLE一起使用。ESCAPE_QUOTES使用反斜杠（C 风格）转义任何替换的引号。
@ONLY将变量替换限制为
@VAR@形式的引用。这对于配置使用${VAR}语法的脚本很有用。NEWLINE_STYLE <style>指定输出文件的换行符样式。指定
UNIX或LF表示\n换行符，或指定DOS、WIN32或CRLF表示\r\n换行符。此选项不能与COPYONLY一起使用。
转换¶
在输入文件内容中引用的变量，如 @VAR@、${VAR}、$CACHE{VAR}，以及作为 $ENV{VAR} 引用的环境变量，都将被替换为变量的当前值，如果变量未定义，则替换为空字符串。此外，以下形式的输入行
#cmakedefine VAR ...
将被替换为
#define VAR ...
或
/* #undef VAR */
取决于 VAR 是否在 CMake 中设置为 if() 命令认为不是 false 常量的任何值。“...” 变量名后面的行上的内容（如果有）将按上述方式处理。
与 #cmakedefine VAR ... 形式的行不同，在 #cmakedefine01 VAR 形式的行中，VAR 本身将展开为 VAR 0 或 VAR 1，而不是被赋值为 ...。
#cmakedefine01 VAR
将被替换为
#define VAR 0
或
#define VAR 1
#cmakedefine01 VAR ... 形式的输入行将展开为 #cmakedefine01 VAR ... 0 或 #cmakedefine01 VAR ... 1，这可能会导致未定义的行为。
在版本 3.10 中添加: 结果行（除了 #undef 注释）可以使用空格和/或制表符在 # 字符与 cmakedefine 或 cmakedefine01 单词之间缩进。此空白缩进将保留在输出行中
# cmakedefine VAR
# cmakedefine01 VAR
如果定义了 VAR，将被替换为
# define VAR
# define VAR 1
示例¶
考虑一个包含 foo.h.in 文件的源树
#cmakedefine FOO_ENABLE
#cmakedefine FOO_STRING "@FOO_STRING@"
相邻的 CMakeLists.txt 可以使用 configure_file 来配置头文件
option(FOO_ENABLE "Enable Foo" ON)
if(FOO_ENABLE)
set(FOO_STRING "foo")
endif()
configure_file(foo.h.in foo.h @ONLY)
这将在与此源目录对应的构建目录中创建一个 foo.h。如果 FOO_ENABLE 选项为 on，则配置的文件将包含
#define FOO_ENABLE
#define FOO_STRING "foo"
否则它将包含
/* #undef FOO_ENABLE */
/* #undef FOO_STRING */
然后可以使用 target_include_directories() 命令将输出目录指定为包含目录
target_include_directories(<target> [SYSTEM] <INTERFACE|PUBLIC|PRIVATE> "${CMAKE_CURRENT_BINARY_DIR}")
以便源文件可以将头文件包含为 #include <foo.h>。