aboutsummaryrefslogtreecommitdiff
path: root/include/cru/common/Event.hpp
diff options
context:
space:
mode:
authorcrupest <crupest@outlook.com>2022-02-08 16:53:51 +0800
committercrupest <crupest@outlook.com>2022-02-08 16:53:51 +0800
commit74bb9cd27242b9320f99ff4d2b50c3051576cc14 (patch)
tree744bac5799c593d1d6f81e7b09581bea626f2cde /include/cru/common/Event.hpp
parentb90c398de829d1ba5329651d75bae82f5e4085fe (diff)
downloadcru-74bb9cd27242b9320f99ff4d2b50c3051576cc14.tar.gz
cru-74bb9cd27242b9320f99ff4d2b50c3051576cc14.tar.bz2
cru-74bb9cd27242b9320f99ff4d2b50c3051576cc14.zip
...
Diffstat (limited to 'include/cru/common/Event.hpp')
-rw-r--r--include/cru/common/Event.hpp281
1 files changed, 0 insertions, 281 deletions
diff --git a/include/cru/common/Event.hpp b/include/cru/common/Event.hpp
deleted file mode 100644
index 5d60c5b3..00000000
--- a/include/cru/common/Event.hpp
+++ /dev/null
@@ -1,281 +0,0 @@
-#pragma once
-#include "Base.hpp"
-
-#include "SelfResolvable.hpp"
-
-#include <algorithm>
-#include <functional>
-#include <initializer_list>
-#include <memory>
-#include <utility>
-#include <vector>
-
-namespace cru {
-class EventRevoker;
-
-namespace details {
-template <class>
-inline constexpr bool always_false_v = false;
-
-// Base class of all Event<T...>.
-// It erases event args types and provides a
-// unified form to create event revoker and
-// revoke(remove) handler.
-class EventBase : public SelfResolvable<EventBase> {
- friend EventRevoker;
-
- protected:
- using EventHandlerToken = long;
-
- EventBase() {}
- CRU_DELETE_COPY(EventBase)
- CRU_DEFAULT_MOVE(EventBase)
- virtual ~EventBase() = default;
-
- // Remove the handler with the given token. If the token
- // corresponds to no handler (which might have be revoked
- // before), then nothing will be done.
- virtual void RemoveHandler(EventHandlerToken token) = 0;
-
- // Create a revoker with the given token.
- inline EventRevoker CreateRevoker(EventHandlerToken token);
-};
-} // namespace details
-
-// A non-copyable and movable event revoker.
-// Call function call operator to revoke the handler.
-class EventRevoker {
- friend details::EventBase;
-
- private:
- EventRevoker(ObjectResolver<details::EventBase>&& resolver,
- details::EventBase::EventHandlerToken token)
- : resolver_(std::move(resolver)), token_(token) {}
-
- public:
- EventRevoker(const EventRevoker& other) = default;
- EventRevoker(EventRevoker&& other) = default;
- EventRevoker& operator=(const EventRevoker& other) = default;
- EventRevoker& operator=(EventRevoker&& other) = default;
- ~EventRevoker() = default;
-
- // Revoke the registered handler. If the event has already
- // been destroyed, then nothing will be done. If one of the
- // copies calls this, then other copies's calls will have no
- // effect. (They have the same token.)
- void operator()() const {
- if (const auto event = resolver_.Resolve()) {
- event->RemoveHandler(token_);
- }
- }
-
- private:
- ObjectResolver<details::EventBase> resolver_;
- details::EventBase::EventHandlerToken token_;
-};
-
-inline EventRevoker details::EventBase::CreateRevoker(EventHandlerToken token) {
- return EventRevoker(CreateResolver(), token);
-}
-
-// int -> int
-// Point -> const Point&
-// int& -> int&
-template <typename TRaw>
-using DeducedEventArgs = std::conditional_t<
- std::is_lvalue_reference_v<TRaw>, TRaw,
- std::conditional_t<std::is_scalar_v<TRaw>, TRaw, const TRaw&>>;
-
-struct IBaseEvent {
- protected:
- IBaseEvent() = default;
- CRU_DELETE_COPY(IBaseEvent)
- CRU_DEFAULT_MOVE(IBaseEvent)
- ~IBaseEvent() = default; // Note that user can't destroy a Event via IEvent.
- // So destructor should be protected.
-
- using SpyOnlyHandler = std::function<void()>;
-
- public:
- virtual EventRevoker AddSpyOnlyHandler(SpyOnlyHandler handler) = 0;
-};
-
-// Provides an interface of event.
-// IEvent only allow to add handler but not to raise the event. You may
-// want to create an Event object and expose IEvent only so users won't
-// be able to emit the event.
-template <typename TEventArgs>
-struct IEvent : virtual IBaseEvent {
- public:
- using EventArgs = DeducedEventArgs<TEventArgs>;
- using EventHandler = std::function<void(EventArgs)>;
- using ShortCircuitHandler = std::function<bool(EventArgs)>;
-
- protected:
- IEvent() = default;
- CRU_DELETE_COPY(IEvent)
- CRU_DEFAULT_MOVE(IEvent)
- ~IEvent() = default; // Note that user can't destroy a Event via IEvent. So
- // destructor should be protected.
-
- public:
- virtual EventRevoker AddHandler(EventHandler handler) = 0;
- virtual EventRevoker AddShortCircuitHandler(ShortCircuitHandler handler) = 0;
- virtual EventRevoker PrependShortCircuitHandler(
- ShortCircuitHandler handler) = 0;
-};
-
-// A non-copyable non-movable Event class.
-// It stores a list of event handlers.
-template <typename TEventArgs>
-class Event : public details::EventBase, public IEvent<TEventArgs> {
- using typename IEvent<TEventArgs>::EventArgs;
-
- using typename IBaseEvent::SpyOnlyHandler;
- using typename IEvent<TEventArgs>::EventHandler;
- using typename IEvent<TEventArgs>::ShortCircuitHandler;
-
- private:
- struct HandlerData {
- HandlerData(EventHandlerToken token, ShortCircuitHandler handler)
- : token(token), handler(std::move(handler)) {}
- EventHandlerToken token;
- ShortCircuitHandler handler;
- };
-
- public:
- Event() = default;
- CRU_DELETE_COPY(Event)
- CRU_DEFAULT_MOVE(Event)
- ~Event() = default;
-
- EventRevoker AddSpyOnlyHandler(SpyOnlyHandler handler) override {
- return AddShortCircuitHandler([handler = std::move(handler)](EventArgs) {
- handler();
- return false;
- });
- }
-
- EventRevoker AddHandler(EventHandler handler) override {
- return AddShortCircuitHandler(
- [handler = std::move(handler)](EventArgs args) {
- handler(args);
- return false;
- });
- }
-
- // Handler return true to short circuit following handlers.
- EventRevoker AddShortCircuitHandler(ShortCircuitHandler handler) override {
- const auto token = current_token_++;
- this->handler_data_list_.emplace_back(token, std::move(handler));
- return CreateRevoker(token);
- }
-
- // Handler return true to short circuit following handlers.
- EventRevoker PrependShortCircuitHandler(
- ShortCircuitHandler handler) override {
- const auto token = current_token_++;
- this->handler_data_list_.emplace(this->handler_data_list_.cbegin(), token,
- std::move(handler));
- return CreateRevoker(token);
- }
-
- // This method will make a copy of all handlers. Because user might delete a
- // handler in a handler, which may lead to seg fault as the handler is
- // deleted while being executed. Thanks to this behavior, all handlers will
- // be taken a snapshot when Raise is called, so even if you delete a handler
- // during this period, all handlers in the snapshot will be executed.
- void Raise(EventArgs args) {
- std::vector<ShortCircuitHandler> handlers;
- handlers.reserve(this->handler_data_list_.size());
- for (const auto& data : this->handler_data_list_) {
- handlers.push_back(data.handler);
- }
- for (const auto& handler : handlers) {
- auto short_circuit = handler(args);
- if (short_circuit) return;
- }
- }
-
- protected:
- void RemoveHandler(EventHandlerToken token) override {
- const auto find_result = std::find_if(
- this->handler_data_list_.cbegin(), this->handler_data_list_.cend(),
- [token](const HandlerData& data) { return data.token == token; });
- if (find_result != this->handler_data_list_.cend()) {
- this->handler_data_list_.erase(find_result);
- }
- }
-
- private:
- std::vector<HandlerData> handler_data_list_;
- EventHandlerToken current_token_ = 0;
-};
-
-namespace details {
-struct EventRevokerDestroyer {
- void operator()(EventRevoker* p) {
- (*p)();
- delete p;
- }
-};
-} // namespace details
-
-// A guard class for event revoker. Automatically revoke it when destroyed.
-class EventRevokerGuard {
- public:
- EventRevokerGuard() = default;
- explicit EventRevokerGuard(EventRevoker&& revoker)
- : revoker_(new EventRevoker(std::move(revoker))) {}
- EventRevokerGuard(const EventRevokerGuard& other) = delete;
- EventRevokerGuard(EventRevokerGuard&& other) = default;
- EventRevokerGuard& operator=(const EventRevokerGuard& other) = delete;
- EventRevokerGuard& operator=(EventRevokerGuard&& other) = default;
- ~EventRevokerGuard() = default;
-
- EventRevoker Get() {
- // revoker is only null when this is moved
- // you shouldn't use a moved instance
- Expects(revoker_);
- return *revoker_;
- }
-
- EventRevoker Release() { return std::move(*revoker_.release()); }
-
- void Reset() { revoker_.reset(); }
-
- void Reset(EventRevoker&& revoker) {
- revoker_.reset(new EventRevoker(std::move(revoker)));
- }
-
- private:
- std::unique_ptr<EventRevoker, details::EventRevokerDestroyer> revoker_;
-};
-
-class EventRevokerListGuard {
- public:
- EventRevokerListGuard() = default;
- EventRevokerListGuard(const EventRevokerListGuard& other) = delete;
- EventRevokerListGuard(EventRevokerListGuard&& other) = default;
- EventRevokerListGuard& operator=(const EventRevokerListGuard& other) = delete;
- EventRevokerListGuard& operator=(EventRevokerListGuard&& other) = default;
- ~EventRevokerListGuard() = default;
-
- public:
- void Add(EventRevoker&& revoker) {
- event_revoker_guard_list_.push_back(EventRevokerGuard(std::move(revoker)));
- }
-
- EventRevokerListGuard& operator+=(EventRevoker&& revoker) {
- this->Add(std::move(revoker));
- return *this;
- }
-
- void Clear() { event_revoker_guard_list_.clear(); }
-
- bool IsEmpty() const { return event_revoker_guard_list_.empty(); }
-
- private:
- std::vector<EventRevokerGuard> event_revoker_guard_list_;
-};
-} // namespace cru