widget_state.hpp

// Copyright Take Vos 2023.
// 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 "../concurrency/concurrency.hpp"
#include "../macros.hpp"
#include <cstdint>
#include <utility>
#include <concepts>
#include <compare>
 
hi_export_module(hikogui.GUI : widget_state);
 
hi_export namespace hi { inline namespace v1 {
 
enum class widget_mode {
    collapse = 0,
 
    invisible = 1,
 
    disabled = 2,
 
    display = 3,
 
    select = 4,
 
    partial = 5,
 
    enabled = 6,
};
 
enum class widget_value {
    off = 0,
    on = 1,
    other = 2,
};
 
enum class widget_phase {
    inactive = 0,
    normal = 1,
    hover = 2,
    pressed = 3,
};
 
constexpr auto widget_state_mode_shift = 0;
constexpr auto widget_state_value_shift = 5;
 
class widget_state {
public:
    constexpr widget_state(widget_state const &) noexcept = default;
    constexpr widget_state(widget_state &&) noexcept = default;
    constexpr widget_state &operator=(widget_state const &) noexcept = default;
    constexpr widget_state &operator=(widget_state &&) noexcept = default;
    
    constexpr widget_state() noexcept = default;
 
    constexpr static widget_state begin() noexcept
    {
        auto r = widget_state{};
        r.set_mode(widget_mode::collapse);
        r.set_layer(0);
        r.set_value(widget_value::off);
        r.set_pressed(false);
        r.set_hover(false);
        r.set_active(false);
        r.set_focus(false);
        return r;
    }
 
    constexpr static widget_state end() noexcept
    {
        auto r = begin();
        r._end = true;
        return r;
    }
 
    constexpr static size_t size() noexcept
    {
        return static_cast<size_t>(end());
    }
 
    [[nodiscard]] constexpr widget_mode mode() const noexcept
    {
        return static_cast<widget_mode>(_mode);
    }
 
    constexpr widget_state &set_mode(widget_mode mode) noexcept
    {
        _mode = static_cast<uint16_t>(mode);
        return *this;
    }
 
    [[nodiscard]] constexpr size_t layer() const noexcept
    {
        return _layer;
    }
 
    constexpr widget_state &set_layer(size_t layer) noexcept
    {
        _layer = static_cast<uint16_t>(layer % 4);
        return *this;
    }
 
    [[nodiscard]] constexpr widget_value value() const noexcept
    {
        return static_cast<widget_value>(_value);
    }
 
    constexpr widget_state &set_value(widget_value value) noexcept
    {
        _value = static_cast<uint16_t>(value);
        return *this;
    }
 
    [[nodiscard]] constexpr widget_phase phase() const noexcept
    {
        if (_pressed) {
            return widget_phase::pressed;
        } else if (_hover) {
            return widget_phase::hover;
        } else if (_active) {
            return widget_phase::normal;
        } else {
            return widget_phase::inactive;
        }
    }
 
    constexpr widget_state &set_pressed(bool pressed) noexcept
    {
        _pressed = static_cast<bool>(pressed);
        return *this;
    }
 
    constexpr widget_state &set_hover(bool hover) noexcept
    {
        _hover = static_cast<bool>(hover);
        return *this;
    }
 
    constexpr widget_state &set_active(bool active) noexcept
    {
        _active = static_cast<bool>(active);
        return *this;
    }
 
    [[nodiscard]] constexpr bool focus() const noexcept
    {
        return static_cast<bool>(_focus);
    }
 
    constexpr widget_state &set_focus(bool focus) noexcept
    {
        _focus = static_cast<uint16_t>(focus);
        return *this;
    }
 
    template<std::integral T>
    constexpr explicit operator T() const noexcept
        requires(sizeof(T) >= 2)
    {
        auto r = T{0};
 
        r += static_cast<T>(_end);
 
        r *= 2;
        r += static_cast<T>(focus());
 
        r *= 4;
        r += static_cast<T>(phase());
 
        r *= 3;
        r += static_cast<T>(value());
 
        r *= 4;
        r += static_cast<T>(layer());
 
        r *= 7;
        r += static_cast<T>(mode());
        return r;
    }
 
    [[nodiscard]] constexpr friend bool operator==(widget_state const &lhs, widget_state const &rhs) noexcept
    {
        return static_cast<uint16_t>(lhs) == static_cast<uint16_t>(rhs);
    }
 
    constexpr widget_state& operator++() noexcept
    {
        if (mode() < widget_mode::enabled) {
            set_mode(static_cast<widget_mode>(std::to_underlying(mode()) + 1));
            return *this;
        }
        set_mode(widget_mode::collapse);
 
        if (layer() < 3) {
            set_layer(layer() + 1);
            return *this;
        }
        set_layer(0);
 
        if (value() < widget_value::other) {
            set_value(static_cast<widget_value>(std::to_underlying(value()) + 1));
            return *this;
        }
        set_value(widget_value::off);
 
        switch (phase()) {
        case widget_phase::inactive:
            set_pressed(false);
            set_hover(false);
            set_active(true);
            return *this;
        case widget_phase::normal:
            set_pressed(false);
            set_hover(true);
            set_active(true);
            return *this;
        case widget_phase::hover:
            set_pressed(true);
            set_hover(true);
            set_active(true);
            return *this;
        case widget_phase::pressed:
            set_pressed(false);
            set_hover(false);
            set_active(false);
            break;
        default:
            hi_no_default();
        }
 
        if (focus() == false) {
            set_focus(true);
            return *this;
        }
        set_focus(false);
 
        _end = true;
        return *this;
    }
 
    [[nodiscard]] constexpr friend bool need_reconstrain(widget_state const &lhs, widget_state const &rhs) noexcept
    {
        return lhs._mode != rhs._mode;
    } 
 
    [[nodiscard]] constexpr friend bool need_relayout(widget_state const &lhs, widget_state const &rhs) noexcept
    {
        return need_reconstrain(lhs, rhs) or lhs._layer != rhs._layer;
    } 
 
    [[nodiscard]] constexpr friend bool need_redraw(widget_state const &lhs, widget_state const &rhs) noexcept
    {
        return lhs != rhs;
    } 
 
private:
    uint16_t _mode : 3 = static_cast<uint16_t>(widget_mode::enabled);
 
    uint16_t _layer : 2 = 0;
 
    uint16_t _value : 2 = static_cast<uint16_t>(widget_value::off);
 
    uint16_t _active: 1 = 1;
 
    uint16_t _hover : 1 = 0;
 
    uint16_t _pressed : 1 = 0;
 
    uint16_t _focus : 1 = 0;
 
    uint16_t _end : 1 = 0;
};
 
}}