Magic_Game/src/kiwano/core/EventDispatcher.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#pragma once
#include <kiwano/core/EventListener.h>

namespace kiwano
{
/**
 * \~chinese
 * @brief <EFBFBD>¼<EFBFBD><EFBFBD>ַ<EFBFBD>ϵͳ
 */
class KGE_API EventDispatcher
{
public:
    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>б<EFBFBD>
    using Listeners = IntrusiveList<EventListenerPtr>;

    /// \~chinese
    /// @brief <20><><EFBFBD>Ӽ<EFBFBD><D3BC><EFBFBD><EFBFBD><EFBFBD>
    EventListener* AddListener(EventListenerPtr listener);

    /// \~chinese
    /// @brief <20><><EFBFBD>Ӽ<EFBFBD><D3BC><EFBFBD><EFBFBD><EFBFBD>
    EventListener* AddListener(EventListener* listener);

    /// \~chinese
    /// @brief <20><><EFBFBD>Ӽ<EFBFBD><D3BC><EFBFBD><EFBFBD><EFBFBD>
    /// @param type <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD><C2BC><EFBFBD><EFBFBD><EFBFBD>
    /// @param callback <20>ص<EFBFBD><D8B5><EFBFBD><EFBFBD><EFBFBD>
    EventListener* AddListener(EventType type, EventListener::Callback callback);

    /// \~chinese
    /// @brief <20><><EFBFBD>Ӽ<EFBFBD><D3BC><EFBFBD><EFBFBD><EFBFBD>
    /// @param name <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param type <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD><C2BC><EFBFBD><EFBFBD><EFBFBD>
    /// @param callback <20>ص<EFBFBD><D8B5><EFBFBD><EFBFBD><EFBFBD>
    EventListener* AddListener(String const& name, EventType type, EventListener::Callback callback);

    /// \~chinese
    /// @brief <20><><EFBFBD>Ӽ<EFBFBD><D3BC><EFBFBD><EFBFBD><EFBFBD>
    /// @tparam _EventTy <20>¼<EFBFBD><C2BC><EFBFBD><EFBFBD><EFBFBD>
    /// @param callback <20>ص<EFBFBD><D8B5><EFBFBD><EFBFBD><EFBFBD>
    template <typename _EventTy, typename = typename std::enable_if<IsEvent<_EventTy>::value, int>::type>
    EventListener* AddListener(EventListener::Callback callback)
    {
        return AddListener(KGE_EVENT(_EventTy), callback);
    }

    /// \~chinese
    /// @brief <20><><EFBFBD>Ӽ<EFBFBD><D3BC><EFBFBD><EFBFBD><EFBFBD>
    /// @tparam _EventTy <20>¼<EFBFBD><C2BC><EFBFBD><EFBFBD><EFBFBD>
    /// @param name <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param callback <20>ص<EFBFBD><D8B5><EFBFBD><EFBFBD><EFBFBD>
    template <typename _EventTy, typename = typename std::enable_if<IsEvent<_EventTy>::value, int>>
    EventListener* AddListener(String const& name, EventListener::Callback callback)
    {
        return AddListener(name, KGE_EVENT(_EventTy), callback);
    }

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param name <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    void StartListeners(String const& name);

    /// \~chinese
    /// @brief ֹͣ<CDA3><D6B9><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param name <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    void StopListeners(String const& name);

    /// \~chinese
    /// @brief <20>Ƴ<EFBFBD><C6B3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param name <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    void RemoveListeners(String const& name);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param type <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD><C2BC><EFBFBD><EFBFBD><EFBFBD>
    void StartListeners(const EventType& type);

    /// \~chinese
    /// @brief ֹͣ<CDA3><D6B9><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param type <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD><C2BC><EFBFBD><EFBFBD><EFBFBD>
    void StopListeners(const EventType& type);

    /// \~chinese
    /// @brief <20>Ƴ<EFBFBD><C6B3><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    /// @param type <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>¼<EFBFBD><C2BC><EFBFBD><EFBFBD><EFBFBD>
    void RemoveListeners(const EventType& type);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>м<EFBFBD><D0BC><EFBFBD><EFBFBD><EFBFBD>
    void StartAllListeners();

    /// \~chinese
    /// @brief ֹͣ<CDA3><D6B9><EFBFBD>м<EFBFBD><D0BC><EFBFBD><EFBFBD><EFBFBD>
    void StopAllListeners();

    /// \~chinese
    /// @brief <20>Ƴ<EFBFBD><C6B3><EFBFBD><EFBFBD>м<EFBFBD><D0BC><EFBFBD><EFBFBD><EFBFBD>
    void RemoveAllListeners();

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD>м<EFBFBD><D0BC><EFBFBD><EFBFBD><EFBFBD>
    const Listeners& GetAllListeners() const;

    /// \~chinese
    /// @brief <20>ַ<EFBFBD><D6B7>¼<EFBFBD>
    /// @param evt <20>¼<EFBFBD>
    /// @return <20>Ƿ<EFBFBD><C7B7><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ַ<EFBFBD><D6B7><EFBFBD><EFBFBD>¼<EFBFBD>
    bool DispatchEvent(Event* evt);

private:
    Listeners listeners_;
};
}  // namespace kiwano