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

См. также

• cmake_parse_arguments()
• endfunction()
• return()