Какие применения оператора препроцессора ## и какие подводные камни следует учитывать?

CrashRpt: использование ## для преобразования многобайтовых строк макросов в Unicode

Интересное использование в CrashRpt (библиотеке отчетов о сбоях) следующее:

#define WIDEN2(x) L ## x
#define WIDEN(x) WIDEN2(x)
//Note you need a WIDEN2 so that __DATE__ will evaluate first.

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

 std::wstring BuildDate = std::wstring(WIDEN(__DATE__)) + L" " + WIDEN(__TIME__);

Они используют его с другим макросом, который возвращает строку с датой и временем.

Размещение L рядом с __ DATE __ приведет к ошибке компиляции.

Windows: использование ## для универсальных строк Unicode или многобайтовых строк

Windows использует что-то вроде следующего:

#ifdef  _UNICODE
    #define _T(x)      L ## x
#else
    #define _T(x) x
#endif

И _T используется везде в коде

Различные библиотеки, используемые для чистых имен аксессуаров и модификаторов:

Я также видел, как он используется в коде для определения аксессуаров и модификаторов:

#define MYLIB_ACCESSOR(name) (Get##name)
#define MYLIB_MODIFIER(name) (Set##name)

Точно так же вы можете использовать этот же метод для любых других типов создания умных имен.

Различные библиотеки, использующие его для одновременного объявления нескольких переменных:

#define CREATE_3_VARS(name) name##1, name##2, name##3
int CREATE_3_VARS(myInts);
myInts1 = 13;
myInts2 = 19;
myInts3 = 77;

Я использую его для добавления пользовательских префиксов к переменным, определяемым макросами. Так что-то вроде:

UNITTEST(test_name)

расширяется до:

void __testframework_test_name ()

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

Его можно использовать для шаблонов:

#define LINKED_LIST(A) struct list##_##A {\
A value; \
struct list##_##A *next; \
};

В этом случае LINKED_LIST (int) даст вам

struct list_int {
int value;
struct list_int *next;
};

Точно так же вы можете написать шаблон функции для обхода списка.

Это полезно во всех ситуациях, чтобы не повторяться без нужды. Ниже приводится пример исходного кода Emacs. Мы хотели бы загрузить ряд функций из библиотеки. Функция "foo" должна быть присвоена fn_foo и так далее. Мы определяем следующий макрос:

#define LOAD_IMGLIB_FN(lib,func) {                                      \
    fn_##func = (void *) GetProcAddress (lib, #func);                   \
    if (!fn_##func) return 0;                                           \
  }

Затем мы можем использовать его:

LOAD_IMGLIB_FN (library, XpmFreeAttributes);
LOAD_IMGLIB_FN (library, XpmCreateImageFromBuffer);
LOAD_IMGLIB_FN (library, XpmReadFileToImage);
LOAD_IMGLIB_FN (library, XImageFree);

Преимущество состоит в том, что не нужно записывать одновременно fn_XpmFreeAttributes и "XpmFreeAttributes" (и есть риск опечатки в одном из них).

Основное использование - это когда у вас есть соглашение об именах и вы хотите, чтобы ваш макрос использовал это соглашение об именах. Возможно, у вас есть несколько семейств методов: image_create (), image_activate () и image_release (), а также file_create (), file_activate (), file_release () и mobile_create (), mobile_activate () и mobile_release ().

Вы можете написать макрос для обработки жизненного цикла объекта:

#define LIFECYCLE(name, func) (struct name x = name##_create(); name##_activate(x); func(x); name##_release())

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

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

SCREEN_HANDLER( activeCall )

расширяется примерно до этого:

STATUS activeCall_constructor( HANDLE *pInst )
STATUS activeCall_eventHandler( HANDLE *pInst, TOKEN *pEvent );
STATUS activeCall_destructor( HANDLE *pInst );

Это обеспечивает правильную параметризацию для всех "производных" объектов, когда вы:

SCREEN_HANDLER( activeCall )
SCREEN_HANDLER( ringingCall )
SCREEN_HANDLER( heldCall )

указанное выше в ваших файлах заголовков и т. д. Это также полезно для обслуживания, если вы даже захотите изменить определения и / или добавить методы к «объектам».

SGlib использует ## для подделки шаблонов в C. Поскольку нет перегрузки функций, ## используется для вставки имени типа в имена сгенерированных функций. Если бы у меня был тип списка с именем list_t, я бы получил функции с именем sglib_list_t_concat и так далее.

Это очень полезно для ведения журнала. Ты можешь сделать:

#define LOG(msg) log_msg(__function__, ## msg)

Или, если ваш компилятор не поддерживает функция и func:

#define LOG(msg) log_msg(__file__, __line__, ## msg)

Вышеупомянутые "функции" регистрируют сообщение и показывают, какая именно функция зарегистрировала сообщение.

Мой синтаксис C++ может быть не совсем правильным.

Вот проблема, с которой я столкнулся при обновлении до новой версии компилятора:

Ненужное использование оператора вставки токена (##) не переносимо и может генерировать нежелательные пробелы, предупреждения или ошибки.

Когда результат оператора вставки токена не является допустимым токеном препроцессора, оператор вставки токена не нужен и, возможно, вреден.

Например, можно попытаться построить строковые литералы во время компиляции с помощью оператора вставки токена:

#define STRINGIFY(x) #x
#define PLUS(a, b) STRINGIFY(a##+##b)
#define NS(a, b) STRINGIFY(a##::##b)
printf("%s %s\n", PLUS(1,2), NS(std,vector));

В некоторых компиляторах это выдаст ожидаемый результат:

1+2 std::vector

В других компиляторах это будет включать нежелательные пробелы:

1 + 2 std :: vector

Довольно современные версии GCC (> = 3.3 или около того) не смогут скомпилировать этот код:

foo.cpp:16:1: pasting "1" and "+" does not give a valid preprocessing token
foo.cpp:16:1: pasting "+" and "2" does not give a valid preprocessing token
foo.cpp:16:1: pasting "std" and "::" does not give a valid preprocessing token
foo.cpp:16:1: pasting "::" and "vector" does not give a valid preprocessing token

Решение состоит в том, чтобы опустить оператор вставки токена при объединении токенов препроцессора с операторами C / C++:

#define STRINGIFY(x) #x
#define PLUS(a, b) STRINGIFY(a+b)
#define NS(a, b) STRINGIFY(a::b)
printf("%s %s\n", PLUS(1,2), NS(std,vector));

Глава документации GCC CPP о конкатенации содержит более полезную информацию об операторе вставки токена.

Я использую его для домашнего свернутого утверждения на нестандартном компиляторе C для встроенных:

#define ASSERT(exp) if (!(exp)){ \
                      print_to_rs232("Assert failed: " ## #exp );\
                      while(1){} //Let the watchdog kill us 

В предыдущем вопросе по Stack Overflow предлагался плавный метод генерации строковых представлений для констант перечисления без большого количества подверженных ошибкам повторного ввода.

Связь

Мой ответ на этот вопрос показал, как применение небольшой магии препроцессора позволяет вам определять ваше перечисление следующим образом (например) ...;

ENUM_BEGIN( Color )
  ENUM(RED),
  ENUM(GREEN),
  ENUM(BLUE)
ENUM_END( Color )

... С тем преимуществом, что расширение макроса не только определяет перечисление (в файле .h), но также определяет соответствующий массив строк (в файле .c);

const char *ColorStringTable[] =
{
  "RED",
  "GREEN",
  "BLUE"
};

Имя таблицы строк происходит от вставки параметра макроса (т. Е. Color) в StringTable с помощью оператора ##. В подобных приложениях (уловках?) Операторы # и ## неоценимы.

При использовании операторов предварительной обработки token-paste ('##') или преобразования строк ('#') следует помнить, что вам нужно использовать дополнительный уровень косвенного обращения, чтобы они работали должным образом во всех случаях.

Если вы этого не сделаете и элементы, переданные оператору вставки токена, сами являются макросами, вы получите результаты, которые, вероятно, не будут тем, что вам нужно:

#include <stdio.h>

#define STRINGIFY2( x) #x
#define STRINGIFY(x) STRINGIFY2(x)
#define PASTE2( a, b) a##b
#define PASTE( a, b) PASTE2( a, b)

#define BAD_PASTE(x,y) x##y
#define BAD_STRINGIFY(x) #x

#define SOME_MACRO function_name

int main() 
{
    printf( "buggy results:\n");
    printf( "%s\n", STRINGIFY( BAD_PASTE( SOME_MACRO, __LINE__)));
    printf( "%s\n", BAD_STRINGIFY( BAD_PASTE( SOME_MACRO, __LINE__)));
    printf( "%s\n", BAD_STRINGIFY( PASTE( SOME_MACRO, __LINE__)));

    printf( "\n" "desired result:\n");
    printf( "%s\n", STRINGIFY( PASTE( SOME_MACRO, __LINE__)));
}

Выход:

buggy results:
SOME_MACRO__LINE__
BAD_PASTE( SOME_MACRO, __LINE__)
PASTE( SOME_MACRO, __LINE__)

desired result:
function_name21

Одно важное использование в WinCE:

#define BITFMASK(bit_position) (((1U << (bit_position ## _WIDTH)) - 1) << (bit_position ## _LEFTSHIFT))

При определении описания бита регистра мы делаем следующее:

#define ADDR_LEFTSHIFT                          0

#define ADDR_WIDTH                              7

А при использовании BITFMASK просто используйте:

BITFMASK(ADDR)