CMake中configure_file的使用
创始人
2024-04-13 13:16:12

      CMake中的configure_file命令用于将一个文件拷贝到另一个位置并修改其内容,其格式如下:

configure_file( [NO_SOURCE_PERMISSIONS | USE_SOURCE_PERMISSIONS |FILE_PERMISSIONS ...][COPYONLY] [ESCAPE_QUOTES] [@ONLY][NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])

      将文件拷贝到文件,并在输入文件内容中替换@VAR@或${VAR}变量值。每个变量引用将被替换为变量的当前值,如果未定义该变量则替换为空字符串。
      在#cmakedefine01 VAR形式的行中,VAR本身将扩展为VAR 0 或 VAR 1,如果定义了VAR,将被替换为:#define VAR 1
      如果输入文件被修改,构建系统(build system)将重新运行CMake来重新配置文件并再次生成构建系统。只有当生成的文件内容发生改变时,生成的文件才会被修改,并在后续的cmake运行中更新它的时间戳。
      参数:
      (1).:输入文件的路径。相对路径是根据CMAKE_CURRENT_SOURCE_DIR的值来处理的。输入路径必须是文件,而不能是目录。
      (2).:输出文件或目录的路径。相对路径是根据CMAKE_CURRENT_SOURCE_DIR的值来处理的。如果路径命名为一个已存在的目录,则输出文件将存放在该目录中,文件名与输入文件相同。如果路径中包含不存在的目录,则会创建它们。
      (3).NO_SOURCE_PERMISSIONS:不要将输入文件的权限转移到输出文件中。拷贝的文件权限默认为标准的644(-rw-r--r--)。
      (4).USE_SOURCE_PERMISSIONS:将输入文件的权限转移到输出文件中。如果没有给出与权限相关的三个关键字(NO_SOURCE_PERMISSIONS, USE_SOURCE_PERMISSIONS or FILE_PERMISSIONS),这已经是默认行为。
      (5).FILE_PERMISSIONS:忽略输入文件的权限并使用指定的作为输出文件的权限。
      (6).COPYONLY:拷贝文件,但不替换任何变量引用或其它内容。此选项不能与NEWLINE_STYLE一起使用。
      (7).ESCAPE_QUOTES:用反斜杠(backslashes)转义任何替换的引号(C风格)。
      (8).@ONLY:将变量替换限制为@VAR@形式的引用。这对于配置使用${VAR}语法的脚本很有用。
      (9).NEWLINE_STYLE:指定输出文件的换行样式。为\n换行符指定UNIX或LF,或者为\r\n换行符指定DOS, WIN32, or CRLF。此选项不能用于COPYONLY。

      执行上述测试代码需要4个文件:build.sh, CMakeLists.txt, test_configure_file.cmake, include/foo.h.in

      build.sh内容如下:

#! /bin/bash# supported input parameters(cmake commands)
params=(function macro cmake_parse_arguments \find_library find_path find_file find_program find_package \cmake_policy cmake_minimum_required project include \string list set foreach message option if while return \math file configure_file \include_directories)usage()
{echo "Error: $0 needs to have an input parameter"echo "supported input parameters:"for param in ${params[@]}; doecho "  $0 ${param}"doneexit -1
}if [ $# != 1 ]; thenusage
fiflag=0
for param in ${params[@]}; doif [ $1 == ${param} ]; thenflag=1breakfi
doneif [ ${flag} == 0 ]; thenecho "Error: parameter \"$1\" is not supported"usageexit -1
fiif [[ ! -d "build" ]]; thenmkdir buildcd build
elsecd build
fiecho "==== test $1 ===="# test_set.cmake: cmake -DTEST_CMAKE_FEATURE=$1 --log-level=verbose ..
# test_option.cmake: cmake -DTEST_CMAKE_FEATURE=$1 -DBUILD_PYTORCH=ON ..
cmake -DTEST_CMAKE_FEATURE=$1 ..
# It can be executed directly on the terminal, no need to execute build.sh, for example: cmake -P test_set.cmake
make

      CMakeLists.txt内容如下:

cmake_minimum_required(VERSION 3.22)
project(cmake_feature_usage)message("#### current cmake version: ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}.${CMAKE_PATCH_VERSION}")
include(test_${TEST_CMAKE_FEATURE}.cmake)
message("==== test finish ====")

      test_configure_file.cmake内容如下:

message("#### test_${TEST_CMAKE_FEATURE}.cmake ####")set(FLAG 2 CACHE STRING "Values that can be specified: [1, 2]" FORCE) # 设置FLAG,用来指定测试哪个代码段message("CMAKE_CURRENT_SOURCE_DIR: ${CMAKE_CURRENT_SOURCE_DIR}")
message("CMAKE_CURRENT_BINARY_DIR: ${CMAKE_CURRENT_BINARY_DIR}")if(${FLAG} STREQUAL "1")# 注意:FOO_ENABLE的值会写入CMakeCache.txtoption(FOO_ENABLE "Enable Foo" ON)if(FOO_ENABLE)set(FOO_STRING "foo")endif()set(VAR 1)configure_file(include/foo.h.in foo.h @ONLY) # 生成的foo.h在build目录下# foo.h内容:# #define FOO_ENABLE# #define FOO_STRING "foo"# #define VAR 1
elseif(${FLAG} STREQUAL "2")option(FOO_ENABLE "Enable Foo" OFF)if(FOO_ENABLE)set(FOO_STRING "foo")endif()set(VAR 0)if(DEFINED VAR)message("defined VAR") # printendif()configure_file(include/foo.h.in foo.h @ONLY) # 生成的foo.h在build目录下# foo.h内容:# /* #undef FOO_ENABLE */# /* #undef FOO_STRING */# #define VAR 0
endif()

      include/foo.h.in内容如下:

#cmakedefine FOO_ENABLE
#cmakedefine FOO_STRING "@FOO_STRING@"#cmakedefine01 VAR

      可能的执行结果如下图所示:

      GitHub:https://github.com/fengbingchun/Linux_Code_Test

相关内容

热门资讯

埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
长白山自助游攻略 吉林长白山游... 昨天介绍了西坡的景点详细请看链接:一个人的旅行,据说能看到长白山天池全凭运气,您的运气如何?今日介绍...
应用未安装解决办法 平板应用未... ---IT小技术,每天Get一个小技能!一、前言描述苹果IPad2居然不能安装怎么办?与此IPad不...
脚上的穴位图 脚面经络图对应的... 人体穴位作用图解大全更清晰直观的标注了各个人体穴位的作用,包括头部穴位图、胸部穴位图、背部穴位图、胳...
猫咪吃了塑料袋怎么办 猫咪误食... 你知道吗?塑料袋放久了会长猫哦!要说猫咪对塑料袋的喜爱程度完完全全可以媲美纸箱家里只要一有塑料袋的响...
demo什么意思 demo版本... 618快到了,各位的小金库大概也在准备开闸放水了吧。没有小金库的,也该向老婆撒娇卖萌服个软了,一切只...
世界上最漂亮的人 世界上最漂亮... 此前在某网上,选出了全球265万颜值姣好的女性。从这些数量庞大的女性群体中,人们投票选出了心目中最美...
埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
长白山自助游攻略 吉林长白山游... 昨天介绍了西坡的景点详细请看链接:一个人的旅行,据说能看到长白山天池全凭运气,您的运气如何?今日介绍...
世界上最漂亮的人 世界上最漂亮... 此前在某网上,选出了全球265万颜值姣好的女性。从这些数量庞大的女性群体中,人们投票选出了心目中最美...
应用未安装解决办法 平板应用未... ---IT小技术,每天Get一个小技能!一、前言描述苹果IPad2居然不能安装怎么办?与此IPad不...
脚上的穴位图 脚面经络图对应的... 人体穴位作用图解大全更清晰直观的标注了各个人体穴位的作用,包括头部穴位图、胸部穴位图、背部穴位图、胳...
demo什么意思 demo版本... 618快到了,各位的小金库大概也在准备开闸放水了吧。没有小金库的,也该向老婆撒娇卖萌服个软了,一切只...
猫咪吃了塑料袋怎么办 猫咪误食... 你知道吗?塑料袋放久了会长猫哦!要说猫咪对塑料袋的喜爱程度完完全全可以媲美纸箱家里只要一有塑料袋的响...