функция

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

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)

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

Команда cmake_language(CALL ...) также может быть использована для вызова функции.

Аргументы

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

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

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