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

#include <LampUnit/TestListener.h>

namespace Lamp{
	class Logger;
}

namespace LampUnit{

//------------------------------------------------------------------------------
/**
 * 文字列リスナ
 */
class TestStringListener : public TestListener{
public:
	/**
	 * コンストラクタ
	 * @param fileName ログファイル名。NULLだとログを残しません。
	 */
	TestStringListener(const char* fileName = "UnitTestLog.txt");

	/**
	 * デストラクタ
	 */
	virtual ~TestStringListener();

	/**
	 * テスト開始
	 * @param test 開始するテスト
	 */
	virtual void startTest(Test* test);

	/**
	 * 失敗の追加
	 *
	 * メソッド終了後でもfailureの情報が必要な場合はfailureをコピーする。
	 * @param failure 失敗したテストの情報
	 */
	virtual void addFailure(const TestFailure& failure);

	/**
	 * テスト終了
	 * @param test 終了するテスト
	 */
	virtual void endTest(Test* test);

	/**
	 * 出力
	 * @param string 出力文字列
	 */
	virtual void print(const char* string);

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

private:
	// テストカウント
	int testCount_;
	// ロガー
	Lamp::Logger* logger_;

	// 最大文字列長
	static const int maxStringLength_ = 1024;

};

//------------------------------------------------------------------------------
} // End of namespace LampUnit
#endif // End of TEST_STRING_LISTENER_H_
//------------------------------------------------------------------------------
