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.