mirror of
https://github.com/quizhizhe/LiteLoaderBDS-1.16.40.git
synced 2025-06-06 12:03:39 +00:00
328 lines
10 KiB
C++
328 lines
10 KiB
C++
#ifndef ENTT_SIGNAL_EMITTER_HPP
|
|
#define ENTT_SIGNAL_EMITTER_HPP
|
|
|
|
|
|
#include <algorithm>
|
|
#include <functional>
|
|
#include <iterator>
|
|
#include <list>
|
|
#include <memory>
|
|
#include <type_traits>
|
|
#include <utility>
|
|
#include <vector>
|
|
#include "../config/config.h"
|
|
#include "../core/fwd.hpp"
|
|
#include "../core/type_info.hpp"
|
|
|
|
|
|
namespace entt {
|
|
|
|
|
|
/**
|
|
* @brief General purpose event emitter.
|
|
*
|
|
* The emitter class template follows the CRTP idiom. To create a custom emitter
|
|
* type, derived classes must inherit directly from the base class as:
|
|
*
|
|
* @code{.cpp}
|
|
* struct my_emitter: emitter<my_emitter> {
|
|
* // ...
|
|
* }
|
|
* @endcode
|
|
*
|
|
* Pools for the type of events are created internally on the fly. It's not
|
|
* required to specify in advance the full list of accepted types.<br/>
|
|
* Moreover, whenever an event is published, an emitter provides the listeners
|
|
* with a reference to itself along with a reference to the event. Therefore
|
|
* listeners have an handy way to work with it without incurring in the need of
|
|
* capturing a reference to the emitter.
|
|
*
|
|
* @tparam Derived Actual type of emitter that extends the class template.
|
|
*/
|
|
template<typename Derived>
|
|
class emitter {
|
|
struct basic_pool {
|
|
virtual ~basic_pool() = default;
|
|
virtual bool empty() const ENTT_NOEXCEPT = 0;
|
|
virtual void clear() ENTT_NOEXCEPT = 0;
|
|
};
|
|
|
|
template<typename Event>
|
|
struct pool_handler final: basic_pool {
|
|
static_assert(std::is_same_v<Event, std::decay_t<Event>>, "Invalid event type");
|
|
|
|
using listener_type = std::function<void(Event &, Derived &)>;
|
|
using element_type = std::pair<bool, listener_type>;
|
|
using container_type = std::list<element_type>;
|
|
using connection_type = typename container_type::iterator;
|
|
|
|
[[nodiscard]] bool empty() const ENTT_NOEXCEPT override {
|
|
auto pred = [](auto &&element) { return element.first; };
|
|
|
|
return std::all_of(once_list.cbegin(), once_list.cend(), pred) &&
|
|
std::all_of(on_list.cbegin(), on_list.cend(), pred);
|
|
}
|
|
|
|
void clear() ENTT_NOEXCEPT override {
|
|
if(publishing) {
|
|
for(auto &&element: once_list) {
|
|
element.first = true;
|
|
}
|
|
|
|
for(auto &&element: on_list) {
|
|
element.first = true;
|
|
}
|
|
} else {
|
|
once_list.clear();
|
|
on_list.clear();
|
|
}
|
|
}
|
|
|
|
connection_type once(listener_type listener) {
|
|
return once_list.emplace(once_list.cend(), false, std::move(listener));
|
|
}
|
|
|
|
connection_type on(listener_type listener) {
|
|
return on_list.emplace(on_list.cend(), false, std::move(listener));
|
|
}
|
|
|
|
void erase(connection_type conn) {
|
|
conn->first = true;
|
|
|
|
if(!publishing) {
|
|
auto pred = [](auto &&element) { return element.first; };
|
|
once_list.remove_if(pred);
|
|
on_list.remove_if(pred);
|
|
}
|
|
}
|
|
|
|
void publish(Event &event, Derived &ref) {
|
|
container_type swap_list;
|
|
once_list.swap(swap_list);
|
|
|
|
publishing = true;
|
|
|
|
for(auto &&element: on_list) {
|
|
element.first ? void() : element.second(event, ref);
|
|
}
|
|
|
|
for(auto &&element: swap_list) {
|
|
element.first ? void() : element.second(event, ref);
|
|
}
|
|
|
|
publishing = false;
|
|
|
|
on_list.remove_if([](auto &&element) { return element.first; });
|
|
}
|
|
|
|
private:
|
|
bool publishing{false};
|
|
container_type once_list{};
|
|
container_type on_list{};
|
|
};
|
|
|
|
template<typename Event>
|
|
[[nodiscard]] pool_handler<Event> * assure() {
|
|
const auto index = type_seq<Event>::value();
|
|
|
|
if(!(index < pools.size())) {
|
|
pools.resize(std::size_t(index)+1u);
|
|
}
|
|
|
|
if(!pools[index]) {
|
|
pools[index].reset(new pool_handler<Event>{});
|
|
}
|
|
|
|
return static_cast<pool_handler<Event> *>(pools[index].get());
|
|
}
|
|
|
|
template<typename Event>
|
|
[[nodiscard]] const pool_handler<Event> * assure() const {
|
|
const auto index = type_seq<Event>::value();
|
|
return (!(index < pools.size()) || !pools[index]) ? nullptr : static_cast<const pool_handler<Event> *>(pools[index].get());
|
|
}
|
|
|
|
public:
|
|
/** @brief Type of listeners accepted for the given event. */
|
|
template<typename Event>
|
|
using listener = typename pool_handler<Event>::listener_type;
|
|
|
|
/**
|
|
* @brief Generic connection type for events.
|
|
*
|
|
* Type of the connection object returned by the event emitter whenever a
|
|
* listener for the given type is registered.<br/>
|
|
* It can be used to break connections still in use.
|
|
*
|
|
* @tparam Event Type of event for which the connection is created.
|
|
*/
|
|
template<typename Event>
|
|
struct connection: private pool_handler<Event>::connection_type {
|
|
/** @brief Event emitters are friend classes of connections. */
|
|
friend class emitter;
|
|
|
|
/*! @brief Default constructor. */
|
|
connection() = default;
|
|
|
|
/**
|
|
* @brief Creates a connection that wraps its underlying instance.
|
|
* @param conn A connection object to wrap.
|
|
*/
|
|
connection(typename pool_handler<Event>::connection_type conn)
|
|
: pool_handler<Event>::connection_type{std::move(conn)}
|
|
{}
|
|
};
|
|
|
|
/*! @brief Default constructor. */
|
|
emitter() = default;
|
|
|
|
/*! @brief Default destructor. */
|
|
virtual ~emitter() {
|
|
static_assert(std::is_base_of_v<emitter<Derived>, Derived>, "Incorrect use of the class template");
|
|
}
|
|
|
|
/*! @brief Default move constructor. */
|
|
emitter(emitter &&) = default;
|
|
|
|
/*! @brief Default move assignment operator. @return This emitter. */
|
|
emitter & operator=(emitter &&) = default;
|
|
|
|
/**
|
|
* @brief Emits the given event.
|
|
*
|
|
* All the listeners registered for the specific event type are invoked with
|
|
* the given event. The event type must either have a proper constructor for
|
|
* the arguments provided or be an aggregate type.
|
|
*
|
|
* @tparam Event Type of event to publish.
|
|
* @tparam Args Types of arguments to use to construct the event.
|
|
* @param args Parameters to use to initialize the event.
|
|
*/
|
|
template<typename Event, typename... Args>
|
|
void publish(Args &&... args) {
|
|
Event instance{std::forward<Args>(args)...};
|
|
assure<Event>()->publish(instance, *static_cast<Derived *>(this));
|
|
}
|
|
|
|
/**
|
|
* @brief Registers a long-lived listener with the event emitter.
|
|
*
|
|
* This method can be used to register a listener designed to be invoked
|
|
* more than once for the given event type.<br/>
|
|
* The connection returned by the method can be freely discarded. It's meant
|
|
* to be used later to disconnect the listener if required.
|
|
*
|
|
* The listener is as a callable object that can be moved and the type of
|
|
* which is _compatible_ with `void(Event &, Derived &)`.
|
|
*
|
|
* @note
|
|
* Whenever an event is emitted, the emitter provides the listener with a
|
|
* reference to the derived class. Listeners don't have to capture those
|
|
* instances for later uses.
|
|
*
|
|
* @tparam Event Type of event to which to connect the listener.
|
|
* @param instance The listener to register.
|
|
* @return Connection object that can be used to disconnect the listener.
|
|
*/
|
|
template<typename Event>
|
|
connection<Event> on(listener<Event> instance) {
|
|
return assure<Event>()->on(std::move(instance));
|
|
}
|
|
|
|
/**
|
|
* @brief Registers a short-lived listener with the event emitter.
|
|
*
|
|
* This method can be used to register a listener designed to be invoked
|
|
* only once for the given event type.<br/>
|
|
* The connection returned by the method can be freely discarded. It's meant
|
|
* to be used later to disconnect the listener if required.
|
|
*
|
|
* The listener is as a callable object that can be moved and the type of
|
|
* which is _compatible_ with `void(Event &, Derived &)`.
|
|
*
|
|
* @note
|
|
* Whenever an event is emitted, the emitter provides the listener with a
|
|
* reference to the derived class. Listeners don't have to capture those
|
|
* instances for later uses.
|
|
*
|
|
* @tparam Event Type of event to which to connect the listener.
|
|
* @param instance The listener to register.
|
|
* @return Connection object that can be used to disconnect the listener.
|
|
*/
|
|
template<typename Event>
|
|
connection<Event> once(listener<Event> instance) {
|
|
return assure<Event>()->once(std::move(instance));
|
|
}
|
|
|
|
/**
|
|
* @brief Disconnects a listener from the event emitter.
|
|
*
|
|
* Do not use twice the same connection to disconnect a listener, it results
|
|
* in undefined behavior. Once used, discard the connection object.
|
|
*
|
|
* @tparam Event Type of event of the connection.
|
|
* @param conn A valid connection.
|
|
*/
|
|
template<typename Event>
|
|
void erase(connection<Event> conn) {
|
|
assure<Event>()->erase(std::move(conn));
|
|
}
|
|
|
|
/**
|
|
* @brief Disconnects all the listeners for the given event type.
|
|
*
|
|
* All the connections previously returned for the given event are
|
|
* invalidated. Using them results in undefined behavior.
|
|
*
|
|
* @tparam Event Type of event to reset.
|
|
*/
|
|
template<typename Event>
|
|
void clear() {
|
|
assure<Event>()->clear();
|
|
}
|
|
|
|
/**
|
|
* @brief Disconnects all the listeners.
|
|
*
|
|
* All the connections previously returned are invalidated. Using them
|
|
* results in undefined behavior.
|
|
*/
|
|
void clear() ENTT_NOEXCEPT {
|
|
for(auto &&cpool: pools) {
|
|
if(cpool) {
|
|
cpool->clear();
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @brief Checks if there are listeners registered for the specific event.
|
|
* @tparam Event Type of event to test.
|
|
* @return True if there are no listeners registered, false otherwise.
|
|
*/
|
|
template<typename Event>
|
|
[[nodiscard]] bool empty() const {
|
|
const auto *cpool = assure<Event>();
|
|
return !cpool || cpool->empty();
|
|
}
|
|
|
|
/**
|
|
* @brief Checks if there are listeners registered with the event emitter.
|
|
* @return True if there are no listeners registered, false otherwise.
|
|
*/
|
|
[[nodiscard]] bool empty() const ENTT_NOEXCEPT {
|
|
return std::all_of(pools.cbegin(), pools.cend(), [](auto &&cpool) {
|
|
return !cpool || cpool->empty();
|
|
});
|
|
}
|
|
|
|
private:
|
|
std::vector<std::unique_ptr<basic_pool>> pools{};
|
|
};
|
|
|
|
|
|
}
|
|
|
|
|
|
#endif
|