More C++ Idioms/インクルードガードマクロ(Include Guard Macro)

出典: フリー教科書『ウィキブックス(Wikibooks)』
移動: 案内検索

インクルードガードマクロ(Include Guard Macro)[編集]

意図[編集]

複数回ヘッダファイルをインクルードすることを防止する。

別名[編集]

動機[編集]

同一のヘッダファイルを同じ翻訳単位にインクルードすることは問題となる。 なぜなら、C++ の基本規則である単一定義規則(One Definition Rule(ODR))に違反するからである。 ヘッダファイルは直接あるいは間接的なインクルードによって複数回インクルードされるかもしれない。

解法とサンプルコード[編集]

インクルードガードマクロ(Include Guard Macro)イディオムは C でも適用可能な古いイディオムである。 ある翻訳単位で複数回ヘッダファイルをインクルードすることを防ぐために、単純な #define を使う。 以下のようなマクロを、ヘッダファイルの先頭と末尾に置く(訳註:__ で開始する名前は実装に予約されている)。

#ifndef __MYHEADER_H // 先頭
#define __MYHEADER_H 
...
#endif // __MYHEADER_H // 末尾

コンパイラによっては

#pragma once

を、インクルードガードの効率的な代替手段としてサポートしている場合がある。 伝統的なインクルードガードマクロとは異なり、2 回以上ヘッダファイルを開く必要がない。

既知の利用[編集]

事実上、世界中の全てのヘッダファイル!

関連するイディオム[編集]