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__), что по-прежнему поддерживается для обратной совместимости.

Далее: Предопределённые макросы, Предыдущее: Конкатенация, Вверх: Макросы [Оглавление][Индекс]