/* KWin - the KDE window manager This file is part of the KDE project. SPDX-FileCopyrightText: 1999, 2000 Matthias Ettrich SPDX-FileCopyrightText: 2003 Lubos Lunak SPDX-FileCopyrightText: 2009 Lucas Murray SPDX-FileCopyrightText: 2019 Vlad Zahorodnii SPDX-FileCopyrightText: 2022 Natalie Clarius SPDX-License-Identifier: GPL-2.0-or-later */ #pragma once // kwin #include "options.h" #include "sm.h" #include "utils/common.h" // KF #include // Qt #include #include #include // std #include #include class KConfig; class KConfigGroup; class KStartupInfo; class KStartupInfoData; class KStartupInfoId; namespace KWin { namespace Decoration { class DecorationBridge; } namespace Xcb { class Tree; class Window; } namespace TabBox { class TabBox; } class Window; class Output; class Compositor; class Group; class InternalWindow; class KillWindow; class ShortcutDialog; class UserActionsMenu; class VirtualDesktop; class X11Window; class X11EventFilter; class FocusChain; class ApplicationMenu; class PlacementTracker; enum class Predicate; class Outline; class RuleBook; class ScreenEdges; #if KWIN_BUILD_ACTIVITIES class Activities; #endif class PlaceholderInputEventFilter; class PlaceholderOutput; class Placement; class OutputConfiguration; class TileManager; class OutputConfigurationStore; class LidSwitchTracker; class DpmsInputEventFilter; class OrientationSensor; class BrightnessDevice; class KWIN_EXPORT Workspace : public QObject { Q_OBJECT public: explicit Workspace(); ~Workspace() override; static Workspace *self() { return _self; } bool hasWindow(const Window *); #if KWIN_BUILD_X11 bool workspaceEvent(xcb_generic_event_t *); /** * @brief Finds the first Client matching the condition expressed by passed in @p func. * * Internally findClient uses the std::find_if algorithm and that determines how the function * needs to be implemented. An example usage for finding a Client with a matching windowId * @code * xcb_window_t w; // our test window * X11Window *client = findClient([w](const X11Window *c) -> bool { * return c->window() == w; * }); * @endcode * * For the standard cases of matching the window id with one of the Client's windows use * the simplified overload method findClient(Predicate, xcb_window_t). Above example * can be simplified to: * @code * xcb_window_t w; // our test window * X11Window *client = findClient(Predicate::WindowMatch, w); * @endcode * * @param func Unary function that accepts a X11Window *as argument and * returns a value convertible to bool. The value returned indicates whether the * X11Window *is considered a match in the context of this function. * The function shall not modify its argument. * This can either be a function pointer or a function object. * @return KWin::X11Window *The found Client or @c null * @see findClient(Predicate, xcb_window_t) */ X11Window *findClient(std::function func) const; /** * @brief Finds the Client matching the given match @p predicate for the given window. * * @param predicate Which window should be compared * @param w The window id to test against * @return KWin::X11Window *The found Client or @c null * @see findClient(std::function) */ X11Window *findClient(Predicate predicate, xcb_window_t w) const; void forEachClient(std::function func); X11Window *findUnmanaged(std::function func) const; /** * @brief Finds the Unmanaged with the given window id. * * @param w The window id to search for * @return KWin::Unmanaged* Found Unmanaged or @c null if there is no Unmanaged with given Id. */ X11Window *findUnmanaged(xcb_window_t w) const; #endif Window *findWindow(const QUuid &internalId) const; Window *findWindow(std::function func) const; void forEachWindow(std::function func); /** * @brief Finds a Window for the internal window @p w. * * Internal window means a window created by KWin itself. On X11 this is an Unmanaged * and mapped by the window id, on Wayland a XdgShellClient mapped on the internal window id. * * @returns Window */ Window *findInternal(QWindow *w) const; QRectF clientArea(clientAreaOption, const Output *output, const VirtualDesktop *desktop) const; QRectF clientArea(clientAreaOption, const Window *window) const; QRectF clientArea(clientAreaOption, const Window *window, const Output *output) const; QRectF clientArea(clientAreaOption, const Window *window, const QPointF &pos) const; /** * Returns the geometry of this Workspace, i.e. the bounding rectangle of all outputs. */ QRect geometry() const; StrutRects restrictedMoveArea(const VirtualDesktop *desktop, StrutAreas areas = StrutAreaAll) const; bool initializing() const; Output *xineramaIndexToOutput(int index) const; void setOutputOrder(const QList &order); QList outputOrder() const; Output *activeOutput() const; void setActiveOutput(Output *output); void setActiveOutput(const QPointF &pos); /** * Returns the active window, i.e. the window that has the focus (or None * if no window has the focus) */ Window *activeWindow() const; /** * Window that was activated, but it's not yet really activeWindow(), because * we didn't process yet the matching FocusIn event. Used mostly in focus * stealing prevention code. */ Window *mostRecentlyActivatedWindow() const; Window *windowUnderMouse(Output *output) const; void activateWindow(Window *window, bool force = false); bool requestFocus(Window *window, bool force = false); enum ActivityFlag { ActivityFocus = 1 << 0, // focus the window ActivityFocusForce = 1 << 1 | ActivityFocus, // focus even if Dock etc. ActivityRaise = 1 << 2 // raise the window }; Q_DECLARE_FLAGS(ActivityFlags, ActivityFlag) bool takeActivity(Window *window, ActivityFlags flags); bool restoreFocus(); void gotFocusIn(const Window *window); void setShouldGetFocus(Window *window); bool activateNextWindow(Window *window); bool focusChangeEnabled() { return block_focus == 0; } /** * Indicates that the given @a window is being moved or resized by the user. */ void setMoveResizeWindow(Window *window); QRectF adjustClientArea(Window *window, const QRectF &area) const; QPointF adjustWindowPosition(const Window *window, QPointF pos, bool unrestricted, double snapAdjust = 1.0) const; QRectF adjustWindowSize(const Window *window, QRectF moveResizeGeom, Gravity gravity) const; void raiseWindow(Window *window, bool nogroup = false); void lowerWindow(Window *window, bool nogroup = false); #if KWIN_BUILD_X11 void raiseWindowRequest(Window *window, NET::RequestSource src = NET::FromApplication, uint32_t timestamp = 0); void lowerWindowRequest(X11Window *window, NET::RequestSource src, xcb_timestamp_t timestamp); void restoreSessionStackingOrder(X11Window *window); #endif void restackWindowUnderActive(Window *window); void stackBelow(Window *window, Window *reference); void stackAbove(Window *window, Window *reference); void raiseOrLowerWindow(Window *window); void updateStackingOrder(bool propagate_new_windows = false); void forceRestacking(); void constrain(Window *below, Window *above); void unconstrain(Window *below, Window *above); void windowAttentionChanged(Window *, bool set); /** * @returns List of all windows (either X11 or Wayland) currently managed by Workspace */ const QList windows() const { return m_windows; } #if KWIN_BUILD_X11 void stackScreenEdgesUnderOverrideRedirect(); #endif SessionManager *sessionManager() const; /** * @returns the TileManager associated to a given output */ TileManager *tileManager(Output *output); public: QPoint cascadeOffset(const QRectF &area) const; //------------------------------------------------- // Unsorted public: StrutRects previousRestrictedMoveArea(const VirtualDesktop *desktop, StrutAreas areas = StrutAreaAll) const; QHash previousScreenSizes() const; /** * Returns @c true if the workspace is currently being rearranged; otherwise returns @c false. */ bool inRearrange() const; /** * Re-arranges the workspace, it includes computing restricted areas, moving windows out of the * restricted areas, and so on. * * The client area is the area that is available for windows (that which is not taken by windows * like panels, the top-of-screen menu etc). * * @see clientArea() */ void rearrange(); /** * Schedules the workspace to be re-arranged at the next available opportunity. */ void scheduleRearrange(); /** * Returns the list of windows sorted in stacking order, with topmost window * at the last position */ const QList &stackingOrder() const; QList unconstrainedStackingOrder() const; QList ensureStackingOrder(const QList &windows) const; Window *topWindowOnDesktop(VirtualDesktop *desktop, Output *output = nullptr, bool unconstrained = false, bool only_normal = true) const; Window *findDesktop(VirtualDesktop *desktop, Output *output) const; void addWindowToDesktop(Window *window, VirtualDesktop *desktop); void removeWindowFromDesktop(Window *window, VirtualDesktop *desktop); void sendWindowToDesktops(Window *window, const QList &desktops, bool dont_activate); void windowToPreviousDesktop(Window *window); void windowToNextDesktop(Window *window); #if KWIN_BUILD_X11 QList ensureStackingOrder(const QList &windows) const; void addManualOverlay(xcb_window_t id) { manual_overlays << id; } void removeManualOverlay(xcb_window_t id) { manual_overlays.removeOne(id); } #endif /** * Shows the menu operations menu for the window and makes it active if * it's not already. */ void showWindowMenu(const QRect &pos, Window *cl); UserActionsMenu *userActionsMenu() const { return m_userActionsMenu; } void showApplicationMenu(const QRect &pos, Window *window, int actionId); void updateMinimizedOfTransients(Window *); void updateOnAllDesktopsOfTransients(Window *); #if KWIN_BUILD_X11 void checkTransients(xcb_window_t w); SessionInfo *takeSessionInfo(X11Window *); #endif // D-Bus interface QString supportInformation() const; enum Direction { DirectionNorth, DirectionEast, DirectionSouth, DirectionWest, DirectionPrev, DirectionNext }; Output *findOutput(Output *reference, Direction direction, bool wrapAround = false) const; void switchToOutput(Output *output); QList outputs() const; Output *outputAt(const QPointF &pos) const; /** * Set "Show Desktop" status * * @param showing @c true to show the desktop, @c false to restore the window positions * @param animated @c true if the "Show Desktop Animation" should be played, otherwise @c false */ void setShowingDesktop(bool showing, bool animated = true); bool showingDesktop() const; void setActiveWindow(Window *window); #if KWIN_BUILD_X11 void removeX11Window(X11Window *); // Only called from X11Window::destroyWindow() or X11Window::releaseWindow() Group *findGroup(xcb_window_t leader) const; void addGroup(Group *group); void removeGroup(Group *group); Group *findClientLeaderGroup(const X11Window *c) const; int unconstainedStackingOrderIndex(const X11Window *c) const; void removeUnmanaged(X11Window *); bool checkStartupNotification(xcb_window_t w, KStartupInfoId &id, KStartupInfoData &data); #endif void removeDeleted(Window *); void addDeleted(Window *); void focusToNull(); // SELI TODO: Public? void windowShortcutUpdated(Window *window); bool shortcutAvailable(const QKeySequence &cut, Window *ignore = nullptr) const; bool globalShortcutsDisabled() const; void disableGlobalShortcutsForClient(bool disable); void setWasUserInteraction(); bool wasUserInteraction() const; qreal packPositionLeft(const Window *window, qreal oldX, bool leftEdge) const; qreal packPositionRight(const Window *window, qreal oldX, bool rightEdge) const; qreal packPositionUp(const Window *window, qreal oldY, bool topEdge) const; qreal packPositionDown(const Window *window, qreal oldY, bool bottomEdge) const; void cancelDelayFocus(); void requestDelayFocus(Window *); /** * updates the mouse position to track whether a focus follow mouse focus change was caused by * an actual mouse move * is esp. called on enter/motion events of inactive windows * since an active window doesn't receive mouse events, it must also be invoked if a (potentially) * active window might be moved/resize away from the cursor (causing a leave event) */ void updateFocusMousePosition(const QPointF &pos); QPointF focusMousePosition() const; /** * Returns a window that is currently being moved or resized by the user. * * If none of windows is being moved or resized, @c null will be returned. */ Window *moveResizeWindow() { return m_moveResizeWindow; } void quickTileWindow(QuickTileMode mode); void switchWindow(Direction direction); ShortcutDialog *shortcutDialog() const { return m_windowKeysDialog; } void addInternalWindow(InternalWindow *window); void removeInternalWindow(InternalWindow *window); /** * @internal * Used by session management */ void setInitialDesktop(int desktop); bool inShouldGetFocus(Window *w) const { return should_get_focus.contains(w); } Window *lastActiveWindow() const { return m_lastActiveWindow; } FocusChain *focusChain() const; ApplicationMenu *applicationMenu() const; Decoration::DecorationBridge *decorationBridge() const; Outline *outline() const; Placement *placement() const; RuleBook *rulebook() const; ScreenEdges *screenEdges() const; #if KWIN_BUILD_TABBOX TabBox::TabBox *tabbox() const; #endif #if KWIN_BUILD_ACTIVITIES Activities *activities() const; #endif /** * Apply the requested output configuration. Note that you must use this function * instead of Platform::applyOutputChanges(). */ bool applyOutputConfiguration(const OutputConfiguration &config, const std::optional> &outputOrder = std::nullopt); public Q_SLOTS: void performWindowOperation(KWin::Window *window, Options::WindowOperation op); // Keybindings // void slotSwitchToWindow( int ); void slotWindowToDesktop(VirtualDesktop *desktop); // void slotWindowToListPosition( int ); void slotSwitchToScreen(Output *output); void slotWindowToScreen(Output *output); void slotSwitchToLeftScreen(); void slotSwitchToRightScreen(); void slotSwitchToAboveScreen(); void slotSwitchToBelowScreen(); void slotSwitchToPrevScreen(); void slotSwitchToNextScreen(); void slotWindowToLeftScreen(); void slotWindowToRightScreen(); void slotWindowToAboveScreen(); void slotWindowToBelowScreen(); void slotWindowToNextScreen(); void slotWindowToPrevScreen(); void slotToggleShowDesktop(); void slotWindowMaximize(); void slotWindowMaximizeVertical(); void slotWindowMaximizeHorizontal(); void slotWindowMinimize(); void slotWindowShade(); void slotWindowRaise(); void slotWindowLower(); void slotWindowRaiseOrLower(); void slotActivateAttentionWindow(); void slotWindowCenter(); void slotWindowMoveLeft(); void slotWindowMoveRight(); void slotWindowMoveUp(); void slotWindowMoveDown(); void slotWindowExpandHorizontal(); void slotWindowExpandVertical(); void slotWindowShrinkHorizontal(); void slotWindowShrinkVertical(); void slotIncreaseWindowOpacity(); void slotLowerWindowOpacity(); void slotWindowOperations(); void slotWindowClose(); void slotWindowMove(); void slotWindowResize(); void slotWindowAbove(); void slotWindowBelow(); void slotWindowOnAllDesktops(); void slotWindowFullScreen(); void slotWindowNoBorder(); void slotWindowToNextDesktop(); void slotWindowToPreviousDesktop(); void slotWindowToDesktopRight(); void slotWindowToDesktopLeft(); void slotWindowToDesktopUp(); void slotWindowToDesktopDown(); void reconfigure(); void slotReconfigure(); void slotKillWindow(); void slotSetupWindowShortcut(); void setupWindowShortcutDone(bool); private Q_SLOTS: void desktopResized(); #if KWIN_BUILD_X11 void selectWmInputEventMask(); #endif void delayFocus(); void slotReloadConfig(); void updateCurrentActivity(const QString &new_activity); // virtual desktop handling void slotCurrentDesktopChanged(VirtualDesktop *previousDesktop, VirtualDesktop *newDesktop); void slotCurrentDesktopChanging(VirtualDesktop *currentDesktop, QPointF delta); void slotCurrentDesktopChangingCancelled(); void slotDesktopAdded(VirtualDesktop *desktop); void slotDesktopRemoved(VirtualDesktop *desktop); void slotOutputBackendOutputsQueried(); Q_SIGNALS: /** * Emitted after the Workspace has setup the complete initialization process. * This can be used to connect to for performing post-workspace initialization. */ void workspaceInitialized(); void geometryChanged(); // Signals required for the scripting interface void currentActivityChanged(); void currentDesktopChanged(KWin::VirtualDesktop *previousDesktop, KWin::Window *); void currentDesktopChanging(KWin::VirtualDesktop *currentDesktop, QPointF delta, KWin::Window *); // for realtime animations void currentDesktopChangingCancelled(); void windowAdded(KWin::Window *); void windowRemoved(KWin::Window *); void windowActivated(KWin::Window *); void windowMinimizedChanged(KWin::Window *); #if KWIN_BUILD_X11 void groupAdded(KWin::Group *); #endif void deletedRemoved(KWin::Window *); void configChanged(); void showingDesktopChanged(bool showing, bool animated); void outputOrderChanged(); void outputAdded(KWin::Output *); void outputRemoved(KWin::Output *); void outputsChanged(); /** * This signal is emitted when the stacking order changed, i.e. a window is risen * or lowered */ void stackingOrderChanged(); void aboutToRearrange(); private: void init(); void initShortcuts(); template void initShortcut(const QString &actionName, const QString &description, const QKeySequence &shortcut, Slot slot); template void initShortcut(const QString &actionName, const QString &description, const QKeySequence &shortcut, T *receiver, Slot slot); void setupWindowShortcut(Window *window); bool switchWindow(Window *window, Direction direction, QPoint curPos, VirtualDesktop *desktop); QList constrainedStackingOrder(); void raiseWindowWithinApplication(Window *window); void lowerWindowWithinApplication(Window *window); bool allowFullClientRaising(const Window *window, uint32_t timestamp); void blockStackingUpdates(bool block); void saveOldScreenSizes(); void addToStack(Window *window); void removeFromStack(Window *window); #if KWIN_BUILD_X11 void initializeX11(); void cleanupX11(); void propagateWindows(bool propagate_new_windows); // Called only from updateStackingOrder void fixPositionAfterCrash(xcb_window_t w, const xcb_get_geometry_reply_t *geom); /// This is the right way to create a new X11 window X11Window *createX11Window(xcb_window_t windowId, bool is_mapped); void addX11Window(X11Window *c); X11Window *createUnmanaged(xcb_window_t windowId); void addUnmanaged(X11Window *c); void updateXStackingOrder(); #endif void setupWindowConnections(Window *window); void addWaylandWindow(Window *window); void removeWaylandWindow(Window *window); //--------------------------------------------------------------------- void closeActivePopup(); void updateWindowVisibilityOnDesktopChange(VirtualDesktop *newDesktop); void activateWindowOnDesktop(VirtualDesktop *desktop); Window *findWindowToActivateOnDesktop(VirtualDesktop *desktop); void removeWindow(Window *window); QString getPlacementTrackerHash(); void updateOutputConfiguration(); void updateOutputs(const std::optional> &outputOrder = std::nullopt); void createDpmsFilter(); void maybeDestroyDpmsFilter(); void assignBrightnessDevices(); bool breaksShowingDesktop(Window *window) const; struct Constraint { Window *below; Window *above; // All constraints above our "below" window QList parents; // All constraints below our "above" window QList children; // Used to prevent cycles. bool enqueued = false; }; QList m_constraints; QWidget *active_popup; Window *m_activePopupWindow; int m_initialDesktop; void updateTabbox(); QList m_outputs; Output *m_activeOutput = nullptr; QList m_outputOrder; Window *m_activeWindow; Window *m_lastActiveWindow; Window *m_moveResizeWindow; // Delay(ed) window focus timer and window QTimer *delayFocusTimer; Window *m_delayFocusWindow; QPointF focusMousePos; QList m_windows; QList deleted; QList unconstrained_stacking_order; // Topmost last QList stacking_order; // Topmost last bool force_restacking; QList should_get_focus; // Last is most recent QList attention_chain; bool showing_desktop; QList groups; bool was_user_interaction; #if KWIN_BUILD_X11 QList manual_overlays; // Topmost last std::unique_ptr m_wasUserInteractionFilter; std::unique_ptr m_nullFocus; std::unique_ptr m_movingClientFilter; std::unique_ptr m_syncAlarmFilter; #endif int block_focus; /** * Holds the menu containing the user actions which is shown * on e.g. right click the window decoration. */ UserActionsMenu *m_userActionsMenu; void modalActionsSwitch(bool enabled); ShortcutDialog *m_windowKeysDialog = nullptr; Window *m_windowKeysWindow = nullptr; bool m_globalShortcutsDisabledForWindow = false; // Timer to collect requests for 'reconfigure' QTimer reconfigureTimer; static Workspace *_self; #if KWIN_BUILD_X11 std::unique_ptr m_startup; #endif QHash m_workAreas; QHash m_restrictedAreas; QHash> m_screenAreas; QRect m_geometry; QHash m_oldScreenGeometries; QHash m_oldRestrictedAreas; QTimer m_rearrangeTimer; bool m_inRearrange = false; int m_setActiveWindowRecursion = 0; int m_blockStackingUpdates = 0; // When > 0, stacking updates are temporarily disabled bool m_blockedPropagatingNewWindows; // Propagate also new windows after enabling stacking updates? friend class StackingUpdatesBlocker; std::unique_ptr m_windowKiller; SessionManager *m_sessionManager; std::unique_ptr m_focusChain; std::unique_ptr m_applicationMenu; std::unique_ptr m_decorationBridge; std::unique_ptr m_outline; std::unique_ptr m_placement; std::unique_ptr m_rulebook; std::unique_ptr m_screenEdges; #if KWIN_BUILD_TABBOX std::unique_ptr m_tabbox; #endif #if KWIN_BUILD_ACTIVITIES std::unique_ptr m_activities; #endif std::unique_ptr m_placementTracker; PlaceholderOutput *m_placeholderOutput = nullptr; std::unique_ptr m_placeholderFilter; std::map> m_tileManagers; std::unique_ptr m_outputConfigStore; std::unique_ptr m_lidSwitchTracker; std::unique_ptr m_orientationSensor; std::unique_ptr m_dpmsFilter; private: friend bool performTransiencyCheck(); friend Workspace *workspace(); }; /** * Helper for Workspace::blockStackingUpdates() being called in pairs (True/false) */ class StackingUpdatesBlocker { public: explicit StackingUpdatesBlocker(Workspace *w) : ws(w) { ws->blockStackingUpdates(true); } ~StackingUpdatesBlocker() { ws->blockStackingUpdates(false); } private: Workspace *ws; }; //--------------------------------------------------------- // Unsorted inline QList Workspace::outputs() const { return m_outputs; } inline Window *Workspace::activeWindow() const { return m_activeWindow; } inline Window *Workspace::mostRecentlyActivatedWindow() const { return should_get_focus.count() > 0 ? should_get_focus.last() : m_activeWindow; } #if KWIN_BUILD_X11 inline void Workspace::addGroup(Group *group) { Q_EMIT groupAdded(group); groups.append(group); } inline void Workspace::removeGroup(Group *group) { groups.removeAll(group); } #endif inline const QList &Workspace::stackingOrder() const { // TODO: Q_ASSERT( block_stacking_updates == 0 ); return stacking_order; } inline bool Workspace::wasUserInteraction() const { return was_user_interaction; } inline SessionManager *Workspace::sessionManager() const { return m_sessionManager; } inline bool Workspace::showingDesktop() const { return showing_desktop; } inline bool Workspace::globalShortcutsDisabled() const { return m_globalShortcutsDisabledForWindow; } inline void Workspace::forceRestacking() { force_restacking = true; StackingUpdatesBlocker blocker(this); // Do restacking if not blocked } inline void Workspace::updateFocusMousePosition(const QPointF &pos) { focusMousePos = pos; } inline QPointF Workspace::focusMousePosition() const { return focusMousePos; } inline Workspace *workspace() { return Workspace::_self; } } // namespace Q_DECLARE_OPERATORS_FOR_FLAGS(KWin::Workspace::ActivityFlags)