Замена текстовых макросов

Предпроцессор поддерживает замену текстовых макросов и замену текстовых макросов вида функций.

Синтаксис

Объяснение

Директивы #define

Директивы #define определяют идентификатор как макрос, то есть они инструктируют компилятор заменить все последующие вхождения идентификатора на список_замены, который может быть дополнительно обработан. Если идентификатор уже определён как макрос любого типа, программа некорректна, если определения не идентичны.

Макросы типа объектов

Макросы типа объектов заменяют каждое вхождение определённого идентификатора на список_замены. Версия (1) директивы #define ведет себя точно так же.

Макросы типа функций

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

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

Количество аргументов должно быть таким же, как количество аргументов в определении макроса (параметры), иначе программа некорректна. Если идентификатор не в функциональной нотации, т.е. не имеет скобок после себя, он не заменяется.

Версия (2) директивы #define определяет простой макрос типа функции.

Версия (3) директивы #define определяет макрос типа функции с переменным числом аргументов. Дополнительные аргументы можно получить, используя __VA_ARGS__ идентификатор, который затем заменяется на аргументы, предоставленные с идентификатором, подлежащим замене.

Версия (4) директивы #define определяет макрос типа функции с переменным числом аргументов, но без обычных аргументов. Аргументы можно получить только с помощью __VA_ARGS__ идентификатора, который затем заменяется на аргументы, предоставленные с идентификатором, подлежащим замене.

#define F(...) f(0 __VA_OPT__(,) __VA_ARGS__)
F(a, b, c) // replaced by f(0, a, b, c)
F()        // replaced by f(0)
 
#define G(X, ...) f(0, X __VA_OPT__(,) __VA_ARGS__)
G(a, b, c) // replaced by f(0, a, b, c)
G(a, )     // replaced by f(0, a)
G(a)       // replaced by f(0, a)
 
#define SDEF(sname, ...) S sname __VA_OPT__(= { __VA_ARGS__ })
SDEF(foo);       // replaced by S foo;
SDEF(bar, 1, 2); // replaced by S bar = { 1, 2 };

Примечание: если аргумент макроса типа функции включает запятые, которые не защищены парными левой и правой скобками (такими как macro(array[x = y, x + 1]) или atomic_store (p, (struct S){ a, b });), запятая интерпретируется как разделитель аргументов макроса, что приводит к ошибке компиляции из-за несоответствия количества аргументов.

Операторы # и ##

В макросах типа функций оператор # перед идентификатором в списке_замены выполняет замену параметра на идентификатор и заключает результат в кавычки, эффективно создавая строковый литерал. Кроме того, предпроцессор добавляет обратные слэши для экранирования кавычек, окружающих вложенные строковые литералы, если таковые имеются, и удваивает обратные слэши внутри строки по мере необходимости. Все начальные и конечные пробелы удаляются, а любая последовательность пробелов посредине текста (но не внутри вложенных строковых литералов) сводится к одному пробелу. Эта операция называется "строковая замена". Если результат строковой замены не является допустимым строковым литералом, поведение не определено.

#define showlist(...) puts(#__VA_ARGS__)
showlist();            // expands to puts("")
showlist(1, "x", int); // expands to puts("1, \"x\", int")

Оператор ## между любыми двумя последовательными идентификаторами в списке_замены выполняет замену параметров на эти идентификаторы, а затем конкатенирует результат. Эта операция называется "конкатенацией" или "склейкой токенов". Склеиваться могут только токены, образующие вместе допустимый токен: идентификаторы, образующие более длинный идентификатор, цифры, образующие число, или операторы + и = образующие +=. Комментарий не может быть создан путём склеивания / и *, так как комментарии удаляются из текста перед рассмотрением подстановки макросов. Если результат конкатенации не является допустимым токеном, поведение не определено.

Примечание: Некоторые компиляторы предлагают расширение, позволяющее ## появляться после запятой и перед __VA_ARGS__, в этом случае ## ничего не делает, когда __VA_ARGS__ не пусто, но удаляет запятую, когда __VA_ARGS__ пусто: это позволяет определять макросы, такие как fprintf (stderr, format, ##__VA_ARGS__).

Порядок вычисления операторов # и ## не определён.

Директива #undef

Директива #undef отменяет идентификатор, то есть она отменяет предыдущее определение идентификатора директивой #define. Если идентификатор не имеет связанного макроса, директива игнорируется.

Предопределённые макросы

В любом модуле перевода определены следующие имена макросов:

Следующие дополнительные имена макросов могут быть предварительно определены реализацией:

Значения этих макросов (кроме __FILE__ и __LINE__) остаются постоянными в течение всего блока трансляции. Попытки переопределения или удаления этих макросов ведут к неопределенному поведению.

Пример

#include <stdio.h>
 
// make function factory and use it
#define FUNCTION(name, a) int fun_##name(int x) { return (a) * x; }
 
FUNCTION(quadruple, 4)
FUNCTION(double, 2)
 
#undef FUNCTION
#define FUNCTION 34
#define OUTPUT(a) puts( #a )
 
int main(void)
{
    printf("quadruple(13): %d\n", fun_quadruple(13) );
    printf("double(21): %d\n", fun_double(21) );
    printf("%d\n", FUNCTION);
    OUTPUT(billion);               // note the lack of quotes
}

quadruple(13): 52
double(21): 42
34
billion

Отчеты об ошибках

Следующие отчеты об ошибках, изменяющие поведение, были применены ретроактивно к ранее опубликованным стандартам C.

Ссылки

• Стандарт C23 (ISO/IEC 9899:2023):
• 6.10.4 Замена макросов (с. 187-184)
• 6.10.9 Имена предопределенных макросов (с. 186-188)
• Стандарт C17 (ISO/IEC 9899:2018):
• 6.10.3 Замена макросов (с. 121-126)
• 6.10.8 Имена предопределенных макросов (с. 127-129)
• Стандарт C11 (ISO/IEC 9899:2011):
• 6.10.3 Замена макросов (с. 166-173)
• 6.10.8 Имена предопределенных макросов (с. 175-176)
• Стандарт C99 (ISO/IEC 9899:1999):
• 6.10.3 Замена макросов (с. 151-158)
• 6.10.8 Имена предопределенных макросов (с. 160-161)
• Стандарт C89/C90 (ISO/IEC 9899:1990):
• 3.8.3 Замена макросов
• 3.8.8 Имена предопределенных макросов

См. также