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"