diff --git a/autotests/client/CMakeLists.txt b/autotests/client/CMakeLists.txt --- a/autotests/client/CMakeLists.txt +++ b/autotests/client/CMakeLists.txt @@ -376,6 +376,17 @@ target_link_libraries( testXdgShellV6 Qt5::Test Qt5::Gui KF5::WaylandServer KF5::WaylandClient Wayland::Client) add_test(NAME kwayland-testXdgShellV6 COMMAND testXdgShellV6) ecm_mark_as_test(testXdgShellV6) +######################################################## +# Test XdgShellStable +######################################################## +set( testXdgShellStable_SRCS + test_xdg_shell.cpp + test_xdg_shell_stable.cpp + ) +add_executable(testXdgShellStable ${testXdgShellStable_SRCS}) +target_link_libraries( testXdgShellStable Qt5::Test Qt5::Gui KF5::WaylandServer KF5::WaylandClient Wayland::Client) +add_test(NAME kwayland-testXdgShellStable COMMAND testXdgShellStable) +ecm_mark_as_test(testXdgShellStable) ######################################################## # Test Pointer Constraints diff --git a/autotests/client/test_xdg_shell.cpp b/autotests/client/test_xdg_shell.cpp --- a/autotests/client/test_xdg_shell.cpp +++ b/autotests/client/test_xdg_shell.cpp @@ -76,8 +76,9 @@ QSignalSpy outputAnnouncedSpy(®istry, &Registry::outputAnnounced); QVERIFY(outputAnnouncedSpy.isValid()); - auto shellAnnouncedSignal = m_version == XdgShellInterfaceVersion::UnstableV5 ? - &Registry::xdgShellUnstableV5Announced : &Registry::xdgShellUnstableV6Announced; + auto shellAnnouncedSignal = m_version == XdgShellInterfaceVersion::UnstableV5 ? &Registry::xdgShellUnstableV5Announced : + m_version == XdgShellInterfaceVersion::UnstableV6 ? &Registry::xdgShellUnstableV6Announced : + &Registry::xdgShellStableAnnounced; QSignalSpy xdgShellAnnouncedSpy(®istry, shellAnnouncedSignal); QVERIFY(xdgShellAnnouncedSpy.isValid()); @@ -105,7 +106,18 @@ QCOMPARE(xdgShellAnnouncedSpy.count(), 1); - Registry::Interface iface = m_version == XdgShellInterfaceVersion::UnstableV5 ? Registry::Interface::XdgShellUnstableV5 : Registry::Interface::XdgShellUnstableV6; + Registry::Interface iface; + switch (m_version) { + case XdgShellInterfaceVersion::UnstableV5: + iface = Registry::Interface::XdgShellUnstableV5; + break; + case XdgShellInterfaceVersion::UnstableV6: + iface = Registry::Interface::XdgShellUnstableV6; + break; + case XdgShellInterfaceVersion::Stable: + iface = Registry::Interface::XdgShellStable; + break; + } m_xdgShell = registry.createXdgShell(registry.interface(iface).name, registry.interface(iface).version, diff --git a/autotests/client/test_xdg_shell_stable.cpp b/autotests/client/test_xdg_shell_stable.cpp new file mode 100644 --- /dev/null +++ b/autotests/client/test_xdg_shell_stable.cpp @@ -0,0 +1,224 @@ +/******************************************************************** +Copyright 2016 Martin Gräßlin +Copyright 2017 David Edmundson + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) version 3, or any +later version accepted by the membership of KDE e.V. (or its +successor approved by the membership of KDE e.V.), which shall +act as a proxy defined in Section 6 of version 3 of the license. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library. If not, see . +*********************************************************************/ + +#include "test_xdg_shell.h" +#include + +class XdgShellTestStable : public XdgShellTest { + Q_OBJECT +public: + XdgShellTestStable() : + XdgShellTest(KWayland::Server::XdgShellInterfaceVersion::Stable) {} + +private Q_SLOTS: + void testMaxSize(); + void testMinSize(); + + void testPopup_data(); + void testPopup(); + + void testMultipleRoles1(); + void testMultipleRoles2(); +}; + +void XdgShellTestStable::testMaxSize() +{ + qRegisterMetaType(); + // this test verifies changing the window maxSize + QSignalSpy xdgSurfaceCreatedSpy(m_xdgShellInterface, &XdgShellInterface::surfaceCreated); + QVERIFY(xdgSurfaceCreatedSpy.isValid()); + QScopedPointer surface(m_compositor->createSurface()); + QScopedPointer xdgSurface(m_xdgShell->createSurface(surface.data())); + QVERIFY(xdgSurfaceCreatedSpy.wait()); + auto serverXdgSurface = xdgSurfaceCreatedSpy.first().first().value(); + QVERIFY(serverXdgSurface); + + QSignalSpy maxSizeSpy(serverXdgSurface, &XdgShellSurfaceInterface::maxSizeChanged); + QVERIFY(maxSizeSpy.isValid()); + + xdgSurface->setMaxSize(QSize(100, 100)); + QVERIFY(maxSizeSpy.wait()); + QCOMPARE(maxSizeSpy.count(), 1); + QCOMPARE(maxSizeSpy.last().at(0).value(), QSize(100,100)); + + xdgSurface->setMaxSize(QSize(200, 200)); + QVERIFY(maxSizeSpy.wait()); + QCOMPARE(maxSizeSpy.count(), 2); + QCOMPARE(maxSizeSpy.last().at(0).value(), QSize(200,200)); +} + + +void XdgShellTestStable::testPopup_data() +{ + QTest::addColumn("positioner"); + XdgPositioner positioner(QSize(10,10), QRect(100,100,50,50)); + QTest::newRow("default") << positioner; + + XdgPositioner positioner2(QSize(20,20), QRect(101,102,51,52)); + QTest::newRow("sizeAndAnchorRect") << positioner2; + + positioner.setAnchorEdge(Qt::TopEdge | Qt::RightEdge); + QTest::newRow("anchorEdge") << positioner; + + positioner.setGravity(Qt::BottomEdge); + QTest::newRow("gravity") << positioner; + + positioner.setGravity(Qt::TopEdge | Qt::RightEdge); + QTest::newRow("gravity2") << positioner; + + positioner.setConstraints(XdgPositioner::Constraint::SlideX | XdgPositioner::Constraint::FlipY); + QTest::newRow("constraints") << positioner; + + positioner.setConstraints(XdgPositioner::Constraint::SlideX | XdgPositioner::Constraint::SlideY | XdgPositioner::Constraint::FlipX | XdgPositioner::Constraint::FlipY | XdgPositioner::Constraint::ResizeX | XdgPositioner::Constraint::ResizeY); + QTest::newRow("constraints2") << positioner; + + positioner.setAnchorOffset(QPoint(4,5)); + QTest::newRow("offset") << positioner; +} + +void XdgShellTestStable::testPopup() +{ + QSignalSpy xdgTopLevelCreatedSpy(m_xdgShellInterface, &XdgShellInterface::surfaceCreated); + QSignalSpy xdgPopupCreatedSpy(m_xdgShellInterface, &XdgShellInterface::xdgPopupCreated); + + QScopedPointer parentSurface(m_compositor->createSurface()); + QScopedPointer xdgParentSurface(m_xdgShell->createSurface(parentSurface.data())); + + QVERIFY(xdgTopLevelCreatedSpy.wait()); + auto serverXdgTopLevel = xdgTopLevelCreatedSpy.first().first().value(); + + QFETCH(XdgPositioner, positioner); + + QScopedPointer surface(m_compositor->createSurface()); + QScopedPointer xdgSurface(m_xdgShell->createPopup(surface.data(), xdgParentSurface.data(), positioner)); + QVERIFY(xdgPopupCreatedSpy.wait()); + auto serverXdgPopup = xdgPopupCreatedSpy.first().first().value(); + QVERIFY(serverXdgPopup); + + QCOMPARE(serverXdgPopup->initialSize(), positioner.initialSize()); + QCOMPARE(serverXdgPopup->anchorRect(), positioner.anchorRect()); + QCOMPARE(serverXdgPopup->anchorEdge(), positioner.anchorEdge()); + QCOMPARE(serverXdgPopup->gravity(), positioner.gravity()); + QCOMPARE(serverXdgPopup->anchorOffset(), positioner.anchorOffset()); + //we have different enums for client server, but they share the same values + QCOMPARE((int)serverXdgPopup->constraintAdjustments(), (int)positioner.constraints()); + QCOMPARE(serverXdgPopup->transientFor().data(), serverXdgTopLevel->surface()); +} + +void XdgShellTestStable::testMinSize() +{ + qRegisterMetaType(); + // this test verifies changing the window minSize + QSignalSpy xdgSurfaceCreatedSpy(m_xdgShellInterface, &XdgShellInterface::surfaceCreated); + QVERIFY(xdgSurfaceCreatedSpy.isValid()); + QScopedPointer surface(m_compositor->createSurface()); + QScopedPointer xdgSurface(m_xdgShell->createSurface(surface.data())); + QVERIFY(xdgSurfaceCreatedSpy.wait()); + auto serverXdgSurface = xdgSurfaceCreatedSpy.first().first().value(); + QVERIFY(serverXdgSurface); + + QSignalSpy minSizeSpy(serverXdgSurface, &XdgShellSurfaceInterface::minSizeChanged); + QVERIFY(minSizeSpy.isValid()); + + xdgSurface->setMinSize(QSize(200, 200)); + QVERIFY(minSizeSpy.wait()); + QCOMPARE(minSizeSpy.count(), 1); + QCOMPARE(minSizeSpy.last().at(0).value(), QSize(200,200)); + + xdgSurface->setMinSize(QSize(100, 100)); + QVERIFY(minSizeSpy.wait()); + QCOMPARE(minSizeSpy.count(), 2); + QCOMPARE(minSizeSpy.last().at(0).value(), QSize(100,100)); +} + +//top level then toplevel +void XdgShellTestStable::testMultipleRoles1() +{ + //setting multiple roles on an xdg surface should fail + QSignalSpy xdgSurfaceCreatedSpy(m_xdgShellInterface, &XdgShellInterface::surfaceCreated); + QSignalSpy xdgPopupCreatedSpy(m_xdgShellInterface, &XdgShellInterface::xdgPopupCreated); + + QVERIFY(xdgSurfaceCreatedSpy.isValid()); + QVERIFY(xdgPopupCreatedSpy.isValid()); + + QScopedPointer surface(m_compositor->createSurface()); + //This is testing we work when a client does something stupid + //we can't use KWayland API here because by design that stops you from doing anything stupid + + qDebug() << (xdg_wm_base*)*m_xdgShell; + auto xdgSurface = xdg_wm_base_get_xdg_surface(*m_xdgShell, *surface.data()); + + //create a top level + auto xdgTopLevel1 = xdg_surface_get_toplevel(xdgSurface); + QVERIFY(xdgSurfaceCreatedSpy.wait()); + + //now try to create another top level for the same xdg surface. It should fail + auto xdgTopLevel2 = xdg_surface_get_toplevel(xdgSurface); + QVERIFY(!xdgSurfaceCreatedSpy.wait(10)); + + xdg_toplevel_destroy(xdgTopLevel1); + xdg_toplevel_destroy(xdgTopLevel2); + xdg_surface_destroy(xdgSurface); +} + +//toplevel then popup +void XdgShellTestStable::testMultipleRoles2() +{ + QSignalSpy xdgSurfaceCreatedSpy(m_xdgShellInterface, &XdgShellInterface::surfaceCreated); + QSignalSpy xdgPopupCreatedSpy(m_xdgShellInterface, &XdgShellInterface::xdgPopupCreated); + + QVERIFY(xdgSurfaceCreatedSpy.isValid()); + QVERIFY(xdgPopupCreatedSpy.isValid()); + + QScopedPointer surface(m_compositor->createSurface()); + QScopedPointer parentSurface(m_compositor->createSurface()); + + auto parentXdgSurface = xdg_wm_base_get_xdg_surface(*m_xdgShell, *parentSurface.data()); + auto xdgTopLevelParent = xdg_surface_get_toplevel(parentXdgSurface); + QVERIFY(xdgSurfaceCreatedSpy.wait()); + + + auto xdgSurface = xdg_wm_base_get_xdg_surface(*m_xdgShell, *surface.data()); + //create a top level + auto xdgTopLevel1 = xdg_surface_get_toplevel(xdgSurface); + QVERIFY(xdgSurfaceCreatedSpy.wait()); + + //now try to create a popup on the same xdg surface. It should fail + + auto positioner = xdg_wm_base_create_positioner(*m_xdgShell); + xdg_positioner_set_anchor_rect(positioner,10, 10, 10, 10); + xdg_positioner_set_size(positioner,10, 100); + + auto xdgPopup2 = xdg_surface_get_popup(xdgSurface, parentXdgSurface, positioner); + QVERIFY(!xdgPopupCreatedSpy.wait(10)); + + xdg_positioner_destroy(positioner); + xdg_toplevel_destroy(xdgTopLevel1); + xdg_toplevel_destroy(xdgTopLevelParent); + xdg_popup_destroy(xdgPopup2); + xdg_surface_destroy(xdgSurface); +} + + +QTEST_GUILESS_MAIN(XdgShellTestStable) + +#include "test_xdg_shell_stable.moc" + diff --git a/src/client/CMakeLists.txt b/src/client/CMakeLists.txt --- a/src/client/CMakeLists.txt +++ b/src/client/CMakeLists.txt @@ -57,6 +57,7 @@ xdgforeign.cpp xdgshell_v5.cpp xdgshell_v6.cpp + xdgshell_stable.cpp xdgoutput.cpp ../compat/wayland-xdg-shell-v5-protocol.c ) @@ -169,6 +170,12 @@ BASENAME xdg-output-unstable-v1 ) +ecm_add_wayland_client_protocol(CLIENT_LIB_SRCS + PROTOCOL ${KWayland_SOURCE_DIR}/src/client/protocols/xdg-shell.xml + BASENAME xdg-shell +) + + set(CLIENT_GENERATED_FILES ${CMAKE_CURRENT_BINARY_DIR}/wayland-fullscreen-shell-client-protocol.h ${CMAKE_CURRENT_BINARY_DIR}/wayland-output-management-client-protocol.h diff --git a/src/client/protocols/xdg-shell.xml b/src/client/protocols/xdg-shell.xml new file mode 100644 --- /dev/null +++ b/src/client/protocols/xdg-shell.xml @@ -0,0 +1,1120 @@ + + + + + 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 protocol 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. + + 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. + + + + + + + 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.ping. + + 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. + + 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 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. + + + + + + + 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. + + + + + + + + + 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. + + 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. + + + + + + + + + + + Destroy the xdg_surface object. An xdg_surface must only be destroyed + after its role object has been destroyed. + + + + + + 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, and will be applied at the + time wl_surface.commit of the corresponding wl_surface is called. + + 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. + + The width and height must be greater than zero. Setting an invalid size + will raise an error. 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. + + + + + + + + + + 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. + + 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. + + + + + + + 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. + + 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. + + 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 windows 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 window removes any parent-child + relationship for the child. Setting a null parent for a window which + currently has no parent is a no-op. + + If the parent is unmapped then its children are managed as + though the parent of the now-unmapped parent has become the + parent of this surface. If no parent exists for the now-unmapped + parent then the children are managed as though they have no + parent surface. + + + + + + + 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". + + 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] http://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. + + 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. 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. They will get applied on + the next commit. + + + + The surface is maximized. The window geometry specified in the configure + event must be obeyed by the client. + + + + + 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. + + + + + + + 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. They will get applied + on the next 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 a protocol 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 + protocol 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. They will get applied + on the next 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 a protocol 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 + protocol error. + + + + + + + + Maximize the surface. + + After requesting that the surface should be maximized, the compositor + will respond by emitting a configure event with the "maximized" state + and the required window geometry. The client should then update its + content, drawing it in a maximized state, i.e. without shadow or other + decoration outside of the window geometry. 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 will alter the state the surface is returned to when + unmaximized if not overridden by the compositor. + + + + + + Unmaximize the surface. + + After requesting that the surface should be unmaximized, the compositor + will respond by emitting a configure event without the "maximized" + state. If available, 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 a + regular state, i.e. potentially with shadow, etc. 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 will alter the state the surface is returned to when + unmaximized if not 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 with the + "fullscreen" state and the fullscreen window geometry. 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 without the + "fullscreen" state. + + 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. + + + + + + + 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. + + The parent surface must have either the xdg_toplevel or xdg_popup surface + role. + + 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 x and y arguments passed when creating the popup object specify + where the top left of the popup should be placed, relative to the + local surface coordinates of the parent surface. See + xdg_surface.get_popup. An xdg_popup must intersect with or be at least + partially adjacent to its parent surface. + + 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, a 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. + + The parent of a grabbing popup must either be another xdg_popup with an + active explicit grab, or an xdg_popup or xdg_toplevel, if there are no + explicit grabs already taken. + + 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. + + + + + + + + + + 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. + + + + + diff --git a/src/client/registry.h b/src/client/registry.h --- a/src/client/registry.h +++ b/src/client/registry.h @@ -54,6 +54,7 @@ struct org_kde_kwin_server_decoration_palette_manager; struct xdg_shell; struct zxdg_shell_v6; +struct xdg_wm_base; struct zwp_relative_pointer_manager_v1; struct zwp_pointer_gestures_v1; struct zwp_pointer_constraints_v1; @@ -176,6 +177,7 @@ ServerSideDecorationPalette, ///Refers to org_kde_kwin_server_decoration_palette_manager @since 5.42 RemoteAccessManager, ///< Refers to org_kde_kwin_remote_access_manager interface, @since 5.45 XdgOutputUnstableV1, ///refers to zxdg_output_v1, @since 5.47 + XdgShellStable ///refers to xdg_wm_base @since 5.XDGSHELL_VERSION }; explicit Registry(QObject *parent = nullptr); virtual ~Registry(); @@ -530,6 +532,16 @@ * @since 5.39 **/ zxdg_shell_v6 *bindXdgShellUnstableV6(uint32_t name, uint32_t version) const; + /** + * Binds the zxdg_shell_v6 (unstable version 6) with @p name and @p version. + * If the @p name does not exist or is not for the xdg shell interface in unstable version 5, + * @c null will be returned. + * + * Prefer using createXdgShell instead. + * @see createXdgShell + * @since 5.39 + **/ + xdg_wm_base *bindXdgShellStable(uint32_t name, uint32_t version) const; /** * Binds the zwp_relative_pointer_manager_v1 with @p name and @p version. * If the @p name does not exist or is not for the relative pointer interface in unstable version 1, @@ -1403,6 +1415,15 @@ */ void xdgOutputAnnounced(quint32 name, quint32 version); + /** + * Emitted whenever a xdg_wm_base (stable xdg shell) interface gets announced. + * @param name The name for the announced interface + * @param version The maximum supported version of the announced interface + * @since 5.XDGSHELL_VERSION + **/ + void xdgShellStableAnnounced(quint32 name, quint32 version); + + ///@} /** @@ -1611,6 +1632,12 @@ * @since 5.47 **/ void xdgOutputRemoved(quint32 name); + /** + * Emitted whenever an xdg_wm_base (stable xdgshell) interface gets removed. + * @param name The name for the removed interface + * @since 5.XDGSHELL_VERSION + **/ + void xdgShellStableRemoved(quint32 name); ///@} /** diff --git a/src/client/registry.cpp b/src/client/registry.cpp --- a/src/client/registry.cpp +++ b/src/client/registry.cpp @@ -78,6 +78,7 @@ #include #include "../compat/wayland-xdg-shell-v5-client-protocol.h" #include +#include #include #include #include @@ -350,6 +351,13 @@ &zxdg_output_manager_v1_interface, &Registry::xdgOutputAnnounced, &Registry::xdgOutputRemoved + }}, + {Registry::Interface::XdgShellStable, { + 1, + QByteArrayLiteral("xdg_wm_base"), + &xdg_wm_base_interface, + &Registry::xdgShellStableAnnounced, + &Registry::xdgShellStableRemoved }} }; @@ -649,6 +657,7 @@ BIND(TextInputManagerUnstableV2, zwp_text_input_manager_v2) BIND(XdgShellUnstableV5, xdg_shell) BIND(XdgShellUnstableV6, zxdg_shell_v6) +BIND(XdgShellStable, xdg_wm_base) BIND(RelativePointerManagerUnstableV1, zwp_relative_pointer_manager_v1) BIND(PointerGesturesUnstableV1, zwp_pointer_gestures_v1) BIND(PointerConstraintsUnstableV1, zwp_pointer_constraints_v1) @@ -750,6 +759,8 @@ return d->create(name, version, parent, &Registry::bindXdgShellUnstableV5); case Interface::XdgShellUnstableV6: return d->create(name, version, parent, &Registry::bindXdgShellUnstableV6); + case Interface::XdgShellStable: + return d->create(name, version, parent, &Registry::bindXdgShellStable); default: return nullptr; } diff --git a/src/client/xdgshell.h b/src/client/xdgshell.h --- a/src/client/xdgshell.h +++ b/src/client/xdgshell.h @@ -17,17 +17,20 @@ You should have received a copy of the GNU Lesser General Public License along with this library. If not, see . ****************************************************************************/ -#ifndef KWAYLAND_CLIENT_XDG_SHELL_V5_H -#define KWAYLAND_CLIENT_XDG_SHELL_V5_H +#ifndef KWAYLAND_CLIENT_XDG_SHELL_H +#define KWAYLAND_CLIENT_XDG_SHELL_H #include #include #include #include +//This is a mix of structs for both xdgshell unstable v5 AND xdg wm base stable +struct xdg_wm_base; struct xdg_shell; struct xdg_surface; struct xdg_popup; +struct xdg_toplevel; struct zxdg_shell_v6; struct zxdg_toplevel_v6; @@ -95,6 +98,7 @@ /** * Which edge of the anchor should the popup be positioned around */ + //KF6 TODO use a better data type (enum of 8 options) rather than flags which allow invalid values Qt::Edges anchorEdge() const; void setAnchorEdge(Qt::Edges edge); @@ -104,6 +108,7 @@ * if the gravity is top, then the bottom of the popup will be at the anchor edge * */ + //KF6 TODO use a better data type (enum of 8 options) rather than flags which allow invalid values Qt::Edges gravity() const; void setGravity(Qt::Edges edge); @@ -180,6 +185,12 @@ **/ void setup(zxdg_shell_v6 *xdgshellv6); + /** + * Setup this XdgShell to manage the @p xdg_wm_base. + * When using Registry::createXdgShell there is no need to call this + * method. + **/ + void setup(xdg_wm_base *xdg_wm_base); /** * @returns @c true if managing a xdg_shell. **/ @@ -239,12 +250,13 @@ **/ XdgShellPopup *createPopup(Surface *surface, XdgShellPopup *parentSurface, const XdgPositioner &positioner, QObject *parent = nullptr); + operator xdg_wm_base*(); + operator xdg_wm_base*() const; operator xdg_shell*(); operator xdg_shell*() const; operator zxdg_shell_v6*(); operator zxdg_shell_v6*() const; - Q_SIGNALS: /** * The corresponding global for this interface on the Registry got removed. @@ -314,6 +326,13 @@ **/ void setup(zxdg_surface_v6 *xdgsurfacev6, zxdg_toplevel_v6 *toplevel); + /** + * Setup this XdgShellSurface to manage the @p toplevel on the relevant @p xdgsurface + * When using XdgShell::createXdgShellSurface there is no need to call this + * method. + **/ + void setup(xdg_surface *xdgsurface, xdg_toplevel *toplevel); + /** * @returns @c true if managing a xdg_surface. **/ @@ -451,7 +470,8 @@ operator xdg_surface*(); operator xdg_surface*() const; - + operator xdg_toplevel*(); + operator xdg_toplevel*() const; operator zxdg_surface_v6*(); operator zxdg_surface_v6*() const; operator zxdg_toplevel_v6*(); @@ -503,6 +523,8 @@ * Setup this XdgShellPopup to manage the @p xdgpopupv5. * When using XdgShell::createXdgShellPopup there is no need to call this * method. + * + * This was for XDGShellV5, this is now deprecated **/ void setup(xdg_popup *xdgpopupv5); @@ -514,6 +536,14 @@ **/ void setup(zxdg_surface_v6 *xdgsurfacev6, zxdg_popup_v6 *xdgpopup6); + /** + * Setup this XdgShellPopup to manage the @p xdgpopupv on associated @p xdgsurface + * When using XdgShell::createXdgShellPopup there is no need to call this + * method. + * @since 5.XDGSTABLE + **/ + void setup(xdg_surface *xdgsurface, xdg_popup *xdgpopup); + /** * @returns @c true if managing an xdg_popup. **/ @@ -556,7 +586,8 @@ */ void requestGrab(Seat *seat, quint32 serial); - + operator xdg_surface*(); + operator xdg_surface*() const; operator xdg_popup*(); operator xdg_popup*() const; operator zxdg_surface_v6*(); diff --git a/src/client/xdgshell.cpp b/src/client/xdgshell.cpp --- a/src/client/xdgshell.cpp +++ b/src/client/xdgshell.cpp @@ -53,6 +53,10 @@ d->setupV6(xdgshellv6); } +void XdgShell::setup(xdg_wm_base *xdg_wm_base) +{ + d->setup(xdg_wm_base); +} void XdgShell::release() { @@ -90,6 +94,15 @@ return *(d.data()); } +XdgShell::operator xdg_wm_base*() { + return *(d.data()); +} + +XdgShell::operator xdg_wm_base*() const { + return *(d.data()); +} + + bool XdgShell::isValid() const { return d->isValid(); @@ -143,6 +156,12 @@ d->setupV6(xdgsurfacev6, xdgtoplevelv6); } +void XdgShellSurface::setup(xdg_surface *xdgsurface, xdg_toplevel *xdgtoplevel) +{ + d->setup(xdgsurface, xdgtoplevel); +} + + void XdgShellSurface::release() { d->release(); @@ -171,6 +190,14 @@ return *(d.data()); } +XdgShellSurface::operator xdg_toplevel*() { + return *(d.data()); +} + +XdgShellSurface::operator xdg_toplevel*() const { + return *(d.data()); +} + XdgShellSurface::operator zxdg_surface_v6*() { return *(d.data()); } @@ -303,6 +330,11 @@ d->setupV6(xdgsurfacev6, xdgpopupv6); } +void XdgShellPopup::setup(xdg_surface *surface, xdg_popup *popup) +{ + d->setup(surface, popup); +} + void XdgShellPopup::release() { d->release(); @@ -328,6 +360,14 @@ d->requestGrab(seat, serial); } +XdgShellPopup::operator xdg_surface*() { + return *(d.data()); +} + +XdgShellPopup::operator xdg_surface*() const { + return *(d.data()); +} + XdgShellPopup::operator xdg_popup*() { return *(d.data()); } diff --git a/src/client/xdgshell_p.h b/src/client/xdgshell_p.h --- a/src/client/xdgshell_p.h +++ b/src/client/xdgshell_p.h @@ -40,6 +40,9 @@ virtual void setupV6(zxdg_shell_v6 *xdgshellv6) { Q_UNUSED(xdgshellv6) } + virtual void setup(xdg_wm_base *xdgshell) { + Q_UNUSED(xdgshell); + } virtual void release() = 0; virtual void destroy() = 0; virtual bool isValid() const = 0; @@ -55,6 +58,13 @@ virtual operator zxdg_shell_v6*() const { return nullptr; } + virtual operator xdg_wm_base*() { + return nullptr; + } + virtual operator xdg_wm_base*() const { + return nullptr; + } + virtual XdgShellSurface *getXdgSurface(Surface *surface, QObject *parent) = 0; virtual XdgShellPopup *getXdgPopup(Surface *surface, Surface *parentSurface, Seat *seat, quint32 serial, const QPoint &parentPos, QObject *parent) { @@ -115,6 +125,18 @@ class Private; }; +class XdgShellStable : public XdgShell +{ + Q_OBJECT +public: + explicit XdgShellStable(QObject *parent = nullptr); + virtual ~XdgShellStable(); + +private: + class Private; + +}; + class XdgShellSurfaceUnstableV5 : public XdgShellSurface { Q_OBJECT @@ -139,6 +161,18 @@ class Private; }; +class XdgTopLevelStable : public XdgShellSurface +{ + Q_OBJECT +public: + virtual ~XdgTopLevelStable(); + +private: + explicit XdgTopLevelStable(QObject *parent = nullptr); + friend class XdgShellStable; + class Private; +}; + class Q_DECL_HIDDEN XdgShellSurface::Private { public: @@ -154,6 +188,11 @@ Q_UNUSED(toplevel) Q_UNUSED(surface) } + virtual void setup(xdg_surface *surface, xdg_toplevel *toplevel) + { + Q_UNUSED(surface) + Q_UNUSED(toplevel) + } virtual void release() = 0; virtual void destroy() = 0; virtual bool isValid() const = 0; @@ -163,6 +202,12 @@ virtual operator xdg_surface*() const { return nullptr; } + virtual operator xdg_toplevel*() { + return nullptr; + } + virtual operator xdg_toplevel*() const { + return nullptr; + } virtual operator zxdg_surface_v6*() { return nullptr; } @@ -212,13 +257,23 @@ Q_UNUSED(s) Q_UNUSED(p) } + virtual void setup(xdg_surface *s, xdg_popup *p) { + Q_UNUSED(s) + Q_UNUSED(p) + } virtual void release() = 0; virtual void destroy() = 0; virtual bool isValid() const = 0; virtual void requestGrab(Seat *seat, quint32 serial) { Q_UNUSED(seat); Q_UNUSED(serial); }; + virtual operator xdg_surface*() { + return nullptr; + } + virtual operator xdg_surface*() const { + return nullptr; + } virtual operator xdg_popup*() { return nullptr; } @@ -278,7 +333,16 @@ class Private; }; +class XdgShellPopupStable : public XdgShellPopup +{ +public: + virtual ~XdgShellPopupStable(); +private: + explicit XdgShellPopupStable(QObject *parent = nullptr); + friend class XdgShellStable; + class Private; +}; } } diff --git a/src/client/xdgshell_stable.cpp b/src/client/xdgshell_stable.cpp new file mode 100644 --- /dev/null +++ b/src/client/xdgshell_stable.cpp @@ -0,0 +1,600 @@ +/**************************************************************************** +Copyright 2017 David Edmundson + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) version 3, or any +later version accepted by the membership of KDE e.V. (or its +successor approved by the membership of KDE e.V.), which shall +act as a proxy defined in Section 6 of version 3 of the license. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library. If not, see . +****************************************************************************/ +#include "xdgshell_p.h" +#include "event_queue.h" +#include "output.h" +#include "seat.h" +#include "surface.h" +#include "wayland_pointer_p.h" +#include + +namespace KWayland +{ +namespace Client +{ + +class XdgShellStable::Private : public XdgShell::Private +{ +public: + void setup(xdg_wm_base *shell) override; + void release() override; + void destroy() override; + bool isValid() const override; + XdgShellSurface *getXdgSurface(Surface *surface, QObject *parent) override; + + XdgShellPopup *getXdgPopup(Surface *surface, XdgShellSurface *parentSurface, const XdgPositioner &positioner, QObject *parent) override; + XdgShellPopup *getXdgPopup(Surface *surface, XdgShellPopup *parentSurface, const XdgPositioner &positioner, QObject *parent) override; + + operator xdg_wm_base*() override { + return xdg_shell_base; + } + operator xdg_wm_base*() const override { + return xdg_shell_base; + } + +private: + XdgShellPopup *internalGetXdgPopup(Surface *surface, xdg_surface *parentSurface, const XdgPositioner &positioner, QObject *parent); + static void pingCallback(void *data, struct xdg_wm_base *shell, uint32_t serial); + + WaylandPointer xdg_shell_base; + static const struct xdg_wm_base_listener s_shellListener; +}; + +const struct xdg_wm_base_listener XdgShellStable::Private::s_shellListener = { + pingCallback, +}; + +void XdgShellStable::Private::pingCallback(void *data, struct xdg_wm_base *shell, uint32_t serial) +{ + Q_UNUSED(data) + xdg_wm_base_pong(shell, serial); +} + +void XdgShellStable::Private::setup(xdg_wm_base *shell) +{ + Q_ASSERT(shell); + Q_ASSERT(!xdg_shell_base); + xdg_shell_base.setup(shell); + xdg_wm_base_add_listener(shell, &s_shellListener, this); +} + +void XdgShellStable::Private::release() +{ + xdg_shell_base.release(); +} + +void XdgShellStable::Private::destroy() +{ + xdg_shell_base.destroy(); +} + +bool XdgShellStable::Private::isValid() const +{ + return xdg_shell_base.isValid(); +} + +XdgShellSurface *XdgShellStable::Private::getXdgSurface(Surface *surface, QObject *parent) +{ + Q_ASSERT(isValid()); + auto ss = xdg_wm_base_get_xdg_surface(xdg_shell_base, *surface); + + if (!ss) { + return nullptr; + } + + auto s = new XdgTopLevelStable(parent); + auto toplevel = xdg_surface_get_toplevel(ss); + if (queue) { + queue->addProxy(ss); + queue->addProxy(toplevel); + } + s->setup(ss, toplevel); + return s; +} + +XdgShellPopup *XdgShellStable::Private::getXdgPopup(Surface *surface, XdgShellSurface *parentSurface, const XdgPositioner &positioner, QObject *parent) +{ + return internalGetXdgPopup(surface, *parentSurface, positioner, parent); +} + +XdgShellPopup *XdgShellStable::Private::getXdgPopup(Surface *surface, XdgShellPopup *parentSurface, const XdgPositioner &positioner, QObject *parent) +{ + return internalGetXdgPopup(surface, *parentSurface, positioner, parent); +} + +XdgShellPopup *XdgShellStable::Private::internalGetXdgPopup(Surface *surface, xdg_surface *parentSurface, const XdgPositioner &positioner, QObject *parent) +{ + Q_ASSERT(isValid()); + auto ss = xdg_wm_base_get_xdg_surface(xdg_shell_base, *surface); + if (!ss) { + return nullptr; + } + + auto p = xdg_wm_base_create_positioner(xdg_shell_base); + + auto anchorRect = positioner.anchorRect(); + xdg_positioner_set_anchor_rect(p, anchorRect.x(), anchorRect.y(), anchorRect.width(), anchorRect.height()); + + QSize initialSize = positioner.initialSize(); + xdg_positioner_set_size(p, initialSize.width(), initialSize.height()); + + QPoint anchorOffset = positioner.anchorOffset(); + if (!anchorOffset.isNull()) { + xdg_positioner_set_offset(p, anchorOffset.x(), anchorOffset.y()); + } + + uint32_t anchor = XDG_POSITIONER_ANCHOR_NONE; + if (positioner.anchorEdge().testFlag(Qt::TopEdge)) { + if (positioner.anchorEdge().testFlag(Qt::LeftEdge) && ((positioner.anchorEdge() & ~Qt::LeftEdge) == Qt::TopEdge)) { + anchor = XDG_POSITIONER_ANCHOR_TOP_LEFT; + } else if (positioner.anchorEdge().testFlag(Qt::RightEdge) && ((positioner.anchorEdge() & ~Qt::RightEdge) == Qt::TopEdge)) { + anchor = XDG_POSITIONER_ANCHOR_TOP_RIGHT; + } else if ((positioner.anchorEdge() & ~Qt::TopEdge) == Qt::Edges()) { + anchor = XDG_POSITIONER_ANCHOR_TOP; + } + } else if (positioner.anchorEdge().testFlag(Qt::BottomEdge)) { + if (positioner.anchorEdge().testFlag(Qt::LeftEdge) && ((positioner.anchorEdge() & ~Qt::LeftEdge) == Qt::BottomEdge)) { + anchor = XDG_POSITIONER_ANCHOR_BOTTOM_LEFT; + } else if (positioner.anchorEdge().testFlag(Qt::RightEdge) && ((positioner.anchorEdge() & ~Qt::RightEdge) == Qt::BottomEdge)) { + anchor = XDG_POSITIONER_ANCHOR_BOTTOM_RIGHT; + } else if ((positioner.anchorEdge() & ~Qt::BottomEdge) == Qt::Edges()) { + anchor = XDG_POSITIONER_ANCHOR_BOTTOM; + } + } else if (positioner.anchorEdge().testFlag(Qt::RightEdge) && ((positioner.anchorEdge() & ~Qt::RightEdge) == Qt::Edges())) { + anchor = XDG_POSITIONER_ANCHOR_RIGHT; + } else if (positioner.anchorEdge().testFlag(Qt::LeftEdge) && ((positioner.anchorEdge() & ~Qt::LeftEdge) == Qt::Edges())) { + anchor = XDG_POSITIONER_ANCHOR_LEFT; + } + if (anchor != 0) { + xdg_positioner_set_anchor(p, anchor); + } + + uint32_t gravity = XDG_POSITIONER_GRAVITY_NONE; + if (positioner.gravity().testFlag(Qt::TopEdge)) { + if (positioner.gravity().testFlag(Qt::LeftEdge) && ((positioner.gravity() & ~Qt::LeftEdge) == Qt::TopEdge)) { + gravity = XDG_POSITIONER_GRAVITY_TOP_LEFT; + } else if (positioner.gravity().testFlag(Qt::RightEdge) && ((positioner.gravity() & ~Qt::RightEdge) == Qt::TopEdge)) { + gravity = XDG_POSITIONER_GRAVITY_TOP_RIGHT; + } else if ((positioner.gravity() & ~Qt::TopEdge) == Qt::Edges()) { + gravity = XDG_POSITIONER_GRAVITY_TOP; + } + } else if (positioner.gravity().testFlag(Qt::BottomEdge)) { + if (positioner.gravity().testFlag(Qt::LeftEdge) && ((positioner.gravity() & ~Qt::LeftEdge) == Qt::BottomEdge)) { + gravity = XDG_POSITIONER_GRAVITY_BOTTOM_LEFT; + } else if (positioner.gravity().testFlag(Qt::RightEdge) && ((positioner.gravity() & ~Qt::RightEdge) == Qt::BottomEdge)) { + gravity = XDG_POSITIONER_GRAVITY_BOTTOM_RIGHT; + } else if ((positioner.gravity() & ~Qt::BottomEdge) == Qt::Edges()) { + gravity = XDG_POSITIONER_GRAVITY_BOTTOM; + } + } else if (positioner.gravity().testFlag(Qt::RightEdge) && ((positioner.gravity() & ~Qt::RightEdge) == Qt::Edges())) { + gravity = XDG_POSITIONER_GRAVITY_RIGHT; + } else if (positioner.gravity().testFlag(Qt::LeftEdge) && ((positioner.gravity() & ~Qt::LeftEdge) == Qt::Edges())) { + gravity = XDG_POSITIONER_GRAVITY_LEFT; + } + if (gravity != 0) { + xdg_positioner_set_gravity(p, gravity); + } + + uint32_t constraint = XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_NONE; + if (positioner.constraints().testFlag(XdgPositioner::Constraint::SlideX)) { + constraint |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_X; + } + if (positioner.constraints().testFlag(XdgPositioner::Constraint::SlideY)) { + constraint |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_Y; + } + if (positioner.constraints().testFlag(XdgPositioner::Constraint::FlipX)) { + constraint |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_X; + } + if (positioner.constraints().testFlag(XdgPositioner::Constraint::FlipY)) { + constraint |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_Y; + } + if (positioner.constraints().testFlag(XdgPositioner::Constraint::ResizeX)) { + constraint |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_X; + } + if (positioner.constraints().testFlag(XdgPositioner::Constraint::ResizeY)) { + constraint |= XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_Y; + } + if (constraint != 0) { + xdg_positioner_set_constraint_adjustment(p, constraint); + } + + XdgShellPopup *s = new XdgShellPopupStable(parent); + auto popup = xdg_surface_get_popup(ss, parentSurface, p); + if (queue) { + //deliberately not adding the positioner because the positioner has no events sent to it + queue->addProxy(ss); + queue->addProxy(popup); + } + s->setup(ss, popup); + + xdg_positioner_destroy(p); + + return s; +} + +XdgShellStable::XdgShellStable(QObject *parent) + : XdgShell(new Private, parent) +{ +} + +XdgShellStable::~XdgShellStable() = default; + + +//A top level wraps both xdg_surface and xdg_top_level into the public API XdgShelllSurface +class XdgTopLevelStable::Private : public XdgShellSurface::Private +{ +public: + Private(XdgShellSurface *q); + WaylandPointer xdgtoplevel; + WaylandPointer xdgsurface; + + void setup(xdg_surface *surface, xdg_toplevel *toplevel) override; + void release() override; + void destroy() override; + bool isValid() const override; + + operator xdg_surface*() override { + return xdgsurface; + } + operator xdg_surface*() const override { + return xdgsurface; + } + operator xdg_toplevel*() override { + return xdgtoplevel; + } + operator xdg_toplevel*() const override { + return xdgtoplevel; + } + + void setTransientFor(XdgShellSurface *parent) override; + void setTitle(const QString &title) override; + void setAppId(const QByteArray &appId) override; + void showWindowMenu(Seat *seat, quint32 serial, qint32 x, qint32 y) override; + void move(Seat *seat, quint32 serial) override; + void resize(Seat *seat, quint32 serial, Qt::Edges edges) override; + void ackConfigure(quint32 serial) override; + void setMaximized() override; + void unsetMaximized() override; + void setFullscreen(Output *output) override; + void unsetFullscreen() override; + void setMinimized() override; + void setMaxSize(const QSize &size) override; + void setMinSize(const QSize &size) override; + +private: + QSize pendingSize; + States pendingState; + + static void configureCallback(void *data, struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height, struct wl_array *state); + static void closeCallback(void *data, xdg_toplevel *xdg_toplevel); + static void surfaceConfigureCallback(void *data, xdg_surface *xdg_surface, uint32_t serial); + + static const struct xdg_toplevel_listener s_toplevelListener; + static const struct xdg_surface_listener s_surfaceListener; +}; + +const struct xdg_toplevel_listener XdgTopLevelStable::Private::s_toplevelListener = { + configureCallback, + closeCallback +}; + +const struct xdg_surface_listener XdgTopLevelStable::Private::s_surfaceListener = { + surfaceConfigureCallback +}; + +void XdgTopLevelStable::Private::surfaceConfigureCallback(void *data, struct xdg_surface *surface, uint32_t serial) +{ + Q_UNUSED(surface) + auto s = static_cast(data); + s->q->configureRequested(s->pendingSize, s->pendingState, serial); + if (!s->pendingSize.isNull()) { + s->q->setSize(s->pendingSize); + s->pendingSize = QSize(); + } + s->pendingState = 0; +} + +void XdgTopLevelStable::Private::configureCallback(void *data, struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height, struct wl_array *state) +{ + Q_UNUSED(xdg_toplevel) + auto s = static_cast(data); + States states; + + uint32_t *statePtr = static_cast(state->data); + for (size_t i = 0; i < state->size / sizeof(uint32_t); i++) { + switch (statePtr[i]) { + case XDG_TOPLEVEL_STATE_MAXIMIZED: + states = states | XdgShellSurface::State::Maximized; + break; + case XDG_TOPLEVEL_STATE_FULLSCREEN: + states = states | XdgShellSurface::State::Fullscreen; + break; + case XDG_TOPLEVEL_STATE_RESIZING: + states = states | XdgShellSurface::State::Resizing; + break; + case XDG_TOPLEVEL_STATE_ACTIVATED: + states = states | XdgShellSurface::State::Activated; + break; + } + } + s->pendingSize = QSize(width, height); + s->pendingState = states; +} + +void XdgTopLevelStable::Private::closeCallback(void *data, xdg_toplevel *xdg_toplevel) +{ + auto s = static_cast(data); + Q_ASSERT(s->xdgtoplevel == xdg_toplevel); + emit s->q->closeRequested(); +} + +XdgTopLevelStable::Private::Private(XdgShellSurface *q) + : XdgShellSurface::Private(q) +{ +} + +void XdgTopLevelStable::Private::setup(xdg_surface *surface, xdg_toplevel *topLevel) +{ + Q_ASSERT(surface); + Q_ASSERT(!xdgtoplevel); + xdgsurface.setup(surface); + xdgtoplevel.setup(topLevel); + xdg_surface_add_listener(xdgsurface, &s_surfaceListener, this); + xdg_toplevel_add_listener(xdgtoplevel, &s_toplevelListener, this); +} + +void XdgTopLevelStable::Private::release() +{ + xdgtoplevel.release(); + xdgsurface.release(); +} + +void XdgTopLevelStable::Private::destroy() +{ + xdgtoplevel.destroy(); + xdgsurface.destroy(); +} + +bool XdgTopLevelStable::Private::isValid() const +{ + return xdgtoplevel.isValid() && xdgsurface.isValid(); +} + +void XdgTopLevelStable::Private::setTransientFor(XdgShellSurface *parent) +{ + xdg_toplevel *parentSurface = nullptr; + if (parent) { + parentSurface = *parent; + } + xdg_toplevel_set_parent(xdgtoplevel, parentSurface); +} + +void XdgTopLevelStable::Private::setTitle(const QString & title) +{ + xdg_toplevel_set_title(xdgtoplevel, title.toUtf8().constData()); +} + +void XdgTopLevelStable::Private::setAppId(const QByteArray & appId) +{ + xdg_toplevel_set_app_id(xdgtoplevel, appId.constData()); +} + +void XdgTopLevelStable::Private::showWindowMenu(Seat *seat, quint32 serial, qint32 x, qint32 y) +{ + xdg_toplevel_show_window_menu(xdgtoplevel, *seat, serial, x, y); +} + +void XdgTopLevelStable::Private::move(Seat *seat, quint32 serial) +{ + xdg_toplevel_move(xdgtoplevel, *seat, serial); +} + +void XdgTopLevelStable::Private::resize(Seat *seat, quint32 serial, Qt::Edges edges) +{ + uint wlEdge = XDG_TOPLEVEL_RESIZE_EDGE_NONE; + if (edges.testFlag(Qt::TopEdge)) { + if (edges.testFlag(Qt::LeftEdge) && ((edges & ~Qt::LeftEdge) == Qt::TopEdge)) { + wlEdge = XDG_TOPLEVEL_RESIZE_EDGE_TOP_LEFT; + } else if (edges.testFlag(Qt::RightEdge) && ((edges & ~Qt::RightEdge) == Qt::TopEdge)) { + wlEdge = XDG_TOPLEVEL_RESIZE_EDGE_TOP_RIGHT; + } else if ((edges & ~Qt::TopEdge) == Qt::Edges()) { + wlEdge = XDG_TOPLEVEL_RESIZE_EDGE_TOP; + } + } else if (edges.testFlag(Qt::BottomEdge)) { + if (edges.testFlag(Qt::LeftEdge) && ((edges & ~Qt::LeftEdge) == Qt::BottomEdge)) { + wlEdge = XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_LEFT; + } else if (edges.testFlag(Qt::RightEdge) && ((edges & ~Qt::RightEdge) == Qt::BottomEdge)) { + wlEdge = XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_RIGHT; + } else if ((edges & ~Qt::BottomEdge) == Qt::Edges()) { + wlEdge = XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM; + } + } else if (edges.testFlag(Qt::RightEdge) && ((edges & ~Qt::RightEdge) == Qt::Edges())) { + wlEdge = XDG_TOPLEVEL_RESIZE_EDGE_RIGHT; + } else if (edges.testFlag(Qt::LeftEdge) && ((edges & ~Qt::LeftEdge) == Qt::Edges())) { + wlEdge = XDG_TOPLEVEL_RESIZE_EDGE_LEFT; + } + xdg_toplevel_resize(xdgtoplevel, *seat, serial, wlEdge); +} + +void XdgTopLevelStable::Private::ackConfigure(quint32 serial) +{ + xdg_surface_ack_configure(xdgsurface, serial); +} + +void XdgTopLevelStable::Private::setMaximized() +{ + xdg_toplevel_set_maximized(xdgtoplevel); +} + +void XdgTopLevelStable::Private::unsetMaximized() +{ + xdg_toplevel_unset_maximized(xdgtoplevel); +} + +void XdgTopLevelStable::Private::setFullscreen(Output *output) +{ + wl_output *o = nullptr; + if (output) { + o = *output; + } + xdg_toplevel_set_fullscreen(xdgtoplevel, o); +} + +void XdgTopLevelStable::Private::unsetFullscreen() +{ + xdg_toplevel_unset_fullscreen(xdgtoplevel); +} + +void XdgTopLevelStable::Private::setMinimized() +{ + xdg_toplevel_set_minimized(xdgtoplevel); +} + +void XdgTopLevelStable::Private::setMaxSize(const QSize &size) +{ + xdg_toplevel_set_max_size(xdgtoplevel, size.width(), size.height()); +} + +void XdgTopLevelStable::Private::setMinSize(const QSize &size) +{ + xdg_toplevel_set_min_size(xdgtoplevel, size.width(), size.height()); +} + +XdgTopLevelStable::XdgTopLevelStable(QObject *parent) + : XdgShellSurface(new Private(this), parent) +{ +} + +XdgTopLevelStable::~XdgTopLevelStable() = default; + +class XdgShellPopupStable::Private : public XdgShellPopup::Private +{ +public: + Private(XdgShellPopup *q); + + void setup(xdg_surface *s, xdg_popup *p) override; + void release() override; + void destroy() override; + bool isValid() const override; + void requestGrab(Seat *seat, quint32 serial) override; + operator xdg_surface*() override { + return xdgsurfacev6; + } + operator xdg_surface*() const override { + return xdgsurfacev6; + } + operator xdg_popup*() override { + return xdgpopupv6; + } + operator xdg_popup*() const override { + return xdgpopupv6; + } + WaylandPointer xdgsurfacev6; + WaylandPointer xdgpopupv6; + + QRect pendingRect; + +private: + static void configureCallback(void *data, xdg_popup *xdg_popup, int32_t x, int32_t y, int32_t width, int32_t height); + static void popupDoneCallback(void *data, xdg_popup *xdg_popup); + static void surfaceConfigureCallback(void *data, xdg_surface *xdg_surface, uint32_t serial); + + static const struct xdg_popup_listener s_popupListener; + static const struct xdg_surface_listener s_surfaceListener; +}; + +const struct xdg_popup_listener XdgShellPopupStable::Private::s_popupListener = { + configureCallback, + popupDoneCallback +}; + +const struct xdg_surface_listener XdgShellPopupStable::Private::s_surfaceListener = { + surfaceConfigureCallback, +}; + +void XdgShellPopupStable::Private::configureCallback(void *data, xdg_popup *xdg_popup, int32_t x, int32_t y, int32_t width, int32_t height) +{ + Q_UNUSED(xdg_popup) + auto s = static_cast(data); + s->pendingRect = QRect(x, y, width, height); +} + +void XdgShellPopupStable::Private::surfaceConfigureCallback(void *data, struct xdg_surface *surface, uint32_t serial) +{ + Q_UNUSED(surface) + auto s = static_cast(data); + s->q->configureRequested(s->pendingRect, serial); + s->pendingRect = QRect(); +} + +void XdgShellPopupStable::Private::popupDoneCallback(void *data, xdg_popup *xdg_popup) +{ + auto s = static_cast(data); + Q_ASSERT(s->xdgpopupv6 == xdg_popup); + emit s->q->popupDone(); +} + +XdgShellPopupStable::Private::Private(XdgShellPopup *q) + : XdgShellPopup::Private(q) +{ +} + +void XdgShellPopupStable::Private::setup(xdg_surface *s, xdg_popup *p) +{ + Q_ASSERT(p); + Q_ASSERT(!xdgsurfacev6); + Q_ASSERT(!xdgpopupv6); + + xdgsurfacev6.setup(s); + xdgpopupv6.setup(p); + xdg_surface_add_listener(xdgsurfacev6, &s_surfaceListener, this); + xdg_popup_add_listener(xdgpopupv6, &s_popupListener, this); +} + +void XdgShellPopupStable::Private::release() +{ + xdgpopupv6.release(); +} + +void XdgShellPopupStable::Private::destroy() +{ + xdgpopupv6.destroy(); +} + +bool XdgShellPopupStable::Private::isValid() const +{ + return xdgpopupv6.isValid(); +} + +void XdgShellPopupStable::Private::requestGrab(Seat *seat, quint32 serial) +{ + xdg_popup_grab(xdgpopupv6, *seat, serial); +} + + +XdgShellPopupStable::XdgShellPopupStable(QObject *parent) + : XdgShellPopup(new Private(this), parent) +{ +} + +XdgShellPopupStable::~XdgShellPopupStable() = default; + +} +} diff --git a/src/server/CMakeLists.txt b/src/server/CMakeLists.txt --- a/src/server/CMakeLists.txt +++ b/src/server/CMakeLists.txt @@ -55,6 +55,7 @@ xdgforeign_interface.cpp xdgshell_v5_interface.cpp xdgshell_v6_interface.cpp + xdgshell_stable_interface.cpp xdgoutput_interface.cpp ../compat/wayland-xdg-shell-v5-protocol.c ) @@ -138,11 +139,6 @@ BASENAME text-input-unstable-v2 ) -ecm_add_wayland_server_protocol(SERVER_LIB_SRCS - PROTOCOL ${KWayland_SOURCE_DIR}/src/client/protocols/xdg-shell-unstable-v5.xml - BASENAME xdg-shell-v5 -) - ecm_add_wayland_server_protocol(SERVER_LIB_SRCS PROTOCOL ${KWayland_SOURCE_DIR}/src/client/protocols/xdg-shell-unstable-v6.xml BASENAME xdg-shell-v6 @@ -188,6 +184,11 @@ BASENAME xdg-output ) +ecm_add_wayland_server_protocol(SERVER_LIB_SRCS + PROTOCOL ${KWayland_SOURCE_DIR}/src/client/protocols/xdg-shell.xml + BASENAME xdg-shell +) + set(SERVER_GENERATED_SRCS ${CMAKE_CURRENT_BINARY_DIR}/wayland-output-management-client-protocol.h ${CMAKE_CURRENT_BINARY_DIR}/wayland-output-management-server-protocol.h @@ -225,6 +226,8 @@ ${CMAKE_CURRENT_BINARY_DIR}/wayland-text-input-unstable-v2-server-protocol.h ${CMAKE_CURRENT_BINARY_DIR}/wayland-xdg-shell-v6-client-protocol.h ${CMAKE_CURRENT_BINARY_DIR}/wayland-xdg-shell-v6-server-protocol.h + ${CMAKE_CURRENT_BINARY_DIR}/wayland-xdg-shell-client-protocol.h + ${CMAKE_CURRENT_BINARY_DIR}/wayland-xdg-shell-server-protocol.h ${CMAKE_CURRENT_BINARY_DIR}/wayland-pointer-gestures-unstable-v1-client-protocol.h ${CMAKE_CURRENT_BINARY_DIR}/wayland-pointer-gestures-unstable-v1-server-protocol.h ${CMAKE_CURRENT_BINARY_DIR}/wayland-pointer-constraints-unstable-v1-client-protocol.h diff --git a/src/server/display.cpp b/src/server/display.cpp --- a/src/server/display.cpp +++ b/src/server/display.cpp @@ -48,6 +48,7 @@ #include "xdgshell_v5_interface_p.h" #include "xdgforeign_interface.h" #include "xdgshell_v6_interface_p.h" +#include "xdgshell_stable_interface_p.h" #include "appmenu_interface.h" #include "server_decoration_palette_interface.h" #include "xdgoutput_interface.h" @@ -384,6 +385,9 @@ case XdgShellInterfaceVersion::UnstableV6: x = new XdgShellV6Interface(this, parent); break; + case XdgShellInterfaceVersion::Stable: + x = new XdgShellStableInterface(this, parent); + break; } connect(this, &Display::aboutToTerminate, x, [x] { delete x; }); return x; diff --git a/src/server/xdgshell_interface.h b/src/server/xdgshell_interface.h --- a/src/server/xdgshell_interface.h +++ b/src/server/xdgshell_interface.h @@ -55,7 +55,12 @@ * zxdg_shell_v6 (unstable v6) * @since 5.39 **/ - UnstableV6 + UnstableV6, + /** + xdg_wm_base (stable) + @since 5.XDGSHELL_VERSION + */ + Stable }; /** diff --git a/src/server/xdgshell_stable_interface.cpp b/src/server/xdgshell_stable_interface.cpp new file mode 100644 --- /dev/null +++ b/src/server/xdgshell_stable_interface.cpp @@ -0,0 +1,980 @@ +/**************************************************************************** +Copyright 2017 David Edmundson + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) version 3, or any +later version accepted by the membership of KDE e.V. (or its +successor approved by the membership of KDE e.V.), which shall +act as a proxy defined in Section 6 of version 3 of the license. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library. If not, see . +****************************************************************************/ +#include "xdgshell_stable_interface_p.h" +#include "xdgshell_interface_p.h" +#include "generic_shell_surface_p.h" +#include "display.h" +#include "global_p.h" +#include "global.h" +#include "resource_p.h" +#include "output_interface.h" +#include "seat_interface.h" +#include "surface_interface.h" + +#include + +namespace KWayland +{ +namespace Server +{ + +class XdgShellStableInterface::Private : public XdgShellInterface::Private +{ +public: + Private(XdgShellStableInterface *q, Display *d); + + QVector surfaces; + QVector positioners; + +private: + + void createSurface(wl_client *client, uint32_t version, uint32_t id, SurfaceInterface *surface, wl_resource *parentResource); + void createPositioner(wl_client *client, uint32_t version, uint32_t id, wl_resource *parentResource); + + void bind(wl_client *client, uint32_t version, uint32_t id) override; + + quint32 ping(XdgShellSurfaceInterface * surface) override; + + static void unbind(wl_resource *resource); + static Private *cast(wl_resource *r) { + return static_cast(wl_resource_get_user_data(r)); + } + + static void destroyCallback(wl_client *client, wl_resource *resource); + static void createPositionerCallback(wl_client *client, wl_resource *resource, uint32_t id); + static void getXdgSurfaceCallback(wl_client *client, wl_resource *resource, uint32_t id, wl_resource * surface); + static void pongCallback(wl_client *client, wl_resource *resource, uint32_t serial); + + XdgShellStableInterface *q; + static const struct xdg_wm_base_interface s_interface; + static const quint32 s_version; + QHash resources; +}; + +class XdgPopupStableInterface::Private : public XdgShellPopupInterface::Private +{ +public: + Private(XdgPopupStableInterface *q, XdgShellStableInterface *c, SurfaceInterface *surface, wl_resource *parentResource); + ~Private() override; + + void ackConfigure(quint32 serial) { + if (!configureSerials.contains(serial)) { + return; + } + while (!configureSerials.isEmpty()) { + quint32 i = configureSerials.takeFirst(); + emit q_func()->configureAcknowledged(i); + if (i == serial) { + break; + } + } + } + + void popupDone() override; + quint32 configure(const QRect &rect) override; + + XdgPopupStableInterface *q_func() { + return static_cast(q); + } +private: + static void grabCallback(wl_client *client, wl_resource *resource, wl_resource *seat, uint32_t serial); + + static const struct xdg_popup_interface s_interface; +}; + +class XdgSurfaceStableInterface::Private : public KWayland::Server::Resource::Private +{ +public: + Private(XdgSurfaceStableInterface* q, XdgShellStableInterface* c, SurfaceInterface* surface, wl_resource* parentResource); + + ~Private() override; + + XdgSurfaceStableInterface *q_func() { + return static_cast(q); + } + + void createTopLevel(wl_client *client, uint32_t version, uint32_t id, wl_resource *parentResource); + void createPopup(wl_client *client, uint32_t version, uint32_t id, wl_resource *parentResource, wl_resource *parentWindow, wl_resource *positioner); + XdgShellStableInterface *m_shell; + SurfaceInterface *m_surface; + + //effectively a union, only one of these should be populated. + //a surface cannot have two roles + QPointer m_topLevel; + QPointer m_popup; + +private: + static void destroyCallback(wl_client *client, wl_resource *resource); + static void getTopLevelCallback(wl_client *client, wl_resource *resource, uint32_t id); + static void getPopupCallback(wl_client *client, wl_resource *resource, uint32_t id, wl_resource *parent, wl_resource *positioner); + static void ackConfigureCallback(wl_client *client, wl_resource *resource, uint32_t serial); + static void setWindowGeometryCallback(wl_client *client, wl_resource *resource, int32_t x, int32_t y, int32_t width, int32_t height); + static const struct xdg_surface_interface s_interface; +}; + +class XdgTopLevelStableInterface::Private : public XdgShellSurfaceInterface::Private +{ +public: + Private(XdgTopLevelStableInterface* q, XdgShellStableInterface* c, SurfaceInterface* surface, wl_resource* parentResource); + ~Private() override; + + void close() override; + + void ackConfigure(quint32 serial) { + if (!configureSerials.contains(serial)) { + return; + } + while (!configureSerials.isEmpty()) { + quint32 i = configureSerials.takeFirst(); + emit q_func()->configureAcknowledged(i); + if (i == serial) { + break; + } + } + } + + quint32 configure(States states, const QSize &size) override { + if (!resource) { + return 0; + } + const quint32 serial = global->display()->nextSerial(); + wl_array configureStates; + wl_array_init(&configureStates); + if (states.testFlag(State::Maximized)) { + uint32_t *s = static_cast(wl_array_add(&configureStates, sizeof(uint32_t))); + *s = XDG_TOPLEVEL_STATE_MAXIMIZED; + } + if (states.testFlag(State::Fullscreen)) { + uint32_t *s = static_cast(wl_array_add(&configureStates, sizeof(uint32_t))); + *s = XDG_TOPLEVEL_STATE_FULLSCREEN; + } + if (states.testFlag(State::Resizing)) { + uint32_t *s = static_cast(wl_array_add(&configureStates, sizeof(uint32_t))); + *s = XDG_TOPLEVEL_STATE_RESIZING; + } + if (states.testFlag(State::Activated)) { + uint32_t *s = static_cast(wl_array_add(&configureStates, sizeof(uint32_t))); + *s = XDG_TOPLEVEL_STATE_ACTIVATED; + } + configureSerials << serial; + xdg_toplevel_send_configure(resource, size.width(), size.height(), &configureStates); + + xdg_surface_send_configure(parentResource, serial); + + client->flush(); + wl_array_release(&configureStates); + return serial; + }; + + XdgTopLevelStableInterface *q_func() { + return static_cast(q); + } + +private: + static void destroyCallback(wl_client *client, wl_resource *resource); + static void setParentCallback(struct wl_client *client, struct wl_resource *resource, wl_resource *parent); + static void showWindowMenuCallback(wl_client *client, wl_resource *resource, wl_resource *seat, uint32_t serial, int32_t x, int32_t y); + static void setMaxSizeCallback(wl_client *client, wl_resource *resource, int32_t width, int32_t height); + static void setMinSizeCallback(wl_client *client, wl_resource *resource, int32_t width, int32_t height); + static void setMaximizedCallback(wl_client *client, wl_resource *resource); + static void unsetMaximizedCallback(wl_client *client, wl_resource *resource); + static void setFullscreenCallback(wl_client *client, wl_resource *resource, wl_resource *output); + static void unsetFullscreenCallback(wl_client *client, wl_resource *resource); + static void setMinimizedCallback(wl_client *client, wl_resource *resource); + + static const struct xdg_toplevel_interface s_interface; +}; + + +const quint32 XdgShellStableInterface::Private::s_version = 1; + +#ifndef DOXYGEN_SHOULD_SKIP_THIS +const struct xdg_wm_base_interface XdgShellStableInterface::Private::s_interface = { + destroyCallback, + createPositionerCallback, + getXdgSurfaceCallback, + pongCallback +}; +#endif + +void XdgShellStableInterface::Private::destroyCallback(wl_client *client, wl_resource *resource) +{ + Q_UNUSED(client) + auto s = cast(resource); + if (!s->surfaces.isEmpty()) { + wl_resource_post_error(resource, XDG_WM_BASE_ERROR_DEFUNCT_SURFACES, "WMBase destroyed before surfaces"); + } + + wl_resource_destroy(resource); +} + +void XdgShellStableInterface::Private::createPositionerCallback(wl_client *client, wl_resource *resource, uint32_t id) +{ + auto s = cast(resource); + s->createPositioner(client, wl_resource_get_version(resource), id, resource); +} + +void XdgShellStableInterface::Private::getXdgSurfaceCallback(wl_client *client, wl_resource *resource, uint32_t id, wl_resource * surface) +{ + auto s = cast(resource); + s->createSurface(client, wl_resource_get_version(resource), id, SurfaceInterface::get(surface), resource); +} + +void XdgShellStableInterface::Private::createSurface(wl_client *client, uint32_t version, uint32_t id, SurfaceInterface *surface, wl_resource *parentResource) +{ + auto it = std::find_if(surfaces.constBegin(), surfaces.constEnd(), + [surface](XdgSurfaceStableInterface *s) { + return surface == s->surface(); + } + ); + if (it != surfaces.constEnd()) { + wl_resource_post_error(surface->resource(), XDG_WM_BASE_ERROR_ROLE, "XDG Surface already created"); + return; + } + XdgSurfaceStableInterface *shellSurface = new XdgSurfaceStableInterface(q, surface, parentResource); + surfaces << shellSurface; + QObject::connect(shellSurface, &XdgSurfaceStableInterface::destroyed, q, + [this, shellSurface] { + surfaces.removeAll(shellSurface); + } + ); + + shellSurface->d->create(display->getConnection(client), version, id); +} + +void XdgShellStableInterface::Private::createPositioner(wl_client *client, uint32_t version, uint32_t id, wl_resource *parentResource) +{ + Q_UNUSED(client) + + XdgPositionerStableInterface *positioner = new XdgPositionerStableInterface(q, parentResource); + positioners << positioner; + QObject::connect(positioner, &Resource::destroyed, q, + [this, positioner] { + positioners.removeAll(positioner); + } + ); + positioner->d->create(display->getConnection(client), version, id); +} + +void XdgShellStableInterface::Private::pongCallback(wl_client *client, wl_resource *resource, uint32_t serial) +{ + Q_UNUSED(client) + auto s = cast(resource); + auto timerIt = s->pingTimers.find(serial); + if (timerIt != s->pingTimers.end() && timerIt.value()->isActive()) { + delete timerIt.value(); + s->pingTimers.erase(timerIt); + emit s->q->pongReceived(serial); + } +} + +XdgShellStableInterface::Private::Private(XdgShellStableInterface *q, Display *d) + : XdgShellInterface::Private(XdgShellInterfaceVersion::Stable, q, d, &xdg_wm_base_interface, 1) + , q(q) +{ +} + +void XdgShellStableInterface::Private::bind(wl_client *client, uint32_t version, uint32_t id) +{ + auto c = display->getConnection(client); + auto resource = c->createResource(&xdg_wm_base_interface, qMin(version, s_version), id); + if (!resource) { + wl_client_post_no_memory(client); + return; + } + resources[client] = resource; + wl_resource_set_implementation(resource, &s_interface, this, unbind); +} + +void XdgShellStableInterface::Private::unbind(wl_resource *resource) +{ + auto s = cast(resource); + auto client = wl_resource_get_client(resource); + s->resources.remove(client); +} + +XdgTopLevelStableInterface *XdgShellStableInterface::getSurface(wl_resource *resource) +{ + if (!resource) { + return nullptr; + } + Q_D(); + + for (auto it = d->surfaces.constBegin(); it != d->surfaces.constEnd() ; it++) { + auto topLevel = (*it)->topLevel(); + if (topLevel && topLevel->resource() == resource) { + return topLevel; + } + } + return nullptr; +} + +XdgSurfaceStableInterface *XdgShellStableInterface::realGetSurface(wl_resource *resource) +{ + if (!resource) { + return nullptr; + } + Q_D(); + + for (auto it = d->surfaces.constBegin(); it != d->surfaces.constEnd() ; it++) { + if ((*it)->resource() == resource) { + return (*it); + } + } + return nullptr; +} + +XdgPositionerStableInterface *XdgShellStableInterface::getPositioner(wl_resource *resource) +{ + if (!resource) { + return nullptr; + } + Q_D(); + for (auto it = d->positioners.constBegin(); it != d->positioners.constEnd() ; it++) { + if ((*it)->resource() == resource) { + return *it; + } + } + return nullptr; +} + +quint32 XdgShellStableInterface::Private::ping(XdgShellSurfaceInterface *surface) +{ + auto client = surface->client()->client(); + //from here we can get the resource bound to our global. + + auto clientXdgShellResource = resources.value(client); + if (!clientXdgShellResource) { + return 0; + } + + const quint32 pingSerial = display->nextSerial(); + xdg_wm_base_send_ping(clientXdgShellResource, pingSerial); + + setupTimer(pingSerial); + return pingSerial; +} + +XdgShellStableInterface::Private *XdgShellStableInterface::d_func() const +{ + return static_cast(d.data()); +} + +namespace { +template <> +Qt::Edges edgesToQtEdges(xdg_toplevel_resize_edge edges) +{ + Qt::Edges qtEdges; + switch (edges) { + case XDG_TOPLEVEL_RESIZE_EDGE_TOP: + qtEdges = Qt::TopEdge; + break; + case XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM: + qtEdges = Qt::BottomEdge; + break; + case XDG_TOPLEVEL_RESIZE_EDGE_LEFT: + qtEdges = Qt::LeftEdge; + break; + case XDG_TOPLEVEL_RESIZE_EDGE_TOP_LEFT: + qtEdges = Qt::TopEdge | Qt::LeftEdge; + break; + case XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_LEFT: + qtEdges = Qt::BottomEdge | Qt::LeftEdge; + break; + case XDG_TOPLEVEL_RESIZE_EDGE_RIGHT: + qtEdges = Qt::RightEdge; + break; + case XDG_TOPLEVEL_RESIZE_EDGE_TOP_RIGHT: + qtEdges = Qt::TopEdge | Qt::RightEdge; + break; + case XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_RIGHT: + qtEdges = Qt::BottomEdge | Qt::RightEdge; + break; + case XDG_TOPLEVEL_RESIZE_EDGE_NONE: + break; + default: + Q_UNREACHABLE(); + break; + } + return qtEdges; +} +} + +#ifndef DOXYGEN_SHOULD_SKIP_THIS +const struct xdg_surface_interface XdgSurfaceStableInterface::Private::s_interface = { + destroyCallback, + getTopLevelCallback, + getPopupCallback, + setWindowGeometryCallback, + ackConfigureCallback +}; +#endif + +void XdgSurfaceStableInterface::Private::destroyCallback(wl_client *client, wl_resource *resource) +{ + Q_UNUSED(client) + wl_resource_destroy(resource); +} + +void XdgSurfaceStableInterface::Private::getTopLevelCallback(wl_client *client, wl_resource *resource, uint32_t id) +{ + auto s = cast(resource); + s->createTopLevel(client, wl_resource_get_version(resource), id, resource); +} + +void XdgSurfaceStableInterface::Private::createTopLevel(wl_client *client, uint32_t version, uint32_t id, wl_resource *parentResource) +{ + if (m_topLevel) { + wl_resource_post_error(parentResource, XDG_SURFACE_ERROR_ALREADY_CONSTRUCTED, "Toplevel already created on this surface"); + return; + } + if (m_popup) { + wl_resource_post_error(parentResource, XDG_SURFACE_ERROR_ALREADY_CONSTRUCTED, "Popup already created on this surface"); + return; + } + m_topLevel = new XdgTopLevelStableInterface (m_shell, m_surface, parentResource); + m_topLevel->d->create(m_shell->display()->getConnection(client), version, id); + + emit m_shell->surfaceCreated(m_topLevel); +} + + +void XdgSurfaceStableInterface::Private::getPopupCallback(wl_client *client, wl_resource *resource, uint32_t id, wl_resource *parent, wl_resource *positioner) +{ + auto s = cast(resource); + s->createPopup(client, wl_resource_get_version(resource), id, resource, parent, positioner); +} + +void XdgSurfaceStableInterface::Private::createPopup(wl_client *client, uint32_t version, uint32_t id, wl_resource *parentResource, wl_resource *parentSurface, wl_resource *positioner) +{ + + if (m_topLevel) { + wl_resource_post_error(parentResource, XDG_SURFACE_ERROR_ALREADY_CONSTRUCTED, "Toplevel already created on this surface"); + return; + } + if (m_popup) { + wl_resource_post_error(parentResource, XDG_SURFACE_ERROR_ALREADY_CONSTRUCTED, "Popup already created on this surface"); + return; + } + + auto xdgPositioner = m_shell->getPositioner(positioner); + if (!xdgPositioner) { + wl_resource_post_error(parentResource, XDG_WM_BASE_ERROR_INVALID_POSITIONER, "Invalid positioner"); + return; + } + m_popup = new XdgPopupStableInterface(m_shell, m_surface, parentResource); + auto pd = m_popup->d_func(); + + pd->create(m_shell->display()->getConnection(client), version, id); + + auto parentXdgSurface = m_shell->realGetSurface(parentSurface); + if (!parentXdgSurface) { + wl_resource_post_error(parentResource, XDG_WM_BASE_ERROR_INVALID_POPUP_PARENT, "Invalid popup parent"); + return; + } + pd->parent = parentXdgSurface->surface(); + pd->initialSize = xdgPositioner->initialSize(); + pd->anchorRect = xdgPositioner->anchorRect(); + pd->anchorEdge = xdgPositioner->anchorEdge(); + pd->gravity = xdgPositioner->gravity(); + pd->constraintAdjustments = xdgPositioner->constraintAdjustments(); + pd->anchorOffset = xdgPositioner->anchorOffset(); + + emit m_shell->xdgPopupCreated(m_popup.data()); +} + + +void XdgSurfaceStableInterface::Private::ackConfigureCallback(wl_client *client, wl_resource *resource, uint32_t serial) +{ + auto s = cast(resource); + Q_ASSERT(client == *s->client); + + if (s->m_topLevel) { + s->m_topLevel->d_func()->ackConfigure(serial); + } else if (s->m_popup) { + s->m_popup->d_func()->ackConfigure(serial); + } +} + +void XdgSurfaceStableInterface::Private::setWindowGeometryCallback(wl_client *client, wl_resource *resource, int32_t x, int32_t y, int32_t width, int32_t height) +{ + // TODO: implement - not done for v5 either + Q_UNUSED(client) + Q_UNUSED(resource) + Q_UNUSED(x) + Q_UNUSED(y) + Q_UNUSED(width) + Q_UNUSED(height) +} + +XdgSurfaceStableInterface::Private::Private(XdgSurfaceStableInterface *q, XdgShellStableInterface *c, SurfaceInterface *surface, wl_resource *parentResource) + : KWayland::Server::Resource::Private(q, c, parentResource, &xdg_surface_interface, &s_interface), + m_shell(c), + m_surface(surface) +{ +} + +XdgSurfaceStableInterface::Private::~Private() = default; + + +class XdgPositionerStableInterface::Private : public KWayland::Server::Resource::Private +{ +public: + Private(XdgPositionerStableInterface *q, XdgShellStableInterface *c, wl_resource* parentResource); + + QSize initialSize; + QRect anchorRect; + Qt::Edges anchorEdge; + Qt::Edges gravity; + PositionerConstraints constraintAdjustments; + QPoint anchorOffset; + +private: + static void setSizeCallback(wl_client *client, wl_resource *resource, int32_t width, int32_t height); + static void setAnchorRectCallback(wl_client *client, wl_resource *resource, int32_t x, int32_t y, int32_t width, int32_t height); + static void setAnchorCallback(wl_client *client, wl_resource *resource, uint32_t anchor); + static void setGravityCallback(wl_client *client, wl_resource *resource, uint32_t gravity); + static void setConstraintAdjustmentCallback(wl_client *client, wl_resource *resource, uint32_t constraint_adjustment); + static void setOffsetCallback(wl_client *client, wl_resource *resource, int32_t x, int32_t y); + + static const struct xdg_positioner_interface s_interface; +}; + +XdgPositionerStableInterface::Private::Private(XdgPositionerStableInterface *q, XdgShellStableInterface *c, wl_resource *parentResource) + : KWayland::Server::Resource::Private(q, c, parentResource, &xdg_positioner_interface, &s_interface) +{ +} + +#ifndef DOXYGEN_SHOULD_SKIP_THIS +const struct xdg_positioner_interface XdgPositionerStableInterface::Private::s_interface = { + resourceDestroyedCallback, + setSizeCallback, + setAnchorRectCallback, + setAnchorCallback, + setGravityCallback, + setConstraintAdjustmentCallback, + setOffsetCallback +}; +#endif + + +void XdgPositionerStableInterface::Private::setSizeCallback(wl_client *client, wl_resource *resource, int32_t width, int32_t height) { + Q_UNUSED(client) + auto s = cast(resource); + s->initialSize = QSize(width, height); +} + +void XdgPositionerStableInterface::Private::setAnchorRectCallback(wl_client *client, wl_resource *resource, int32_t x, int32_t y, int32_t width, int32_t height) +{ + Q_UNUSED(client) + auto s = cast(resource); + s->anchorRect = QRect(x, y, width, height); +} + +void XdgPositionerStableInterface::Private::setAnchorCallback(wl_client *client, wl_resource *resource, uint32_t anchor) { + Q_UNUSED(client) + + auto s = cast(resource); + + Qt::Edges qtEdges; + switch (anchor) { + case XDG_POSITIONER_ANCHOR_TOP: + qtEdges = Qt::TopEdge; + break; + case XDG_POSITIONER_ANCHOR_BOTTOM: + qtEdges = Qt::BottomEdge; + break; + case XDG_POSITIONER_ANCHOR_LEFT: + qtEdges = Qt::LeftEdge; + break; + case XDG_POSITIONER_ANCHOR_TOP_LEFT: + qtEdges = Qt::TopEdge | Qt::LeftEdge; + break; + case XDG_POSITIONER_ANCHOR_BOTTOM_LEFT: + qtEdges = Qt::BottomEdge | Qt::LeftEdge; + break; + case XDG_POSITIONER_ANCHOR_RIGHT: + qtEdges = Qt::RightEdge; + break; + case XDG_POSITIONER_ANCHOR_TOP_RIGHT: + qtEdges = Qt::TopEdge | Qt::RightEdge; + break; + case XDG_POSITIONER_ANCHOR_BOTTOM_RIGHT: + qtEdges = Qt::BottomEdge | Qt::RightEdge; + break; + case XDG_POSITIONER_ANCHOR_NONE: + break; + default: + Q_UNREACHABLE(); + break; + } + + s->anchorEdge = qtEdges; +} + +void XdgPositionerStableInterface::Private::setGravityCallback(wl_client *client, wl_resource *resource, uint32_t gravity) { + Q_UNUSED(client) + auto s = cast(resource); + + Qt::Edges qtEdges; + switch (gravity) { + case XDG_POSITIONER_GRAVITY_TOP: + qtEdges = Qt::TopEdge; + break; + case XDG_POSITIONER_GRAVITY_BOTTOM: + qtEdges = Qt::BottomEdge; + break; + case XDG_POSITIONER_GRAVITY_LEFT: + qtEdges = Qt::LeftEdge; + break; + case XDG_POSITIONER_GRAVITY_TOP_LEFT: + qtEdges = Qt::TopEdge | Qt::LeftEdge; + break; + case XDG_POSITIONER_GRAVITY_BOTTOM_LEFT: + qtEdges = Qt::BottomEdge | Qt::LeftEdge; + break; + case XDG_POSITIONER_GRAVITY_RIGHT: + qtEdges = Qt::RightEdge; + break; + case XDG_POSITIONER_GRAVITY_TOP_RIGHT: + qtEdges = Qt::TopEdge | Qt::RightEdge; + break; + case XDG_POSITIONER_GRAVITY_BOTTOM_RIGHT: + qtEdges = Qt::BottomEdge | Qt::RightEdge; + break; + case XDG_POSITIONER_GRAVITY_NONE: + break; + default: + Q_UNREACHABLE(); + break; + } + + s->gravity = qtEdges; +} + +void XdgPositionerStableInterface::Private::setConstraintAdjustmentCallback(wl_client *client, wl_resource *resource, uint32_t constraint_adjustment) { + Q_UNUSED(client) + auto s = cast(resource); + PositionerConstraints constraints; + if (constraint_adjustment & XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_X) { + constraints |= PositionerConstraint::SlideX; + } + if (constraint_adjustment & XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_Y) { + constraints |= PositionerConstraint::SlideY; + } + if (constraint_adjustment & XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_X) { + constraints |= PositionerConstraint::FlipX; + } + if (constraint_adjustment & XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_Y) { + constraints |= PositionerConstraint::FlipY; + } + if (constraint_adjustment & XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_X) { + constraints |= PositionerConstraint::ResizeX; + } + if (constraint_adjustment & XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_Y) { + constraints |= PositionerConstraint::ResizeY; + } + s->constraintAdjustments = constraints; +} + +void XdgPositionerStableInterface::Private::setOffsetCallback(wl_client *client, wl_resource *resource, int32_t x, int32_t y) +{ + Q_UNUSED(client) + auto s = cast(resource); + s->anchorOffset = QPoint(x,y); +} + +void XdgTopLevelStableInterface::Private::close() +{ + xdg_toplevel_send_close(resource); + client->flush(); +} + +void XdgTopLevelStableInterface::Private::setMaxSizeCallback(wl_client *client, wl_resource *resource, int32_t width, int32_t height) +{ + auto s = cast(resource); + Q_ASSERT(client == *s->client); + s->q_func()->maxSizeChanged(QSize(width, height)); +} + +void XdgTopLevelStableInterface::Private::setMinSizeCallback(wl_client *client, wl_resource *resource, int32_t width, int32_t height) +{ + auto s = cast(resource); + Q_ASSERT(client == *s->client); + s->q_func()->minSizeChanged(QSize(width, height)); +} + +const struct xdg_toplevel_interface XdgTopLevelStableInterface::Private::s_interface = { + destroyCallback, + setParentCallback, + setTitleCallback, + setAppIdCallback, + showWindowMenuCallback, + moveCallback, + resizeCallback, + setMaxSizeCallback, + setMinSizeCallback, + setMaximizedCallback, + unsetMaximizedCallback, + setFullscreenCallback, + unsetFullscreenCallback, + setMinimizedCallback +}; + +void XdgTopLevelStableInterface::Private::destroyCallback(wl_client *client, wl_resource *resource) +{ + Q_UNUSED(client) + wl_resource_destroy(resource); +} + +void XdgTopLevelStableInterface::Private::setParentCallback(wl_client *client, wl_resource *resource, wl_resource *parent) +{ + auto s = cast(resource); + Q_ASSERT(client == *s->client); + if (!parent) { + //setting null is valid API. Clear + s->parent = nullptr; + emit s->q_func()->transientForChanged(); + } else { + auto parentSurface = static_cast(s->q->global())->getSurface(parent); + if (s->parent.data() != parentSurface) { + s->parent = QPointer(parentSurface); + emit s->q_func()->transientForChanged(); + } + } +} + +void XdgTopLevelStableInterface::Private::showWindowMenuCallback(wl_client *client, wl_resource *resource, wl_resource *seat, uint32_t serial, int32_t x, int32_t y) +{ + auto s = cast(resource); + Q_ASSERT(client == *s->client); + emit s->q_func()->windowMenuRequested(SeatInterface::get(seat), serial, QPoint(x, y)); +} + +XdgTopLevelStableInterface::Private::Private(XdgTopLevelStableInterface *q, XdgShellStableInterface *c, SurfaceInterface *surface, wl_resource *parentResource) + : XdgShellSurfaceInterface::Private(XdgShellInterfaceVersion::Stable, q, c, surface, parentResource, &xdg_toplevel_interface, &s_interface) +{ +} + +void XdgTopLevelStableInterface::Private::setMaximizedCallback(wl_client *client, wl_resource *resource) +{ + auto s = cast(resource); + Q_ASSERT(client == *s->client); + s->q_func()->maximizedChanged(true); +} + +void XdgTopLevelStableInterface::Private::unsetMaximizedCallback(wl_client *client, wl_resource *resource) +{ + auto s = cast(resource); + Q_ASSERT(client == *s->client); + s->q_func()->maximizedChanged(false); +} + +void XdgTopLevelStableInterface::Private::setFullscreenCallback(wl_client *client, wl_resource *resource, wl_resource *output) +{ + auto s = cast(resource); + Q_ASSERT(client == *s->client); + OutputInterface *o = nullptr; + if (output) { + o = OutputInterface::get(output); + } + s->q_func()->fullscreenChanged(true, o); +} + +void XdgTopLevelStableInterface::Private::unsetFullscreenCallback(wl_client *client, wl_resource *resource) +{ + auto s = cast(resource); + Q_ASSERT(client == *s->client); + s->q_func()->fullscreenChanged(false, nullptr); +} + +void XdgTopLevelStableInterface::Private::setMinimizedCallback(wl_client *client, wl_resource *resource) +{ + auto s = cast(resource); + Q_ASSERT(client == *s->client); + s->q_func()->minimizeRequested(); +} + +XdgTopLevelStableInterface::Private::~Private() = default; + +#ifndef DOXYGEN_SHOULD_SKIP_THIS +const struct xdg_popup_interface XdgPopupStableInterface::Private::s_interface = { + resourceDestroyedCallback, + grabCallback +}; +#endif + +XdgPopupStableInterface::Private::Private(XdgPopupStableInterface *q, XdgShellStableInterface *c, SurfaceInterface *surface, wl_resource *parentResource) + : XdgShellPopupInterface::Private(XdgShellInterfaceVersion::Stable, q, c, surface, parentResource, &xdg_popup_interface, &s_interface) +{ +} + +void XdgPopupStableInterface::Private::grabCallback(wl_client *client, wl_resource *resource, wl_resource *seat, uint32_t serial) +{ + Q_UNUSED(client) + auto s = cast(resource); + auto seatInterface = SeatInterface::get(seat); + s->q_func()->grabRequested(seatInterface, serial); +} + +XdgPopupStableInterface::Private::~Private() = default; + +quint32 XdgPopupStableInterface::Private::configure(const QRect &rect) +{ + if (!resource) { + return 0; + } + const quint32 serial = global->display()->nextSerial(); + configureSerials << serial; + xdg_popup_send_configure(resource, rect.x(), rect.y(), rect.width(), rect.height()); + xdg_surface_send_configure(parentResource, serial); + client->flush(); + + return serial; +} + +void XdgPopupStableInterface::Private::popupDone() +{ + if (!resource) { + return; + } + // TODO: dismiss all child popups + xdg_popup_send_popup_done(resource); + client->flush(); +} + +XdgShellStableInterface::XdgShellStableInterface(Display *display, QObject *parent) + : XdgShellInterface(new Private(this, display), parent) +{ +} + +Display* XdgShellStableInterface::display() const +{ + return d->display; +} + +XdgShellStableInterface::~XdgShellStableInterface() = default; + +XdgSurfaceStableInterface::XdgSurfaceStableInterface(XdgShellStableInterface *parent, SurfaceInterface *surface, wl_resource *parentResource) + : KWayland::Server::Resource(new Private(this, parent, surface, parentResource)) +{ +} + +XdgSurfaceStableInterface::~XdgSurfaceStableInterface() = default; + +SurfaceInterface* XdgSurfaceStableInterface::surface() const +{ + Q_D(); + return d->m_surface; +} + +XdgPositionerStableInterface::XdgPositionerStableInterface(XdgShellStableInterface *parent, wl_resource *parentResource) + : KWayland::Server::Resource(new Private(this, parent, parentResource)) +{ +} + +QSize XdgPositionerStableInterface::initialSize() const +{ + Q_D(); + return d->initialSize; +} + +QRect XdgPositionerStableInterface::anchorRect() const +{ + Q_D(); + return d->anchorRect; +} + +Qt::Edges XdgPositionerStableInterface::anchorEdge() const +{ + Q_D(); + return d->anchorEdge; +} + +Qt::Edges XdgPositionerStableInterface::gravity() const +{ + Q_D(); + return d->gravity; +} + +PositionerConstraints XdgPositionerStableInterface::constraintAdjustments() const +{ + Q_D(); + return d->constraintAdjustments; +} + +QPoint XdgPositionerStableInterface::anchorOffset() const +{ + Q_D(); + return d->anchorOffset; +} + + +XdgPositionerStableInterface::Private *XdgPositionerStableInterface::d_func() const +{ + return static_cast(d.data()); +} + + +XdgTopLevelStableInterface* XdgSurfaceStableInterface::topLevel() const +{ + Q_D(); + return d->m_topLevel.data(); +} + +XdgPopupStableInterface* XdgSurfaceStableInterface::popup() const +{ + Q_D(); + return d->m_popup.data(); +} + +XdgSurfaceStableInterface::Private *XdgSurfaceStableInterface::d_func() const +{ + return static_cast(d.data()); +} + + +XdgTopLevelStableInterface::XdgTopLevelStableInterface(XdgShellStableInterface *parent, SurfaceInterface *surface, wl_resource *parentResource) + : KWayland::Server::XdgShellSurfaceInterface(new Private(this, parent, surface, parentResource)) +{ +} + +XdgTopLevelStableInterface::~XdgTopLevelStableInterface() = default; + +XdgTopLevelStableInterface::Private *XdgTopLevelStableInterface::d_func() const +{ + return static_cast(d.data()); +} + +XdgPopupStableInterface::XdgPopupStableInterface(XdgShellStableInterface *parent, SurfaceInterface *surface, wl_resource *parentResource) + : XdgShellPopupInterface(new Private(this, parent, surface, parentResource)) +{ +} + +XdgPopupStableInterface::~XdgPopupStableInterface() = default; + +XdgPopupStableInterface::Private *XdgPopupStableInterface::d_func() const +{ + return static_cast(d.data()); +} + +} +} + diff --git a/src/server/xdgshell_stable_interface_p.h b/src/server/xdgshell_stable_interface_p.h new file mode 100644 --- /dev/null +++ b/src/server/xdgshell_stable_interface_p.h @@ -0,0 +1,148 @@ +/**************************************************************************** +Copyright 2017 David Edmundson + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) version 3, or any +later version accepted by the membership of KDE e.V. (or its +successor approved by the membership of KDE e.V.), which shall +act as a proxy defined in Section 6 of version 3 of the license. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library. If not, see . +****************************************************************************/ +#ifndef KWAYLAND_SERVER_XDGSHELL_STABLE_INTERFACE_P_H +#define KWAYLAND_SERVER_XDGSHELL_STABLE_INTERFACE_P_H + +#include "global.h" +#include "resource.h" +#include "xdgshell_interface.h" + +#include + +#include + +namespace KWayland +{ +namespace Server +{ + +class Display; +class OutputInterface; +class SeatInterface; +class SurfaceInterface; +class XdgTopLevelStableInterface; +class XdgPopupStableInterface; +class XdgPositionerStableInterface; +class XdgSurfaceStableInterface; +template +class GenericShellSurface; + +class XdgShellStableInterface : public XdgShellInterface +{ + Q_OBJECT +public: + virtual ~XdgShellStableInterface(); + + /** + * @returns The XdgTopLevelV6Interface for the @p native resource. + **/ + XdgTopLevelStableInterface *getSurface(wl_resource *native); + //DAVE we want to rename this, as it's bloody confusing. But XdgShellInterface::getSurface exists and expects that + //also use a less terrible argument name than native. It's obvious it's native from the type + + XdgPositionerStableInterface *getPositioner(wl_resource *native); + + XdgSurfaceStableInterface *realGetSurface(wl_resource *native); + + Display *display() const; + + void ping(XdgShellSurfaceInterface * surface); + +private: + explicit XdgShellStableInterface(Display *display, QObject *parent = nullptr); + friend class Display; + class Private; + Private *d_func() const; +}; + +class XdgSurfaceStableInterface : public KWayland::Server::Resource +{ + Q_OBJECT +public: + virtual ~XdgSurfaceStableInterface(); + SurfaceInterface* surface() const; + XdgTopLevelStableInterface* topLevel() const; + XdgPopupStableInterface *popup() const; + +private: + explicit XdgSurfaceStableInterface(XdgShellStableInterface *parent, SurfaceInterface *surface, wl_resource *parentResource); + friend class XdgShellStableInterface; + + class Private; + Private *d_func() const; +}; + +class XdgTopLevelStableInterface : public +XdgShellSurfaceInterface +{ + Q_OBJECT +public: + virtual ~XdgTopLevelStableInterface(); + +private: + explicit XdgTopLevelStableInterface(XdgShellStableInterface *parent, SurfaceInterface *surface, wl_resource *parentResource); + friend class XdgShellStableInterface; + friend class XdgSurfaceStableInterface; + + class Private; + Private *d_func() const; +}; + +class XdgPopupStableInterface : public XdgShellPopupInterface +{ + Q_OBJECT +public: + virtual ~XdgPopupStableInterface(); + +private: + explicit XdgPopupStableInterface(XdgShellStableInterface *parent, SurfaceInterface *surface, wl_resource *parentResource); + friend class XdgShellStableInterface; + friend class XdgSurfaceStableInterface; + friend class GenericShellSurface; + + class Private; + Private *d_func() const; +}; + +/* + * This is a private internal class that keeps track of sent data + * At the time of PopupCreation these values are copied to the popup + */ +class XdgPositionerStableInterface: public KWayland::Server::Resource +{ +public: + QSize initialSize() const; + QRect anchorRect() const; + Qt::Edges anchorEdge() const; + Qt::Edges gravity() const; + PositionerConstraints constraintAdjustments() const; + QPoint anchorOffset() const; +private: + explicit XdgPositionerStableInterface(XdgShellStableInterface *parent, wl_resource *parentResource); + friend class XdgShellStableInterface; + + class Private; + Private *d_func() const; +}; + +} +} + +#endif