最近工作上遇到一個和 C/C++ 巨集有關的問題。我想要使用巨集將原本呼叫 bcopy 的程式碼導向另一個實作 __bionic_bcopy。所以我寫出以下的程式碼：

#define bcopy __bionic_bcopy

然而這段程式碼會使得部分程式無法被正常地編譯。如果我將上面的 #define 改為：

#define bcopy(src, dst, size) __bionic_copy(src, dst, size)

原本被第一個 #define 弄壞的程式就能被正常地編譯了。然而這兩個 #define 的差異是什麼呢？以下是引起錯誤的程式片段：

builtin.def

#ifndef BUILTIN_LIBC
#define BUILTIN_LIBC(NAME) BUILTIN(NAME)
#endif

BUILTIN_LIBC(bcopy)

builtin.cpp

enum BuiltinFunction {
#define BUILTIN(NAME) BUILTIN_##NAME,
#include "builtin.def"
};

void HandleBuiltin(BuiltinFunction func) {
  if (func == BUILTIN_bcopy) {
    // ...
  }
}

這段程式碼在前置處理（Preprocessing）之後會變成：

enum BuiltinFunction {
  BUILTIN_bcopy,
};

void HandleBuiltin(BuiltinFunction func) {
  if (func == BUILTIN_bcopy) {
    // ...
  }
}

簡單的說，這段程式碼先定義了 BuiltinFunction 列舉，接著 HandleBuiltin 函式會比較參數 func 與 BUILTIN_bcopy。

如果我們在 builtin.cpp 的最前面加上本文第一個 #define：

#define bcopy __bionic_bcopy

enum BuiltinFunction {
#define BUILTIN(NAME) BUILTIN_##NAME,
#include "builtin.def"
};

void HandleBuiltin(BuiltinFunction func) {
  if (func == BUILTIN_bcopy) {
    // ...
  }
}

經過前置處理（Preprocessing）之後，程式碼會變成：

enum BuiltinFunction {
  BUILTIN___bionic_bcopy,
};

void HandleBuiltin(BuiltinFunction func) {
  if (func == BUILTIN_bcopy) {
    // ...
  }
}

因為列舉裡面的 BUILTIN_bcopy 變成 BUILTIN___bionic_bcopy，所以後面的 BUILTIN_bcopy 會被編譯器視為未宣告的識別字，進而產生編譯錯誤。

這裡有兩個巨集展開規則的細節：

1. 當前置處理器在代換一個類函式巨集呼叫（Function-like Macro Invocation）的時候，如果參照 Formal Parameter（型式參數）的地方與 # 或 ## 運算元無關，前置處理器會先展開 Actual Parameter（實際參數），再代入展開後的 Actual Parameter。
2. 當整個類函式巨集呼叫被展開之後，如果展開後的代換序列（Replacement List）仍然包含其他巨集參照，且被參照的巨集不是正在展開過程中的巨集[1]，前置處理器會反覆代換直到沒有可以被代換的巨集參照。

以上面的 builtin.cpp 為例，前置處理器的處理步驟分別是：

1. 因為 BUILTIN_LIBC 是一個類函式巨集，所以要將 builtin.def 裡面的 BUILTIN_LIBC(bcopy) 展開。
2. 將 BUILTIN_LIBC(NAME) 代換為 BUILTIN(NAME)。因為 NAME 和 # 或 ## 無關，所以前置處理器必須先展開 NAME 對應的序列。因為 bcopy 是一個類物件巨集（Object-like Macro），前置處理器會先將 bcopy 展開為 __bionic_bcopy。之後代入 __bionic_bcopy 得到 BUILTIN(__bionic_bcopy)。
3. 因為 BUILTIN 也是一個類函式巨集，所以要進一步展開。
4. 將 BUILTIN(NAME) 代換為 BUILTIN_##NAME,。因為 NAME 的前面有 ## 所以就直接代入 __bionic_bcopy得到 BUILTIN___bionic_bcopy,。
5. 因為 BUILTIN___bionic_bcopy 不是巨集名稱，所以前置處理器的工作到此結束。

那為什麼本文第二個 #define 不會有相同的問題呢？

#define bcopy(src, dst, size) __bionic_copy(src, dst, size)

第二個定義是類函式巨集（Function-like Macro）。如果沒有傳遞參數的刮號，前置處理器就不會展開它們。在上面的例子中，前置處理器在第二步展開「NAME 對應的序列」的時候，依然會保留 bcopy。

#define STR(X) #X
#define XSTR(X) STR(X)

#define CONFIG 4

const char example1[] = STR(CONFIG);  // "CONFIG"
const char example2[] = XSTR(CONFIG);  // "4"

#define PREVENT_MACRO_SUBSTITUTION

namespace test {

template <typename T>
T max PREVENT_MACRO_SUBSTITUTION (T a, T b) {
  using std::max;
  return max PREVENT_MACRO_SUBSTITUTION (a, b);
}

}  // namespace test

#define max(a, b) (((a) > (b)) ? (a) : (b))

#define EXAMPLE(X) (EXAMPLE(X + 1) - EXAMPLE(1))
EXAMPLE(5)

(EXAMPLE(5 + 1) - EXAMPLE(1))

#define IDENTITY(X) X
#define TEST_0(X) IDENTITY(X)
#define TEST_1(X) IDENTITY(TEST_0)(X)
TEST_1(42)