Typesafe事件系统的实现

时间:2017-11-25 12:02:53

标签: c++ c++11 templates events

我为自己的游戏编写了一个事件系统。它运行正常,但有一个很大的缺陷 - 它不是类型安全的,因此需要订阅的回调函数来手动转换接收的基本事件。现在,我正在尝试使用模板实现类型安全版本。我对这个话题一般都很好,但显然不是专家。

首先,这里有一些代码展示我想如何使用该事件:

定义派生事件

// Derived Events
class ClickEvent : public Event
{
public:
    float x;
    float y;
};

class RenderNodeCreatedEvent : public Event
{
public:
    unsigned long long int renderNodeId;
};

创建并使用它们(例如,在主程序中用于测试目的)

// Create the on event functions
std::function<void(const ClickEvent &)> onClickFunction = [](const ClickEvent & event)
{
    std::cout << std::endl << "Mouse clicked at position: " << event.x << event.y;
};

std::function<void(const RenderNodeCreatedEvent &)> onRenderNodeCreatedFunction = [](const RenderNodeCreatedEvent & event)
{
    std::cout << std::endl << "Render node created with id: " << event.renderNodeId;
};

// Create the events
ClickEvent clickEvent;
clickEvent.x = 300.f;
clickEvent.y = 255.5f;

RenderNodeCreatedEvent renderNodeCreatedEvent;
renderNodeCreatedEvent.renderNodeId = 26234628374324;

// Create the event manager and subscribe the event functions
EventManager eventManager;
eventManager.Subscribe(onClickFunction);
eventManager.Subscribe(onRenderNodeCreatedFunction);

// Raise the events
eventManager.Raise(clickEvent);
eventManager.Raise(renderNodeCreatedEvent);

以下是我尝试为每个派生事件类生成std::size_t类型的唯一ID:

class BaseEvent
{
public:
    typedef std::size_t ID;

    BaseEvent() = default;
    virtual ~BaseEvent() = default;

protected:
    static ID GetNextID()
    {
        static ID id = 0;
        return id++;
    }
};

class Event : public BaseEvent
{
public:
    Event() = default;
    virtual ~Event() = default;

    // Sets a unique id for the event the first time this function is called
    ID GetID()
    {
        static ID id = BaseEvent::GetNextID();
        return id;
    }
};

最后,这是我(可怕)尝试一个可以提供上述功能的事件管理器。我真的很难管理正确的转换和/或存储不同类型的回调函数。回调包装器不起作用 - 这只是我必须解决这个问题的一个基本想法,所以我把它包含在帖子中。

class EventManager
{
public:
    // Define the template callback type
    template <class DerivedEvent>
    using TCallback = std::function<void(const DerivedEvent &)>;

public:
    EventManager() = default;
    ~EventManager() = default;

    template<class DerivedEvent>
    void Subscribe(TCallback<DerivedEvent> callback)
    {
        // Get the index of the callback list this callback will be added to
        Event::ID id = DerivedEvent::GetID();

        // This won't work sinve TCallback is a different type than TCallback<Event>
        callbackListList[id].push_back(callback);
    }

    template <class DerivedEvent>
    void Raise(DerivedEvent event)
    {
        // Get the type of the event and therefore the index in the callbackListList
        Event::ID = DerivedEvent::GetID();

        /// How to cast the events back
        // Get the respective list of callback functions
        std::vector<TCallback<DerivedEvent>> /*&*/ callbackList;

        // Create a callback wrapper of with the type 'derived event' ?????
        CallbackWrapper<DerivedEvent> callbackWrapper(/*derived callback*/);
        // Call the callback wrapper using the base event ?????
    }

    template <typename DerivedEvent>
    class CallbackWrapper
    {
    public:
        CallbackWrapper(TCallback<DerivedEvent> callback) : callback(callback) {}

        void operator () (const Event & event)
        {
            callback(static_cast<const Event<DerivedEvent> &>(event).event);
        }

    private:
        TCallback<DerivedEvent> callback;
    };

private:
    std::vector<std::vector<TCallback<Event>>> callbackListList;
};

我知道这是很多代码,但我觉得这是展示我所说内容的最简单方法。

感谢您的帮助,Adrian

编辑: 必须将Event类声明为模板,以获取派生类型的唯一ID。

template <class DerivedEvent>
class Event : public BaseEvent

现在继承自Event:

class ClickEvent : public Event<ClickEvent>
class RenderNodeCreatedEvent : public Event<RenderNodeCreatedEvent>

最后,EventManager只能存储 BaseEvent

类型的回调向量的向量
private:
    std::vector<std::vector<TCallback<BaseEvent>>> callbackListList;

0 个答案:

没有答案