ShrlAlgoToolkit/WPFluent/Controls/TitleBar/TitleBar.xaml.cs

using WPFluent.Designer;
using WPFluent.Extensions;
using WPFluent.Input;
using WPFluent.Interop;

using System.Diagnostics;
using System.Windows.Data;
using System.Windows.Input;

// ReSharper disable once CheckNamespace
namespace WPFluent.Controls;

/// <summary>
/// Custom navigation buttons for the window.
/// </summary>
[TemplatePart(Name = ElementMainGrid, Type = typeof(System.Windows.Controls.Grid))]
[TemplatePart(Name = ElementIcon, Type = typeof(System.Windows.Controls.Image))]
[TemplatePart(Name = ElementHelpButton, Type = typeof(TitleBarButton))]
[TemplatePart(Name = ElementMinimizeButton, Type = typeof(TitleBarButton))]
[TemplatePart(Name = ElementMaximizeButton, Type = typeof(TitleBarButton))]
[TemplatePart(Name = ElementRestoreButton, Type = typeof(TitleBarButton))]
[TemplatePart(Name = ElementCloseButton, Type = typeof(TitleBarButton))]
public class TitleBar : System.Windows.Controls.Control, IThemeControl
{
    private const string ElementCloseButton = "PART_CloseButton";
    private const string ElementHelpButton = "PART_HelpButton";
    private const string ElementIcon = "PART_Icon";
    private const string ElementMainGrid = "PART_MainGrid";
    private const string ElementMaximizeButton = "PART_MaximizeButton";
    private const string ElementMinimizeButton = "PART_MinimizeButton";
    private const string ElementRestoreButton = "PART_RestoreButton";

    private static DpiScale? dpiScale;

    /// <summary>
    /// Identifies the <see cref="ApplicationTheme"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty ApplicationThemeProperty = DependencyProperty.Register(
        nameof(ApplicationTheme),
        typeof(Appearance.ApplicationTheme),
        typeof(TitleBar),
        new PropertyMetadata(Appearance.ApplicationTheme.Unknown));

    /// <summary>
    /// Identifies the <see cref="ButtonsBackground"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty ButtonsBackgroundProperty = DependencyProperty.Register(
        nameof(ButtonsBackground),
        typeof(Brush),
        typeof(TitleBar),
        new FrameworkPropertyMetadata(SystemColors.ControlBrush, FrameworkPropertyMetadataOptions.Inherits));

    /// <summary>
    /// Identifies the <see cref="ButtonsForeground"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty ButtonsForegroundProperty = DependencyProperty.Register(
        nameof(ButtonsForeground),
        typeof(Brush),
        typeof(TitleBar),
        new FrameworkPropertyMetadata(SystemColors.ControlTextBrush, FrameworkPropertyMetadataOptions.Inherits));

    /// <summary>
    /// Identifies the <see cref="CanMaximize"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty CanMaximizeProperty = DependencyProperty.Register(
        nameof(CanMaximize),
        typeof(bool),
        typeof(TitleBar),
        new PropertyMetadata(true));

    /// <summary>
    /// Identifies the <see cref="CloseClicked"/> routed event.
    /// </summary>
    public static readonly RoutedEvent CloseClickedEvent = EventManager.RegisterRoutedEvent(
        nameof(CloseClicked),
        RoutingStrategy.Bubble,
        typeof(TypedEventHandler<TitleBar, RoutedEventArgs>),
        typeof(TitleBar));

    /// <summary>
    /// Identifies the <see cref="CloseWindowByDoubleClickOnIcon"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty CloseWindowByDoubleClickOnIconProperty =
        DependencyProperty.Register(
        nameof(CloseWindowByDoubleClickOnIcon),
        typeof(bool),
        typeof(TitleBar),
        new PropertyMetadata(false));

    /// <summary>
    /// Identifies the <see cref="ForceShutdown"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty ForceShutdownProperty = DependencyProperty.Register(
        nameof(ForceShutdown),
        typeof(bool),
        typeof(TitleBar),
        new PropertyMetadata(false));

    /// <summary>
    /// Property for <see cref="Header"/>.
    /// </summary>
    public static readonly DependencyProperty HeaderProperty = DependencyProperty.Register(
        nameof(Header),
        typeof(object),
        typeof(TitleBar),
        new PropertyMetadata(null));

    /// <summary>
    /// Identifies the <see cref="HelpClicked"/> routed event.
    /// </summary>
    public static readonly RoutedEvent HelpClickedEvent = EventManager.RegisterRoutedEvent(
        nameof(HelpClicked),
        RoutingStrategy.Bubble,
        typeof(TypedEventHandler<TitleBar, RoutedEventArgs>),
        typeof(TitleBar));

    /// <summary>
    /// Identifies the <see cref="Icon"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty IconProperty = DependencyProperty.Register(
        nameof(Icon),
        typeof(IconElement),
        typeof(TitleBar),
        new PropertyMetadata(null));

    /// <summary>
    /// Identifies the <see cref="IsMaximized"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty IsMaximizedProperty = DependencyProperty.Register(
        nameof(IsMaximized),
        typeof(bool),
        typeof(TitleBar),
        new PropertyMetadata(false));

    /// <summary>
    /// Identifies the <see cref="MaximizeClicked"/> routed event.
    /// </summary>
    public static readonly RoutedEvent MaximizeClickedEvent = EventManager.RegisterRoutedEvent(
        nameof(MaximizeClicked),
        RoutingStrategy.Bubble,
        typeof(TypedEventHandler<TitleBar, RoutedEventArgs>),
        typeof(TitleBar));

    /// <summary>
    /// Identifies the <see cref="MinimizeClicked"/> routed event.
    /// </summary>
    public static readonly RoutedEvent MinimizeClickedEvent = EventManager.RegisterRoutedEvent(
        nameof(MinimizeClicked),
        RoutingStrategy.Bubble,
        typeof(TypedEventHandler<TitleBar, RoutedEventArgs>),
        typeof(TitleBar));

    /// <summary>
    /// Identifies the <see cref="ShowClose"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty ShowCloseProperty = DependencyProperty.Register(
        nameof(ShowClose),
        typeof(bool),
        typeof(TitleBar),
        new PropertyMetadata(true));

    /// <summary>
    /// Identifies the <see cref="ShowHelp"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty ShowHelpProperty = DependencyProperty.Register(
        nameof(ShowHelp),
        typeof(bool),
        typeof(TitleBar),
        new PropertyMetadata(false));

    /// <summary>
    /// Identifies the <see cref="ShowMaximize"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty ShowMaximizeProperty = DependencyProperty.Register(
        nameof(ShowMaximize),
        typeof(bool),
        typeof(TitleBar),
        new PropertyMetadata(true));

    /// <summary>
    /// Identifies the <see cref="ShowMinimize"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty ShowMinimizeProperty = DependencyProperty.Register(
        nameof(ShowMinimize),
        typeof(bool),
        typeof(TitleBar),
        new PropertyMetadata(true));

    /// <summary>
    /// Identifies the <see cref="TemplateButtonCommand"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty TemplateButtonCommandProperty = DependencyProperty.Register(
        nameof(TemplateButtonCommand),
        typeof(IRelayCommand),
        typeof(TitleBar),
        new PropertyMetadata(null));

    /// <summary>
    /// Identifies the <see cref="Title"/> dependency property.
    /// </summary>
    public static readonly DependencyProperty TitleProperty = DependencyProperty.Register(
        nameof(Title),
        typeof(string),
        typeof(TitleBar),
        new PropertyMetadata(null));

    /// <summary>
    /// Property for <see cref="TrailingContent"/>.
    /// </summary>
    public static readonly DependencyProperty TrailingContentProperty = DependencyProperty.Register(
        nameof(TrailingContent),
        typeof(object),
        typeof(TitleBar),
        new PropertyMetadata(null));

    private readonly TitleBarButton[] _buttons = new TitleBarButton[4];
    private System.Windows.Window _currentWindow = null!;

    /*private System.Windows.Controls.Grid _mainGrid = null!;*/
    private System.Windows.Controls.ContentPresenter _icon = null!;

    private DependencyObject _parentWindow;
    private readonly TextBlock _titleBlock;

    /// <summary>
    /// Initializes a new instance of the <see cref="TitleBar"/> class and sets the default <see
    /// cref="FrameworkElement.Loaded"/> event.
    /// </summary>
    public TitleBar()
    {
        SetValue(TemplateButtonCommandProperty, new RelayCommand<TitleBarButtonType>(OnTemplateButtonClick));

        dpiScale ??= VisualTreeHelper.GetDpi(this);

        _titleBlock = new TextBlock();
        _titleBlock.VerticalAlignment = VerticalAlignment.Center;
        _ = _titleBlock.SetBinding(
            System.Windows.Controls.TextBlock.TextProperty,
            new Binding(nameof(Title)) { Source = this });
        _ = _titleBlock.SetBinding(
            System.Windows.Controls.TextBlock.FontSizeProperty,
            new Binding(nameof(FontSize)) { Source = this });
        Header = _titleBlock;

        Loaded += OnLoaded;
        Unloaded += OnUnloaded;
    }

    /// <summary>
    /// Event triggered after clicking close button.
    /// </summary>
    public event TypedEventHandler<TitleBar, RoutedEventArgs> CloseClicked
    {
        add => AddHandler(CloseClickedEvent, value);
        remove => RemoveHandler(CloseClickedEvent, value);
    }

    /// <summary>
    /// Event triggered after clicking help button
    /// </summary>
    public event TypedEventHandler<TitleBar, RoutedEventArgs> HelpClicked
    {
        add => AddHandler(HelpClickedEvent, value);
        remove => RemoveHandler(HelpClickedEvent, value);
    }

    /// <summary>
    /// Event triggered after clicking maximize or restore button.
    /// </summary>
    public event TypedEventHandler<TitleBar, RoutedEventArgs> MaximizeClicked
    {
        add => AddHandler(MaximizeClickedEvent, value);
        remove => RemoveHandler(MaximizeClickedEvent, value);
    }

    /// <summary>
    /// Event triggered after clicking minimize button.
    /// </summary>
    public event TypedEventHandler<TitleBar, RoutedEventArgs> MinimizeClicked
    {
        add => AddHandler(MinimizeClickedEvent, value);
        remove => RemoveHandler(MinimizeClickedEvent, value);
    }

    private void CloseWindow()
    {
        Debug.WriteLine(
            $"INFO | {typeof(TitleBar)}.CloseWindow:ForceShutdown -  {ForceShutdown}",
            "WPFluent.TitleBar");

        if(ForceShutdown)
        {
            UiApplication.Current.Shutdown();
            return;
        }

        _currentWindow.Close();
    }

    private T GetTemplateChild<T>(string name) where T : DependencyObject
    {
        var element = GetTemplateChild(name);

        if(element is not T tElement)
        {
            throw new InvalidOperationException($"Template part '{name}' is not found or is not of type {typeof(T)}");
        }

        return tElement;
    }

    private IntPtr HwndSourceHook(IntPtr hwnd, int msg, IntPtr wParam, IntPtr lParam, ref bool handled)
    {
        var message = (User32.WM)msg;

        if(message
            is not (
                User32.WM.NCHITTEST
                or User32.WM.NCMOUSELEAVE
                or User32.WM.NCLBUTTONDOWN
                or User32.WM.NCLBUTTONUP
            ))
        {
            return IntPtr.Zero;
        }

        foreach(TitleBarButton button in _buttons)
        {
            if(!button.ReactToHwndHook(message, lParam, out IntPtr returnIntPtr))
            {
                continue;
            }

            // Fix for when sometimes, button hover backgrounds aren't cleared correctly, causing multiple buttons to appear as if hovered.
            foreach(TitleBarButton anotherButton in _buttons)
            {
                if(anotherButton == button)
                {
                    continue;
                }

                if(anotherButton.IsHovered && button.IsHovered)
                {
                    anotherButton.RemoveHover();
                }
            }

            handled = true;
            return returnIntPtr;
        }

        var isMouseOverHeaderContent = false;

        if(message == User32.WM.NCHITTEST && (TrailingContent is UIElement || Header is UIElement))
        {
            var headerLeftUIElement = Header as UIElement;
            var headerRightUiElement = TrailingContent as UIElement;

            if(headerLeftUIElement is not null && headerLeftUIElement != _titleBlock)
            {
                isMouseOverHeaderContent =
                    headerLeftUIElement.IsMouseOverElement(lParam) ||
                    (headerRightUiElement?.IsMouseOverElement(lParam) ?? false);
            }
            else
            {
                isMouseOverHeaderContent = headerRightUiElement?.IsMouseOverElement(lParam) ?? false;
            }
        }

        switch(message)
        {
            case User32.WM.NCHITTEST when CloseWindowByDoubleClickOnIcon && _icon.IsMouseOverElement(lParam):
                // Ideally, clicking on the icon should open the system menu, but when the system menu is opened manually, double-clicking on the icon does not close the window
                handled = true;
                return (IntPtr)User32.WM_NCHITTEST.HTSYSMENU;
            case User32.WM.NCHITTEST when this.IsMouseOverElement(lParam) && !isMouseOverHeaderContent:
                handled = true;
                return (IntPtr)User32.WM_NCHITTEST.HTCAPTION;
            default:
                return IntPtr.Zero;
        }
    }

    private void MaximizeWindow()
    {
        if(!CanMaximize)
        {
            return;
        }

        if(MaximizeActionOverride is not null)
        {
            MaximizeActionOverride(this, _currentWindow);

            return;
        }

        if(_currentWindow.WindowState == WindowState.Normal)
        {
            SetCurrentValue(IsMaximizedProperty, true);
            _currentWindow.SetCurrentValue(Window.WindowStateProperty, WindowState.Maximized);
        }
        else
        {
            SetCurrentValue(IsMaximizedProperty, false);
            _currentWindow.SetCurrentValue(Window.WindowStateProperty, WindowState.Normal);
        }
    }

    private void MinimizeWindow()
    {
        if(MinimizeActionOverride is not null)
        {
            MinimizeActionOverride(this, _currentWindow);

            return;
        }

        _currentWindow.SetCurrentValue(Window.WindowStateProperty, WindowState.Minimized);
    }

    private void OnParentWindowStateChanged(object sender, EventArgs e)
    {
        if(IsMaximized != (_currentWindow.WindowState == WindowState.Maximized))
        {
            SetCurrentValue(IsMaximizedProperty, _currentWindow.WindowState == WindowState.Maximized);
        }
    }

    private void OnTemplateButtonClick(TitleBarButtonType buttonType)
    {
        switch(buttonType)
        {
            case TitleBarButtonType.Maximize
            or TitleBarButtonType.Restore:
                RaiseEvent(new RoutedEventArgs(MaximizeClickedEvent, this));
                MaximizeWindow();
                break;

            case TitleBarButtonType.Close:
                RaiseEvent(new RoutedEventArgs(CloseClickedEvent, this));
                CloseWindow();
                break;

            case TitleBarButtonType.Minimize:
                RaiseEvent(new RoutedEventArgs(MinimizeClickedEvent, this));
                MinimizeWindow();
                break;

            case TitleBarButtonType.Help:
                RaiseEvent(new RoutedEventArgs(HelpClickedEvent, this));
                break;
        }
    }

    private void OnUnloaded(object sender, RoutedEventArgs e)
    {
        Loaded -= OnLoaded;
        Unloaded -= OnUnloaded;

        Appearance.ApplicationThemeManager.Changed -= OnThemeChanged;
    }

    /// <summary>
    /// Listening window hooks after rendering window content to SizeToContent support
    /// </summary>
    private void OnWindowContentRendered(object sender, EventArgs e)
    {
        if(sender is not Window window)
        {
            return;
        }

        window.ContentRendered -= OnWindowContentRendered;

        var handle = new WindowInteropHelper(window).Handle;
        var windowSource =
            HwndSource.FromHwnd(handle) ?? throw new InvalidOperationException("Window source is null");
        windowSource.AddHook(HwndSourceHook);
    }

    /// <summary>
    /// Show 'SystemMenu' on mouse right button up.
    /// </summary>
    private void TitleBar_MouseRightButtonUp(object sender, MouseButtonEventArgs e)
    {
        var point = PointToScreen(e.GetPosition(this));

        if(dpiScale is null)
        {
            throw new InvalidOperationException("dpiScale is not initialized.");
        }

        SystemCommands.ShowSystemMenu(
            _parentWindow as Window,
            new Point(point.X / dpiScale.Value.DpiScaleX, point.Y / dpiScale.Value.DpiScaleY));
    }

    /// <inheritdoc/>
    protected override void OnInitialized(EventArgs e)
    {
        base.OnInitialized(e);

        SetCurrentValue(ApplicationThemeProperty, Appearance.ApplicationThemeManager.GetAppTheme());
        Appearance.ApplicationThemeManager.Changed += OnThemeChanged;
    }

    protected virtual void OnLoaded(object sender, RoutedEventArgs e)
    {
        if(DesignerHelper.IsInDesignMode)
        {
            return;
        }

        _currentWindow =
            System.Windows.Window.GetWindow(this) ?? throw new InvalidOperationException("Window is null");
        _currentWindow.StateChanged += OnParentWindowStateChanged;
        _currentWindow.ContentRendered += OnWindowContentRendered;
    }

    /// <summary>
    /// This virtual method is triggered when the app's theme changes.
    /// </summary>
    protected virtual void OnThemeChanged(Appearance.ApplicationTheme currentApplicationTheme, Color systemAccent)
    {
        Debug.WriteLine(
            $"INFO | {typeof(TitleBar)} received theme -  {currentApplicationTheme}",
            "WPFluent.TitleBar");

        SetCurrentValue(ApplicationThemeProperty, currentApplicationTheme);
    }

    /// <summary>
    /// Invoked whenever application code or an internal process, such as a rebuilding layout pass, calls the
    /// ApplyTemplate method.
    /// </summary>
    public override void OnApplyTemplate()
    {
        base.OnApplyTemplate();

        _parentWindow = VisualTreeHelper.GetParent(this);

        while(_parentWindow is not null and not Window)
        {
            _parentWindow = VisualTreeHelper.GetParent(_parentWindow);
        }

        MouseRightButtonUp += TitleBar_MouseRightButtonUp;

        /*_mainGrid = GetTemplateChild<System.Windows.Controls.Grid>(ElementMainGrid);*/
        _icon = GetTemplateChild<System.Windows.Controls.ContentPresenter>(ElementIcon);

        var helpButton = GetTemplateChild<TitleBarButton>(ElementHelpButton);
        var minimizeButton = GetTemplateChild<TitleBarButton>(ElementMinimizeButton);
        var maximizeButton = GetTemplateChild<TitleBarButton>(ElementMaximizeButton);
        var closeButton = GetTemplateChild<TitleBarButton>(ElementCloseButton);

        _buttons[0] = maximizeButton;
        _buttons[1] = minimizeButton;
        _buttons[2] = closeButton;
        _buttons[3] = helpButton;
    }

    /// <inheritdoc/>
    public Appearance.ApplicationTheme ApplicationTheme
    {
        get => (Appearance.ApplicationTheme)GetValue(ApplicationThemeProperty);
        set => SetValue(ApplicationThemeProperty, value);
    }

    /// <summary>
    /// Gets or sets the background of the navigation buttons when hovered.
    /// </summary>
    [Bindable(true)]
    [Category("Appearance")]
    public Brush ButtonsBackground
    {
        get => (Brush)GetValue(ButtonsBackgroundProperty);
        set => SetValue(ButtonsBackgroundProperty, value);
    }

    /// <summary>
    /// Gets or sets the foreground of the navigation buttons.
    /// </summary>
    [Bindable(true)]
    [Category("Appearance")]
    public Brush ButtonsForeground
    {
        get => (Brush)GetValue(ButtonsForegroundProperty);
        set => SetValue(ButtonsForegroundProperty, value);
    }

    /// <summary>
    /// Gets or sets a value indicating whether the maximize functionality is enabled. If disabled the
    /// MaximizeActionOverride action won't be called
    /// </summary>
    public bool CanMaximize { get => (bool)GetValue(CanMaximizeProperty); set => SetValue(CanMaximizeProperty, value); }

    /// <summary>
    /// Gets or sets a value indicating whether the window can be closed by double clicking on the icon
    /// </summary>
    public bool CloseWindowByDoubleClickOnIcon
    {
        get => (bool)GetValue(CloseWindowByDoubleClickOnIconProperty);
        set => SetValue(CloseWindowByDoubleClickOnIconProperty, value);
    }

    /// <summary>
    /// Gets or sets a value indicating whether the controls affect main application window.
    /// </summary>
    public bool ForceShutdown
    {
        get => (bool)GetValue(ForceShutdownProperty);
        set => SetValue(ForceShutdownProperty, value);
    }

    /// <summary>
    /// Gets or sets the content displayed in the left side of the <see cref="TitleBar"/>.
    /// </summary>
    public object Header { get => GetValue(HeaderProperty); set => SetValue(HeaderProperty, value); }

    /// <summary>
    /// Gets or sets the titlebar icon.
    /// </summary>
    public IconElement Icon { get => (IconElement)GetValue(IconProperty); set => SetValue(IconProperty, value); }

    /// <summary>
    /// Gets a value indicating whether the current window is maximized.
    /// </summary>
    public bool IsMaximized
    {
        get => (bool)GetValue(IsMaximizedProperty);
        internal set => SetValue(IsMaximizedProperty, value);
    }

    /// <summary>
    /// Gets or sets the <see cref="Action"/> that should be executed when the Maximize button is clicked."/>
    /// </summary>
    public Action<TitleBar, System.Windows.Window> MaximizeActionOverride { get; set; }

    /// <summary>
    /// Gets or sets what <see cref="Action"/> should be executed when the Minimize button is clicked.
    /// </summary>
    public Action<TitleBar, System.Windows.Window> MinimizeActionOverride { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether to show the close button.
    /// </summary>
    public bool ShowClose { get => (bool)GetValue(ShowCloseProperty); set => SetValue(ShowCloseProperty, value); }

    /// <summary>
    /// Gets or sets a value indicating whether to show the help button
    /// </summary>
    public bool ShowHelp { get => (bool)GetValue(ShowHelpProperty); set => SetValue(ShowHelpProperty, value); }

    /// <summary>
    /// Gets or sets a value indicating whether to show the maximize button.
    /// </summary>
    public bool ShowMaximize
    {
        get => (bool)GetValue(ShowMaximizeProperty);
        set => SetValue(ShowMaximizeProperty, value);
    }

    /// <summary>
    /// Gets or sets a value indicating whether to show the minimize button.
    /// </summary>
    public bool ShowMinimize
    {
        get => (bool)GetValue(ShowMinimizeProperty);
        set => SetValue(ShowMinimizeProperty, value);
    }

    /// <summary>
    /// Gets the command triggered when clicking the titlebar button.
    /// </summary>
    public IRelayCommand TemplateButtonCommand => (IRelayCommand)GetValue(TemplateButtonCommandProperty);

    /// <summary>
    /// Gets or sets title displayed on the left.
    /// </summary>
    public string Title { get => (string)GetValue(TitleProperty); set => SetValue(TitleProperty, value); }

    /// <summary>
    /// Gets or sets the content displayed in right side of the <see cref="TitleBar"/>.
    /// </summary>
    public object TrailingContent
    {
        get => GetValue(TrailingContentProperty);
        set => SetValue(TrailingContentProperty, value);
    }
}