Make source code more relocatable

Occasionally, I see complaints about the file organization of kwin,
which is fair enough.

This change makes the source code more relocatable by removing relative
paths from includes.

CMAKE_CURRENT_SOURCE_DIR was added to the interface include directories
of kwin library. This means that as long as you link against kwin target,
the real location of the source code of the library doesn't matter.

With autotests, things are not as convenient as with kwin target. Some
tests use cpp files from kwin core. If we move all source code in a src/
directory, they will need to be adjusted, but mostly only in build
scripts.

autotests/integration/kwin_wayland_test.cpp

@@ -7,15 +7,16 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "kwin_wayland_test.h"
-#include "../../platform.h"
-#include "../../pluginmanager.h"
-#include "../../composite.h"
-#include "../../effects.h"
-#include "../../wayland_server.h"
-#include "../../workspace.h"
-#include "../../xcbutils.h"
-#include "../../xwl/xwayland.h"
-#include "../../inputmethod.h"
+
+#include "composite.h"
+#include "effects.h"
+#include "inputmethod.h"
+#include "platform.h"
+#include "pluginmanager.h"
+#include "wayland_server.h"
+#include "workspace.h"
+#include "xcbutils.h"
+#include "xwl/xwayland.h"
 
 #include <KPluginMetaData>
 

autotests/integration/kwin_wayland_test.h

@@ -9,7 +9,7 @@
 #ifndef KWIN_WAYLAND_TEST_H
 #define KWIN_WAYLAND_TEST_H
 
-#include "../../main.h"
+#include "main.h"
 
 // Qt
 #include <QtTest>

autotests/integration/xwayland_selections_test.cpp

@@ -13,7 +13,7 @@
 #include "screens.h"
 #include "wayland_server.h"
 #include "workspace.h"
-#include "../../xwl/databridge.h"
+#include "xwl/databridge.h"
 
 #include <KWaylandServer/datadevice_interface.h>
 

autotests/libinput/CMakeLists.txt

@@ -2,6 +2,7 @@ include_directories(${Libinput_INCLUDE_DIRS})
 
 add_library(LibInputTestObjects STATIC ../../libinput/device.cpp ../../libinput/events.cpp mock_libinput.cpp)
 target_link_libraries(LibInputTestObjects Qt::Test Qt::Widgets Qt::DBus Qt::Gui KF5::ConfigCore)
+target_include_directories(LibInputTestObjects PUBLIC ${CMAKE_SOURCE_DIR})
 
 ########################################################
 # Test Devices

autotests/libinput/context_test.cpp

@@ -8,8 +8,10 @@
 */
 #include "mock_libinput.h"
 #include "mock_udev.h"
-#include "../../libinput/context.h"
-#include "../../udev.h"
+
+#include "libinput/context.h"
+#include "udev.h"
+
 #include <QtTest>
 Q_LOGGING_CATEGORY(KWIN_CORE, "kwin_core", QtWarningMsg)
 

autotests/libinput/device_test.cpp

@@ -7,7 +7,7 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "mock_libinput.h"
-#include "../../libinput/device.h"
+#include "libinput/device.h"
 #include <config-kwin.h>
 
 #include <KSharedConfig>

autotests/libinput/gesture_event_test.cpp

@@ -7,8 +7,9 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "mock_libinput.h"
-#include "../../libinput/device.h"
-#include "../../libinput/events.h"
+
+#include "libinput/device.h"
+#include "libinput/events.h"
 
 #include <QtTest>
 

autotests/libinput/input_event_test.cpp

@@ -7,8 +7,9 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "mock_libinput.h"
-#include "../../libinput/device.h"
-#include "../input_event.h"
+
+#include "libinput/device.h"
+#include "input_event.h"
 
 #include <QtTest>
 

autotests/libinput/key_event_test.cpp

@@ -7,8 +7,9 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "mock_libinput.h"
-#include "../../libinput/device.h"
-#include "../../libinput/events.h"
+
+#include "libinput/device.h"
+#include "libinput/events.h"
 
 #include <QtTest>
 

autotests/libinput/mock_udev.cpp

@@ -6,7 +6,8 @@
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
-#include "../../udev.h"
+#include "udev.h"
+
 #include "mock_udev.h"
 
 udev *udev::s_mockUdev = nullptr;

autotests/libinput/pointer_event_test.cpp

@@ -7,8 +7,9 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "mock_libinput.h"
-#include "../../libinput/device.h"
-#include "../../libinput/events.h"
+
+#include "libinput/device.h"
+#include "libinput/events.h"
 
 #include <QtTest>
 

autotests/libinput/switch_event_test.cpp

@@ -7,8 +7,9 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "mock_libinput.h"
-#include "../../libinput/device.h"
-#include "../../libinput/events.h"
+
+#include "libinput/device.h"
+#include "libinput/events.h"
 
 #include <QtTest>
 

autotests/libinput/touch_event_test.cpp

@@ -7,8 +7,9 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "mock_libinput.h"
-#include "../../libinput/device.h"
-#include "../../libinput/events.h"
+
+#include "libinput/device.h"
+#include "libinput/events.h"
 
 #include <QtTest>
 

autotests/libxrenderutils/blendpicture_test.cpp

@@ -11,7 +11,8 @@
 #include <QX11Info>
 
 #include "../testutils.h"
-#include "../../libkwineffects/kwinxrenderutils.h"
+
+#include "kwinxrenderutils.h"
 
 class BlendPictureTest : public QObject
 {

autotests/mock_screens.h

@@ -9,7 +9,7 @@
 #ifndef KWIN_MOCK_SCREENS_H
 #define KWIN_MOCK_SCREENS_H
 
-#include "../screens.h"
+#include "screens.h"
 
 namespace KWin
 {

autotests/onscreennotificationtest.cpp

@@ -6,8 +6,9 @@
 */
 
 #include "onscreennotificationtest.h"
-#include "../onscreennotification.h"
-#include "../input.h"
+
+#include "onscreennotification.h"
+#include "input.h"
 
 #include <KSharedConfig>
 #include <KConfigGroup>

autotests/opengl_context_attribute_builder_test.cpp

@@ -6,8 +6,8 @@
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
-#include "../abstract_opengl_context_attribute_builder.h"
-#include "../egl_context_attribute_builder.h"
+#include "abstract_opengl_context_attribute_builder.h"
+#include "egl_context_attribute_builder.h"
 #include <QtTest>
 #include <epoxy/egl.h>
 

autotests/tabbox/mock_tabboxclient.h

@@ -9,7 +9,7 @@
 #ifndef KWIN_MOCK_TABBOX_CLIENT_H
 #define KWIN_MOCK_TABBOX_CLIENT_H
 
-#include "../../tabbox/tabboxhandler.h"
+#include "tabbox/tabboxhandler.h"
 
 #include <QIcon>
 #include <QUuid>

autotests/tabbox/mock_tabboxhandler.h

@@ -9,7 +9,7 @@
 #ifndef KWIN_MOCK_TABBOX_HANDLER_H
 #define KWIN_MOCK_TABBOX_HANDLER_H
 
-#include "../../tabbox/tabboxhandler.h"
+#include "tabbox/tabboxhandler.h"
 namespace KWin
 {
 class MockTabBoxHandler : public TabBox::TabBoxHandler

autotests/tabbox/test_desktopchain.cpp

@@ -8,7 +8,7 @@
 */
 
 // KWin
-#include "../../tabbox/desktopchain.h"
+#include "tabbox/desktopchain.h"
 
 #include <QTest>
 

autotests/tabbox/test_tabbox_config.cpp

@@ -6,7 +6,7 @@
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
-#include "../../tabbox/tabboxconfig.h"
+#include "tabbox/tabboxconfig.h"
 #include <QtTest>
 using namespace KWin;
 using namespace KWin::TabBox;

autotests/test_builtin_effectloader.cpp

@@ -6,10 +6,10 @@
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
-#include "../effectloader.h"
-#include "../effects/effect_builtins.h"
+#include "effectloader.h"
+#include "effects/effect_builtins.h"
 #include "mock_effectshandler.h"
-#include "../scripting/scriptedeffect.h" // for mocking ScriptedEffect::create
+#include "scripting/scriptedeffect.h" // for mocking ScriptedEffect::create
 #include "testutils.h"
 // KDE
 #include <KConfig>

autotests/test_client_machine.cpp

@@ -8,8 +8,8 @@
 */
 #include "testutils.h"
 // KWin
-#include "../client_machine.h"
-#include "../xcbutils.h"
+#include "client_machine.h"
+#include "xcbutils.h"
 // Qt
 #include <QApplication>
 #include <QtTest>

autotests/test_gestures.cpp

@@ -6,7 +6,7 @@
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
-#include "../gestures.h"
+#include "gestures.h"
 
 #include <QTest>
 #include <QSignalSpy>

autotests/test_plugin_effectloader.cpp

@@ -6,9 +6,9 @@
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
-#include "../effectloader.h"
+#include "effectloader.h"
 #include "mock_effectshandler.h"
-#include "../scripting/scriptedeffect.h" // for mocking ScriptedEffect::create
+#include "scripting/scriptedeffect.h" // for mocking ScriptedEffect::create
 // KDE
 #include <KConfig>
 #include <KConfigGroup>

autotests/test_screen_edges.cpp

@@ -7,17 +7,18 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 // kwin
-#include "../atoms.h"
-#include "../cursor.h"
-#include "../input.h"
-#include "../gestures.h"
-#include "../main.h"
-#include "../screenedge.h"
-#include "../screens.h"
-#include "../utils.h"
-#include "../virtualdesktops.h"
-#include "../xcbutils.h"
-#include "../platform.h"
+#include "atoms.h"
+#include "cursor.h"
+#include "input.h"
+#include "gestures.h"
+#include "main.h"
+#include "screenedge.h"
+#include "screens.h"
+#include "utils.h"
+#include "virtualdesktops.h"
+#include "xcbutils.h"
+#include "platform.h"
+
 #include "mock_screens.h"
 #include "mock_workspace.h"
 #include "mock_x11client.h"

autotests/test_scripted_effectloader.cpp

@@ -6,13 +6,13 @@
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
-#include "../effectloader.h"
+#include "effectloader.h"
 #include "mock_effectshandler.h"
-#include "../scripting/scriptedeffect.h"
+#include "scripting/scriptedeffect.h"
 // for mocking
-#include "../cursor.h"
-#include "../input.h"
-#include "../screenedge.h"
+#include "cursor.h"
+#include "input.h"
+#include "screenedge.h"
 // KDE
 #include <KConfig>
 #include <KConfigGroup>

autotests/test_virtual_desktops.cpp

@@ -6,8 +6,8 @@
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
-#include "../virtualdesktops.h"
-#include "../input.h"
+#include "input.h"
+#include "virtualdesktops.h"
 // KDE
 #include <KConfigGroup>
 

autotests/test_virtualkeyboard_dbus.cpp

@@ -12,7 +12,7 @@
 #include <QDBusPendingReply>
 #include <QSignalSpy>
 
-#include "../virtualkeyboard_dbus.h"
+#include "virtualkeyboard_dbus.h"
 
 using KWin::VirtualKeyboardDBus;
 

autotests/test_window_paint_data.cpp

@@ -8,7 +8,8 @@
 */
 
 #include <kwineffects.h>
-#include "../virtualdesktops.h"
+
+#include "virtualdesktops.h"
 
 #include <QVector2D>
 #include <QGraphicsRotation>

autotests/test_xcb_size_hints.cpp

@@ -8,7 +8,7 @@
 */
 #include "testutils.h"
 // KWin
-#include "../xcbutils.h"
+#include "xcbutils.h"
 // Qt
 #include <QApplication>
 #include <QtTest>

autotests/test_xcb_window.cpp

@@ -8,7 +8,7 @@
 */
 #include "testutils.h"
 // KWin
-#include "../xcbutils.h"
+#include "xcbutils.h"
 // Qt
 #include <QApplication>
 #include <QtTest>

autotests/test_xcb_wrapper.cpp

@@ -8,7 +8,7 @@
 */
 #include "testutils.h"
 // KWin
-#include "../xcbutils.h"
+#include "xcbutils.h"
 // Qt
 #include <QApplication>
 #include <QtTest>

autotests/test_xkb.cpp

@@ -6,7 +6,7 @@
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
-#include "../xkb.h"
+#include "xkb.h"
 
 #include <QtTest>
 #include <xkbcommon/xkbcommon-keysyms.h>

libinput/connection.cpp

@@ -13,17 +13,17 @@
 
 // TODO: Make it compile also in testing environment
 #ifndef KWIN_BUILD_TESTING
-#include "../abstract_wayland_output.h"
-#include "../main.h"
-#include "../platform.h"
-#include "../workspace.h"
-#include "../abstract_client.h"
-#include "../screens.h"
+#include "abstract_wayland_output.h"
+#include "main.h"
+#include "platform.h"
+#include "workspace.h"
+#include "abstract_client.h"
+#include "screens.h"
 #endif
 
-#include "../input_event.h"
-#include "../logind.h"
-#include "../udev.h"
+#include "input_event.h"
+#include "logind.h"
+#include "udev.h"
 #include "libinput_logging.h"
 
 #include <QDBusMessage>

libinput/connection.h

@@ -9,10 +9,11 @@
 #ifndef KWIN_LIBINPUT_CONNECTION_H
 #define KWIN_LIBINPUT_CONNECTION_H
 
-#include "../input.h"
-#include "../keyboard_input.h"
 #include <kwinglobals.h>
 
+#include "input.h"
+#include "keyboard_input.h"
+
 #include <QObject>
 #include <QPointer>
 #include <QSize>

libinput/context.cpp

@@ -9,8 +9,9 @@
 #include "context.h"
 #include "events.h"
 #include "libinput_logging.h"
-#include "../logind.h"
-#include "../udev.h"
+
+#include "logind.h"
+#include "udev.h"
 
 #include <fcntl.h>
 #include <unistd.h>

libinput/events.h

@@ -9,7 +9,7 @@
 #ifndef KWIN_LIBINPUT_EVENTS_H
 #define KWIN_LIBINPUT_EVENTS_H
 
-#include "../input.h"
+#include "input.h"
 
 #include <libinput.h>
 

platformsupport/scenes/opengl/egl_dmabuf.cpp

@@ -8,10 +8,10 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "egl_dmabuf.h"
-
 #include "drm_fourcc.h"
 #include "kwineglext.h"
-#include "../../../wayland_server.h"
+
+#include "wayland_server.h"
 
 #include <unistd.h>
 

platformsupport/scenes/opengl/egl_dmabuf.h

@@ -9,10 +9,10 @@
 */
 #pragma once
 
-#include "../../../linux_dmabuf.h"
-
 #include "abstract_egl_backend.h"
 
+#include "linux_dmabuf.h"
+
 #include <QVector>
 
 namespace KWin

plugins/idletime/poller.cpp

@@ -7,7 +7,7 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "poller.h"
-#include "../../wayland_server.h"
+#include "wayland_server.h"
 
 #include <KWayland/Client/idle.h>
 #include <KWayland/Client/registry.h>

plugins/kglobalaccel/kglobalaccel_plugin.cpp

@@ -7,7 +7,8 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "kglobalaccel_plugin.h"
-#include "../../input.h"
+
+#include "input.h"
 
 #include <QDebug>
 

plugins/platforms/x11/standalone/overlaywindow_x11.h

@@ -10,8 +10,8 @@
 #ifndef KWIN_OVERLAYWINDOW_X11_H
 #define KWIN_OVERLAYWINDOW_X11_H
 
-#include "../../../../overlaywindow.h"
-#include "../../../../x11eventfilter.h"
+#include "overlaywindow.h"
+#include "x11eventfilter.h"
 
 namespace KWin {
 class KWIN_EXPORT OverlayWindowX11 : public OverlayWindow, public X11EventFilter {

plugins/qpa/integration.cpp

@@ -8,16 +8,17 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "integration.h"
-#include "abstract_output.h"
 #include "backingstore.h"
 #include "eglplatformcontext.h"
 #include "logging.h"
 #include "offscreensurface.h"
 #include "screen.h"
 #include "window.h"
-#include "../../main.h"
-#include "../../platform.h"
-#include "../../screens.h"
+
+#include "abstract_output.h"
+#include "main.h"
+#include "platform.h"
+#include "screens.h"
 
 #include <QCoreApplication>
 #include <QtConcurrentRun>

plugins/qpa/platformcursor.cpp

@@ -7,7 +7,7 @@
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "platformcursor.h"
-#include "../../cursor.h"
+#include "cursor.h"
 
 namespace KWin
 {

plugins/windowsystem/windoweffects.cpp

@@ -5,7 +5,7 @@
 */
 #include "windoweffects.h"
 #include "effect_builtins.h"
-#include "../../effects.h"
+#include "effects.h"
 
 #include <QGuiApplication>
 #include <QWidget>

scripting/scriptedeffect.cpp

@@ -11,9 +11,10 @@
 #include "meta.h"
 #include "scriptingutils.h"
 #include "workspace_wrapper.h"
-#include "../screens.h"
-#include "../screenedge.h"
 #include "scripting_logging.h"
+
+#include "screens.h"
+#include "screenedge.h"
 // KDE
 #include <KConfigGroup>
 #include <kconfigloader.h>

scripting/scripting.cpp

@@ -17,10 +17,11 @@
 #include "screenedgeitem.h"
 #include "scripting_model.h"
 #include "scripting_logging.h"
-#include "../x11client.h"
-#include "../thumbnailitem.h"
-#include "../options.h"
-#include "../workspace.h"
+
+#include "options.h"
+#include "thumbnailitem.h"
+#include "workspace.h"
+#include "x11client.h"
 // KDE
 #include <KConfigGroup>
 #include <KPackage/PackageLoader>

scripting/workspace_wrapper.cpp

@@ -9,13 +9,13 @@
 */
 
 #include "workspace_wrapper.h"
-#include "../x11client.h"
-#include "../outline.h"
-#include "../screens.h"
-#include "../virtualdesktops.h"
-#include "../workspace.h"
+#include "x11client.h"
+#include "outline.h"
+#include "screens.h"
+#include "virtualdesktops.h"
+#include "workspace.h"
 #ifdef KWIN_BUILD_ACTIVITIES
-#include "../activities.h"
+#include "activities.h"
 #endif
 
 #include <QDesktopWidget>

tests/CMakeLists.txt

@@ -8,6 +8,7 @@ endif()
 set(screenedgeshowtest_SRCS screenedgeshowtest.cpp)
 add_executable(screenedgeshowtest ${screenedgeshowtest_SRCS})
 target_link_libraries(screenedgeshowtest Qt::Widgets Qt::X11Extras KF5::ConfigCore KF5::WindowSystem KF5::WaylandClient ${XCB_XCB_LIBRARY})
+target_include_directories(screenedgeshowtest PRIVATE ${CMAKE_SOURCE_DIR})
 
 set(libinputtest_SRCS
     ${KWin_SOURCE_DIR}/libinput/connection.cpp
@@ -22,9 +23,11 @@ set(libinputtest_SRCS
 add_executable(libinputtest ${libinputtest_SRCS})
 add_definitions(-DKWIN_BUILD_TESTING)
 target_link_libraries(libinputtest Qt::Core Qt::DBus Libinput::Libinput UDev::UDev KF5::ConfigCore KF5::GlobalAccel KF5::WindowSystem)
+target_include_directories(libinputtest PRIVATE ${CMAKE_SOURCE_DIR})
 
 add_executable(x11shadowreader x11shadowreader.cpp)
 target_link_libraries(x11shadowreader XCB::XCB Qt::Widgets Qt::X11Extras KF5::ConfigCore KF5::WindowSystem)
+target_include_directories(x11shadowreader PRIVATE ${CMAKE_SOURCE_DIR})
 
 add_executable(pointerconstraints pointerconstraintstest.cpp)
 add_definitions(-DDIR="${CMAKE_CURRENT_SOURCE_DIR}")

tests/libinputtest.cpp

@@ -3,10 +3,10 @@
 
     SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 */
-#include "../input.h"
-#include "../libinput/connection.h"
-#include "../libinput/device.h"
-#include "../logind.h"
+#include "input.h"
+#include "libinput/connection.h"
+#include "libinput/device.h"
+#include "logind.h"
 
 #include <QCoreApplication>
 #include <QLoggingCategory>

tests/screenedgeshowtest.cpp

@@ -3,6 +3,8 @@
 
     SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 */
+#include "xcbutils.h"
+
 #include <QApplication>
 #include <QHBoxLayout>
 #include <QMenu>
@@ -15,7 +17,6 @@
 #include <QWidget>
 #include <QCheckBox>
 #include <QX11Info>
-#include "../xcbutils.h"
 
 #include <KWindowSystem>
 

tests/x11shadowreader.cpp

@@ -3,7 +3,8 @@
 
     SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 */
-#include "../xcbutils.h"
+#include "xcbutils.h"
+
 #include <QApplication>
 #include <QDebug>
 #include <QCommandLineParser>