C言語 define マクロ【数値に名前を付ける意味とメリット】

こんにちは、ナナです。

プリプロセッサ３大機能のうちの１つdefine機能による「マクロ定義」について解説しましょう。

マクロ定義は「定数」というものに名前を与えるための機能です。名前を作り出すことでどのようなメリットがあるのかを学んでいきましょう。

本記事では次の疑問点を解消する内容となっています。

では、「マクロ定義」機能の使い方を学んでいきましょう。

「プリプロセッサ」が、そもそも何かわからない方は『C言語 プリプロセッサ【絶対知るべき3大機能を順に解説する】』の記事を先に見ておくとよいでしょう。

defineによる「マクロ定義」とはどのような機能なのか？

「マクロ定義」は、数値に名前を付けるための機能です。

皆さんがプログラムの中で扱う値に、任意の名前を与えることができるのです。では、名前を付けることに、いったいどのような便利さがあるのでしょうか？

定数とマジックナンバー

皆さん、次のプログラムの「printPrice関数」が、いったい何をする関数なのかわかりますか？

#include <stdio.h>

void printPrice(int kind)
{
　　switch (kind)
　　{
　　case 0:
　　　　printf("250円\n");
　　　　break;

　　case 1:
　　　　printf("100円\n");
　　　　break;

　　case 2:
　　　　printf("400円\n");
　　　　break;
　　}
}

int main(void)
{
　　printPrice(2);
　　return 0;
}

print（印字）price（価格）という関数名から、何かの価格を表示するための関数であろうことは想像できますね。

このプログラムの中で登場する「１」や「２」といった、値を変えられない数値のことを「定数ていすう」と呼びます。

では、これらの定数の数に込められた意味がみなさんにはわかりますか？

わかりませんよね。そうは当然です。この数値の意味は私が知っているだけで、皆さんにその数値の意味を教えていないのですから、わかるわけがありません。

このように他の人から見て、意味の分からない定数のことを「マジックナンバー」と呼びます。

マジックナンバーが多用されたプログラムは解析が困難であり、メンテナンス作業が大変になります。プログラムは人が読むものでもあるということを、決して忘れてはいけません。

「マクロ定義」とは、このようなマジックナンバーを防止するために使用する機能です。

define マクロの定義方法

さぁ、名人より素敵なあだ名をいただいたところで、マクロ定義の方法を学びましょう。

マクロ定義の書き方

マジックナンバーに名前を付けることができるのが「マクロ定義」です。マクロ定義は次のように行います。

定数を示す「マクロ定義名」は、慣例として全て大文字の名前で定義します。

値の後にセミコロンはつけません。うっかり間違えてセミコロンを付けると予期せぬビルドエラーになり、原因がわからなくて困ることがあるので注意しましょう。

define マクロを定義するメリット

メリット①　名前を付けたことによる可読性の向上

次のプログラムは、先ほどのプログラムをマクロ定義を使って書き換えたものです。

皆さん今度のプログラムは理解できるのではないでしょうか。

マジックナンバーをマクロ定義名に置き換えたことにより、人が見て理解のできるプログラムに変わります。

#include <stdio.h>

#define D_KIND_APPLE_ID     (0)
#define D_KIND_BANANA_ID    (1)
#define D_KIND_PEACH_ID     (2)

void printPrice(int kind)
{
    switch (kind)
    {
    case D_KIND_APPLE_ID:
        printf("250円\n");
        break;

    case D_KIND_BANANA_ID:
        printf("100円\n");
        break;

    case D_KIND_PEACH_ID:
        printf("400円\n");
        break;
    }
}

int main(void)
{
    printPrice(D_KIND_PEACH_ID);
    return 0;
}

あえてコメントは入れてありませんが、内容は理解できましたよね。このプログラムはマクロ定義を使わないものと全く同じ動作をします。

マクロ定義である「#define」とは、プリプロセッサにより

プログラム中に書かれたマクロ定義名を、値へと置換する「文字列の置換機能」

なのです。

皆さん自身がソースコードの中からマクロ定義名の文字列を見つけて、値へとコピー＆ペーストするのと同じことをプリプロセッサは行うのです。

マクロ定義を使うことで、開発者は数値に意味を与えることができ、可読性の高いソースコードを作ることができます。

メリット②　定数値の一括変更

マクロ定義は値に名前を付けられるメリット以外にも便利な用途があります。

それは、定数値の一括変更です。

先ほどのプログラムでリンゴのIDの値を「０」から「５」に仕様変更しなければならなくなりました。

この場合、皆さんはリンゴの「０」をプログラムから検索し、「５」に変更しなければなりません。

この時に注意しなければならないのが、「０」という数値はリンゴのID以外にもプログラムの中で使用されることがあり得るということです。

そのため、プログラムを解析し「リンゴの０」を表している数値のみを、漏れなく変更しなければなりません。プログラム規模が大きくなると、この作業は困難になります。

この問題はマクロ定義を行っておくことで簡単に解決します。

マクロ定義の値を編集するだけで、すべてのリンゴの番号は「５」に置換されます。そして、リンゴの番号とは無関係な「０」の値には影響がありません。

このように数値というのは後からメンテナンスしようとするほど困難になっていきます。

最初にプログラムを作りこむときに、しっかりとマクロ定義を行うことで未来の作業が楽になるのです。

define 関数マクロの定義方法と使い方

マクロ定義の中には「関数マクロ」と呼ばれる機能が存在します。

関数マクロの書き方

「関数マクロ」は皆さんがこれまで作ってきた関数を、マクロ定義で作るというものです。

とはいっても規模の大きい関数というものではなく、「関数で作るほどでもないが、ちょっとした処理がしたいな」という時に定義します。

プログラムでは次のように使用することで展開結果に置き換わります。

プログラムの中ではあたかも関数呼び出しかのように書かれていますが、実際は関数ではないのが関数マクロの特徴です。

関数マクロの定義例その①：三角形の面積算出

#include <stdio.h>

//  三角形の面積を求める関数マクロ
#define  triangle(base, high)  ((base) * (high) / 2.0)

int main(void)
{
    double  area;

    //  面積の算出と表示
    //  ((10.0) * (30.0) / 2.0) へ置換
    area = triangle(10.0, 30.0);
    printf("%lf\n", area);

    return 0;
}

関数マクロの定義例その②：三角形の面積算出

#include <stdio.h>

//  正方形の面積を求める
#define square(side)    ((side) * (side))

int main(void)
{
    double  area;

    //  面積の算出と表示
    //  ((20.0) * (20.0)) へ置換
    area = square(20.0);
    printf("%lf\n", area);

    return 0;
}

defineとは文字列の置換であると解説しましたが、それは関数マクロでも同じです。

ルールに従い文字を指定の形式に置換するのが関数マクロなのです。

マクロの副作用に注意

マクロ定義は使い方を誤ると、思わぬ結果に置換されるため注意が必要です。

これを「マクロの副作用」と呼びます。

代表的な副作用が発生するケースを紹介します。次の関数マクロを定義したとします。

本来面積は（10.0＋5）×（30.0 ＋ 2）÷ 2.0 ⇒ 240.0になるはずですが、計算結果は161.0になってしまいました。

これがマクロの副作用です。副作用を避けたいのであれば少し面倒ですが、各引数要素と全体を（）で値を括ってあげることです。

マクロ定義でも関数マクロでも値を（）で括ってあげることにより、副作用を発生しないようにできます。

マクロ定義は単純な文字列置換であることを知っておきましょう。

Q&A：define マクロ定義に関するよくある質問

Q：マクロ定義の名前の先頭に「D_」ってついてるのはなぜ？

本記事に登場するマクロ定義の名前は「D_KIND_APPLE_ID」のように先頭に「D_」がくっついています。

これは、Defineの「D」を示しており、頭に付けるので「接頭語」と呼びます。

このように名前にルール付けをすることで、皆が同じ認識でプログラムを見られるようになります。「D_～」を見たら「あぁ、これはマクロ定義だな～」といった形で認識するのです。

実際の開発の中でも、名前の付け方にルールを設けることで可読性を向上させる活動をすることは珍しくありません。

Q：定数定義には列挙型もあったが、マクロ定義との切り分けは？

C言語において定数の作り方がいくつかあります。代表的な定数定義がマクロ定義とenumです。

まず、enumについてですが、値が正数値でないといけないという制限があり、浮動小数点は定義できません。

それに対しマクロ定義にはそのような制約がなく、次のように浮動小数点のマクロ定義も作ることができます。

#define     PI  (3.141592)  //　円周率

代表的な浮動小数点のマクロである円周率のPIです。

さらに、マクロ定義とは実は数値である必要性すらありません。次のように文字列を定義することもできます。

#include <stdio.h>

//  文字列をマクロ定義
#define  D_HELLO  "Hello"

int main(void)
{
    printf("%s\n", D_HELLO);

    return 0;
}

マクロ定義は「定義名」を単に「値」に置き換える機能です。その仕組みを知った上で利用することです。

結論としてenumとマクロ定義の使い分けの基準ですね。

「enumは正数値で重複しない連番を作りたい時に使う、それ以外の定数はマクロ定義」と覚えておくとよいでしょう。

enumについて知りたい方は『C言語 enum 列挙型【連番の作り方と使いどころを教えます】』の記事も参考にしてください。

課題：define マクロ定義が学べたかを確認しよう

課題１

#include <stdio.h>

int main(void)
{
    double len;

    // 円周取得
    len = getCircleLength(2.8 + 1.4);

    printf("%lf\n", len);

    return 0;
}

26.389373

#include <stdio.h>

#define D_PI  (3.141592)

double getCircleLength(double radius)
{
     return 2 * D_PI * radius;
}

int main(void)
{
    double len;

    // 円周取得
    len = getCircleLength(2.8 + 1.4);

    printf("%lf\n", len);

    return 0;
}

課題２

CIRCLE_LEN(r)

#include <stdio.h>

int main(void)
{
    double len;

    // 円周取得
    len = getCircleLength(2.8 + 1.4);
    printf("%lf\n", len);

    // 円周取得
    len = CIRCLE_LEN(2.8 + 1.4);
    printf("%lf\n", len);

    return 0;
}

26.389373
26.389373

#include <stdio.h>

#define D_PI            (3.141592)
#define CIRCLE_LEN(r)   (2 * D_PI * (r))

double getCircleLength(double radius)
{
     return 2 * D_PI * radius;
}

int main(void)
{
    double len;

    // 円周取得
    len = getCircleLength(2.8 + 1.4);
    printf("%lf\n", len);

    // 円周取得
    len = CIRCLE_LEN(2.8 + 1.4);
    printf("%lf\n", len);

    return 0;
}