function

开始记录一个函数，以便稍后将其作为命令调用。

function(<name> [<arg1> ...])
  <commands>
endfunction()

定义一个名为 <name> 的函数，该函数接受名为 <arg1>, ... 的参数。函数定义中的 <commands> 会被记录下来；它们在函数被调用之前不会被执行。

出于历史原因，endfunction() 命令接受一个可选的 <name> 参数。如果使用，它必须与开头的 function 命令的参数一模一样。

函数会打开一个新的作用域：有关详细信息，请参阅 set(var PARENT_SCOPE)。

有关函数内部策略行为的详细信息，请参阅 cmake_policy() 命令文档。

有关 CMake 函数和宏之间的区别，请参阅 macro() 命令文档。

调用

函数调用不区分大小写。定义为

function(foo)
  <commands>
endfunction()

的函数可以通过以下任何一种方式调用：

foo()
Foo()
FOO()
cmake_language(CALL foo)

依此类推。但是，强烈建议保持函数定义中选择的大小写。通常，函数使用全小写名称。

3.18 版本新增: cmake_language(CALL ...) 命令也可用于调用该函数。

参数

当函数被调用时，记录的 <commands> 会首先通过将形式参数（${arg1}, ...）替换为传入的参数来修改，然后像普通命令一样被调用。

除了引用形式参数之外，您还可以引用 ARGC 变量，该变量将设置为传递给函数的参数数量，以及 ARGV0, ARGV1, ARGV2, ...，它们将包含传入参数的实际值。这有助于创建带有可选参数的函数。

此外，ARGV 包含传递给函数的全部参数列表，而 ARGN 包含最后一个预期参数之后的参数列表。引用超出 ARGC 的 ARGV# 参数具有未定义行为。检查 ARGC 是否大于 # 是确保 ARGV# 作为额外参数传递给函数的唯一方法。

另请参阅

• cmake_parse_arguments()

• endfunction()

• return()