GUI.hpp

#pragma once

#include <CEGUI/CEGUI.h>
#include <string>
#include "Console.hpp"
#include "EntityTracker.hpp"
#include "GameLog.hpp"
#include "BuilderWindow.hpp"
#include "TopBar.hpp"
#include "ResearchWindow.hpp"
#include "SpellCastingWindow.hpp"
#ifdef WIN32
#include <windows.h>
#else
#include <dirent.h>
#endif

class Game;

/**
 * Represents the game's main graphical user interface (i.e. any windows except
 * for the development ones like the console or entity creator).
 */
class GUI
{
	public:
		/**
		 * Destructor.
		 */
		~GUI() {}

		/**
		 * Brief: Initializes the selection by loading the layout and registering
		 *        all event handlers.
		 * Param: Pointer to the game object, which is used by the event handlers
		 *        (like the quit button etc).
		 */
		void init(Game*);

		/**
		 * Brief: Set's the GUI's visibility status.
		 * Param: The new visibility status.
		 * TODO: Toggle GUI with a hotkey for screen capturing?
		 */
		void set_visible(bool);

		/**
		 * Brief: Returns true if the entire GUI is visible, false otherwise.
		 */
		bool is_visible() const;

		/**
		 * Brief: Set's the visibility status of a particular window.
		 * Param: Name (path) of the window, without the root window prefix.
		 *        (e.g. "TOOLS/TOOL_SELECTION/SPELL_SELECTION")
		 * Param: The new visibility status.
		 */
		void set_visible(const std::string&, bool);

		/**
		 * Brief: Returns the visibility status of a particular window.
		 * Param: Name (path) of the window, without the root window prefix.
		 */
		bool is_visible(const std::string&) const;

		/**
		 * Brief: Returns the singleton instance.
		 */
		static GUI& instance();

		/**
		 * Brief: Shows the load/save dialog window.
		 * Param: Either "SAVE" or "LOAD", will determine the
		 *        functionality of the window.
		 */
		void show_load_save_dialog(const std::string&);

		/**
		 * Brief: Returns a pointer to a given subwindow of
		 *        the root window.
		 * Param: Name of the window.
		 */
		CEGUI::Window* get_window(const std::string&);

		/**
		 * Brief: Returns a reference to the game's dev console.
		 */
		Console& get_console();

		/**
		 * Brief: Returns a reference to the entity tracker.
		 */
		EntityTracker& get_tracker();

		/**
		 * Brief: Returns a reference to the game's log.
		 */
		GameLog& get_log();

		/**
		 * Brief: Returns a reference to the builder window.
		 */
		BuilderWindow& get_builder();

		/**
		 * Brief: Returns a reference to the top bar.
		 */
		TopBar& get_top_bar();

		/**
		 * Brief: Returns a reference to the research window.
		 */
		ResearchWindow& get_research();

		/**
		 * Brief: Returns a reference to the spell casting window.
		 */
		SpellCastingWindow& get_spell_casting();

		/**
		 * Brief: Notifies the GUI that the escape key was pressed so that
		 *        it can close windows if needed. Returns true if anything
		 *        has been closed, false otherwise.
		 * Note: CEGUI event system does not seem to work properly :/
		 */
		bool escape_pressed();

		/**
		 * Note: Since VS2015 seems to have some problems with C++ standard
		 *       (generates default copy/move constructors and operators even
		 *        if default constructor is created), these constructors/operators
		 *        are explicitly deleted.
		 */
		GUI(const GUI&) = delete;
		GUI(GUI&&) = delete;
		GUI& operator=(const GUI&) = delete;
		GUI& operator=(GUI&&) = delete;
	private:
		/**
		 * Constructor, private because of the singleton pattern.
		 */
		GUI();

		/**
		 * Brief: Fills a given list box with the names of all files in a
		 *        given directory.
		 * Param: Name of the directory.
		 * Param: List box to be filled.
		 * Param: If true, the .lua extension will be cut from the file name
		 *        if present.
		 */
		void list_directory(const std::string&, CEGUI::Listbox&, bool = false);

		/**
		 * Pointer to the root window of the layout.
		 */
		CEGUI::Window* window_;

		/**
		 * Name of the current tool in the tools subwindow.
		 */
		std::string curr_tool_;

		/**
		 * Pointer to the game instance used by button event handlers.
		 */
		Game* game_;

		/**
		 * ID of the entity that is currently tracked by the entity viewer.
		 */
		EntityTracker tracker_;

		/**
		 * Game's developer console.
		 */
		Console console_;

		/**
		 * Game's log, used to show messages to the player.
		 */
		GameLog log_;

		/**
		 * Allows the player to place buildings.
		 */
		BuilderWindow builder_;

		/**
		 * Shows game info at the top of the screen.
		 */
		TopBar top_bar_;

		/**
		 * Game's research window that allows the player to buy
		 * buildings, units and spells.
		 */
		ResearchWindow research_;

		/**
		 * Allows the player to cast spells.
		 */
		SpellCastingWindow spell_casting_;

		/**
		 * Allows easier access to the menu subwindow.
		 */
		CEGUI::Window* menu_;
};