プリプロセス | Programming Place Plus　新C++編

このページの概要 🔗

このページでは、プリプロセスについて説明します。プリプロセスで実行される機能として、ここまでのページでも #include を説明していますが、ほかにも多数の機能が存在しています。このページで、残りのほとんどの機能を取り上げることにします。

このページの解説は C++14 をベースとしています。

以下は目次です。要点だけをさっと確認したい方は、「まとめ」をご覧ください。

• プリプロセス
• マクロ (#define)
  • マクロの効果を打ち切る（#undef）
  • オブジェクト形式マクロ
  • 関数形式マクロ
• #演算子
• ##演算子
• 事前定義マクロ
  • __func__
• #line
• 分岐 (#if、#elif、#else、#endif)
  • #error
• マクロによる分岐 (#ifdef、#ifndef、defined)
• 機能テストマクロ
• プラグマ
• まとめ
• 参考リンク
• 練習問題
• 更新履歴

プリプロセス 🔗

前のページで #include について解説したとき、ビルドの手順の中に、プリプロセスという段階があることに触れました。プリプロセスは、コンパイルの手前の段階で、プリプロセッサというソフトウェアによって行われます。また、プリプロセスを終えたあとのソースファイルを翻訳単位と呼ぶのでした。コンパイルは翻訳単位に対して行われます。

ソースファイルの中で、プリプロセスで処理される箇所のコードは、行の先頭が # で始まるという共通点があります。これはプリプロセッサに与える命令であることを表しており、プリプロセッサディレクティブ（プリプロセッサ指令） (preprocessing directive) と総称されます。

普通、#include のように書きますし、発音するときにも「シャープインクルード」と呼ぶことが多いですが、実は # と include は分離できます（つまり空白が挟まっても構わない）。# で始まる行がプリプロセスで処理される行であり、include はプリプロセッサが解釈できる命令の名前です。

マクロ (#define) 🔗

マクロ (macro) は、プリプロセスの段階で、ソースコード上の文字の並びを、ほかの文字の並びに置換する機能です。

マクロは #define というプリプロセッサディレクティブを使って定義しますが、以下のように２種類の方法があります。

#define マクロ名 置換後の文字の並び
#define マクロ名(仮引数の並び) 置換後の文字の並び

１つ目はオブジェクト形式マクロ (object-like macro)、２つ目は関数形式マクロ (function-like macro) と呼ばれます。それぞれの詳しい解説はあとで行うことにして、まず共通する話をしておきます。

まず、マクロ定義の行末にはコメントを書いても構いません。

【上級】コメント部分を無視する（１つの空白文字に置き換える）タイミングは、プリプロセッサディレクティブが実行される手前のステップなので、プリプロセスに影響はありません。^[3]

「置換後の文字の並び」を複数行にしたい場合がありますが、普通に改行することは許されず、行末（本物の改行文字の直前）に \ を置く必要があります。

#define INIT_POS(pos)  pos.x = 0; \
                       pos.y = 0; \
                       pos.z = 0;

マクロの効果は、#define を記述した場所から、翻訳単位の終わりまで及びます（あるいは後述する #undef が現れるまで）。その間にある「マクロ名」と同じ記述が、「置換後の文字の並び」へと置換されます。

「置換後の文字の並び」は省略できます。これは後述する #if の条件式の中で使用する目的のマクロを定義するときによく取られる方法です。

ヘッダファイルでマクロの定義を行うと、インクルードした側にまで影響が及ぶことに注意してください。予想外のところでソースコードが置換されることになり、トラブルの原因になりえます。マクロ名はすべて大文字とし、すべて大文字の名前はマクロ以外で使わないようにするというガイドラインにしたがうと、トラブルを防げます^[1]。

「仮引数の並び」「置換後の文字の並び」がそれぞれまったく同じであれば、同じ名前のマクロ定義が重複しても許されます。違いがある場合はエラーになります^[2]。

マクロの定義は、ソースファイル上に記述するだけでなく、コンパイラのオプションとして与える方法もあります。Visual Studio での方法は、「Visual Studio編＞プリプロセスで使うマクロを定義する」のページを参照してください。

マクロはかなり強烈な機能であり、危険な面も大きいため、原則としては使わないことを勧めます。ヘッダファイルで定義すると、インクルードされることによって影響範囲が広がるため、特に避けるべきです。ほとんどのケースでは、オブジェクト形式マクロは constexpr変数で代替できますし、関数形式マクロは関数テンプレート（未解説）で代替できます。

#unbef マクロ名

#define CARD_MARK_NUM       4   // マークの総数
#define EACH_MARK_CARD_NUM  13  // 各マークのカードの枚数
#define TRUMP_CARD_NUM      (EACH_MARK_CARD_NUM * CARD_MARK_NUM)  // トランプに含まれるカードの枚数

#define HAND_CARD_NUM (5)          // 避ける
constexpr auto hand_card_num = 5;  // 推奨

#include <iostream>

#define BAD_MACRO     3 + 2
#define BETTER_MACRO  (3 + 2)

int main()
{
    std::cout << BAD_MACRO * 10 << "\n";
    std::cout << BETTER_MACRO * 10 << "\n";
}

23
50

int main()
{
    std::cout << 3 + 2 * 10 << "\n";
    std::cout << (3 + 2) * 10 << "\n";
}

#define PRINT_VALUE(x)  std::cout << x << "\n"
#define PRINT_NAME_AND_VALUE(name, value)  std::cout << name << ": " << value << "\n"
#define PRINT_EMPTY()  std::cout << "\n"

PRINT_VALUE(123);
PRINT_NAME_AND_VALUE("xyz", 400);
PRINT_EMPTY();

#include <iostream>

#define ADD(a, b)  ((a) + (b))

int main()
{
    std::cout << ADD(3, 5) << "\n";
    std::cout << ADD(123LL, -340LL) << "\n";
    std::cout << ADD(2.34, 6.15) << "\n";
}

8
-217
8.49

#include <iostream>

#define BAD_MUL(a, b)  (a * b)
#define BETTER_MUL(a, b)  ((a) * (b))

int main()
{
    std::cout << BAD_MUL(5 + 2, 5) << "\n";
    std::cout << BETTER_MUL(5 + 2, 5) << "\n";
}

15
35

#include <iostream>

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

int main()
{
    int a {10};
    std::cout << MAX(a, 5) << "\n";
    std::cout << MAX(a + 1, 5) << "\n";
    std::cout << MAX(++a, 5) << "\n";
}

10
11
12

#演算子 🔗

置換後の文字の並びの中で、マクロの仮引数の名前の頭に # を付加すると、実引数として渡された内容を文字列にしたものへ置き換えられます。この # は、関数形式マクロでのみ使用できる演算子の一種です。

次のプログラムでは、変数の値を、その変数の名前とともに出力する関数形式マクロを定義しています。

#include <iostream>

#define PRINT(v)    std::cout << #v << " = " << (v) << "\n"

int main()
{
    int x {123};
    double y {3.14};

    PRINT(x);
    PRINT(y);
}

実行結果：

x = 123
y = 3.14

##演算子 🔗

置換後の文字の並びの中で ## を使うと、２つの文字の並びを連結できます。この ## は、マクロでのみ使用できる演算子の一種です。

#include <iostream>

#define VALUE(number)   value ## number

int main()
{
    int value1 {10};
    int value2 {20};
    int value3 {30};

    std::cout << VALUE(1) << "\n";
    std::cout << VALUE(2) << "\n";
    std::cout << VALUE(3) << "\n";
}

実行結果：

10
20
30

VALUE マクロは、value という文字の並びと、仮引数number に渡されてきた文字の並びを連結しています。そのため、VALUE(1) は value ## 1 を意味しており、value1 に置換されます。

マクロの置換はプリプロセスで行われることなので、次のようには書けません。

#include <iostream>

#define VALUE(number)   value ## number

int main()
{
    int value1 {10};
    int value2 {20};
    int value3 {30};

    for (int i = 1; i <= 3; ++i) {
        std::cout << VALUE(i) << "\n";
    }
}

VALUE(i) は value ## i であり、置換結果は valuei です。プリプロセスの時点では i は i でしかありません。これは求めていた結果ではないばかりか、未定義の動作ですらあります。##演算子によって作られる文字の並びは、前処理トークン (preprocessing token) と呼ばれる、意味が特定できる文字の並びでなければ未定義とされているためです^[4]。

前処理トークンは、識別子や各種リテラル、ヘッダファイルの名前といったものです。^[5]

なお、#演算子と ##演算子が両方登場する場合、どちらが先に評価されるかは未規定です^[6]。

事前定義マクロ 🔗

自動的に定義済みになっているマクロがいくつか存在しています。このようなマクロは、事前定義マクロ (predefined macro) と呼ばれ、いつでも使用できます。

代表的な事前定義マクロとして、以下のものがあります。

完全な一覧は規格文書を参照してください。^[7]

__FILE__ と __LINE__ の置換結果は、このあと説明する #line の影響を受けます。

【上級】__DATE__ の置換結果のうち、Mmm（月）にあたる部分は、std::asctime関数によって生成される月の表現と同じものが使われます。dd（日）は必ず２桁分の幅を取り、10未満のときは上位桁が空白文字になります。^[8]

【上級】__TIME__ の置換結果は、std::asctime関数によって生成される表現と同じものが使われます。^[9]

【C++20】std::source_locationクラスが追加され、ソースファイルの名前、行番号、列番号、関数名をまとめて取得、保持できるようになりました^[10]。

#include <iostream>

int main()
{
    std::cout << __FILE__ << "\n";
    std::cout << __LINE__ << "\n";
    std::cout << __DATE__ << "\n";
    std::cout << __TIME__ << "\n";
}

実行結果：

c:\test_program\main.cpp
6
Feb  5 2022
13:22:25

プリプロセスの機能なので、実行するたびに結果が変わるというものではありません。

【上級】__DATE__ と __TIME__ を使っていると、同じソースファイルをコンパイルしても、異なるオブジェクトファイルが生成されることに注意してください。このため、実行可能ファイルも異なるものになります。たとえば複数のプログラマーで開発を行っている場合、ほかの作業者がビルドした結果とは異なるものが生成されることになります。

#include <iostream>

void my_function()
{
    std::cout << __func__ << "\n";
}

int main()
{
    std::cout << __func__ << "\n";
    my_function();

    struct S {
        void operator()() {
            std::cout << __func__ << "\n";
        }
    };
    S s {};
    s();
}

main
my_function
operator ()

#line 🔗

#line は、ソースファイルの行番号や名前を制御します。

#line の使い方は次の２通りあります。

#line 行番号
#line 行番号 ソースファイル名

いずれにしても、#line を記述した行の行番号を「行番号」に指定した数とみなすようにプリプロセッサに指示を与えます。「ソースファイル名」を指定した場合は、同様に #line を記述した行以降のソースファイル名を「ソースファイル名」とみなすようになります。その結果、__FILE__ や __LINE__ の置換結果が影響を受けます。また、処理系がエラーや警告などを報告するときに表示されるソースファイル名や行番号にも影響することがあります。

#include <iostream>

int main()
{
    std::cout << __FILE__ << "\n";
    std::cout << __LINE__ << "\n";

#line 1000 "new_name.cpp"
    std::cout << __FILE__ << "\n";
    std::cout << __LINE__ << "\n";
}

実行結果：

c:\test_program\main.cpp
6
c:\test_program\new_name.cpp
1001

分岐 (#if、#elif、#else、#endif) 🔗

プリプロセスの中で分岐構造を作る方法があり、条件によって、有効にするコードと無効にするコードを切り替えられます。その結果のコードがコンパイルされるため、コンパイルする部分としない部分を作れます。このようにコンパイルを制御することを、条件コンパイル (conditional compilation) と呼びます。

もっとも単純な分岐構造は、#if と #endif によって構築できます。

#if 条件式
    条件式が真のときに有効なコード
#endif

「条件式」の結果が 0 以外になる場合に、「条件式が真のときに有効なコード」の部分は有効であり、コンパイルされることになります。プリプロセスの時点で評価できなければならないため定数式でなければなりません。

通常の if文に対する else は #else で、else if は #elif で表現します。

#if 条件式１
    条件式１が真のときに有効なコード
#elif 条件式２
    条件式１が偽、条件式２が真のときに有効なコード
#else
    条件式１、条件式２がともに偽のときに有効なコード
#endif

以下は使用例です。PROGRAM_MODE の置換後の値を変更してビルドしなおすと、有効になるコードの部分が変化します。

#include <iostream>

#define PROGRAM_MODE    (1)

int main()
{
#if PROGRAM_MODE == 0
    std::cout << "program mode 0.\n";
#elif PROGRAM_MODE == 1
    std::cout << "program mode 1.\n";
#else
    std::cout << "program mode is unknown.\n";
#endif
}

実行結果：

program mode 1.

なお、PROGRAM_MODE を constexpr変数に変えることは不適切であることに注意してください。

#include <iostream>

constexpr auto program_mode = 1;

int main()
{
#if program_mode == 0
    std::cout << "program mode 0.\n";
#elif program_mode == 1
    std::cout << "program mode 1.\n";
#else
    std::cout << "program mode is unknown.\n";
#endif
}

実行結果：

program mode 0.

program_mode の値は 1 ですが、実行結果をみると 0 のときのコードが有効になっていることが分かります。このような結果になるのは、#if の条件式の中で、マクロ名以外の識別子やキーワードは 0 で置き換えられる（true と false だけは例外でそのまま扱われる）というルールがあるためです^[12]。そのため、constexpr変数の名前（＝識別子）である program_mode は 0 に置き換わっており、#if program_mode == 0 のところが真となります。

なお、有効にならない部分のコードはコンパイルされないため、プリプロセスでの分岐構造を、コメントアウトの代わりに用いることがあります（#if 0 ～ #endif で囲む）。/* ～ */ と違って、ネストできる利点があるほか、0 を 1 に変えるだけでアンコメントできる手軽さもあります。

#error エラーメッセージ

#include <iostream>

#define PROGRAM_MODE    (2)

int main()
{
#if PROGRAM_MODE == 0
    std::cout << "program mode 0.\n";
#elif PROGRAM_MODE == 1
    std::cout << "program mode 1.\n";
#else
    #error "program mode is unknown.\n";
#endif
}

1>  main.cpp
1>c:\test_program\main.cpp(12): fatal error C1189: #error:  "program mode is unknown.\n";

マクロによる分岐 (#ifdef、#ifndef、defined)

プリプロセスによる分岐にはもう１種類あって、マクロが定義されているかどうかを判断基準にします。

#ifdef はマクロが定義されているかどうか、#ifndef はマクロが定義されていないかどうかを判定します。いずれも #else を加えることが可能です。

#ifdef マクロ名
    マクロが定義されているときに有効なコード
#endif

#ifndef マクロ名
    マクロが定義されていないときに有効なコード
#endif

#undef によって定義が消されている場合、そこから後ろの位置では「定義されていない」とみなされます。

#if と defined を組み合わせて実現することもできます。defined は、指定したマクロが定義されていたら 1 に、定義されていなければ 0 になります。

#if defined(マクロ名)
    マクロが定義されているときに有効なコード
#endif

// ( ) はなくても同じ
#if defined マクロ名
    マクロが定義されているときに有効なコード
#endif

こうした分岐の制御のためだけに使うマクロは、置換後の結果には興味がないので、「置換後の文字の並び」を省略して定義することもあります。

#define DEBUG_MODE
#ifdef DEBUG_MODE
// ...
#endif

次のサンプルは、標準入力から５つの整数を受け取り、その合計を出力するだけの簡単なプログラムです。NEGATIVE_NUMBER_NOT_ALLOW マクロが定義されているときには、負数をエラーとして扱うようにします。

#include <iostream>

#define NEGATIVE_NUMBER_NOT_ALLOW   // 有効な場合、負数を許可しない

int main()
{
    int total_values {0};

    for (int i = 0; i < 5; ++i) {

#ifdef NEGATIVE_NUMBER_NOT_ALLOW
        std::cout << "Please enter the integer greater than or equal to 0.\n";
#else
        std::cout << "Please enter the integer.\n";
#endif

        int value {};
        std::cin >> value;

#ifdef NEGATIVE_NUMBER_NOT_ALLOW
        if (value < 0) {
            std::cout << "error.\n";
            return 1;
        }
#endif

        total_values += value;
    }

    std::cout << "total: " << total_values << "\n";
}

実行結果：

Please enter the integer greater than or equal to 0.
3  <-- 入力した内容
Please enter the integer greater than or equal to 0.
5  <-- 入力した内容
Please enter the integer greater than or equal to 0.
-1  <-- 入力した内容
error.

実行結果（NEGATIVE_NUMBER_NOT_ALLOW を定義しない場合）：

Please enter the integer.
3  <-- 入力した内容
Please enter the integer.
5  <-- 入力した内容
Please enter the integer.
-1  <-- 入力した内容
Please enter the integer.
2  <-- 入力した内容
Please enter the integer.
-3  <-- 入力した内容
total: 6

機能テストマクロ 🔗

C++ の規格バージョンが上がるたびに、新機能が増えたり、仕様に変更が入ったりしますが、コンパイラがそうした変更を実装するまでには時間がかかるため、たとえば C++14 で追加された機能の一部は実装済みだが、ほかの機能はまだ実装されていないという状況が生まれるのはよくあることです。

どの機能が実装されているかどうかを確認できるように、機能テストマクロ (feature test macro) という仕組みがあります。その機能が実装されている場合にかぎって、その機能と対応した名称の機能テストマクロが定義されるので、#ifdef などを使って確認することで、機能の実装状況に応じてコードを書きわけられます。

機能テストマクロはオブジェクト形式マクロになっており、仕様が作られた年月を意味する整数リテラルに置換されます（たとえば 201304 のような）。のちのバージョンで機能に更新が加えられた場合に、機能テストマクロの置換結果も、新しい年月を意味するものに変更されることがあります。そのため、#if と == を使って、置換後の値を調べると失敗する可能性があります。置換後の値まで調べる必要性がないかぎり、#ifdef や #if defined を使って、定義の有無だけを確認すればいいです。

機能テストマクロには、標準ヘッダで定義されるものと、どこからでも使えるように定義されるものとがあります。種類が多いので、当サイトでは１つ１つ取り上げて解説しませんので、詳細はリファレンスサイトなどで確認してください。以下にリンク（外部サイト）をまとめておきます。

C++14 で追加された機能である、関数の戻り値型の型推論（「関数から値を返す」のページを参照）の場合の例を上げておきます。この機能に対応した機能テストマクロは __cpp_return_type_deduction です。

#ifdef __cpp_return_type_deduction
// 戻り値型の型推論が使える
auto getline_from_stdin()
{
    std::string s {};
    std::getline(std::cin, s);
    return s;
}
#else
// 戻り値型の型推論が使えない
std::string getline_from_stdin()
{
    std::string s {};
    std::getline(std::cin, s);
    return s;
}
#endif

プラグマ 🔗

最後にプラグマ (pragma) を紹介します。プラグマは、処理系が独自に実装している、標準でない機能を使うための構文で、次のように #pragma を使って記述します。

#pragma *****

***** の部分は、使おうとする機能によって異なります。標準のものではないため、処理系のドキュメントを確認するなどして理解しなければなりません。

【上級】解説は省きますが、#pramga を #define の「置換後の文字の並び」のところで使えない問題を解決する方法として、_Pragma演算子があります^[13]。

比較的よく認知されているプラグマとして、#pragma once があります。これはインクルードガード（「ヘッダファイル」のページを参照）を簡単に実現します。ヘッダファイルの先頭に #pragma once と記述するだけで、インクルードガードの役割を果たします。

#pragma once

// ほかのコード

主要なコンパイラではインクルードガードとして機能しますが、あくまでも処理系定義の機能です。これを認識しないコンパイラでは、単にこの記述を無視するかもしれません。

まとめ 🔗

• 先頭が # で始まる行は、プリプロセッサに与える命令を表しており、プリプロセッサディレクティブと呼ばれる
• #define はマクロを定義する。マクロは、プリプロセスの段階でソースコードの文字の並びを置き換える
  • 単に文字の並びの置き換えのみを行うマクロを、オブジェクト形式マクロと呼ぶ
  • 関数のように引数を指定でき、その指定を踏まえた置き換えを行うマクロを、関数形式マクロと呼ぶ
  • #define の効力は、翻訳単位の終わりにまで及ぶ。あるいは、#undef で打ち切られる
  • マクロの名前はすべて大文字に、またそれ以外のことにはすべて大文字の名前を使わないようにすると、意図しない置換によるトラブルを軽減できる
  • マクロは危険な面もあるため、可能なかぎり、constexpr変数、関数テンプレート、インライン関数といった別の手段で代替すると良い
• #演算子は、関数形式マクロに渡された実引数を文字列化する
• ##演算子は、２つの文字の並びを連結する
• あらかじめ定義されている __FILE__、__LINE__、__DATE__、__TIME__ といった事前定義マクロと、__func__ という事前定義変数がある
  • #line はソースファイルの行番号と名前を制御する
• #if、#else、#elif、#endif によって、プリプロセス中で分岐構造を実現できる
• #ifdef、#ifndef、#if defined も分岐構造を実現する。こちらは任意のマクロが定義されているかどうかを条件とする
• #error は強制的にエラーを起こす
• 機能テストマクロの定義を調べることで、新しい機能が実装されているかどうかを確認できる
• #pragma は、処理系の独自機能を使うために用いられる

新C++編の【本編】の各ページには、末尾に練習問題があります。ページ内で学んだ知識を確認する簡単な問題から、これまでに学んだ知識を組み合わせなければならない問題、あるいは更なる自力での調査や模索が必要になるような高難易度な問題をいくつか掲載しています。

参考リンク 🔗

• 1. NL.9: Use ALL_CAPS for macro names only | C++ Core Guidelines
• 2. C++ standard working draft N4140 16.3 Macro replacement - 2 | 14882: Contents
• 3. C++ standard working draft N4140 2.2 Phases of translation | 14882: Contents
  • コメントの置き換えは phase 3 に、プリプロセッサディレクティブの実行は phase 4 にある
• 4. C++ standard working draft N4140 16.3.3 The ## operator - 3 | 14882: Contents
• 5. C++ standard working draft N4140 2.5 Preprocessing tokens | 14882: Contents
• 6. C++ standard working draft N4140 16.3.2 The # operator - 2 | 14882: Contents
• 7. C++ standard working draft N4140 16.8 Predefined macro names | 14882: Contents
• 8. C++ standard working draft N4140 16.8 Predefined macro names (1.2) | 14882: Contents
• 9. C++ standard working draft N4140 16.8 Predefined macro names (1.6) | 14882: Contents
• 10. source_location - cpprefjp C++日本語リファレンス
• 11. C++ standard working draft N4140 8.4.1 In general - 8 | 14882: Contents
• 12. C++ standard working draft N4140 16.1 Conditional inclusion - 4 | 14882: Contents
  • “(略) all remaining identifiers and keywords, except for true and false, are replaced with the pp-number 0, (略)” とある
• 13. Pragma演算子 - cpprefjp C++日本語リファレンス
• Programming Place Plus　新C++編　参考書籍
  • 当サイトの参考書籍一覧ページ。C++ に関する書籍を多数紹介
• Programming Place Plus　新C++編　リンク集
  • 当サイトの参考Webサイト集。C++ の全般的な学習に有益なサイトを紹介

練習問題 🔗

問題の難易度について。

• (確認★) このページの内容の理解を確認する問題
• (基本★～★★) このページの内容を使って解く問題
• (応用★★～★★★) このページまでに学んだことを活用して、現実的な問題を解決する問題
• (調査★★～★★★) 自力で情報を探したり、模索したりする問題
• (発展★★★) プログラムの改善など、より上を目指すような問題

★は、すべての方が取り組める入門レベルの問題です。
★★は、自力でプログラミングができるようなるために、入門者の方であっても取り組んでほしい問題です。
★★★は、本格的にプログラマーを目指す人のための問題です。

void print_source_location()
{
    std::cout << "File: " << __FILE__ << "  Line: " << __LINE__ << "  Func: " << __func__ << "\n";
}

更新履歴 🔗

• ’2023/2/18
  • 分岐のプリプロセッサディレクティブについて、その意味の説明を修正
  • 実行結果が、ほかのプログラムのものになっている箇所があったのを修正
• ’2022/11/20
  • 「機能テストマクロ」を追加
• ’2022/2/13
  • 新規作成

• 次のページへ（アサート）
• 前のページへ（ヘッダファイル）
• 新C++編のトップページへ
• Programming Place Plus のトップページへ