macro

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

macro(<name> [arg1 [arg2 [arg3 ...]]])
  COMMAND1(ARGS ...)
  COMMAND2(ARGS ...)
  ...
endmacro(<name>)

Определить макрос с именем <name>, принимающий аргументы с именами arg1, arg2, arg3, (…). Команды, перечисленные после макроса, но перед соответствующим endmacro(), не вызываются до тех пор, пока макрос не будет вызван. При вызове команды, записанные в макросе, сначала модифицируются заменой формальных параметров (${arg1}) на переданные аргументы, а затем вызываются как обычные команды. В дополнение к ссылкам на формальные параметры можно ссылаться на значения ${ARGC}, которые будут установлены в число переданных аргументов, а также на ${ARGV0}, ${ARGV1}, ${ARGV2}, …, которые будут содержать фактические значения переданных аргументов. Это позволяет создавать макросы с необязательными аргументами. Дополнительно ${ARGV} содержит список всех аргументов, переданных макросу, а ${ARGN} — список аргументов, следующих за последним ожидаемым аргументом. Ссылка на аргументы ${ARGV#} после ${ARGC} имеет неопределённое поведение. Проверка того, что ${ARGC} больше, чем #, — единственный способ убедиться, что ${ARGV#} был передан в функцию как дополнительный аргумент.

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

Особенности аргументов макроса

Обратите внимание, что параметры макроса и значения, такие как ARGN, не являются переменными в обычном смысле CMake. Это подстановки строк, подобные тому, как это делает препроцессор C с макросом. Поэтому вы не сможете использовать команды, такие как:

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)
    [...]
  endforeach()
endmacro()

function(_FOO)
  _bar(x y z)
endfunction()

_foo(a b c)

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