функция

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

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# был передан в функцию в качестве дополнительного аргумента.