generator.hpp

// Copyright Take Vos 2020-2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
 
#pragma once
 
#include <concepts>
#include <coroutine>
#include <optional>
#include <memory>
#include <memory_resource>
#include <type_traits>
#include "../macros.hpp"
#include "debugger.hpp"
 
hi_export_module(hikogui.utility.generator);
 
hi_export namespace hi::inline v1 {
 
template<typename T>
class generator {
public:
    using value_type = T;
 
    static_assert(not std::is_reference_v<value_type>);
    static_assert(not std::is_const_v<value_type>);
 
    class promise_type {
    public:
        generator get_return_object()
        {
            return generator{handle_type::from_promise(*this)};
        }
 
        value_type const& value() const noexcept
        {
            hi_axiom(_value);
            return *_value;
        }
 
        static std::suspend_never initial_suspend() noexcept
        {
            return {};
        }
 
        static std::suspend_always final_suspend() noexcept
        {
            return {};
        }
 
        std::suspend_always yield_value(value_type const& value) noexcept
        {
            _value = value;
            return {};
        }
 
        std::suspend_always yield_value(value_type&& value) noexcept
        {
            _value = std::move(value);
            return {};
        }
 
        void return_void() noexcept {}
 
        // Disallow co_await in generator coroutines.
        void await_transform() = delete;
 
        void unhandled_exception() noexcept
        {
            _exception = std::current_exception();
        }
 
        void rethrow()
        {
            if (auto ptr = std::exchange(_exception, nullptr)) {
                std::rethrow_exception(ptr);
            }
        }
 
    private:
        std::optional<value_type> _value = {};
        std::exception_ptr _exception = nullptr;
    };
 
    using handle_type = std::coroutine_handle<promise_type>;
 
    class value_proxy {
    public:
        value_proxy(value_type const& value) noexcept : _value(value) {}
 
        value_type const& operator*() const noexcept
        {
            return _value;
        }
 
    private:
        value_type _value;
    };
 
    class const_iterator {
    public:
        using difference_type = ptrdiff_t;
        using value_type = std::decay_t<value_type>;
        using pointer = value_type const *;
        using reference = value_type const&;
        using iterator_category = std::input_iterator_tag;
 
        explicit const_iterator(handle_type coroutine) : _coroutine{coroutine}
        {
            _coroutine.promise().rethrow();
        }
 
        const_iterator& operator++()
        {
            hi_axiom(not at_end());
            _coroutine.resume();
            _coroutine.promise().rethrow();
            return *this;
        }
 
        value_proxy operator++(int)
        {
            auto tmp = value_proxy(_coroutine.promise().value());
            hi_axiom(not at_end());
            _coroutine.resume();
            _coroutine.promise().rethrow();
            return tmp;
        }
 
        decltype(auto) operator*() const
        {
            hi_axiom(not at_end());
            return _coroutine.promise().value();
        }
 
        pointer *operator->() const noexcept
        {
            hi_axiom(not at_end());
            return std::addressof(_coroutine.promise().value());
        }
 
        [[nodiscard]] bool at_end() const noexcept
        {
            return not _coroutine or _coroutine.done();
        }
 
        [[nodiscard]] bool operator==(std::default_sentinel_t) const noexcept
        {
            return at_end();
        }
 
    private:
        handle_type _coroutine;
    };
 
    explicit generator(handle_type coroutine) : _coroutine(coroutine) {}
 
    generator() = default;
    ~generator()
    {
        if (_coroutine) {
            _coroutine.destroy();
        }
    }
 
    generator(const generator&) = delete;
    generator& operator=(const generator&) = delete;
 
    generator(generator&& other) noexcept : _coroutine{std::exchange(other._coroutine, {})} {}
 
    generator& operator=(generator&& other) noexcept
    {
        hi_return_on_self_assignment(other);
        if (_coroutine) {
            _coroutine.destroy();
        }
        _coroutine = std::exchange(other._coroutine, {});
        return *this;
    }
 
    const_iterator begin() const
    {
        return const_iterator{_coroutine};
    }
 
    const_iterator cbegin() const
    {
        return const_iterator{_coroutine};
    }
 
    std::default_sentinel_t end() const
    {
        return {};
    }
 
    std::default_sentinel_t cend() const
    {
        return {};
    }
 
private:
    handle_type _coroutine;
};
 
template<typename T>
class generator<T&> {
public:
    using value_type = T&;
 
    class promise_type {
    public:
        generator get_return_object()
        {
            return generator{handle_type::from_promise(*this)};
        }
 
        value_type value() const noexcept
        {
            hi_axiom(_value != nullptr);
            // Convert stored pointer back to reference.
            return *_value;
        }
 
        static std::suspend_never initial_suspend() noexcept
        {
            return {};
        }
 
        static std::suspend_always final_suspend() noexcept
        {
            return {};
        }
 
        std::suspend_always yield_value(value_type value) noexcept
        {
            _value = std::addressof(value);
            return {};
        }
 
        void return_void() noexcept {}
 
        // Disallow co_await in generator coroutines.
        void await_transform() = delete;
 
        void unhandled_exception() noexcept
        {
            _exception = std::current_exception();
        }
 
        void rethrow()
        {
            if (auto ptr = std::exchange(_exception, nullptr)) {
                std::rethrow_exception(ptr);
            }
        }
 
    private:
        std::remove_reference_t<value_type> *_value = nullptr;
        std::exception_ptr _exception = nullptr;
    };
 
    using handle_type = std::coroutine_handle<promise_type>;
 
    class value_proxy {
    public:
        value_proxy(value_type value) noexcept : _value(std::addressof(value)) {}
 
        value_type operator*() const noexcept
        {
            return *_value;
        }
 
    private:
        std::remove_reference_t<value_type> *_value;
    };
 
    class const_iterator {
    public:
        using difference_type = ptrdiff_t;
        using value_type = std::decay_t<value_type>;
        using pointer = value_type const *;
        using reference = value_type const&;
        using iterator_category = std::input_iterator_tag;
 
        explicit const_iterator(handle_type coroutine) : _coroutine{coroutine} {}
 
        const_iterator& operator++()
        {
            hi_axiom(not at_end());
            _coroutine.resume();
            _coroutine.promise().rethrow();
            return *this;
        }
 
        value_proxy operator++(int)
        {
            auto tmp = value_proxy(_coroutine.promise().value());
            hi_axiom(not at_end());
            _coroutine.resume();
            _coroutine.promise().rethrow();
            return tmp;
        }
 
        decltype(auto) operator*() const
        {
            hi_axiom(not at_end());
            return _coroutine.promise().value();
        }
 
        pointer *operator->() const noexcept
        {
            hi_axiom(not at_end());
            return std::addressof(_coroutine.promise().value());
        }
 
        [[nodiscard]] bool at_end() const noexcept
        {
            return not _coroutine or _coroutine.done();
        }
 
        [[nodiscard]] bool operator==(std::default_sentinel_t) const noexcept
        {
            return at_end();
        }
 
    private:
        handle_type _coroutine;
    };
 
    explicit generator(handle_type coroutine) : _coroutine(coroutine) {}
 
    generator() = default;
    ~generator()
    {
        if (_coroutine) {
            _coroutine.destroy();
        }
    }
 
    generator(const generator&) = delete;
    generator& operator=(const generator&) = delete;
 
    generator(generator&& other) noexcept : _coroutine{std::exchange(other._coroutine, {})} {}
 
    generator& operator=(generator&& other) noexcept
    {
        hi_return_on_self_assignment(other);
        if (_coroutine) {
            _coroutine.destroy();
        }
        _coroutine = std::exchange(other._coroutine, {});
        return *this;
    }
 
    const_iterator begin() const
    {
        return const_iterator{_coroutine};
    }
 
    const_iterator cbegin() const
    {
        return const_iterator{_coroutine};
    }
 
    std::default_sentinel_t end() const
    {
        return {};
    }
 
    std::default_sentinel_t cend() const
    {
        return {};
    }
 
private:
    handle_type _coroutine;
};
 
} // namespace hi::inline v1