Препроцессорные директивы в C/C++ (#include, #define и прочее)

#define N 20
 
int a[N];
int x;
 
void func (void)
{
  int i;
  for (i = 0; i < N; i++)
    x += a[i];
}

int a[20];
int x;
 
void func (void)
{
  int i;
  for (i = 0; i < 20; i++)
    x += a[i];
}

#define N 20
 
int a[N];
...
 
void func (void)
{
  int N;
  N++;
}

int a[20];
...
 
void func (void)
{
  int 20;
  20++;
}

#define N 20 <-- в этой точке препроцессор "запомнит" макрос "N"
                 и с этого момента будет заменять "N" на "20"
 
int a[N];
...
 
#undef N <-- в этой точке препроцессор "забудет" макрос "N"
             и больше заменять его не будет
 
void func (void)
{
  int N;
  N++;
}

<-- здесь было "#define"
 
int a[20]; <-- здесь ещё работает замена "N" на "20"
...
 
<-- здесь было "#undef"
 
void func (void)
{
  int N; <-- в местах после #undef замена не производится
  N++;
}

#define SQUARE(val) val * val
 
void func (int x, int y)
{
  int a, b;
 
  a = SQUARE (x);
  b = SQUARE (y);
}

void func (int x, int y)
{
  int a, b;
 
  a = x * x; <-- здесь произошла текстовая замена "SQUARE(x)" на "x * x"
  b = y * y; <-- здесь произошла текстовая замена "SQUARE(y)" на "y * y"
}

#define SUM(x1,x2) x1 + x2

// Правильно. Трактуется как макрос "SQUARE" с одним параметром "val"
// и телом "val * val"
#define SQUARE(val) val * val
 
// Не правильно. Трактуется как макрос "SQUARE" без параметров
// и телом "(val) val * val"
#define SQUARE (val) val * val

#define SQUARE (val) val * val
void func (int x)
{
  int a;
  a = SQUARE (x);
}

void func (int x)
{
  int a;
  a = (val) val * val (x); <-- произошла текстовая замена "SQUARE" на "(val) val * val"
}

#define SQUARE(val) val * val
void func (int x)
{
  int a;
  a = SQUARE (x+1);
}

void func (int x)
{
  int a;
  a = x+1 * x+1;
}

#define SQUARE(val) (val) * (val)
void func (int x)
{
  int a;
  a = SQUARE (x+1);
}

void func (int x)
{
  int a;
  a = (x+1) * (x+1);
}

#define DOUBLE(val) (val) + (val)
...
  x = DOUBLE(y) * DOUBLE(y);
...

x = (y) + (y) * (y) + (y);

#define DOUBLE(val) ((val) + (val))
...
  x = DOUBLE(y) * DOUBLE(y);
...

x = ((y) + (y)) * ((y) + (y));

a = SQUARE (fgetc(fp));

a = ((fgetc(fp)) * (fgetc(fp)));

#define MACRO(x,y) x #y
...
MACRO (10, 20)

10 "20"

#define PRINT_INT_VAR(x) printf (#x "=%d\n", x)
...
int a, b[10];
...
PRINT_INT_VAR (a);
PRINT_INT_VAR (b[2]);

printf ("a" "=%d\n", a);
printf ("b[2]" "=%d\n", b[2]);

"qwe" "rty"

"qwerty"

printf ("a=%d\n", a);
printf ("b[2]=%d\n", b[2]);

PRINT_INT_VAR (a+b);

printf ("a+b=%d\n", a+b);

#define PRINT_VAR(var,format) printf (#var "=" format "\n", (var))
...
int i;
float f;
...
PRINT_VAR (i, "%d");
PRINT_VAR (f, "%f");

#define MACRO1(x,y) x##y
#define MACRO2(x,y) x##y##trampampam
 
MACRO1 (abc, def)
MACRO2 (abc, def)

abcdef
abcdeftrampampam

void func1 (void)
{
  ...
#if defined __linux__
  num = __NR_read;
#elif defined __sun__
  num = SYS_read;
#else
#error "unknown OS"
#endif
  ...
}
 
void func2 (void)
{
  ...
#if defined __linux__
  num = __NR_write;
#elif defined __sun__
  num = SYS_write;
#else
#error "unknown OS"
#endif
  ...
}

#if defined __linux__
  #define SYS_NUM(num) __NR_##num
#elif defined __sun__
  #define SYS_NUM(num) SYS_##num
#else
#error "unknown OS"
#endif
 
void func1 (void)
{
  ...
  num = SYS_NUM (read);
  ...
}
 
void func2 (void)
{
  ...
  num = SYS_NUM (write);
  ...
}

void func1 (void)
{
  ...
  num = __NR_read;
  ...
}
 
void func2 (void)
{
  ...
  num = __NR_write;
  ...
}

void func1 (void)
{
  ...
  num = SYS_read;
  ...
}
 
void func2 (void)
{
  ...
  num = SYS_write;
  ...
}

#define FUNC(x,y,z) \
  ( (x)*(x)*(x) \
    + (y)*(y)*(y) \
    + (z)*(z)*(z) )
...
  a = FUNC (10, x+1, t-d);
...

...
  a =   ( (10)*(10)*(10)     + (x+1)*(x+1)*(x+1)     + (t-d)*(t-d)*(t-d) );
...

const int debug = 1;
...
void func (void)
{
  if (debug)
    printf ("entering 'func'\n");
  ...
}
...

const int debug = 1;
...
void debug_print (...)
{
  ...
}
 
void func (void)
{
  if (debug)
    debug_print (...);
  ...
}
...

#define DEBUG 1
 
#if DEBUG == 1
 
void debug_print (...)
{
  ...
}
 
#endif
 
void func (void)
{
#if DEBUG == 1
  debug_print (...);
#endif
 
  ...
}
...

void debug_print (...)
{
  ...
}
 
void func (void)
{
  debug_print (...);
  ...
}
...

<-- то место, которое вырезалось на препроцессировании из-за невыполнения
    условия в директиве #if. На самом деле каждая строка исходного текста
    будет заменена пустой строкой, но я эти пустые строки рисовать не буду,
    чтобы не загромождать текст. В данном случае здесь вырезался текст
    функции debug_print
 
void func (void)
{
<-- здесь вырезался вызов функции debug_print
  ...
}
...

#define BUILD_LITE 1
#define BUILD_MEDIUM 2
#define BUILD_FULL 3
 
/* При сборке должен быть включен только один из этих вариантов */
/* #define BUILD BUILD_LITE */
/* #define BUILD BUILD_MEDIUM */
#define BUILD BUILD_FULL
...
#if BUILD >= BUILD_LITE
/* Данный код подключится при любой конфигурации, но для порядку его
 * надо "подсветить" макросом BUILD. Так проще будет поиском найти все места,
 * которые теоретически зависят от типа сборки, мало ли в будущем мы вместо
 * трёх типов будем использовать пять. */
...
#endif
...
#if BUILD >= BUILD_MEDIUM
/* Данный код подключится в конфигурациях medium и full */
...
#endif
...
#if BUILD == BUILD_FULL
/* Данный код подключится в только в конфигурации full */
...
#endif

#if <условие>
...
#endif

#if <условие>
...
#else
...
#endif

#if <условие>
...
#elif <условие>
...
#elif <условие>
...
#else
...
#endif

/* Пользовательская ошибка N1234. На текущий момент она не исправлена, т.к.
 * это требует много времени, а потому под этим макросом пока сделаем затычки
 * для обхода ошибки */
#define BUG1234
...
 
void func1 (void)
{
  ...
  /* Пишем затычку. В случае наличия или отсутствия отладочных печатей код
   * затычки выглядит по разному */
  #if defined BUG1234
  #if DEBUG == 1
  /* Код затычки в отладочной сборке */
  ...
  #else /* DEBUG */
  /* Код затычки в пользовательской сборке */
  ...
  #endif /* DEBUG */
  #endif /* BUG1234 */
  ...
}
...
void func2 (void)
{
  ...
  /* Здесь ошибка проявляется только в MEDIUM сборке */
  #if (defined BUG1234) && (BUILD == BUILD_MEDIUM)
  /* Код затычки */
  ...
  #endif
  ...
}

#if (defined __i386__) || (defined __alpha__)
/* Архитектуры с little endian */
#define LITTLE_ENDIAN
#elif (defined __sparc__)
/* Архитектуры с big endian */
#define BIG_ENDIAN
#else
#error "unknown architecture"
#endif

/* Наша старая реализация. Условно пишу так, но включение макроса
 * в общем случае может быть под #ifdef */
#define DEBUG
 
...
 
/* Плавный переход на новую реализацию */
#ifndef DEBUG
/* Отсутствие старого макроса означает новый макрос со значением 0 */
#define DEBUG_LEVEL 0
#else
/* Во время переходного периода наличие старого макроса будет означать
 * новый макрос со значением 10. В этом месте дополнительно выдадим
 * предупреждение. Его будут видеть только те, кто активно работает
 * с включенным макросом DEBUG */
#define DEBUG_LEVEL 10
#warning "Макрос DEBUG устаревший, надо заменять его на DEBUG_LEVEL"
#endif
 
/* В новой реализации макрос определён всегда. Поэтому для внутреннего контроля
 * сделаем проверку */
#ifndef DEBUG_LEVEL
#error "Макрос DEBUG_LEVEL не определён"
#endif

#ifdef DEBUG
#error "Макрос DEBUG больше не поддерживается"
#endif