//
// C++ Interface: AvatarLogger
//
// Description:
//
//
// Author: Sean Ryan <sryan@evercrack.com>, (C) 2008
// Author: Erik Hjortsberg <erik.hjortsberg@gmail.com>, (C) 2008
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.//
//
#ifndef EMBEROGREAVATARLOGGER_H
#define EMBEROGREAVATARLOGGER_H

#include <sigc++/trackable.h>
#include <fstream>
#include <string>
#include <memory>
#include "framework/ConsoleObject.h"


namespace EmberOgre {

class Avatar;
class EmberEntity;

/**
	Handles logging of ingame events such as chat to a file. The file will be created when an instance of this is created and the connection will be severed at its destruction.
	The log file will be located in the directory returned by a call to ConfigService::getHomeDirectory()

	@author Sean Ryan <sryan@evercrack.com>
	@author Erik Hjortsberg <erik.hjortsberg@gmail.com>
*/
class AvatarLogger
: public  sigc::trackable
{
public:
    AvatarLogger(EmberEntity& avatarEntity);
    virtual ~AvatarLogger();

protected:

	/**
	 * Holds the file to which messages will be written.
	 */
	std::auto_ptr<std::ofstream> mChatLogger;


	/**
	 * Listens to the GUIManager::AppendIGChatLine event and write the contents of chat messages to the log.
	 * @param message
	 * @param entity
	 */
	void GUIManager_AppendIGChatLine(const std::string& message, EmberEntity* entity);


};

/**
Handles the creation of an instance of AvatarLogger.
Since the AvatarLogger is dependent on an actual EmberEntity instance it can't be created until such an instance exists in the system. This class will take care of delaying the creation until it's suitable.
You can create an instance of this anytime.
*/
class AvatarLoggerParent
{
public:
	/**
	 *    Ctor.
	 * @param avatar
	 */
	AvatarLoggerParent(Avatar& avatar);

	~AvatarLoggerParent() {}

protected:

	std::auto_ptr<AvatarLogger> mLogger;

};
}

#endif
