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()

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

Аргументы

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

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

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