【CMake】cmake中的include指令（.cmake文件/MACRO宏/function函数）

已于 2022-04-25 14:07:35 修改
阅读量4.8w 收藏 193
点赞数 75
分类专栏： 《开发》Make 文章标签： CMake include .cmake MACRO function
于 2019-10-24 13:51:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_38410730/article/details/102677143
版权

说到cmake，可能最先想到的就是CmakeLists.txt文件，但是在很多情况下，也会看到.cmake文件。也许，你会诧异，.cmake文件是干什么的，甚至会想.cmake文件是不是cmake的正统文件，而CmakeLists.txt并不是。

但其实，CmakeLists.txt才是cmake的正统文件，而.cmake文件是一个模块文件，可以被include到CMakeLists.txt中。


include指令

include指令一般用于语句的复用，也就是说，如果有一些语句需要在很多CMakeLists.txt文件中使用，为避免重复编写，可以将其写在.cmake文件中，然后在需要的CMakeLists.txt文件中进行include操作就行了。

include指令的结构为：

include(<file|module> [OPTIONAL] [RESULT_VARIABLE <var>]
                      [NO_POLICY_SCOPE])

虽然，有不少的可选参数，但是一般情况下，都是直接写：

include(file|module)

注意，为了使CMakeLists.txt能够找到该文件，需要指定文件完整路径(绝对路径或相对路径)，当然如果指定了CMAKE_MODULE_PATH，就可以直接include该目录下的.cmake文件了。

.cmake文件里面通常是什么信息呢？

.cmake文件里包含了一些cmake命令和一些宏/函数，当CMakeLists.txt包含该.cmake文件时，当编译运行时，该.cmake里的一些命令就会在该包含处得到执行，并且在包含以后的地方能够调用该.cmake里的一些宏和函数。

什么是宏？什么是函数？


MACRO宏和function函数

宏和函数的定义

先看一下关键字：cmake的宏是MACRO，函数是function。它们的用法是：

macro(<name> [arg1 [arg2 [arg3 ...]]])
  COMMAND1(ARGS ...)            # 命令语句
  COMMAND2(ARGS ...)
  ...
endmacro()

function(<name> [arg1 [arg2 [arg3 ...]]])
  COMMAND1(ARGS ...)            # 命令语句
  COMMAND2(ARGS ...)
  ...
function()

定义一个名称为name的宏（函数），arg1...是传入的参数。我们除了可以用${arg1}来引用变量以外，系统为我们提供了一些特殊的变量：

变量说明
argv##是一个下标，0指向第一个参数，累加
argv所有的定义时要求传入的参数
argn定义时要求传入的参数以外的参数
argc传入的实际参数的个数，也就是调用函数是传入的参数个数

宏和函数的区别

那么宏和函数之间的区别是什么呢？

其实和C/C++里面宏和函数之间的区别差不多，宏就是字符串替换，函数就是使用变量，在命令中途可以对改变量进行修改。

以StackOverflow的例子来了解一下区别：

首先创建一个CMakeLists.txt：

cmake_minimum_required(VERSION 3.0)
include(test.cmake)

在同目录下创建文件test.cmake：

set(var "ABC")

macro(Moo arg)
  message("arg = ${arg}")
  set(arg "abc")
  message("# After change the value of arg.")
  message("arg = ${arg}")
endmacro()
message("=== Call macro ===")
Moo(${var})

function(Foo arg)
  message("arg = ${arg}")
  set(arg "abc")
  message("# After change the value of arg.")
  message("arg = ${arg}")
endfunction()
message("=== Call function ===")
Foo(${var})

运行cmake：

mkdir build && cd build
cmake ..

运行后的输出结果是：

-- The C compiler identification is GNU 5.4.0
-- The CXX compiler identification is GNU 5.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
=== Call macro ===
arg = ABC
# After change the value of arg.
arg = ABC
=== Call function ===
arg = ABC
# After change the value of arg.
arg = abc
-- Configuring done
-- Generating done
-- Build files have been written to: /home/yngzmiao/test/build

从这里可以看出，宏实现的仅仅是字符串替换，宏定义的过程中是无法进行修改的，而函数却是可以的。

蛋疼的参数

一般情况下，从上面的例子就能看出宏和函数的用法了，但很多情况下，我们自以为的“懂了”都是假懂。比如一不小心，就会出错。

更换test.cmake为下面的内容，并运行：

set(var "ABC")

macro(Moo arg)
  message("arg = ${arg}")
  set(arg "abc")
  message("# After change the value of arg.")
  message("arg = ${arg}")
endmacro()
message("=== Call macro ===")
Moo(var)

function(Foo arg)
  message("arg = ${arg}")
  set(arg "abc")
  message("# After change the value of arg.")
  message("arg = ${arg}")
endfunction()
message("=== Call function ===")
Foo(var)

运行后的输出结果是：

-- The C compiler identification is GNU 5.4.0
-- The CXX compiler identification is GNU 5.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
=== Call macro ===
arg = var
# After change the value of arg.
arg = var
=== Call function ===
arg = var
# After change the value of arg.
arg = abc
-- Configuring done
-- Generating done
-- Build files have been written to: /home/yngzmiao/test/build

对比两段程序可以看出其中的区别：无论是宏还是函数，当调用的时候如果使用的是set出来的变量，都必须通过${}将变量的内容传递进去，而不能只写上变量名。

这是将实参传递给形参时的注意点，但在宏和函数的实现过程中，还有需要注意的内容。

例子：

set(var "ABC")

macro(Moo arg)
  if (arg STREQUAL "ABC")
    message("arg1 = ${arg}")
  endif()
  if (${arg} STREQUAL "ABC")
    message("arg2 = ${arg}")
  endif()
endmacro()
message("=== Call macro ===")
Moo(${var})

function(Foo arg)
  if (arg STREQUAL "ABC")
    message("arg1 = ${arg}")
  endif()
  if (${arg} STREQUAL "ABC")
    message("arg2 = ${arg}")
  endif()
endfunction()
message("=== Call function ===")
Foo(${var})

运行后的输出结果是：

-- The C compiler identification is GNU 5.4.0
-- The CXX compiler identification is GNU 5.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
=== Call macro ===
arg2 = ABC
=== Call function ===
arg1 = ABC
arg2 = ABC
-- Configuring done
-- Generating done
-- Build files have been written to: /home/yngzmiao/test/build

可以看出，在宏和函数的实现过程中，宏的参数由于不是传统意义上的变量，而是字符串替换，因此需要通过${}取出内容。而函数却不一定需要这样。

也就是说，对于macro宏而言：

if(argv0)                         # 错误用法
if(${argv0})                      # 正确用法
if(defined argv0)                 # 错误用法
if(defined ${argv0})              # 正确用法

也就是说，对于宏和函数的参数而言：

  • 当宏和函数调用的时候，如果传递的是经set设置的变量，必须通过${}取出内容；
  • 在宏的定义过程中，对变量进行的操作必须通过${}取出内容，而函数就没有这个必要。

相关阅读

CMake实战–include命令和macro宏
cmake使用教程（八）-macro和function
CMake中include指令用法介绍

CMake学习笔记（三）区分macro与function
liji_digital的博客
04-05 791
因为macro的set(in "2")又定义了一个新的变量in，并赋值2。在执行set(in "2")之前，message("in = "${in})的内容已经被替换成message("in = 1")，所以set(in "2")对后面的语句没有影响，仍然输出1。（事实上，set(in "2")把in当成了一个新的全局变量，后面还会提到）。这也是set(in "2")起作用的原因。可见，test(1)调用时，in = 1,但是set(in "2")随后将in 改为2.所以接下来打印in = 2。
cmake教程5-macro宏定义以及传递参数给源文件
常思考->有目标->重实践->善反思
06-29 2万+
引入在C++程序中我们经常见到如下，两个问题： 1. 输出当前程序的版本号 2. 通过cmake添加macro宏定义 出入到源文件，例如在编译opencv/caffe的时候，我们通过cmake -DUSE_CUDA=ON/OFF来确定,是否使用cuda. 问题cmake中如何实现上述两个功能的呢？ 至于问题1： 我们可能想到直接在头文件中定义，这样也可以，但是如果直接在cm...
CMake从入门到实战系列（十八）—— CMake中的include指令，提高项目的模块化和可重用性
张慕枫的博客
12-19 372
CMake官网中对于include指令的介绍，如下：翻译：从文件或模块加载并运行CMake代码。CMake中的include 指令用于将其他CMake文件或模块包含到当前文件中，并且在当前作用域有效。这条指令会读取所包含文件中的代码，并立即执行这些命令，就好像它们直接写在 include 命令所在的位置一样。
CMake 常用命令和变量_代码文件夹包括include、lib、src
2501_90324309的博客
01-19 597
本文通过一个C++工程实例，介绍了构建过程中用到的一些CMake命令和变量.后面的文章将会讲解如何构建更加复杂的C++工程，会用到CMake里的function和其他命令和变量。
CMake
最新发布
z85123789的博客
03-13 601
CMake简单使用教程
Cmake中include(ExternalProject)的用法
07-03
写CmakeLists.txt时，有时需要include(ExternalProject)，但是Cmake官网教程对此部分没有详细叙述。本人经过辛苦查找，终于找到关于ExternalProject的教程，分享给大家。
【CMake】CMake从入门到实战系列（十八）—— CMake中的include指令，提高项目的模块化和可重用性
【骠姚校尉】的博客
07-31 1683
CMake官网中对于include指令的介绍，如下：翻译：从文件或模块加载并运行CMake代码。CMake中的include 指令用于将其他CMake文件或模块包含到当前文件中，并且在当前作用域有效。这条指令会读取所包含文件中的代码，并立即执行这些命令，就好像它们直接写在 include 命令所在的位置一样。
CMake中include指令介绍
热门推荐
liitdar的博客
07-21 6万+
本文主要介绍CMake中include指令的相关知识。引用CMake官网中对于include指令的介绍，如下：include指令的用法如下：详细描述如下：从上述内容可知，include指令用来载入并运行来自于文件或模块的CMake代码。在这里针对一些具体的问题场景，介绍include指令的具体用法。有时遇到这样一种需求，在使用同一个外层CMakeLists.txt的前提下，每个源码子目录中要求使用的C++标准版本不同，有的源码要求使用C++98标准编译、有的源码要求使用C++11标准编译，这时就可以使用in
CMAKE : INCLUDE命令
RobotLife的博客
12-30 6918
指令：include 作用：从文件或模块加载并运行CMake代码。 形式： include(&lt;file|module&gt; [OPTIONAL] [RESULT_VARIABLE ] [NO_POLICY_SCOPE]) 说明： 变量读写范围为调用此指令的调用者的范围，因此，具有动态范围即取决于调用者； 如果“OPTIONAL”被指定，则指定的文件不存在时，不会产生任何错误； 如果“RE...
cmake(三十五)Cmake之include指令
wzj_110的博客
05-11 7929
一 CMakeLists.txt和cmake脚本的联系和区别 ① cmake脚本 (1) cmake文件里面通常是'什么信息(information)' -- '.cmake文件'里包含了一些"公共(复用)"的'cmake命令'和一些'宏|函数' -- 当CMakeLists.txt'包含该.cmake文件'时,当'编译'运行时,该.cmake里的一些命令就会在该'包含处'得到加载'执行',在'后续'能够'调用该.cmake里'的一些宏和函数 -- .cmake文件是一个'模块...
cmake-3.20.6.tar.gz
01-30
3. **配置**：进入解压后的目录，运行 `./configure`（对于某些需要配置的项目，CMake 并不需要此步，因为它自身没有 configure 脚本）。 4. **编译**：使用 `make` 命令编译源代码。 5. **安装**：执行 `sudo ...
cmake-3.27.8.zip
01-31
- 高级功能：如条件语句(`if`)、循环(`foreach`)、函数(`function`)和宏(`macro`)，以及自定义命令和目标属性。 总的来说，CMake是一个强大的工具，能简化多平台软件的构建流程，提高开发效率，减少维护成本。通过...
cmake-3.20.6.zip
01-30
- 宏（macro）类似于函数，但不支持返回值和局部变量，适用于简单的代码复用。 4. **CMake与版本控制集成** - CMake可以与Git、SVN等版本控制系统结合，方便在不同开发环境中保持代码同步。 5. **多配置构建** ...
CMake4-指令2-1：include【将需要在很多CMakeLists文件中复用的语句抽取出来放入.cmake文件中（如：MACRO宏、function函数）】【清单文件中的命令会被立即处理】
u013250861的博客
11-19 1434
cmake的宏是MACRO，函数是function。COMMAND1(ARGS ...) # 命令语句...endmacro()COMMAND1(ARGS ...) # 命令语句...function()定义一个名称为name的宏（函数），arg1...是传入的参数。我们除了可以用${arg1}来引用变量变量说明argv##是一个下标，0指向第一个参数，累加argv所有的定义时要求传入的参数argn定义时要求传入的参数以外的参数argc。
CMake中的include函数
m0_61629312的博客
12-05 544
表示要包含的脚本文件的路径。如果文件名不包含路径分隔符，则 CMake 会搜索 CMake 模块路径和当前源代码目录来查找该文件。函数用于将共享的 CMake 模块或其他功能性脚本文件包含到主要的 CMakeLists.txt 文件中，以实现代码的重用和模块化。函数时，CMake 将加载并执行指定的脚本文件。这意味着脚本文件中的所有命令和变量定义都将在当前脚本中生效。如果脚本文件位于不同的目录中，可以使用相对或绝对路径来指定文件的位置。函数用于包含其他 CMake 脚本文件。在 CMake 中，
cmake include命令
m0_38036750的博客
07-09 699
cmake include()命令
CMake中include指令用法介绍
leoking01的专栏
08-24 3895
转载于：https://blog.csdn.net/liitdar/article/details/81144461 本文主要介绍CMake中include指令的用法。 1 概述 引用CMake官网对于include指令的介绍，如下： Load and run CMake code from a file or module. include指令的用法如下： include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR...
CMake中include的使用
网络资源是无限的
10-30 4883
CMake中include的使用
[5] CMake总结 - 2 基本命令
WhateverYoung的专栏
02-08 3283
CMake常用命令基本语法规则 cmake变量使用${}方式取值,但是在IF控制语句中是直接使用变量名 环境变量使用$ENV{}方式取值,使用SET(ENV{VAR} VALUE)赋值 指令(参数1 参数2…) 参数使用括弧括起,参数之间使用空格或分号分开。以ADD_EXECUTABLE指令为例： ADD_EXECUTABLE(hello main.c func.c)或者 ADD_EXECUTAB
cmake使用教程（八）-macro和function
06-02
好的，下面为您介绍 CMake 中的 macro 和 function。 ## 1. macro macro 是一种 CMake 的宏定义机制，可以将一组 CMake 命令封装起来，用一个名字来调用，从而简化 CMakeLists.txt 中的代码量。 macro 的定义格式如下： ``` macro(macro_name [arg1 [arg2 [arg3 ...]]) # command1 # command2 # ... endmacro() ``` 其中，macro_name 是宏的名称，arg1、arg2、arg3...是宏的参数列表，可以有 0 至多个参数。 下面是一个简单的例子，定义了一个名为 print_info 的宏，该宏接受两个参数，分别是 name 和 age，然后输出一条信息： ``` macro(print_info name age) message("Name: ${name}, Age: ${age}") endmacro() print_info("Alice" 18) ``` 执行上述代码后，输出结果为： ``` Name: Alice, Age: 18 ``` ## 2. function function 与 macro 的作用类似，也是将一组 CMake 命令封装起来，用一个名字来调用，但 function 有明确的返回值。function 的定义格式如下： ``` function(func_name [arg1 [arg2 [arg3 ...]]) # command1 # command2 # ... return(value) endfunction() ``` 其中，func_name 是函数的名称，arg1、arg2、arg3...是函数的参数列表，可以有 0 至多个参数。value 是函数的返回值。 下面是一个简单的例子，定义了一个名为 add 的函数，该函数接受两个参数，分别是 a 和 b，然后返回它们的和： ``` function(add a b) set(result ${a}+${b}) return(${result}) endfunction() set(sum 0) math(EXPR sum "${sum} + $(add(1 2))") message("Sum: ${sum}") ``` 执行上述代码后，输出结果为： ``` Sum: 3 ``` 在 function 中，我们使用 set 命令定义了一个变量 result，然后用 return 返回了这个变量的值。在调用 add 函数时，我们使用了 $() 将函数调用结果作为表达式的一部分，然后再用 math 命令计算出 sum 的值。 以上就是 CMake 中 macro 和 function 的介绍，希望对您有所帮助。
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值