event.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2010-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  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
 *  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, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <any>
#include <map>
#include <set>
#include <string>
 
class ActorSprite;
class Item;
 
// Possible exception that can be thrown
enum BadEvent {
    BAD_KEY,
    BAD_VALUE,
    KEY_ALREADY_EXISTS
};
 
class EventListener;
class VariableData;
 
class Event
{
public:
    enum Channel
    {
        ActorSpriteChannel,
        AttributesChannel,
        BuySellChannel,
        ChatChannel,
        ClientChannel,
        ConfigChannel,
        GameChannel,
        ItemChannel,
        NoticesChannel,
        NpcChannel,
        StorageChannel,
        QuestsChannel
    };
 
    enum Type
    {
        Announcement,
        Being,
        ClearDialog,
        Close,
        CloseAll,
        CloseDialog,
        ConfigOptionChanged,
        Constructed,
        LoadingDatabases,
        Destroyed,
        Destructed,
        Destructing,
        DoCloseInventory,
        DoDrop,
        DoEquip,
        DoMove,
        DoUnequip,
        DoUse,
        EnginesInitialized,
        EnginesInitializing,
        GuiWindowsLoaded,
        GuiWindowsLoading,
        GuiWindowsUnloaded,
        GuiWindowsUnloading,
        IntegerInput,
        MapLoaded,
        Menu,
        Message,
        Next,
        NpcCount,
        Player,
        Post,
        PostCount,
        ServerNotice,
        StateChange,
        StorageCount,
        StringInput,
        UpdateAttribute,
        UpdateStat,
        UpdateStatusEffect,
        Whisper,
        WhisperError,
        QuestVarsChanged,
    };
 
    Event(Type type)
        : mType(type)
    {}
 
    template<typename T>
    Event(Type type, const T &value)
        : mType(type)
        , mValue(value)
    {}
 
    ~Event();
 
    Type getType() const
    { return mType; }
 
    template<typename T>
    void setValue(const T &value)
    { mValue = value; }
 
    template<typename T>
    const T &value() const
    { return std::any_cast<const T &>(mValue); }
 
    template<typename T>
    bool hasValue(const T &value) const
    { return mValue.type() == typeid(T) && Event::value<T>() == value; }
 
// Integers
 
    void setInt(const std::string &key, int value);
 
    int getInt(const std::string &key) const;
 
    int getInt(const std::string &key, int defaultValue) const
    { try { return getInt(key); } catch (BadEvent) { return defaultValue; }}
 
// Strings
 
    void setString(const std::string &key, const std::string &value);
 
    const std::string &getString(const std::string &key) const;
 
    std::string getString(const std::string &key,
                          const std::string &defaultValue) const
    { try { return getString(key); } catch (BadEvent) { return defaultValue; }}
 
// Floats
 
    void setFloat(const std::string &key, double value);
 
    double getFloat(const std::string &key) const;
 
    double getFloat(const std::string &key, float defaultValue) const
    { try { return getFloat(key); } catch (BadEvent) { return defaultValue; }}
 
// Booleans
 
    void setBool(const std::string &key, bool value);
 
    bool getBool(const std::string &key) const;
 
    bool getBool(const std::string &key, bool defaultValue) const
    { try { return getBool(key); } catch (BadEvent) { return defaultValue; }}
 
// Items
 
    void setItem(const std::string &key, Item *value);
 
    Item *getItem(const std::string &key) const;
 
    Item *getItem(const std::string &key, Item *defaultValue) const
    { try { return getItem(key); } catch (BadEvent) { return defaultValue; }}
 
// ActorSprites
 
    void setActor(const std::string &key, ActorSprite *value);
 
    ActorSprite *getActor(const std::string &key) const;
 
    ActorSprite *getActor(const std::string &key,
                          ActorSprite *defaultValue) const
    { try { return getActor(key); } catch (BadEvent) { return defaultValue; }}
 
// Triggers
 
    void trigger(Channel channel) const
    { trigger(channel, *this); }
 
    static void trigger(Channel channel, const Event &event);
 
    static void trigger(Channel channel, Type type)
    { trigger(channel, Event(type)); }
 
protected:
    friend class EventListener;
 
    static void bind(EventListener *listener, Channel channel);
 
    static void unbind(EventListener *listener, Channel channel);
 
    static void remove(EventListener *listener);
 
private:
    using ListenMap = std::map<Channel, std::set<EventListener *>>;
    static ListenMap mBindings;
 
    const Type mType;
    std::map<std::string, VariableData *> mData;
    std::any mValue;
};
 
inline void serverNotice(const std::string &message)
{
    Event event(Event::ServerNotice);
    event.setString("message", message);
    event.trigger(Event::NoticesChannel);
}