macro

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

macro(<name> [<arg1> ...])
  <commands>
endmacro()

Определяет макрос с именем <name>, принимающий аргументы с именами <arg1>, ... Команды, перечисленные после макроса, но перед соответствующей командой endmacro(), не выполняются до вызова макроса.

В соответствии с наследием, команда endmacro() допускает необязательный <name> аргумент. Если используется, он должен быть точной копией аргумента открывающей команды macro.

См. документацию команды cmake_policy() для поведения политик внутри макросов.

См. раздел Макрос против функции ниже для отличий между макросами CMake и командой functions.

Вызов

Вызов макроса нечувствителен к регистру. Макрос, определенный как

macro(foo)
  <commands>
endmacro()

можно вызвать с помощью любого из

foo()
Foo()
FOO()
cmake_language(CALL foo)

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

Аргументы

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

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

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

Макрос против функции

Команда macro очень похожа на команду function(). Тем не менее, существуют некоторые важные различия.

В функции ARGN, ARGC, ARGV и ARGV0, ARGV1, ... являются истинными переменными в обычном смысле CMake. В макросе они таковыми не являются; это строковые замены, аналогичные тому, как препроцессор C обрабатывает макросы. Это имеет ряд последствий, как объяснено в разделе Особые случаи аргументов ниже.

Еще одно отличие между макросами и функциями — это управление потоком. Функция выполняется путем передачи управления от вызывающей инструкции к телу функции. Макрос выполняется так, как если бы тело макроса было вставлено вместо вызывающей инструкции. Это означает, что return() в теле макроса не просто завершает выполнение макроса, а возвращает управление из области вызова макроса. Чтобы избежать путаницы, рекомендуется вообще избегать использования return() в макросах.

В отличие от функции, переменные CMAKE_CURRENT_FUNCTION, CMAKE_CURRENT_FUNCTION_LIST_DIR, CMAKE_CURRENT_FUNCTION_LIST_FILE, CMAKE_CURRENT_FUNCTION_LIST_LINE для макроса не устанавливаются.

Особые случаи аргументов

Поскольку ARGN, ARGC, ARGV, ARGV0 и т. д. не являются переменными, вы НЕ сможете использовать команды, такие как

if(ARGV1) # ARGV1 is not a variable
if(DEFINED ARGV2) # ARGV2 is not a variable
if(ARGC GREATER 2) # ARGC is not a variable
foreach(loop_var IN LISTS ARGN) # ARGN is not a variable

В первом случае вы можете использовать if(${ARGV1}). Во втором и третьем случаях правильный способ проверки, был ли передан необязательный аргумент макросу, — это использовать if(${ARGC} GREATER 2). В последнем случае вы можете использовать foreach(loop_var ${ARGN}), но это пропустит пустые аргументы. Если вам необходимо включить их, вы можете использовать

set(list_var "${ARGN}")
foreach(loop_var IN LISTS list_var)

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

macro(bar)
  foreach(arg IN LISTS ARGN)
    <commands>
  endforeach()
endmacro()

function(foo)
  bar(x y z)
endfunction()

foo(a b c)

будет перебирать a;b;c а не x;y;z, как можно было ожидать. Если вам нужны настоящие переменные CMake и/или лучшее управление областью CMake, обратите внимание на команду function.

См. также

• cmake_parse_arguments()
• endmacro()