/***************************************************************************
 *   Copyright (C) 2005-2008 by the FIFE team                              *
 *   http://www.fifengine.de                                               *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE 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.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_GUI_GUIMANAGER_H
#define FIFE_GUI_GUIMANAGER_H

// Standard C++ library includes

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/base/singleton.h"
#include "eventchannel/sdl/ec_isdleventlistener.h"

namespace FIFE {
	class ImagePool;
	class RenderBackend;
	class GuiImageLoader;
	class Console;
	class GuiFont;

	class GuiManager:
			public ISdlEventListener {
	public:
		/** Constructor.
		 */
		GuiManager(ImagePool& pool);

		/** Destructor.
		 */
		virtual ~GuiManager();

		/** Performs the GUI logic and draws the GUI accordingly.
		 *
		 * This will be called each frame.
		 */
		virtual void turn() = 0;

		/** Inits the GUI Manager.
		 * @param graphics backend specific graphics object to use
		 * @param screenWidth width for the gui top container
		 * @param screenHeight height for the gui top container
		 */
		virtual void init(RenderBackend* render_backend, int screenWidth,
				int screenHeight);

		/** Resizes the top container.
		 *
		 * @param x The new starting X coordinate.
		 * @param y The new starting Y coordinate.
		 * @param width The new width.
		 * @param height The new height.
		 */
		virtual void resize(unsigned int x, unsigned int y, unsigned int width,
				unsigned int height) = 0;

		/** Gets the console.
		 *
		 * @return The console.
		 */
		Console* getConsole() const {
			return m_console;
		}

		/** Display the in-game FIFE console. */
		virtual void showConsole() = 0;

		/** Hide the in-game FIFE console. */
		virtual void hideConsole() = 0;

		/** Toggle the visibility of the in-game FIFE console. */
		virtual void toggleConsole();

		/** Gets the shared ImagePool instance.
		 *
		 * @return The ImagePool instance.
		 */
		ImagePool& getImagePool() const {
			return m_image_pool;
		}

		virtual bool onSdlEvent(SDL_Event& evt) = 0;

		/** Set the global font properties.
		 */
		virtual GuiFont* setDefaultFont(const std::string& path,
				unsigned int size, const std::string& glyphs);

		/** Gets font with given properties. Note that font will be owned by
		 *  guimanager
		 */
		virtual GuiFont* createFont(const std::string& path = "",
				unsigned int size = 0, const std::string& glyphs = "");

		/** Releases given font.
		 */
		virtual void releaseFont(GuiFont* font);

		virtual void invalidateFonts();

	protected:
		// Whether the console is visible.
		bool m_console_visible;

	private:
		// pool used for images
		ImagePool& m_image_pool;

		// The console.
		Console* m_console;

		// The fonts used
		std::vector<GuiFont*> m_fonts;
		// default font settings
		std::string m_fontpath;
		std::string m_fontglyphs;
		int m_fontsize;
	};
}

#endif