//------------------------------------------------------------------------------
// Lamp : Open source game middleware
// Copyright (C) 2004  Junpei Ohtani ( Email : junpee@users.sourceforge.jp )
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//------------------------------------------------------------------------------

/** @file
 * デバッグ出力ヘッダ
 * @author Junpee
 */
#ifndef DEBUG_OUTPUT_H_
#define DEBUG_OUTPUT_H_

//------------------------------------------------------------------------------
// デバッグ時
#ifdef _DEBUG

/**
 * デバッグ出力の初期化
 */
#define DebugOutInitialize() ::Lamp::DebugOutput::initialize()

/**
 * デバッグ出力の後始末
 */
#define DebugOutFinalize() ::Lamp::DebugOutput::finalize()


/**
 * デバッグ出力
 *
 * デバッグ時にprintfと同じ構文で呼び出すと、デバッグ出力にメッセージを出力します。
 * <pre>
 * サンプルコード
 *
 * // デバッグ時、デバッグ出力に「Hoge 1 2.0」と出力して改行する。
 * DebugOut("Hoge %d %.1f\n", 1, 2.f);
 * </pre>
 */
#define DebugOut ::Lamp::DebugOutput::print

/**
 * 線の出力
 *
 * デバッグ時にデバッグ出力に線を出力し、改行します。
 */
#define DebugOutLine() ::Lamp::DebugOutput::print("------------------------------"\
	"--------------------------------------------------\n")

/**
 * 太い線の出力
 *
 * デバッグ時にデバッグ出力に太い線を出力し、改行します。
 */
#define DebugOutThickLine() ::Lamp::DebugOutput::print("##############################"\
	"##################################################\n")

namespace Lamp{

class String;

/**
 * デバッグ出力クラス
 *
 * デバッグ出力の実装クラスです。
 */
class DebugOutput{
public:
	/**
	 * 初期化
	 * @param fileName デバッグログファイル名。NULLだとログを残しません。
	 */
	static void initialize(const char* fileName = "LampDebugLog.txt");

	/**
	 * 後始末
	 */
	static void finalize();

	/**
	 * デバッグ出力
	 *
	 * 可変長引数に対応したデバッグ出力メソッド。
	 * @param format フォーマット
	 * @param ... 可変長引数
	 * @return 出力文字数
	 */
	static int print(const char* format, ...);

	/**
	 * デバッグ出力
	 * @param string 文字列
	 * @return 出力文字数
	 */
	static int print(const String& string);

private:
	// コンストラクタ隠蔽
	DebugOutput();

	// ロガー
	static Logger* logger_;
};

} // End of namespace Lamp

//------------------------------------------------------------------------------
// 非デバッグ時
#else // ! _DEBUG

// デバッグ出力の初期化ダミー
#define DebugOutInitialize()

// デバッグ出力の後始末ダミー
#define DebugOutFinalize()

/// 出力ダミー
#define DebugOut

/// 線の出力ダミー
#define DebugOutLine()

/// 太い線の出力ダミー
#define DebugOutThickLine()

#endif// End of _DEBUG

//------------------------------------------------------------------------------
#endif // End of DEBUG_OUTPUT_H_
//------------------------------------------------------------------------------
