abstract_state_manager.hpp

//
//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2010-2015 SuperTuxKart-Team
//
//  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 3
//  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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

#ifndef HEADER_ABSTRACT_STATE_MANAGER_HPP
#define HEADER_ABSTRACT_STATE_MANAGER_HPP

#include <vector>
#include <string>
#include "guiengine/engine.hpp"
#include "guiengine/screen.hpp"
#include "utils/leak_check.hpp"

namespace GUIEngine
{
    class Widget;
    class Screen;

    enum GameState
    {
        MENU,
        GAME,
        INGAME_MENU,
        CURRENT
    };   // GameState

    class AbstractStateManager
    {
    protected:
        GameState m_game_mode;

        std::vector<std::pair<std::string, Screen*>  > m_menu_stack;

        void pushMenu(Screen* screen);

        void setGameState(GameState state);

    public:

        LEAK_CHECK()

        
        AbstractStateManager();

        virtual ~AbstractStateManager() { }

        void pushScreen(Screen* screen);

        void replaceTopMostScreen(Screen* screen, GUIEngine::GameState gameState = GUIEngine::CURRENT);

        void popMenu();

        void resetAndGoToScreen(Screen* screen);

        void resetAndSetStack(Screen* screens[]);

        void enterGameState();

        GameState getGameState();

        void reshowTopMostMenu();

        template<typename T>
        void hardResetAndGoToScreen()
        {
            if (m_game_mode != GAME) GUIEngine::getCurrentScreen()->tearDown();

            GUIEngine::clearScreenCache();

            T* instance = T::getInstance();

            m_menu_stack.emplace_back(instance->getName(), instance);
            setGameState(MENU);

            switchToScreen(instance);
            getCurrentScreen()->init();

            onTopMostScreenChanged();
        }

        /*  ***********************************
         * methods to override in children *
         *********************************** */

        virtual void escapePressed() = 0;

        virtual void onGameStateChange(GameState new_state) = 0;

        virtual void onStackEmptied() = 0;

        virtual void onTopMostScreenChanged() = 0;

        // --------------------------------------------------------------------
        unsigned int getMenuStackSize() const
        { 
            return (unsigned int)m_menu_stack.size();
        }
    };   // Class AbstractStateManager

}   // GUIEngine
#endif