diff --git a/Source/Editor/GUI/Docking/DockHintWindow.cs b/Source/Editor/GUI/Docking/DockHintWindow.cs deleted file mode 100644 index 301605783..000000000 --- a/Source/Editor/GUI/Docking/DockHintWindow.cs +++ /dev/null @@ -1,535 +0,0 @@ -// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved. - -using System; -using FlaxEngine; -using FlaxEngine.GUI; - -namespace FlaxEditor.GUI.Docking -{ - /// - /// Helper class used to handle docking windows dragging and docking. - /// - public class DockHintWindow - { - private FloatWindowDockPanel _toMove; - - private Float2 _dragOffset; - private Float2 _defaultWindowSize; - private Rectangle _rectDock; - private Rectangle _rectWindow; - private Float2 _mouse; - private DockState _toSet; - private DockPanel _toDock; - private bool _lateDragOffsetUpdate; - - private Rectangle _rLeft, _rRight, _rBottom, _rUpper, _rCenter; - - private DockHintWindow(FloatWindowDockPanel toMove) - { - _toMove = toMove; - _toSet = DockState.Float; - var window = toMove.Window.Window; - - // Remove focus from drag target - _toMove.Focus(); - _toMove.Defocus(); - - // Focus window - window.Focus(); - - // Check if window is maximized and restore window. - if (window.IsMaximized) - { - // Restore window and set position to mouse. - var mousePos = window.MousePosition; - var previousSize = window.Size; - window.Restore(); - window.Position = Platform.MousePosition - mousePos * window.Size / previousSize; - } - - // Calculate dragging offset and move window to the destination position - var mouseScreenPosition = Platform.MousePosition; - - // If the _toMove window was not focused when initializing this window, the result vector only contains zeros - // and to prevent a failure, we need to perform an update for the drag offset at later time which will be done in the OnMouseMove event handler. - if (mouseScreenPosition != Float2.Zero) - CalculateDragOffset(mouseScreenPosition); - else - _lateDragOffsetUpdate = true; - - // Get initial size - _defaultWindowSize = window.Size; - - // Init proxy window - Proxy.Init(ref _defaultWindowSize); - - // Bind events - Proxy.Window.MouseUp += OnMouseUp; - Proxy.Window.MouseMove += OnMouseMove; - Proxy.Window.LostFocus += OnLostFocus; - _toMove.Window.Window.MouseUp += OnMouseUp; // Intercept the drag release mouse event from source window - - // Update window GUI - Proxy.Window.GUI.PerformLayout(); - - // Update rectangles - UpdateRects(); - - // Enable hit window presentation - Proxy.Window.RenderingEnabled = true; - Proxy.Window.Show(); - Proxy.Window.Focus(); - - // Hide base window - window.Hide(); - - // Start tracking mouse - Proxy.Window.StartTrackingMouse(false); - } - - /// - /// Releases unmanaged and - optionally - managed resources. - /// - public void Dispose() - { - // End tracking mouse - Proxy.Window.EndTrackingMouse(); - - // Disable rendering - Proxy.Window.RenderingEnabled = false; - - // Unbind events - Proxy.Window.MouseUp -= OnMouseUp; - Proxy.Window.MouseMove -= OnMouseMove; - Proxy.Window.LostFocus -= OnLostFocus; - if (_toMove?.Window?.Window) - _toMove.Window.Window.MouseUp -= OnMouseUp; - - // Hide the proxy - Proxy.Hide(); - - if (_toMove == null) - return; - - // Check if window won't be docked - if (_toSet == DockState.Float) - { - var window = _toMove.Window?.Window; - if (window == null) - return; - var mouse = Platform.MousePosition; - - // Move base window - window.Position = mouse - _dragOffset; - - // Show base window - window.Show(); - } - else - { - bool hasNoChildPanels = _toMove.ChildPanelsCount == 0; - - // Check if window has only single tab - if (hasNoChildPanels && _toMove.TabsCount == 1) - { - // Dock window - _toMove.GetTab(0).Show(_toSet, _toDock); - } - // Check if dock as tab and has no child panels - else if (hasNoChildPanels && _toSet == DockState.DockFill) - { - // Dock all tabs - while (_toMove.TabsCount > 0) - { - _toMove.GetTab(0).Show(DockState.DockFill, _toDock); - } - } - else - { - var selectedTab = _toMove.SelectedTab; - - // Dock the first tab into the target location - if (_toMove.TabsCount > 0) - { - var firstTab = _toMove.GetTab(0); - firstTab.Show(_toSet, _toDock); - - // Dock rest of the tabs - while (_toMove.TabsCount > 0) - { - _toMove.GetTab(0).Show(DockState.DockFill, firstTab); - } - } - - // Keep selected tab being selected - selectedTab?.SelectTab(); - } - - // Focus target window - _toDock.Root.Focus(); - } - - _toMove = null; - } - - /// - /// Creates the new dragging hit window. - /// - /// Floating dock panel to move. - /// The dock hint window object. - public static DockHintWindow Create(FloatWindowDockPanel toMove) - { - if (toMove == null) - throw new ArgumentNullException(); - - return new DockHintWindow(toMove); - } - - /// - /// Creates the new dragging hit window. - /// - /// Dock window to move. - /// The dock hint window object. - public static DockHintWindow Create(DockWindow toMove) - { - if (toMove == null) - throw new ArgumentNullException(); - - // Show floating - toMove.ShowFloating(); - - // Move window to the mouse position (with some offset for caption bar) - var window = (WindowRootControl)toMove.Root; - var mouse = Platform.MousePosition; - window.Window.Position = mouse - new Float2(8, 8); - - // Get floating panel - var floatingPanelToMove = window.GetChild(0) as FloatWindowDockPanel; - - return new DockHintWindow(floatingPanelToMove); - } - - /// - /// Calculates window rectangle in the dock window. - /// - /// Window dock state. - /// Dock panel rectangle. - /// Calculated window rectangle. - public static Rectangle CalculateDockRect(DockState state, ref Rectangle rect) - { - Rectangle result = rect; - switch (state) - { - case DockState.DockFill: - result.Location.Y += DockPanel.DefaultHeaderHeight; - result.Size.Y -= DockPanel.DefaultHeaderHeight; - break; - case DockState.DockTop: - result.Size.Y *= DockPanel.DefaultSplitterValue; - break; - case DockState.DockLeft: - result.Size.X *= DockPanel.DefaultSplitterValue; - break; - case DockState.DockBottom: - result.Location.Y += result.Size.Y * (1 - DockPanel.DefaultSplitterValue); - result.Size.Y *= DockPanel.DefaultSplitterValue; - break; - case DockState.DockRight: - result.Location.X += result.Size.X * (1 - DockPanel.DefaultSplitterValue); - result.Size.X *= DockPanel.DefaultSplitterValue; - break; - } - return result; - } - - private void CalculateDragOffset(Float2 mouseScreenPosition) - { - var baseWinPos = _toMove.Window.Window.Position; - _dragOffset = mouseScreenPosition - baseWinPos; - } - - private void UpdateRects() - { - // Cache mouse position - _mouse = Platform.MousePosition; - - // Check intersection with any dock panel - var uiMouse = _mouse; - _toDock = _toMove.MasterPanel.HitTest(ref uiMouse, _toMove); - - // Check dock state to use - bool showProxyHints = _toDock != null; - bool showBorderHints = showProxyHints; - bool showCenterHint = showProxyHints; - if (showProxyHints) - { - // If moved window has not only tabs but also child panels disable docking as tab - if (_toMove.ChildPanelsCount > 0) - showCenterHint = false; - - // Disable docking windows with one or more dock panels inside - if (_toMove.ChildPanelsCount > 0) - showBorderHints = false; - - // Get dock area - _rectDock = _toDock.DockAreaBounds; - - // Cache dock rectangles - var size = _rectDock.Size; - var offset = _rectDock.Location; - var borderMargin = 4.0f; - var hintWindowsSize = Proxy.HintWindowsSize * Platform.DpiScale; - var hintWindowsSize2 = hintWindowsSize * 0.5f; - var centerX = size.X * 0.5f; - var centerY = size.Y * 0.5f; - _rUpper = new Rectangle(centerX - hintWindowsSize2, borderMargin, hintWindowsSize, hintWindowsSize) + offset; - _rBottom = new Rectangle(centerX - hintWindowsSize2, size.Y - hintWindowsSize - borderMargin, hintWindowsSize, hintWindowsSize) + offset; - _rLeft = new Rectangle(borderMargin, centerY - hintWindowsSize2, hintWindowsSize, hintWindowsSize) + offset; - _rRight = new Rectangle(size.X - hintWindowsSize - borderMargin, centerY - hintWindowsSize2, hintWindowsSize, hintWindowsSize) + offset; - _rCenter = new Rectangle(centerX - hintWindowsSize2, centerY - hintWindowsSize2, hintWindowsSize, hintWindowsSize) + offset; - - // Hit test - DockState toSet = DockState.Float; - if (showBorderHints) - { - if (_rUpper.Contains(_mouse)) - toSet = DockState.DockTop; - else if (_rBottom.Contains(_mouse)) - toSet = DockState.DockBottom; - else if (_rLeft.Contains(_mouse)) - toSet = DockState.DockLeft; - else if (_rRight.Contains(_mouse)) - toSet = DockState.DockRight; - } - if (showCenterHint && _rCenter.Contains(_mouse)) - toSet = DockState.DockFill; - _toSet = toSet; - - // Show proxy hint windows - Proxy.Down.Position = _rBottom.Location; - Proxy.Left.Position = _rLeft.Location; - Proxy.Right.Position = _rRight.Location; - Proxy.Up.Position = _rUpper.Location; - Proxy.Center.Position = _rCenter.Location; - } - else - { - _toSet = DockState.Float; - } - - // Update proxy hint windows visibility - Proxy.Down.IsVisible = showProxyHints & showBorderHints; - Proxy.Left.IsVisible = showProxyHints & showBorderHints; - Proxy.Right.IsVisible = showProxyHints & showBorderHints; - Proxy.Up.IsVisible = showProxyHints & showBorderHints; - Proxy.Center.IsVisible = showProxyHints & showCenterHint; - - // Calculate proxy/dock/window rectangles - if (_toDock == null) - { - // Floating window over nothing - _rectWindow = new Rectangle(_mouse - _dragOffset, _defaultWindowSize); - } - else - { - if (_toSet == DockState.Float) - { - // Floating window over dock panel - _rectWindow = new Rectangle(_mouse - _dragOffset, _defaultWindowSize); - } - else - { - // Use only part of the dock panel to show hint - _rectWindow = CalculateDockRect(_toSet, ref _rectDock); - } - } - - // Update proxy window - Proxy.Window.ClientBounds = _rectWindow; - } - - private void OnMouseUp(ref Float2 location, MouseButton button, ref bool handled) - { - if (button == MouseButton.Left) - { - Dispose(); - } - } - - private void OnMouseMove(ref Float2 mousePos) - { - // Recalculate the drag offset because the current mouse screen position was invalid when we initialized the window - if (_lateDragOffsetUpdate) - { - // Calculate dragging offset and move window to the destination position - CalculateDragOffset(mousePos); - - // Reset state - _lateDragOffsetUpdate = false; - } - - UpdateRects(); - } - - private void OnLostFocus() - { - Dispose(); - } - - /// - /// Contains helper proxy windows shared across docking panels. They are used to visualize docking window locations. - /// - public static class Proxy - { - /// - /// The drag proxy window. - /// - public static Window Window; - - /// - /// The left hint proxy window. - /// - public static Window Left; - - /// - /// The right hint proxy window. - /// - public static Window Right; - - /// - /// The up hint proxy window. - /// - public static Window Up; - - /// - /// The down hint proxy window. - /// - public static Window Down; - - /// - /// The center hint proxy window. - /// - public static Window Center; - - /// - /// The hint windows size. - /// - public const float HintWindowsSize = 32.0f; - - /// - /// Initializes the hit proxy windows. Those windows are used to indicate drag target areas (left, right, top, bottom, etc.). - /// - public static void InitHitProxy() - { - CreateProxy(ref Left, "DockHint.Left"); - CreateProxy(ref Right, "DockHint.Right"); - CreateProxy(ref Up, "DockHint.Up"); - CreateProxy(ref Down, "DockHint.Down"); - CreateProxy(ref Center, "DockHint.Center"); - } - - /// - /// Initializes the hint window. - /// - /// Initial size of the proxy window. - public static void Init(ref Float2 initSize) - { - if (Window == null) - { - var settings = CreateWindowSettings.Default; - settings.Title = "DockHint.Window"; - settings.Size = initSize; - settings.AllowInput = true; - settings.AllowMaximize = false; - settings.AllowMinimize = false; - settings.HasBorder = false; - settings.HasSizingFrame = false; - settings.Type = WindowType.Utility; - settings.SupportsTransparency = true; - settings.ShowInTaskbar = false; - settings.ShowAfterFirstPaint = false; - settings.IsTopmost = true; - - Window = Platform.CreateWindow(ref settings); - Window.Opacity = 0.6f; - Window.GUI.BackgroundColor = Style.Current.DragWindow; - } - else - { - // Resize proxy - Window.ClientSize = initSize; - } - - InitHitProxy(); - } - - private static void CreateProxy(ref Window win, string name) - { - if (win != null) - return; - - var settings = CreateWindowSettings.Default; - settings.Title = name; - settings.Size = new Float2(HintWindowsSize * Platform.DpiScale); - settings.AllowInput = false; - settings.AllowMaximize = false; - settings.AllowMinimize = false; - settings.HasBorder = false; - settings.HasSizingFrame = false; - settings.Type = WindowType.Utility; - settings.SupportsTransparency = true; - settings.ShowInTaskbar = false; - settings.ActivateWhenFirstShown = false; - settings.IsTopmost = true; - settings.ShowAfterFirstPaint = false; - - win = Platform.CreateWindow(ref settings); - win.Opacity = 0.6f; - win.GUI.BackgroundColor = Style.Current.DragWindow; - } - - /// - /// Hides proxy windows. - /// - public static void Hide() - { - HideProxy(ref Window); - HideProxy(ref Left); - HideProxy(ref Right); - HideProxy(ref Up); - HideProxy(ref Down); - HideProxy(ref Center); - } - - private static void HideProxy(ref Window win) - { - if (win) - { - win.Hide(); - } - } - - /// - /// Releases proxy data and windows. - /// - public static void Dispose() - { - DisposeProxy(ref Window); - DisposeProxy(ref Left); - DisposeProxy(ref Right); - DisposeProxy(ref Up); - DisposeProxy(ref Down); - DisposeProxy(ref Center); - } - - private static void DisposeProxy(ref Window win) - { - if (win) - { - win.Close(ClosingReason.User); - win = null; - } - } - } - } -} diff --git a/Source/Editor/GUI/Docking/DockPanelProxy.cs b/Source/Editor/GUI/Docking/DockPanelProxy.cs index 4e7ca8973..19253cfb7 100644 --- a/Source/Editor/GUI/Docking/DockPanelProxy.cs +++ b/Source/Editor/GUI/Docking/DockPanelProxy.cs @@ -170,7 +170,7 @@ namespace FlaxEditor.GUI.Docking if (_panel.ChildPanelsCount == 0 && _panel.TabsCount == 1 && _panel.IsFloating) { // Create docking hint window but in an async manner - DockHintWindow.Create(_panel as FloatWindowDockPanel); + WindowDragHelper.StartDragging(_panel as FloatWindowDockPanel); } else { @@ -181,7 +181,7 @@ namespace FlaxEditor.GUI.Docking _panel.SelectTab(index - 1); // Create docking hint window - DockHintWindow.Create(win); + WindowDragHelper.StartDragging(win, _panel.RootWindow.Window); } } } diff --git a/Source/Editor/GUI/Docking/DockWindow.cs b/Source/Editor/GUI/Docking/DockWindow.cs index 937d6232f..52eb708d7 100644 --- a/Source/Editor/GUI/Docking/DockWindow.cs +++ b/Source/Editor/GUI/Docking/DockWindow.cs @@ -182,6 +182,25 @@ namespace FlaxEditor.GUI.Docking /// Window size, set to use default. /// Window location. public void ShowFloating(Float2 location, Float2 size, WindowStartPosition position = WindowStartPosition.CenterParent) + { + CreateFloating(location, size, position, true); + } + + /// + /// Creates the window in a floating state. + /// + public void CreateFloating() + { + CreateFloating(Float2.Zero, Float2.Zero); + } + /// + /// Creates the window in a floating state. + /// + /// Window location. + /// Window size, set to use default. + /// Window location. + /// Window visibility. + public void CreateFloating(Float2 location, Float2 size, WindowStartPosition position = WindowStartPosition.CenterParent, bool showWindow = false) { Undock(); @@ -199,14 +218,17 @@ namespace FlaxEditor.GUI.Docking windowGUI.UnlockChildrenRecursive(); windowGUI.PerformLayout(); - // Show - window.Show(); - window.BringToFront(); - window.Focus(); - OnShow(); + if (showWindow) + { + // Show + window.Show(); + window.BringToFront(); + window.Focus(); + OnShow(); - // Perform layout again - windowGUI.PerformLayout(); + // Perform layout again + windowGUI.PerformLayout(); + } } /// diff --git a/Source/Editor/GUI/Docking/FloatWindowDockPanel.cs b/Source/Editor/GUI/Docking/FloatWindowDockPanel.cs index 3f5131680..90ecb08b3 100644 --- a/Source/Editor/GUI/Docking/FloatWindowDockPanel.cs +++ b/Source/Editor/GUI/Docking/FloatWindowDockPanel.cs @@ -52,7 +52,7 @@ namespace FlaxEditor.GUI.Docking return; // Create docking hint window - DockHintWindow.Create(this); + WindowDragHelper.StartDragging(this); } /// diff --git a/Source/Editor/GUI/Docking/MasterDockPanel.cs b/Source/Editor/GUI/Docking/MasterDockPanel.cs index 80f710a18..5cefbd3bd 100644 --- a/Source/Editor/GUI/Docking/MasterDockPanel.cs +++ b/Source/Editor/GUI/Docking/MasterDockPanel.cs @@ -81,7 +81,6 @@ namespace FlaxEditor.GUI.Docking public DockPanel HitTest(ref Float2 position, FloatWindowDockPanel excluded) { // Check all floating windows - // TODO: gather windows order and take it into account when performing test for (int i = 0; i < FloatingPanels.Count; i++) { var win = FloatingPanels[i]; @@ -94,9 +93,44 @@ namespace FlaxEditor.GUI.Docking } // Base + //if (!Root?.RootWindow.Window.IsFocused ?? false) + // return null; return base.HitTest(ref position); } + /// + /// Performs hit test over dock panel. + /// + /// Window space position to test. + /// Floating window to omit during searching (and all docked to that one). + /// Results of the hit test + /// True if any dock panels were hit, otherwise false. + public bool HitTest(ref Float2 position, FloatWindowDockPanel excluded, out DockPanel[] hitResults) + { + // Check all floating windows + List results = new(FloatingPanels.Count); + for (int i = 0; i < FloatingPanels.Count; i++) + { + var win = FloatingPanels[i]; + if (win.Visible && win != excluded) + { + var result = win.HitTest(ref position); + if (result != null) + results.Add(result); + } + } + + // Base + //if (!Root?.RootWindow.Window.IsFocused ?? false) + // return null; + var baseResult = base.HitTest(ref position); + if (baseResult != null) + results.Add(baseResult); + + hitResults = results.ToArray(); + return hitResults.Length > 0; + } + internal void LinkWindow(DockWindow window) { // Add to the windows list diff --git a/Source/Editor/GUI/Docking/WindowDragHelper.cs b/Source/Editor/GUI/Docking/WindowDragHelper.cs new file mode 100644 index 000000000..06cbd06cd --- /dev/null +++ b/Source/Editor/GUI/Docking/WindowDragHelper.cs @@ -0,0 +1,448 @@ +// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved. + +using System; +using FlaxEngine; +using FlaxEngine.GUI; + +namespace FlaxEditor.GUI.Docking +{ + /// + /// Helper class used to handle docking windows dragging and docking. + /// + public class WindowDragHelper + { + private FloatWindowDockPanel _toMove; + + private Float2 _dragOffset; + private Rectangle _rectDock; + private Float2 _mouse; + private DockState _toSet; + private DockPanel _toDock; + private Window _dragSourceWindow; + + private Rectangle _rLeft, _rRight, _rBottom, _rUpper, _rCenter; + private Control _dockHintDown, _dockHintUp, _dockHintLeft, _dockHintRight, _dockHintCenter; + + /// + /// The hint control size. + /// + public const float HintControlSize = 32.0f; + + /// + /// The opacity of the dragged window when hint controls are shown. + /// + public const float DragWindowOpacity = 0.4f; + + private WindowDragHelper(FloatWindowDockPanel toMove, Window dragSourceWindow) + { + _toMove = toMove; + _toSet = DockState.Float; + var window = toMove.Window.Window; + + // Check if window is maximized and restore window. + if (window.IsMaximized) + { + // Restore window and set position to mouse. + var mousePos = window.MousePosition; + var previousSize = window.Size; + window.Restore(); + window.Position = Platform.MousePosition - mousePos * window.Size / previousSize; + } + + // Bind events + FlaxEngine.Scripting.Update += OnUpdate; + window.MouseUp += OnMouseUp; + + // Update rectangles + UpdateRects(Platform.MousePosition); + + _dragSourceWindow = dragSourceWindow; + if (_dragSourceWindow != null) // Detaching a tab from existing window + { + _dragOffset = new Float2(window.Size.X / 2, 10.0f); + + // TODO: when detaching tab in floating window (not main window), the drag source window is still main window? + var dragSourceWindowWayland = toMove.MasterPanel?.RootWindow.Window ?? Editor.Instance.Windows.MainWindow; + window.DoDragDrop(window.Title, _dragOffset, dragSourceWindowWayland); + + _dragSourceWindow.MouseUp += OnMouseUp; // The mouse up event is sent to the source window on Windows + } + else + { + _dragOffset = window.MousePosition; + window.DoDragDrop(window.Title, _dragOffset, window); + } + + // Ensure the dragged window stays on top of every other window + window.IsAlwaysOnTop = true; + } + + /// + /// Releases unmanaged and - optionally - managed resources. + /// + public void Dispose() + { + var window = _toMove?.Window?.Window; + + // Unbind events + FlaxEngine.Scripting.Update -= OnUpdate; + if (window != null) + window.MouseUp -= OnMouseUp; + if (_dragSourceWindow != null) + _dragSourceWindow.MouseUp -= OnMouseUp; + + RemoveDockHints(); + + if (_toMove == null) + return; + + if (window != null) + { + window.Opacity = 1.0f; + window.IsAlwaysOnTop = false; + window.BringToFront(); + } + + // Check if window won't be docked + if (_toSet == DockState.Float) + { + if (window == null) + return; + + // Show base window + window.Show(); + } + else + { + bool hasNoChildPanels = _toMove.ChildPanelsCount == 0; + + // Check if window has only single tab + if (hasNoChildPanels && _toMove.TabsCount == 1) + { + // Dock window + _toMove.GetTab(0).Show(_toSet, _toDock); + } + // Check if dock as tab and has no child panels + else if (hasNoChildPanels && _toSet == DockState.DockFill) + { + // Dock all tabs + while (_toMove.TabsCount > 0) + { + _toMove.GetTab(0).Show(DockState.DockFill, _toDock); + } + } + else + { + var selectedTab = _toMove.SelectedTab; + + // Dock the first tab into the target location + if (_toMove.TabsCount > 0) + { + var firstTab = _toMove.GetTab(0); + firstTab.Show(_toSet, _toDock); + + // Dock rest of the tabs + while (_toMove.TabsCount > 0) + { + _toMove.GetTab(0).Show(DockState.DockFill, firstTab); + } + } + + // Keep selected tab being selected + selectedTab?.SelectTab(); + } + + // Focus target window + _toDock.Root.Focus(); + } + + _toMove = null; + } + + /// + /// Start dragging a floating dock panel. + /// + /// Floating dock panel to move. + /// The window drag helper object. + public static WindowDragHelper StartDragging(FloatWindowDockPanel toMove) + { + if (toMove == null) + throw new ArgumentNullException(); + + return new WindowDragHelper(toMove, null); + } + + /// + /// Start dragging a docked panel into a floating window. + /// + /// Dock window to move. + /// The window where dragging started from. + /// The window drag helper object. + public static WindowDragHelper StartDragging(DockWindow toMove, Window dragSourceWindow) + { + if (toMove == null) + throw new ArgumentNullException(); + + // Create floating window + toMove.CreateFloating(); + + // Get floating panel + var window = (WindowRootControl)toMove.Root; + var floatingPanelToMove = window.GetChild(0) as FloatWindowDockPanel; + + return new WindowDragHelper(floatingPanelToMove, dragSourceWindow); + } + + private void AddDockHints() + { + if (_toDock == null) + return; + + if (_toDock.RootWindow.Window != _dragSourceWindow) + _toDock.RootWindow.Window.MouseUp += OnMouseUp; + + _dockHintDown = AddHintControl(new Float2(0.5f, 1)); + _dockHintUp = AddHintControl(new Float2(0.5f, 0)); + _dockHintLeft = AddHintControl(new Float2(0, 0.5f)); + _dockHintRight = AddHintControl(new Float2(1, 0.5f)); + _dockHintCenter = AddHintControl(new Float2(0.5f, 0.5f)); + + Control AddHintControl(Float2 pivot) + { + Control hintControl = _toDock.AddChild(); + hintControl.AnchorPreset = AnchorPresets.StretchAll; + hintControl.Offsets = Margin.Zero; + hintControl.Size = new Float2(HintControlSize); + hintControl.BackgroundColor = Style.Current.DragWindow.AlphaMultiplied(0.6f); + hintControl.Pivot = pivot; + hintControl.PivotRelative = true; + return hintControl; + } + } + + private void RemoveDockHints() + { + if (_toDock == null) + return; + + if (_toDock.RootWindow.Window != _dragSourceWindow) + _toDock.RootWindow.Window.MouseUp -= OnMouseUp; + + _dockHintDown?.Parent.RemoveChild(_dockHintDown); + _dockHintUp?.Parent.RemoveChild(_dockHintUp); + _dockHintLeft?.Parent.RemoveChild(_dockHintLeft); + _dockHintRight?.Parent.RemoveChild(_dockHintRight); + _dockHintCenter?.Parent.RemoveChild(_dockHintCenter); + _dockHintDown = _dockHintUp = _dockHintLeft = _dockHintRight = _dockHintCenter = null; + } + + private void UpdateRects(Float2 mousePos) + { + // Cache mouse position + _mouse = mousePos; + + // Check intersection with any dock panel + DockPanel dockPanel = null; + if (_toMove.MasterPanel.HitTest(ref _mouse, _toMove, out var hitResults)) + { + dockPanel = hitResults[0]; + + // Prefer panel which currently has focus + foreach (var hit in hitResults) + { + if (hit.RootWindow.Window.IsFocused) + { + dockPanel = hit; + break; + } + } + + // Prefer panel in the same window we hit earlier + if (dockPanel?.RootWindow != _toDock?.RootWindow) + { + foreach (var hit in hitResults) + { + if (hit.RootWindow == _toDock?.RootWindow) + { + dockPanel = _toDock; + break; + } + } + } + } + + if (dockPanel != _toDock) + { + RemoveDockHints(); + _toDock = dockPanel; + AddDockHints(); + + // Make sure the all the dock hint areas are not under other windows + _toDock?.RootWindow.Window.BringToFront(); + //_toDock?.RootWindow.Window.Focus(); + + // Make the dragged window transparent when dock hints are visible + _toMove.Window.Window.Opacity = _toDock == null ? 1.0f : DragWindowOpacity; + } + + // Check dock state to use + bool showProxyHints = _toDock != null; + bool showBorderHints = showProxyHints; + bool showCenterHint = showProxyHints; + Control hoveredHintControl = null; + Float2 hoveredSizeOverride = Float2.Zero; + if (showProxyHints) + { + // If moved window has not only tabs but also child panels disable docking as tab + if (_toMove.ChildPanelsCount > 0) + showCenterHint = false; + + // Disable docking windows with one or more dock panels inside + if (_toMove.ChildPanelsCount > 0) + showBorderHints = false; + + // Get dock area + _rectDock = _toDock.DockAreaBounds; + + // Cache dock rectangles + var size = _rectDock.Size / Platform.DpiScale; + var offset = _toDock.PointFromScreen(_rectDock.Location); + var borderMargin = 4.0f; + var hintWindowsSize = HintControlSize; + var hintWindowsSize2 = hintWindowsSize * 0.5f; + var hintPreviewSize = new Float2(Math.Max(HintControlSize * 2, size.X * 0.5f), Math.Max(HintControlSize * 2, size.Y * 0.5f)); + var centerX = size.X * 0.5f; + var centerY = size.Y * 0.5f; + _rUpper = new Rectangle(centerX - hintWindowsSize2, borderMargin, hintWindowsSize, hintWindowsSize) + offset; + _rBottom = new Rectangle(centerX - hintWindowsSize2, size.Y - hintWindowsSize - borderMargin, hintWindowsSize, hintWindowsSize) + offset; + _rLeft = new Rectangle(borderMargin, centerY - hintWindowsSize2, hintWindowsSize, hintWindowsSize) + offset; + _rRight = new Rectangle(size.X - hintWindowsSize - borderMargin, centerY - hintWindowsSize2, hintWindowsSize, hintWindowsSize) + offset; + _rCenter = new Rectangle(centerX - hintWindowsSize2, centerY - hintWindowsSize2, hintWindowsSize, hintWindowsSize) + offset; + + // Hit test, and calculate the approximation for filled area when hovered over the hint + DockState toSet = DockState.Float; + if (showBorderHints) + { + if (_rUpper.Contains(_toDock.PointFromScreen(_mouse))) + { + toSet = DockState.DockTop; + hoveredHintControl = _dockHintUp; + hoveredSizeOverride = new Float2(size.X, hintPreviewSize.Y); + } + else if (_rBottom.Contains(_toDock.PointFromScreen(_mouse))) + { + toSet = DockState.DockBottom; + hoveredHintControl = _dockHintDown; + hoveredSizeOverride = new Float2(size.X, hintPreviewSize.Y); + } + else if (_rLeft.Contains(_toDock.PointFromScreen(_mouse))) + { + toSet = DockState.DockLeft; + hoveredHintControl = _dockHintLeft; + hoveredSizeOverride = new Float2(hintPreviewSize.X, size.Y); + } + else if (_rRight.Contains(_toDock.PointFromScreen(_mouse))) + { + toSet = DockState.DockRight; + hoveredHintControl = _dockHintRight; + hoveredSizeOverride = new Float2(hintPreviewSize.X, size.Y); + } + } + if (showCenterHint && _rCenter.Contains(_toDock.PointFromScreen(_mouse))) + { + toSet = DockState.DockFill; + hoveredHintControl = _dockHintCenter; + hoveredSizeOverride = new Float2(size.X, size.Y); + } + + _toSet = toSet; + } + else + { + _toSet = DockState.Float; + } + + // Update sizes and opacity of hint controls + if (_toDock != null) + { + if (hoveredHintControl != _dockHintDown) + { + _dockHintDown.Size = new Float2(HintControlSize); + _dockHintDown.BackgroundColor = Style.Current.DragWindow.AlphaMultiplied(0.6f); + } + if (hoveredHintControl != _dockHintLeft) + { + _dockHintLeft.Size = new Float2(HintControlSize); + _dockHintLeft.BackgroundColor = Style.Current.DragWindow.AlphaMultiplied(0.6f); + } + if (hoveredHintControl != _dockHintRight) + { + _dockHintRight.Size = new Float2(HintControlSize); + _dockHintRight.BackgroundColor = Style.Current.DragWindow.AlphaMultiplied(0.6f); + } + if (hoveredHintControl != _dockHintUp) + { + _dockHintUp.Size = new Float2(HintControlSize); + _dockHintUp.BackgroundColor = Style.Current.DragWindow.AlphaMultiplied(0.6f); + } + if (hoveredHintControl != _dockHintCenter) + { + _dockHintCenter.Size = new Float2(HintControlSize); + _dockHintCenter.BackgroundColor = Style.Current.DragWindow.AlphaMultiplied(0.6f); + } + + if (_toSet != DockState.Float) + { + if (hoveredHintControl != null) + { + hoveredHintControl.BackgroundColor = Style.Current.DragWindow.AlphaMultiplied(1.0f); + hoveredHintControl.Size = hoveredSizeOverride; + } + } + } + + // Update hint controls visibility and location + if (showProxyHints) + { + if (hoveredHintControl != _dockHintDown) + _dockHintDown.Location = _rBottom.Location; + if (hoveredHintControl != _dockHintLeft) + _dockHintLeft.Location = _rLeft.Location; + if (hoveredHintControl != _dockHintRight) + _dockHintRight.Location = _rRight.Location; + if (hoveredHintControl != _dockHintUp) + _dockHintUp.Location = _rUpper.Location; + if (hoveredHintControl != _dockHintCenter) + _dockHintCenter.Location = _rCenter.Location; + + _dockHintDown.Visible = showProxyHints & showBorderHints; + _dockHintLeft.Visible = showProxyHints & showBorderHints; + _dockHintRight.Visible = showProxyHints & showBorderHints; + _dockHintUp.Visible = showProxyHints & showBorderHints; + _dockHintCenter.Visible = showProxyHints & showCenterHint; + } + } + + private void OnMouseUp(ref Float2 location, MouseButton button, ref bool handled) + { + if (button == MouseButton.Left) + Dispose(); + } + + private void OnUpdate() + { + var mousePos = Platform.MousePosition; + + if (_mouse != mousePos) + OnMouseMove(mousePos); + } + + private void OnMouseMove(Float2 mousePos) + { + if (_dragSourceWindow != null) + _toMove.Window.Window.Position = mousePos - _dragOffset; + + UpdateRects(mousePos); + } + } +} diff --git a/Source/Editor/Modules/UIModule.cs b/Source/Editor/Modules/UIModule.cs index 6d4ed276c..a16dedef5 100644 --- a/Source/Editor/Modules/UIModule.cs +++ b/Source/Editor/Modules/UIModule.cs @@ -16,7 +16,7 @@ using FlaxEditor.Windows; using FlaxEngine; using FlaxEngine.GUI; using FlaxEngine.Json; -using DockHintWindow = FlaxEditor.GUI.Docking.DockHintWindow; +using WindowDragHelper = FlaxEditor.GUI.Docking.WindowDragHelper; using MasterDockPanel = FlaxEditor.GUI.Docking.MasterDockPanel; using FlaxEditor.Content.Settings; using FlaxEditor.Options; @@ -456,13 +456,6 @@ namespace FlaxEditor.Modules UpdateToolstrip(); } - /// - public override void OnExit() - { - // Cleanup dock panel hint proxy windows (Flax will destroy them by var but it's better to clear them earlier) - DockHintWindow.Proxy.Dispose(); - } - private IColorPickerDialog ShowPickColorDialog(Control targetControl, Color initialValue, ColorValueBox.ColorPickerEvent colorChanged, ColorValueBox.ColorPickerClosedEvent pickerClosed, bool useDynamicEditing) { var dialog = new ColorPickerDialog(initialValue, colorChanged, pickerClosed, useDynamicEditing); diff --git a/Source/Engine/Engine/Time.h b/Source/Engine/Engine/Time.h index ff81fb93e..a67f7c2c4 100644 --- a/Source/Engine/Engine/Time.h +++ b/Source/Engine/Engine/Time.h @@ -16,6 +16,7 @@ API_CLASS(Static) class FLAXENGINE_API Time friend class Engine; friend class TimeService; friend class PhysicsSettings; + friend Window; public: /// diff --git a/Source/Engine/Platform/Base/WindowBase.h b/Source/Engine/Platform/Base/WindowBase.h index cbe166c0e..b35d56ad4 100644 --- a/Source/Engine/Platform/Base/WindowBase.h +++ b/Source/Engine/Platform/Base/WindowBase.h @@ -429,7 +429,7 @@ public: public: /// - /// Starts drag and drop operation + /// Starts a drag and drop operation. /// /// The data. /// The result. @@ -438,6 +438,18 @@ public: return DragDropEffect::None; } + /// + /// Starts a window drag and drop operation. + /// + /// The data. + /// The offset for positioning the window from cursor. + /// The window where dragging started. + /// The result. + API_FUNCTION() virtual DragDropEffect DoDragDrop(const StringView& data, const Float2& offset, Window* dragSourceWindow) + { + return DragDropEffect::None; + } + /// /// Starts the mouse tracking. /// diff --git a/Source/Engine/Platform/Linux/LinuxPlatform.cpp b/Source/Engine/Platform/Linux/LinuxPlatform.cpp index 202f4a851..33de8cf4b 100644 --- a/Source/Engine/Platform/Linux/LinuxPlatform.cpp +++ b/Source/Engine/Platform/Linux/LinuxPlatform.cpp @@ -1396,11 +1396,7 @@ DragDropEffect Window::DoDragDrop(const StringView& data) StringAnsi dataAnsi(data); LinuxDropTextData dropData; dropData.Text = data; -#if !PLATFORM_SDL unsigned long mainWindow = _window; -#else - unsigned long mainWindow = (unsigned long)_handle; -#endif // Begin dragging auto screen = X11::XDefaultScreen(xDisplay); diff --git a/Source/Engine/Platform/SDL/SDLInput.cpp b/Source/Engine/Platform/SDL/SDLInput.cpp index 6f4b445dd..06bb8a6e9 100644 --- a/Source/Engine/Platform/SDL/SDLInput.cpp +++ b/Source/Engine/Platform/SDL/SDLInput.cpp @@ -405,19 +405,24 @@ public: auto windowHandle = static_cast(window)->_window; if (relativeMode) { - oldScreenRect = SDL_GetWindowMouseRect(windowHandle); relativeModeWindow = window; SDL_GetMouseState(&oldPosition.X, &oldPosition.Y); if (!SDL_CursorVisible()) { // Trap the cursor in current location SDL_Rect clipRect = { (int)oldPosition.X, (int)oldPosition.Y, 1, 1 }; + oldScreenRect = SDL_GetWindowMouseRect(windowHandle); SDL_SetWindowMouseRect(windowHandle, &clipRect); } } else { - SDL_SetWindowMouseRect(windowHandle, oldScreenRect); + if (relativeModeWindow != window) + { + // FIXME: When floating game window is focused and editor viewport activated, the relative mode gets stuck + return; + } + SDL_SetWindowMouseRect(windowHandle, nullptr);//oldScreenRect); SDL_WarpMouseInWindow(windowHandle, oldPosition.X, oldPosition.Y); oldScreenRect = nullptr; relativeModeWindow = nullptr; @@ -519,17 +524,6 @@ bool SDLInput::HandleEvent(SDLWindow* window, SDL_Event& event) } return true; } - /*case SDL_EVENT_DROP_POSITION: - { - // We are not receiving mouse motion events during drag-and-drop - auto dpiScale = window->GetDpiScale(); - //const Float2 mousePos(event.drop.x * dpiScale, event.drop.y * dpiScale);// = window->ClientToScreen({ event.drop.x * dpiScale, event.drop.y * dpiScale}); - Float2 mousePos = window->ClientToScreen({ event.drop.x * dpiScale, event.drop.y * dpiScale}); - if (window != Engine::MainWindow) - mousePos = window->GetPosition() - mousePos; - Input::Mouse->OnMouseMove(mousePos, window); - return true; - }*/ case SDL_EVENT_WINDOW_MOUSE_LEAVE: { Input::Mouse->OnMouseLeave(window); diff --git a/Source/Engine/Platform/SDL/SDLPlatform.Linux.cpp b/Source/Engine/Platform/SDL/SDLPlatform.Linux.cpp index caa1f9a94..35095b654 100644 --- a/Source/Engine/Platform/SDL/SDLPlatform.Linux.cpp +++ b/Source/Engine/Platform/SDL/SDLPlatform.Linux.cpp @@ -10,29 +10,367 @@ #include "Engine/Profiler/ProfilerCPU.h" #include "Engine/Core/Log.h" #include "Engine/Core/Collections/Array.h" +#include "Engine/Core/Collections/Dictionary.h" #include "Engine/Engine/CommandLine.h" #include "Engine/Platform/WindowsManager.h" #include "Engine/Platform/Linux/IncludeX11.h" +#include "Engine/Input/Input.h" +#include "Engine/Input/Mouse.h" +#include "Engine/Engine/Time.h" +#include "Engine/Graphics/RenderTask.h" +#include "Engine/Platform/Base/DragDropHelper.h" +#include "Engine/Platform/Unix/UnixFile.h" +#include "Engine/Platform/MessageBox.h" +#include #include #include #include +#include +#include +#include +#include +#include +#include -// Wayland -wl_display* WaylandDisplay = nullptr; +// Missing Wayland features: +// - Application icon (xdg-toplevel-icon-v1) https://github.com/libsdl-org/SDL/pull/9584 +// - Color picker (xdg-desktop-portal?) https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Screenshot.html +// - + +class LinuxDropFilesData : public IGuiData +{ +public: + Array Files; + SDLWindow* Window; + + Type GetType() const override + { + return Type::Files; + } + String GetAsText() const override + { + return String::Empty; + } + void GetAsFiles(Array* files) const override + { + files->Add(Files); + } +}; + +class LinuxDropTextData : public IGuiData +{ +public: + StringView Text; + + Type GetType() const override + { + return Type::Text; + } + String GetAsText() const override + { + return String(Text); + } + void GetAsFiles(Array* files) const override + { + } +}; + +namespace WaylandImpl +{ + wl_display* WaylandDisplay = nullptr; + + uint32 GrabSerial = 0; + wl_pointer_listener PointerListener = + { + [](void* data, wl_pointer* wl_pointer, uint32_t serial, wl_surface* surface, wl_fixed_t surface_x, wl_fixed_t surface_y) { }, // Enter event + [](void* data, wl_pointer* wl_pointer, uint32_t serial, wl_surface* surface) { }, // Leave event + [](void* data, wl_pointer* wl_pointer, uint32_t time, wl_fixed_t surface_x, wl_fixed_t surface_y) { }, // Motion event + [](void* data, wl_pointer* wl_pointer, uint32_t serial, uint32_t time, uint32_t button, uint32_t state) // Button event + { + // Store the serial for upcoming drag-and-drop action + if (state == 1) + GrabSerial = serial; + }, + [](void* data, wl_pointer* wl_pointer, uint32_t time, uint32_t axis, wl_fixed_t value) { }, // Axis event + [](void* data, wl_pointer* wl_pointer) { }, // Frame event + [](void* data, wl_pointer* wl_pointer, uint32_t axis_source) { }, // Axis source event + [](void* data, wl_pointer* wl_pointer, uint32_t time, uint32_t axis) { }, // Axis stop event + [](void* data, wl_pointer* wl_pointer, uint32_t axis, int32_t discrete) { }, // axis discrete + [](void* data, wl_pointer* wl_pointer, uint32_t axis, int32_t value120) { }, // Scroll wheel event + [](void* data, wl_pointer* wl_pointer, uint32_t axis, uint32_t direction) { }, // Relative direction event + }; + + wl_pointer* WaylandPointer = nullptr; + wl_seat_listener SeatListener = + { + [](void* data, wl_seat* seat, uint32 capabilities) // Seat capabilities changed event + { + if ((capabilities & wl_seat_capability::WL_SEAT_CAPABILITY_POINTER) != 0) + { + WaylandPointer = wl_seat_get_pointer(seat); + wl_pointer_add_listener(WaylandPointer, &PointerListener, nullptr); + } + }, + [](void* data, wl_seat* seat, const char* name) { } // Seat name event + }; + + xdg_toplevel_drag_manager_v1* DragManager = nullptr; + wl_seat* Seat = nullptr; + wl_data_device_manager* DataDeviceManager = nullptr; + wl_registry_listener RegistryListener = + { + [](void* data, wl_registry* registry, uint32 id, const char* interface, uint32 version) // Announce global object event + { + StringAnsi interfaceStr(interface); + if (interfaceStr == "xdg_toplevel_drag_manager_v1") + DragManager = static_cast(wl_registry_bind(registry, id, &xdg_toplevel_drag_manager_v1_interface, Math::Min(1U, version))); + else if (interfaceStr == "wl_seat") + { + Seat = static_cast(wl_registry_bind(registry, id, &wl_seat_interface, Math::Min(9U, version))); + wl_seat_add_listener(Seat, &SeatListener, nullptr); + } + else if (interfaceStr == "wl_data_device_manager") + DataDeviceManager = static_cast(wl_registry_bind(registry, id, &wl_data_device_manager_interface, Math::Min(3U, version))); + }, + [] (void* data, wl_registry* registry, uint32 id) { }, // Announce global remove event + }; + + wl_data_offer* DataOffer = nullptr; // The last accepted offer + wl_data_offer* SelectionOffer = nullptr; + wl_data_device_listener DataDeviceListener = + { + [](void* data, wl_data_device* data_device, wl_data_offer* id) { }, // Data offer event + [](void* data, wl_data_device* data_device, uint32 serial, wl_surface* surface, wl_fixed_t x, wl_fixed_t y, wl_data_offer* id) // Enter event + { + DataOffer = id; + + SDLWindow* sourceWindow = (SDLWindow*)data; + if (sourceWindow != nullptr) + { + // Let them know that we support the following action at this given point + wl_data_offer_set_actions(id, WL_DATA_DEVICE_MANAGER_DND_ACTION_MOVE, WL_DATA_DEVICE_MANAGER_DND_ACTION_MOVE); + } + else + { + wl_data_offer_set_actions(id, WL_DATA_DEVICE_MANAGER_DND_ACTION_NONE, WL_DATA_DEVICE_MANAGER_DND_ACTION_NONE); + } + }, + [](void* data, wl_data_device* data_device) // Leave event + { + // The cursor left the surface area + if (DataOffer != nullptr) + wl_data_offer_destroy(DataOffer); + DataOffer = nullptr; + }, + [](void* data, wl_data_device* data_device, uint32_t time, wl_fixed_t x, wl_fixed_t y) { }, // Motion event + [](void* data, wl_data_device* data_device) // Drop event + { + // The drop is accepted + if (DataOffer != nullptr) + { + wl_data_offer_finish(DataOffer); + wl_data_offer_destroy(DataOffer); + DataOffer = nullptr; + } + }, + [](void* data, wl_data_device* data_device, wl_data_offer* id) // Selection event + { + // Clipboard: We can read the clipboard content + if (SelectionOffer != nullptr) + wl_data_offer_destroy(SelectionOffer); + SelectionOffer = id; + }, + }; + + int64 DragOverFlag = 0; + wl_data_source_listener DataSourceListener = + { + [](void* data, wl_data_source* source, const char* mime_type) { }, // Target event + [](void* data, wl_data_source* source, const char* mime_type, int32_t fd) // Send event + { + // Clipboard: The other end has accepted and is requesting the data + IGuiData* inputData = static_cast(data); + if (inputData->GetType() == IGuiData::Type::Text) + { + UnixFile file(fd); + StringAnsi text = StringAnsi(inputData->GetAsText()); + file.Write(text.Get(), text.Length() * sizeof(StringAnsi::CharType)); + file.Close(); + } + }, + [](void* data, wl_data_source* source) // Cancelled event + { + // Clipboard: other application has replaced the content in clipboard + IGuiData* inputData = static_cast(data); + Platform::AtomicStore(&WaylandImpl::DragOverFlag, 1); + + wl_data_source_destroy(source); + }, + [](void* data, wl_data_source* source) { }, // DnD drop performed event + [](void* data, wl_data_source* source) // DnD Finished event + { + // The destination has finally accepted the last given dnd_action + IGuiData* inputData = static_cast(data); + Platform::AtomicStore(&WaylandImpl::DragOverFlag, 1); + + wl_data_source_destroy(source); + }, + [](void* data, wl_data_source* source, uint32_t dnd_action) { }, // Action event + }; + + wl_data_device* DataDevice = nullptr; + wl_event_queue* EventQueue = nullptr; + wl_data_device_manager* WrappedDataDeviceManager = nullptr; + wl_data_device* WrappedDataDevice = nullptr; + bool DraggingActive = false; + bool DraggingWindow = false; + StringView DraggingData = nullptr; + class DragDropJob : public ThreadPoolTask + { + public: + int64 StartFlag = 0; + int64 WaitFlag = 0; + int64 ExitFlag = 0; + SDLWindow* Window = nullptr; + SDLWindow* DragSourceWindow = nullptr; + Float2 DragOffset = Float2::Zero; + + // [ThreadPoolTask] + bool Run() override + { + bool dragWindow = DraggingWindow; + uint32 grabSerial = GrabSerial; + + if (EventQueue == nullptr) + { + if (WrappedDataDevice != nullptr) + wl_proxy_wrapper_destroy(WrappedDataDevice); + if (WrappedDataDeviceManager != nullptr) + wl_proxy_wrapper_destroy(WrappedDataDeviceManager); + if (DataDevice != nullptr) + wl_data_device_destroy(DataDevice); + + // This seems to throw bogus warnings about wl_data_source still being attached to the queue + if (EventQueue != nullptr) + wl_event_queue_destroy(EventQueue); + EventQueue = wl_display_create_queue(WaylandDisplay); + + WrappedDataDeviceManager = static_cast(wl_proxy_create_wrapper(DataDeviceManager)); + wl_proxy_set_queue(reinterpret_cast(WrappedDataDeviceManager), EventQueue); + + DataDevice = wl_data_device_manager_get_data_device(WrappedDataDeviceManager, Seat); + wl_data_device_add_listener(DataDevice, &DataDeviceListener, nullptr); + wl_display_roundtrip(WaylandDisplay); + wl_data_device_set_user_data(DataDevice, dragWindow ? DragSourceWindow : Window); + + WrappedDataDevice = static_cast(wl_proxy_create_wrapper(DataDevice)); + wl_proxy_set_queue(reinterpret_cast(WrappedDataDevice), EventQueue); + } + + // Offer data for consumption, the data source is destroyed elsewhere + wl_data_source* dataSource = wl_data_device_manager_create_data_source(WrappedDataDeviceManager); + wl_data_source* wrappedDataSource = (wl_data_source*)wl_proxy_create_wrapper(dataSource); + wl_proxy_set_queue(reinterpret_cast(wrappedDataSource), EventQueue); + if (dragWindow) + { + wl_data_source_offer(dataSource, "flaxengine/window"); + wl_data_source_offer(dataSource, "text/plain;charset=utf-8"); // TODO: needs support for custom mime-types in SDL + wl_data_source_set_actions(dataSource, WL_DATA_DEVICE_MANAGER_DND_ACTION_MOVE); + } + else + { + wl_data_source_offer(dataSource, "text/plain"); + wl_data_source_offer(dataSource, "text/plain;charset=utf-8"); + wl_data_source_set_actions(dataSource, WL_DATA_DEVICE_MANAGER_DND_ACTION_MOVE | WL_DATA_DEVICE_MANAGER_DND_ACTION_COPY); + } + LinuxDropTextData textData; + textData.Text = *DraggingData; + wl_data_source_add_listener(dataSource, &DataSourceListener, &textData); + + // Begin dragging operation + auto draggedWindow = Window->GetSDLWindow(); + auto dragStartWindow = DragSourceWindow != nullptr ? DragSourceWindow->GetSDLWindow() : draggedWindow; + wl_surface* originSurface = static_cast(SDL_GetPointerProperty(SDL_GetWindowProperties(dragStartWindow), SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER, nullptr)); + wl_surface* iconSurface = nullptr; + wl_data_device_start_drag(WrappedDataDevice, dataSource, originSurface, iconSurface, grabSerial); + + Platform::AtomicStore(&StartFlag, 1); + + xdg_toplevel_drag_v1* toplevelDrag = nullptr; + xdg_toplevel* wrappedToplevel = nullptr; + + while (Platform::AtomicRead(&ExitFlag) == 0) + { + // Start dispatching events to keep data offers alive + if (wl_display_dispatch_queue(WaylandDisplay, EventQueue) == -1) + LOG(Warning, "wl_display_dispatch_queue failed, errno: {}", errno); + if (wl_display_roundtrip_queue(WaylandDisplay, EventQueue) == -1) + LOG(Warning, "wl_display_roundtrip_queue failed, errno: {}", errno); + + // Wait until window has showed up + if (wrappedToplevel == nullptr && dragWindow && Platform::AtomicRead(&WaitFlag) != 0) + { + auto toplevel = static_cast(SDL_GetPointerProperty(SDL_GetWindowProperties(draggedWindow), SDL_PROP_WINDOW_WAYLAND_XDG_TOPLEVEL_POINTER, nullptr)); + if (toplevel != nullptr) + { + // Attach the window to the ongoing drag operation + wrappedToplevel = static_cast(wl_proxy_create_wrapper(toplevel)); + wl_proxy_set_queue(reinterpret_cast(wrappedToplevel), EventQueue); + toplevelDrag = xdg_toplevel_drag_manager_v1_get_xdg_toplevel_drag(DragManager, dataSource); + + Float2 scaledOffset = DragOffset / Window->GetDpiScale(); + xdg_toplevel_drag_v1_attach(toplevelDrag, wrappedToplevel, static_cast(scaledOffset.X), static_cast(scaledOffset.Y)); + } + } + } + + if (wl_display_roundtrip_queue(WaylandDisplay, EventQueue) == -1) + LOG(Warning, "wl_display_roundtrip_queue failed, errno: {}", errno); + + if (toplevelDrag != nullptr) + { + wl_proxy_wrapper_destroy(wrappedToplevel); + xdg_toplevel_drag_v1_destroy(toplevelDrag); + toplevelDrag = nullptr; + } + + if (wrappedDataSource != nullptr) + wl_proxy_wrapper_destroy(wrappedDataSource); + + if (SelectionOffer != nullptr) + { + wl_data_offer_destroy(SelectionOffer); + SelectionOffer = nullptr; + } + + // We can't release the queue immediately due to some resources being still used for a while + /*if (WaylandQueue != nullptr) + { + wl_event_queue_destroy(WaylandQueue); + WaylandQueue = nullptr; + }*/ + + return false; + } + }; +} // X11 Delegate LinuxPlatform::xEventReceived; -// Missing Wayland features: -// - Application icon (xdg-toplevel-icon-v1) https://github.com/libsdl-org/SDL/pull/9584 -// - Window positioning and position tracking -// - Color picker (xdg-desktop-portal?) https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.Screenshot.html -// - - -namespace +namespace X11Impl { + Window* DraggedWindow = nullptr; + + struct Property + { + unsigned char* data; + int format, nitems; + X11::Atom type; + }; + X11::Display* xDisplay = nullptr; X11::XIM IM = nullptr; X11::XIC IC = nullptr; @@ -67,54 +405,7 @@ namespace Float2 xDndPos; int32 xDnDVersion = 0; int32 XFixesSelectionNotifyEvent = 0; -} - -class LinuxDropFilesData : public IGuiData -{ -public: - Array Files; - - Type GetType() const override - { - return Type::Files; - } - String GetAsText() const override - { - return String::Empty; - } - void GetAsFiles(Array* files) const override - { - files->Add(Files); - } -}; - -class LinuxDropTextData : public IGuiData -{ -public: - StringView Text; - - Type GetType() const override - { - return Type::Text; - } - String GetAsText() const override - { - return String(Text); - } - void GetAsFiles(Array* files) const override - { - } -}; - -struct Property -{ - unsigned char* data; - int format, nitems; - X11::Atom type; -}; - -namespace Impl -{ + StringAnsi ClipboardText; void ClipboardGetText(String& result, X11::Atom source, X11::Atom atom, X11::Window window) @@ -254,15 +545,56 @@ DragDropEffect Window::DoDragDrop(const StringView& data) return DoDragDropX11(data); } -DragDropEffect Window::DoDragDropWayland(const StringView& data) +DragDropEffect Window::DoDragDropWayland(const StringView& data, Window* dragSourceWindow, Float2 dragOffset) { - // TODO: Wayland - LOG(Warning, "Wayland Drag and drop is not implemented yet."); + // For drag-and-drop, we need to run another event queue in a separate thread to avoid racing issues + // while SDL is dispatching the main Wayland event queue when receiving the data offer from us. + + Engine::OnDraw(); + + WaylandImpl::DraggingActive = true; + WaylandImpl::DraggingData = StringView(data.Get(), data.Length()); + WaylandImpl::DragOverFlag = 0; + + auto task = New(); + task->Window = this; + task->DragSourceWindow = dragSourceWindow; // Needs to be the parent window when dragging a tab to window + task->DragOffset = dragOffset; + Task::StartNew(task); + while (task->GetState() == TaskState::Queued) + Platform::Sleep(1); + + while (Platform::AtomicRead(&task->StartFlag) == 0) + Platform::Sleep(1); + + while (Platform::AtomicRead(&WaylandImpl::DragOverFlag) == 0) + { + SDLPlatform::Tick(); + Engine::OnUpdate();//Scripting::Update(); // For docking updates + Engine::OnDraw(); + + // The window needs to be finished showing up before we can start dragging it + if (IsVisible() && Platform::AtomicRead(&task->WaitFlag) == 0) + Platform::AtomicStore(&task->WaitFlag, 1); + + Platform::Sleep(1); + } + + // The mouse up event was ignored earlier, release the button now + Input::Mouse->OnMouseUp(Platform::GetMousePosition(), MouseButton::Left, this); + + Platform::AtomicStore(&task->ExitFlag, 1); + task->Wait(); + + WaylandImpl::DraggingActive = false; + WaylandImpl::DraggingData = nullptr; + return DragDropEffect::None; } DragDropEffect Window::DoDragDropX11(const StringView& data) { + using namespace X11Impl; auto cursorWrong = X11::XCreateFontCursor(xDisplay, 54); auto cursorTransient = X11::XCreateFontCursor(xDisplay, 24); auto cursorGood = X11::XCreateFontCursor(xDisplay, 4); @@ -281,6 +613,7 @@ DragDropEffect Window::DoDragDropX11(const StringView& data) // Make sure SDL hasn't grabbed the pointer, and force ungrab it XUngrabPointer(xDisplay, CurrentTime); + auto hintAutoCapture = SDL_GetHint(SDL_HINT_MOUSE_AUTO_CAPTURE); SDL_SetHint(SDL_HINT_MOUSE_AUTO_CAPTURE, "0"); // Begin dragging @@ -289,7 +622,7 @@ DragDropEffect Window::DoDragDropX11(const StringView& data) if (X11::XGrabPointer(xDisplay, mainWindow, 1, Button1MotionMask | ButtonReleaseMask, GrabModeAsync, GrabModeAsync, rootWindow, cursorWrong, CurrentTime) != GrabSuccess) { - SDL_SetHint(SDL_HINT_MOUSE_AUTO_CAPTURE, "1"); + SDL_SetHint(SDL_HINT_MOUSE_AUTO_CAPTURE, hintAutoCapture); return DragDropEffect::None; } X11::XSetSelectionOwner(xDisplay, xAtomXdndSelection, mainWindow, CurrentTime); @@ -349,7 +682,7 @@ DragDropEffect Window::DoDragDropX11(const StringView& data) else if (event.type == MotionNotify) { // Find window under mouse - auto window = Impl::FindAppWindow(xDisplay, rootWindow); + auto window = X11Impl::FindAppWindow(xDisplay, rootWindow); int fmt, version = -1; X11::Atom atmp; unsigned long nitems, bytesLeft; @@ -416,7 +749,7 @@ DragDropEffect Window::DoDragDropX11(const StringView& data) auto ww = WindowsManager::GetByNativePtr((void*)window); if (ww) { - xDndPos = ww->ScreenToClient(Impl::GetX11MousePosition()); + xDndPos = ww->ScreenToClient(X11Impl::GetX11MousePosition()); xDndResult = DragDropEffect::None; ww->OnDragEnter(&dropData, xDndPos, xDndResult); } @@ -445,7 +778,7 @@ DragDropEffect Window::DoDragDropX11(const StringView& data) auto ww = WindowsManager::GetByNativePtr((void*)window); if (ww) { - xDndPos = ww->ScreenToClient(Impl::GetX11MousePosition()); + xDndPos = ww->ScreenToClient(X11Impl::GetX11MousePosition()); ww->_dragOver = true; xDndResult = DragDropEffect::None; ww->OnDragOver(&dropData, xDndPos, xDndResult); @@ -492,7 +825,7 @@ DragDropEffect Window::DoDragDropX11(const StringView& data) auto ww = WindowsManager::GetByNativePtr((void*)previousWindow); if (ww) { - xDndPos = ww->ScreenToClient(Impl::GetX11MousePosition()); + xDndPos = ww->ScreenToClient(X11Impl::GetX11MousePosition()); xDndResult = DragDropEffect::None; ww->OnDragDrop(&dropData, xDndPos, xDndResult); ww->Focus(); @@ -571,11 +904,130 @@ DragDropEffect Window::DoDragDropX11(const StringView& data) XUngrabPointer(xDisplay, CurrentTime); X11::XFlush(xDisplay); - SDL_SetHint(SDL_HINT_MOUSE_AUTO_CAPTURE, "1"); + SDL_SetHint(SDL_HINT_MOUSE_AUTO_CAPTURE, hintAutoCapture); return result; } +void SDLPlatform::PreHandleEvents() +{ +} + +void SDLPlatform::PostHandleEvents() +{ + // Handle window dragging release here + if (X11Impl::DraggedWindow != nullptr) + { + Float2 mousePosition; + auto buttons = SDL_GetGlobalMouseState(&mousePosition.X, &mousePosition.Y); + bool buttonReleased = (buttons & SDL_BUTTON_MASK(SDL_BUTTON_LEFT)) == 0; + if (buttonReleased) + { + // Send simulated mouse up event + SDL_Event buttonUpEvent { 0 }; + buttonUpEvent.motion.type = SDL_EVENT_MOUSE_BUTTON_UP; + buttonUpEvent.button.down = false; + buttonUpEvent.motion.windowID = SDL_GetWindowID(X11Impl::DraggedWindow->GetSDLWindow()); + buttonUpEvent.motion.timestamp = SDL_GetTicksNS(); + buttonUpEvent.motion.state = SDL_BUTTON_LEFT; + buttonUpEvent.button.clicks = 1; + buttonUpEvent.motion.x = mousePosition.X; + buttonUpEvent.motion.y = mousePosition.Y; + X11Impl::DraggedWindow->HandleEvent(buttonUpEvent); + X11Impl::DraggedWindow = nullptr; + } + } +} + +bool SDLWindow::HandleEventInternal(SDL_Event& event) +{ + switch (event.type) + { + case SDL_EVENT_WINDOW_MOVED: + { + if (SDLPlatform::UsesX11()) + { + // X11 doesn't report any mouse events when mouse is over the caption area, send a simulated event instead... + Float2 mousePosition; + auto buttons = SDL_GetGlobalMouseState(&mousePosition.X, &mousePosition.Y); + if ((buttons & SDL_BUTTON_MASK(SDL_BUTTON_LEFT)) != 0 && X11Impl::DraggedWindow == nullptr) + { + // TODO: verify mouse position, window focus + bool result = false; + OnLeftButtonHit(WindowHitCodes::Caption, result); + if (result) + X11Impl::DraggedWindow = this; + } + } + break; + } + case SDL_EVENT_MOUSE_BUTTON_UP: + case SDL_EVENT_MOUSE_MOTION: + { + if (SDLPlatform::UsesWayland() && WaylandImpl::DraggingActive) + { + // Ignore mouse events in dragged window + return true; + } + break; + } + case SDL_EVENT_WINDOW_MOUSE_LEAVE: + { + OnDragLeave(); // Check for release of mouse button too? + break; + } + case SDL_EVENT_DROP_BEGIN: + case SDL_EVENT_DROP_POSITION: + case SDL_EVENT_DROP_FILE: + case SDL_EVENT_DROP_TEXT: + case SDL_EVENT_DROP_COMPLETE: + { + if (SDLPlatform::UsesWayland()) + { + // HACK: We can't use Wayland listeners due to SDL also using them at the same time causes + // some of the events to drop and make it impossible to implement dragging on application side. + // We can get enough information through SDL_EVENT_DROP_* events to fill in the blanks for the + // drag and drop implementation. + + auto dpiScale = GetDpiScale(); + const Float2 mousePos = Float2(event.drop.x * dpiScale, event.drop.y * dpiScale); + DragDropEffect effect = DragDropEffect::None; + String text(event.drop.data); + + LinuxDropTextData dropData; + dropData.Text = text; + + if (event.type == SDL_EVENT_DROP_BEGIN || event.type == SDL_EVENT_DROP_POSITION) + { + // We don't have the drag data during these events... + dropData.Text = WaylandImpl::DraggingData; + } + + if (event.type == SDL_EVENT_DROP_BEGIN) + { + OnDragEnter(&dropData, mousePos, effect); + } + else if (event.type == SDL_EVENT_DROP_POSITION) + { + Input::Mouse->OnMouseMove(ClientToScreen(mousePos), this); + OnDragOver(&dropData, mousePos, effect); + } + else if (event.type == SDL_EVENT_DROP_FILE) + OnDragDrop(&dropData, mousePos, effect); + else if (event.type == SDL_EVENT_DROP_TEXT) + OnDragDrop(&dropData, mousePos, effect); + else if (event.type == SDL_EVENT_DROP_COMPLETE) + OnDragLeave(); + } + break; + } + default: + break; + } + + return false; +} + void SDLClipboard::Clear() { SetText(StringView::Empty); @@ -589,14 +1041,14 @@ void SDLClipboard::SetText(const StringView& text) if (!mainWindow) return; - if (xDisplay) + if (X11Impl::xDisplay) { X11::Window window = (X11::Window)(mainWindow->GetX11WindowHandle()); - Impl::ClipboardText.Set(text.Get(), text.Length()); - X11::XSetSelectionOwner(xDisplay, xAtomClipboard, window, CurrentTime); // CLIPBOARD + X11Impl::ClipboardText.Set(text.Get(), text.Length()); + X11::XSetSelectionOwner(X11Impl::xDisplay, X11Impl::xAtomClipboard, window, CurrentTime); // CLIPBOARD //X11::XSetSelectionOwner(xDisplay, xAtomPrimary, window, CurrentTime); // XA_PRIMARY - X11::XFlush(xDisplay); - X11::XGetSelectionOwner(xDisplay, xAtomClipboard); + X11::XFlush(X11Impl::xDisplay); + X11::XGetSelectionOwner(X11Impl::xDisplay, X11Impl::xAtomClipboard); //X11::XGetSelectionOwner(xDisplay, xAtomPrimary); } else @@ -621,20 +1073,20 @@ String SDLClipboard::GetText() auto mainWindow = Engine::MainWindow; if (!mainWindow) return result; - if (xDisplay) + if (X11Impl::xDisplay) { - X11::Window window = (X11::Window)mainWindow->GetX11WindowHandle(); + X11::Window window = static_cast(mainWindow->GetX11WindowHandle()); - Impl::ClipboardGetText(result, xAtomClipboard, xAtomUTF8String, window); + X11Impl::ClipboardGetText(result, X11Impl::xAtomClipboard, X11Impl::xAtomUTF8String, window); if (result.HasChars()) return result; - Impl::ClipboardGetText(result, xAtomClipboard, xAtomString, window); + X11Impl::ClipboardGetText(result, X11Impl::xAtomClipboard, X11Impl::xAtomString, window); if (result.HasChars()) return result; - Impl::ClipboardGetText(result, xAtomPrimary, xAtomUTF8String, window); + X11Impl::ClipboardGetText(result, X11Impl::xAtomPrimary, X11Impl::xAtomUTF8String, window); if (result.HasChars()) return result; - Impl::ClipboardGetText(result, xAtomPrimary, xAtomString, window); + X11Impl::ClipboardGetText(result, X11Impl::xAtomPrimary, X11Impl::xAtomString, window); return result; } else @@ -654,8 +1106,9 @@ Array SDLClipboard::GetFiles() return Array(); } -bool SDLCALL SDLPlatform::X11EventHook(void *userdata, _XEvent *xevent) +bool SDLCALL SDLPlatform::X11EventHook(void* userdata, _XEvent* xevent) { + using namespace X11Impl; const X11::XEvent& event = *(X11::XEvent*)xevent; Window* window; @@ -672,13 +1125,13 @@ bool SDLCALL SDLPlatform::X11EventHook(void *userdata, _XEvent *xevent) const char* targetTypeFiles = "text/uri-list"; if (event.xclient.data.l[1] & 1) { - Property p = Impl::ReadProperty(xDisplay, source, XInternAtom(xDisplay, "XdndTypeList", 0)); - xDnDRequested = Impl::SelectTargetFromList(xDisplay, targetTypeFiles, (X11::Atom*)p.data, p.nitems); + Property p = X11Impl::ReadProperty(xDisplay, source, XInternAtom(xDisplay, "XdndTypeList", 0)); + xDnDRequested = X11Impl::SelectTargetFromList(xDisplay, targetTypeFiles, (X11::Atom*)p.data, p.nitems); X11::XFree(p.data); } else { - xDnDRequested = Impl::SelectTargetFromAtoms(xDisplay, targetTypeFiles, event.xclient.data.l[2], event.xclient.data.l[3], event.xclient.data.l[4]); + xDnDRequested = X11Impl::SelectTargetFromAtoms(xDisplay, targetTypeFiles, event.xclient.data.l[2], event.xclient.data.l[3], event.xclient.data.l[4]); } return false; } @@ -763,7 +1216,7 @@ bool SDLCALL SDLPlatform::X11EventHook(void *userdata, _XEvent *xevent) window = WindowsManager::GetByNativePtr((void*)event.xany.window); if (window) { - Property p = Impl::ReadProperty(xDisplay, event.xany.window, xAtomPrimary); + Property p = X11Impl::ReadProperty(xDisplay, event.xany.window, xAtomPrimary); if (xDndResult != DragDropEffect::None) { LinuxDropFilesData dropData; @@ -818,9 +1271,9 @@ bool SDLCALL SDLPlatform::X11EventHook(void *userdata, _XEvent *xevent) result = X11::XChangeProperty(xDisplay, ev.requestor, ev.property, xAtomAtom, 32, PropModeReplace, (unsigned char*)types.Get(), types.Count()); } else if (ev.target == xAtomString || ev.target == xAtomText) - result = X11::XChangeProperty(xDisplay, ev.requestor, ev.property, xAtomString, 8, PropModeReplace, (unsigned char*)Impl::ClipboardText.Get(), Impl::ClipboardText.Length()); + result = X11::XChangeProperty(xDisplay, ev.requestor, ev.property, xAtomString, 8, PropModeReplace, (unsigned char*)X11Impl::ClipboardText.Get(), X11Impl::ClipboardText.Length()); else if (ev.target == xAtomUTF8String) - result = X11::XChangeProperty(xDisplay, ev.requestor, ev.property, xAtomUTF8String, 8, PropModeReplace, (unsigned char*)Impl::ClipboardText.Get(), Impl::ClipboardText.Length()); + result = X11::XChangeProperty(xDisplay, ev.requestor, ev.property, xAtomUTF8String, 8, PropModeReplace, (unsigned char*)X11Impl::ClipboardText.Get(), X11Impl::ClipboardText.Length()); else ev.property = 0; if ((result & 2) == 0) @@ -844,17 +1297,33 @@ int X11ErrorHandler(X11::Display* display, X11::XErrorEvent* event) return 0; } -bool SDLPlatform::InitPlatform() +bool SDLPlatform::InitInternal() { - if (LinuxPlatform::Init()) - return true; + bool waylandRequested = (!CommandLine::Options.X11 || CommandLine::Options.Wayland) && StringAnsi(SDL_GetHint(SDL_HINT_VIDEO_DRIVER)) == "wayland"; + if (!CommandLine::Options.Headless && waylandRequested) + { + // Ignore in X11 session + String waylandDisplayEnv; + if (!GetEnvironmentVariable(String("WAYLAND_DISPLAY"), waylandDisplayEnv)) + { + WaylandImpl::WaylandDisplay = (wl_display*)SDL_GetPointerProperty(SDL_GetGlobalProperties(), SDL_PROP_GLOBAL_VIDEO_WAYLAND_WL_DISPLAY_POINTER, nullptr); + if (WaylandImpl::WaylandDisplay != nullptr) + { + // Tap into Wayland registry so we can start listening for events + wl_registry* registry = wl_display_get_registry(WaylandImpl::WaylandDisplay); + wl_registry_add_listener(registry, &WaylandImpl::RegistryListener, nullptr); + wl_display_roundtrip(WaylandImpl::WaylandDisplay); + } + } + } return false; } -bool SDLPlatform::InitPlatformX11(void* display) +bool SDLPlatform::InitX11(void* display) { - if (xDisplay || WaylandDisplay) + using namespace X11Impl; + if (xDisplay || WaylandImpl::WaylandDisplay) return false; // The Display instance must be the same one SDL uses internally @@ -862,7 +1331,7 @@ bool SDLPlatform::InitPlatformX11(void* display) SDL_SetX11EventHook((SDL_X11EventHook)&X11EventHook, nullptr); X11::XSetErrorHandler(X11ErrorHandler); - //xDisplay = X11::XOpenDisplay(nullptr); + xDisplay = X11::XOpenDisplay(nullptr); xAtomDeleteWindow = X11::XInternAtom(xDisplay, "WM_DELETE_WINDOW", 0); xAtomXdndEnter = X11::XInternAtom(xDisplay, "XdndEnter", 0); xAtomXdndPosition = X11::XInternAtom(xDisplay, "XdndPosition", 0); @@ -905,7 +1374,7 @@ bool SDLPlatform::InitPlatformX11(void* display) void* SDLPlatform::GetXDisplay() { - return xDisplay; + return X11Impl::xDisplay; } void SDLPlatform::SetHighDpiAwarenessEnabled(bool enable) @@ -913,14 +1382,220 @@ void SDLPlatform::SetHighDpiAwarenessEnabled(bool enable) base::SetHighDpiAwarenessEnabled(enable); } +bool SDLPlatform::UsesWindows() +{ + return false; +} + bool SDLPlatform::UsesWayland() { - return WaylandDisplay != nullptr; + if (X11Impl::xDisplay == nullptr && WaylandImpl::WaylandDisplay == nullptr) + { + // In case the X11 display pointer has not been updated yet + return strcmp(SDL_GetCurrentVideoDriver(), "wayland") == 0; + } + return WaylandImpl::WaylandDisplay != nullptr; } bool SDLPlatform::UsesX11() { - return xDisplay != nullptr; + if (X11Impl::xDisplay == nullptr && WaylandImpl::WaylandDisplay == nullptr) + { + // In case the X11 display pointer has not been updated yet + return strcmp(SDL_GetCurrentVideoDriver(), "x11") == 0; + } + return X11Impl::xDisplay != nullptr; +} + +DragDropEffect SDLWindow::DoDragDrop(const StringView& data, const Float2& offset, Window* dragSourceWindow) +{ + if (SDLPlatform::UsesWayland()) + { + Float2 dragOffset = offset; + if (_settings.HasBorder && dragSourceWindow == this) + { + // Wayland includes the decorations in the client-space coordinates, adjust the offset for it. + // Assume the title decoration is 25px thick... + float topOffset = 25.0f; + dragOffset += Float2(0.0f, topOffset); + } + + // Show the window without changing focus + if (!_visible) + { + if (_showAfterFirstPaint) + { + if (RenderTask) + RenderTask->Enabled = true; + } + else + SDL_ShowWindow(_window); + } + WindowBase::Show(); + + WaylandImpl::DraggingWindow = true; + DoDragDropWayland(String(""), dragSourceWindow, dragOffset); + WaylandImpl::DraggingWindow = false; + } + else + Show(); + return DragDropEffect::None; +} + +DialogResult MessageBox::Show(Window* parent, const StringView& text, const StringView& caption, MessageBoxButtons buttons, MessageBoxIcon icon) +{ + StringAnsi textAnsi(text); + StringAnsi captionAnsi(caption); + + SDL_MessageBoxData data; + SDL_MessageBoxButtonData dataButtons[3]; + data.window = parent ? static_cast(parent)->_window : nullptr; + data.title = captionAnsi.GetText(); + data.message = textAnsi.GetText(); + data.colorScheme = nullptr; + + switch (icon) + { + case MessageBoxIcon::Error: + case MessageBoxIcon::Hand: + case MessageBoxIcon::Stop: + data.flags |= SDL_MESSAGEBOX_ERROR; + break; + case MessageBoxIcon::Asterisk: + case MessageBoxIcon::Information: + case MessageBoxIcon::Question: + data.flags |= SDL_MESSAGEBOX_INFORMATION; + break; + case MessageBoxIcon::Exclamation: + case MessageBoxIcon::Warning: + data.flags |= SDL_MESSAGEBOX_WARNING; + break; + default: + break; + } + + switch (buttons) + { + case MessageBoxButtons::AbortRetryIgnore: + dataButtons[0] = + { + SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, + (int)DialogResult::Abort, + "Abort" + }; + dataButtons[1] = + { + SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, + (int)DialogResult::Retry, + "Retry" + }; + dataButtons[2] = + { + 0, + (int)DialogResult::Ignore, + "Ignore" + }; + data.numbuttons = 3; + break; + case MessageBoxButtons::OK: + dataButtons[0] = + { + SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT | SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, + (int)DialogResult::OK, + "OK" + }; + data.numbuttons = 1; + break; + case MessageBoxButtons::OKCancel: + dataButtons[0] = + { + SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, + (int)DialogResult::OK, + "OK" + }; + dataButtons[1] = + { + SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, + (int)DialogResult::Cancel, + "Cancel" + }; + data.numbuttons = 2; + break; + case MessageBoxButtons::RetryCancel: + dataButtons[0] = + { + SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, + (int)DialogResult::Retry, + "Retry" + }; + dataButtons[1] = + { + SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, + (int)DialogResult::Cancel, + "Cancel" + }; + data.numbuttons = 2; + break; + case MessageBoxButtons::YesNo: + dataButtons[0] = + { + SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, + (int)DialogResult::Yes, + "Yes" + }; + dataButtons[1] = + { + SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, + (int)DialogResult::No, + "No" + }; + data.numbuttons = 2; + break; + case MessageBoxButtons::YesNoCancel: + { + dataButtons[0] = + { + SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, + (int)DialogResult::Yes, + "Yes" + }; + dataButtons[1] = + { + 0, + (int)DialogResult::No, + "No" + }; + dataButtons[2] = + { + SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, + (int)DialogResult::Cancel, + "Cancel" + }; + data.numbuttons = 3; + break; + } + default: + break; + } + data.buttons = dataButtons; + + int result = -1; + if (!SDL_ShowMessageBox(&data, &result)) + { +#if PLATFORM_LINUX + // Fallback to native messagebox implementation in case some system fonts are missing + if (SDLPlatform::UsesX11()) + { + LOG(Warning, "Failed to show SDL message box: {0}", String(SDL_GetError())); + return ShowFallback(parent, text, caption, buttons, icon); + } +#endif + LOG(Error, "Failed to show SDL message box: {0}", String(SDL_GetError())); + return DialogResult::Abort; + } + if (result < 0) + return DialogResult::None; + return (DialogResult)result; } #endif diff --git a/Source/Engine/Platform/SDL/SDLPlatform.Windows.cpp b/Source/Engine/Platform/SDL/SDLPlatform.Windows.cpp index 496113bb4..ce60d76de 100644 --- a/Source/Engine/Platform/SDL/SDLPlatform.Windows.cpp +++ b/Source/Engine/Platform/SDL/SDLPlatform.Windows.cpp @@ -1,16 +1,36 @@ // Copyright (c) 2012-2024 Wojciech Figat. All rights reserved. - #if PLATFORM_SDL && PLATFORM_WINDOWS +#define BORDERLESS_MAXIMIZE_WORKAROUND 2 + #include "SDLPlatform.h" +#include "SDLInput.h" + #include "Engine/Core/Collections/Array.h" #include "Engine/Platform/WindowsManager.h" #include "Engine/Platform/Win32/IncludeWindowsHeaders.h" +#include "Engine/Input/Mouse.h" +#include "Engine/Core/Log.h" +#include "Engine/Engine/Engine.h" #include #include #include +#include + +#if USE_EDITOR +#include +#endif + +#define STYLE_RESIZABLE (WS_THICKFRAME | WS_MAXIMIZEBOX) + +namespace WinImpl +{ + Window* DraggedWindow; + Float2 DraggedWindowStartPosition = Float2::Zero; + Float2 DraggedWindowMousePosition = Float2::Zero; +} // The events for releasing the mouse during window dragging are missing, handle the mouse release event here bool SDLCALL SDLPlatform::EventMessageHook(void* userdata, MSG* msg) @@ -35,18 +55,59 @@ bool SDLCALL SDLPlatform::EventMessageHook(void* userdata, MSG* msg) { Window* window; GET_WINDOW_WITH_HWND(window, msg->hwnd); - - auto hit = static_cast(msg->wParam); - if (SDLPlatform::CheckWindowDragging(window, hit)) - return false; + WinImpl::DraggedWindow = window; + + WinImpl::DraggedWindowStartPosition = WinImpl::DraggedWindow->GetClientPosition(); + Float2 mousePos(static_cast(static_cast(WINDOWS_GET_X_LPARAM(msg->lParam))), static_cast(static_cast(WINDOWS_GET_Y_LPARAM(msg->lParam)))); + WinImpl::DraggedWindowMousePosition = mousePos; + WinImpl::DraggedWindowMousePosition -= WinImpl::DraggedWindowStartPosition; + + bool result = false; + WindowHitCodes hit = static_cast(msg->wParam); + window->OnHitTest(mousePos, hit, result); + //if (result && hit != WindowHitCodes::Caption) + // return false; + + if (hit == WindowHitCodes::Caption) + { + SDL_Event event{ 0 }; + event.button.type = SDL_EVENT_MOUSE_BUTTON_DOWN; + event.button.down = true; + event.button.timestamp = SDL_GetTicksNS(); + event.button.windowID = SDL_GetWindowID(window->GetSDLWindow()); + event.button.button = SDL_BUTTON_LEFT; + event.button.clicks = 1; + event.button.x = WinImpl::DraggedWindowMousePosition.X; + event.button.y = WinImpl::DraggedWindowMousePosition.Y; + + SDL_PushEvent(&event); + } } + /*else if (msg->message == WM_NCLBUTTONUP || msg->message == WM_CAPTURECHANGED) + { + windowDragging = false; + Window* window; + GET_WINDOW_WITH_HWND(window, msg->hwnd); + + SDL_Event event{ 0 }; + event.button.type = SDL_EVENT_MOUSE_BUTTON_UP; + event.button.down = false; + event.button.timestamp = SDL_GetTicksNS(); + event.button.windowID = SDL_GetWindowID(window->GetSDLWindow()); + event.button.button = SDL_BUTTON_LEFT; + event.button.clicks = 1; + event.button.x = static_cast(static_cast(WINDOWS_GET_X_LPARAM(msg->lParam))); + event.button.y = static_cast(static_cast(WINDOWS_GET_Y_LPARAM(msg->lParam))); + + SDL_PushEvent(&event); + }*/ return true; #undef GET_WINDOW_WITH_HWND } -bool SDLPlatform::InitPlatform() +bool SDLPlatform::InitInternal() { - // Workaround required for handling window dragging events properly for DockHintWindow + // Workaround required for handling window dragging events properly SDL_SetWindowsMessageHook(&EventMessageHook, nullptr); if (WindowsPlatform::Init()) @@ -55,10 +116,177 @@ bool SDLPlatform::InitPlatform() return false; } +bool SDLPlatform::EventFilterCallback(void* userdata, SDL_Event* event) +{ + Window* draggedWindow = *(Window**)userdata; + if (draggedWindow == nullptr) + return true; + + // When the window is being dragged on Windows, the internal message loop is blocking + // the SDL event queue. We need to handle all relevant events in this event watch callback + // to ensure dragging related functionality doesn't break due to engine not getting updated. + // This also happens to fix the engine freezing during the dragging operation. + + SDLWindow* window = SDLWindow::GetWindowFromEvent(*event); + if (event->type == SDL_EVENT_WINDOW_EXPOSED) + { + // The internal timer is sending exposed events every ~16ms + Engine::OnUpdate();//Scripting::Update(); // For docking updates + Engine::OnDraw(); + return false; + } + else if (event->type == SDL_EVENT_MOUSE_BUTTON_DOWN) + { + SDLWindow* window = SDLWindow::GetWindowFromEvent(*event); + if (window) + { + bool result = false; + window->OnLeftButtonHit(WindowHitCodes::Caption, result); + //if (result) + // return false; + window->HandleEvent(*event); + } + + return false; + } + else if (event->type == SDL_EVENT_WINDOW_MOVED) + { + Float2 start = WinImpl::DraggedWindowStartPosition; + Float2 newPos = Float2(static_cast(event->window.data1), static_cast(event->window.data2)); + Float2 offset = newPos - start; + Float2 mousePos = WinImpl::DraggedWindowMousePosition; + + SDL_Event mouseMovedEvent { 0 }; + mouseMovedEvent.motion.type = SDL_EVENT_MOUSE_MOTION; + mouseMovedEvent.motion.windowID = SDL_GetWindowID(WinImpl::DraggedWindow->GetSDLWindow()); + mouseMovedEvent.motion.timestamp = SDL_GetTicksNS(); + mouseMovedEvent.motion.state = SDL_BUTTON_LEFT; + mouseMovedEvent.motion.x = mousePos.X; + mouseMovedEvent.motion.y = mousePos.Y; + if (window) + window->HandleEvent(mouseMovedEvent); + if (window) + window->HandleEvent(*event); + + return false; + } + if (window) + window->HandleEvent(*event); + + return true; +} + +void SDLPlatform::PreHandleEvents() +{ + SDL_AddEventWatch(EventFilterCallback, &WinImpl::DraggedWindow); +} + +void SDLPlatform::PostHandleEvents() +{ + SDL_RemoveEventWatch(EventFilterCallback, &WinImpl::DraggedWindow); + + // Handle window dragging release here + if (WinImpl::DraggedWindow != nullptr) + { + Float2 mousePosition; + auto buttons = SDL_GetGlobalMouseState(&mousePosition.X, &mousePosition.Y); + + // Send simulated mouse up event + SDL_Event buttonUpEvent { 0 }; + buttonUpEvent.motion.type = SDL_EVENT_MOUSE_BUTTON_UP; + buttonUpEvent.button.down = false; + buttonUpEvent.motion.windowID = SDL_GetWindowID(WinImpl::DraggedWindow->GetSDLWindow()); + buttonUpEvent.motion.timestamp = SDL_GetTicksNS(); + buttonUpEvent.motion.state = SDL_BUTTON_LEFT; + buttonUpEvent.button.clicks = 1; + buttonUpEvent.motion.x = mousePosition.X; + buttonUpEvent.motion.y = mousePosition.Y; + WinImpl::DraggedWindow->HandleEvent(buttonUpEvent); + WinImpl::DraggedWindow = nullptr; + } +} + +bool SDLWindow::HandleEventInternal(SDL_Event& event) +{ + switch (event.type) + { + case SDL_EVENT_WINDOW_DESTROYED: + { +#if USE_EDITOR + // Disable file dropping + if (_settings.AllowDragAndDrop) + { + const auto result = RevokeDragDrop((HWND)_handle); + if (result != S_OK) + LOG(Warning, "Window drag and drop service error: 0x{0:x}:{1}", result, 2); + } +#endif + break; + } + case SDL_EVENT_MOUSE_BUTTON_UP: + { + if (WinImpl::DraggedWindow != nullptr && WinImpl::DraggedWindow->_windowId != event.button.windowID) + { + // Send the button event to dragged window as well + Float2 mousePos = ClientToScreen({ event.button.x, event.button.y }); + Float2 clientPos = WinImpl::DraggedWindow->ScreenToClient(mousePos); + + SDL_Event event2 = event; + event2.button.windowID = WinImpl::DraggedWindow->_windowId; + event2.button.x = clientPos.X; + event2.button.y = clientPos.Y; + + SDLInput::HandleEvent(WinImpl::DraggedWindow, event2); + } + break; + } + default: + break; + } + + return false; +} + +bool SDLPlatform::UsesWindows() +{ + return true; +} + +bool SDLPlatform::UsesWayland() +{ + return false; +} + +bool SDLPlatform::UsesX11() +{ + return false; +} + +void SDLWindow::Focus() +{ + auto activateWhenRaised = SDL_GetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED); + SDL_SetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED, "1"); + + // Forcing the window to focus causes issues with opening context menus while window is maximized + //auto forceRaiseWindow = SDL_GetHint(SDL_HINT_FORCE_RAISEWINDOW); + //SDL_SetHint(SDL_HINT_FORCE_RAISEWINDOW, "1"); + + SDL_RaiseWindow(_window); + + SDL_SetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED, activateWhenRaised); + //SDL_SetHint(SDL_HINT_FORCE_RAISEWINDOW, forceRaiseWindow); +} + void SDLPlatform::SetHighDpiAwarenessEnabled(bool enable) { // Other supported values: "permonitor", "permonitorv2" SDL_SetHint("SDL_WINDOWS_DPI_AWARENESS", enable ? "system" : "unaware"); } +DragDropEffect SDLWindow::DoDragDrop(const StringView& data, const Float2& offset, Window* dragSourceWindow) +{ + Show(); + return DragDropEffect::None; +} + #endif diff --git a/Source/Engine/Platform/SDL/SDLPlatform.cpp b/Source/Engine/Platform/SDL/SDLPlatform.cpp index b84e38245..790d6498a 100644 --- a/Source/Engine/Platform/SDL/SDLPlatform.cpp +++ b/Source/Engine/Platform/SDL/SDLPlatform.cpp @@ -10,6 +10,7 @@ #include "Engine/Platform/BatteryInfo.h" #include "Engine/Platform/WindowsManager.h" #include "Engine/Platform/SDL/SDLInput.h" +#include "Engine/Engine/Engine.h" #include #include @@ -22,14 +23,10 @@ #if PLATFORM_LINUX #include "Engine/Engine/CommandLine.h" -#include "Engine/Platform/MessageBox.h" -#include #endif #define DefaultDPI 96 -uint32 SDLPlatform::DraggedWindowId = 0; - namespace { int32 SystemDpi = 96; @@ -44,7 +41,12 @@ bool SDLPlatform::Init() else if (CommandLine::Options.Wayland) SDL_SetHintWithPriority(SDL_HINT_VIDEO_DRIVER, "wayland", SDL_HINT_OVERRIDE); else - SDL_SetHintWithPriority(SDL_HINT_VIDEO_DRIVER, "wayland", SDL_HINT_OVERRIDE); + { + // Override the X11 preference when running in Wayland session + String waylandDisplayEnv; + if (!GetEnvironmentVariable(String("WAYLAND_DISPLAY"), waylandDisplayEnv)) + SDL_SetHintWithPriority(SDL_HINT_VIDEO_DRIVER, "wayland", SDL_HINT_OVERRIDE); + } #endif #if PLATFORM_LINUX @@ -69,21 +71,15 @@ bool SDLPlatform::Init() SDL_SetHint(SDL_HINT_MOUSE_RELATIVE_WARP_MOTION, "0"); SDL_SetHint(SDL_HINT_MOUSE_RELATIVE_CURSOR_VISIBLE, "1"); // Needed for tracking mode SDL_SetHint(SDL_HINT_MOUSE_RELATIVE_MODE_CENTER, "0"); // + SDL_SetHint(SDL_HINT_MOUSE_DOUBLE_CLICK_RADIUS, "8"); // Reduce the default mouse double-click radius //SDL_SetHint(SDL_HINT_MOUSE_RELATIVE_MODE_WARP, "1"); // Disables raw mouse input SDL_SetHint(SDL_HINT_WINDOWS_RAW_KEYBOARD, "1"); SDL_SetHint(SDL_HINT_VIDEO_WAYLAND_SCALE_TO_DISPLAY, "1"); - // Disable SDL clipboard support - SDL_SetEventEnabled(SDL_EVENT_CLIPBOARD_UPDATE, false); - - // Disable SDL drag and drop support - SDL_SetEventEnabled(SDL_EVENT_DROP_FILE, false); - SDL_SetEventEnabled(SDL_EVENT_DROP_TEXT, false); - SDL_SetEventEnabled(SDL_EVENT_DROP_BEGIN, false); - SDL_SetEventEnabled(SDL_EVENT_DROP_COMPLETE, false); - SDL_SetEventEnabled(SDL_EVENT_DROP_POSITION, false); + //if (InitInternal()) + // return true; if (!SDL_InitSubSystem(SDL_INIT_VIDEO | SDL_INIT_GAMEPAD)) Platform::Fatal(String::Format(TEXT("Failed to initialize SDL: {0}."), String(SDL_GetError()))); @@ -104,10 +100,23 @@ bool SDLPlatform::Init() } } SDL_free(locales); - - if (InitPlatform()) + + if (InitInternal()) return true; + if (UsesWindows() || UsesX11()) + { + // Disable SDL clipboard support + SDL_SetEventEnabled(SDL_EVENT_CLIPBOARD_UPDATE, false); + + // Disable SDL drag and drop support + SDL_SetEventEnabled(SDL_EVENT_DROP_FILE, false); + SDL_SetEventEnabled(SDL_EVENT_DROP_TEXT, false); + SDL_SetEventEnabled(SDL_EVENT_DROP_BEGIN, false); + SDL_SetEventEnabled(SDL_EVENT_DROP_COMPLETE, false); + SDL_SetEventEnabled(SDL_EVENT_DROP_POSITION, false); + } + SDLInput::Init(); SystemDpi = (int)(SDL_GetDisplayContentScale(SDL_GetPrimaryDisplay()) * DefaultDPI); @@ -129,74 +138,12 @@ void SDLPlatform::LogInfo() LOG(Info, "SDL video driver: {}", String(SDL_GetCurrentVideoDriver())); } -bool SDLPlatform::CheckWindowDragging(Window* window, WindowHitCodes hit) -{ - bool handled = false; - window->OnLeftButtonHit(hit, handled); - if (handled) - DraggedWindowId = window->_windowId; - return handled; -} - void SDLPlatform::Tick() { SDLInput::Update(); - if (DraggedWindowId != 0) - { - Float2 mousePos; - auto buttons = SDL_GetGlobalMouseState(&mousePos.X, &mousePos.Y); - if (!(buttons & SDL_BUTTON_MASK(SDL_BUTTON_LEFT))) - { - Window* window = nullptr; - WindowsManager::WindowsLocker.Lock(); - for (int32 i = 0; i < WindowsManager::Windows.Count(); i++) - { - if (WindowsManager::Windows[i]->_windowId == DraggedWindowId) - { - window = WindowsManager::Windows[i]; - break; - } - } - WindowsManager::WindowsLocker.Unlock(); - - if (window != nullptr) - { - int top, left, bottom, right; - SDL_GetWindowBordersSize(window->_window, &top, &left, &bottom, &right); - mousePos += Float2(static_cast(left), static_cast(-top)); - Input::Mouse->OnMouseUp(mousePos, MouseButton::Left, window); - } - DraggedWindowId = 0; - } - else - { -#if PLATFORM_LINUX - String dockHintWindow("DockHint.Window"); - Window* window = nullptr; - WindowsManager::WindowsLocker.Lock(); - for (int32 i = 0; i < WindowsManager::Windows.Count(); i++) - { - if (WindowsManager::Windows[i]->_title.Compare(dockHintWindow) == 0) - //if (WindowsManager::Windows[i]->_windowId == DraggedWindowId) - { - window = WindowsManager::Windows[i]; - break; - } - } - WindowsManager::WindowsLocker.Unlock(); - - if (window != nullptr) - { - int top, left, bottom, right; - SDL_GetWindowBordersSize(window->_window, &top, &left, &bottom, &right); - mousePos += Float2(static_cast(left), static_cast(-top)); - Input::Mouse->OnMouseMove(mousePos, window); - } -#endif - } - } - + PreHandleEvents(); + SDL_PumpEvents(); SDL_Event events[32]; int count = SDL_PeepEvents(events, SDL_arraysize(events), SDL_GETEVENT, SDL_EVENT_FIRST, SDL_EVENT_LAST); @@ -208,8 +155,10 @@ void SDLPlatform::Tick() else if (events[i].type >= SDL_EVENT_JOYSTICK_AXIS_MOTION && events[i].type <= SDL_EVENT_GAMEPAD_STEAM_HANDLE_UPDATED) SDLInput::HandleEvent(nullptr, events[i]); else - SDLPlatform::HandleEvent(events[i]); + HandleEvent(events[i]); } + + PostHandleEvents(); } bool SDLPlatform::HandleEvent(SDL_Event& event) @@ -264,7 +213,18 @@ void SDLPlatform::OpenUrl(const StringView& url) Float2 SDLPlatform::GetMousePosition() { Float2 pos; - SDL_GetGlobalMouseState(&pos.X, &pos.Y); + if (UsesWayland()) + { + // Wayland doesn't support reporting global mouse position, + // use the last known reported position we got from received window events. + pos = Input::GetMouseScreenPosition(); + //if (!SDL_GetGlobalMouseState(&pos.X, &pos.Y)) + // LOG(Error, "SDL_GetGlobalMouseState() failed"); + } + else if (UsesX11()) + SDL_GetGlobalMouseState(&pos.X, &pos.Y); + else + pos = Input::GetMouseScreenPosition(); return pos; } @@ -313,176 +273,4 @@ Window* SDLPlatform::CreateWindow(const CreateWindowSettings& settings) return New(settings); } -#if !PLATFORM_LINUX - -bool SDLPlatform::UsesWayland() -{ - return false; -} - -bool SDLPlatform::UsesX11() -{ - return false; -} - -#endif - -#if PLATFORM_LINUX -DialogResult MessageBox::Show(Window* parent, const StringView& text, const StringView& caption, MessageBoxButtons buttons, MessageBoxIcon icon) -{ - StringAnsi textAnsi(text); - StringAnsi captionAnsi(caption); - - SDL_MessageBoxData data; - SDL_MessageBoxButtonData dataButtons[3]; - data.window = parent ? static_cast(parent)->_window : nullptr; - data.title = captionAnsi.GetText(); - data.message = textAnsi.GetText(); - data.colorScheme = nullptr; - - switch (icon) - { - case MessageBoxIcon::Error: - case MessageBoxIcon::Hand: - case MessageBoxIcon::Stop: - data.flags |= SDL_MESSAGEBOX_ERROR; - break; - case MessageBoxIcon::Asterisk: - case MessageBoxIcon::Information: - case MessageBoxIcon::Question: - data.flags |= SDL_MESSAGEBOX_INFORMATION; - break; - case MessageBoxIcon::Exclamation: - case MessageBoxIcon::Warning: - data.flags |= SDL_MESSAGEBOX_WARNING; - break; - default: - break; - } - - switch (buttons) - { - case MessageBoxButtons::AbortRetryIgnore: - dataButtons[0] = - { - SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, - (int)DialogResult::Abort, - "Abort" - }; - dataButtons[1] = - { - SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, - (int)DialogResult::Retry, - "Retry" - }; - dataButtons[2] = - { - 0, - (int)DialogResult::Ignore, - "Ignore" - }; - data.numbuttons = 3; - break; - case MessageBoxButtons::OK: - dataButtons[0] = - { - SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT | SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, - (int)DialogResult::OK, - "OK" - }; - data.numbuttons = 1; - break; - case MessageBoxButtons::OKCancel: - dataButtons[0] = - { - SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, - (int)DialogResult::OK, - "OK" - }; - dataButtons[1] = - { - SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, - (int)DialogResult::Cancel, - "Cancel" - }; - data.numbuttons = 2; - break; - case MessageBoxButtons::RetryCancel: - dataButtons[0] = - { - SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, - (int)DialogResult::Retry, - "Retry" - }; - dataButtons[1] = - { - SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, - (int)DialogResult::Cancel, - "Cancel" - }; - data.numbuttons = 2; - break; - case MessageBoxButtons::YesNo: - dataButtons[0] = - { - SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, - (int)DialogResult::Yes, - "Yes" - }; - dataButtons[1] = - { - SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, - (int)DialogResult::No, - "No" - }; - data.numbuttons = 2; - break; - case MessageBoxButtons::YesNoCancel: - { - dataButtons[0] = - { - SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT, - (int)DialogResult::Yes, - "Yes" - }; - dataButtons[1] = - { - 0, - (int)DialogResult::No, - "No" - }; - dataButtons[2] = - { - SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, - (int)DialogResult::Cancel, - "Cancel" - }; - data.numbuttons = 3; - break; - } - default: - break; - } - data.buttons = dataButtons; - - int result = -1; - if (!SDL_ShowMessageBox(&data, &result)) - { -#if PLATFORM_LINUX - // Fallback to native messagebox implementation in case some system fonts are missing - if (SDLPlatform::UsesX11()) - { - LOG(Warning, "Failed to show SDL message box: {0}", String(SDL_GetError())); - return ShowFallback(parent, text, caption, buttons, icon); - } -#endif - LOG(Error, "Failed to show SDL message box: {0}", String(SDL_GetError())); - return DialogResult::Abort; - } - if (result < 0) - return DialogResult::None; - return (DialogResult)result; -} -#endif - #endif diff --git a/Source/Engine/Platform/SDL/SDLPlatform.h b/Source/Engine/Platform/SDL/SDLPlatform.h index 528ab6f61..8f374e400 100644 --- a/Source/Engine/Platform/SDL/SDLPlatform.h +++ b/Source/Engine/Platform/SDL/SDLPlatform.h @@ -7,21 +7,18 @@ #include "Engine/Platform/Base/Enums.h" #if PLATFORM_WINDOWS #include "Engine/Platform/Windows/WindowsPlatform.h" +typedef struct tagMSG MSG; #elif PLATFORM_LINUX #include "Engine/Platform/Linux/LinuxPlatform.h" +union _XEvent; #else #endif class SDLWindow; union SDL_Event; -#if PLATFORM_WINDOWS -typedef struct tagMSG MSG; -#elif PLATFORM_LINUX -union _XEvent; -#endif /// -/// The Windows platform implementation and application management utilities. +/// The SDL platform implementation and application management utilities. /// class FLAXENGINE_API SDLPlatform #if PLATFORM_WINDOWS @@ -38,25 +35,25 @@ class FLAXENGINE_API SDLPlatform friend SDLWindow; private: - static uint32 DraggedWindowId; - -private: - static bool InitPlatform(); + static bool InitInternal(); #if PLATFORM_LINUX - static bool InitPlatformX11(void* display); + static bool InitX11(void* display); #endif static bool HandleEvent(SDL_Event& event); #if PLATFORM_WINDOWS - static bool __cdecl EventMessageHook(void* userdata, MSG* msg); + static bool EventMessageHook(void* userdata, MSG* msg); + static bool SDLPlatform::EventFilterCallback(void* userdata, SDL_Event* event); #elif PLATFORM_LINUX - static bool __cdecl X11EventHook(void *userdata, _XEvent *xevent); + static bool X11EventHook(void* userdata, _XEvent* xevent); #endif + static void PreHandleEvents(); + static void PostHandleEvents(); public: - static bool CheckWindowDragging(Window* window, WindowHitCodes hit); #if PLATFORM_LINUX static void* GetXDisplay(); #endif + static bool UsesWindows(); static bool UsesWayland(); static bool UsesX11(); diff --git a/Source/Engine/Platform/SDL/SDLWindow.cpp b/Source/Engine/Platform/SDL/SDLWindow.cpp index e9e80157d..84c02c0df 100644 --- a/Source/Engine/Platform/SDL/SDLWindow.cpp +++ b/Source/Engine/Platform/SDL/SDLWindow.cpp @@ -14,7 +14,6 @@ #include "Engine/Input/Input.h" #include "Engine/Input/Keyboard.h" #include "Engine/Input/Mouse.h" -#include "Engine/Platform/IGuiData.h" #include "Engine/Platform/WindowsManager.h" #define NOGDI @@ -26,8 +25,6 @@ #if PLATFORM_WINDOWS #include "Engine/Platform/Win32/IncludeWindowsHeaders.h" -#define STYLE_RESIZABLE (WS_THICKFRAME | WS_MAXIMIZEBOX) -#define BORDERLESS_MAXIMIZE_WORKAROUND 2 #if USE_EDITOR #include #endif @@ -37,57 +34,44 @@ #define DefaultDPI 96 -namespace +namespace WindowImpl { SDLWindow* LastEventWindow = nullptr; static SDL_Cursor* Cursors[SDL_SYSTEM_CURSOR_COUNT] = { nullptr }; -#if BORDERLESS_MAXIMIZE_WORKAROUND == 2 - int SkipMaximizeEventsCount = 0; -#endif } +using namespace WindowImpl; -void* GetNativeWindowPointer(SDL_Window* window); SDL_HitTestResult OnWindowHitTest(SDL_Window* win, const SDL_Point* area, void* data); void GetRelativeWindowOffset(WindowType type, SDLWindow* parentWindow, Int2& positionOffset); Int2 GetSDLWindowScreenPosition(const SDLWindow* window); -void SetSDLWindowScreenPosition(const SDLWindow* window, const int x, const int y); +void SetSDLWindowScreenPosition(const SDLWindow* window, const Int2 position); -class SDLDropFilesData : public IGuiData +bool IsPopupWindow(WindowType type) { -public: - Array Files; + return type == WindowType::Popup || type == WindowType::Tooltip; +} - Type GetType() const override - { - return Type::Files; - } - String GetAsText() const override - { - return String::Empty; - } - void GetAsFiles(Array* files) const override - { - files->Add(Files); - } -}; - -class SDLDropTextData : public IGuiData +void* GetNativeWindowPointer(SDL_Window* window) { -public: - StringView Text; - - Type GetType() const override - { - return Type::Text; - } - String GetAsText() const override - { - return String(Text); - } - void GetAsFiles(Array* files) const override - { - } -}; + void* windowPtr; + auto props = SDL_GetWindowProperties(window); +#if PLATFORM_WINDOWS + windowPtr = SDL_GetPointerProperty(props, SDL_PROP_WINDOW_WIN32_HWND_POINTER, nullptr); +#elif PLATFORM_LINUX + windowPtr = SDL_GetPointerProperty(props, SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER, nullptr); + if (windowPtr == nullptr) + windowPtr = (void*)SDL_GetNumberProperty(props, SDL_PROP_WINDOW_X11_WINDOW_NUMBER, 0); +#elif PLATFORM_MAC + windowPtr = SDL_GetPointerProperty(props, SDL_PROP_WINDOW_COCOA_WINDOW_POINTER, nullptr); +#elif PLATFORM_ANDROID + windowPtr = SDL_GetPointerProperty(props, SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER, nullptr); +#elif PLATFORM_IOS + windowPtr = SDL_GetPointerProperty(props, SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER, nullptr); +#else + static_assert(false, "unsupported platform"); +#endif + return windowPtr; +} SDLWindow::SDLWindow(const CreateWindowSettings& settings) : WindowBase(settings) @@ -130,8 +114,8 @@ SDLWindow::SDLWindow(const CreateWindowSettings& settings) flags |= SDL_WINDOW_TRANSPARENT; // Disable parenting of child windows as those are always on top of the parent window and never show up in taskbar - //if (_settings.Parent != nullptr && (_settings.Type != WindowType::Tooltip && _settings.Type != WindowType::Popup)) - // _settings.Parent = nullptr; + if (_settings.Parent != nullptr && (_settings.Type != WindowType::Tooltip && _settings.Type != WindowType::Popup)) + _settings.Parent = nullptr; // The window position needs to be relative to the parent window Int2 relativePosition(Math::TruncToInt(settings.Position.X), Math::TruncToInt(settings.Position.Y)); @@ -190,10 +174,6 @@ SDLWindow::SDLWindow(const CreateWindowSettings& settings) if (xdndAware != 0) X11::XChangeProperty(xDisplay, (X11::Window)_handle, xdndAware, (X11::Atom)4, 32, PropModeReplace, (unsigned char*)&xdndVersion, 1); } - else - { - // TODO: Wayland - } #endif } #endif @@ -203,32 +183,10 @@ SDLWindow::SDLWindow(const CreateWindowSettings& settings) #if PLATFORM_LINUX // Initialize using the shared Display instance from SDL if (SDLPlatform::UsesX11() && SDLPlatform::GetXDisplay() == nullptr) - SDLPlatform::InitPlatformX11(GetX11Display()); + SDLPlatform::InitX11(GetX11Display()); #endif } -void* GetNativeWindowPointer(SDL_Window* window) -{ - void* windowPtr; - auto props = SDL_GetWindowProperties(window); -#if PLATFORM_WINDOWS - windowPtr = SDL_GetPointerProperty(props, SDL_PROP_WINDOW_WIN32_HWND_POINTER, nullptr); -#elif PLATFORM_LINUX - windowPtr = SDL_GetPointerProperty(SDL_GetWindowProperties(window), SDL_PROP_WINDOW_WAYLAND_SURFACE_POINTER, nullptr); - if (windowPtr == nullptr) - windowPtr = (void*)SDL_GetNumberProperty(SDL_GetWindowProperties(window), SDL_PROP_WINDOW_X11_WINDOW_NUMBER, 0); -#elif PLATFORM_MAC - windowPtr = SDL_GetPointerProperty(props, SDL_PROP_WINDOW_COCOA_WINDOW_POINTER, nullptr); -#elif PLATFORM_ANDROID - windowPtr = SDL_GetPointerProperty(props, SDL_PROP_WINDOW_ANDROID_WINDOW_POINTER, nullptr); -#elif PLATFORM_IOS - windowPtr = SDL_GetPointerProperty(props, SDL_PROP_WINDOW_UIKIT_WINDOW_POINTER, nullptr); -#else - static_assert(false, "unsupported platform"); -#endif - return windowPtr; -} - SDL_Window* SDLWindow::GetSDLWindow() const { return _window; @@ -265,7 +223,7 @@ SDLWindow::~SDLWindow() if (_window == nullptr) return; - + SDL_StopTextInput(_window); SDL_DestroyWindow(_window); @@ -366,6 +324,10 @@ void SDLWindow::HandleEvent(SDL_Event& event) if (_isClosing) return; + // Platform specific event handling + if (HandleEventInternal(event)) + return; + switch (event.type) { case SDL_EVENT_WINDOW_CLOSE_REQUESTED: @@ -375,16 +337,6 @@ void SDLWindow::HandleEvent(SDL_Event& event) } case SDL_EVENT_WINDOW_DESTROYED: { -#if USE_EDITOR && PLATFORM_WINDOWS - // Disable file dropping - if (_settings.AllowDragAndDrop) - { - const auto result = RevokeDragDrop((HWND)_handle); - if (result != S_OK) - LOG(Warning, "Window drag and drop service error: 0x{0:x}:{1}", result, 2); - } -#endif - // Quit #if PLATFORM_WINDOWS PostQuitMessage(0); @@ -413,16 +365,6 @@ void SDLWindow::HandleEvent(SDL_Event& event) case SDL_EVENT_WINDOW_MOVED: { _cachedClientRectangle.Location = Float2(static_cast(event.window.data1), static_cast(event.window.data2)); -#if PLATFORM_LINUX - if (SDLPlatform::UsesX11()) - { - // X11 doesn't report any mouse events when mouse is over the caption area, send a simulated event instead... - Float2 mousePosition; - auto buttons = SDL_GetGlobalMouseState(&mousePosition.X, &mousePosition.Y); - if ((buttons & SDL_BUTTON_MASK(SDL_BUTTON_LEFT)) != 0) - SDLPlatform::CheckWindowDragging(this, WindowHitCodes::Caption); - } -#endif return; } case SDL_EVENT_WINDOW_HIT_TEST: @@ -440,46 +382,11 @@ void SDLWindow::HandleEvent(SDL_Event& event) _minimized = false; _maximized = true; -#if PLATFORM_WINDOWS && BORDERLESS_MAXIMIZE_WORKAROUND == 2 - if (SkipMaximizeEventsCount > 0) - { - SkipMaximizeEventsCount--; - return; - } - - if (!_settings.HasBorder && _settings.HasSizingFrame) - { - // Restore the window back to previous state - SDL_RestoreWindow(_window); - - // Remove the resizable flags from borderless windows and maximize the window again - auto style = ::GetWindowLong((HWND)_handle, GWL_STYLE); - style &= ~STYLE_RESIZABLE; - ::SetWindowLong((HWND)_handle, GWL_STYLE, style); - - SDL_MaximizeWindow(_window); - - // Re-enable the resizable borderless flags - style = ::GetWindowLong((HWND)_handle, GWL_STYLE) | STYLE_RESIZABLE; - ::SetWindowLong((HWND)_handle, GWL_STYLE, style); - - // The next SDL_EVENT_WINDOW_RESTORED and SDL_EVENT_WINDOW_MAXIMIZED events should be ignored - SkipMaximizeEventsCount = 2; - } -#endif CheckForWindowResize(); return; } case SDL_EVENT_WINDOW_RESTORED: { -#if BORDERLESS_MAXIMIZE_WORKAROUND == 2 - if (SkipMaximizeEventsCount > 0) - { - SkipMaximizeEventsCount--; - return; - } -#endif - if (_maximized) { _maximized = false; @@ -543,68 +450,6 @@ void SDLWindow::HandleEvent(SDL_Event& event) } return; } -#if false - case SDL_EVENT_DROP_BEGIN: - { - Focus(); - Float2 mousePosition; - SDL_GetGlobalMouseState(&mousePosition.X, &mousePosition.Y); - mousePosition = ScreenToClient(mousePosition); - - DragDropEffect effect; - SDLDropTextData dropData; - OnDragEnter(&dropData, mousePosition, effect); - OnDragOver(&dropData, mousePosition, effect); - return; - } - case SDL_EVENT_DROP_POSITION: - { - DragDropEffect effect = DragDropEffect::None; - - SDLDropTextData dropData; - OnDragOver(&dropData, Float2(static_cast(event.drop.x), static_cast(event.drop.y)), effect); - return; - } - case SDL_EVENT_DROP_FILE: - { - SDLDropFilesData dropData; - dropData.Files.Add(StringAnsi(event.drop.data).ToString()); // TODO: collect multiple files at once? - - Focus(); - - Float2 mousePosition; - SDL_GetGlobalMouseState(&mousePosition.X, &mousePosition.Y); - mousePosition = ScreenToClient(mousePosition); - DragDropEffect effect = DragDropEffect::None; - OnDragDrop(&dropData, mousePosition, effect); - return; - } - case SDL_EVENT_DROP_TEXT: - { - SDLDropTextData dropData; - String str = StringAnsi(event.drop.data).ToString(); - dropData.Text = StringView(str); - - Focus(); - Float2 mousePosition; - SDL_GetGlobalMouseState(&mousePosition.X, &mousePosition.Y); - mousePosition = ScreenToClient(mousePosition); - DragDropEffect effect = DragDropEffect::None; - OnDragDrop(&dropData, mousePosition, effect); - return; - } - case SDL_EVENT_DROP_COMPLETE: - { - return; - } -#endif - case SDL_EVENT_WINDOW_MOUSE_LEAVE: - { -#if !PLATFORM_WINDOWS - OnDragLeave(); // Check for release of mouse button too? -#endif - break; - } default: break; } @@ -639,9 +484,9 @@ void SDLWindow::Show() else if (_settings.Parent == nullptr) BringToFront(); - // Reused top-most windows (DockHintWindow) doesn't stay on top for some reason - if (_settings.IsTopmost && _settings.Type != WindowType::Tooltip) - SDL_SetWindowAlwaysOnTop(_window, true); + // Reused top-most windows doesn't stay on top for some reason + if (_settings.IsTopmost && !IsPopupWindow(_settings.Type)) + SetIsAlwaysOnTop(true); if (_isTrackingMouse) { @@ -678,19 +523,7 @@ void SDLWindow::Maximize() if (!_settings.AllowMaximize) return; -#if PLATFORM_WINDOWS && BORDERLESS_MAXIMIZE_WORKAROUND == 1 - // Workaround for "SDL_BORDERLESS_RESIZABLE_STYLE" hint not working as expected when maximizing windows - auto style = ::GetWindowLong((HWND)_handle, GWL_STYLE); - style &= ~STYLE_RESIZABLE; - ::SetWindowLong((HWND)_handle, GWL_STYLE, style); - SDL_MaximizeWindow(_window); - - style = ::GetWindowLong((HWND)_handle, GWL_STYLE) | STYLE_RESIZABLE; - ::SetWindowLong((HWND)_handle, GWL_STYLE, style); -#else - SDL_MaximizeWindow(_window); -#endif } void SDLWindow::SetBorderless(bool isBorderless, bool maximized) @@ -706,45 +539,18 @@ void SDLWindow::SetBorderless(bool isBorderless, bool maximized) BringToFront(); - if (isBorderless) - { - SDL_SetWindowBordered(_window, !isBorderless ? true : false); - if (maximized) - { - Maximize(); - } - else - Focus(); - } + SDL_SetWindowBordered(_window, !isBorderless ? true : false); + if (maximized) + Maximize(); else - { - SDL_SetWindowBordered(_window, !isBorderless ? true : false); - if (maximized) - { - Maximize(); - } - else - Focus(); - } - + Focus(); + CheckForWindowResize(); } void SDLWindow::Restore() { -#if PLATFORM_WINDOWS && BORDERLESS_MAXIMIZE_WORKAROUND == 1 - // Workaround for "SDL_BORDERLESS_RESIZABLE_STYLE" hint not working as expected when maximizing windows - auto style = ::GetWindowLong((HWND)_handle, GWL_STYLE); - style &= ~STYLE_RESIZABLE; - ::SetWindowLong((HWND)_handle, GWL_STYLE, style); - SDL_RestoreWindow(_window); - - style = ::GetWindowLong((HWND)_handle, GWL_STYLE) | STYLE_RESIZABLE; - ::SetWindowLong((HWND)_handle, GWL_STYLE, style); -#else - SDL_RestoreWindow(_window); -#endif } bool SDLWindow::IsClosed() const @@ -760,28 +566,19 @@ bool SDLWindow::IsForegroundWindow() const void SDLWindow::BringToFront(bool force) { - auto activateWhenRaised = SDL_GetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED); - SDL_SetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED, "0"); SDL_RaiseWindow(_window); - SDL_SetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED, activateWhenRaised); } void SDLWindow::SetClientBounds(const Rectangle& clientArea) { - int newX = static_cast(clientArea.GetLeft()); - int newY = static_cast(clientArea.GetTop()); + Int2 newPos = Int2(clientArea.GetTopLeft()); int newW = static_cast(clientArea.GetWidth()); int newH = static_cast(clientArea.GetHeight()); - SetSDLWindowScreenPosition(this, newX, newY); + SetSDLWindowScreenPosition(this, newPos); SDL_SetWindowSize(_window, newW, newH); } -bool IsPopupWindow(WindowType type) -{ - return type == WindowType::Popup || type == WindowType::Tooltip; -} - void GetRelativeWindowOffset(WindowType type, SDLWindow* parentWindow, Int2& positionOffset) { if (!IsPopupWindow(type)) @@ -812,9 +609,9 @@ Int2 GetSDLWindowScreenPosition(const SDLWindow* window) return position - relativeOffset; } -void SetSDLWindowScreenPosition(const SDLWindow* window, const int x, const int y) +void SetSDLWindowScreenPosition(const SDLWindow* window, const Int2 position) { - Int2 relativePosition(x, y); + Int2 relativePosition = position; GetRelativeWindowOffset(window->GetSettings().Type, window->GetSettings().Parent, relativePosition); SDL_SetWindowPosition(window->GetSDLWindow(), relativePosition.X, relativePosition.Y); } @@ -834,12 +631,12 @@ void SDLWindow::SetPosition(const Float2& position) screenPosition += Int2(monitorBounds.GetTopLeft()); } - SetSDLWindowScreenPosition(this, screenPosition.X, screenPosition.Y); + SetSDLWindowScreenPosition(this, screenPosition); } void SDLWindow::SetClientPosition(const Float2& position) { - SetSDLWindowScreenPosition(this, static_cast(position.X), static_cast(position.Y)); + SetSDLWindowScreenPosition(this, Int2(position)); } void SDLWindow::SetIsFullscreen(bool isFullscreen) @@ -848,7 +645,7 @@ void SDLWindow::SetIsFullscreen(bool isFullscreen) if (!isFullscreen) { // The window is set to always-on-top for some reason when leaving fullscreen - SDL_SetWindowAlwaysOnTop(_window, false); + SetIsAlwaysOnTop(false); } WindowBase::SetIsFullscreen(isFullscreen); @@ -930,25 +727,15 @@ void SDLWindow::SetOpacity(const float opacity) LOG(Warning, "SDL_SetWindowOpacity failed: {0}", String(SDL_GetError())); } +#if !PLATFORM_WINDOWS + void SDLWindow::Focus() { -#if PLATFORM_WINDOWS - auto activateWhenRaised = SDL_GetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED); - SDL_SetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED, "1"); - - // Forcing the window to focus causes issues with opening context menus while window is maximized - //auto forceRaiseWindow = SDL_GetHint(SDL_HINT_FORCE_RAISEWINDOW); - //SDL_SetHint(SDL_HINT_FORCE_RAISEWINDOW, "1"); - SDL_RaiseWindow(_window); - - SDL_SetHint(SDL_HINT_WINDOW_ACTIVATE_WHEN_RAISED, activateWhenRaised); - //SDL_SetHint(SDL_HINT_FORCE_RAISEWINDOW, forceRaiseWindow); -#else - SDL_RaiseWindow(_window); -#endif } +#endif + String SDLWindow::GetTitle() const { return String(SDL_GetWindowTitle(_window)); diff --git a/Source/Engine/Platform/SDL/SDLWindow.h b/Source/Engine/Platform/SDL/SDLWindow.h index 416bd48d2..331f99266 100644 --- a/Source/Engine/Platform/SDL/SDLWindow.h +++ b/Source/Engine/Platform/SDL/SDLWindow.h @@ -57,11 +57,12 @@ private: static SDLWindow* GetWindowFromEvent(const SDL_Event& event); static SDLWindow* GetWindowWithSDLWindow(SDL_Window* window); void HandleEvent(SDL_Event& event); + bool HandleEventInternal(SDL_Event& event); void CheckForWindowResize(); void UpdateCursor(); #if PLATFORM_LINUX - DragDropEffect DoDragDropWayland(const StringView& data); + DragDropEffect DoDragDropWayland(const StringView& data, Window* dragSourceWindow = nullptr, Float2 dragOffset = Float2::Zero); DragDropEffect DoDragDropX11(const StringView& data); #endif @@ -104,6 +105,7 @@ public: String GetTitle() const override; void SetTitle(const StringView& title) override; DragDropEffect DoDragDrop(const StringView& data) override; + DragDropEffect DoDragDrop(const StringView& data, const Float2& offset, Window* dragSourceWindow) override; void StartTrackingMouse(bool useMouseScreenOffset) override; void EndTrackingMouse() override; void StartClippingCursor(const Rectangle& bounds) override; diff --git a/Source/Engine/UI/GUI/Tooltip.cs b/Source/Engine/UI/GUI/Tooltip.cs index cc8c211b3..1d5838a33 100644 --- a/Source/Engine/UI/GUI/Tooltip.cs +++ b/Source/Engine/UI/GUI/Tooltip.cs @@ -207,7 +207,7 @@ namespace FlaxEngine.GUI var rightBottomLocationSS = locationSS + dpiSize; // Prioritize tooltip placement within parent window, fall back to virtual desktop - if (rightBottomMonitorBounds.Y < rightBottomLocationSS.Y) + /*if (rightBottomMonitorBounds.Y < rightBottomLocationSS.Y) { // Direction: up locationSS.Y -= dpiSize.Y + flipOffset; @@ -216,7 +216,7 @@ namespace FlaxEngine.GUI { // Direction: left locationSS.X -= dpiSize.X + flipOffset * 2; - } + }*/ } /// diff --git a/Source/ThirdParty/Wayland/Wayland.Build.cs b/Source/ThirdParty/Wayland/Wayland.Build.cs index c2d924367..7a2d5d6b8 100644 --- a/Source/ThirdParty/Wayland/Wayland.Build.cs +++ b/Source/ThirdParty/Wayland/Wayland.Build.cs @@ -32,6 +32,6 @@ public class Wayland : ThirdPartyModule // Include generated protocol files for dependency options.PublicIncludePaths.Add(Path.Combine(FolderPath, "include")); - options.SourceFiles.AddRange(Directory.GetFiles(FolderPath, "*.cpp", SearchOption.TopDirectoryOnly)); + options.SourceFiles.AddRange(Directory.GetFiles(FolderPath, "*.c", SearchOption.TopDirectoryOnly)); } } diff --git a/Source/ThirdParty/Wayland/include/wayland/xdg-shell.h b/Source/ThirdParty/Wayland/include/wayland/xdg-shell.h new file mode 100644 index 000000000..1f077b491 --- /dev/null +++ b/Source/ThirdParty/Wayland/include/wayland/xdg-shell.h @@ -0,0 +1,2325 @@ +/* Generated by wayland-scanner 1.23.1 */ + +#ifndef XDG_SHELL_CLIENT_PROTOCOL_H +#define XDG_SHELL_CLIENT_PROTOCOL_H + +#include +#include +#include "wayland-client.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @page page_xdg_shell The xdg_shell protocol + * @section page_ifaces_xdg_shell Interfaces + * - @subpage page_iface_xdg_wm_base - create desktop-style surfaces + * - @subpage page_iface_xdg_positioner - child surface positioner + * - @subpage page_iface_xdg_surface - desktop user interface surface base interface + * - @subpage page_iface_xdg_toplevel - toplevel surface + * - @subpage page_iface_xdg_popup - short-lived, popup surfaces for menus + * @section page_copyright_xdg_shell Copyright + *
+ *
+ * Copyright © 2008-2013 Kristian Høgsberg
+ * Copyright © 2013      Rafael Antognolli
+ * Copyright © 2013      Jasper St. Pierre
+ * Copyright © 2010-2013 Intel Corporation
+ * Copyright © 2015-2017 Samsung Electronics Co., Ltd
+ * Copyright © 2015-2017 Red Hat Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ * 
+ */ +struct wl_output; +struct wl_seat; +struct wl_surface; +struct xdg_popup; +struct xdg_positioner; +struct xdg_surface; +struct xdg_toplevel; +struct xdg_wm_base; + +#ifndef XDG_WM_BASE_INTERFACE +#define XDG_WM_BASE_INTERFACE +/** + * @page page_iface_xdg_wm_base xdg_wm_base + * @section page_iface_xdg_wm_base_desc Description + * + * The xdg_wm_base interface is exposed as a global object enabling clients + * to turn their wl_surfaces into windows in a desktop environment. It + * defines the basic functionality needed for clients and the compositor to + * create windows that can be dragged, resized, maximized, etc, as well as + * creating transient windows such as popup menus. + * @section page_iface_xdg_wm_base_api API + * See @ref iface_xdg_wm_base. + */ +/** + * @defgroup iface_xdg_wm_base The xdg_wm_base interface + * + * The xdg_wm_base interface is exposed as a global object enabling clients + * to turn their wl_surfaces into windows in a desktop environment. It + * defines the basic functionality needed for clients and the compositor to + * create windows that can be dragged, resized, maximized, etc, as well as + * creating transient windows such as popup menus. + */ +extern const struct wl_interface xdg_wm_base_interface; +#endif +#ifndef XDG_POSITIONER_INTERFACE +#define XDG_POSITIONER_INTERFACE +/** + * @page page_iface_xdg_positioner xdg_positioner + * @section page_iface_xdg_positioner_desc Description + * + * The xdg_positioner provides a collection of rules for the placement of a + * child surface relative to a parent surface. Rules can be defined to ensure + * the child surface remains within the visible area's borders, and to + * specify how the child surface changes its position, such as sliding along + * an axis, or flipping around a rectangle. These positioner-created rules are + * constrained by the requirement that a child surface must intersect with or + * be at least partially adjacent to its parent surface. + * + * See the various requests for details about possible rules. + * + * At the time of the request, the compositor makes a copy of the rules + * specified by the xdg_positioner. Thus, after the request is complete the + * xdg_positioner object can be destroyed or reused; further changes to the + * object will have no effect on previous usages. + * + * For an xdg_positioner object to be considered complete, it must have a + * non-zero size set by set_size, and a non-zero anchor rectangle set by + * set_anchor_rect. Passing an incomplete xdg_positioner object when + * positioning a surface raises an invalid_positioner error. + * @section page_iface_xdg_positioner_api API + * See @ref iface_xdg_positioner. + */ +/** + * @defgroup iface_xdg_positioner The xdg_positioner interface + * + * The xdg_positioner provides a collection of rules for the placement of a + * child surface relative to a parent surface. Rules can be defined to ensure + * the child surface remains within the visible area's borders, and to + * specify how the child surface changes its position, such as sliding along + * an axis, or flipping around a rectangle. These positioner-created rules are + * constrained by the requirement that a child surface must intersect with or + * be at least partially adjacent to its parent surface. + * + * See the various requests for details about possible rules. + * + * At the time of the request, the compositor makes a copy of the rules + * specified by the xdg_positioner. Thus, after the request is complete the + * xdg_positioner object can be destroyed or reused; further changes to the + * object will have no effect on previous usages. + * + * For an xdg_positioner object to be considered complete, it must have a + * non-zero size set by set_size, and a non-zero anchor rectangle set by + * set_anchor_rect. Passing an incomplete xdg_positioner object when + * positioning a surface raises an invalid_positioner error. + */ +extern const struct wl_interface xdg_positioner_interface; +#endif +#ifndef XDG_SURFACE_INTERFACE +#define XDG_SURFACE_INTERFACE +/** + * @page page_iface_xdg_surface xdg_surface + * @section page_iface_xdg_surface_desc Description + * + * An interface that may be implemented by a wl_surface, for + * implementations that provide a desktop-style user interface. + * + * It provides a base set of functionality required to construct user + * interface elements requiring management by the compositor, such as + * toplevel windows, menus, etc. The types of functionality are split into + * xdg_surface roles. + * + * Creating an xdg_surface does not set the role for a wl_surface. In order + * to map an xdg_surface, the client must create a role-specific object + * using, e.g., get_toplevel, get_popup. The wl_surface for any given + * xdg_surface can have at most one role, and may not be assigned any role + * not based on xdg_surface. + * + * A role must be assigned before any other requests are made to the + * xdg_surface object. + * + * The client must call wl_surface.commit on the corresponding wl_surface + * for the xdg_surface state to take effect. + * + * Creating an xdg_surface from a wl_surface which has a buffer attached or + * committed is a client error, and any attempts by a client to attach or + * manipulate a buffer prior to the first xdg_surface.configure call must + * also be treated as errors. + * + * After creating a role-specific object and setting it up (e.g. by sending + * the title, app ID, size constraints, parent, etc), the client must + * perform an initial commit without any buffer attached. The compositor + * will reply with initial wl_surface state such as + * wl_surface.preferred_buffer_scale followed by an xdg_surface.configure + * event. The client must acknowledge it and is then allowed to attach a + * buffer to map the surface. + * + * Mapping an xdg_surface-based role surface is defined as making it + * possible for the surface to be shown by the compositor. Note that + * a mapped surface is not guaranteed to be visible once it is mapped. + * + * For an xdg_surface to be mapped by the compositor, the following + * conditions must be met: + * (1) the client has assigned an xdg_surface-based role to the surface + * (2) the client has set and committed the xdg_surface state and the + * role-dependent state to the surface + * (3) the client has committed a buffer to the surface + * + * A newly-unmapped surface is considered to have met condition (1) out + * of the 3 required conditions for mapping a surface if its role surface + * has not been destroyed, i.e. the client must perform the initial commit + * again before attaching a buffer. + * @section page_iface_xdg_surface_api API + * See @ref iface_xdg_surface. + */ +/** + * @defgroup iface_xdg_surface The xdg_surface interface + * + * An interface that may be implemented by a wl_surface, for + * implementations that provide a desktop-style user interface. + * + * It provides a base set of functionality required to construct user + * interface elements requiring management by the compositor, such as + * toplevel windows, menus, etc. The types of functionality are split into + * xdg_surface roles. + * + * Creating an xdg_surface does not set the role for a wl_surface. In order + * to map an xdg_surface, the client must create a role-specific object + * using, e.g., get_toplevel, get_popup. The wl_surface for any given + * xdg_surface can have at most one role, and may not be assigned any role + * not based on xdg_surface. + * + * A role must be assigned before any other requests are made to the + * xdg_surface object. + * + * The client must call wl_surface.commit on the corresponding wl_surface + * for the xdg_surface state to take effect. + * + * Creating an xdg_surface from a wl_surface which has a buffer attached or + * committed is a client error, and any attempts by a client to attach or + * manipulate a buffer prior to the first xdg_surface.configure call must + * also be treated as errors. + * + * After creating a role-specific object and setting it up (e.g. by sending + * the title, app ID, size constraints, parent, etc), the client must + * perform an initial commit without any buffer attached. The compositor + * will reply with initial wl_surface state such as + * wl_surface.preferred_buffer_scale followed by an xdg_surface.configure + * event. The client must acknowledge it and is then allowed to attach a + * buffer to map the surface. + * + * Mapping an xdg_surface-based role surface is defined as making it + * possible for the surface to be shown by the compositor. Note that + * a mapped surface is not guaranteed to be visible once it is mapped. + * + * For an xdg_surface to be mapped by the compositor, the following + * conditions must be met: + * (1) the client has assigned an xdg_surface-based role to the surface + * (2) the client has set and committed the xdg_surface state and the + * role-dependent state to the surface + * (3) the client has committed a buffer to the surface + * + * A newly-unmapped surface is considered to have met condition (1) out + * of the 3 required conditions for mapping a surface if its role surface + * has not been destroyed, i.e. the client must perform the initial commit + * again before attaching a buffer. + */ +extern const struct wl_interface xdg_surface_interface; +#endif +#ifndef XDG_TOPLEVEL_INTERFACE +#define XDG_TOPLEVEL_INTERFACE +/** + * @page page_iface_xdg_toplevel xdg_toplevel + * @section page_iface_xdg_toplevel_desc Description + * + * This interface defines an xdg_surface role which allows a surface to, + * among other things, set window-like properties such as maximize, + * fullscreen, and minimize, set application-specific metadata like title and + * id, and well as trigger user interactive operations such as interactive + * resize and move. + * + * A xdg_toplevel by default is responsible for providing the full intended + * visual representation of the toplevel, which depending on the window + * state, may mean things like a title bar, window controls and drop shadow. + * + * Unmapping an xdg_toplevel means that the surface cannot be shown + * by the compositor until it is explicitly mapped again. + * All active operations (e.g., move, resize) are canceled and all + * attributes (e.g. title, state, stacking, ...) are discarded for + * an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to + * the state it had right after xdg_surface.get_toplevel. The client + * can re-map the toplevel by performing a commit without any buffer + * attached, waiting for a configure event and handling it as usual (see + * xdg_surface description). + * + * Attaching a null buffer to a toplevel unmaps the surface. + * @section page_iface_xdg_toplevel_api API + * See @ref iface_xdg_toplevel. + */ +/** + * @defgroup iface_xdg_toplevel The xdg_toplevel interface + * + * This interface defines an xdg_surface role which allows a surface to, + * among other things, set window-like properties such as maximize, + * fullscreen, and minimize, set application-specific metadata like title and + * id, and well as trigger user interactive operations such as interactive + * resize and move. + * + * A xdg_toplevel by default is responsible for providing the full intended + * visual representation of the toplevel, which depending on the window + * state, may mean things like a title bar, window controls and drop shadow. + * + * Unmapping an xdg_toplevel means that the surface cannot be shown + * by the compositor until it is explicitly mapped again. + * All active operations (e.g., move, resize) are canceled and all + * attributes (e.g. title, state, stacking, ...) are discarded for + * an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to + * the state it had right after xdg_surface.get_toplevel. The client + * can re-map the toplevel by performing a commit without any buffer + * attached, waiting for a configure event and handling it as usual (see + * xdg_surface description). + * + * Attaching a null buffer to a toplevel unmaps the surface. + */ +extern const struct wl_interface xdg_toplevel_interface; +#endif +#ifndef XDG_POPUP_INTERFACE +#define XDG_POPUP_INTERFACE +/** + * @page page_iface_xdg_popup xdg_popup + * @section page_iface_xdg_popup_desc Description + * + * A popup surface is a short-lived, temporary surface. It can be used to + * implement for example menus, popovers, tooltips and other similar user + * interface concepts. + * + * A popup can be made to take an explicit grab. See xdg_popup.grab for + * details. + * + * When the popup is dismissed, a popup_done event will be sent out, and at + * the same time the surface will be unmapped. See the xdg_popup.popup_done + * event for details. + * + * Explicitly destroying the xdg_popup object will also dismiss the popup and + * unmap the surface. Clients that want to dismiss the popup when another + * surface of their own is clicked should dismiss the popup using the destroy + * request. + * + * A newly created xdg_popup will be stacked on top of all previously created + * xdg_popup surfaces associated with the same xdg_toplevel. + * + * The parent of an xdg_popup must be mapped (see the xdg_surface + * description) before the xdg_popup itself. + * + * The client must call wl_surface.commit on the corresponding wl_surface + * for the xdg_popup state to take effect. + * @section page_iface_xdg_popup_api API + * See @ref iface_xdg_popup. + */ +/** + * @defgroup iface_xdg_popup The xdg_popup interface + * + * A popup surface is a short-lived, temporary surface. It can be used to + * implement for example menus, popovers, tooltips and other similar user + * interface concepts. + * + * A popup can be made to take an explicit grab. See xdg_popup.grab for + * details. + * + * When the popup is dismissed, a popup_done event will be sent out, and at + * the same time the surface will be unmapped. See the xdg_popup.popup_done + * event for details. + * + * Explicitly destroying the xdg_popup object will also dismiss the popup and + * unmap the surface. Clients that want to dismiss the popup when another + * surface of their own is clicked should dismiss the popup using the destroy + * request. + * + * A newly created xdg_popup will be stacked on top of all previously created + * xdg_popup surfaces associated with the same xdg_toplevel. + * + * The parent of an xdg_popup must be mapped (see the xdg_surface + * description) before the xdg_popup itself. + * + * The client must call wl_surface.commit on the corresponding wl_surface + * for the xdg_popup state to take effect. + */ +extern const struct wl_interface xdg_popup_interface; +#endif + +#ifndef XDG_WM_BASE_ERROR_ENUM +#define XDG_WM_BASE_ERROR_ENUM +enum xdg_wm_base_error { + /** + * given wl_surface has another role + */ + XDG_WM_BASE_ERROR_ROLE = 0, + /** + * xdg_wm_base was destroyed before children + */ + XDG_WM_BASE_ERROR_DEFUNCT_SURFACES = 1, + /** + * the client tried to map or destroy a non-topmost popup + */ + XDG_WM_BASE_ERROR_NOT_THE_TOPMOST_POPUP = 2, + /** + * the client specified an invalid popup parent surface + */ + XDG_WM_BASE_ERROR_INVALID_POPUP_PARENT = 3, + /** + * the client provided an invalid surface state + */ + XDG_WM_BASE_ERROR_INVALID_SURFACE_STATE = 4, + /** + * the client provided an invalid positioner + */ + XDG_WM_BASE_ERROR_INVALID_POSITIONER = 5, + /** + * the client didn’t respond to a ping event in time + */ + XDG_WM_BASE_ERROR_UNRESPONSIVE = 6, +}; +#endif /* XDG_WM_BASE_ERROR_ENUM */ + +/** + * @ingroup iface_xdg_wm_base + * @struct xdg_wm_base_listener + */ +struct xdg_wm_base_listener { + /** + * check if the client is alive + * + * The ping event asks the client if it's still alive. Pass the + * serial specified in the event back to the compositor by sending + * a "pong" request back with the specified serial. See + * xdg_wm_base.pong. + * + * Compositors can use this to determine if the client is still + * alive. It's unspecified what will happen if the client doesn't + * respond to the ping request, or in what timeframe. Clients + * should try to respond in a reasonable amount of time. The + * “unresponsive” error is provided for compositors that wish + * to disconnect unresponsive clients. + * + * A compositor is free to ping in any way it wants, but a client + * must always respond to any xdg_wm_base object it created. + * @param serial pass this to the pong request + */ + void (*ping)(void *data, + struct xdg_wm_base *xdg_wm_base, + uint32_t serial); +}; + +/** + * @ingroup iface_xdg_wm_base + */ +static inline int +xdg_wm_base_add_listener(struct xdg_wm_base *xdg_wm_base, + const struct xdg_wm_base_listener *listener, void *data) +{ + return wl_proxy_add_listener((struct wl_proxy *) xdg_wm_base, + (void (**)(void)) listener, data); +} + +#define XDG_WM_BASE_DESTROY 0 +#define XDG_WM_BASE_CREATE_POSITIONER 1 +#define XDG_WM_BASE_GET_XDG_SURFACE 2 +#define XDG_WM_BASE_PONG 3 + +/** + * @ingroup iface_xdg_wm_base + */ +#define XDG_WM_BASE_PING_SINCE_VERSION 1 + +/** + * @ingroup iface_xdg_wm_base + */ +#define XDG_WM_BASE_DESTROY_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_wm_base + */ +#define XDG_WM_BASE_CREATE_POSITIONER_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_wm_base + */ +#define XDG_WM_BASE_GET_XDG_SURFACE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_wm_base + */ +#define XDG_WM_BASE_PONG_SINCE_VERSION 1 + +/** @ingroup iface_xdg_wm_base */ +static inline void +xdg_wm_base_set_user_data(struct xdg_wm_base *xdg_wm_base, void *user_data) +{ + wl_proxy_set_user_data((struct wl_proxy *) xdg_wm_base, user_data); +} + +/** @ingroup iface_xdg_wm_base */ +static inline void * +xdg_wm_base_get_user_data(struct xdg_wm_base *xdg_wm_base) +{ + return wl_proxy_get_user_data((struct wl_proxy *) xdg_wm_base); +} + +static inline uint32_t +xdg_wm_base_get_version(struct xdg_wm_base *xdg_wm_base) +{ + return wl_proxy_get_version((struct wl_proxy *) xdg_wm_base); +} + +/** + * @ingroup iface_xdg_wm_base + * + * Destroy this xdg_wm_base object. + * + * Destroying a bound xdg_wm_base object while there are surfaces + * still alive created by this xdg_wm_base object instance is illegal + * and will result in a defunct_surfaces error. + */ +static inline void +xdg_wm_base_destroy(struct xdg_wm_base *xdg_wm_base) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_wm_base, + XDG_WM_BASE_DESTROY, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_wm_base), WL_MARSHAL_FLAG_DESTROY); +} + +/** + * @ingroup iface_xdg_wm_base + * + * Create a positioner object. A positioner object is used to position + * surfaces relative to some parent surface. See the interface description + * and xdg_surface.get_popup for details. + */ +static inline struct xdg_positioner * +xdg_wm_base_create_positioner(struct xdg_wm_base *xdg_wm_base) +{ + struct wl_proxy *id; + + id = wl_proxy_marshal_flags((struct wl_proxy *) xdg_wm_base, + XDG_WM_BASE_CREATE_POSITIONER, &xdg_positioner_interface, wl_proxy_get_version((struct wl_proxy *) xdg_wm_base), 0, NULL); + + return (struct xdg_positioner *) id; +} + +/** + * @ingroup iface_xdg_wm_base + * + * This creates an xdg_surface for the given surface. While xdg_surface + * itself is not a role, the corresponding surface may only be assigned + * a role extending xdg_surface, such as xdg_toplevel or xdg_popup. It is + * illegal to create an xdg_surface for a wl_surface which already has an + * assigned role and this will result in a role error. + * + * This creates an xdg_surface for the given surface. An xdg_surface is + * used as basis to define a role to a given surface, such as xdg_toplevel + * or xdg_popup. It also manages functionality shared between xdg_surface + * based surface roles. + * + * See the documentation of xdg_surface for more details about what an + * xdg_surface is and how it is used. + */ +static inline struct xdg_surface * +xdg_wm_base_get_xdg_surface(struct xdg_wm_base *xdg_wm_base, struct wl_surface *surface) +{ + struct wl_proxy *id; + + id = wl_proxy_marshal_flags((struct wl_proxy *) xdg_wm_base, + XDG_WM_BASE_GET_XDG_SURFACE, &xdg_surface_interface, wl_proxy_get_version((struct wl_proxy *) xdg_wm_base), 0, NULL, surface); + + return (struct xdg_surface *) id; +} + +/** + * @ingroup iface_xdg_wm_base + * + * A client must respond to a ping event with a pong request or + * the client may be deemed unresponsive. See xdg_wm_base.ping + * and xdg_wm_base.error.unresponsive. + */ +static inline void +xdg_wm_base_pong(struct xdg_wm_base *xdg_wm_base, uint32_t serial) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_wm_base, + XDG_WM_BASE_PONG, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_wm_base), 0, serial); +} + +#ifndef XDG_POSITIONER_ERROR_ENUM +#define XDG_POSITIONER_ERROR_ENUM +enum xdg_positioner_error { + /** + * invalid input provided + */ + XDG_POSITIONER_ERROR_INVALID_INPUT = 0, +}; +#endif /* XDG_POSITIONER_ERROR_ENUM */ + +#ifndef XDG_POSITIONER_ANCHOR_ENUM +#define XDG_POSITIONER_ANCHOR_ENUM +enum xdg_positioner_anchor { + XDG_POSITIONER_ANCHOR_NONE = 0, + XDG_POSITIONER_ANCHOR_TOP = 1, + XDG_POSITIONER_ANCHOR_BOTTOM = 2, + XDG_POSITIONER_ANCHOR_LEFT = 3, + XDG_POSITIONER_ANCHOR_RIGHT = 4, + XDG_POSITIONER_ANCHOR_TOP_LEFT = 5, + XDG_POSITIONER_ANCHOR_BOTTOM_LEFT = 6, + XDG_POSITIONER_ANCHOR_TOP_RIGHT = 7, + XDG_POSITIONER_ANCHOR_BOTTOM_RIGHT = 8, +}; +#endif /* XDG_POSITIONER_ANCHOR_ENUM */ + +#ifndef XDG_POSITIONER_GRAVITY_ENUM +#define XDG_POSITIONER_GRAVITY_ENUM +enum xdg_positioner_gravity { + XDG_POSITIONER_GRAVITY_NONE = 0, + XDG_POSITIONER_GRAVITY_TOP = 1, + XDG_POSITIONER_GRAVITY_BOTTOM = 2, + XDG_POSITIONER_GRAVITY_LEFT = 3, + XDG_POSITIONER_GRAVITY_RIGHT = 4, + XDG_POSITIONER_GRAVITY_TOP_LEFT = 5, + XDG_POSITIONER_GRAVITY_BOTTOM_LEFT = 6, + XDG_POSITIONER_GRAVITY_TOP_RIGHT = 7, + XDG_POSITIONER_GRAVITY_BOTTOM_RIGHT = 8, +}; +#endif /* XDG_POSITIONER_GRAVITY_ENUM */ + +#ifndef XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM +#define XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM +/** + * @ingroup iface_xdg_positioner + * constraint adjustments + * + * The constraint adjustment value define ways the compositor will adjust + * the position of the surface, if the unadjusted position would result + * in the surface being partly constrained. + * + * Whether a surface is considered 'constrained' is left to the compositor + * to determine. For example, the surface may be partly outside the + * compositor's defined 'work area', thus necessitating the child surface's + * position be adjusted until it is entirely inside the work area. + * + * The adjustments can be combined, according to a defined precedence: 1) + * Flip, 2) Slide, 3) Resize. + */ +enum xdg_positioner_constraint_adjustment { + /** + * don't move the child surface when constrained + * + * Don't alter the surface position even if it is constrained on + * some axis, for example partially outside the edge of an output. + */ + XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_NONE = 0, + /** + * move along the x axis until unconstrained + * + * Slide the surface along the x axis until it is no longer + * constrained. + * + * First try to slide towards the direction of the gravity on the x + * axis until either the edge in the opposite direction of the + * gravity is unconstrained or the edge in the direction of the + * gravity is constrained. + * + * Then try to slide towards the opposite direction of the gravity + * on the x axis until either the edge in the direction of the + * gravity is unconstrained or the edge in the opposite direction + * of the gravity is constrained. + */ + XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_X = 1, + /** + * move along the y axis until unconstrained + * + * Slide the surface along the y axis until it is no longer + * constrained. + * + * First try to slide towards the direction of the gravity on the y + * axis until either the edge in the opposite direction of the + * gravity is unconstrained or the edge in the direction of the + * gravity is constrained. + * + * Then try to slide towards the opposite direction of the gravity + * on the y axis until either the edge in the direction of the + * gravity is unconstrained or the edge in the opposite direction + * of the gravity is constrained. + */ + XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_Y = 2, + /** + * invert the anchor and gravity on the x axis + * + * Invert the anchor and gravity on the x axis if the surface is + * constrained on the x axis. For example, if the left edge of the + * surface is constrained, the gravity is 'left' and the anchor is + * 'left', change the gravity to 'right' and the anchor to 'right'. + * + * If the adjusted position also ends up being constrained, the + * resulting position of the flip_x adjustment will be the one + * before the adjustment. + */ + XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_X = 4, + /** + * invert the anchor and gravity on the y axis + * + * Invert the anchor and gravity on the y axis if the surface is + * constrained on the y axis. For example, if the bottom edge of + * the surface is constrained, the gravity is 'bottom' and the + * anchor is 'bottom', change the gravity to 'top' and the anchor + * to 'top'. + * + * The adjusted position is calculated given the original anchor + * rectangle and offset, but with the new flipped anchor and + * gravity values. + * + * If the adjusted position also ends up being constrained, the + * resulting position of the flip_y adjustment will be the one + * before the adjustment. + */ + XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_Y = 8, + /** + * horizontally resize the surface + * + * Resize the surface horizontally so that it is completely + * unconstrained. + */ + XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_X = 16, + /** + * vertically resize the surface + * + * Resize the surface vertically so that it is completely + * unconstrained. + */ + XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_Y = 32, +}; +#endif /* XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM */ + +#define XDG_POSITIONER_DESTROY 0 +#define XDG_POSITIONER_SET_SIZE 1 +#define XDG_POSITIONER_SET_ANCHOR_RECT 2 +#define XDG_POSITIONER_SET_ANCHOR 3 +#define XDG_POSITIONER_SET_GRAVITY 4 +#define XDG_POSITIONER_SET_CONSTRAINT_ADJUSTMENT 5 +#define XDG_POSITIONER_SET_OFFSET 6 +#define XDG_POSITIONER_SET_REACTIVE 7 +#define XDG_POSITIONER_SET_PARENT_SIZE 8 +#define XDG_POSITIONER_SET_PARENT_CONFIGURE 9 + + +/** + * @ingroup iface_xdg_positioner + */ +#define XDG_POSITIONER_DESTROY_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_positioner + */ +#define XDG_POSITIONER_SET_SIZE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_positioner + */ +#define XDG_POSITIONER_SET_ANCHOR_RECT_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_positioner + */ +#define XDG_POSITIONER_SET_ANCHOR_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_positioner + */ +#define XDG_POSITIONER_SET_GRAVITY_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_positioner + */ +#define XDG_POSITIONER_SET_CONSTRAINT_ADJUSTMENT_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_positioner + */ +#define XDG_POSITIONER_SET_OFFSET_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_positioner + */ +#define XDG_POSITIONER_SET_REACTIVE_SINCE_VERSION 3 +/** + * @ingroup iface_xdg_positioner + */ +#define XDG_POSITIONER_SET_PARENT_SIZE_SINCE_VERSION 3 +/** + * @ingroup iface_xdg_positioner + */ +#define XDG_POSITIONER_SET_PARENT_CONFIGURE_SINCE_VERSION 3 + +/** @ingroup iface_xdg_positioner */ +static inline void +xdg_positioner_set_user_data(struct xdg_positioner *xdg_positioner, void *user_data) +{ + wl_proxy_set_user_data((struct wl_proxy *) xdg_positioner, user_data); +} + +/** @ingroup iface_xdg_positioner */ +static inline void * +xdg_positioner_get_user_data(struct xdg_positioner *xdg_positioner) +{ + return wl_proxy_get_user_data((struct wl_proxy *) xdg_positioner); +} + +static inline uint32_t +xdg_positioner_get_version(struct xdg_positioner *xdg_positioner) +{ + return wl_proxy_get_version((struct wl_proxy *) xdg_positioner); +} + +/** + * @ingroup iface_xdg_positioner + * + * Notify the compositor that the xdg_positioner will no longer be used. + */ +static inline void +xdg_positioner_destroy(struct xdg_positioner *xdg_positioner) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_positioner, + XDG_POSITIONER_DESTROY, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_positioner), WL_MARSHAL_FLAG_DESTROY); +} + +/** + * @ingroup iface_xdg_positioner + * + * Set the size of the surface that is to be positioned with the positioner + * object. The size is in surface-local coordinates and corresponds to the + * window geometry. See xdg_surface.set_window_geometry. + * + * If a zero or negative size is set the invalid_input error is raised. + */ +static inline void +xdg_positioner_set_size(struct xdg_positioner *xdg_positioner, int32_t width, int32_t height) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_positioner, + XDG_POSITIONER_SET_SIZE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_positioner), 0, width, height); +} + +/** + * @ingroup iface_xdg_positioner + * + * Specify the anchor rectangle within the parent surface that the child + * surface will be placed relative to. The rectangle is relative to the + * window geometry as defined by xdg_surface.set_window_geometry of the + * parent surface. + * + * When the xdg_positioner object is used to position a child surface, the + * anchor rectangle may not extend outside the window geometry of the + * positioned child's parent surface. + * + * If a negative size is set the invalid_input error is raised. + */ +static inline void +xdg_positioner_set_anchor_rect(struct xdg_positioner *xdg_positioner, int32_t x, int32_t y, int32_t width, int32_t height) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_positioner, + XDG_POSITIONER_SET_ANCHOR_RECT, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_positioner), 0, x, y, width, height); +} + +/** + * @ingroup iface_xdg_positioner + * + * Defines the anchor point for the anchor rectangle. The specified anchor + * is used derive an anchor point that the child surface will be + * positioned relative to. If a corner anchor is set (e.g. 'top_left' or + * 'bottom_right'), the anchor point will be at the specified corner; + * otherwise, the derived anchor point will be centered on the specified + * edge, or in the center of the anchor rectangle if no edge is specified. + */ +static inline void +xdg_positioner_set_anchor(struct xdg_positioner *xdg_positioner, uint32_t anchor) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_positioner, + XDG_POSITIONER_SET_ANCHOR, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_positioner), 0, anchor); +} + +/** + * @ingroup iface_xdg_positioner + * + * Defines in what direction a surface should be positioned, relative to + * the anchor point of the parent surface. If a corner gravity is + * specified (e.g. 'bottom_right' or 'top_left'), then the child surface + * will be placed towards the specified gravity; otherwise, the child + * surface will be centered over the anchor point on any axis that had no + * gravity specified. If the gravity is not in the ‘gravity’ enum, an + * invalid_input error is raised. + */ +static inline void +xdg_positioner_set_gravity(struct xdg_positioner *xdg_positioner, uint32_t gravity) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_positioner, + XDG_POSITIONER_SET_GRAVITY, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_positioner), 0, gravity); +} + +/** + * @ingroup iface_xdg_positioner + * + * Specify how the window should be positioned if the originally intended + * position caused the surface to be constrained, meaning at least + * partially outside positioning boundaries set by the compositor. The + * adjustment is set by constructing a bitmask describing the adjustment to + * be made when the surface is constrained on that axis. + * + * If no bit for one axis is set, the compositor will assume that the child + * surface should not change its position on that axis when constrained. + * + * If more than one bit for one axis is set, the order of how adjustments + * are applied is specified in the corresponding adjustment descriptions. + * + * The default adjustment is none. + */ +static inline void +xdg_positioner_set_constraint_adjustment(struct xdg_positioner *xdg_positioner, uint32_t constraint_adjustment) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_positioner, + XDG_POSITIONER_SET_CONSTRAINT_ADJUSTMENT, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_positioner), 0, constraint_adjustment); +} + +/** + * @ingroup iface_xdg_positioner + * + * Specify the surface position offset relative to the position of the + * anchor on the anchor rectangle and the anchor on the surface. For + * example if the anchor of the anchor rectangle is at (x, y), the surface + * has the gravity bottom|right, and the offset is (ox, oy), the calculated + * surface position will be (x + ox, y + oy). The offset position of the + * surface is the one used for constraint testing. See + * set_constraint_adjustment. + * + * An example use case is placing a popup menu on top of a user interface + * element, while aligning the user interface element of the parent surface + * with some user interface element placed somewhere in the popup surface. + */ +static inline void +xdg_positioner_set_offset(struct xdg_positioner *xdg_positioner, int32_t x, int32_t y) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_positioner, + XDG_POSITIONER_SET_OFFSET, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_positioner), 0, x, y); +} + +/** + * @ingroup iface_xdg_positioner + * + * When set reactive, the surface is reconstrained if the conditions used + * for constraining changed, e.g. the parent window moved. + * + * If the conditions changed and the popup was reconstrained, an + * xdg_popup.configure event is sent with updated geometry, followed by an + * xdg_surface.configure event. + */ +static inline void +xdg_positioner_set_reactive(struct xdg_positioner *xdg_positioner) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_positioner, + XDG_POSITIONER_SET_REACTIVE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_positioner), 0); +} + +/** + * @ingroup iface_xdg_positioner + * + * Set the parent window geometry the compositor should use when + * positioning the popup. The compositor may use this information to + * determine the future state the popup should be constrained using. If + * this doesn't match the dimension of the parent the popup is eventually + * positioned against, the behavior is undefined. + * + * The arguments are given in the surface-local coordinate space. + */ +static inline void +xdg_positioner_set_parent_size(struct xdg_positioner *xdg_positioner, int32_t parent_width, int32_t parent_height) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_positioner, + XDG_POSITIONER_SET_PARENT_SIZE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_positioner), 0, parent_width, parent_height); +} + +/** + * @ingroup iface_xdg_positioner + * + * Set the serial of an xdg_surface.configure event this positioner will be + * used in response to. The compositor may use this information together + * with set_parent_size to determine what future state the popup should be + * constrained using. + */ +static inline void +xdg_positioner_set_parent_configure(struct xdg_positioner *xdg_positioner, uint32_t serial) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_positioner, + XDG_POSITIONER_SET_PARENT_CONFIGURE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_positioner), 0, serial); +} + +#ifndef XDG_SURFACE_ERROR_ENUM +#define XDG_SURFACE_ERROR_ENUM +enum xdg_surface_error { + /** + * Surface was not fully constructed + */ + XDG_SURFACE_ERROR_NOT_CONSTRUCTED = 1, + /** + * Surface was already constructed + */ + XDG_SURFACE_ERROR_ALREADY_CONSTRUCTED = 2, + /** + * Attaching a buffer to an unconfigured surface + */ + XDG_SURFACE_ERROR_UNCONFIGURED_BUFFER = 3, + /** + * Invalid serial number when acking a configure event + */ + XDG_SURFACE_ERROR_INVALID_SERIAL = 4, + /** + * Width or height was zero or negative + */ + XDG_SURFACE_ERROR_INVALID_SIZE = 5, + /** + * Surface was destroyed before its role object + */ + XDG_SURFACE_ERROR_DEFUNCT_ROLE_OBJECT = 6, +}; +#endif /* XDG_SURFACE_ERROR_ENUM */ + +/** + * @ingroup iface_xdg_surface + * @struct xdg_surface_listener + */ +struct xdg_surface_listener { + /** + * suggest a surface change + * + * The configure event marks the end of a configure sequence. A + * configure sequence is a set of one or more events configuring + * the state of the xdg_surface, including the final + * xdg_surface.configure event. + * + * Where applicable, xdg_surface surface roles will during a + * configure sequence extend this event as a latched state sent as + * events before the xdg_surface.configure event. Such events + * should be considered to make up a set of atomically applied + * configuration states, where the xdg_surface.configure commits + * the accumulated state. + * + * Clients should arrange their surface for the new states, and + * then send an ack_configure request with the serial sent in this + * configure event at some point before committing the new surface. + * + * If the client receives multiple configure events before it can + * respond to one, it is free to discard all but the last event it + * received. + * @param serial serial of the configure event + */ + void (*configure)(void *data, + struct xdg_surface *xdg_surface, + uint32_t serial); +}; + +/** + * @ingroup iface_xdg_surface + */ +static inline int +xdg_surface_add_listener(struct xdg_surface *xdg_surface, + const struct xdg_surface_listener *listener, void *data) +{ + return wl_proxy_add_listener((struct wl_proxy *) xdg_surface, + (void (**)(void)) listener, data); +} + +#define XDG_SURFACE_DESTROY 0 +#define XDG_SURFACE_GET_TOPLEVEL 1 +#define XDG_SURFACE_GET_POPUP 2 +#define XDG_SURFACE_SET_WINDOW_GEOMETRY 3 +#define XDG_SURFACE_ACK_CONFIGURE 4 + +/** + * @ingroup iface_xdg_surface + */ +#define XDG_SURFACE_CONFIGURE_SINCE_VERSION 1 + +/** + * @ingroup iface_xdg_surface + */ +#define XDG_SURFACE_DESTROY_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_surface + */ +#define XDG_SURFACE_GET_TOPLEVEL_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_surface + */ +#define XDG_SURFACE_GET_POPUP_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_surface + */ +#define XDG_SURFACE_SET_WINDOW_GEOMETRY_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_surface + */ +#define XDG_SURFACE_ACK_CONFIGURE_SINCE_VERSION 1 + +/** @ingroup iface_xdg_surface */ +static inline void +xdg_surface_set_user_data(struct xdg_surface *xdg_surface, void *user_data) +{ + wl_proxy_set_user_data((struct wl_proxy *) xdg_surface, user_data); +} + +/** @ingroup iface_xdg_surface */ +static inline void * +xdg_surface_get_user_data(struct xdg_surface *xdg_surface) +{ + return wl_proxy_get_user_data((struct wl_proxy *) xdg_surface); +} + +static inline uint32_t +xdg_surface_get_version(struct xdg_surface *xdg_surface) +{ + return wl_proxy_get_version((struct wl_proxy *) xdg_surface); +} + +/** + * @ingroup iface_xdg_surface + * + * Destroy the xdg_surface object. An xdg_surface must only be destroyed + * after its role object has been destroyed, otherwise + * a defunct_role_object error is raised. + */ +static inline void +xdg_surface_destroy(struct xdg_surface *xdg_surface) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_surface, + XDG_SURFACE_DESTROY, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_surface), WL_MARSHAL_FLAG_DESTROY); +} + +/** + * @ingroup iface_xdg_surface + * + * This creates an xdg_toplevel object for the given xdg_surface and gives + * the associated wl_surface the xdg_toplevel role. + * + * See the documentation of xdg_toplevel for more details about what an + * xdg_toplevel is and how it is used. + */ +static inline struct xdg_toplevel * +xdg_surface_get_toplevel(struct xdg_surface *xdg_surface) +{ + struct wl_proxy *id; + + id = wl_proxy_marshal_flags((struct wl_proxy *) xdg_surface, + XDG_SURFACE_GET_TOPLEVEL, &xdg_toplevel_interface, wl_proxy_get_version((struct wl_proxy *) xdg_surface), 0, NULL); + + return (struct xdg_toplevel *) id; +} + +/** + * @ingroup iface_xdg_surface + * + * This creates an xdg_popup object for the given xdg_surface and gives + * the associated wl_surface the xdg_popup role. + * + * If null is passed as a parent, a parent surface must be specified using + * some other protocol, before committing the initial state. + * + * See the documentation of xdg_popup for more details about what an + * xdg_popup is and how it is used. + */ +static inline struct xdg_popup * +xdg_surface_get_popup(struct xdg_surface *xdg_surface, struct xdg_surface *parent, struct xdg_positioner *positioner) +{ + struct wl_proxy *id; + + id = wl_proxy_marshal_flags((struct wl_proxy *) xdg_surface, + XDG_SURFACE_GET_POPUP, &xdg_popup_interface, wl_proxy_get_version((struct wl_proxy *) xdg_surface), 0, NULL, parent, positioner); + + return (struct xdg_popup *) id; +} + +/** + * @ingroup iface_xdg_surface + * + * The window geometry of a surface is its "visible bounds" from the + * user's perspective. Client-side decorations often have invisible + * portions like drop-shadows which should be ignored for the + * purposes of aligning, placing and constraining windows. + * + * The window geometry is double-buffered state, see wl_surface.commit. + * + * When maintaining a position, the compositor should treat the (x, y) + * coordinate of the window geometry as the top left corner of the window. + * A client changing the (x, y) window geometry coordinate should in + * general not alter the position of the window. + * + * Once the window geometry of the surface is set, it is not possible to + * unset it, and it will remain the same until set_window_geometry is + * called again, even if a new subsurface or buffer is attached. + * + * If never set, the value is the full bounds of the surface, + * including any subsurfaces. This updates dynamically on every + * commit. This unset is meant for extremely simple clients. + * + * The arguments are given in the surface-local coordinate space of + * the wl_surface associated with this xdg_surface, and may extend outside + * of the wl_surface itself to mark parts of the subsurface tree as part of + * the window geometry. + * + * When applied, the effective window geometry will be the set window + * geometry clamped to the bounding rectangle of the combined + * geometry of the surface of the xdg_surface and the associated + * subsurfaces. + * + * The effective geometry will not be recalculated unless a new call to + * set_window_geometry is done and the new pending surface state is + * subsequently applied. + * + * The width and height of the effective window geometry must be + * greater than zero. Setting an invalid size will raise an + * invalid_size error. + */ +static inline void +xdg_surface_set_window_geometry(struct xdg_surface *xdg_surface, int32_t x, int32_t y, int32_t width, int32_t height) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_surface, + XDG_SURFACE_SET_WINDOW_GEOMETRY, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_surface), 0, x, y, width, height); +} + +/** + * @ingroup iface_xdg_surface + * + * When a configure event is received, if a client commits the + * surface in response to the configure event, then the client + * must make an ack_configure request sometime before the commit + * request, passing along the serial of the configure event. + * + * For instance, for toplevel surfaces the compositor might use this + * information to move a surface to the top left only when the client has + * drawn itself for the maximized or fullscreen state. + * + * If the client receives multiple configure events before it + * can respond to one, it only has to ack the last configure event. + * Acking a configure event that was never sent raises an invalid_serial + * error. + * + * A client is not required to commit immediately after sending + * an ack_configure request - it may even ack_configure several times + * before its next surface commit. + * + * A client may send multiple ack_configure requests before committing, but + * only the last request sent before a commit indicates which configure + * event the client really is responding to. + * + * Sending an ack_configure request consumes the serial number sent with + * the request, as well as serial numbers sent by all configure events + * sent on this xdg_surface prior to the configure event referenced by + * the committed serial. + * + * It is an error to issue multiple ack_configure requests referencing a + * serial from the same configure event, or to issue an ack_configure + * request referencing a serial from a configure event issued before the + * event identified by the last ack_configure request for the same + * xdg_surface. Doing so will raise an invalid_serial error. + */ +static inline void +xdg_surface_ack_configure(struct xdg_surface *xdg_surface, uint32_t serial) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_surface, + XDG_SURFACE_ACK_CONFIGURE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_surface), 0, serial); +} + +#ifndef XDG_TOPLEVEL_ERROR_ENUM +#define XDG_TOPLEVEL_ERROR_ENUM +enum xdg_toplevel_error { + /** + * provided value is not a valid variant of the resize_edge enum + */ + XDG_TOPLEVEL_ERROR_INVALID_RESIZE_EDGE = 0, + /** + * invalid parent toplevel + */ + XDG_TOPLEVEL_ERROR_INVALID_PARENT = 1, + /** + * client provided an invalid min or max size + */ + XDG_TOPLEVEL_ERROR_INVALID_SIZE = 2, +}; +#endif /* XDG_TOPLEVEL_ERROR_ENUM */ + +#ifndef XDG_TOPLEVEL_RESIZE_EDGE_ENUM +#define XDG_TOPLEVEL_RESIZE_EDGE_ENUM +/** + * @ingroup iface_xdg_toplevel + * edge values for resizing + * + * These values are used to indicate which edge of a surface + * is being dragged in a resize operation. + */ +enum xdg_toplevel_resize_edge { + XDG_TOPLEVEL_RESIZE_EDGE_NONE = 0, + XDG_TOPLEVEL_RESIZE_EDGE_TOP = 1, + XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM = 2, + XDG_TOPLEVEL_RESIZE_EDGE_LEFT = 4, + XDG_TOPLEVEL_RESIZE_EDGE_TOP_LEFT = 5, + XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_LEFT = 6, + XDG_TOPLEVEL_RESIZE_EDGE_RIGHT = 8, + XDG_TOPLEVEL_RESIZE_EDGE_TOP_RIGHT = 9, + XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_RIGHT = 10, +}; +#endif /* XDG_TOPLEVEL_RESIZE_EDGE_ENUM */ + +#ifndef XDG_TOPLEVEL_STATE_ENUM +#define XDG_TOPLEVEL_STATE_ENUM +/** + * @ingroup iface_xdg_toplevel + * types of state on the surface + * + * The different state values used on the surface. This is designed for + * state values like maximized, fullscreen. It is paired with the + * configure event to ensure that both the client and the compositor + * setting the state can be synchronized. + * + * States set in this way are double-buffered, see wl_surface.commit. + */ +enum xdg_toplevel_state { + /** + * the surface is maximized + * the surface is maximized + * + * The surface is maximized. The window geometry specified in the + * configure event must be obeyed by the client, or the + * xdg_wm_base.invalid_surface_state error is raised. + * + * The client should draw without shadow or other decoration + * outside of the window geometry. + */ + XDG_TOPLEVEL_STATE_MAXIMIZED = 1, + /** + * the surface is fullscreen + * the surface is fullscreen + * + * The surface is fullscreen. The window geometry specified in + * the configure event is a maximum; the client cannot resize + * beyond it. For a surface to cover the whole fullscreened area, + * the geometry dimensions must be obeyed by the client. For more + * details, see xdg_toplevel.set_fullscreen. + */ + XDG_TOPLEVEL_STATE_FULLSCREEN = 2, + /** + * the surface is being resized + * the surface is being resized + * + * The surface is being resized. The window geometry specified in + * the configure event is a maximum; the client cannot resize + * beyond it. Clients that have aspect ratio or cell sizing + * configuration can use a smaller size, however. + */ + XDG_TOPLEVEL_STATE_RESIZING = 3, + /** + * the surface is now activated + * the surface is now activated + * + * Client window decorations should be painted as if the window + * is active. Do not assume this means that the window actually has + * keyboard or pointer focus. + */ + XDG_TOPLEVEL_STATE_ACTIVATED = 4, + /** + * the surface’s left edge is tiled + * + * The window is currently in a tiled layout and the left edge is + * considered to be adjacent to another part of the tiling grid. + * + * The client should draw without shadow or other decoration + * outside of the window geometry on the left edge. + * @since 2 + */ + XDG_TOPLEVEL_STATE_TILED_LEFT = 5, + /** + * the surface’s right edge is tiled + * + * The window is currently in a tiled layout and the right edge + * is considered to be adjacent to another part of the tiling grid. + * + * The client should draw without shadow or other decoration + * outside of the window geometry on the right edge. + * @since 2 + */ + XDG_TOPLEVEL_STATE_TILED_RIGHT = 6, + /** + * the surface’s top edge is tiled + * + * The window is currently in a tiled layout and the top edge is + * considered to be adjacent to another part of the tiling grid. + * + * The client should draw without shadow or other decoration + * outside of the window geometry on the top edge. + * @since 2 + */ + XDG_TOPLEVEL_STATE_TILED_TOP = 7, + /** + * the surface’s bottom edge is tiled + * + * The window is currently in a tiled layout and the bottom edge + * is considered to be adjacent to another part of the tiling grid. + * + * The client should draw without shadow or other decoration + * outside of the window geometry on the bottom edge. + * @since 2 + */ + XDG_TOPLEVEL_STATE_TILED_BOTTOM = 8, + /** + * surface repaint is suspended + * + * The surface is currently not ordinarily being repainted; for + * example because its content is occluded by another window, or + * its outputs are switched off due to screen locking. + * @since 6 + */ + XDG_TOPLEVEL_STATE_SUSPENDED = 9, +}; +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_STATE_TILED_LEFT_SINCE_VERSION 2 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_STATE_TILED_RIGHT_SINCE_VERSION 2 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_STATE_TILED_TOP_SINCE_VERSION 2 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_STATE_TILED_BOTTOM_SINCE_VERSION 2 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_STATE_SUSPENDED_SINCE_VERSION 6 +#endif /* XDG_TOPLEVEL_STATE_ENUM */ + +#ifndef XDG_TOPLEVEL_WM_CAPABILITIES_ENUM +#define XDG_TOPLEVEL_WM_CAPABILITIES_ENUM +enum xdg_toplevel_wm_capabilities { + /** + * show_window_menu is available + */ + XDG_TOPLEVEL_WM_CAPABILITIES_WINDOW_MENU = 1, + /** + * set_maximized and unset_maximized are available + */ + XDG_TOPLEVEL_WM_CAPABILITIES_MAXIMIZE = 2, + /** + * set_fullscreen and unset_fullscreen are available + */ + XDG_TOPLEVEL_WM_CAPABILITIES_FULLSCREEN = 3, + /** + * set_minimized is available + */ + XDG_TOPLEVEL_WM_CAPABILITIES_MINIMIZE = 4, +}; +#endif /* XDG_TOPLEVEL_WM_CAPABILITIES_ENUM */ + +/** + * @ingroup iface_xdg_toplevel + * @struct xdg_toplevel_listener + */ +struct xdg_toplevel_listener { + /** + * suggest a surface change + * + * This configure event asks the client to resize its toplevel + * surface or to change its state. The configured state should not + * be applied immediately. See xdg_surface.configure for details. + * + * The width and height arguments specify a hint to the window + * about how its surface should be resized in window geometry + * coordinates. See set_window_geometry. + * + * If the width or height arguments are zero, it means the client + * should decide its own window dimension. This may happen when the + * compositor needs to configure the state of the surface but + * doesn't have any information about any previous or expected + * dimension. + * + * The states listed in the event specify how the width/height + * arguments should be interpreted, and possibly how it should be + * drawn. + * + * Clients must send an ack_configure in response to this event. + * See xdg_surface.configure and xdg_surface.ack_configure for + * details. + */ + void (*configure)(void *data, + struct xdg_toplevel *xdg_toplevel, + int32_t width, + int32_t height, + struct wl_array *states); + /** + * surface wants to be closed + * + * The close event is sent by the compositor when the user wants + * the surface to be closed. This should be equivalent to the user + * clicking the close button in client-side decorations, if your + * application has any. + * + * This is only a request that the user intends to close the + * window. The client may choose to ignore this request, or show a + * dialog to ask the user to save their data, etc. + */ + void (*close)(void *data, + struct xdg_toplevel *xdg_toplevel); + /** + * recommended window geometry bounds + * + * The configure_bounds event may be sent prior to a + * xdg_toplevel.configure event to communicate the bounds a window + * geometry size is recommended to constrain to. + * + * The passed width and height are in surface coordinate space. If + * width and height are 0, it means bounds is unknown and + * equivalent to as if no configure_bounds event was ever sent for + * this surface. + * + * The bounds can for example correspond to the size of a monitor + * excluding any panels or other shell components, so that a + * surface isn't created in a way that it cannot fit. + * + * The bounds may change at any point, and in such a case, a new + * xdg_toplevel.configure_bounds will be sent, followed by + * xdg_toplevel.configure and xdg_surface.configure. + * @since 4 + */ + void (*configure_bounds)(void *data, + struct xdg_toplevel *xdg_toplevel, + int32_t width, + int32_t height); + /** + * compositor capabilities + * + * This event advertises the capabilities supported by the + * compositor. If a capability isn't supported, clients should hide + * or disable the UI elements that expose this functionality. For + * instance, if the compositor doesn't advertise support for + * minimized toplevels, a button triggering the set_minimized + * request should not be displayed. + * + * The compositor will ignore requests it doesn't support. For + * instance, a compositor which doesn't advertise support for + * minimized will ignore set_minimized requests. + * + * Compositors must send this event once before the first + * xdg_surface.configure event. When the capabilities change, + * compositors must send this event again and then send an + * xdg_surface.configure event. + * + * The configured state should not be applied immediately. See + * xdg_surface.configure for details. + * + * The capabilities are sent as an array of 32-bit unsigned + * integers in native endianness. + * @param capabilities array of 32-bit capabilities + * @since 5 + */ + void (*wm_capabilities)(void *data, + struct xdg_toplevel *xdg_toplevel, + struct wl_array *capabilities); +}; + +/** + * @ingroup iface_xdg_toplevel + */ +static inline int +xdg_toplevel_add_listener(struct xdg_toplevel *xdg_toplevel, + const struct xdg_toplevel_listener *listener, void *data) +{ + return wl_proxy_add_listener((struct wl_proxy *) xdg_toplevel, + (void (**)(void)) listener, data); +} + +#define XDG_TOPLEVEL_DESTROY 0 +#define XDG_TOPLEVEL_SET_PARENT 1 +#define XDG_TOPLEVEL_SET_TITLE 2 +#define XDG_TOPLEVEL_SET_APP_ID 3 +#define XDG_TOPLEVEL_SHOW_WINDOW_MENU 4 +#define XDG_TOPLEVEL_MOVE 5 +#define XDG_TOPLEVEL_RESIZE 6 +#define XDG_TOPLEVEL_SET_MAX_SIZE 7 +#define XDG_TOPLEVEL_SET_MIN_SIZE 8 +#define XDG_TOPLEVEL_SET_MAXIMIZED 9 +#define XDG_TOPLEVEL_UNSET_MAXIMIZED 10 +#define XDG_TOPLEVEL_SET_FULLSCREEN 11 +#define XDG_TOPLEVEL_UNSET_FULLSCREEN 12 +#define XDG_TOPLEVEL_SET_MINIMIZED 13 + +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_CONFIGURE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_CLOSE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_CONFIGURE_BOUNDS_SINCE_VERSION 4 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_WM_CAPABILITIES_SINCE_VERSION 5 + +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_DESTROY_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_SET_PARENT_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_SET_TITLE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_SET_APP_ID_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_SHOW_WINDOW_MENU_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_MOVE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_RESIZE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_SET_MAX_SIZE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_SET_MIN_SIZE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_SET_MAXIMIZED_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_UNSET_MAXIMIZED_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_SET_FULLSCREEN_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_UNSET_FULLSCREEN_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel + */ +#define XDG_TOPLEVEL_SET_MINIMIZED_SINCE_VERSION 1 + +/** @ingroup iface_xdg_toplevel */ +static inline void +xdg_toplevel_set_user_data(struct xdg_toplevel *xdg_toplevel, void *user_data) +{ + wl_proxy_set_user_data((struct wl_proxy *) xdg_toplevel, user_data); +} + +/** @ingroup iface_xdg_toplevel */ +static inline void * +xdg_toplevel_get_user_data(struct xdg_toplevel *xdg_toplevel) +{ + return wl_proxy_get_user_data((struct wl_proxy *) xdg_toplevel); +} + +static inline uint32_t +xdg_toplevel_get_version(struct xdg_toplevel *xdg_toplevel) +{ + return wl_proxy_get_version((struct wl_proxy *) xdg_toplevel); +} + +/** + * @ingroup iface_xdg_toplevel + * + * This request destroys the role surface and unmaps the surface; + * see "Unmapping" behavior in interface section for details. + */ +static inline void +xdg_toplevel_destroy(struct xdg_toplevel *xdg_toplevel) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_DESTROY, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), WL_MARSHAL_FLAG_DESTROY); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Set the "parent" of this surface. This surface should be stacked + * above the parent surface and all other ancestor surfaces. + * + * Parent surfaces should be set on dialogs, toolboxes, or other + * "auxiliary" surfaces, so that the parent is raised when the dialog + * is raised. + * + * Setting a null parent for a child surface unsets its parent. Setting + * a null parent for a surface which currently has no parent is a no-op. + * + * Only mapped surfaces can have child surfaces. Setting a parent which + * is not mapped is equivalent to setting a null parent. If a surface + * becomes unmapped, its children's parent is set to the parent of + * the now-unmapped surface. If the now-unmapped surface has no parent, + * its children's parent is unset. If the now-unmapped surface becomes + * mapped again, its parent-child relationship is not restored. + * + * The parent toplevel must not be one of the child toplevel's + * descendants, and the parent must be different from the child toplevel, + * otherwise the invalid_parent protocol error is raised. + */ +static inline void +xdg_toplevel_set_parent(struct xdg_toplevel *xdg_toplevel, struct xdg_toplevel *parent) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_SET_PARENT, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, parent); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Set a short title for the surface. + * + * This string may be used to identify the surface in a task bar, + * window list, or other user interface elements provided by the + * compositor. + * + * The string must be encoded in UTF-8. + */ +static inline void +xdg_toplevel_set_title(struct xdg_toplevel *xdg_toplevel, const char *title) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_SET_TITLE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, title); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Set an application identifier for the surface. + * + * The app ID identifies the general class of applications to which + * the surface belongs. The compositor can use this to group multiple + * surfaces together, or to determine how to launch a new application. + * + * For D-Bus activatable applications, the app ID is used as the D-Bus + * service name. + * + * The compositor shell will try to group application surfaces together + * by their app ID. As a best practice, it is suggested to select app + * ID's that match the basename of the application's .desktop file. + * For example, "org.freedesktop.FooViewer" where the .desktop file is + * "org.freedesktop.FooViewer.desktop". + * + * Like other properties, a set_app_id request can be sent after the + * xdg_toplevel has been mapped to update the property. + * + * See the desktop-entry specification [0] for more details on + * application identifiers and how they relate to well-known D-Bus + * names and .desktop files. + * + * [0] https://standards.freedesktop.org/desktop-entry-spec/ + */ +static inline void +xdg_toplevel_set_app_id(struct xdg_toplevel *xdg_toplevel, const char *app_id) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_SET_APP_ID, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, app_id); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Clients implementing client-side decorations might want to show + * a context menu when right-clicking on the decorations, giving the + * user a menu that they can use to maximize or minimize the window. + * + * This request asks the compositor to pop up such a window menu at + * the given position, relative to the local surface coordinates of + * the parent surface. There are no guarantees as to what menu items + * the window menu contains, or even if a window menu will be drawn + * at all. + * + * This request must be used in response to some sort of user action + * like a button press, key press, or touch down event. + */ +static inline void +xdg_toplevel_show_window_menu(struct xdg_toplevel *xdg_toplevel, struct wl_seat *seat, uint32_t serial, int32_t x, int32_t y) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_SHOW_WINDOW_MENU, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, seat, serial, x, y); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Start an interactive, user-driven move of the surface. + * + * This request must be used in response to some sort of user action + * like a button press, key press, or touch down event. The passed + * serial is used to determine the type of interactive move (touch, + * pointer, etc). + * + * The server may ignore move requests depending on the state of + * the surface (e.g. fullscreen or maximized), or if the passed serial + * is no longer valid. + * + * If triggered, the surface will lose the focus of the device + * (wl_pointer, wl_touch, etc) used for the move. It is up to the + * compositor to visually indicate that the move is taking place, such as + * updating a pointer cursor, during the move. There is no guarantee + * that the device focus will return when the move is completed. + */ +static inline void +xdg_toplevel_move(struct xdg_toplevel *xdg_toplevel, struct wl_seat *seat, uint32_t serial) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_MOVE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, seat, serial); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Start a user-driven, interactive resize of the surface. + * + * This request must be used in response to some sort of user action + * like a button press, key press, or touch down event. The passed + * serial is used to determine the type of interactive resize (touch, + * pointer, etc). + * + * The server may ignore resize requests depending on the state of + * the surface (e.g. fullscreen or maximized). + * + * If triggered, the client will receive configure events with the + * "resize" state enum value and the expected sizes. See the "resize" + * enum value for more details about what is required. The client + * must also acknowledge configure events using "ack_configure". After + * the resize is completed, the client will receive another "configure" + * event without the resize state. + * + * If triggered, the surface also will lose the focus of the device + * (wl_pointer, wl_touch, etc) used for the resize. It is up to the + * compositor to visually indicate that the resize is taking place, + * such as updating a pointer cursor, during the resize. There is no + * guarantee that the device focus will return when the resize is + * completed. + * + * The edges parameter specifies how the surface should be resized, and + * is one of the values of the resize_edge enum. Values not matching + * a variant of the enum will cause the invalid_resize_edge protocol error. + * The compositor may use this information to update the surface position + * for example when dragging the top left corner. The compositor may also + * use this information to adapt its behavior, e.g. choose an appropriate + * cursor image. + */ +static inline void +xdg_toplevel_resize(struct xdg_toplevel *xdg_toplevel, struct wl_seat *seat, uint32_t serial, uint32_t edges) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_RESIZE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, seat, serial, edges); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Set a maximum size for the window. + * + * The client can specify a maximum size so that the compositor does + * not try to configure the window beyond this size. + * + * The width and height arguments are in window geometry coordinates. + * See xdg_surface.set_window_geometry. + * + * Values set in this way are double-buffered, see wl_surface.commit. + * + * The compositor can use this information to allow or disallow + * different states like maximize or fullscreen and draw accurate + * animations. + * + * Similarly, a tiling window manager may use this information to + * place and resize client windows in a more effective way. + * + * The client should not rely on the compositor to obey the maximum + * size. The compositor may decide to ignore the values set by the + * client and request a larger size. + * + * If never set, or a value of zero in the request, means that the + * client has no expected maximum size in the given dimension. + * As a result, a client wishing to reset the maximum size + * to an unspecified state can use zero for width and height in the + * request. + * + * Requesting a maximum size to be smaller than the minimum size of + * a surface is illegal and will result in an invalid_size error. + * + * The width and height must be greater than or equal to zero. Using + * strictly negative values for width or height will result in a + * invalid_size error. + */ +static inline void +xdg_toplevel_set_max_size(struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_SET_MAX_SIZE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, width, height); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Set a minimum size for the window. + * + * The client can specify a minimum size so that the compositor does + * not try to configure the window below this size. + * + * The width and height arguments are in window geometry coordinates. + * See xdg_surface.set_window_geometry. + * + * Values set in this way are double-buffered, see wl_surface.commit. + * + * The compositor can use this information to allow or disallow + * different states like maximize or fullscreen and draw accurate + * animations. + * + * Similarly, a tiling window manager may use this information to + * place and resize client windows in a more effective way. + * + * The client should not rely on the compositor to obey the minimum + * size. The compositor may decide to ignore the values set by the + * client and request a smaller size. + * + * If never set, or a value of zero in the request, means that the + * client has no expected minimum size in the given dimension. + * As a result, a client wishing to reset the minimum size + * to an unspecified state can use zero for width and height in the + * request. + * + * Requesting a minimum size to be larger than the maximum size of + * a surface is illegal and will result in an invalid_size error. + * + * The width and height must be greater than or equal to zero. Using + * strictly negative values for width and height will result in a + * invalid_size error. + */ +static inline void +xdg_toplevel_set_min_size(struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_SET_MIN_SIZE, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, width, height); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Maximize the surface. + * + * After requesting that the surface should be maximized, the compositor + * will respond by emitting a configure event. Whether this configure + * actually sets the window maximized is subject to compositor policies. + * The client must then update its content, drawing in the configured + * state. The client must also acknowledge the configure when committing + * the new content (see ack_configure). + * + * It is up to the compositor to decide how and where to maximize the + * surface, for example which output and what region of the screen should + * be used. + * + * If the surface was already maximized, the compositor will still emit + * a configure event with the "maximized" state. + * + * If the surface is in a fullscreen state, this request has no direct + * effect. It may alter the state the surface is returned to when + * unmaximized unless overridden by the compositor. + */ +static inline void +xdg_toplevel_set_maximized(struct xdg_toplevel *xdg_toplevel) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_SET_MAXIMIZED, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Unmaximize the surface. + * + * After requesting that the surface should be unmaximized, the compositor + * will respond by emitting a configure event. Whether this actually + * un-maximizes the window is subject to compositor policies. + * If available and applicable, the compositor will include the window + * geometry dimensions the window had prior to being maximized in the + * configure event. The client must then update its content, drawing it in + * the configured state. The client must also acknowledge the configure + * when committing the new content (see ack_configure). + * + * It is up to the compositor to position the surface after it was + * unmaximized; usually the position the surface had before maximizing, if + * applicable. + * + * If the surface was already not maximized, the compositor will still + * emit a configure event without the "maximized" state. + * + * If the surface is in a fullscreen state, this request has no direct + * effect. It may alter the state the surface is returned to when + * unmaximized unless overridden by the compositor. + */ +static inline void +xdg_toplevel_unset_maximized(struct xdg_toplevel *xdg_toplevel) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_UNSET_MAXIMIZED, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Make the surface fullscreen. + * + * After requesting that the surface should be fullscreened, the + * compositor will respond by emitting a configure event. Whether the + * client is actually put into a fullscreen state is subject to compositor + * policies. The client must also acknowledge the configure when + * committing the new content (see ack_configure). + * + * The output passed by the request indicates the client's preference as + * to which display it should be set fullscreen on. If this value is NULL, + * it's up to the compositor to choose which display will be used to map + * this surface. + * + * If the surface doesn't cover the whole output, the compositor will + * position the surface in the center of the output and compensate with + * with border fill covering the rest of the output. The content of the + * border fill is undefined, but should be assumed to be in some way that + * attempts to blend into the surrounding area (e.g. solid black). + * + * If the fullscreened surface is not opaque, the compositor must make + * sure that other screen content not part of the same surface tree (made + * up of subsurfaces, popups or similarly coupled surfaces) are not + * visible below the fullscreened surface. + */ +static inline void +xdg_toplevel_set_fullscreen(struct xdg_toplevel *xdg_toplevel, struct wl_output *output) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_SET_FULLSCREEN, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0, output); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Make the surface no longer fullscreen. + * + * After requesting that the surface should be unfullscreened, the + * compositor will respond by emitting a configure event. + * Whether this actually removes the fullscreen state of the client is + * subject to compositor policies. + * + * Making a surface unfullscreen sets states for the surface based on the following: + * * the state(s) it may have had before becoming fullscreen + * * any state(s) decided by the compositor + * * any state(s) requested by the client while the surface was fullscreen + * + * The compositor may include the previous window geometry dimensions in + * the configure event, if applicable. + * + * The client must also acknowledge the configure when committing the new + * content (see ack_configure). + */ +static inline void +xdg_toplevel_unset_fullscreen(struct xdg_toplevel *xdg_toplevel) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_UNSET_FULLSCREEN, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0); +} + +/** + * @ingroup iface_xdg_toplevel + * + * Request that the compositor minimize your surface. There is no + * way to know if the surface is currently minimized, nor is there + * any way to unset minimization on this surface. + * + * If you are looking to throttle redrawing when minimized, please + * instead use the wl_surface.frame event for this, as this will + * also work with live previews on windows in Alt-Tab, Expose or + * similar compositor features. + */ +static inline void +xdg_toplevel_set_minimized(struct xdg_toplevel *xdg_toplevel) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel, + XDG_TOPLEVEL_SET_MINIMIZED, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel), 0); +} + +#ifndef XDG_POPUP_ERROR_ENUM +#define XDG_POPUP_ERROR_ENUM +enum xdg_popup_error { + /** + * tried to grab after being mapped + */ + XDG_POPUP_ERROR_INVALID_GRAB = 0, +}; +#endif /* XDG_POPUP_ERROR_ENUM */ + +/** + * @ingroup iface_xdg_popup + * @struct xdg_popup_listener + */ +struct xdg_popup_listener { + /** + * configure the popup surface + * + * This event asks the popup surface to configure itself given + * the configuration. The configured state should not be applied + * immediately. See xdg_surface.configure for details. + * + * The x and y arguments represent the position the popup was + * placed at given the xdg_positioner rule, relative to the upper + * left corner of the window geometry of the parent surface. + * + * For version 2 or older, the configure event for an xdg_popup is + * only ever sent once for the initial configuration. Starting with + * version 3, it may be sent again if the popup is setup with an + * xdg_positioner with set_reactive requested, or in response to + * xdg_popup.reposition requests. + * @param x x position relative to parent surface window geometry + * @param y y position relative to parent surface window geometry + * @param width window geometry width + * @param height window geometry height + */ + void (*configure)(void *data, + struct xdg_popup *xdg_popup, + int32_t x, + int32_t y, + int32_t width, + int32_t height); + /** + * popup interaction is done + * + * The popup_done event is sent out when a popup is dismissed by + * the compositor. The client should destroy the xdg_popup object + * at this point. + */ + void (*popup_done)(void *data, + struct xdg_popup *xdg_popup); + /** + * signal the completion of a repositioned request + * + * The repositioned event is sent as part of a popup + * configuration sequence, together with xdg_popup.configure and + * lastly xdg_surface.configure to notify the completion of a + * reposition request. + * + * The repositioned event is to notify about the completion of a + * xdg_popup.reposition request. The token argument is the token + * passed in the xdg_popup.reposition request. + * + * Immediately after this event is emitted, xdg_popup.configure and + * xdg_surface.configure will be sent with the updated size and + * position, as well as a new configure serial. + * + * The client should optionally update the content of the popup, + * but must acknowledge the new popup configuration for the new + * position to take effect. See xdg_surface.ack_configure for + * details. + * @param token reposition request token + * @since 3 + */ + void (*repositioned)(void *data, + struct xdg_popup *xdg_popup, + uint32_t token); +}; + +/** + * @ingroup iface_xdg_popup + */ +static inline int +xdg_popup_add_listener(struct xdg_popup *xdg_popup, + const struct xdg_popup_listener *listener, void *data) +{ + return wl_proxy_add_listener((struct wl_proxy *) xdg_popup, + (void (**)(void)) listener, data); +} + +#define XDG_POPUP_DESTROY 0 +#define XDG_POPUP_GRAB 1 +#define XDG_POPUP_REPOSITION 2 + +/** + * @ingroup iface_xdg_popup + */ +#define XDG_POPUP_CONFIGURE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_popup + */ +#define XDG_POPUP_POPUP_DONE_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_popup + */ +#define XDG_POPUP_REPOSITIONED_SINCE_VERSION 3 + +/** + * @ingroup iface_xdg_popup + */ +#define XDG_POPUP_DESTROY_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_popup + */ +#define XDG_POPUP_GRAB_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_popup + */ +#define XDG_POPUP_REPOSITION_SINCE_VERSION 3 + +/** @ingroup iface_xdg_popup */ +static inline void +xdg_popup_set_user_data(struct xdg_popup *xdg_popup, void *user_data) +{ + wl_proxy_set_user_data((struct wl_proxy *) xdg_popup, user_data); +} + +/** @ingroup iface_xdg_popup */ +static inline void * +xdg_popup_get_user_data(struct xdg_popup *xdg_popup) +{ + return wl_proxy_get_user_data((struct wl_proxy *) xdg_popup); +} + +static inline uint32_t +xdg_popup_get_version(struct xdg_popup *xdg_popup) +{ + return wl_proxy_get_version((struct wl_proxy *) xdg_popup); +} + +/** + * @ingroup iface_xdg_popup + * + * This destroys the popup. Explicitly destroying the xdg_popup + * object will also dismiss the popup, and unmap the surface. + * + * If this xdg_popup is not the "topmost" popup, the + * xdg_wm_base.not_the_topmost_popup protocol error will be sent. + */ +static inline void +xdg_popup_destroy(struct xdg_popup *xdg_popup) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_popup, + XDG_POPUP_DESTROY, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_popup), WL_MARSHAL_FLAG_DESTROY); +} + +/** + * @ingroup iface_xdg_popup + * + * This request makes the created popup take an explicit grab. An explicit + * grab will be dismissed when the user dismisses the popup, or when the + * client destroys the xdg_popup. This can be done by the user clicking + * outside the surface, using the keyboard, or even locking the screen + * through closing the lid or a timeout. + * + * If the compositor denies the grab, the popup will be immediately + * dismissed. + * + * This request must be used in response to some sort of user action like a + * button press, key press, or touch down event. The serial number of the + * event should be passed as 'serial'. + * + * The parent of a grabbing popup must either be an xdg_toplevel surface or + * another xdg_popup with an explicit grab. If the parent is another + * xdg_popup it means that the popups are nested, with this popup now being + * the topmost popup. + * + * Nested popups must be destroyed in the reverse order they were created + * in, e.g. the only popup you are allowed to destroy at all times is the + * topmost one. + * + * When compositors choose to dismiss a popup, they may dismiss every + * nested grabbing popup as well. When a compositor dismisses popups, it + * will follow the same dismissing order as required from the client. + * + * If the topmost grabbing popup is destroyed, the grab will be returned to + * the parent of the popup, if that parent previously had an explicit grab. + * + * If the parent is a grabbing popup which has already been dismissed, this + * popup will be immediately dismissed. If the parent is a popup that did + * not take an explicit grab, an error will be raised. + * + * During a popup grab, the client owning the grab will receive pointer + * and touch events for all their surfaces as normal (similar to an + * "owner-events" grab in X11 parlance), while the top most grabbing popup + * will always have keyboard focus. + */ +static inline void +xdg_popup_grab(struct xdg_popup *xdg_popup, struct wl_seat *seat, uint32_t serial) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_popup, + XDG_POPUP_GRAB, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_popup), 0, seat, serial); +} + +/** + * @ingroup iface_xdg_popup + * + * Reposition an already-mapped popup. The popup will be placed given the + * details in the passed xdg_positioner object, and a + * xdg_popup.repositioned followed by xdg_popup.configure and + * xdg_surface.configure will be emitted in response. Any parameters set + * by the previous positioner will be discarded. + * + * The passed token will be sent in the corresponding + * xdg_popup.repositioned event. The new popup position will not take + * effect until the corresponding configure event is acknowledged by the + * client. See xdg_popup.repositioned for details. The token itself is + * opaque, and has no other special meaning. + * + * If multiple reposition requests are sent, the compositor may skip all + * but the last one. + * + * If the popup is repositioned in response to a configure event for its + * parent, the client should send an xdg_positioner.set_parent_configure + * and possibly an xdg_positioner.set_parent_size request to allow the + * compositor to properly constrain the popup. + * + * If the popup is repositioned together with a parent that is being + * resized, but not in response to a configure event, the client should + * send an xdg_positioner.set_parent_size request. + */ +static inline void +xdg_popup_reposition(struct xdg_popup *xdg_popup, struct xdg_positioner *positioner, uint32_t token) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_popup, + XDG_POPUP_REPOSITION, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_popup), 0, positioner, token); +} + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/ThirdParty/Wayland/include/wayland/xdg-toplevel-drag-v1.h b/Source/ThirdParty/Wayland/include/wayland/xdg-toplevel-drag-v1.h new file mode 100644 index 000000000..454844643 --- /dev/null +++ b/Source/ThirdParty/Wayland/include/wayland/xdg-toplevel-drag-v1.h @@ -0,0 +1,320 @@ +/* Generated by wayland-scanner 1.23.1 */ + +#ifndef XDG_TOPLEVEL_DRAG_V1_CLIENT_PROTOCOL_H +#define XDG_TOPLEVEL_DRAG_V1_CLIENT_PROTOCOL_H + +#include +#include +#include "wayland-client.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @page page_xdg_toplevel_drag_v1 The xdg_toplevel_drag_v1 protocol + * @section page_ifaces_xdg_toplevel_drag_v1 Interfaces + * - @subpage page_iface_xdg_toplevel_drag_manager_v1 - Move a window during a drag + * - @subpage page_iface_xdg_toplevel_drag_v1 - Object representing a toplevel move during a drag + * @section page_copyright_xdg_toplevel_drag_v1 Copyright + *
+ *
+ * Copyright 2023 David Redondo
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ * 
+ */ +struct wl_data_source; +struct xdg_toplevel; +struct xdg_toplevel_drag_manager_v1; +struct xdg_toplevel_drag_v1; + +#ifndef XDG_TOPLEVEL_DRAG_MANAGER_V1_INTERFACE +#define XDG_TOPLEVEL_DRAG_MANAGER_V1_INTERFACE +/** + * @page page_iface_xdg_toplevel_drag_manager_v1 xdg_toplevel_drag_manager_v1 + * @section page_iface_xdg_toplevel_drag_manager_v1_desc Description + * + * This protocol enhances normal drag and drop with the ability to move a + * window at the same time. This allows having detachable parts of a window + * that when dragged out of it become a new window and can be dragged over + * an existing window to be reattached. + * + * A typical workflow would be when the user starts dragging on top of a + * detachable part of a window, the client would create a wl_data_source and + * a xdg_toplevel_drag_v1 object and start the drag as normal via + * wl_data_device.start_drag. Once the client determines that the detachable + * window contents should be detached from the originating window, it creates + * a new xdg_toplevel with these contents and issues a + * xdg_toplevel_drag_v1.attach request before mapping it. From now on the new + * window is moved by the compositor during the drag as if the client called + * xdg_toplevel.move. + * + * Dragging an existing window is similar. The client creates a + * xdg_toplevel_drag_v1 object and attaches the existing toplevel before + * starting the drag. + * + * Clients use the existing drag and drop mechanism to detect when a window + * can be docked or undocked. If the client wants to snap a window into a + * parent window it should delete or unmap the dragged top-level. If the + * contents should be detached again it attaches a new toplevel as described + * above. If a drag operation is cancelled without being dropped, clients + * should revert to the previous state, deleting any newly created windows + * as appropriate. When a drag operation ends as indicated by + * wl_data_source.dnd_drop_performed the dragged toplevel window's final + * position is determined as if a xdg_toplevel_move operation ended. + * + * Warning! The protocol described in this file is currently in the testing + * phase. Backward compatible changes may be added together with the + * corresponding interface version bump. Backward incompatible changes can + * only be done by creating a new major version of the extension. + * @section page_iface_xdg_toplevel_drag_manager_v1_api API + * See @ref iface_xdg_toplevel_drag_manager_v1. + */ +/** + * @defgroup iface_xdg_toplevel_drag_manager_v1 The xdg_toplevel_drag_manager_v1 interface + * + * This protocol enhances normal drag and drop with the ability to move a + * window at the same time. This allows having detachable parts of a window + * that when dragged out of it become a new window and can be dragged over + * an existing window to be reattached. + * + * A typical workflow would be when the user starts dragging on top of a + * detachable part of a window, the client would create a wl_data_source and + * a xdg_toplevel_drag_v1 object and start the drag as normal via + * wl_data_device.start_drag. Once the client determines that the detachable + * window contents should be detached from the originating window, it creates + * a new xdg_toplevel with these contents and issues a + * xdg_toplevel_drag_v1.attach request before mapping it. From now on the new + * window is moved by the compositor during the drag as if the client called + * xdg_toplevel.move. + * + * Dragging an existing window is similar. The client creates a + * xdg_toplevel_drag_v1 object and attaches the existing toplevel before + * starting the drag. + * + * Clients use the existing drag and drop mechanism to detect when a window + * can be docked or undocked. If the client wants to snap a window into a + * parent window it should delete or unmap the dragged top-level. If the + * contents should be detached again it attaches a new toplevel as described + * above. If a drag operation is cancelled without being dropped, clients + * should revert to the previous state, deleting any newly created windows + * as appropriate. When a drag operation ends as indicated by + * wl_data_source.dnd_drop_performed the dragged toplevel window's final + * position is determined as if a xdg_toplevel_move operation ended. + * + * Warning! The protocol described in this file is currently in the testing + * phase. Backward compatible changes may be added together with the + * corresponding interface version bump. Backward incompatible changes can + * only be done by creating a new major version of the extension. + */ +extern const struct wl_interface xdg_toplevel_drag_manager_v1_interface; +#endif +#ifndef XDG_TOPLEVEL_DRAG_V1_INTERFACE +#define XDG_TOPLEVEL_DRAG_V1_INTERFACE +/** + * @page page_iface_xdg_toplevel_drag_v1 xdg_toplevel_drag_v1 + * @section page_iface_xdg_toplevel_drag_v1_desc Description + * + * @section page_iface_xdg_toplevel_drag_v1_api API + * See @ref iface_xdg_toplevel_drag_v1. + */ +/** + * @defgroup iface_xdg_toplevel_drag_v1 The xdg_toplevel_drag_v1 interface + * + */ +extern const struct wl_interface xdg_toplevel_drag_v1_interface; +#endif + +#ifndef XDG_TOPLEVEL_DRAG_MANAGER_V1_ERROR_ENUM +#define XDG_TOPLEVEL_DRAG_MANAGER_V1_ERROR_ENUM +enum xdg_toplevel_drag_manager_v1_error { + /** + * data_source already used for toplevel drag + */ + XDG_TOPLEVEL_DRAG_MANAGER_V1_ERROR_INVALID_SOURCE = 0, +}; +#endif /* XDG_TOPLEVEL_DRAG_MANAGER_V1_ERROR_ENUM */ + +#define XDG_TOPLEVEL_DRAG_MANAGER_V1_DESTROY 0 +#define XDG_TOPLEVEL_DRAG_MANAGER_V1_GET_XDG_TOPLEVEL_DRAG 1 + + +/** + * @ingroup iface_xdg_toplevel_drag_manager_v1 + */ +#define XDG_TOPLEVEL_DRAG_MANAGER_V1_DESTROY_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel_drag_manager_v1 + */ +#define XDG_TOPLEVEL_DRAG_MANAGER_V1_GET_XDG_TOPLEVEL_DRAG_SINCE_VERSION 1 + +/** @ingroup iface_xdg_toplevel_drag_manager_v1 */ +static inline void +xdg_toplevel_drag_manager_v1_set_user_data(struct xdg_toplevel_drag_manager_v1 *xdg_toplevel_drag_manager_v1, void *user_data) +{ + wl_proxy_set_user_data((struct wl_proxy *) xdg_toplevel_drag_manager_v1, user_data); +} + +/** @ingroup iface_xdg_toplevel_drag_manager_v1 */ +static inline void * +xdg_toplevel_drag_manager_v1_get_user_data(struct xdg_toplevel_drag_manager_v1 *xdg_toplevel_drag_manager_v1) +{ + return wl_proxy_get_user_data((struct wl_proxy *) xdg_toplevel_drag_manager_v1); +} + +static inline uint32_t +xdg_toplevel_drag_manager_v1_get_version(struct xdg_toplevel_drag_manager_v1 *xdg_toplevel_drag_manager_v1) +{ + return wl_proxy_get_version((struct wl_proxy *) xdg_toplevel_drag_manager_v1); +} + +/** + * @ingroup iface_xdg_toplevel_drag_manager_v1 + * + * Destroy this xdg_toplevel_drag_manager_v1 object. Other objects, + * including xdg_toplevel_drag_v1 objects created by this factory, are not + * affected by this request. + */ +static inline void +xdg_toplevel_drag_manager_v1_destroy(struct xdg_toplevel_drag_manager_v1 *xdg_toplevel_drag_manager_v1) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel_drag_manager_v1, + XDG_TOPLEVEL_DRAG_MANAGER_V1_DESTROY, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel_drag_manager_v1), WL_MARSHAL_FLAG_DESTROY); +} + +/** + * @ingroup iface_xdg_toplevel_drag_manager_v1 + * + * Create an xdg_toplevel_drag for a drag and drop operation that is going + * to be started with data_source. + * + * This request can only be made on sources used in drag-and-drop, so it + * must be performed before wl_data_device.start_drag. Attempting to use + * the source other than for drag-and-drop such as in + * wl_data_device.set_selection will raise an invalid_source error. + * + * Destroying data_source while a toplevel is attached to the + * xdg_toplevel_drag is undefined. + */ +static inline struct xdg_toplevel_drag_v1 * +xdg_toplevel_drag_manager_v1_get_xdg_toplevel_drag(struct xdg_toplevel_drag_manager_v1 *xdg_toplevel_drag_manager_v1, struct wl_data_source *data_source) +{ + struct wl_proxy *id; + + id = wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel_drag_manager_v1, + XDG_TOPLEVEL_DRAG_MANAGER_V1_GET_XDG_TOPLEVEL_DRAG, &xdg_toplevel_drag_v1_interface, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel_drag_manager_v1), 0, NULL, data_source); + + return (struct xdg_toplevel_drag_v1 *) id; +} + +#ifndef XDG_TOPLEVEL_DRAG_V1_ERROR_ENUM +#define XDG_TOPLEVEL_DRAG_V1_ERROR_ENUM +enum xdg_toplevel_drag_v1_error { + /** + * valid toplevel already attached + */ + XDG_TOPLEVEL_DRAG_V1_ERROR_TOPLEVEL_ATTACHED = 0, + /** + * drag has not ended + */ + XDG_TOPLEVEL_DRAG_V1_ERROR_ONGOING_DRAG = 1, +}; +#endif /* XDG_TOPLEVEL_DRAG_V1_ERROR_ENUM */ + +#define XDG_TOPLEVEL_DRAG_V1_DESTROY 0 +#define XDG_TOPLEVEL_DRAG_V1_ATTACH 1 + + +/** + * @ingroup iface_xdg_toplevel_drag_v1 + */ +#define XDG_TOPLEVEL_DRAG_V1_DESTROY_SINCE_VERSION 1 +/** + * @ingroup iface_xdg_toplevel_drag_v1 + */ +#define XDG_TOPLEVEL_DRAG_V1_ATTACH_SINCE_VERSION 1 + +/** @ingroup iface_xdg_toplevel_drag_v1 */ +static inline void +xdg_toplevel_drag_v1_set_user_data(struct xdg_toplevel_drag_v1 *xdg_toplevel_drag_v1, void *user_data) +{ + wl_proxy_set_user_data((struct wl_proxy *) xdg_toplevel_drag_v1, user_data); +} + +/** @ingroup iface_xdg_toplevel_drag_v1 */ +static inline void * +xdg_toplevel_drag_v1_get_user_data(struct xdg_toplevel_drag_v1 *xdg_toplevel_drag_v1) +{ + return wl_proxy_get_user_data((struct wl_proxy *) xdg_toplevel_drag_v1); +} + +static inline uint32_t +xdg_toplevel_drag_v1_get_version(struct xdg_toplevel_drag_v1 *xdg_toplevel_drag_v1) +{ + return wl_proxy_get_version((struct wl_proxy *) xdg_toplevel_drag_v1); +} + +/** + * @ingroup iface_xdg_toplevel_drag_v1 + * + * Destroy this xdg_toplevel_drag_v1 object. This request must only be + * called after the underlying wl_data_source drag has ended, as indicated + * by the dnd_drop_performed or cancelled events. In any other case an + * ongoing_drag error is raised. + */ +static inline void +xdg_toplevel_drag_v1_destroy(struct xdg_toplevel_drag_v1 *xdg_toplevel_drag_v1) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel_drag_v1, + XDG_TOPLEVEL_DRAG_V1_DESTROY, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel_drag_v1), WL_MARSHAL_FLAG_DESTROY); +} + +/** + * @ingroup iface_xdg_toplevel_drag_v1 + * + * Request that the window will be moved with the cursor during the drag + * operation. The offset is a hint to the compositor how the toplevel + * should be positioned relative to the cursor hotspot in surface local + * coordinates and relative to the geometry of the toplevel being attached. + * See xdg_surface.set_window_geometry. For example it might only + * be used when an unmapped window is attached. The attached window + * does not participate in the selection of the drag target. + * + * If the toplevel is unmapped while it is attached, it is automatically + * detached from the drag. In this case this request has to be called again + * if the window should be attached after it is remapped. + * + * This request can be called multiple times but issuing it while a + * toplevel with an active role is attached raises a toplevel_attached + * error. + */ +static inline void +xdg_toplevel_drag_v1_attach(struct xdg_toplevel_drag_v1 *xdg_toplevel_drag_v1, struct xdg_toplevel *toplevel, int32_t x_offset, int32_t y_offset) +{ + wl_proxy_marshal_flags((struct wl_proxy *) xdg_toplevel_drag_v1, + XDG_TOPLEVEL_DRAG_V1_ATTACH, NULL, wl_proxy_get_version((struct wl_proxy *) xdg_toplevel_drag_v1), 0, toplevel, x_offset, y_offset); +} + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/Source/ThirdParty/Wayland/protocols/xdg-shell.xml b/Source/ThirdParty/Wayland/protocols/xdg-shell.xml new file mode 100644 index 000000000..1caf6f100 --- /dev/null +++ b/Source/ThirdParty/Wayland/protocols/xdg-shell.xml @@ -0,0 +1,1383 @@ + + + + + Copyright © 2008-2013 Kristian Høgsberg + Copyright © 2013 Rafael Antognolli + Copyright © 2013 Jasper St. Pierre + Copyright © 2010-2013 Intel Corporation + Copyright © 2015-2017 Samsung Electronics Co., Ltd + Copyright © 2015-2017 Red Hat Inc. + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + + + + + The xdg_wm_base interface is exposed as a global object enabling clients + to turn their wl_surfaces into windows in a desktop environment. It + defines the basic functionality needed for clients and the compositor to + create windows that can be dragged, resized, maximized, etc, as well as + creating transient windows such as popup menus. + + + + + + + + + + + + + + + Destroy this xdg_wm_base object. + + Destroying a bound xdg_wm_base object while there are surfaces + still alive created by this xdg_wm_base object instance is illegal + and will result in a defunct_surfaces error. + + + + + + Create a positioner object. A positioner object is used to position + surfaces relative to some parent surface. See the interface description + and xdg_surface.get_popup for details. + + + + + + + This creates an xdg_surface for the given surface. While xdg_surface + itself is not a role, the corresponding surface may only be assigned + a role extending xdg_surface, such as xdg_toplevel or xdg_popup. It is + illegal to create an xdg_surface for a wl_surface which already has an + assigned role and this will result in a role error. + + This creates an xdg_surface for the given surface. An xdg_surface is + used as basis to define a role to a given surface, such as xdg_toplevel + or xdg_popup. It also manages functionality shared between xdg_surface + based surface roles. + + See the documentation of xdg_surface for more details about what an + xdg_surface is and how it is used. + + + + + + + + A client must respond to a ping event with a pong request or + the client may be deemed unresponsive. See xdg_wm_base.ping + and xdg_wm_base.error.unresponsive. + + + + + + + The ping event asks the client if it's still alive. Pass the + serial specified in the event back to the compositor by sending + a "pong" request back with the specified serial. See xdg_wm_base.pong. + + Compositors can use this to determine if the client is still + alive. It's unspecified what will happen if the client doesn't + respond to the ping request, or in what timeframe. Clients should + try to respond in a reasonable amount of time. The “unresponsive” + error is provided for compositors that wish to disconnect unresponsive + clients. + + A compositor is free to ping in any way it wants, but a client must + always respond to any xdg_wm_base object it created. + + + + + + + + The xdg_positioner provides a collection of rules for the placement of a + child surface relative to a parent surface. Rules can be defined to ensure + the child surface remains within the visible area's borders, and to + specify how the child surface changes its position, such as sliding along + an axis, or flipping around a rectangle. These positioner-created rules are + constrained by the requirement that a child surface must intersect with or + be at least partially adjacent to its parent surface. + + See the various requests for details about possible rules. + + At the time of the request, the compositor makes a copy of the rules + specified by the xdg_positioner. Thus, after the request is complete the + xdg_positioner object can be destroyed or reused; further changes to the + object will have no effect on previous usages. + + For an xdg_positioner object to be considered complete, it must have a + non-zero size set by set_size, and a non-zero anchor rectangle set by + set_anchor_rect. Passing an incomplete xdg_positioner object when + positioning a surface raises an invalid_positioner error. + + + + + + + + + Notify the compositor that the xdg_positioner will no longer be used. + + + + + + Set the size of the surface that is to be positioned with the positioner + object. The size is in surface-local coordinates and corresponds to the + window geometry. See xdg_surface.set_window_geometry. + + If a zero or negative size is set the invalid_input error is raised. + + + + + + + + Specify the anchor rectangle within the parent surface that the child + surface will be placed relative to. The rectangle is relative to the + window geometry as defined by xdg_surface.set_window_geometry of the + parent surface. + + When the xdg_positioner object is used to position a child surface, the + anchor rectangle may not extend outside the window geometry of the + positioned child's parent surface. + + If a negative size is set the invalid_input error is raised. + + + + + + + + + + + + + + + + + + + + + + Defines the anchor point for the anchor rectangle. The specified anchor + is used derive an anchor point that the child surface will be + positioned relative to. If a corner anchor is set (e.g. 'top_left' or + 'bottom_right'), the anchor point will be at the specified corner; + otherwise, the derived anchor point will be centered on the specified + edge, or in the center of the anchor rectangle if no edge is specified. + + + + + + + + + + + + + + + + + + + Defines in what direction a surface should be positioned, relative to + the anchor point of the parent surface. If a corner gravity is + specified (e.g. 'bottom_right' or 'top_left'), then the child surface + will be placed towards the specified gravity; otherwise, the child + surface will be centered over the anchor point on any axis that had no + gravity specified. If the gravity is not in the ‘gravity’ enum, an + invalid_input error is raised. + + + + + + + The constraint adjustment value define ways the compositor will adjust + the position of the surface, if the unadjusted position would result + in the surface being partly constrained. + + Whether a surface is considered 'constrained' is left to the compositor + to determine. For example, the surface may be partly outside the + compositor's defined 'work area', thus necessitating the child surface's + position be adjusted until it is entirely inside the work area. + + The adjustments can be combined, according to a defined precedence: 1) + Flip, 2) Slide, 3) Resize. + + + + Don't alter the surface position even if it is constrained on some + axis, for example partially outside the edge of an output. + + + + + Slide the surface along the x axis until it is no longer constrained. + + First try to slide towards the direction of the gravity on the x axis + until either the edge in the opposite direction of the gravity is + unconstrained or the edge in the direction of the gravity is + constrained. + + Then try to slide towards the opposite direction of the gravity on the + x axis until either the edge in the direction of the gravity is + unconstrained or the edge in the opposite direction of the gravity is + constrained. + + + + + Slide the surface along the y axis until it is no longer constrained. + + First try to slide towards the direction of the gravity on the y axis + until either the edge in the opposite direction of the gravity is + unconstrained or the edge in the direction of the gravity is + constrained. + + Then try to slide towards the opposite direction of the gravity on the + y axis until either the edge in the direction of the gravity is + unconstrained or the edge in the opposite direction of the gravity is + constrained. + + + + + Invert the anchor and gravity on the x axis if the surface is + constrained on the x axis. For example, if the left edge of the + surface is constrained, the gravity is 'left' and the anchor is + 'left', change the gravity to 'right' and the anchor to 'right'. + + If the adjusted position also ends up being constrained, the resulting + position of the flip_x adjustment will be the one before the + adjustment. + + + + + Invert the anchor and gravity on the y axis if the surface is + constrained on the y axis. For example, if the bottom edge of the + surface is constrained, the gravity is 'bottom' and the anchor is + 'bottom', change the gravity to 'top' and the anchor to 'top'. + + The adjusted position is calculated given the original anchor + rectangle and offset, but with the new flipped anchor and gravity + values. + + If the adjusted position also ends up being constrained, the resulting + position of the flip_y adjustment will be the one before the + adjustment. + + + + + Resize the surface horizontally so that it is completely + unconstrained. + + + + + Resize the surface vertically so that it is completely unconstrained. + + + + + + + Specify how the window should be positioned if the originally intended + position caused the surface to be constrained, meaning at least + partially outside positioning boundaries set by the compositor. The + adjustment is set by constructing a bitmask describing the adjustment to + be made when the surface is constrained on that axis. + + If no bit for one axis is set, the compositor will assume that the child + surface should not change its position on that axis when constrained. + + If more than one bit for one axis is set, the order of how adjustments + are applied is specified in the corresponding adjustment descriptions. + + The default adjustment is none. + + + + + + + Specify the surface position offset relative to the position of the + anchor on the anchor rectangle and the anchor on the surface. For + example if the anchor of the anchor rectangle is at (x, y), the surface + has the gravity bottom|right, and the offset is (ox, oy), the calculated + surface position will be (x + ox, y + oy). The offset position of the + surface is the one used for constraint testing. See + set_constraint_adjustment. + + An example use case is placing a popup menu on top of a user interface + element, while aligning the user interface element of the parent surface + with some user interface element placed somewhere in the popup surface. + + + + + + + + + + When set reactive, the surface is reconstrained if the conditions used + for constraining changed, e.g. the parent window moved. + + If the conditions changed and the popup was reconstrained, an + xdg_popup.configure event is sent with updated geometry, followed by an + xdg_surface.configure event. + + + + + + Set the parent window geometry the compositor should use when + positioning the popup. The compositor may use this information to + determine the future state the popup should be constrained using. If + this doesn't match the dimension of the parent the popup is eventually + positioned against, the behavior is undefined. + + The arguments are given in the surface-local coordinate space. + + + + + + + + Set the serial of an xdg_surface.configure event this positioner will be + used in response to. The compositor may use this information together + with set_parent_size to determine what future state the popup should be + constrained using. + + + + + + + + An interface that may be implemented by a wl_surface, for + implementations that provide a desktop-style user interface. + + It provides a base set of functionality required to construct user + interface elements requiring management by the compositor, such as + toplevel windows, menus, etc. The types of functionality are split into + xdg_surface roles. + + Creating an xdg_surface does not set the role for a wl_surface. In order + to map an xdg_surface, the client must create a role-specific object + using, e.g., get_toplevel, get_popup. The wl_surface for any given + xdg_surface can have at most one role, and may not be assigned any role + not based on xdg_surface. + + A role must be assigned before any other requests are made to the + xdg_surface object. + + The client must call wl_surface.commit on the corresponding wl_surface + for the xdg_surface state to take effect. + + Creating an xdg_surface from a wl_surface which has a buffer attached or + committed is a client error, and any attempts by a client to attach or + manipulate a buffer prior to the first xdg_surface.configure call must + also be treated as errors. + + After creating a role-specific object and setting it up (e.g. by sending + the title, app ID, size constraints, parent, etc), the client must + perform an initial commit without any buffer attached. The compositor + will reply with initial wl_surface state such as + wl_surface.preferred_buffer_scale followed by an xdg_surface.configure + event. The client must acknowledge it and is then allowed to attach a + buffer to map the surface. + + Mapping an xdg_surface-based role surface is defined as making it + possible for the surface to be shown by the compositor. Note that + a mapped surface is not guaranteed to be visible once it is mapped. + + For an xdg_surface to be mapped by the compositor, the following + conditions must be met: + (1) the client has assigned an xdg_surface-based role to the surface + (2) the client has set and committed the xdg_surface state and the + role-dependent state to the surface + (3) the client has committed a buffer to the surface + + A newly-unmapped surface is considered to have met condition (1) out + of the 3 required conditions for mapping a surface if its role surface + has not been destroyed, i.e. the client must perform the initial commit + again before attaching a buffer. + + + + + + + + + + + + + + Destroy the xdg_surface object. An xdg_surface must only be destroyed + after its role object has been destroyed, otherwise + a defunct_role_object error is raised. + + + + + + This creates an xdg_toplevel object for the given xdg_surface and gives + the associated wl_surface the xdg_toplevel role. + + See the documentation of xdg_toplevel for more details about what an + xdg_toplevel is and how it is used. + + + + + + + This creates an xdg_popup object for the given xdg_surface and gives + the associated wl_surface the xdg_popup role. + + If null is passed as a parent, a parent surface must be specified using + some other protocol, before committing the initial state. + + See the documentation of xdg_popup for more details about what an + xdg_popup is and how it is used. + + + + + + + + + The window geometry of a surface is its "visible bounds" from the + user's perspective. Client-side decorations often have invisible + portions like drop-shadows which should be ignored for the + purposes of aligning, placing and constraining windows. + + The window geometry is double-buffered state, see wl_surface.commit. + + When maintaining a position, the compositor should treat the (x, y) + coordinate of the window geometry as the top left corner of the window. + A client changing the (x, y) window geometry coordinate should in + general not alter the position of the window. + + Once the window geometry of the surface is set, it is not possible to + unset it, and it will remain the same until set_window_geometry is + called again, even if a new subsurface or buffer is attached. + + If never set, the value is the full bounds of the surface, + including any subsurfaces. This updates dynamically on every + commit. This unset is meant for extremely simple clients. + + The arguments are given in the surface-local coordinate space of + the wl_surface associated with this xdg_surface, and may extend outside + of the wl_surface itself to mark parts of the subsurface tree as part of + the window geometry. + + When applied, the effective window geometry will be the set window + geometry clamped to the bounding rectangle of the combined + geometry of the surface of the xdg_surface and the associated + subsurfaces. + + The effective geometry will not be recalculated unless a new call to + set_window_geometry is done and the new pending surface state is + subsequently applied. + + The width and height of the effective window geometry must be + greater than zero. Setting an invalid size will raise an + invalid_size error. + + + + + + + + + + When a configure event is received, if a client commits the + surface in response to the configure event, then the client + must make an ack_configure request sometime before the commit + request, passing along the serial of the configure event. + + For instance, for toplevel surfaces the compositor might use this + information to move a surface to the top left only when the client has + drawn itself for the maximized or fullscreen state. + + If the client receives multiple configure events before it + can respond to one, it only has to ack the last configure event. + Acking a configure event that was never sent raises an invalid_serial + error. + + A client is not required to commit immediately after sending + an ack_configure request - it may even ack_configure several times + before its next surface commit. + + A client may send multiple ack_configure requests before committing, but + only the last request sent before a commit indicates which configure + event the client really is responding to. + + Sending an ack_configure request consumes the serial number sent with + the request, as well as serial numbers sent by all configure events + sent on this xdg_surface prior to the configure event referenced by + the committed serial. + + It is an error to issue multiple ack_configure requests referencing a + serial from the same configure event, or to issue an ack_configure + request referencing a serial from a configure event issued before the + event identified by the last ack_configure request for the same + xdg_surface. Doing so will raise an invalid_serial error. + + + + + + + The configure event marks the end of a configure sequence. A configure + sequence is a set of one or more events configuring the state of the + xdg_surface, including the final xdg_surface.configure event. + + Where applicable, xdg_surface surface roles will during a configure + sequence extend this event as a latched state sent as events before the + xdg_surface.configure event. Such events should be considered to make up + a set of atomically applied configuration states, where the + xdg_surface.configure commits the accumulated state. + + Clients should arrange their surface for the new states, and then send + an ack_configure request with the serial sent in this configure event at + some point before committing the new surface. + + If the client receives multiple configure events before it can respond + to one, it is free to discard all but the last event it received. + + + + + + + + + This interface defines an xdg_surface role which allows a surface to, + among other things, set window-like properties such as maximize, + fullscreen, and minimize, set application-specific metadata like title and + id, and well as trigger user interactive operations such as interactive + resize and move. + + A xdg_toplevel by default is responsible for providing the full intended + visual representation of the toplevel, which depending on the window + state, may mean things like a title bar, window controls and drop shadow. + + Unmapping an xdg_toplevel means that the surface cannot be shown + by the compositor until it is explicitly mapped again. + All active operations (e.g., move, resize) are canceled and all + attributes (e.g. title, state, stacking, ...) are discarded for + an xdg_toplevel surface when it is unmapped. The xdg_toplevel returns to + the state it had right after xdg_surface.get_toplevel. The client + can re-map the toplevel by performing a commit without any buffer + attached, waiting for a configure event and handling it as usual (see + xdg_surface description). + + Attaching a null buffer to a toplevel unmaps the surface. + + + + + This request destroys the role surface and unmaps the surface; + see "Unmapping" behavior in interface section for details. + + + + + + + + + + + + Set the "parent" of this surface. This surface should be stacked + above the parent surface and all other ancestor surfaces. + + Parent surfaces should be set on dialogs, toolboxes, or other + "auxiliary" surfaces, so that the parent is raised when the dialog + is raised. + + Setting a null parent for a child surface unsets its parent. Setting + a null parent for a surface which currently has no parent is a no-op. + + Only mapped surfaces can have child surfaces. Setting a parent which + is not mapped is equivalent to setting a null parent. If a surface + becomes unmapped, its children's parent is set to the parent of + the now-unmapped surface. If the now-unmapped surface has no parent, + its children's parent is unset. If the now-unmapped surface becomes + mapped again, its parent-child relationship is not restored. + + The parent toplevel must not be one of the child toplevel's + descendants, and the parent must be different from the child toplevel, + otherwise the invalid_parent protocol error is raised. + + + + + + + Set a short title for the surface. + + This string may be used to identify the surface in a task bar, + window list, or other user interface elements provided by the + compositor. + + The string must be encoded in UTF-8. + + + + + + + Set an application identifier for the surface. + + The app ID identifies the general class of applications to which + the surface belongs. The compositor can use this to group multiple + surfaces together, or to determine how to launch a new application. + + For D-Bus activatable applications, the app ID is used as the D-Bus + service name. + + The compositor shell will try to group application surfaces together + by their app ID. As a best practice, it is suggested to select app + ID's that match the basename of the application's .desktop file. + For example, "org.freedesktop.FooViewer" where the .desktop file is + "org.freedesktop.FooViewer.desktop". + + Like other properties, a set_app_id request can be sent after the + xdg_toplevel has been mapped to update the property. + + See the desktop-entry specification [0] for more details on + application identifiers and how they relate to well-known D-Bus + names and .desktop files. + + [0] https://standards.freedesktop.org/desktop-entry-spec/ + + + + + + + Clients implementing client-side decorations might want to show + a context menu when right-clicking on the decorations, giving the + user a menu that they can use to maximize or minimize the window. + + This request asks the compositor to pop up such a window menu at + the given position, relative to the local surface coordinates of + the parent surface. There are no guarantees as to what menu items + the window menu contains, or even if a window menu will be drawn + at all. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. + + + + + + + + + + Start an interactive, user-driven move of the surface. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. The passed + serial is used to determine the type of interactive move (touch, + pointer, etc). + + The server may ignore move requests depending on the state of + the surface (e.g. fullscreen or maximized), or if the passed serial + is no longer valid. + + If triggered, the surface will lose the focus of the device + (wl_pointer, wl_touch, etc) used for the move. It is up to the + compositor to visually indicate that the move is taking place, such as + updating a pointer cursor, during the move. There is no guarantee + that the device focus will return when the move is completed. + + + + + + + + These values are used to indicate which edge of a surface + is being dragged in a resize operation. + + + + + + + + + + + + + + + Start a user-driven, interactive resize of the surface. + + This request must be used in response to some sort of user action + like a button press, key press, or touch down event. The passed + serial is used to determine the type of interactive resize (touch, + pointer, etc). + + The server may ignore resize requests depending on the state of + the surface (e.g. fullscreen or maximized). + + If triggered, the client will receive configure events with the + "resize" state enum value and the expected sizes. See the "resize" + enum value for more details about what is required. The client + must also acknowledge configure events using "ack_configure". After + the resize is completed, the client will receive another "configure" + event without the resize state. + + If triggered, the surface also will lose the focus of the device + (wl_pointer, wl_touch, etc) used for the resize. It is up to the + compositor to visually indicate that the resize is taking place, + such as updating a pointer cursor, during the resize. There is no + guarantee that the device focus will return when the resize is + completed. + + The edges parameter specifies how the surface should be resized, and + is one of the values of the resize_edge enum. Values not matching + a variant of the enum will cause the invalid_resize_edge protocol error. + The compositor may use this information to update the surface position + for example when dragging the top left corner. The compositor may also + use this information to adapt its behavior, e.g. choose an appropriate + cursor image. + + + + + + + + + The different state values used on the surface. This is designed for + state values like maximized, fullscreen. It is paired with the + configure event to ensure that both the client and the compositor + setting the state can be synchronized. + + States set in this way are double-buffered, see wl_surface.commit. + + + + The surface is maximized. The window geometry specified in the configure + event must be obeyed by the client, or the xdg_wm_base.invalid_surface_state + error is raised. + + The client should draw without shadow or other + decoration outside of the window geometry. + + + + + The surface is fullscreen. The window geometry specified in the + configure event is a maximum; the client cannot resize beyond it. For + a surface to cover the whole fullscreened area, the geometry + dimensions must be obeyed by the client. For more details, see + xdg_toplevel.set_fullscreen. + + + + + The surface is being resized. The window geometry specified in the + configure event is a maximum; the client cannot resize beyond it. + Clients that have aspect ratio or cell sizing configuration can use + a smaller size, however. + + + + + Client window decorations should be painted as if the window is + active. Do not assume this means that the window actually has + keyboard or pointer focus. + + + + + The window is currently in a tiled layout and the left edge is + considered to be adjacent to another part of the tiling grid. + + The client should draw without shadow or other decoration outside of + the window geometry on the left edge. + + + + + The window is currently in a tiled layout and the right edge is + considered to be adjacent to another part of the tiling grid. + + The client should draw without shadow or other decoration outside of + the window geometry on the right edge. + + + + + The window is currently in a tiled layout and the top edge is + considered to be adjacent to another part of the tiling grid. + + The client should draw without shadow or other decoration outside of + the window geometry on the top edge. + + + + + The window is currently in a tiled layout and the bottom edge is + considered to be adjacent to another part of the tiling grid. + + The client should draw without shadow or other decoration outside of + the window geometry on the bottom edge. + + + + + The surface is currently not ordinarily being repainted; for + example because its content is occluded by another window, or its + outputs are switched off due to screen locking. + + + + + + + Set a maximum size for the window. + + The client can specify a maximum size so that the compositor does + not try to configure the window beyond this size. + + The width and height arguments are in window geometry coordinates. + See xdg_surface.set_window_geometry. + + Values set in this way are double-buffered, see wl_surface.commit. + + The compositor can use this information to allow or disallow + different states like maximize or fullscreen and draw accurate + animations. + + Similarly, a tiling window manager may use this information to + place and resize client windows in a more effective way. + + The client should not rely on the compositor to obey the maximum + size. The compositor may decide to ignore the values set by the + client and request a larger size. + + If never set, or a value of zero in the request, means that the + client has no expected maximum size in the given dimension. + As a result, a client wishing to reset the maximum size + to an unspecified state can use zero for width and height in the + request. + + Requesting a maximum size to be smaller than the minimum size of + a surface is illegal and will result in an invalid_size error. + + The width and height must be greater than or equal to zero. Using + strictly negative values for width or height will result in a + invalid_size error. + + + + + + + + Set a minimum size for the window. + + The client can specify a minimum size so that the compositor does + not try to configure the window below this size. + + The width and height arguments are in window geometry coordinates. + See xdg_surface.set_window_geometry. + + Values set in this way are double-buffered, see wl_surface.commit. + + The compositor can use this information to allow or disallow + different states like maximize or fullscreen and draw accurate + animations. + + Similarly, a tiling window manager may use this information to + place and resize client windows in a more effective way. + + The client should not rely on the compositor to obey the minimum + size. The compositor may decide to ignore the values set by the + client and request a smaller size. + + If never set, or a value of zero in the request, means that the + client has no expected minimum size in the given dimension. + As a result, a client wishing to reset the minimum size + to an unspecified state can use zero for width and height in the + request. + + Requesting a minimum size to be larger than the maximum size of + a surface is illegal and will result in an invalid_size error. + + The width and height must be greater than or equal to zero. Using + strictly negative values for width and height will result in a + invalid_size error. + + + + + + + + Maximize the surface. + + After requesting that the surface should be maximized, the compositor + will respond by emitting a configure event. Whether this configure + actually sets the window maximized is subject to compositor policies. + The client must then update its content, drawing in the configured + state. The client must also acknowledge the configure when committing + the new content (see ack_configure). + + It is up to the compositor to decide how and where to maximize the + surface, for example which output and what region of the screen should + be used. + + If the surface was already maximized, the compositor will still emit + a configure event with the "maximized" state. + + If the surface is in a fullscreen state, this request has no direct + effect. It may alter the state the surface is returned to when + unmaximized unless overridden by the compositor. + + + + + + Unmaximize the surface. + + After requesting that the surface should be unmaximized, the compositor + will respond by emitting a configure event. Whether this actually + un-maximizes the window is subject to compositor policies. + If available and applicable, the compositor will include the window + geometry dimensions the window had prior to being maximized in the + configure event. The client must then update its content, drawing it in + the configured state. The client must also acknowledge the configure + when committing the new content (see ack_configure). + + It is up to the compositor to position the surface after it was + unmaximized; usually the position the surface had before maximizing, if + applicable. + + If the surface was already not maximized, the compositor will still + emit a configure event without the "maximized" state. + + If the surface is in a fullscreen state, this request has no direct + effect. It may alter the state the surface is returned to when + unmaximized unless overridden by the compositor. + + + + + + Make the surface fullscreen. + + After requesting that the surface should be fullscreened, the + compositor will respond by emitting a configure event. Whether the + client is actually put into a fullscreen state is subject to compositor + policies. The client must also acknowledge the configure when + committing the new content (see ack_configure). + + The output passed by the request indicates the client's preference as + to which display it should be set fullscreen on. If this value is NULL, + it's up to the compositor to choose which display will be used to map + this surface. + + If the surface doesn't cover the whole output, the compositor will + position the surface in the center of the output and compensate with + with border fill covering the rest of the output. The content of the + border fill is undefined, but should be assumed to be in some way that + attempts to blend into the surrounding area (e.g. solid black). + + If the fullscreened surface is not opaque, the compositor must make + sure that other screen content not part of the same surface tree (made + up of subsurfaces, popups or similarly coupled surfaces) are not + visible below the fullscreened surface. + + + + + + + Make the surface no longer fullscreen. + + After requesting that the surface should be unfullscreened, the + compositor will respond by emitting a configure event. + Whether this actually removes the fullscreen state of the client is + subject to compositor policies. + + Making a surface unfullscreen sets states for the surface based on the following: + * the state(s) it may have had before becoming fullscreen + * any state(s) decided by the compositor + * any state(s) requested by the client while the surface was fullscreen + + The compositor may include the previous window geometry dimensions in + the configure event, if applicable. + + The client must also acknowledge the configure when committing the new + content (see ack_configure). + + + + + + Request that the compositor minimize your surface. There is no + way to know if the surface is currently minimized, nor is there + any way to unset minimization on this surface. + + If you are looking to throttle redrawing when minimized, please + instead use the wl_surface.frame event for this, as this will + also work with live previews on windows in Alt-Tab, Expose or + similar compositor features. + + + + + + This configure event asks the client to resize its toplevel surface or + to change its state. The configured state should not be applied + immediately. See xdg_surface.configure for details. + + The width and height arguments specify a hint to the window + about how its surface should be resized in window geometry + coordinates. See set_window_geometry. + + If the width or height arguments are zero, it means the client + should decide its own window dimension. This may happen when the + compositor needs to configure the state of the surface but doesn't + have any information about any previous or expected dimension. + + The states listed in the event specify how the width/height + arguments should be interpreted, and possibly how it should be + drawn. + + Clients must send an ack_configure in response to this event. See + xdg_surface.configure and xdg_surface.ack_configure for details. + + + + + + + + + The close event is sent by the compositor when the user + wants the surface to be closed. This should be equivalent to + the user clicking the close button in client-side decorations, + if your application has any. + + This is only a request that the user intends to close the + window. The client may choose to ignore this request, or show + a dialog to ask the user to save their data, etc. + + + + + + + + The configure_bounds event may be sent prior to a xdg_toplevel.configure + event to communicate the bounds a window geometry size is recommended + to constrain to. + + The passed width and height are in surface coordinate space. If width + and height are 0, it means bounds is unknown and equivalent to as if no + configure_bounds event was ever sent for this surface. + + The bounds can for example correspond to the size of a monitor excluding + any panels or other shell components, so that a surface isn't created in + a way that it cannot fit. + + The bounds may change at any point, and in such a case, a new + xdg_toplevel.configure_bounds will be sent, followed by + xdg_toplevel.configure and xdg_surface.configure. + + + + + + + + + + + + + + + + + This event advertises the capabilities supported by the compositor. If + a capability isn't supported, clients should hide or disable the UI + elements that expose this functionality. For instance, if the + compositor doesn't advertise support for minimized toplevels, a button + triggering the set_minimized request should not be displayed. + + The compositor will ignore requests it doesn't support. For instance, + a compositor which doesn't advertise support for minimized will ignore + set_minimized requests. + + Compositors must send this event once before the first + xdg_surface.configure event. When the capabilities change, compositors + must send this event again and then send an xdg_surface.configure + event. + + The configured state should not be applied immediately. See + xdg_surface.configure for details. + + The capabilities are sent as an array of 32-bit unsigned integers in + native endianness. + + + + + + + + A popup surface is a short-lived, temporary surface. It can be used to + implement for example menus, popovers, tooltips and other similar user + interface concepts. + + A popup can be made to take an explicit grab. See xdg_popup.grab for + details. + + When the popup is dismissed, a popup_done event will be sent out, and at + the same time the surface will be unmapped. See the xdg_popup.popup_done + event for details. + + Explicitly destroying the xdg_popup object will also dismiss the popup and + unmap the surface. Clients that want to dismiss the popup when another + surface of their own is clicked should dismiss the popup using the destroy + request. + + A newly created xdg_popup will be stacked on top of all previously created + xdg_popup surfaces associated with the same xdg_toplevel. + + The parent of an xdg_popup must be mapped (see the xdg_surface + description) before the xdg_popup itself. + + The client must call wl_surface.commit on the corresponding wl_surface + for the xdg_popup state to take effect. + + + + + + + + + This destroys the popup. Explicitly destroying the xdg_popup + object will also dismiss the popup, and unmap the surface. + + If this xdg_popup is not the "topmost" popup, the + xdg_wm_base.not_the_topmost_popup protocol error will be sent. + + + + + + This request makes the created popup take an explicit grab. An explicit + grab will be dismissed when the user dismisses the popup, or when the + client destroys the xdg_popup. This can be done by the user clicking + outside the surface, using the keyboard, or even locking the screen + through closing the lid or a timeout. + + If the compositor denies the grab, the popup will be immediately + dismissed. + + This request must be used in response to some sort of user action like a + button press, key press, or touch down event. The serial number of the + event should be passed as 'serial'. + + The parent of a grabbing popup must either be an xdg_toplevel surface or + another xdg_popup with an explicit grab. If the parent is another + xdg_popup it means that the popups are nested, with this popup now being + the topmost popup. + + Nested popups must be destroyed in the reverse order they were created + in, e.g. the only popup you are allowed to destroy at all times is the + topmost one. + + When compositors choose to dismiss a popup, they may dismiss every + nested grabbing popup as well. When a compositor dismisses popups, it + will follow the same dismissing order as required from the client. + + If the topmost grabbing popup is destroyed, the grab will be returned to + the parent of the popup, if that parent previously had an explicit grab. + + If the parent is a grabbing popup which has already been dismissed, this + popup will be immediately dismissed. If the parent is a popup that did + not take an explicit grab, an error will be raised. + + During a popup grab, the client owning the grab will receive pointer + and touch events for all their surfaces as normal (similar to an + "owner-events" grab in X11 parlance), while the top most grabbing popup + will always have keyboard focus. + + + + + + + + This event asks the popup surface to configure itself given the + configuration. The configured state should not be applied immediately. + See xdg_surface.configure for details. + + The x and y arguments represent the position the popup was placed at + given the xdg_positioner rule, relative to the upper left corner of the + window geometry of the parent surface. + + For version 2 or older, the configure event for an xdg_popup is only + ever sent once for the initial configuration. Starting with version 3, + it may be sent again if the popup is setup with an xdg_positioner with + set_reactive requested, or in response to xdg_popup.reposition requests. + + + + + + + + + + The popup_done event is sent out when a popup is dismissed by the + compositor. The client should destroy the xdg_popup object at this + point. + + + + + + + + Reposition an already-mapped popup. The popup will be placed given the + details in the passed xdg_positioner object, and a + xdg_popup.repositioned followed by xdg_popup.configure and + xdg_surface.configure will be emitted in response. Any parameters set + by the previous positioner will be discarded. + + The passed token will be sent in the corresponding + xdg_popup.repositioned event. The new popup position will not take + effect until the corresponding configure event is acknowledged by the + client. See xdg_popup.repositioned for details. The token itself is + opaque, and has no other special meaning. + + If multiple reposition requests are sent, the compositor may skip all + but the last one. + + If the popup is repositioned in response to a configure event for its + parent, the client should send an xdg_positioner.set_parent_configure + and possibly an xdg_positioner.set_parent_size request to allow the + compositor to properly constrain the popup. + + If the popup is repositioned together with a parent that is being + resized, but not in response to a configure event, the client should + send an xdg_positioner.set_parent_size request. + + + + + + + + The repositioned event is sent as part of a popup configuration + sequence, together with xdg_popup.configure and lastly + xdg_surface.configure to notify the completion of a reposition request. + + The repositioned event is to notify about the completion of a + xdg_popup.reposition request. The token argument is the token passed + in the xdg_popup.reposition request. + + Immediately after this event is emitted, xdg_popup.configure and + xdg_surface.configure will be sent with the updated size and position, + as well as a new configure serial. + + The client should optionally update the content of the popup, but must + acknowledge the new popup configuration for the new position to take + effect. See xdg_surface.ack_configure for details. + + + + + + diff --git a/Source/ThirdParty/Wayland/protocols/xdg-toplevel-drag-v1.xml b/Source/ThirdParty/Wayland/protocols/xdg-toplevel-drag-v1.xml new file mode 100644 index 000000000..e14497df6 --- /dev/null +++ b/Source/ThirdParty/Wayland/protocols/xdg-toplevel-drag-v1.xml @@ -0,0 +1,142 @@ + + + + + Copyright 2023 David Redondo + + Permission is hereby granted, free of charge, to any person obtaining a + copy of this software and associated documentation files (the "Software"), + to deal in the Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice (including the next + paragraph) shall be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + DEALINGS IN THE SOFTWARE. + + + + + This protocol enhances normal drag and drop with the ability to move a + window at the same time. This allows having detachable parts of a window + that when dragged out of it become a new window and can be dragged over + an existing window to be reattached. + + A typical workflow would be when the user starts dragging on top of a + detachable part of a window, the client would create a wl_data_source and + a xdg_toplevel_drag_v1 object and start the drag as normal via + wl_data_device.start_drag. Once the client determines that the detachable + window contents should be detached from the originating window, it creates + a new xdg_toplevel with these contents and issues a + xdg_toplevel_drag_v1.attach request before mapping it. From now on the new + window is moved by the compositor during the drag as if the client called + xdg_toplevel.move. + + Dragging an existing window is similar. The client creates a + xdg_toplevel_drag_v1 object and attaches the existing toplevel before + starting the drag. + + Clients use the existing drag and drop mechanism to detect when a window + can be docked or undocked. If the client wants to snap a window into a + parent window it should delete or unmap the dragged top-level. If the + contents should be detached again it attaches a new toplevel as described + above. If a drag operation is cancelled without being dropped, clients + should revert to the previous state, deleting any newly created windows + as appropriate. When a drag operation ends as indicated by + wl_data_source.dnd_drop_performed the dragged toplevel window's final + position is determined as if a xdg_toplevel_move operation ended. + + Warning! The protocol described in this file is currently in the testing + phase. Backward compatible changes may be added together with the + corresponding interface version bump. Backward incompatible changes can + only be done by creating a new major version of the extension. + + + + + + + + + Destroy this xdg_toplevel_drag_manager_v1 object. Other objects, + including xdg_toplevel_drag_v1 objects created by this factory, are not + affected by this request. + + + + + + Create an xdg_toplevel_drag for a drag and drop operation that is going + to be started with data_source. + + This request can only be made on sources used in drag-and-drop, so it + must be performed before wl_data_device.start_drag. Attempting to use + the source other than for drag-and-drop such as in + wl_data_device.set_selection will raise an invalid_source error. + + Destroying data_source while a toplevel is attached to the + xdg_toplevel_drag is undefined. + + + + + + + + + + + + + + + + + + + Destroy this xdg_toplevel_drag_v1 object. This request must only be + called after the underlying wl_data_source drag has ended, as indicated + by the dnd_drop_performed or cancelled events. In any other case an + ongoing_drag error is raised. + + + + + + Request that the window will be moved with the cursor during the drag + operation. The offset is a hint to the compositor how the toplevel + should be positioned relative to the cursor hotspot in surface local + coordinates and relative to the geometry of the toplevel being attached. + See xdg_surface.set_window_geometry. For example it might only + be used when an unmapped window is attached. The attached window + does not participate in the selection of the drag target. + + If the toplevel is unmapped while it is attached, it is automatically + detached from the drag. In this case this request has to be called again + if the window should be attached after it is remapped. + + This request can be called multiple times but issuing it while a + toplevel with an active role is attached raises a toplevel_attached + error. + + + + + + + + + + diff --git a/Source/ThirdParty/Wayland/xdg-shell.c b/Source/ThirdParty/Wayland/xdg-shell.c new file mode 100644 index 000000000..d698c2ca5 --- /dev/null +++ b/Source/ThirdParty/Wayland/xdg-shell.c @@ -0,0 +1,184 @@ +/* Generated by wayland-scanner 1.23.1 */ + +/* + * Copyright © 2008-2013 Kristian Høgsberg + * Copyright © 2013 Rafael Antognolli + * Copyright © 2013 Jasper St. Pierre + * Copyright © 2010-2013 Intel Corporation + * Copyright © 2015-2017 Samsung Electronics Co., Ltd + * Copyright © 2015-2017 Red Hat Inc. + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice (including the next + * paragraph) shall be included in all copies or substantial portions of the + * Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. + */ + +#include +#include +#include +#include "wayland-util.h" + +#ifndef __has_attribute +# define __has_attribute(x) 0 /* Compatibility with non-clang compilers. */ +#endif + +#if (__has_attribute(visibility) || defined(__GNUC__) && __GNUC__ >= 4) +#define WL_PRIVATE __attribute__ ((visibility("hidden"))) +#else +#define WL_PRIVATE +#endif + +extern const struct wl_interface wl_output_interface; +extern const struct wl_interface wl_seat_interface; +extern const struct wl_interface wl_surface_interface; +extern const struct wl_interface xdg_popup_interface; +extern const struct wl_interface xdg_positioner_interface; +extern const struct wl_interface xdg_surface_interface; +extern const struct wl_interface xdg_toplevel_interface; + +static const struct wl_interface *xdg_shell_types[] = { + NULL, + NULL, + NULL, + NULL, + &xdg_positioner_interface, + &xdg_surface_interface, + &wl_surface_interface, + &xdg_toplevel_interface, + &xdg_popup_interface, + &xdg_surface_interface, + &xdg_positioner_interface, + &xdg_toplevel_interface, + &wl_seat_interface, + NULL, + NULL, + NULL, + &wl_seat_interface, + NULL, + &wl_seat_interface, + NULL, + NULL, + &wl_output_interface, + &wl_seat_interface, + NULL, + &xdg_positioner_interface, + NULL, +}; + +static const struct wl_message xdg_wm_base_requests[] = { + { "destroy", "", xdg_shell_types + 0 }, + { "create_positioner", "n", xdg_shell_types + 4 }, + { "get_xdg_surface", "no", xdg_shell_types + 5 }, + { "pong", "u", xdg_shell_types + 0 }, +}; + +static const struct wl_message xdg_wm_base_events[] = { + { "ping", "u", xdg_shell_types + 0 }, +}; + +WL_PRIVATE const struct wl_interface xdg_wm_base_interface = { + "xdg_wm_base", 6, + 4, xdg_wm_base_requests, + 1, xdg_wm_base_events, +}; + +static const struct wl_message xdg_positioner_requests[] = { + { "destroy", "", xdg_shell_types + 0 }, + { "set_size", "ii", xdg_shell_types + 0 }, + { "set_anchor_rect", "iiii", xdg_shell_types + 0 }, + { "set_anchor", "u", xdg_shell_types + 0 }, + { "set_gravity", "u", xdg_shell_types + 0 }, + { "set_constraint_adjustment", "u", xdg_shell_types + 0 }, + { "set_offset", "ii", xdg_shell_types + 0 }, + { "set_reactive", "3", xdg_shell_types + 0 }, + { "set_parent_size", "3ii", xdg_shell_types + 0 }, + { "set_parent_configure", "3u", xdg_shell_types + 0 }, +}; + +WL_PRIVATE const struct wl_interface xdg_positioner_interface = { + "xdg_positioner", 6, + 10, xdg_positioner_requests, + 0, NULL, +}; + +static const struct wl_message xdg_surface_requests[] = { + { "destroy", "", xdg_shell_types + 0 }, + { "get_toplevel", "n", xdg_shell_types + 7 }, + { "get_popup", "n?oo", xdg_shell_types + 8 }, + { "set_window_geometry", "iiii", xdg_shell_types + 0 }, + { "ack_configure", "u", xdg_shell_types + 0 }, +}; + +static const struct wl_message xdg_surface_events[] = { + { "configure", "u", xdg_shell_types + 0 }, +}; + +WL_PRIVATE const struct wl_interface xdg_surface_interface = { + "xdg_surface", 6, + 5, xdg_surface_requests, + 1, xdg_surface_events, +}; + +static const struct wl_message xdg_toplevel_requests[] = { + { "destroy", "", xdg_shell_types + 0 }, + { "set_parent", "?o", xdg_shell_types + 11 }, + { "set_title", "s", xdg_shell_types + 0 }, + { "set_app_id", "s", xdg_shell_types + 0 }, + { "show_window_menu", "ouii", xdg_shell_types + 12 }, + { "move", "ou", xdg_shell_types + 16 }, + { "resize", "ouu", xdg_shell_types + 18 }, + { "set_max_size", "ii", xdg_shell_types + 0 }, + { "set_min_size", "ii", xdg_shell_types + 0 }, + { "set_maximized", "", xdg_shell_types + 0 }, + { "unset_maximized", "", xdg_shell_types + 0 }, + { "set_fullscreen", "?o", xdg_shell_types + 21 }, + { "unset_fullscreen", "", xdg_shell_types + 0 }, + { "set_minimized", "", xdg_shell_types + 0 }, +}; + +static const struct wl_message xdg_toplevel_events[] = { + { "configure", "iia", xdg_shell_types + 0 }, + { "close", "", xdg_shell_types + 0 }, + { "configure_bounds", "4ii", xdg_shell_types + 0 }, + { "wm_capabilities", "5a", xdg_shell_types + 0 }, +}; + +WL_PRIVATE const struct wl_interface xdg_toplevel_interface = { + "xdg_toplevel", 6, + 14, xdg_toplevel_requests, + 4, xdg_toplevel_events, +}; + +static const struct wl_message xdg_popup_requests[] = { + { "destroy", "", xdg_shell_types + 0 }, + { "grab", "ou", xdg_shell_types + 22 }, + { "reposition", "3ou", xdg_shell_types + 24 }, +}; + +static const struct wl_message xdg_popup_events[] = { + { "configure", "iiii", xdg_shell_types + 0 }, + { "popup_done", "", xdg_shell_types + 0 }, + { "repositioned", "3u", xdg_shell_types + 0 }, +}; + +WL_PRIVATE const struct wl_interface xdg_popup_interface = { + "xdg_popup", 6, + 3, xdg_popup_requests, + 3, xdg_popup_events, +}; + diff --git a/Source/ThirdParty/Wayland/xdg-toplevel-drag-v1.c b/Source/ThirdParty/Wayland/xdg-toplevel-drag-v1.c new file mode 100644 index 000000000..9e8f12ef7 --- /dev/null +++ b/Source/ThirdParty/Wayland/xdg-toplevel-drag-v1.c @@ -0,0 +1,74 @@ +/* Generated by wayland-scanner 1.23.1 */ + +/* + * Copyright 2023 David Redondo + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice (including the next + * paragraph) shall be included in all copies or substantial portions of the + * Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. + */ + +#include +#include +#include +#include "wayland-util.h" + +#ifndef __has_attribute +# define __has_attribute(x) 0 /* Compatibility with non-clang compilers. */ +#endif + +#if (__has_attribute(visibility) || defined(__GNUC__) && __GNUC__ >= 4) +#define WL_PRIVATE __attribute__ ((visibility("hidden"))) +#else +#define WL_PRIVATE +#endif + +extern const struct wl_interface wl_data_source_interface; +extern const struct wl_interface xdg_toplevel_interface; +extern const struct wl_interface xdg_toplevel_drag_v1_interface; + +static const struct wl_interface *xdg_toplevel_drag_v1_types[] = { + &xdg_toplevel_drag_v1_interface, + &wl_data_source_interface, + &xdg_toplevel_interface, + NULL, + NULL, +}; + +static const struct wl_message xdg_toplevel_drag_manager_v1_requests[] = { + { "destroy", "", xdg_toplevel_drag_v1_types + 0 }, + { "get_xdg_toplevel_drag", "no", xdg_toplevel_drag_v1_types + 0 }, +}; + +WL_PRIVATE const struct wl_interface xdg_toplevel_drag_manager_v1_interface = { + "xdg_toplevel_drag_manager_v1", 1, + 2, xdg_toplevel_drag_manager_v1_requests, + 0, NULL, +}; + +static const struct wl_message xdg_toplevel_drag_v1_requests[] = { + { "destroy", "", xdg_toplevel_drag_v1_types + 0 }, + { "attach", "oii", xdg_toplevel_drag_v1_types + 2 }, +}; + +WL_PRIVATE const struct wl_interface xdg_toplevel_drag_v1_interface = { + "xdg_toplevel_drag_v1", 1, + 2, xdg_toplevel_drag_v1_requests, + 0, NULL, +}; + diff --git a/Source/Tools/Flax.Build/Platforms/Linux/LinuxToolchain.cs b/Source/Tools/Flax.Build/Platforms/Linux/LinuxToolchain.cs index 7ded704f1..a976cc8cf 100644 --- a/Source/Tools/Flax.Build/Platforms/Linux/LinuxToolchain.cs +++ b/Source/Tools/Flax.Build/Platforms/Linux/LinuxToolchain.cs @@ -126,6 +126,7 @@ namespace Flax.Build.Platforms args.Add("-lXcursor"); args.Add("-lXinerama"); args.Add("-lXfixes"); + args.Add("-lwayland-client"); } ///