//------------------------------------------------------------------------------
// 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 ERROR_OUTPUT_H_
#define ERROR_OUTPUT_H_

//------------------------------------------------------------------------------

/**
 * エラー出力の初期化
 */
#define ErrorOutInitialize ::Lamp::ErrorOutput::initialize

/**
 * エラー出力の後始末
 */
#define ErrorOutFinalize ::Lamp::ErrorOutput::finalize

/**
 * エラー出力
 *
 * printfと同じ構文で呼び出すと、エラーハンドラを呼び出します。
 * デフォルトのエラーハンドラはメッセージを出力した後、強制終了します。
 * <pre>
 * サンプルコード
 *
 * // 「Hoge 1 2.0」というメッセージでエラーを発生させる。
 * ErrorOut("Hoge %d %.1f", 1, 2.f);
 * </pre>
 */
#define ErrorOut ::Lamp::ErrorOutput::print

/**
 * 線の出力
 *
 * エラー時にエラー出力に線を出力し、改行します。
 */
#define ErrorOutLine() ::Lamp::ErrorOutput::print("------------------------------"\
	"--------------------------------------------------\n")

/**
 * 太い線の出力
 *
 * エラー時にエラー出力に太い線を出力し、改行します。
 */
#define ErrorOutThickLine() ::Lamp::ErrorOutput::print("##############################"\
	"##################################################\n")

namespace Lamp{

class Logger;
class String;

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

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

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

	/**
	 * エラー出力
	 * @param string 文字列
	 * @return 出力文字数
	 */
	static int print(const String& string);

	/**
	 * エラーハンドラの型
	 *
	 * デフォルトのエラーハンドラはメッセージを出力して強制終了します。
	 * @param message エラーメッセージ
	 */
	typedef void (*ErrorHandler)(const char* message);

	/**
	 * エラーハンドラの設定
	 * @param handler 設定するエラーハンドラ
	 */
	static void setErrorHandler(ErrorHandler handler){ handler_ = handler; }

private:
	// デフォルトエラーハンドラ
	static void defaultErrorHandler(const char* message);

	// コンストラクタ隠蔽
	ErrorOutput();

	// エラーハンドラ
	static ErrorHandler handler_;
	// ロガー
	static Logger* logger_;
};

} // End of namespace Lamp

//------------------------------------------------------------------------------
#endif // End of ERROR_OUTPUT_H_
//------------------------------------------------------------------------------
