/* Coroutines for OctaSTD. * * This file is part of OctaSTD. See COPYING.md for further information. */ #ifndef OSTD_COROUTINE_HH #define OSTD_COROUTINE_HH #include #include #include #include #include #include "ostd/types.hh" #include "ostd/range.hh" #include "ostd/internal/context.hh" namespace ostd { struct coroutine_error: std::runtime_error { using std::runtime_error::runtime_error; }; template struct coroutine; namespace detail { /* dealing with args */ template struct coro_types { using yield_type = std::tuple; template static yield_type get_impl( std::tuple...> &args, std::index_sequence ) { return std::make_tuple(std::forward(*std::get(args))...); } static yield_type get(std::tuple...> &args) { return get_impl(args, std::index_sequence_for{}); } }; template struct coro_types { using yield_type = A; static yield_type get(std::tuple> &args) { return std::forward(*std::get<0>(args)); } }; template struct coro_types { using yield_type = std::pair; static yield_type get( std::tuple, std::add_pointer_t> &args ) { return std::make_pair( std::forward(*std::get<0>(args)), std::forward(*std::get<1>(args)) ); } }; template<> struct coro_types<> { using yield_type = void; }; template using coro_args = typename coro_types::yield_type; /* storing and handling results */ template struct coro_rtype { using type = std::aligned_storage_t; static void store(type &stor, R &&v) { new (&stor) R(std::move(v)); } static void store(type &stor, R const &v) { new (&stor) R(v); } static R get(type &stor) { R &tstor = *reinterpret_cast(&stor); R ret{std::forward(tstor)}; /* this way we can make sure result is always uninitialized * except when resuming, so no need to keep a bool flag etc. */ tstor.~R(); return ret; } }; template struct coro_rtype { using type = R *; static void store(type &stor, R &v) { stor = &v; } static R &get(type stor) { return *stor; } }; template struct coro_rtype { using type = std::aligned_storage_t; static void store(type &stor, R &&v) { new (&stor) R(std::move(v)); } static R &&get(type &stor) { R &tstor = *reinterpret_cast(&stor); R ret{std::forward(tstor)}; tstor.~R(); return std::move(ret); } }; template using coro_result = typename coro_rtype::type; /* forward declare generic yielder for friends */ template struct coro_yielder; /* default case, yield returns args and takes a value */ template struct coro_base: coroutine_context { protected: friend struct coro_yielder; template coro_args get_args(std::index_sequence) { return coro_types::get(p_args); } void set_args(std::add_pointer_t ...args) { p_args = std::make_tuple(args...); } R get_result() { return std::forward(coro_rtype::get(p_result)); } template void call_helper(F &func, std::index_sequence) { coro_rtype::store(p_result, std::forward(func( Y{*this}, std::forward(*std::get(p_args))... ))); } void swap(coro_base &other) { using std::swap; swap(p_args, other.p_args); /* no need to swap result as result is always only alive * for the time of a single resume, in which no swap happens */ coroutine_context::swap(other); } std::tuple...> p_args; coro_result p_result; }; /* yield takes a value but doesn't return any args */ template struct coro_base: coroutine_context { protected: friend struct coro_yielder; template void get_args(std::index_sequence) {} void set_args() {} R get_result() { return std::forward(coro_rtype::get(p_result)); } template void call_helper(F &func, std::index_sequence) { coro_rtype::store(p_result, std::forward(func(Y{*this}))); } void swap(coro_base &other) { coroutine_context::swap(other); } coro_result p_result; }; /* yield doesn't take a value and returns args */ template struct coro_base: coroutine_context { protected: friend struct coro_yielder; template coro_args get_args(std::index_sequence) { return coro_types::get(p_args); } void set_args(std::add_pointer_t ...args) { p_args = std::make_tuple(args...); } void get_result() {} template void call_helper(F &func, std::index_sequence) { func(Y{*this}, std::forward(*std::get(p_args))...); } void swap(coro_base &other) { using std::swap; swap(p_args, other.p_args); coroutine_context::swap(other); } std::tuple...> p_args; }; /* yield doesn't take a value or return any args */ template<> struct coro_base: coroutine_context { protected: friend struct coro_yielder; template void get_args(std::index_sequence) {} void set_args() {} void get_result() {} template void call_helper(F &func, std::index_sequence) { func(Y{*this}); } void swap(coro_base &other) { coroutine_context::swap(other); } }; template struct coro_yielder { coro_yielder(coro_base &coro): p_coro(coro) {} coro_args operator()(R &&ret) { coro_rtype::store(p_coro.p_result, std::move(ret)); p_coro.yield_jump(); return p_coro.get_args(std::make_index_sequence{}); } coro_args operator()(R const &ret) { coro_rtype::store(p_coro.p_result, ret); p_coro.yield_jump(); return p_coro.get_args(std::make_index_sequence{}); } private: coro_base &p_coro; }; template struct coro_yielder { coro_yielder(coro_base &coro): p_coro(coro) {} coro_args operator()(R &ret) { coro_rtype::store(p_coro.p_result, ret); p_coro.yield_jump(); return p_coro.get_args(std::make_index_sequence{}); } private: coro_base &p_coro; }; template struct coro_yielder { coro_yielder(coro_base &coro): p_coro(coro) {} coro_args operator()(R &&ret) { coro_rtype::store(p_coro.p_result, std::move(ret)); p_coro.yield_jump(); return p_coro.get_args(std::make_index_sequence{}); } private: coro_base &p_coro; }; template struct coro_yielder { coro_yielder(coro_base &coro): p_coro(coro) {} coro_args operator()() { p_coro.yield_jump(); return p_coro.get_args(std::make_index_sequence{}); } private: coro_base &p_coro; }; } /* namespace detail */ template struct coroutine: detail::coro_base { private: using base_t = detail::coro_base; /* necessary so that context callback can access privates */ friend struct detail::coroutine_context; public: using yield_type = detail::coro_yielder; /* we have no way to assign a function anyway... */ coroutine() = delete; /* 0 means default size decided by the stack allocator */ template coroutine(F func, SA sa = SA{}): base_t(), p_func(std::move(func)) { /* that way there is no context creation/stack allocation */ if (!p_func) { this->set_dead(); return; } this->template make_context>(sa); } template coroutine(std::nullptr_t, SA = SA{0}): base_t(), p_func(nullptr) { this->set_dead(); } coroutine(coroutine const &) = delete; coroutine(coroutine &&c) noexcept: base_t(std::move(c)), p_func(std::move(c.p_func)) { c.p_func = nullptr; } coroutine &operator=(coroutine const &) = delete; coroutine &operator=(coroutine &&c) noexcept { base_t::operator=(std::move(c)); p_func = std::move(c.p_func); c.p_func = nullptr; } explicit operator bool() const noexcept { return !this->is_dead(); } R resume(A ...args) { if (this->is_dead()) { throw coroutine_error{"dead coroutine"}; } this->set_args(&args...); detail::coroutine_context::call(); return this->get_result(); } R operator()(A ...args) { /* duplicate the logic so we don't copy/move the args */ if (this->is_dead()) { throw coroutine_error{"dead coroutine"}; } this->set_args(&args...); detail::coroutine_context::call(); return this->get_result(); } void swap(coroutine &other) noexcept { std::swap(p_func, other.p_func); base_t::swap(other); } private: void resume_call() { base_t::template call_helper( p_func, std::index_sequence_for{} ); } std::function p_func; }; template inline void swap(coroutine &a, coroutine &b) noexcept { a.swap(b); } template struct generator_range; namespace detail { template struct generator_iterator; } template struct generator: detail::coroutine_context { private: using base_t = detail::coroutine_context; friend struct detail::coroutine_context; struct yielder { yielder(generator &g): p_gen(g) {} void operator()(T &&ret) { p_gen.p_result = &ret; p_gen.yield_jump(); } void operator()(T &ret) { p_gen.p_result = &ret; p_gen.yield_jump(); } private: generator &p_gen; }; public: using range = generator_range; using yield_type = yielder; generator() = delete; template generator(F func, SA sa = SA{}): base_t(), p_func(std::move(func)) { /* that way there is no context creation/stack allocation */ if (!p_func) { this->set_dead(); return; } this->template make_context>(sa); /* generate an initial value */ resume(); } template generator(std::nullptr_t, SA = SA{0}): base_t(), p_func(nullptr) { this->set_dead(); } generator(generator const &) = delete; generator(generator &&c) noexcept: base_t(std::move(c)), p_func(std::move(c.p_func)), p_result(c.p_result) { c.p_func = nullptr; c.p_result = nullptr; } generator &operator=(generator const &) = delete; generator &operator=(generator &&c) noexcept { base_t::operator=(std::move(c)); p_func = std::move(c.p_func); p_result = c.p_result; c.p_func = nullptr; c.p_result = nullptr; } explicit operator bool() const noexcept { return !this->is_dead(); } void resume() { if (this->is_dead()) { throw coroutine_error{"dead generator"}; } detail::coroutine_context::call(); } T &value() { if (!p_result) { throw coroutine_error{"no value"}; } return *p_result; } T const &value() const { if (!p_result) { throw coroutine_error{"no value"}; } return *p_result; } bool empty() const noexcept { return !p_result; } generator_range iter() noexcept; /* for range for loop; they're the same, operator!= bypasses comparing */ detail::generator_iterator begin() noexcept; detail::generator_iterator end() noexcept; void swap(generator &other) noexcept { using std::swap; swap(p_func, other.p_func); swap(p_result, other.p_result); detail::coroutine_context::swap(other); } private: void resume_call() { p_func(yield_type{*this}); /* done, gotta null the item so that empty() returns true */ p_result = nullptr; } std::function p_func; /* we can use a pointer because even stack values are alive * as long as the coroutine is alive (and it is on every yield) */ T *p_result = nullptr; }; template inline void swap(generator &a, generator &b) noexcept { a.swap(b); } namespace detail { template struct yield_type_base { using type = typename generator::yield_type; }; template struct yield_type_base { using type = typename coroutine::yield_type; }; } template using yield_type = typename detail::yield_type_base::type; template struct generator_range: input_range> { using range_category = input_range_tag; using value_type = T; using reference = T &; using size_type = size_t; using difference_type = ptrdiff_t; generator_range() = delete; generator_range(generator &g): p_gen(&g) {} bool empty() const noexcept { return p_gen->empty(); } void pop_front() { p_gen->resume(); } reference front() const { return p_gen->value(); } bool equals_front(generator_range const &g) const noexcept { return p_gen == g.p_gen; } /* same behavior as on generator itself, for range for loop */ detail::generator_iterator begin() noexcept; detail::generator_iterator end() noexcept; private: generator *p_gen; }; template generator_range generator::iter() noexcept { return generator_range{*this}; } namespace detail { /* deliberately incomplete, only for range for loop */ template struct generator_iterator { generator_iterator() = delete; generator_iterator(generator &g): p_gen(&g) {} bool operator!=(generator_iterator const &) noexcept { return !p_gen->empty(); } T &operator*() const { return p_gen->value(); } generator_iterator &operator++() { p_gen->resume(); return *this; } private: generator *p_gen; }; } /* namespace detail */ template detail::generator_iterator generator::begin() noexcept { return detail::generator_iterator{*this}; } template detail::generator_iterator generator::end() noexcept { return detail::generator_iterator{*this}; } template detail::generator_iterator generator_range::begin() noexcept { return detail::generator_iterator{*p_gen}; } template detail::generator_iterator generator_range::end() noexcept { return detail::generator_iterator{*p_gen}; } } /* namespace ostd */ #endif