テキストマクロの置換 - cppreference.com

プリプロセッサはテキストマクロの置換をサポートします。 関数ライクなテキストマクロの置換もサポートされます。

構文

説明

#define 指令

#define 指令は identifier をマクロとして定義します。 これは、すべての一連の identifier の出現を replacement-list に置き換えるようコンパイラに指示します。 オプションでさらに処理されることあリます。 識別子がすでに何らかの種類のマクロとして定義されている場合、その定義が同一でなければ、プログラムは ill-formed です。

オブジェクトライクなマクロ

オブジェクトライクなマクロは定義された identifier のすべての出現を replacement-list で置き換えます。 #define 指令のバージョン (1) はまさにそのように動作します。

関数ライクなマクロ

関数ライクなマクロは、定義された identifier のそれぞれの出現を replacement-list で置き換え、さらに任意の数の引数を取り、 replacement-list 内の対応するあらゆる parameters の出現を置き換えます。

関数ライクなマクロの呼び出しの構文は関数呼び出しの構文に似ています。 次のプリプロセッサトークンとして ( が続くマクロ名のそれぞれの実体は、 replacement-list によって置き換えられるトークンの並びを導入します。 この並びは対応する ) トークンによって終了します (間に入る開き括弧と閉じ括弧の対応する組はスキップされます)。

バージョン (2) の場合、実引数の数はマクロ定義内の仮引数の数と同じでなければなりません。 バージョン (3,4) の場合、実引数の数は仮引数の数 (... は数えません) と同じまたは (C++20以上)より多くなければなりません。 そうでなければ、プログラムは ill-formed です。 識別子が関数表記でない場合、すなわち、後に括弧が続かない場合は、一切置換されません。

#define 指令のバージョン (2) は単純な関数ライクなマクロを定義します。

#define 指令のバージョン (3) は可変長引数を持つ関数ライクなマクロを定義します。 追加の引数 (可変長引数と呼ばれます) は、置換される識別子として供給される __VA_ARGS__ を用いてアクセスすることができます。 __VA_ARGS__ は実引数で置換されます。

#define 指令のバージョン (4) は可変長引数を持つけれども正規の引数を持たない関数ライクなマクロを定義します。 引数 (可変長引数と呼ばれます) は、置換される識別子として供給される __VA_ARGS__ でのみアクセスできます。 __VA_ARGS__ は実引数で置換されます。

#define F(...) f(0 __VA_OPT__(,) __VA_ARGS__)
#define G(X, ...) f(0, X __VA_OPT__(,) __VA_ARGS__)
#define SDEF(sname, ...) S sname __VA_OPT__(= { __VA_ARGS__ })
F(a, b, c) // f(0, a, b, c) で置換されます。
F()        // f(0) で置換されます。
G(a, b, c) // f(0, a, b, c) で置換されます。
G(a, )     // f(0, a) で置換されます。
G(a)       // f(0, a) で置換されます。
SDEF(foo);       // S foo; で置換されます。
SDEF(bar, 1, 2); // S bar = { 1, 2 }; で置換されます。

ノート: 関数ライクなマクロの実引数に、対応する開き括弧と閉じ括弧の組で保護されていないコンマが含まれている場合 (一番よくあるケースは assert(std::is_same_v<int, int>); や BOOST_FOREACH(std::pair<int,int> p, m) のようなテンプレートの実引数リストです)、コンマはマクロの実引数の区切りとして解釈されます。 これは実引数の数の不一致によるコンパイルの失敗を発生させます。

予約済みのマクロ名

何らかの標準ライブラリヘッダをインクルードする翻訳単位は、いかなる標準ライブラリヘッダで宣言されている名前も #define または #undef してはなりません。

標準ライブラリの任意の一部を使用する翻訳単位は、以下と字句的に同一な名前を #define または #undef してはなりません。

• キーワード

そうでなければ、動作は未定義です。

# および ## 演算子

関数ライクなマクロにおいて、 replacement-list 内の識別子の前の # 演算子は、引数の置換によって識別子を処理し、その結果を引用符で囲み、実質的に文字列リテラルを作成します。 さらに、プリプロセッサは必要に応じて、埋め込まれる文字列リテラル (もしあれば) の周りの引用符をエスケープするためにバックスラッシュを追加し、文字列内のバックスラッシュを二重化します。 すべての先行および後続するホワイトスペースは除去され、テキストの途中 (埋め込まれた文字列リテラル内部は除く) のホワイトスペースのあらゆる並びは単一のスペースに圧縮されます。 この操作は「文字列化」と呼ばれます。 文字列化の結果が有効な文字列リテラルでない場合、動作は未定義です。

#define showlist(...) puts(#__VA_ARGS__)
showlist();            // puts("") に展開されます。
showlist(1, "x", int); // puts("1, \"x\", int") に展開されます。

replacement-list 内の任意の2つの連続する識別子の間の ## 演算子は、その2つの識別子 (マクロ展開されない) の引数置換を処理し、その後、その結果を連結します。 この操作は「連結」または「トークンの貼り合わせ」と呼ばれます。 合わせて有効なトークンを形成するトークンのみが連結できます。 より長い識別子を形成する識別子、数値を形成する数字、または　+= を形成する + と = 演算子などです。 コメントはマクロ置換が考慮される前にテキストから除去されるため、 / と * を連結してコメントを作ることはできません。 連結の結果が有効なトークンでない場合、動作は未定義です。

ノート: コンパイラによってはコンマの後 __VA_ARGS__ の前に ## が現れることを許容する拡張を提供します。 この場合 ## は可変長引数が存在するとき何もしませんが、可変長引数が存在しないときはコンマを除去します。 これにより fprintf (stderr, format, ##__VA_ARGS__) などのマクロを定義することを可能とします。

#undef 指令

#undef 指令は identifier の定義を解除します。 つまり、 #define 指令による identifier の以前の定義を取り消します。 その識別子に紐付くマクロがない場合、この指令は無視されます。

定義済みのマクロ

以下のマクロ名はすべての翻訳単位であらかじめ定義されています。

処理系によっては以下の追加のマクロ名があらかじめ定義されていることがあります。

(__FILE__ および __LINE__ を除いて) これらのマクロの値は翻訳単位を通して一定に保たれます。 これらのマクロの再定義および定義解除の試みの結果は未定義動作です。

ノート: すべての関数の本体のスコープ内において、その関数の名前を処理系定義の書式で保持する静的な文字配列として定義される、 __func__(C++11以上) という名前の特別な関数ローカルな定義済みの変数が存在します。 これは定義済みのマクロではありませんが、例えば assert によって、 __FILE__ や __LINE__ と一緒に使用されます。

例

#include <iostream>

// 関数ファクトリを作成して、それを使用します。
#define FUNCTION(name, a) int fun_##name() { return a;}

FUNCTION(abcd, 12)
FUNCTION(fff, 2)
FUNCTION(qqq, 23)

#undef FUNCTION
#define FUNCTION 34
#define OUTPUT(a) std::cout << "output: " #a << '\n'

// マクロ定義内でマクロを使用する例。
#define WORD "Hello "
#define OUTER(...) WORD #__VA_ARGS__

int main()
{
    std::cout << "abcd: " << fun_abcd() << '\n';
    std::cout << "fff: " << fun_fff() << '\n';
    std::cout << "qqq: " << fun_qqq() << '\n';
    std::cout << FUNCTION << '\n';
    OUTPUT(million);               //ダブルクォートがないことに注意。

    std::cout << OUTER(World) << '\n';
    std::cout << OUTER(WORD World) << '\n';
}

abcd: 12
fff: 2
qqq: 23
34
output: million
Hello World
Hello WORD World

関連項目