From e6644d6b235005de9ba1b9884472fa5f5d8d6074 Mon Sep 17 00:00:00 2001 From: HampusM Date: Sun, 20 Mar 2022 18:49:49 +0100 Subject: refactor: update event system terminology & structure --- src/engine/engine.cpp | 2 +- src/engine/user/input.cpp | 24 +++++++++++++----------- src/engine/user/input.hpp | 17 +++++++++-------- src/interfaces/command.hpp | 11 ++++++++++- src/interfaces/engine.hpp | 2 -- src/interfaces/input.hpp | 20 +++++++++++++------- src/interfaces/observable.hpp | 20 -------------------- src/interfaces/publisher.hpp | 20 ++++++++++++++++++++ src/interfaces/subscriber.hpp | 8 ++++++++ 9 files changed, 74 insertions(+), 50 deletions(-) delete mode 100644 src/interfaces/observable.hpp create mode 100644 src/interfaces/publisher.hpp create mode 100644 src/interfaces/subscriber.hpp diff --git a/src/engine/engine.cpp b/src/engine/engine.cpp index ed81ed3..e463f28 100644 --- a/src/engine/engine.cpp +++ b/src/engine/engine.cpp @@ -49,6 +49,6 @@ void CLIGameEngine::_configure_input( auto key = config_pair.first; auto command = config_pair.second; - _input_handler->attach(key, command); + _input_handler->subscribe(key, command); } } diff --git a/src/engine/user/input.cpp b/src/engine/user/input.cpp index f1685fd..5e6f517 100644 --- a/src/engine/user/input.cpp +++ b/src/engine/user/input.cpp @@ -8,25 +8,26 @@ void InputHandler::listen() const noexcept while (read(STDIN_FILENO, &character, 1) == 1) { - notify(character); + notify_subscribers(character, nullptr); } } -void InputHandler::attach(const char &key, - const std::shared_ptr &command) noexcept +void InputHandler::subscribe( + const Event &event, const std::shared_ptr> &subscriber) noexcept { - auto key_index = _key_as_index(key); + auto event_index = _event_as_index(event); - _key_commands.at(key_index).push_back(command); + _subscribers.at(event_index).push_back(subscriber); } -void InputHandler::notify(const char &key) const noexcept +void InputHandler::notify_subscribers(const Event &event, + const Context &context) const noexcept { - auto key_index = _key_as_index(key); + auto event_index = _event_as_index(event); - for (const auto &command : _key_commands.at(key_index)) + for (const auto &subscriber : _subscribers.at(event_index)) { - command->execute(); + subscriber->update(context); } } @@ -58,7 +59,8 @@ void InputHandler::leave_raw_mode() noexcept _original_termios = nullptr; } -InputHandler::_KeyCommandsSizeType InputHandler::_key_as_index(const char &key) noexcept +InputHandler::_SubscribersSizeType +InputHandler::_event_as_index(const Event &event) noexcept { - return static_cast<_KeyCommandsSizeType>(static_cast(key)); + return static_cast<_SubscribersSizeType>(static_cast(event)); } diff --git a/src/engine/user/input.hpp b/src/engine/user/input.hpp index d2aa447..7a3c88e 100644 --- a/src/engine/user/input.hpp +++ b/src/engine/user/input.hpp @@ -1,9 +1,8 @@ #pragma once #include "DI/auto_wirable.hpp" -#include "interfaces/command.hpp" #include "interfaces/input.hpp" -#include "interfaces/observable.hpp" +#include "interfaces/subscriber.hpp" #include #include @@ -18,21 +17,23 @@ public: void listen() const noexcept override; - void attach(const char &key, - const std::shared_ptr &command) noexcept override; + void + subscribe(const Event &event, + const std::shared_ptr> &subscriber) noexcept override; - void notify(const char &key) const noexcept override; + void notify_subscribers(const Event &event, + const Context &context) const noexcept override; void enter_raw_mode() noexcept override; void leave_raw_mode() noexcept override; private: - std::array>, CHAR_MAX> _key_commands; + std::array>>, CHAR_MAX> _subscribers; std::shared_ptr _original_termios = nullptr; - using _KeyCommandsSizeType = decltype(_key_commands)::size_type; + using _SubscribersSizeType = decltype(_subscribers)::size_type; - static _KeyCommandsSizeType _key_as_index(const char &key) noexcept; + static _SubscribersSizeType _event_as_index(const Event &event) noexcept; }; diff --git a/src/interfaces/command.hpp b/src/interfaces/command.hpp index 245bdd6..62d7a59 100644 --- a/src/interfaces/command.hpp +++ b/src/interfaces/command.hpp @@ -1,9 +1,18 @@ #pragma once -class ICommand +#include "interfaces/subscriber.hpp" + +#include + +class ICommand : public ISubscriber { public: virtual ~ICommand() = default; virtual void execute() noexcept = 0; + + void update(const std::nullptr_t & /*context*/) noexcept override + { + execute(); + }; }; diff --git a/src/interfaces/engine.hpp b/src/interfaces/engine.hpp index 498ff41..6830340 100644 --- a/src/interfaces/engine.hpp +++ b/src/interfaces/engine.hpp @@ -1,7 +1,5 @@ #pragma once -#include "interfaces/observable.hpp" - #include class ICLIGameEngine diff --git a/src/interfaces/input.hpp b/src/interfaces/input.hpp index 82ad57c..795ade2 100644 --- a/src/interfaces/input.hpp +++ b/src/interfaces/input.hpp @@ -1,21 +1,27 @@ #pragma once -#include "interfaces/command.hpp" -#include "interfaces/observable.hpp" +#include "interfaces/publisher.hpp" +#include "interfaces/subscriber.hpp" +#include #include -class IInputHandler : public IObservable +class IInputHandler : public IPublisher { public: + using Event = char; + using Context = std::nullptr_t; + ~IInputHandler() noexcept override = default; - void listen() const noexcept override = 0; + virtual void listen() const noexcept = 0; - void attach(const char &key, - const std::shared_ptr &command) noexcept override = 0; + void subscribe( + const Event &event, + const std::shared_ptr> &subscriber) noexcept override = 0; - void notify(const char &key) const noexcept override = 0; + void notify_subscribers(const Event &event, + const Context &context) const noexcept override = 0; virtual void enter_raw_mode() noexcept = 0; diff --git a/src/interfaces/observable.hpp b/src/interfaces/observable.hpp deleted file mode 100644 index 21fed76..0000000 --- a/src/interfaces/observable.hpp +++ /dev/null @@ -1,20 +0,0 @@ -#pragma once - -#include "interfaces/command.hpp" - -#include -#include - -template -class IObservable -{ -public: - virtual ~IObservable() noexcept = default; - - virtual void listen() const noexcept = 0; - - virtual void attach(const char &event, - const std::shared_ptr &command) noexcept = 0; - - virtual void notify(const Event &event) const noexcept = 0; -}; diff --git a/src/interfaces/publisher.hpp b/src/interfaces/publisher.hpp new file mode 100644 index 0000000..14766ed --- /dev/null +++ b/src/interfaces/publisher.hpp @@ -0,0 +1,20 @@ +#pragma once + +#include "interfaces/subscriber.hpp" + +#include +#include + +template +class IPublisher +{ +public: + virtual ~IPublisher() noexcept = default; + + virtual void + subscribe(const Event &event, + const std::shared_ptr> &subscriber) noexcept = 0; + + virtual void notify_subscribers(const Event &event, + const Context &context) const noexcept = 0; +}; diff --git a/src/interfaces/subscriber.hpp b/src/interfaces/subscriber.hpp new file mode 100644 index 0000000..17d87ef --- /dev/null +++ b/src/interfaces/subscriber.hpp @@ -0,0 +1,8 @@ +#pragma once + +template +class ISubscriber +{ +public: + virtual void update(const Context &context) noexcept = 0; +}; -- cgit v1.2.3-18-g5258