function

Начать запись функции для последующего вызова в качестве команды.

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

Определяет функцию с именем <name>, принимающую аргументы с именами <arg1>, ... <commands> в определении функции записываются; они не выполняются до тех пор, пока функция не будет вызвана.

По унаследованному стандарту, команда endfunction() допускает необязательный аргумент <name>. Если он используется, он должен быть точной копией аргумента открывающей команды function.

Функция открывает новую область видимости: см. set(var PARENT_SCOPE) для деталей.

См. документацию команды cmake_policy() для поведения политик внутри функций.

См. документацию команды macro() для различий между функциями и макросами CMake.

Вызов

Вызов функции нечувствителен к регистру. Функция, определенная как

function(foo)
  <commands>
endfunction()

может быть вызвана любым из способов

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

и так далее. Однако настоятельно рекомендуется придерживаться регистра, выбранного в определении функции. Обычно функции используют имена в нижнем регистре.

Аргументы

При вызове функции записанные <commands> сначала изменяются путем замены формальных параметров (${arg1}, ...) переданными аргументами, а затем вызываются как обычные команды.

В дополнение к ссылкам на формальные параметры вы можете ссылаться на переменную ARGC, которая будет установлена ​​в количестве переданных в функцию аргументов, а также ARGV0, ARGV1, ARGV2, ... которые будут содержать фактические значения переданных аргументов. Это облегчает создание функций с необязательными аргументами.

Кроме того, ARGV содержит список всех переданных в функцию аргументов, а ARGN — список аргументов после последнего ожидаемого аргумента. Ссылка на аргументы ARGV# сверх ARGC имеет неопределенное поведение. Проверка того, что ARGC больше #, — единственный способ гарантировать, что ARGV# был передан в функцию как дополнительный аргумент.