once pragma

  • [アーティクル]

ソース コード ファイルをコンパイルするときに、コンパイラがヘッダー ファイルを 1 回だけインクルードすることを指定します。

構文

#pragma once

解説

#pragma once を使用すると、翻訳単位でファイルの最初の#include の実行後にコンパイラで同じファイルを再度開いて読み込むことがないので、ビルド時間を短縮できます。 これは、複数インクルードの最適化と呼ばれます。 プリプロセッサのマクロ定義を使用してファイルの内容が複数回インクルードされないようにする、include guard 表現形式と同様の効果があります。 またこれは、単一定義規則の違反を防止するのにも役立ちます。単一定義規則とは、コード内のすべてのテンプレート、型、関数、オブジェクトに 2 つ以上の定義が含まれてはならないという要件です。

次に例を示します。

// header.h
#pragma once
// Code placed here is included only once per translation unit

新しいコードには #pragma once ディレクティブを使用することをお勧めします。これを使えば、プリプロセッサ シンボルによるグローバル名前空間のポリューションが発生しないためです。 入力が少ないため、混乱が少なく、シンボルの競合が発生することはありません。 シンボルの競合は、異なるヘッダー ファイルでガード値と同じプリプロセッサシンボルが使用されている場合に発生するエラーです。 これは C++ の標準の一部ではありませんが、いくつかの一般的なコンパイラにより移植可能な方法で実装されます。

同じファイルで include guard 表現形式と #pragma once の両方を使用する利点はありません。 コメントではないコードまたはプリプロセッサ ディレクティブが標準的な表現形式の前後にくる場合、#pragma once ディレティブと同様の方法で、コンパイラにより include guard 表現形式が認識され、複数インクルードの最適化が実装されます。

// header.h
// Demonstration of the #include guard idiom.
// Note that the defined symbol can be arbitrary.
#ifndef HEADER_H_     // equivalently, #if !defined HEADER_H_
#define HEADER_H_
// Code placed here is included only once per translation unit
#endif // HEADER_H_

既存のコードとの一貫性を維持するために、#pragma once ディレクティブを実装していないコンパイラにコードを移植できるようにする必要がある場合や、複数のインクルードの最適化が不可能である場合は、#include guard 表現形式をお勧めします。 ファイル システムの別名または別名が設定されたインクルード パスにより、コンパイラが正規のパスを基準に同じインクルード ファイルを識別できなくなるような複雑なプロジェクトで発生する場合があります。

プリプロセッサ シンボルを使用してその効果を制御する、複数回のインクルードが発生するように設計されているヘッダー ファイルに、#pragma once または include guard の表現形式を使用しないようにします。 この設計の例については、<assert.h> ヘッダー ファイルを参照してください。 また、インクルード ファイルに複数のパスを作成すると、include guard と #pragma once の両方で複数インクルードの最適化が損なわれるため、インクルード パスを慎重に管理し、それを回避してください。

関連項目

pragma ディレクティブと __pragma および _Pragma キーワード