diff options
| author | untodesu <kirill@untode.su> | 2025-06-28 01:59:49 +0500 |
|---|---|---|
| committer | untodesu <kirill@untode.su> | 2025-06-28 01:59:49 +0500 |
| commit | 61e5bcef2629e2d68b805a956a96fff264d4f74d (patch) | |
| tree | bca3a94bac79d34e3c0db57c77604f5a823ecbda /deps/include/entt/process/process.hpp | |
| parent | 88c01588aa0830e219eaa62588839e4d1e2883ce (diff) | |
| download | voxelius-61e5bcef2629e2d68b805a956a96fff264d4f74d.tar.bz2 voxelius-61e5bcef2629e2d68b805a956a96fff264d4f74d.zip | |
Restructure dependencies and update to C++20
- Nuked static_assert from almost everywhere in the project
- Nuked binary dependency support. Might add one later though
- Separated dependency headers into a separate include subdirectory
- Grafted a thirdpartylegalnotices.txt generator from RITEG
- Pushed development snapshot version to 2126 (26th week of 2025)
Diffstat (limited to 'deps/include/entt/process/process.hpp')
| -rw-r--r-- | deps/include/entt/process/process.hpp | 354 |
1 files changed, 0 insertions, 354 deletions
diff --git a/deps/include/entt/process/process.hpp b/deps/include/entt/process/process.hpp deleted file mode 100644 index f2692bd..0000000 --- a/deps/include/entt/process/process.hpp +++ /dev/null @@ -1,354 +0,0 @@ -#ifndef ENTT_PROCESS_PROCESS_HPP
-#define ENTT_PROCESS_PROCESS_HPP
-
-#include <cstdint>
-#include <type_traits>
-#include <utility>
-#include "fwd.hpp"
-
-namespace entt {
-
-/**
- * @brief Base class for processes.
- *
- * This class stays true to the CRTP idiom. Derived classes must specify what's
- * the intended type for elapsed times.<br/>
- * A process should expose publicly the following member functions whether
- * required:
- *
- * * @code{.cpp}
- * void update(Delta, void *);
- * @endcode
- *
- * It's invoked once per tick until a process is explicitly aborted or it
- * terminates either with or without errors. Even though it's not mandatory to
- * declare this member function, as a rule of thumb each process should at
- * least define it to work properly. The `void *` parameter is an opaque
- * pointer to user data (if any) forwarded directly to the process during an
- * update.
- *
- * * @code{.cpp}
- * void init();
- * @endcode
- *
- * It's invoked when the process joins the running queue of a scheduler. This
- * happens as soon as it's attached to the scheduler if the process is a top
- * level one, otherwise when it replaces its parent if the process is a
- * continuation.
- *
- * * @code{.cpp}
- * void succeeded();
- * @endcode
- *
- * It's invoked in case of success, immediately after an update and during the
- * same tick.
- *
- * * @code{.cpp}
- * void failed();
- * @endcode
- *
- * It's invoked in case of errors, immediately after an update and during the
- * same tick.
- *
- * * @code{.cpp}
- * void aborted();
- * @endcode
- *
- * It's invoked only if a process is explicitly aborted. There is no guarantee
- * that it executes in the same tick, this depends solely on whether the
- * process is aborted immediately or not.
- *
- * Derived classes can change the internal state of a process by invoking the
- * `succeed` and `fail` protected member functions and even pause or unpause the
- * process itself.
- *
- * @sa scheduler
- *
- * @tparam Derived Actual type of process that extends the class template.
- * @tparam Delta Type to use to provide elapsed time.
- */
-template<typename Derived, typename Delta>
-class process {
- enum class state : std::uint8_t {
- uninitialized = 0,
- running,
- paused,
- succeeded,
- failed,
- aborted,
- finished,
- rejected
- };
-
- template<typename Target = Derived>
- auto next(std::integral_constant<state, state::uninitialized>)
- -> decltype(std::declval<Target>().init(), void()) {
- static_cast<Target *>(this)->init();
- }
-
- template<typename Target = Derived>
- auto next(std::integral_constant<state, state::running>, Delta delta, void *data)
- -> decltype(std::declval<Target>().update(delta, data), void()) {
- static_cast<Target *>(this)->update(delta, data);
- }
-
- template<typename Target = Derived>
- auto next(std::integral_constant<state, state::succeeded>)
- -> decltype(std::declval<Target>().succeeded(), void()) {
- static_cast<Target *>(this)->succeeded();
- }
-
- template<typename Target = Derived>
- auto next(std::integral_constant<state, state::failed>)
- -> decltype(std::declval<Target>().failed(), void()) {
- static_cast<Target *>(this)->failed();
- }
-
- template<typename Target = Derived>
- auto next(std::integral_constant<state, state::aborted>)
- -> decltype(std::declval<Target>().aborted(), void()) {
- static_cast<Target *>(this)->aborted();
- }
-
- template<typename... Args>
- void next(Args &&...) const noexcept {}
-
-protected:
- /**
- * @brief Terminates a process with success if it's still alive.
- *
- * The function is idempotent and it does nothing if the process isn't
- * alive.
- */
- void succeed() noexcept {
- if(alive()) {
- current = state::succeeded;
- }
- }
-
- /**
- * @brief Terminates a process with errors if it's still alive.
- *
- * The function is idempotent and it does nothing if the process isn't
- * alive.
- */
- void fail() noexcept {
- if(alive()) {
- current = state::failed;
- }
- }
-
- /**
- * @brief Stops a process if it's in a running state.
- *
- * The function is idempotent and it does nothing if the process isn't
- * running.
- */
- void pause() noexcept {
- if(current == state::running) {
- current = state::paused;
- }
- }
-
- /**
- * @brief Restarts a process if it's paused.
- *
- * The function is idempotent and it does nothing if the process isn't
- * paused.
- */
- void unpause() noexcept {
- if(current == state::paused) {
- current = state::running;
- }
- }
-
-public:
- /*! @brief Type used to provide elapsed time. */
- using delta_type = Delta;
-
- /*! @brief Default constructor. */
- constexpr process() = default;
-
- /*! @brief Default copy constructor. */
- process(const process &) = default;
-
- /*! @brief Default move constructor. */
- process(process &&) noexcept = default;
-
- /**
- * @brief Default copy assignment operator.
- * @return This process.
- */
- process &operator=(const process &) = default;
-
- /**
- * @brief Default move assignment operator.
- * @return This process.
- */
- process &operator=(process &&) noexcept = default;
-
- /*! @brief Default destructor. */
- virtual ~process() noexcept {
- static_assert(std::is_base_of_v<process, Derived>, "Incorrect use of the class template");
- }
-
- /**
- * @brief Aborts a process if it's still alive.
- *
- * The function is idempotent and it does nothing if the process isn't
- * alive.
- *
- * @param immediate Requests an immediate operation.
- */
- void abort(const bool immediate = false) {
- if(alive()) {
- current = state::aborted;
-
- if(immediate) {
- tick({});
- }
- }
- }
-
- /**
- * @brief Returns true if a process is either running or paused.
- * @return True if the process is still alive, false otherwise.
- */
- [[nodiscard]] bool alive() const noexcept {
- return current == state::running || current == state::paused;
- }
-
- /**
- * @brief Returns true if a process is already terminated.
- * @return True if the process is terminated, false otherwise.
- */
- [[nodiscard]] bool finished() const noexcept {
- return current == state::finished;
- }
-
- /**
- * @brief Returns true if a process is currently paused.
- * @return True if the process is paused, false otherwise.
- */
- [[nodiscard]] bool paused() const noexcept {
- return current == state::paused;
- }
-
- /**
- * @brief Returns true if a process terminated with errors.
- * @return True if the process terminated with errors, false otherwise.
- */
- [[nodiscard]] bool rejected() const noexcept {
- return current == state::rejected;
- }
-
- /**
- * @brief Updates a process and its internal state if required.
- * @param delta Elapsed time.
- * @param data Optional data.
- */
- void tick(const Delta delta, void *data = nullptr) {
- switch(current) {
- case state::uninitialized:
- next(std::integral_constant<state, state::uninitialized>{});
- current = state::running;
- break;
- case state::running:
- next(std::integral_constant<state, state::running>{}, delta, data);
- break;
- default:
- // suppress warnings
- break;
- }
-
- // if it's dead, it must be notified and removed immediately
- switch(current) {
- case state::succeeded:
- next(std::integral_constant<state, state::succeeded>{});
- current = state::finished;
- break;
- case state::failed:
- next(std::integral_constant<state, state::failed>{});
- current = state::rejected;
- break;
- case state::aborted:
- next(std::integral_constant<state, state::aborted>{});
- current = state::rejected;
- break;
- default:
- // suppress warnings
- break;
- }
- }
-
-private:
- state current{state::uninitialized};
-};
-
-/**
- * @brief Adaptor for lambdas and functors to turn them into processes.
- *
- * Lambdas and functors can't be used directly with a scheduler for they are not
- * properly defined processes with managed life cycles.<br/>
- * This class helps in filling the gap and turning lambdas and functors into
- * full featured processes usable by a scheduler.
- *
- * The signature of the function call operator should be equivalent to the
- * following:
- *
- * @code{.cpp}
- * void(Delta delta, void *data, auto succeed, auto fail);
- * @endcode
- *
- * Where:
- *
- * * `delta` is the elapsed time.
- * * `data` is an opaque pointer to user data if any, `nullptr` otherwise.
- * * `succeed` is a function to call when a process terminates with success.
- * * `fail` is a function to call when a process terminates with errors.
- *
- * The signature of the function call operator of both `succeed` and `fail`
- * is equivalent to the following:
- *
- * @code{.cpp}
- * void();
- * @endcode
- *
- * Usually users shouldn't worry about creating adaptors. A scheduler will
- * create them internally each and avery time a lambda or a functor is used as
- * a process.
- *
- * @sa process
- * @sa scheduler
- *
- * @tparam Func Actual type of process.
- * @tparam Delta Type to use to provide elapsed time.
- */
-template<typename Func, typename Delta>
-struct process_adaptor: process<process_adaptor<Func, Delta>, Delta>, private Func {
- /**
- * @brief Constructs a process adaptor from a lambda or a functor.
- * @tparam Args Types of arguments to use to initialize the actual process.
- * @param args Parameters to use to initialize the actual process.
- */
- template<typename... Args>
- process_adaptor(Args &&...args)
- : Func{std::forward<Args>(args)...} {}
-
- /**
- * @brief Updates a process and its internal state if required.
- * @param delta Elapsed time.
- * @param data Optional data.
- */
- void update(const Delta delta, void *data) {
- Func::operator()(
- delta,
- data,
- [this]() { this->succeed(); },
- [this]() { this->fail(); });
- }
-};
-
-} // namespace entt
-
-#endif
|