configure_file简介

configure_file 将文件复制到另一个位置并修改其内容。该命令将<input>文件复制到<output>文件，并根据指定规则对其内容进行转换。

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为输出文件。通常，输入文件为 xxx-config.h.in，输出文件为xxx-config.h。
@ONLY 指定在<input>文件中只使用@VAR@的方式获取变量值，而不用${VAR}。如果CMake没用定义该遍历，则替换为空字符串。

示例

需要准备2个文件：config.h.in（input），CMakeLists.txt（与input在同一目录）。output是自动生成的。

config.h.in

#cmakedefine var1
#cmakedefine var2 "@var2" #注意：@@之间的名称要与cmakedefine后变量名一样
#cmakedefine var3 "${var3}"  # 注意：${}之间的名称要与cmakedefine后的变量名一样
#ifndef _@var4@_${var5}_
#define _@var4@_${var5}_
#endif

CMakeLists.txt

cmake_mininum_required(VERSION 2.8)
project (configure_file_test)
option (var1 "use var1..." ON)  #定义var1，也可以使用cmake -Dvar1=ON替代
set (var2 13) #指定var2的值
set (var3 "var3string") #指定var3的值
set (var4 "VARTEST4")
set (var5 "VARTEST5")

configure_file (config.h.in config.h)

执行cmake命令“cmake .”后，自动生成config.h文件

#define var1
#define var2 "13"
#define var3 "var3string"
#ifndef _VARTEST4_VARTEST5_
#define _VARTEST4_VARTEST5_
#endif

其他细节

参数详解

input 输入文件的路径，是一个相对路径，以CMAKE_CURRENT_SOURCE_DIR为路径前缀。而且，它必须是一个文件，不能是目录。

output 输出文件或目录，也是一个相对路径，以 CMAKE_CURRENT_SOURCE_DIR为前缀。如果output的名称与已经存在的目录名相同，就会在该目录下生成一个与input文件名相同的文件。e.g. 如果input文件名“inputfile”，output是一个目录“currentdir”（已经存在），那么生成的文件路径为“currentdir/inputfile”。

options 参数选项

1）COPYONLY 简单把input文件拷贝到output，不做任何替换。该选项与NEWLINE_STYLE冲突，不能同时使用。

2）ESCAPE_QUATES 忽略反斜杠（C语言风格）的转义。
e.g. 不加ESCAPE_QUATES，默认会对反斜杠进行转义：

config.h.in文件：
#define @var@

CMakeLists.txt文件：
set (var "\"VAR\"")
configure_file(config.h.in config.h)

生成的config.h文件：
#define "VAR"

加ESCAPE_QUATES，不对反斜杠进行转义：

config.h.in文件：
#define @var@

CMakeLists.txt文件：
set(var "\"VAR\"")
configure_file(config.h.in config.h ESCAPE_QUATES)

生成的config.h文件：
#define \"VAR\"

3）@ONLY
只替换input文件中的@var，不替换\({var}。\){var}在脚本语言中有语义含义（替换会导致含义变化），因此在处理这类文件时很有用。

4）NEWLINE_STYLE
指定output文件的换行风格，如linux以\n（LF）作为换行，windows以\r\n（CRLF）作为换行。该参数后腰指明换行的规则，如UNIX|DOS|WIN32|LF|CRLF。

cmakedefine命令

#cmakedefine var
#cmakedefine var1 10

如果var后面没用跟着值，生成效果为“#define var”；如果跟着值，生成效果为“#define var1 10”

cmakedefine01命令

#cmakedefine01 var

如果var有定义，生成效果为“#define var 1”；如果未定义，生成效果为“#define var 0”。

其他注意事项

1）对于input中的“#cmakedefine var @var@”或“#cmakedefine var \({var}”，@@之间或\){}内变量名要与cmakedefine命令后变量名一样，否则替换不成功。

2）configure_file 要放在变量定义后（OPTION定义的变量可以在configure_file之后）。

参考

https://www.jianshu.com/p/2946eeec2489
https://cmake.org/cmake/help/latest/command/configure_file.html