ヘッダーが衝突する場合のインクルードエラーの解決方法が知りたい。

Question

下記のGame_Scene クラスのインクルードですがなぜstage.hppをインクルードするとstageクラス内の#define つまりEntry.hpp関係が読み込まれないのでしょうか？ヘッダーファイルが衝突していると思いEntry.hppをコメントアウトしてStage.hppをインクルードしたり前方宣言やら色々試しましたがわかりません。どうすればいいのでしょうか？

#ifndef ___STAGE_HPP_
#define ___STAGE_HPP_

#include "Entry.hpp"

/*####################################################
* エディットするステージを描画
*
* 説明
* 
* 
######################################################*/

class Stage
{
public:
	Stage();	//コンストラクタ
	~Stage();	//デストラクタ

	void Update();	//計算
	void Draw();	//描画

private:


	byte mGame_Stage[ STAGE_GRID_Y ][ STAGE_GRID_X ];	//ステージ
};


#endif

#ifndef ___GAME_SCENE_HPP_
#define ___GAME_SCENE_HPP_

#include "Scene_base.hpp"
//#include "Entry.hpp"
#include "Stage.hpp"


enum class Scene_Type;
class Stage;
/*####################################################
* メインゲーム　シーン
*
* 説明
* メインのゲーム画面
######################################################*/
class Game_Scene : public Scene_base
{
public:
	Game_Scene(Scene_Type t,Entry* e);	//コンストラクタ
	~Game_Scene();						//デストラクタ

	void Update();	//更新
	void Draw();	//描画

private:



	std::shared_ptr<Stage> stage;

	Entry* Owner;	//Entry クラス

};

#endif

#ifndef ___ENTRY_HPP_
#define ___ENTRY_HPP_



#include "Game_Scene.hpp"
#include "Input.hpp"
#include <iostream>
class Game_Scene;



#define CELL ((int)48)	//セル

#define byte unsigned char	//バイト

//画面サイズ
#define SCREEN_WIDTH ((int)16 * 70)
#define SCREEN_HEIGHT ((int)9 * 70)

//ステージ
#define STAGE_WIDTH ((int)100 * CELL)
#define STAGE_HEIGHT ((int)100 * CELL)

//ステージのセル数
#define STAGE_GRID_X ((int)(STAGE_WIDTH / CELL))
#define STAGE_GRID_Y ((int)(STAGE_HEIGHT / CELL))

//方向
#define VECTOR_UP glm::ivec2(0,-1)
#define VECTOR_DOWN glm::ivec2(0,1)
#define VECTOR_LEFT glm::ivec2(-1,0)
#define VECTOR_RIGHT glm::ivec2(1,0)

#define PI ((float)3.14159265359)	//PI



// シーンの種類
enum class Scene_Type
{
	Title,		//タイトル
	Game,		//メインゲーム
	GameOver,	//ゲームオーバー


	Menu,		//メニュー
	Pause,		//一時停止
};



/*####################################################
* シーン推移
* 
* 説明
* シーンの推移を行う
######################################################*/
class Entry
{
public:

	Entry();	//コンストラクタ
	~Entry();	//デストラクタ

	void Update();	//計算
	void Draw();	//描画
	int GetRand(int start, int end);	//乱数を取得
	
	int LoadSprite(const char* FileName);				//スプライトをロード


	std::shared_ptr<Input> InputKey;

private:

	std::shared_ptr<Game_Scene> game;

	Scene_Type type;

};


#endif

#ifndef ___SCENE_BASE_HPP_
#define ___SCENE_BASE_HPP_

#include <iostream>
#include <vector>

class Entry;
enum class Scene_Type;

/*####################################################
* シーンの基底クラス
* 
* 説明
* 全てのシーンクラスはこのクラスを継承する。
######################################################*/
class Scene_base
{
public:
	Scene_base(Scene_Type t,Entry* e);	//コンストラクタ
	~Scene_base();						//デストラクタ

	virtual void Update() = 0;	//更新
	virtual void Draw() = 0;	//描画

	Scene_Type getSceneType();	//シーンタイプを取得
protected:

	Scene_Type Type;	//シーンタイプ
	Entry* Owner;		//Entry クラス

};


#endif

Comments

[txty]

忘却の彼方だし、素人の考えで笑われるかもしれませんけどヘッダファイルに #ifndef　　＃define#endifするけどそこに書くのはクラスで　　cpp側で＃includeすればいいんじゃないの
ポインタの扱いがよくわかんなくて避けてるけど誰か助けて。

[退会済みユーザー]

どういう意味でしょうか？

[txty]

.cpp側でインクルードすればよくてヘッダ側でインクルードしてるからおかしいのかなと思った。過去に書いた資料みてみてそうかなと思った。

[退会済みユーザー]

ソースファイル側でインクルードするのは正しいのでしょうか？

[txty]

私はそうしてるけどそんなんで問題解消するか知らない

[txty]

書き込みがなくなったので、どうなったのか気にしてます。

また、今回のコメント欄に貼ったコメントは
参考にしないでください。

Answer 1

Entry.hpp ⇨ Game_Schene.hpp ⇨ Stage.hpp ⇨ Entry.hpp の循環インクルードになっています。Stage.hpp より先に Entry.hpp が読み込まれると、STAGE_GRID_X が定義される前に Stage.hpp がインクルードされるためコンパイルできなくなります。

質問者さまが過去に4回ぐらい遭遇している循環インクルードの問題ですが、今回は Stage.hpp 内でクラスの前方宣言することでは解消できませんね。

• Entry.hpp 内で Game_Scene.hpp をインクルードせず、前方宣言で済ませる
• Entry.hpp 内の定数定義だけを別ヘッダに追い出して、Stage.hpp では Entry.hpp の代わりにそれをインクルードする

のどちらかでいいと思います。

---

毎回 Entry.hpp が問題を起こしていますが、「Entry.hpp からは他のヘッダをインクルードするのは避ける。前方宣言で済ませる」と「ヘッダからEntry.hppをインクルードするのを避ける。可能なら前方宣言で済ませる」でだいたい解消すると思います。

追記: Entry.hpp の設計について:
Entry.hpp には「いろいろなクラスで使われる定数・関数(Entry::GetRand()やEntry::LoadSprite())」と「ゲーム全体を制御する(?)クラス class Entry」が混在しています。これらの役割を別ヘッダに分けるのが循環参照のない理想的な設計です。かといって Entry::GetRand()やEntry::LoadSprite() が Entry クラスに存在する理由もあるでしょうから、一部を抽象クラスにしてしまうのが良いと思います。おおまかな例:

Entry.hpp (いろいろなクラスから使うのはこのヘッダ。.cpp は不要。)

#define CELL ((int)48)
...

class Entry {
 public:
   virtual ~Entry() {}
   virtual int GetRand(int start, int end) = 0;
   virtual int LoadSprite(const char* FileName) = 0;
};

EntryImpl.hpp (ゲーム全体の制御はこれ)

#include "Entry.hpp"

class EntryImpl : public Entry {
  EntryImpl();
  ~EntryImpl() override;

  void Update();
  void Draw();

  int GetRand(int start, int end) override;
  int LoadSprite(const char* FileName) overide;

  std::shared_ptr<Input> InputKey;

private:
  std::shared_ptr<Game_Scene> game;
  Scene_Type type;
};

Comments

[退会済みユーザー]

Entry.hppを読み込ませるて定数を使うというやり方が既に危険で良くないのでしょうか？

[退会済みユーザー]

またソースファイルで.hppをインクルードするという手段は正しいのでしょうか？

[int32_t]

> Entry.hppを読み込ませるて定数を使うというやり方が既に危険で良くないのでしょうか？

Entry.hppがトラブルを生みやすい設計ですが、前方宣言などで回避できるのなら大した問題ではないです。
どういう設計をしたらいいのか、回答に追記しておきました。

> またソースファイルで.hppをインクルードするという手段は正しいのでしょうか？

ごく普通に行われることです。正しくコンパイルできれば何も問題はありません。

[退会済みユーザー]

なるほど。
> Entry.hpp 内で Game_Scene.hpp をインクルードせず、前方宣言で済ませる

とありますがソースファイル側で.Game_Scene.hppをインクルードする必要があるのですが大丈夫なのでしょうか？

[int32_t]

> ソースファイル側で.Game_Scene.hppをインクルードする必要があるのですが

既に書いたように、問題ありません。何を心配しているのかわかりませんが、必要なときに必要なヘッダをインクルードするのはごく当然のことです。