3.6 Макросы с переменным числом аргументов

Макрос можно объявить так, чтобы он принимал переменное число аргументов, подобно функции. Синтаксис определения макроса аналогичен синтаксису функции. Вот пример:

#define eprintf(...) fprintf (stderr, __VA_ARGS__)

Этот вид макроса называется макросом с переменным числом аргументов. Когда макрос вызывается, все токены в его списке аргументов после последнего именованного аргумента (в этом макросе их нет), включая любые запятые, становятся переменным аргументом. Эта последовательность токенов заменяет идентификатор __VA_ARGS__ в теле макроса повсюду, где он встречается. Таким образом, у нас есть такая замена:

eprintf ("%s:%d: ", input_file, lineno)
     →  fprintf (stderr, "%s:%d: ", input_file, lineno)

Переменный аргумент полностью макрорасширяется перед вставкой в макрорасширение, как и обычный аргумент. Вы можете использовать операторы ‘#’ и ‘##’ для строковой записи переменного аргумента или для склеивания ведущего или заключительного токена с другим токеном. (Но см. ниже важный специальный случай для ‘##’.)

Если ваш макрос сложный, вы можете захотеть более описательное имя для переменного аргумента, чем __VA_ARGS__. CPP допускает это как расширение. Вы можете написать имя аргумента непосредственно перед ‘...’; это имя используется для переменного аргумента. Макрос eprintf выше можно записать

#define eprintf(args...) fprintf (stderr, args)

используя это расширение. Вы не можете использовать __VA_ARGS__ и это расширение в одном макросе.

Вы можете иметь как именованные аргументы, так и переменные аргументы в макросе с переменным числом аргументов. Мы могли бы определить eprintf так:

#define eprintf(format, ...) fprintf (stderr, format, __VA_ARGS__)

Эта формулировка выглядит более описательно, но исторически она была менее гибкой: вам приходилось передавать как минимум один аргумент после строки форматирования. В стандартном C вы не могли опустить запятую, разделяющую именованный аргумент и переменные аргументы. (Обратите внимание, что это ограничение было снято в C++20, и его никогда не было в GNU C; см. ниже.)

Кроме того, если вы оставили переменный аргумент пустым, у вас возникла бы синтаксическая ошибка, потому что после строки форматирования была бы лишняя запятая.

eprintf("success!\n", );
     → fprintf(stderr, "success!\n", );

Это было исправлено в C++20, а GNU CPP также имеет пару расширений, которые решают эту проблему.

Во-первых, в GNU CPP и в C++ начиная с C++20 разрешается опустить переменный аргумент полностью:

eprintf ("success!\n")
     → fprintf(stderr, "success!\n", );

Во-вторых, C++20 вводит макрос-функцию __VA_OPT__. Этот макрос может встречаться только в определении макроса с переменным числом аргументов. Если переменный аргумент имеет какие-либо токены, то вызов __VA_OPT__ расширяется до своего аргумента; но если переменный аргумент не имеет токенов, то __VA_OPT__ расширяется до ничего:

#define eprintf(format, ...) \
  fprintf (stderr, format __VA_OPT__(,) __VA_ARGS__)

__VA_OPT__ также доступен в GNU C и GNU C++.

Исторически GNU CPP также имел другое расширение для обработки заключительной запятой: оператор склеивания токенов ‘##’ имеет особое значение, когда он помещается между запятой и переменным аргументом. Несмотря на введение __VA_OPT__, это расширение по-прежнему поддерживается в GNU CPP для обратной совместимости. Если вы напишете

#define eprintf(format, ...) fprintf (stderr, format, ##__VA_ARGS__)

и переменный аргумент пропущен при использовании макроса eprintf, то запятая перед ‘##’ будет удалена. Это не происходит, если вы передаете пустой аргумент, и это не происходит, если токен, предшествующий ‘##’, является не запятой.

eprintf ("success!\n")
     → fprintf(stderr, "success!\n");

Вышеизложенное объяснение неоднозначно в случае, когда единственным параметром макроса является параметр переменных аргументов, поскольку бессмысленно пытаться отличить отсутствие аргумента от пустого аргумента. CPP сохраняет запятую при соответствии определенному стандарту C. В противном случае запятая удаляется как расширение стандарта.

Стандарт C предписывает, что идентификатор __VA_ARGS__ может встречаться только в списке замены макроса с переменным числом аргументов. Он не может использоваться в качестве имени макроса, имени аргумента макроса или внутри макроса другого типа. Он также может быть запрещен в открытом тексте; стандарт неоднозначен. Мы рекомендуем избегать его использования, кроме его определенного назначения.

Аналогично, C++ запрещает __VA_OPT__ где угодно за пределами списка замены макроса с переменным числом аргументов.

Макросы с переменным числом аргументов стали стандартной частью языка C с C99. GNU CPP ранее поддерживал их с именованным переменным аргументом (‘args...’, а не ‘...’ и __VA_ARGS__), который до сих пор поддерживается для обратной совместимости.