デバッグの支援関数を作っています。処理を短くして見やすくしたいです。

Question

#include <list>
#include <string>

//デバッグリストに追加するには次の4行を貼り付ける
char buf[32];
sprintf_s(buf, "%d", 10);
char buf2[32] = "テスト";
addDebugList(buf2, buf);


//listのコンテナ宣言
list<string> debugList1;
list<string> debugList2;
void addDebugList(char(&bungen)[32], char(&atai)[32])
{
	debugList1.push_back(bungen);
	debugList2.push_back(atai);
}

以上のようなデバッグを支援するためのコードがあったとします。
デバッグしたい項目があればaddDebuglistに項目名とそのデータを引数で渡します。

しかし、そのリストに追加するためには四つも処理（4～7行目あたり）を行わなければいけません。デバッグする度に4行も書いていたらソースが読みにくくなる原因になると思いました。

誰かこれを今よりも短くすることはできますか？

ちなみにDXライブラリを使って自作ゲームを作っています。

Answer 1

クラス、関数テンプレート、マクロを組み合わせます。

以下のようにヘッダーにデバッグ支援コードを書きます。

#include <list>
#include <string>
#include <sstream>

class DebugList
{
	std::list<std::string> debugList1;
	std::list<std::string> debugList2;

	DebugList()
	{}

public:
	static DebugList & getInstance()
	{
		static DebugList instance;
		return instance;
	}

	template <class Type>
	void addDebugList(const std::string & bungen, const Type & atai)
	{
		std::stringstream ss;
		ss << atai;
		debugList1.push_back(bungen);
		debugList2.push_back(ss.str());
	}
};

#define ADD_DEBUG_LIST(bungen, atai) DebugList::getInstance().addDebugList(bungen, atai)

このヘッダーをインクルードすればADD_DEBUG_LIST("テスト", 10);のように1行で書けます。
マクロにしておけば、後で__FILE__や__LINE__のようなデバッグに役に立つ情報を組み込みたくなったときに、呼び出し側を変える必要がないという利点があります。

Comments

[Chironian]

あう、先をこされてしまった。ほとんど同じもの書いてました。
マクロ化、良いですね。

ところで、クラスまではしないで安易にグローバル関数で良いような気もします。

[catsforepaw]

デバッグ支援コードは状況によって（リリースビルドとかで）無効化したいこともあるので、マクロにすると都合が良いんですよね。

> ところで、クラスまではしないで安易にグローバル関数で良いような気もします。

最初はそれも考えたのですが、ご質問のコードの「listのコンテナ」の置き場所を考えたら、クラス化した方が扱いやすいと思いました。

[Chironian]

ヘッダにだけ支援コードを書いてでcpp不要にしたってわけですね。なるほど。
デバッグ支援は使いたい時にサッと使いたいですもんね。その発想は持ってませんでした。頂きます。

[tunakan_ex]

ありがとうございます。使ってみます。

[catsforepaw]

Chironian さん

> ヘッダにだけ支援コードを書いてでcpp不要にしたってわけですね。

それです。「デバッグ支援コードはヘッダーに書く」ということが私の中で常識化してしまったので説明を省いてしまいました。特にチーム開発などではいかに簡単に使わせるのかということも重要な課題ですからね。

Answer 2

実行中に変数がどのようになっているか調べたいのなら、
char buf[32];
sprintf_s(buf, "%d", 10);
char buf2[32] = "テスト";
addDebugList(buf2, buf);

ではなくて
addDebugList(buf2, buf);
のみでいいのでは？
buf2やbufではなくて調べたい変数（iやstrなど）をそのまま書けば１行で済む。