【C言語】プリプロセッサ（マクロ）とは

悩んでいる人

C言語のプリプロセッサ（マクロ）を教えて！

こういった悩みにお答えします．

本記事の信頼性

リアルタイムシステムの研究歴12年．
東大教員の時に，英語でOS（Linuxカーネル）の授業．
2012年9月～2013年8月にアメリカのノースカロライナ大学チャペルヒル校（UNC）コンピュータサイエンス学部で客員研究員として勤務．C言語でリアルタイムLinuxの研究開発．
プログラミング歴15年以上，習得している言語: C/C++，Python，Solidity/Vyper，Java，Ruby，Go，Rust，D，HTML/CSS/JS/PHP，MATLAB，Assembler (x64，ARM)．
東大教員の時に，C++言語で開発した「LLVMコンパイラの拡張」，C言語で開発した独自のリアルタイムOS「Mcube Kernel」をGitHubにオープンソースとして公開．
2020年1月～現在はアメリカのノースカロライナ州チャペルヒルにあるGuarantee Happiness LLCのCTOとしてECサイト開発やWeb/SNSマーケティングの業務．2022年6月～現在はアメリカのノースカロライナ州チャペルヒルにあるJapanese Tar Heel, Inc.のCEO兼CTO．
最近は自然言語処理AIとイーサリアムに関する有益な情報発信に従事．

（AI全般を含む）自然言語処理AIの論文の日本語訳や，AIチャットボット（ChatGPT，Auto-GPT，Gemini（旧Bard）など）の記事を50本以上執筆．アメリカのサンフランシスコ（広義のシリコンバレー）の会社でプロンプトエンジニア・マネージャー・Quality Assurance（QA）の業務委託の経験あり．
（スマートコントラクトのプログラミングを含む）イーサリアムや仮想通貨全般の記事を200本以上執筆．イギリスのロンドンの会社で仮想通貨の英語の記事を日本語に翻訳する業務委託の経験あり．

こういった私から学べます．

C言語を独学で習得することは難しいです．

私にC言語の無料相談をしたいあなたは，公式LINE「ChishiroのC言語」の友だち追加をお願い致します．

私のキャパシティもあり，一定数に達したら終了しますので，今すぐ追加しましょう！

独学が難しいあなたは，元東大教員がおすすめするC言語を学べるオンラインプログラミングスクール5社で自分に合うスクールを見つけましょう．後悔はさせません！

: 元東大教員がおすすめするC言語を学べるオンラインプログラミングスクール5社

こういった悩みにお答えします．こういった私が解説していきます．私が大学の授業で初めてC言語を勉強した時は全然できませんでしたが，先生やTA，友人に相談しながら一生懸命C言語を勉強してできるようにな ...

続きを見る

C言語のプリプロセッサ（マクロ）とは

プリプロセッサ（マクロ）とは，C言語でコンパイルする前の処理（プリプロセス）を行うプログラムのことです．

プリプロセッサは，マクロ置換（記号定数，引数付きマクロ）や，ファイルの取り込み（インクルード）等を行います．

また，プリプロセッサには，if文に相当するような簡単な制御構造があり，条件付きコンパイル等が行えます．

プリプロセッサは，処理を行単位で行います．

プリプロセッサへの指示を行うための予約語は，最初の文字が’#’で必ず始まります．

ここで，#の前に空白はあってもよいです．

’#’が最初に付いているトークン（token：文字綴り）から始まる行は，プリプロセッサにより何らかの処理をされて，コンパイラに渡されます．

これらの行は，C言語の残りの部分とは文法的に独立しています．

また，プリプロセッサの適用範囲は，ファイルの全て（最初から最後まで）です．

C言語のプリプロセッサには以下の予約語があります．

#define
#undef
#include
#if
#elif
#else
#ifdef
#ifndef
#endif
#line
#error
#pragma
#

※#lineは行番号を変更する機能なので，基本的には使わない方が無難です．

それでは，これらを組み合わせたマクロの使い方を紹介していきます．

#include：ファイルの取り込み

ファイルの取り込み（インクルード）は

#include <filename>

1	#include <filename>

または

#include “filename”

1	#include “filename”

で行えます．

ファイルをインクルードすると，その位置にファイルが埋め込まれるので，読み込まれたファイルがその場所に記述されていた場合と同じ処理をします．

filenameを<>で囲むと，処理系の規則に従いヘッダファイルがあるパスが検索されます．例えば，UNIXの処理系の場合，/usr/include等のデフォルトのディレクトリや環境変数「C_INCLUDE_PATH」で指定したディレクトリ等が検索されます．

filenameを””で囲むと，まず現在のディレクトリが検索され，次に上記の処理系の規則に従ったパスが検索されます．

また，インクルードされるファイルにさらに#includeがあっても構いません．

つまり，#includeはネスト（入れ子）が可能です．

また，ファイルへの取り込みはヘッダファイル（*.h）だけでなくソースファイル（*.c）も可能です．

インクルードするファイルは，関数プロトタイプ宣言やグローバル変数のextern宣言をまとめたヘッダファイルにするのが一般的です．

ヘッダファイルをインクルードする全てのソースファイルで共通して利用できるため，ファイル間の不整合によるバグを除去できます．

#define：マクロ置換

マクロ置換は#defineで行います．

#defineはトークンの置換を行っているにすぎないことを，きちんと理解しましょう．

記号定数マクロ

記号定数マクロのコードは以下になります．

MACROトークンを5と定義しています．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

#define MACRO 5

int main(void)
{
  printf("This is a MACRO(%d).\n", MACRO);

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#define MACRO 5

int main(void)

{

printf("This is a MACRO(%d).\n", MACRO);

return 0;

}

実行結果は以下になります．

MACROトークンの値が5と出力されていることがわかります．

$ gcc define_macro.c 
$ a.out 
This is a MACRO(5).

$ gcc define_macro.c

$ a.out

This is a MACRO(5).

マクロの入れ子（多重定義）

マクロは，入れ子ができます（多重定義）．

例えば，以下のトークンを定義した場合を説明します．

#define A B
#define B C

1 2	#define A B #define B C

まず，コード中のAは，Bに置換されます．

次に，BはCに置換されるので，最終的にAはCに置換されます．

多重定義では，どちらが先に定義されているかは関係ありません．

下記のように逆順で定義する場合でも，AはCに置換されます．

プリプロセッサは置換の際の不整合が生じないように何回もスキャンします．

#define B C
#define A B

1 2	#define B C #define A B

マクロの入れ子（多重定義）した定数を出力するコードは以下になります．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

#define C 1
#define A B
#define B C

int main(void)
{
  printf("A = %d\n", A);
  printf("B = %d\n", B);
  printf("C = %d\n", C);

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#define C 1

#define A B

#define B C

int main(void)

{

printf("A = %d\n", A);

printf("B = %d\n", B);

printf("C = %d\n", C);

return 0;

}

実行結果は以下になります．

全ての出力結果が1になっていることがわかります．

$ gcc define_macro_nested.c
$ a.out 
A = 1
B = 1
C = 1

$ gcc define_macro_nested.c

$ a.out

A = 1

B = 1

C = 1

マクロ関数（引数付きマクロ）

#defineは単なる文字列の置換だけでなくマクロ関数（引数付きのマクロ）を定義することで，柔軟なコードを書くことができます．

例えば，2乗を求めるsquareマクロ関数を定義します．

以下のように書くと，引数xの2乗を返すsquareマクロ関数を定義できます．

#define square(x) ((x) * (x))

1	#define square(x) ((x) * (x))

square関数マクロの利用例は以下になります．

y = square(3);

1	y = square(3);

上記のコードは，下記のように展開されて，2乗を計算します．

y = ((3) * (3));

1	y = ((3) * (3));

このように，マクロの良い点は関数のように引数の型に依存しないことです．

つまり，squareは，int型でもdouble型でも利用できます．

※マクロはC++言語のテンプレートと似ています．

int型で同じ動作をする関数は以下のコードです．

int square(int x)
{
  return x * x;
}

int square(int x)

{

return x * x;

}

関数呼び出しの場合，レジスタの退避や復帰処理のようなオーバーヘッドが発生してしまいます．

これに対して，マクロ関数の場合，単に展開され置換されるだけなのでオーバーヘッドがなく，関数より高速に処理できます．

その分，マクロ関数を利用すると，メモリサイズが大きくなる傾向にあります．

プリプロセッサ（マクロ）の副作用

マクロはテキストを単に置換しますが，それに伴う副作用があります．

例えばsqr関数マクロを以下のように定義した場合を考えてみましょう．

#define sqr(x) x * x

1	#define sqr(x) x * x

例えば，以下のように計算するとします．

※正しい計算結果は5^2 = 25になります．

y = sqr(2 + 3);

1	y = sqr(2 + 3);

この場合，プリプロセッサは以下のように展開します．

y = 2 + 3 * 2 + 3;

1	y = 2 + 3 * 2 + 3;

計算結果は11となり，正しい計算結果の25になりません．

#define square(x) ((x) * (x))

1	#define square(x) ((x) * (x))

上記のマクロ関数squareのように定義するとプリプロセッサは以下のように展開し，正しい計算結果25となります．

y = ((2 + 3) * (2 + 3));

1	y = ((2 + 3) * (2 + 3));

このようにマクロを利用するとカッコ（）の使い方が重要になります．

あなたがマクロを利用してコードを書く時は，十分に気をつけて下さい．

カッコの使い方が正しかったとしても，以下の場合はどうなるでしょうか？

y = square(++x);

1	y = square(++x);

この場合，プリプロセッサは以下のように展開します．

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

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

これでは，yの値もxの値も間違って計算してしまいます．

マクロを上手に書き換えれば避けられるわけではなく，マクロの本質的な問題（副作用）になります．

したがって，マクロを利用する時は正しく理解することが重要になります．

squareとsqr関数マクロのコードを実行して動作を確認してみましょう．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

#define square(x) ((x) * (x))
#define sqr(x) x * x

int main(void)
{
  int x, y;

  y = sqr(2 + 3);
  printf("sqr(2 + 3) = %d\n", y);

  y = square(2 + 3);
  printf("square(2 + 3) = %d\n", y);

  x = 2;
  y = square(++x);
  printf("x = 2, square(++x) = %d, x = %d\n", y, x);

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#define square(x) ((x) * (x))

#define sqr(x) x * x

int main(void)

{

int x, y;

y = sqr(2 + 3);

printf("sqr(2 + 3) = %d\n", y);

y = square(2 + 3);

printf("square(2 + 3) = %d\n", y);

x = 2;

y = square(++x);

printf("x = 2, square(++x) = %d, x = %d\n", y, x);

return 0;

}

実行結果は以下になります．

コンパイル時に21行目でマクロ関数square内でインクリメントを利用しているので，未定義の動作になる警告が出ています（2～10行目）．

14行目のマクロ関数squareの実行結果は16（=4^2）になり，実行後のxの値は4になっています．（9（=3^2）になりません．）

変数xが前置インクリメントを2回実行してしまったことが原因です．

このように，マクロの副作用が発生することを正しく理解しましょう．

$ gcc define_macro_side_effects.c
define_macro_side_effects.c: In function 'main':
define_macro_side_effects.c:21:14: warning: operation on 'x' may be undefined [-Wsequence-point]
    7 | #define square(x) ((x) * (x))
      |                    ~~~
......
   21 |   y = square(++x);
define_macro_side_effects.c:7:21: note: in definition of macro 'square'
    7 | #define square(x) ((x) * (x))
      |                     ^
$ a.out 
sqr(2 + 3) = 11
square(2 + 3) = 25
x = 2, square(++x) = 16, x = 4

$ gcc define_macro_side_effects.c

define_macro_side_effects.c: In function 'main':

define_macro_side_effects.c:21:14: warning: operation on 'x' may be undefined [-Wsequence-point]

7 | #define square(x) ((x) * (x))

| ~~~

......

21 | y = square(++x);

define_macro_side_effects.c:7:21: note: in definition of macro 'square'

7 | #define square(x) ((x) * (x))

| ^

$ a.out

sqr(2 + 3) = 11

square(2 + 3) = 25

x = 2, square(++x) = 16, x = 4

マクロの副作用によるバグを避けるために，現在のC言語の実装ではインライン関数が好まれます．

squareをインライン関数で定義すると以下になります．

square関数の定義の前に「static inline」が追加されていることを確認して下さい．

static inline int square(int x)
{
  return x * x;
}

static inline int square(int x)

{

return x * x;

}

インライン関数で実装することで，マクロと同様にコンパイラはsquare関数を展開した高速なプログラムを生成します．

しかし，インライン関数も通常の関数と同様に型を指定する必要があること，コンパイラの最適化オプションやメモリサイズの制約等により展開されずに通常の関数と同じ動作になることがありますので注意して下さい．

#undef，#define：トークンの再定義

トークンの再定義をしたい場合，#undef，#defineを組み合わせて利用します．

以前に定義されていたトークンがある場合，同じトークンを#defineで定義をするとコンパイルエラーになってしまうので，#undefで一度トークンを削除して，#defineで同じトークンを定義します．

トークンの再定義は，明示的に定義したトークンを利用したい場合（定義を上書きしたい場合）に使います．

OSトークンの再定義は以下のコードです．

7行目に#defineでOSを"Windows"と定義，8行目に#undefでOSの定義を削除，8行目に#defineでOSを"Linux"と定義しています．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

#define OS "Windows"
#undef OS
#define OS "Linux"

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

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#define OS "Windows"

#undef OS

#define OS "Linux"

int main(void)

{

printf("OS = %s\n", OS);

return 0;

}

実行結果は以下になります．

再定義された"Linux"が出力されていることがわかります．

$ gcc undef_define.c 
$ a.out 
OS = Linux

$ gcc undef_define.c

$ a.out

OS = Linux

ここで，コードの7行目の#defineをコメントアウトしても正常に動作することに注意して下さい．

#undefはマクロが定義されていた場合は削除しますが，未定義の場合は何も削除しません．

8行目の#undefをコメントアウトしたら，以下のようにコンパイル時に警告が発生します（2～7行目）．

実行すると再定義された"Linux"が出力されます（9行目）．

$ gcc undef_define.c
undef_define.c:9: warning: "OS" redefined
    9 | #define OS "Linux"
      | 
undef_define.c:7: note: this is the location of the previous definition
    7 | #define OS "Windows"
      | 
$ a.out 
OS = Linux

$ gcc undef_define.c

undef_define.c:9: warning: "OS" redefined

9 | #define OS "Linux"

undef_define.c:7: note: this is the location of the previous definition

7 | #define OS "Windows"

$ a.out

OS = Linux

行末に「\」：複数行のマクロと副作用を回避するdo while文

ファイルのオープンやクローズ等もお決まりのパターンなので，マクロにしてみましょう．

例えば，以下のようにfile_openマクロ関数を定義したとします．

#define file_open(fp, fname, mode, errno) if ((fp = fopen(fname, mode)) == NULL) { fprintf(stderr, “Error: cannot open %s\n”, fname); exit(errno); }

1	#define file_open(fp, fname, mode, errno) if ((fp = fopen(fname, mode)) == NULL) { fprintf(stderr, “Error: cannot open %s\n”, fname); exit(errno); }

このマクロ関数file_openの引数は以下になります．

第1引数fp：ファイルポインタ
第２引数fname：ファイル名
第3引数mode：モード
第4引数errno：エラーコード

ファイル名がfnameのファイルをモードmodeでオープンし，ファイルポインタをfpに代入します．

ファイルオープンに失敗した時にはメッセージを出力した後にexit関数を利用したエラーコードerrnoで強制終了します．

これらの一連の処理は，ファイルをオープンする時には必ず行うのでマクロ関数にするメリットはあります．

しかし，上記のマクロは1行で書かれていてとても読みにくいですよね．

プログラムの開発効率や保守性という観点から考えると，読みやすさも重要です．

そこで，#defineで定義が長くなる場合は行末に「\」を置けば次の行に続けることができます．

この機能により，上記のマクロ関数は以下のように定義できます．

#define file_open(fp, fname, mode, errno)              \
  if ((fp = fopen(fname, mode)) == NULL) {             \
    fprintf(stderr, “Error: cannot open %s\n”, fname); \
    exit(errno);                                       \
  }

#define file_open(fp, fname, mode, errno) \

if ((fp = fopen(fname, mode)) == NULL) { \

fprintf(stderr, “Error: cannot open %s\n”, fname); \

exit(errno); \

}

このように記述すれば，行の終わりに「\」が置かれる以外は，普通のC言語のプログラムと同じです．

こちらの方が，とても読みやすいですよね．

しかし，このマクロは失敗することがあります．

関数を呼び出す際には，最後にセミコロン;を書くためです．

するとマクロを展開した時に，最後のセミコロンが冗長になってしまいますが，場所によっては邪魔になり，副作用（予期せぬ結果）を引き起こすことがあります．

以下に副作用が発生するコードを紹介します．

引数を1個（argcは2）入力し，そのファイルを読み込む処理をしています．

引数が1個以外の場合はprint_usage関数を呼び出してexit関数で強制終了します．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>
#include <stdlib.h>

#define file_open(fp, fname, mode, errno)               \
  if ((fp = fopen(fname, mode)) == NULL) {              \
    fprintf(stderr, "Error: cannot open %s\n", fname);  \
    exit(errno);                                        \
  }

void print_usage(char *s)
{
  fprintf(stderr, "Error: %s filename\n", s);
  exit(2);
}

int main(int argc, char *argv[])
{
  FILE *fp;

  /* *INDENT-OFF* */
  if (argc == 2)
    file_open(fp, argv[1], "r", 1);
  else
    print_usage(argv[0]);
  /* *INDENT-ON* */

  /* do something... */

  fclose(fp);
  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#include <stdlib.h>

#define file_open(fp, fname, mode, errno) \

if ((fp = fopen(fname, mode)) == NULL) { \

fprintf(stderr, "Error: cannot open %s\n", fname); \

exit(errno); \

}

void print_usage(char *s)

{

fprintf(stderr, "Error: %s filename\n", s);

exit(2);

}

int main(int argc, char *argv[])

{

FILE *fp;

/* *INDENT-OFF* */

if (argc == 2)

file_open(fp, argv[1], "r", 1);

else

print_usage(argv[0]);

/* *INDENT-ON* */

/* do something... */

fclose(fp);

return 0;

}

上記のコードは，一見すると正常にコンパイルできそうですが，以下のようにコンパイルエラーになります．

$ gcc define_macro_multiple_lines.c 
define_macro_multiple_lines.c: In function 'main':
define_macro_multiple_lines.c:27:3: error: 'else' without a previous 'if'
   27 |   else
      |   ^~~~

$ gcc define_macro_multiple_lines.c

define_macro_multiple_lines.c: In function 'main':

define_macro_multiple_lines.c:27:3: error: 'else' without a previous 'if'

27 | else

| ^~~~

この理由として，このプログラムのmain関数は以下のように展開されるからです．

int main(int argc, char *argv[])
{
  FILE *fp;

  /* *INDENT-OFF* */
  if (argc == 2)
    if ((fp = fopen(argv[1], "r")) == NULL) {
      fprintf(stderr, "Error: cannot open %s\n", argv[1]);
      exit(1);
    };
  else
    print_usage(argv[0]);
  /* *INDENT-ON* */

  /* do something... */

  fclose(fp);
  return 0;
}

int main(int argc, char *argv[])

{

FILE *fp;

/* *INDENT-OFF* */

if (argc == 2)

if ((fp = fopen(argv[1], "r")) == NULL) {

fprintf(stderr, "Error: cannot open %s\n", argv[1]);

exit(1);

};

else

print_usage(argv[0]);

/* *INDENT-ON* */

/* do something... */

fclose(fp);

return 0;

}

file_open関数マクロで展開された部分（上記の7～10行目）をよく見てみましょう．

10行目の最後にセミコロン;が入っていることがわかります．

これが副作用になって，正常にコンパイルできませんでした．

このセミコロンを除去した場合でも，11行目のelse文は6行目のif文に対する処理ではなく，7行目のfile_openマクロのif文に対する処理になってしまいます．

なので，コンパイルは成功しても正常に実行できません．

そこで，以下のようにdo while文を利用すると，この副作用を防ぐことができます．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>
#include <stdlib.h>

#define file_open(fp, fname, mode, errno) do {            \
    if ((fp = fopen(fname, mode)) == NULL) {              \
      fprintf(stderr, "Error: cannot open %s\n", fname);  \
      exit(errno);                                        \
    }                                                     \
  } while (0)

void print_usage(char *s)
{
  fprintf(stderr, "Error: %s filename\n", s);
  exit(2);
}

int main(int argc, char *argv[])
{
  FILE *fp;

  /* *INDENT-OFF* */
  if (argc == 2)
    file_open(fp, argv[1], "r", 1);
  else
    print_usage(argv[0]);
  /* *INDENT-ON* */

  /* do something... */

  fclose(fp);
  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#include <stdlib.h>

#define file_open(fp, fname, mode, errno) do { \

if ((fp = fopen(fname, mode)) == NULL) { \

fprintf(stderr, "Error: cannot open %s\n", fname); \

exit(errno); \

} \

} while (0)

void print_usage(char *s)

{

fprintf(stderr, "Error: %s filename\n", s);

exit(2);

}

int main(int argc, char *argv[])

{

FILE *fp;

/* *INDENT-OFF* */

if (argc == 2)

file_open(fp, argv[1], "r", 1);

else

print_usage(argv[0]);

/* *INDENT-ON* */

/* do something... */

fclose(fp);

return 0;

}

※防御的プログラミングにより，if文に複文のカッコ「{}」を利用して複文にする方法でも可能です．

実行結果は以下になります．

※何もしていないので何も出力されません．

$ gcc define_macro_multiple_lines_do_while.c
$ a.out define_macro_multiple_lines.c 
$

$ gcc define_macro_multiple_lines_do_while.c

$ a.out define_macro_multiple_lines.c

#if，#elif，#else，#error，#endif：条件付きコンパイル

#if，#elif，#else，#error，#endifを利用した条件付きコンパイルを紹介していきます．

OSTYPEの値によりOSトークンを定義するコードは以下になります．

OSTYPEとOSの関係は，0の場合は"Windows"，1の場合は"Linux"，2の場合は"Mac OS X"になります．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

#if OSTYPE == 0
#define OS "Windows"
#elif OSTYPE == 1
#define OS "Linux"
#elif OSTYPE == 2
#define OS "Mac OS X"
#else
#error "Unknown OS"
#endif

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

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#if OSTYPE == 0

#define OS "Windows"

#elif OSTYPE == 1

#define OS "Linux"

#elif OSTYPE == 2

#define OS "Mac OS X"

#else

#error "Unknown OS"

#endif

int main(void)

{

printf("OS = %s\n", OS);

return 0;

}

実行結果は以下になります．

gccの-DオプションでOSTYPEマクロを0に設定するためには，-DOSTYPE=0と書きます．

OSTYPEの値によりOSの文字列の出力結果が異なることがわかります．

$ gcc conditional_compile.c -DOSTYPE=0
$ a.out 
OS = Windows
$ gcc conditional_compile.c -DOSTYPE=1
$ a.out 
OS = Linux
$ gcc conditional_compile.c -DOSTYPE=2
$ a.out
OS = Mac OS X

$ gcc conditional_compile.c -DOSTYPE=0

$ a.out

OS = Windows

$ gcc conditional_compile.c -DOSTYPE=1

$ a.out

OS = Linux

$ gcc conditional_compile.c -DOSTYPE=2

$ a.out

OS = Mac OS X

また，-DOSTYPE=3と設定すると，14行目の#errorが実行されてコンパイルエラーになります．

このように#elseと#errorを組み合わせると，不正な値を定義した場合のエラーチェックに役立ちます．

※if文，else if文のあとに続くelse文のような使い方です．

$ gcc conditional_compile.c -DOSTYPE=3
conditional_compile.c:14:2: error: #error "Unknown OS"
   14 | #error "Unknown OS"
      |  ^~~~~
conditional_compile.c: In function 'main':
conditional_compile.c:19:23: error: 'OS' undeclared (first use in this function)
   19 |   printf("OS = %s\n", OS);
      |                       ^~
conditional_compile.c:19:23: note: each undeclared identifier is reported only once for each function it appears in

$ gcc conditional_compile.c -DOSTYPE=3

conditional_compile.c:14:2: error: #error "Unknown OS"

14 | #error "Unknown OS"

| ^~~~~

conditional_compile.c: In function 'main':

conditional_compile.c:19:23: error: 'OS' undeclared (first use in this function)

19 | printf("OS = %s\n", OS);

| ^~

conditional_compile.c:19:23: note: each undeclared identifier is reported only once for each function it appears in

ここで，OSTYPEを未定義の場合にどうなるのか実行してみましょう．

$ gcc conditional_compile.c           
$ a.out 
OS = Windows

$ gcc conditional_compile.c

$ a.out

OS = Windows

OS = Windowsと出力されました．

これは，C言語の仕様では，#ifで未定義マクロを参照した場合，0として評価します．

つまり，OSTYPEを0として評価したので，7行目の#ifが真になり，8行目でOSを"Windows"と定義しました．

未定義なのに正常にコンパイルできてしまうと不正な動作をしてしまうかもしれないので，不安ですよね．

そこで，未定義マクロを参照していることを発見するためには，コンパイルオプションで-Wundefを設定します．

-Wundefオプションを付けてコンパイルすると下記のようにOSTYPEが未定義という警告が発生していることがわかります．

$ gcc conditional_compile.c -Wundef
conditional_compile.c:7:5: warning: "OSTYPE" is not defined, evaluates to 0 [-Wundef]
    7 | #if OSTYPE == 0
      |

$ gcc conditional_compile.c -Wundef

conditional_compile.c:7:5: warning: "OSTYPE" is not defined, evaluates to 0 [-Wundef]

7 | #if OSTYPE == 0

また，7行目のOSTYPE == 0をOSTYPE == 10（0～2以外の値）に変更した後にコンパイルするとエラーになることがわかります．

$ gcc conditional_compile.c 
conditional_compile.c:14:2: error: #error "Unknown OS"
   14 | #error "Unknown OS"
      |  ^~~~~
conditional_compile.c: In function 'main':
conditional_compile.c:19:23: error: 'OS' undeclared (first use in this function)
   19 |   printf("OS = %s\n", OS);
      |                       ^~
conditional_compile.c:19:23: note: each undeclared identifier is reported only once for each function it appears in

$ gcc conditional_compile.c

conditional_compile.c:14:2: error: #error "Unknown OS"

14 | #error "Unknown OS"

| ^~~~~

conditional_compile.c: In function 'main':

conditional_compile.c:19:23: error: 'OS' undeclared (first use in this function)

19 | printf("OS = %s\n", OS);

| ^~

conditional_compile.c:19:23: note: each undeclared identifier is reported only once for each function it appears in

#if defined，#ifdef：定義済みマクロかどうか判定

トークンが定義されているかどうか判定したい場合には，#if + definedと#ifdefを利用します．

#if definedのコード

#if + definedを利用したコードは以下になります．

前述のOSの名前を判定する場合を修正したものです．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

#if defined(WINDOWS)
#define OS "Windows"
#elif defined(LINUX)
#define OS "Linux"
#elif defined(MACOSX)
#define OS "Mac OS X"
#else
#error "Unknown OS"
#endif

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

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#if defined(WINDOWS)

#define OS "Windows"

#elif defined(LINUX)

#define OS "Linux"

#elif defined(MACOSX)

#define OS "Mac OS X"

#else

#error "Unknown OS"

#endif

int main(void)

{

printf("OS = %s\n", OS);

return 0;

}

実行結果は以下になります．

-Dオプションの使い方が，-DWINDOWSのように少し変更しているので注意して下さい．

$ gcc conditional_compile_if_defined.c -DWINDOWS
$ a.out 
OS = Windows
$ gcc conditional_compile_if_defined.c -DLINUX  
$ a.out 
OS = Linux
$ gcc conditional_compile_if_defined.c -DMACOSX
$ a.out 
OS = Mac OS X

$ gcc conditional_compile_if_defined.c -DWINDOWS

$ a.out

OS = Windows

$ gcc conditional_compile_if_defined.c -DLINUX

$ a.out

OS = Linux

$ gcc conditional_compile_if_defined.c -DMACOSX

$ a.out

OS = Mac OS X

WINDOWS，LINUX，MACOSXトークンのいずれも未定義の場合は，コンパイルエラーになります．

#ifのみの利用する場合（definedを利用しない場合）と比較すると，定義し忘れやタイポを発見できるメリットがあります．

防御的プログラミングの観点では，#if + definedの方が推奨されます．

$ gcc conditional_compile_if_defined.c         
conditional_compile_if_defined.c:14:2: error: #error "Unknown OS"
   14 | #error "Unknown OS"
      |  ^~~~~
conditional_compile_if_defined.c: In function 'main':
conditional_compile_if_defined.c:19:23: error: 'OS' undeclared (first use in this function)
   19 |   printf("OS = %s\n", OS);
      |                       ^~
conditional_compile_if_defined.c:19:23: note: each undeclared identifier is reported only once for each function it appears in

$ gcc conditional_compile_if_defined.c

conditional_compile_if_defined.c:14:2: error: #error "Unknown OS"

14 | #error "Unknown OS"

| ^~~~~

conditional_compile_if_defined.c: In function 'main':

conditional_compile_if_defined.c:19:23: error: 'OS' undeclared (first use in this function)

19 | printf("OS = %s\n", OS);

| ^~

conditional_compile_if_defined.c:19:23: note: each undeclared identifier is reported only once for each function it appears in

#ifdefのコード

#ifdefでもトークンが定義されているかどうか判定できますが，#elif definedと同じ意味の予約語がないことに注意して下さい．（いわゆる#elifdefはありません．）

なので，#elifでも利用できる#if + definedの方が柔軟性が高いです．

もちろん#ifdef + #elif definedと書くことはできますが，あまり使いません．

#ifdefは通常は#elifが不要な場合に利用します．

#ifdefを使うメリットは，#if + definedより文字数が少ないのでスッキリ書けることです．

#ifdefのコードは以下になります．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

#ifdef OSTYPE
#define OS "Linux"
#else
#error "Unknown OS"
#endif

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

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#ifdef OSTYPE

#define OS "Linux"

#else

#error "Unknown OS"

#endif

int main(void)

{

printf("OS = %s\n", OS);

return 0;

}

実行結果は以下になります．

$ gcc conditional_compile_ifdef.c -DOSTYPE
$ a.out 
OS = Linux

$ gcc conditional_compile_ifdef.c -DOSTYPE

$ a.out

OS = Linux

OSTYPEトークンが未定義の場合はコンパイルエラーになります．

$ gcc conditional_compile_ifdef.c         
conditional_compile_ifdef.c:10:2: error: #error "Unknown OS"
   10 | #error "Unknown OS"
      |  ^~~~~
conditional_compile_ifdef.c: In function 'main':
conditional_compile_ifdef.c:15:23: error: 'OS' undeclared (first use in this function)
   15 |   printf("OS = %s\n", OS);
      |                       ^~
conditional_compile_ifdef.c:15:23: note: each undeclared identifier is reported only once for each function it appears in

$ gcc conditional_compile_ifdef.c

conditional_compile_ifdef.c:10:2: error: #error "Unknown OS"

10 | #error "Unknown OS"

| ^~~~~

conditional_compile_ifdef.c: In function 'main':

conditional_compile_ifdef.c:15:23: error: 'OS' undeclared (first use in this function)

15 | printf("OS = %s\n", OS);

| ^~

conditional_compile_ifdef.c:15:23: note: each undeclared identifier is reported only once for each function it appears in

#ifndef，#define，#endif，#pragma once：インクルードガード

ヘッダファイル（*.h）でよく利用されるインクルードガードを紹介します．

インクルードガードとは，ヘッダファイルを多重にインクルードして，コンパイルエラーになることを防ぐ手法です．

インクルードガードは以下の2種類が使われますので，それぞれ説明していきます．

#ifndef，#define，#endif
#pragma once

#ifndef，#define，#endifによるインクルードガード

#ifndef，#define，#endifによるインクルードガードは，古典的によく利用される手法です．

あなたがよく利用するstdio.hファイルにも利用されています．

stdio.hの中身を見てみましょう．

以下のように#ifndef，#define，#endifが利用されていることがわかります．

$ cat /usr/include/stdio.h

...

#ifndef _STDIO_H
#define _STDIO_H   

...

#endif /* <stdio.h> included.  */

$ cat /usr/include/stdio.h

...

#ifndef _STDIO_H

#define _STDIO_H

...

#endif /* <stdio.h> included. */

インクルードガードの仕組みを説明します．

まず，stdio.hファイルを読み込む時に，_STDIO_Hは未定義とします．

#ifndefで_STDIO_Hトークンが未定義なので真になり（5行目），#defineで_STDIO_Hトークンを定義し（6行目），#endifでヘッダファイルの中身を挟みます（10行目）．

次に，stdio.hもう一度読み込もうとする場合，_STDIO_Hは定義済みなので#ifndefは偽になります．

このようにヘッダファイルを1度しか読まない仕組みを作るのがインクルードガードです．

#ifndef，#define，#endifによるインクルードガードのヘッダとコードは以下になります．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#ifndef __INLUCDE_GUARD_IFNDEF__
#define __INLUCDE_GUARD_IFNDEF__

struct data {
  int c;
};

#endif

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#ifndef __INLUCDE_GUARD_IFNDEF__

#define __INLUCDE_GUARD_IFNDEF__

struct data {

int c;

};

#endif

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>
#include "include_guard_ifndef.h"

int main(void)
{
  struct data d = {1};

  printf("d.c = %d\n", d.c);

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#include "include_guard_ifndef.h"

int main(void)

{

struct data d = {1};

printf("d.c = %d\n", d.c);

return 0;

}

実行結果は以下になります．

$ gcc include_guard_ifndef.c 
$ a.out 
d.c = 1

$ gcc include_guard_ifndef.c

$ a.out

d.c = 1

#pragma onceによるインクルードガード

#pragma onceによるインクルードガードを紹介します．

ヘッダファイルの先頭に#pragma onceと書くだけでお手軽に利用できます．

#pragma onceによるヘッダとコードは以下になります．

ヘッダは#pragma onceを利用した方が短く書けることがわかります（行数が12行から9行に削減）．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#pragma once

struct data {
  int c;
};

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#pragma once

struct data {

int c;

};

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>
#include "include_guard_pragma_once.h"

int main(void)
{
  struct data d = {1};

  printf("d.c = %d\n", d.c);

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#include "include_guard_pragma_once.h"

int main(void)

{

struct data d = {1};

printf("d.c = %d\n", d.c);

return 0;

}

実行結果は以下になります．

$ gcc include_guard_pragma_once.c 
$ a.out 
d.c = 1

$ gcc include_guard_pragma_once.c

$ a.out

d.c = 1

#演算子：文字列化

文字列化する#演算子を紹介します．

マクロ関数の引数に演算子を#記号をつけて定義することで，文字列（すなわちダブルクォーテーション「"」で挟んだ状態）に置換します．

#演算子は，以下のように書きます．

※stringifyは「文字列化する」という意味の英語です．

#define STRINGIFY(str) #str

1	#define STRINGIFY(str) #str

#演算子を利用したコードは以下になります．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

#define PRINTF(str) printf(#str "\n")
#define STRINGIFY(str) #str

int main(void)
{
  PRINTF(Hello World!);
  printf("%s\n", STRINGIFY(stringify));

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#define PRINTF(str) printf(#str "\n")

#define STRINGIFY(str) #str

int main(void)

{

PRINTF(Hello World!);

printf("%s\n", STRINGIFY(stringify));

return 0;

}

実行結果は以下になります．

PRINTFマクロ関数はHello World!をダブルクォーテーションで挟んでいませんが，正常にコンパイルして実行できていることがわかります．

$ gcc stringify.c 
$ a.out 
Hello World!
stringify

$ gcc stringify.c

$ a.out

Hello World!

stringify

#演算子による置換は，文字列内にダブルクォーテーション「"」が頻繁に出てくる場合に便利です．

文字列内で「"」を出力したい場合は毎回「\"」と書かなければなりませんが，#演算子を利用すれば必要はありません．

文字列内に「"」があるコードは以下になります．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

#define PRINTF(str) printf(#str "\n")

int main(void)
{
  PRINTF(Hello "C" World!);
  printf("Hello \"C\" World!\n");

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#define PRINTF(str) printf(#str "\n")

int main(void)

{

PRINTF(Hello "C" World!);

printf("Hello \"C\" World!\n");

return 0;

}

実行結果は以下になります．

上記のコードのPRINTFマクロ関数（11行目）とprintf関数（12行目）は，下記の3～4行目に示すように，同じ出力結果になります．

$ gcc stringify2.c 
$ a.out 
Hello "C" World!
Hello "C" World!

$ gcc stringify2.c

$ a.out

Hello "C" World!

##演算子：トークンの連結

トークンを連結する##演算子を紹介します．

トークンを連結するとは，名前（例：変数名）を指定するのに2つの文字をくっつけて1つの文字に置換することです．

上記のトークンを連結するために「左辺 ## 右辺」と##演算子を利用します．

例えば，「c ## 11」と指定すると，c11に置換されます．

##演算子を利用したコードは以下になります．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

#define c(i) printf("c" #i " = %d\n" , c ## i)

int main(void)
{
  int c11 = 11, c17 = 17;

  c(11);
  c(17);

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#define c(i) printf("c" #i " = %d\n" , c ## i)

int main(void)

{

int c11 = 11, c17 = 17;

c(11);

c(17);

return 0;

}

実行結果は以下になります．

$ gcc token_concatenation.c 
$ a.out 
c11 = 11
c17 = 17

$ gcc token_concatenation.c

$ a.out

c11 = 11

c17 = 17

gccで-Eオプションを付けてコンパイルすると以下のようにプリプロセッサ処理後のコードが読めます．

##演算子を利用した場合，printf関数の中身が正しく展開できていることがわかります．

$ gcc token_concatenation.c -E
... # 長いので省略
int main(void)
{
  int c11 = 11, c17 = 17;

  printf("c" "11" " = %d\n" , c11);
  printf("c" "17" " = %d\n" , c17);

  return 0;
}

$ gcc token_concatenation.c -E

... # 長いので省略

int main(void)

{

int c11 = 11, c17 = 17;

printf("c" "11" " = %d\n" , c11);

printf("c" "17" " = %d\n" , c17);

return 0;

}

#if 0を利用したコメントの入れ子

C言語の文法にある/* */のコメントは入れ子できませんでした．

例えば，以下のようにfunc関数を定義した場合，コンパイルエラーになります．

/*
void func(void)
{
  /*
  int a = 123;
  */
}
*/

void func(void)

{

int a = 123;

}

そこで，#if 0は真偽値が必ず偽になることを利用して，#endifまでをコンパイル時に無視できます．

この機能を応用するとコメントを入れ子できます．

#if 0による入れ子したコメントは以下になります．

#if 0
void func(void)
{
#if 0
  int a = 123;
#endif
}
#endif

#if 0

void func(void)

{

#if 0

int a = 123;

#endif

}

#endif

#if 0によるコメントは便利なので，是非使いましょう！

FILE，func，LINE：C言語の組込みマクロ

C言語の組込みマクロとして，以下の3つをよく使います．

__FILE__：ファイル名
__func__：関数名
__LINE__：行番号

デバッグの時に利用してみましょう．

__FILE__，__func__，__LINE__を利用したコードは以下になります．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>

int main(void)
{
  printf("%s:%s():%d: Hello World!\n", __FILE__, __func__, __LINE__);

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

int main(void)

{

printf("%s:%s():%d: Hello World!\n", __FILE__, __func__, __LINE__);

return 0;

}

実行結果は以下になります．

9行目のprintf関数で，embedded_macro.cファイル，main関数，ファイルの9行目という情報が正しく出力されていることがわかります．

$ gcc embedded_macro.c
$ a.out 
embedded_macro.c:main():9: Hello World!

$ gcc embedded_macro.c

$ a.out

embedded_macro.c:main():9: Hello World!

printfデバッグ

あなたがデバッグする時によく利用するprintfデバッグを紹介します．

printfデバッグは，本記事で学んだ以下の内容の集大成になります．

行末に「\」：複数行のマクロと副作用を回避するdo while文
#if defined，#ifdef：定義済みマクロかどうか判定
#pragma onceによるインクルードガード
##演算子：トークンの連結
__FILE__，__func__，__LINE__：C言語の組込みマクロ

printfデバッグのヘッダとコードは以下になります．

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#pragma once

#ifdef DEBUG

#define PDEBUG(fmt, args...) do {  \
    fprintf(stderr, fmt, ## args); \
  } while (0)

#define PDEBUG_WHERE(fmt, args...) do {                      \
    PDEBUG("%s:%s():%d: ", __FILE__, __func__, __LINE__);    \
    PDEBUG(fmt, args);                                       \
  } while (0)


#else

#define PDEBUG(fmt, args...)

#define PDEBUG_WHERE(fmt, args...)

#endif

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#pragma once

#ifdef DEBUG

#define PDEBUG(fmt, args...) do { \

fprintf(stderr, fmt, ## args); \

} while (0)

#define PDEBUG_WHERE(fmt, args...) do { \

PDEBUG("%s:%s():%d: ", __FILE__, __func__, __LINE__); \

PDEBUG(fmt, args); \

} while (0)

#else

#define PDEBUG(fmt, args...)

#define PDEBUG_WHERE(fmt, args...)

#endif

/*
 * Author: Hiroyuki Chishiro
 * License: 2-Clause BSD
 */
#include <stdio.h>
#include "printf_debug.h"

int main(void)
{
  int a = 123;

  PDEBUG("This is PDEBUG. a = %d\n", a);
  PDEBUG_WHERE("This is PDEBUG_WHERE. a = %d\n", a);

  return 0;
}

* Author: Hiroyuki Chishiro

* License: 2-Clause BSD

#include <stdio.h>

#include "printf_debug.h"

int main(void)

{

int a = 123;

PDEBUG("This is PDEBUG. a = %d\n", a);

PDEBUG_WHERE("This is PDEBUG_WHERE. a = %d\n", a);

return 0;

}

実行結果は以下になります．

-DDEEBUGオプションの有無で，printfデバッグによる変数aの値の出力が変化することがわかります．

$ gcc printf_debug.c -DDEBUG
$ a.out 
This is PDEBUG. a = 123
printf_debug.c:main():21: This is PDEBUG_WHERE. a = 123
$ gcc printf_debug.c
$ a.out
$

$ gcc printf_debug.c -DDEBUG

$ a.out

This is PDEBUG. a = 123

printf_debug.c:main():21: This is PDEBUG_WHERE. a = 123

$ gcc printf_debug.c

$ a.out

私がよく利用するprintfデバッグですので，是非利用してC言語の開発を効率化しましょう．

もちろん，上記のコードを応用してあなただけのprintfデバッグを開発しても構いません．

また，printfデバッグだけでなく，GDBも利用して開発を効率化したいあなたは，【無料】元東大教員がおすすめするC言語の開発ツール2選をあわせて読むことをおすすめします．

: 【C言語】Makeの使い方

こういった悩みにお答えします．こういった私が解説していきます． C言語はPython，Ruby，HTML/CSS/JS/PHPのようなアプリケーション系の言語と比較して難易度が高いですよね．私がC ...

続きを見る

まとめ

C言語のプリプロセッサ（マクロ）の使い方を紹介しました．

本記事に書いてある内容がわかれば，C言語のマクロを神レベルで使いこなせます．

一度読んでわからないところがあれば，何度も読んでマクロを習得しましょう．

C言語を独学で習得することは難しいです．

私にC言語の無料相談をしたいあなたは，公式LINE「ChishiroのC言語」の友だち追加をお願い致します．

私のキャパシティもあり，一定数に達したら終了しますので，今すぐ追加しましょう！

: 元東大教員がおすすめするC言語を学べるオンラインプログラミングスクール5社

こういった悩みにお答えします．こういった私が解説していきます．私が大学の授業で初めてC言語を勉強した時は全然できませんでしたが，先生やTA，友人に相談しながら一生懸命C言語を勉強してできるようにな ...

続きを見る

【C言語】プリプロセッサ（マクロ）とは

元東大教員がおすすめするC言語を学べるオンラインプログラミングスクール5社

C言語のプリプロセッサ（マクロ）とは

#include：ファイルの取り込み

#define：マクロ置換

記号定数マクロ

マクロの入れ子（多重定義）

マクロ関数（引数付きマクロ）

プリプロセッサ（マクロ）の副作用

#undef，#define：トークンの再定義

行末に「\」：複数行のマクロと副作用を回避するdo while文

#if，#elif，#else，#error，#endif：条件付きコンパイル

#if defined，#ifdef：定義済みマクロかどうか判定

#if definedのコード

#ifdefのコード

#ifndef，#define，#endif，#pragma once：インクルードガード

#ifndef，#define，#endifによるインクルードガード

#pragma onceによるインクルードガード

#演算子：文字列化

##演算子：トークンの連結

#if 0を利用したコメントの入れ子

__FILE__，__func__，__LINE__：C言語の組込みマクロ

printfデバッグ

【C言語】Makeの使い方

まとめ

元東大教員がおすすめするC言語を学べるオンラインプログラミングスクール5社

FILE，func，LINE：C言語の組込みマクロ