Replacing text macros

Препроцессор поддерживает текстовую замену макросов и функциональную текстовую замену макросов.

Синтаксис

Объяснение

#define директивы

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

Макросы, подобные объектам

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

Макросы, подобные функциям

Функциональные макросы заменяют каждое вхождение определенного идентификатора на список-замены , дополнительно принимая ряд аргументов, которые затем заменяют соответствующие вхождения любых параметров в списке-замены .

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

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

Версия (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 } ) ; ), запятая интерпретируется как разделитель аргументов макроса, что вызывает ошибку компиляции из-за несоответствия количества аргументов.

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

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

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

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

Примечание: Некоторые компиляторы предоставляют расширение, позволяющее ## появляться после запятой и перед __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.

Ссылки

Смотрите также