selection_delegate.hpp

Go to the documentation of this file.

// Copyright Take Vos 2021.
// 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 "../l10n/l10n.hpp"
#include "../observer/observer.hpp"
#include "../utility/utility.hpp"
#include "../concurrency/concurrency.hpp"
#include "../dispatch/dispatch.hpp"
#include "../GUI/GUI.hpp"
#include "../macros.hpp"
#include "radio_delegate.hpp"
#include "radio_widget.hpp"
#include <memory>
#include <functional>
#include <vector>
 
hi_export_module(hikogui.widgets.selection_delegate);
 
hi_export namespace hi { inline namespace v1 {
class selection_widget;

class selection_delegate {
public:
    virtual ~selection_delegate() = default;
 
    virtual void init(widget_intf const &sender) {}
    virtual void deinit(widget_intf const &sender) {}

    [[nodiscard]] virtual std::optional<widget_id> keyboard_focus_id(widget_intf const& sender) const noexcept
    {
        return std::nullopt;
    }

    [[nodiscard]] virtual size_t size(widget_intf const& sender) const noexcept
    {
        return 0;
    }
 
    [[nodiscard]] bool empty(widget_intf const& sender) const noexcept
    {
        return size(sender) == 0;
    }

    [[nodiscard]] virtual std::unique_ptr<widget> make_option_widget(widget_intf const& sender, widget_intf const &parent, size_t index) noexcept = 0;

    [[nodiscard]] virtual std::optional<label> selected_label(widget_intf const& sender) const noexcept
    {
        return std::nullopt;
    }

    template<forward_of<void()> Func>
    [[nodiscard]] callback<void()> subscribe_on_value(Func&& func, callback_flags flags = callback_flags::synchronous) noexcept
    {
        return _value_notifier.subscribe(std::forward<Func>(func), flags);
    }

    template<forward_of<void()> Func>
    [[nodiscard]] callback<void()> subscribe_on_options(Func&& func, callback_flags flags = callback_flags::synchronous) noexcept
    {
        return _options_notifier.subscribe(std::forward<Func>(func), flags);
    }
 
protected:
    notifier<void()> _value_notifier;
    notifier<void()> _options_notifier;
};

template<typename T>
class default_selection_delegate : public selection_delegate {
public:
    using value_type = T;
    using option_type = std::pair<value_type, label>;
    using options_type = std::vector<option_type>;
 
    observer<value_type> value;
    observer<options_type> options;

    template<forward_of<observer<value_type>> Value, forward_of<observer<options_type>> Options>
    default_selection_delegate(Value&& value, Options&& options) noexcept :
        value(std::forward<Value>(value)), options(std::forward<Options>(options))
    {
        _option_delegate = std::make_shared<option_delegate_type>(this);
 
        // clang-format off
        _value_cbt = this->value.subscribe([&](auto...){ this->_value_notifier(); });
        _options_cbt = this->options.subscribe([&](auto...){ this->_options_notifier(); });
        // clang-format on
    }
 
    [[nodiscard]] size_t size(widget_intf const& sender) const noexcept override
    {
        return options->size();
    }
 
    [[nodiscard]] std::optional<label> selected_label(widget_intf const& sender) const noexcept override
    {
        for (auto&& option : *options) {
            if (option.first == *value) {
                return option.second;
            }
        }
        return std::nullopt;
    }
 
    [[nodiscard]] std::optional<widget_id> keyboard_focus_id(widget_intf const& sender) const noexcept override
    {
        return _option_delegate->keyboard_focus_id();
    }

    [[nodiscard]] std::unique_ptr<widget> make_option_widget(widget_intf const& sender, widget_intf const &parent, size_t index) noexcept override
    {
        auto& [option_value, option_label] = options->at(index);
        return _option_delegate->make_option_widget(sender, parent, option_value, option_label, _option_delegate);
    }
 
private:
    class option_delegate_type : public radio_delegate {
    public:
        option_delegate_type(not_null<default_selection_delegate *> parent) noexcept : _parent(parent)
        {
            _value_cbt = parent->value.subscribe([&](auto...) {
                this->_notifier();
            });
        }
 
        void init(widget_intf const& sender) noexcept override
        {
            hi_assert(_next_value, "The value was not set of this option widget.");
 
            auto const it = std::lower_bound(_senders.begin(), _senders.end(), sender.id);
            hi_assert(it == _senders.end() or it->id != sender.id, "button was already registered with selection-delegate.");
 
            _senders.emplace(it, sender.id, *_next_value);
            _next_value = std::nullopt;
        }
 
        void deinit(widget_intf const& sender) noexcept override
        {
            auto const it = std::lower_bound(_senders.begin(), _senders.end(), sender.id);
            if (it != _senders.end() and it->id == sender.id) {
                _senders.erase(it);
            }
        }
 
        [[nodiscard]] std::optional<widget_id> keyboard_focus_id() const noexcept
        {
            if (_senders.empty()) {
                return std::nullopt;
            }
 
            for (auto const& sender : _senders) {
                if (sender.value == *_parent->value) {
                    return sender.id;
                }
            }
            return _senders.front().id;
        }
 
        [[nodiscard]] std::unique_ptr<widget>
        make_option_widget(widget_intf const& sender, widget_intf const &parent, value_type const& value, label const& label, std::shared_ptr<option_delegate_type> shared_this) noexcept
        {
            using button_widget = radio_menu_button_widget;
            using button_attributes = radio_menu_button_widget::attributes_type;
 
            // Prepare the value for the next widget, so that the widget immediately can retrieve its value.
            _next_value = value;
            return make_unique<button_widget>(make_not_null(parent), button_attributes{label}, std::move(shared_this));
        }
 
        [[nodiscard]] widget_value state(widget_intf const& sender) const noexcept override
        {
            auto const it = std::lower_bound(_senders.begin(), _senders.end(), sender.id);
 
            if (it != _senders.end() and it->id == sender.id) {
                return *_parent->value == it->value ? widget_value::on : widget_value::off;
 
            } else {
                // button-button was not yet registered.
                return widget_value::off;
            }
        }
 
        void activate(widget_intf const& sender) noexcept override
        {
            auto const it = std::lower_bound(_senders.begin(), _senders.end(), sender.id);
 
            if (it != _senders.end() and it->id == sender.id) {
                _parent->value = it->value;
            }
        }
 
    private:
        struct sender_info_type {
            widget_id id = {};
            value_type value;
 
            [[nodiscard]] friend bool operator==(sender_info_type const& lhs, widget_id const& rhs) noexcept
            {
                return lhs.id == rhs;
            }
 
            [[nodiscard]] friend auto operator<=>(sender_info_type const& lhs, widget_id const& rhs) noexcept
            {
                return lhs.id <=> rhs;
            }
        };
 
        not_null<default_selection_delegate *> _parent;
        std::vector<sender_info_type> _senders;
        std::optional<value_type> _next_value;
        callback<void(value_type)> _value_cbt;
    };
 
    std::shared_ptr<option_delegate_type> _option_delegate;
 
    callback<void(value_type)> _value_cbt;
    callback<void(options_type)> _options_cbt;
};
 
template<typename Value, typename Options>
default_selection_delegate(Value&&, Options&&) -> default_selection_delegate<observer_decay_t<Value>>;
 
}} // namespace hi::v1