cmake 中有两个相似的关键字, macro 和 function 这两个都是创建一段有名字的代码稍后可以调用, 还可以传参数
macro 宏定义与 function 函数的相同点
macro 形式如下:
macro(<name> [arg1 [arg2 [arg3 ...]]])
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
endmacro(<name>)
function 形式如下:
function(<name> [arg1 [arg2 [arg3 ...]]])
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
function(<name>)
定义一个名称为 name 的宏 (函数),arg1… 是传入的参数我们除了可以用 ${arg1} 来引用变量以外, 系统为我们提供了一些特殊的变量:
| 变量 | 说明 |
|---|---|
ARGV# |
# 是一个下标，0 指向第一个参数，累加 |
ARGV |
所有的定义时要求传入的参数 |
ARGN |
定义时要求传入的参数以外的参数，比如定义宏（函数）时，要求输入 1 个，书记输入了 3 个，则剩下的两个会以数组形式存储在 ARGN 中 |
ARGC |
传入的实际参数的个数，也就是调用函数是传入的参数个数 |
macro宏定义与function函数的不同点
宏的ARGN、ARGV等参数不是通常CMake意义上的变量。 它们是字符串替换，很像C预处理器对宏的处理。 因此，如下命令是错误的：
if(ARGV1) # ARGV1 is not a variable
if(DEFINED ARGV2) # ARGV2 is not a variable
if(ARGC GREATER 2) # ARGC is not a variable
foreach(loop_var IN LISTS ARGN) # ARGN is not a variable
正确写法如下：
if(${
ARGV1})
if(DEFINED ${
ARGV2})
if(${
ARGC} GREATER 2)
foreach(loop_var IN LISTS ${
ARGN})
or
set(list_var "${ARGN}")
foreach(loop_var IN LISTS list_var)
例子1
macro(FOO arg1 arg2 arg3)
message(STATUS "this is arg1:${arg1},ARGV0=${ARGV0}")
message(STATUS "this is arg2:${arg2},ARGV1=${ARGV1}")
message(STATUS "this is arg3:${arg3},ARGV2=${ARGV2}")
message(STATUS "this is argc:${ARGC}")
message(STATUS "this is args:${ARGV},ARGN=${ARGN}")
if(arg1 STREQUAL one)
message(STATUS "this is arg1")
endif()
if(ARGV2 STREQUAL "two")
message(STATUS "this is arg2")
endif()
set(${
arg1} nine)
message(STATUS "after set arg1=${${arg1}}")
endmacro(FOO)
function(BAR arg1)
message(STATUS "this is arg1:${arg1},ARGV0=${ARGV0}")
message(STATUS "this is argn:${ARGN}")
if(arg1 STREQUAL first)
message(STATUS "this is first")
endif()
set(arg1 ten)
message(STATUS "after set arg1=${arg1}")
endfunction(BAR arg1)
set(p1 one)
set(p2 two)
set(p3 three)
set(p4 four)
set(p5 five)
set(p6 first)
set(p7 second)
FOO(${
p1} ${
p2} ${
p3} ${
p4} ${
p5})
BAR(${
p6} ${
p7})
message(STATUS "after bar p6=${p6}")
输出结果如下:
例子2
macro(_bar)
foreach(arg IN LISTS ARGN)
message(STATUS "this is in macro ${arg}")
endforeach()
endmacro()
function(_foo)
foreach(arg IN LISTS ARGN)
message(STATUS "this in function is ${arg}")
endforeach()
_bar(x y z)
endfunction()
_foo(a b c)
看一下输出:
