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

См. также

• endfunction()
• return()