インクルードガードについて教えてください。

Question

###インクルードガードとは...

マクローリン級数展開を利用しsin(x)の関数を作成しました。
そしてこのsin(x)などの関数をまとめてヘッダファイルとして新しく作成したいです。

###試したこと
呼び出し元

#include <stdio.h>
#include <Original.h>

#define PI 3.14159265

int main(void){
//Original.hの中にある関数を呼び出して実験しています
}

//Original.h
#include <stdio.h>
#define PI 3.1415

double sine(double deg){
//マクローリンのアルゴリズムがあります。
}

このときエラーが出ます。当たり前ですが。。。

これらについて調べてみたところ#ifndef - #Endif というマクロがあるのまでは分かったのですが、理解ができません。

この場合であればstdio.hがすでにインクルードされているか。されていなかったときのみインクルードする方法。PIについてもすでに定義されているか調べ、されていなかったらPIについて定義する方法をご示唆お願いします。
###環境
Visual Studio 2015

###余談
余談ですがVisual Studio 使うときになぜstdafx.hをインクルードしないといけないのですか？
またstdafx.hをインクルードしないで使用する方法とかございましたら教えてください。

Comments

[ozwk]

Original.hはどれですか？

[Green-Tea]

すいません！！２つ目のソースプログラムがそれに当たります

Answer 1

これらについて調べてみたところ#ifndef - #Endif というマクロがあるのまでは分かったのですが、理解ができません。

インクルードガードは、だいたいこんな感じで書きます。

#ifndef MYPROJECT_ORIGINAL_H_
#define MYPROJECT_ORIGINAL_H_

//Original.h
#include <stdio.h>
#define PI 3.1415

double sine(double deg){
//マクローリンのアルゴリズムがあります。
}

#endif // MYPROJECT_ORIGINAL_H_

インクルードガードは同じヘッダーファイルを何度も読み込ませないための仕組みです。
コンパイラーによって初めてそのファイルを読もうとするときにはMYPROJECT_ORIGINAL_H_が定義されていないので、#ifndefに合致し、対応する#endifまでが読み込まれます。その際、#ifndefの次の行の#define MYPROJECT_ORIGINAL_H_が実行されます。
2度目に同じファイルを読もうとしたときは、すでにMYPROJECT_ORIGINAL_H_マクロが定義されているため、#ifndefに合致せず、#endifまで読み飛ばされます。

この場合であればstdio.hがすでにインクルードされているか。されていなかったときのみインクルードする方法。

stdio.hはすでにインクルードガードが施されているので気にする必要はありません。

PIについてもすでに定義されているか調べ、されていなかったらPIについて定義する方法をご示唆お願いします。

マクロ単体でそのようにすることは通常はあまりありません。異なる値が定義されると、どれが使われるかによって結果が変わってしまうからです。Original.hの中で使うためのPIなら#define ORIGINAL_PI 3.14……という具合に、名前を変えて区別する方が良いです。

それと、ヘッダーの中に関数を書く場合はインライン関数にしてください。

inline double sine(double deg){

余談ですがVisual Studio 使うときになぜstdafx.hをインクルードしないといけないのですか？
またstdafx.hをインクルードしないで使用する方法とかございましたら教えてください。

いけないわけではなく、「プリコンパイル済みヘッダー」の機能が使えるようにプロジェクト作成時にデフォルトで組み込まれているのです。プロジェクトのプロパティのC/C++の「プリコンパイル済みヘッダー」の設定で「プリコンパイル済みヘッダー」を「プリコンパイル済みヘッダーを使用しない」に変更するとstdafx.hをインクルードしなくても良くなります。

Comments

[Green-Tea]

MYPROJECT_ORIGINAL_H の "MYPROJECT"はなぜつけるんですか？

[catsforepaw]

説明が抜けていました。インクルードガード用のマクロ名は、他と被らない独自の名前にすることが求められます。ファイル名だけでは別のプロジェクトやライブラリでも同じ名前が使われている可能性があるので、特に決まりはないですが、プロジェクト名などをくっつけることが多いです。

Answer 2

まず#ifndef～#endifディレクティブですが、

#ifndef HOGE
～
#endif

と書いた時、HOGEというdefineが定義されている時は、その間に記述されている内容をコンパイルしないようにします（ついでに、その逆をするのが#ifdef ～ #endif）。

多分、エラーって、PIというdefineが二重定義されているという旨のものではないですか？Original.hとCソースファイルとで、違う値で定義しているので。
普通、こうした定数定義もヘッダファイルに記載します。なので、Cソースファイル側の定義を削除すればエラーは解消されると思います（少なくとも、これに関しては。他の記述がないので、他にもあるかもしれません）。

さらに言えば、ヘッダファイルには関数本体の記述はしません。プロトタイプ宣言のみを記述します。関数本体（この場合はsine()）は別のソースファイルに記述して、分割コンパイルを行なうようにします（もしくはsine()等の関数をまとめたファイルをライブラリとして生成します）。

Comments

[Green-Tea]

最後のヘッダファイルには書かないってことが少し驚きました。。。。
回答ありがとうございました。

Answer 3

こんにちは。

stdio.hがすでにインクルードされているか。されていなかったときのみインクルードする方法。

こちらは通常は無理です。
でも、stdio.h自身がインクルードガードがかかっているので、２重にインクルードしても２回目のインクルードは事実上無視されます。

PIについてもすでに定義されているか調べ、されていなかったらPIについて定義する方法

下記です。

#ifndef PI   // PIが定義されていない時のみ#endifまでコンパイルする
    #define PI 3.14159265
#endif

Comments

[Green-Tea]

stdio.hは特殊なヘッダファイルなんですね。。。

[Chironian]

stdio.hは標準ライブラリのヘッダ・ファイルです。搭載されていないCコンパイラはまず存在しませんので特殊ではないです。

実は、C/C++言語では、ヘッダ・ファイルにインクルード・ガードをつけることはほぼ「常識」となってます。寧ろ、インクルードガードを付けていないインクルード・ファイルの方が特殊かも知れません。

ところで、実際に目にするインクルード・ガートは#pragma onceが多いかも知れません。コンパイラ・メーカが提供するヘッダでは良く使われてますし、お手軽なので使う人も少なくないです。
ですが、コンパイラによっては使えない可能性があるものなので、あまりお勧めはできません。