path: root/src/ui/control.hpp

#pragma once

#include "system_headers.hpp"
#include <unordered_map>
#include <any>
#include <utility>

#include "base.hpp"
#include "ui_base.hpp"
#include "layout_base.hpp"
#include "events/ui_event.hpp"
#include "border_property.hpp"
#include "cursor.hpp"
#include "any_map.hpp"

namespace cru::ui
{
    class Control;
    class Window;


    //the position cache
    struct ControlPositionCache
    {
        //The lefttop relative to the ancestor.
        Point lefttop_position_absolute;
    };

    class Control : public Object
    {
        friend class Window;
        friend class LayoutManager;

    protected:
        struct WindowConstructorTag {}; //Used for constructor for class Window. 

        explicit Control(bool container = false);

        // Used only for creating Window. It will set window_ as window.
        Control(WindowConstructorTag, Window* window);

    public:
        Control(const Control& other) = delete;
        Control(Control&& other) = delete;
        Control& operator=(const Control& other) = delete;
        Control& operator=(Control&& other) = delete;
        ~Control() override;

    public:

        //*************** region: tree ***************
        virtual StringView GetControlType() const = 0;

        bool IsContainer() const
        {
            return is_container_;
        }

        //Get parent of control, return nullptr if it has no parent.
        Control* GetParent() const
        {
            return parent_;
        }

        //Return a immutable vector of all children.
        const std::vector<Control*>& GetChildren() const;

        //Add a child at tail.
        void AddChild(Control* control);

        //Add a child before the position.
        void AddChild(Control* control, int position);

        //Remove a child.
        void RemoveChild(Control* child);

        //Remove a child at specified position.
        void RemoveChild(int position);

        //Get the ancestor of the control.
        Control* GetAncestor();

        //Get the window if attached, otherwise, return nullptr.
        Window* GetWindow() const
        {
            return window_;
        }

        //Traverse the tree rooted the control including itself.
        void TraverseDescendants(const std::function<void(Control*)>& predicate);

        //*************** region: position and size ***************
        // Position and size part must be isolated from layout part.
        // All the operations in this part must be done independently.
        // And layout part must use api of this part.

        //Get the lefttop relative to its parent.
        virtual Point GetPositionRelative();

        //Set the lefttop relative to its parent.
        virtual void SetPositionRelative(const Point& position);

        //Get the actual size.
        virtual Size GetSize();

        //Set the actual size directly without re-layout.
        virtual void SetSize(const Size& size);

        //Get lefttop relative to ancestor. This is only valid when
        //attached to window. Notice that the value is cached.
        //You can invalidate and recalculate it by calling "InvalidatePositionCache". 
        Point GetPositionAbsolute() const;

        //Local point to absolute point.
        Point ControlToWindow(const Point& point) const;

        //Absolute point to local point.
        Point WindowToControl(const Point& point) const;

        // Default implement in Control is test point in border geometry's
        // fill and stroke with width of border.
        virtual bool IsPointInside(const Point& point);


        //*************** region: graphic ***************

        //Draw this control and its child controls.
        void Draw(ID2D1DeviceContext* device_context);

        virtual void InvalidateDraw();

        Microsoft::WRL::ComPtr<ID2D1Brush> GetForegroundBrush() const
        {
            return foreground_brush_;
        }

        void SetForegroundBrush(Microsoft::WRL::ComPtr<ID2D1Brush> foreground_brush)
        {
            foreground_brush_ = std::move(foreground_brush);
            InvalidateDraw();
        }

        Microsoft::WRL::ComPtr<ID2D1Brush> GetBackgroundBrush() const
        {
            return background_brush_;
        }

        void SetBackgroundBrush(Microsoft::WRL::ComPtr<ID2D1Brush> background_brush)
        {
            background_brush_ = std::move(background_brush);
            InvalidateDraw();
        }


        //*************** region: focus ***************

        bool RequestFocus();

        bool HasFocus();

        bool IsFocusOnPressed() const
        {
            return is_focus_on_pressed_;
        }

        void SetFocusOnPressed(const bool value)
        {
            is_focus_on_pressed_ = value;
        }

        //*************** region: layout ***************

        void InvalidateLayout();

        void Measure(const Size& available_size);

        void Layout(const Rect& rect);

        Size GetDesiredSize() const;

        void SetDesiredSize(const Size& desired_size);

        BasicLayoutParams* GetLayoutParams()
        {
            return &layout_params_;
        }

        Rect GetRect(RectRange range);

        Point TransformPoint(const Point& point, RectRange from = RectRange::Margin, RectRange to = RectRange::Content);

        //*************** region: border ***************

        BorderProperty& GetBorderProperty()
        {
            return border_property_;
        }

        void UpdateBorder();

        bool IsBordered() const
        {
            return is_bordered_;
        }

        void SetBordered(bool bordered);


        //*************** region: additional properties ***************
        AnyMap* GetAdditionalPropertyMap()
        {
            return &additional_property_map_;
        }

        
        //*************** region: cursor ***************
        // If cursor is set to null, then it uses parent's cursor.
        // Window's cursor can't be null.

        Cursor::Ptr GetCursor() const
        {
            return cursor_;
        }

        void SetCursor(const Cursor::Ptr& cursor);


        //*************** region: events ***************
        //Raised when mouse enter the control.
        events::MouseEvent mouse_enter_event;
        //Raised when mouse is leave the control.
        events::MouseEvent mouse_leave_event;
        //Raised when mouse is move in the control.
        events::MouseEvent mouse_move_event;
        //Raised when a mouse button is pressed in the control.
        events::MouseButtonEvent mouse_down_event;
        //Raised when a mouse button is released in the control.
        events::MouseButtonEvent mouse_up_event;
        //Raised when a mouse button is pressed in the control and released in the control with mouse not leaving it between two operations.
        events::MouseButtonEvent mouse_click_event;

        events::KeyEvent key_down_event;
        events::KeyEvent key_up_event;
        events::CharEvent char_event;

        events::FocusChangeEvent get_focus_event;
        events::FocusChangeEvent lose_focus_event;

        events::DrawEvent draw_content_event;
        events::DrawEvent draw_background_event;
        events::DrawEvent draw_foreground_event;

        events::PositionChangedEvent position_changed_event;
        events::SizeChangedEvent size_changed_event;

    protected:
        //Invoked when a child is added. Overrides should invoke base.
        virtual void OnAddChild(Control* child);
        //Invoked when a child is removed. Overrides should invoke base.
        virtual void OnRemoveChild(Control* child);

        //Invoked when the control is attached to a window. Overrides should invoke base.
        virtual void OnAttachToWindow(Window* window);
        //Invoked when the control is detached to a window. Overrides should invoke base.
        virtual void OnDetachToWindow(Window* window);

    private:
        void OnDrawCore(ID2D1DeviceContext* device_context);

    protected:

        //*************** region: graphic events ***************
        virtual void OnDrawContent(ID2D1DeviceContext* device_context);
        virtual void OnDrawForeground(ID2D1DeviceContext* device_context);
        virtual void OnDrawBackground(ID2D1DeviceContext* device_context);

        // For a event, the window event system will first dispatch event to core functions.
        // Therefore for particular controls, you should do essential actions in core functions,
        // and override version should invoke base version. The base core function
        // in "Control" class will call corresponding non-core function and call "Raise" on
        // event objects. So user custom actions should be done by overriding non-core function
        // and calling the base version is optional.

        //*************** region: position and size event ***************
        virtual void OnPositionChanged(events::PositionChangedEventArgs& args);
        virtual void OnSizeChanged(events::SizeChangedEventArgs& args);

        virtual void OnPositionChangedCore(events::PositionChangedEventArgs& args);
        virtual void OnSizeChangedCore(events::SizeChangedEventArgs& args);

        void RaisePositionChangedEvent(events::PositionChangedEventArgs& args);
        void RaiseSizeChangedEvent(events::SizeChangedEventArgs& args);

        void RegenerateBorderGeometry();

        //*************** region: mouse event ***************
        virtual void OnMouseEnter(events::MouseEventArgs& args);
        virtual void OnMouseLeave(events::MouseEventArgs& args);
        virtual void OnMouseMove(events::MouseEventArgs& args);
        virtual void OnMouseDown(events::MouseButtonEventArgs& args);
        virtual void OnMouseUp(events::MouseButtonEventArgs& args);
        virtual void OnMouseClick(events::MouseButtonEventArgs& args);

        virtual void OnMouseEnterCore(events::MouseEventArgs& args);
        virtual void OnMouseLeaveCore(events::MouseEventArgs& args);
        virtual void OnMouseMoveCore(events::MouseEventArgs& args);
        virtual void OnMouseDownCore(events::MouseButtonEventArgs& args);
        virtual void OnMouseUpCore(events::MouseButtonEventArgs& args);
        virtual void OnMouseClickCore(events::MouseButtonEventArgs& args);

        void RaiseMouseEnterEvent(events::MouseEventArgs& args);
        void RaiseMouseLeaveEvent(events::MouseEventArgs& args);
        void RaiseMouseMoveEvent(events::MouseEventArgs& args);
        void RaiseMouseDownEvent(events::MouseButtonEventArgs& args);
        void RaiseMouseUpEvent(events::MouseButtonEventArgs& args);
        void RaiseMouseClickEvent(events::MouseButtonEventArgs& args);

        virtual void OnMouseClickBegin(MouseButton button);
        virtual void OnMouseClickEnd(MouseButton button);

        //*************** region: keyboard event ***************
        virtual void OnKeyDown(events::KeyEventArgs& args);
        virtual void OnKeyUp(events::KeyEventArgs& args);
        virtual void OnChar(events::CharEventArgs& args);

        virtual void OnKeyDownCore(events::KeyEventArgs& args);
        virtual void OnKeyUpCore(events::KeyEventArgs& args);
        virtual void OnCharCore(events::CharEventArgs& args);

        void RaiseKeyDownEvent(events::KeyEventArgs& args);
        void RaiseKeyUpEvent(events::KeyEventArgs& args);
        void RaiseCharEvent(events::CharEventArgs& args);

        //*************** region: focus event ***************
        virtual void OnGetFocus(events::FocusChangeEventArgs& args);
        virtual void OnLoseFocus(events::FocusChangeEventArgs& args);

        virtual void OnGetFocusCore(events::FocusChangeEventArgs& args);
        virtual void OnLoseFocusCore(events::FocusChangeEventArgs& args);

        void RaiseGetFocusEvent(events::FocusChangeEventArgs& args);
        void RaiseLoseFocusEvent(events::FocusChangeEventArgs& args);

        //*************** region: layout ***************
        Size OnMeasureCore(const Size& available_size);
        void OnLayoutCore(const Rect& rect);

        virtual Size OnMeasureContent(const Size& available_size);
        virtual void OnLayoutContent(const Rect& rect);

    private:
        // Only for layout manager to use.
        // Check if the old position is updated to current position.
        // If not, then a notify of position change and update will
        // be done.
        void CheckAndNotifyPositionChanged();

        void ThrowIfNotContainer() const
        {
            if (!is_container_)
                throw std::runtime_error("You can't perform such operation on a non-container control.");
        }

    private:
        bool is_container_;

    protected:
        Window * window_ = nullptr; // protected for Window class to write it as itself in constructor.

    private:
        Control * parent_ = nullptr;
        std::vector<Control*> children_{};

        // When position is changed and notification hasn't been
        // sent, it will be the old position. When position is changed
        // more than once, it will be the oldest position since last
        // notification. If notification has been sent, it will be updated
        // to position_.
        Point old_position_ = Point::Zero();
        Point position_ = Point::Zero();
        Size size_ = Size::Zero();

        ControlPositionCache position_cache_{};

        bool is_mouse_inside_ = false;

        std::unordered_map<MouseButton, bool> is_mouse_click_valid_map_
        {
            { MouseButton::Left, true },
            { MouseButton::Middle, true },
            { MouseButton::Right, true }
        }; // used for clicking determination

        BasicLayoutParams layout_params_{};
        Size desired_size_ = Size::Zero();

        bool is_bordered_ = false;
        BorderProperty border_property_;

        Microsoft::WRL::ComPtr<ID2D1Geometry> border_geometry_ = nullptr;
        Microsoft::WRL::ComPtr<ID2D1Geometry> in_border_geometry_ = nullptr; //used for foreground and background brush.

        Microsoft::WRL::ComPtr<ID2D1Brush> foreground_brush_ = nullptr;
        Microsoft::WRL::ComPtr<ID2D1Brush> background_brush_ = nullptr;

        AnyMap additional_property_map_{};

        bool is_focus_on_pressed_ = true;

#ifdef CRU_DEBUG_LAYOUT
        Microsoft::WRL::ComPtr<ID2D1Geometry> margin_geometry_;
        Microsoft::WRL::ComPtr<ID2D1Geometry> padding_geometry_;
#endif

        Cursor::Ptr cursor_{};
    };

    // Find the lowest common ancestor.
    // Return nullptr if "left" and "right" are not in the same tree.
    Control* FindLowestCommonAncestor(Control* left, Control* right);

    // Return the ancestor if one control is the ancestor of the other one, otherwise nullptr.
    Control* IsAncestorOrDescendant(Control* left, Control* right);

    template <typename TControl, typename... Args>
    TControl* CreateWithLayout(const LayoutSideParams& width, const LayoutSideParams& height, Args&&... args)
    {
        static_assert(std::is_base_of_v<Control, TControl>, "TControl is not a control class.");
        TControl* control = TControl::Create(std::forward<Args>(args)...);
        control->GetLayoutParams()->width = width;
        control->GetLayoutParams()->height = height;
        return control;
    }


    template <typename TControl, typename... Args>
    TControl* CreateWithLayout(const Thickness& padding, const Thickness& margin, Args&&... args)
    {
        static_assert(std::is_base_of_v<Control, TControl>, "TControl is not a control class.");
        TControl* control = TControl::Create(std::forward<Args>(args)...);
        control->GetLayoutParams()->padding = padding;
        control->GetLayoutParams()->margin = margin;
        return control;
    }

    template <typename TControl, typename... Args>
    TControl* CreateWithLayout(const LayoutSideParams& width, const LayoutSideParams& height, const Thickness& padding, const Thickness& margin, Args&&... args)
    {
        static_assert(std::is_base_of_v<Control, TControl>, "TControl is not a control class.");
        TControl* control = TControl::Create(std::forward<Args>(args)...);
        control->GetLayoutParams()->width = width;
        control->GetLayoutParams()->height = height;
        control->GetLayoutParams()->padding = padding;
        control->GetLayoutParams()->margin = margin;
        return control;
    }

    using ControlList = std::initializer_list<Control*>;
}