gui_window.hpp

// Copyright Take Vos 2019-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 "gui_window_size.hpp"
#include "mouse_cursor.hpp"
#include "hitbox.hpp"
#include "gui_event.hpp"
#include "keyboard_focus_direction.hpp"
#include "keyboard_focus_group.hpp"
#include "widget.hpp"
#include "../GFX/module.hpp"
#include "../geometry/module.hpp"
#include "../chrono.hpp"
#include "../label.hpp"
#include "../animator.hpp"
#include <unordered_set>
#include <memory>
#include <mutex>
 
namespace hi::inline v1 {
class gfx_device;
class gfx_system;
class gfx_surface;
class gui_system;
class keyboard_bindings;

class gui_window {
public:
    gui_system& gui;

    std::unique_ptr<widget> widget;
 
    label title;
 
    std::unique_ptr<gfx_surface> surface;

    aarectangle rectangle;

    mouse_cursor current_mouse_cursor = mouse_cursor::None;

    bool resizing = false;

    bool active = false;

    float dpi = 72.0;

    extent2 widget_size;

    notifier<void()> closing;
 
    gui_window(gui_system& gui, std::unique_ptr<hi::widget> widget, label const& title) noexcept;
 
    virtual ~gui_window();
 
    gui_window(gui_window const&) = delete;
    gui_window& operator=(gui_window const&) = delete;
    gui_window(gui_window&&) = delete;
    gui_window& operator=(gui_window&&) = delete;
 
    void set_device(gfx_device *device) noexcept;

    hi::keyboard_bindings const& keyboard_bindings() const noexcept;

    virtual void render(utc_nanoseconds displayTimePoint);

    virtual void set_cursor(mouse_cursor cursor) = 0;

    virtual void close_window() = 0;

    virtual void set_size_state(gui_window_size state) noexcept = 0;

    virtual aarectangle workspace_rectangle() const noexcept = 0;

    virtual aarectangle fullscreen_rectangle() const noexcept = 0;
 
    virtual hi::subpixel_orientation subpixel_orientation() const noexcept = 0;

    gui_window_size size_state() const noexcept
    {
        return _size_state;
    }

    virtual void open_system_menu() = 0;

    virtual void set_window_size(extent2 extent) = 0;
 
    void update_mouse_target(widget_id new_target_widget, point2 position = {}) noexcept;

    void update_keyboard_target(widget_id widget, keyboard_focus_group group = keyboard_focus_group::normal) noexcept;

    void update_keyboard_target(widget_id widget, keyboard_focus_group group, keyboard_focus_direction direction) noexcept;

    void update_keyboard_target(keyboard_focus_group group, keyboard_focus_direction direction) noexcept;

    [[nodiscard]] virtual std::optional<hi::text> get_text_from_clipboard() const noexcept = 0;

    virtual void put_text_on_clipboard(hi::text text) const noexcept = 0;
 
    [[nodiscard]] translate2 window_to_screen() const noexcept
    {
        return translate2{rectangle.left(), rectangle.bottom()};
    }
 
    [[nodiscard]] translate2 screen_to_window() const noexcept
    {
        return ~window_to_screen();
    }

    bool process_event(gui_event const& event) noexcept;
 
protected:
    static constexpr std::chrono::nanoseconds _animation_duration = std::chrono::milliseconds(150);
 
    box_constraints _widget_constraints = {};
 
    std::atomic<aarectangle> _redraw_rectangle = aarectangle{};
    std::atomic<bool> _relayout = false;
    std::atomic<bool> _reconstrain = false;
    std::atomic<bool> _resize = false;

    gui_window_size _size_state = gui_window_size::normal;

    aarectangle _restore_rectangle;

    utc_nanoseconds last_forced_redraw = {};

    animator<float> _animated_active = _animation_duration;
 
private:
    notifier<>::callback_token _setting_change_token;
    observer<std::string>::callback_token _selected_theme_token;

    widget_id _mouse_target_id;

    widget_id _keyboard_target_id;

    bool send_events_to_widget(widget_id target_widget, std::vector<gui_event> const& events) noexcept;
 
    friend class widget;
};
 
} // namespace hi::inline v1