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++2a и никогда не существовало в GNU C; см. ниже.)

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

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

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

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

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

Во-вторых, C++2a вводит макрос-функцию __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__), который по-прежнему поддерживается для обратной совместимости.

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