state_manager.hpp

//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2009-2015 Marianne Gagnon
//
//  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 STATE_MANAGER_HPP
#define STATE_MANAGER_HPP

#include <string>

#include "config/player_profile.hpp"
#include "guiengine/abstract_state_manager.hpp"
#include "utils/ptr_vector.hpp"

class AbstractKart;
class InputDevice;
struct Input;
namespace Online
{
    class OnlineProfile;
}

namespace GUIEngine
{
    class Widget;
}

const static int PLAYER_ID_GAME_MASTER = 0;

class StateManager : public GUIEngine::AbstractStateManager
{

    void updateActivePlayerIDs();


public:

    class ActivePlayer
    {
        friend class StateManager;

        PlayerProfile *m_player;
        InputDevice   *m_device;

        AbstractKart  *m_kart;

        int m_id;

        ActivePlayer(PlayerProfile* player, InputDevice* device);

#ifdef DEBUG
        unsigned int m_magic_number;
#endif

    public:

        ~ActivePlayer();

#ifdef DEBUG
        bool ok()
        {
            return (m_magic_number == 0xAC1EF1AE);
        }   // ok
#endif
        // --------------------------------------------------------------------
        PlayerProfile* getProfile()
        {
#ifdef DEBUG
            assert(m_magic_number == 0xAC1EF1AE);
#endif
            return m_player;
        }   // getProfile

        // --------------------------------------------------------------------
        const PlayerProfile* getConstProfile() const
        {
#ifdef DEBUG
            assert(m_magic_number == 0xAC1EF1AE);
#endif
            return m_player;
        }   // getConstProfile

        // --------------------------------------------------------------------
        void setPlayerProfile(PlayerProfile* player);

        // --------------------------------------------------------------------
        int getID() const
        {
#ifdef DEBUG
            assert(m_magic_number == 0xAC1EF1AE);
#endif
            return m_id;
        }   // getID
        // --------------------------------------------------------------------

        InputDevice* getDevice() const
        {
#ifdef DEBUG
            assert(m_magic_number == 0xAC1EF1AE);
#endif
            return m_device;
        }   // getDevice

        // --------------------------------------------------------------------
        void setDevice(InputDevice* device);

        // --------------------------------------------------------------------
        void setKart(AbstractKart *kart)
        {
#ifdef DEBUG
            assert(m_magic_number == 0xAC1EF1AE);
#endif
            m_kart = kart;
        }   // setKart

        // --------------------------------------------------------------------
        AbstractKart* getKart()
        {
#ifdef DEBUG
            assert(m_magic_number == 0xAC1EF1AE);
#endif
            return m_kart;
        }   // getKart

    };   // ActivePlayer

    // ========================================================================
    const PtrVector<ActivePlayer, HOLD>& getActivePlayers()
                                 { return m_active_players; }
    ActivePlayer* getActivePlayer(const int id);

    const PlayerProfile* getActivePlayerProfile(const int id);

    int createActivePlayer(PlayerProfile *profile, InputDevice *device);
    void removeActivePlayer(int id);

    unsigned int activePlayerCount();
    void resetActivePlayers();

    void escapePressed();

    virtual void onGameStateChange(GUIEngine::GameState new_state);

    virtual void onStackEmptied();

    virtual void onTopMostScreenChanged();

    // singleton
    static StateManager* get();
    static void deallocate();
    static void clear();
    void clearMenuStack() { m_menu_stack.clear(); }
private:
    PtrVector<ActivePlayer, HOLD> m_active_players;
};

#endif