3.3 Аргументы макроса

Макросы, похожие на функции, могут принимать аргументы, как и настоящие функции. Для определения макроса, использующего аргументы, введённые параметры заключаются в скобки в определении макроса, делая макрос похожим на функцию. Параметры должны быть допустимыми идентификаторами C, разделенными запятыми и необязательными пробелами.

Для вызова макроса, принимающего аргументы, запишите имя макроса, за которым следует список фактических аргументов в скобках, разделенных запятыми. Вызов макроса не ограничен одной логической строкой — он может занимать любое количество строк в исходном файле. Количество аргументов должно соответствовать количеству параметров в определении макроса. При раскрытии макроса каждое использование параметра в его теле заменяется токенами соответствующего аргумента. (Вы можете не использовать все параметры в теле макроса.)

В качестве примера, здесь представлен макрос, вычисляющий минимальное значение из двух числовых значений, как он определен во многих программах на C, и некоторые примеры его использования.

#define min(X, Y)  ((X) < (Y) ? (X) : (Y))
  x = min(a, b);          →  x = ((a) < (b) ? (a) : (b));
  y = min(1, 2);          →  y = ((1) < (2) ? (1) : (2));
  z = min(a + 28, *p);    →  z = ((a + 28) < (*p) ? (a + 28) : (*p));

(В этом примере уже видны несколько опасностей аргументов макроса. Подробные объяснения см. в разделе Ошибки макросов.)

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

macro (array[x = y, x + 1])

передает два аргумента макросу macro: array[x = y и x + 1]. Если вы хотите передать array[x = y, x + 1] в качестве аргумента, вы можете написать это как array[(x = y, x + 1)], что эквивалентно коду C.

Все аргументы макроса полностью раскрываются макросом перед подстановкой в тело макроса. После подстановки весь текст снова сканируется на макросы для раскрытия, включая аргументы. Это правило может показаться странным, но оно тщательно разработано, чтобы вы не беспокоились о том, является ли какой-либо вызов функции фактически вызовом макроса. Однако, вы можете столкнуться с проблемами, если попытаетесь быть слишком умными. Подробное обсуждение см. в разделе Предварительный просмотр аргументов.

Например, min (min (a, b), c) сначала раскрывается до

min (((a) < (b) ? (a) : (b)), (c))

а затем до

((((a) < (b) ? (a) : (b))) < (c)
 ? (((a) < (b) ? (a) : (b)))
 : (c))

(Переводные переводы строк в данном случае представлены для наглядности; они фактически не будут генерироваться.)

Вы можете оставить аргументы макроса пустыми; это не ошибка для препроцессора (но многие макросы затем расширятся до недопустимого кода). Вы не можете полностью опустить аргументы; если макрос принимает два аргумента, то должна быть ровно одна запятая на верхнем уровне списка аргументов. Вот несколько смешных примеров с использованием min:

min(, b)        → ((   ) < (b) ? (   ) : (b))
min(a, )        → ((a  ) < ( ) ? (a  ) : ( ))
min(,)          → ((   ) < ( ) ? (   ) : ( ))
min((,),)       → (((,)) < ( ) ? ((,)) : ( ))

min()      error→ macro "min" requires 2 arguments, but only 1 given
min(,,)    error→ macro "min" passed 3 arguments, but takes just 2

Пробел не является токеном препроцессирования, поэтому, если макрос foo принимает один аргумент, foo () и foo ( ) оба передают ему пустой аргумент. Предыдущие реализации и документация GNU препроцессора были неверными в этом пункте, настаивая на том, что для функции-макроса, принимающей один аргумент, необходимо передавать пробел, если требуется пустой аргумент.

Параметры макроса, появляющиеся внутри строковых литералов, не заменяются соответствующими фактическими аргументами.

#define foo(x) x, "x"
foo(bar)        → bar, "x"