kwin/toplevel.h

1042 lines
31 KiB
C
Raw Normal View History

/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright (C) 2006 Lubos Lunak <l.lunak@kde.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#ifndef KWIN_TOPLEVEL_H
#define KWIN_TOPLEVEL_H
// kwin
#include "input.h"
#include "utils.h"
#include "virtualdesktops.h"
#include "xcbutils.h"
// KDE
#include <NETWM>
// Qt
#include <QObject>
#include <QMatrix4x4>
#include <QUuid>
// xcb
#include <xcb/damage.h>
#include <xcb/xfixes.h>
// c++
#include <functional>
class QOpenGLFramebufferObject;
namespace KWayland
{
namespace Server
{
class SurfaceInterface;
}
}
namespace KWin
{
Improved resolving whether a window is on local machine Most windows use the hostname in WM_CLIENT_MACHINE, but there are windows using the FQDN (for example libreoffice). So instead of "foo" it is "foo.local.net" or similar. The logic so far has been unable to properly determine whether windows with FQDN are on the local system. In order to solve this problem the handling is split out into an own class which stores the information of hostname and whether it is a local machine. This is to not query multiple times. To determine whether the Client is on the local system getaddrinfo is used for the own hostname and the FQDN provided in WM_CLIENT_MACHINE. If one of the queried names matches, we know that it is on the local machine. The old logic to compare the hostname is still used and getaddrinfo is only a fallback in case hostname does not match. The problem with getaddrinfo is, that it accesses the network and by that could block. To circumvent this problem the calls are moved into threads by using QtConcurrent::run. Obviously this brings disadvantages. When trying to resolve whether a Client is on the local machine and a FQDN is used, the information is initially wrong. The new ClientMachine class emits a signal when the information that the system is local becomes available, but for some things this is just too late: * window rules are already gathered * Session Management has already taken place In both cases this is an acceptable loss. For window rules it just needs a proper matching of the machine in case of localhost (remote hosts are not affected). And the case of session management is very academic as it is unlikely that a restoring session contains remote windows. BUG: 308391 FIXED-IN: 4.11 REVIEW: 108235
2013-01-07 07:07:27 +00:00
class ClientMachine;
class Deleted;
class EffectWindowImpl;
class Shadow;
/**
* Enum to describe the reason why a Toplevel has to be released.
*/
enum class ReleaseReason {
Release, ///< Normal Release after e.g. an Unmap notify event (window still valid)
Destroyed, ///< Release after an Destroy notify event (window no longer valid)
KWinShutsDown ///< Release on KWin Shutdown (window still valid)
};
2019-10-02 09:57:59 +00:00
class KWIN_EXPORT Toplevel : public QObject
2011-01-30 14:34:42 +00:00
{
Q_OBJECT
2019-07-03 16:56:36 +00:00
Q_PROPERTY(bool alpha READ hasAlpha NOTIFY hasAlphaChanged)
Q_PROPERTY(qulonglong frameId READ frameId)
/**
* This property holds the geometry of the Toplevel, excluding invisible
* portions, e.g. client-side and server-side drop-shadows, etc.
*
* @deprecated Use frameGeometry property instead.
*/
Q_PROPERTY(QRect geometry READ frameGeometry NOTIFY geometryChanged)
/**
* This property holds rectangle that the pixmap or buffer of this Toplevel
* occupies on the screen. This rectangle includes invisible portions of the
* client, e.g. client-side drop shadows, etc.
*/
Q_PROPERTY(QRect bufferGeometry READ bufferGeometry NOTIFY geometryChanged)
/**
* This property holds the geometry of the Toplevel, excluding invisible
* portions, e.g. server-side and client-side drop-shadows, etc.
*/
Q_PROPERTY(QRect frameGeometry READ frameGeometry NOTIFY geometryChanged)
/**
* This property holds the position of the Toplevel's frame geometry.
*/
Q_PROPERTY(QPoint pos READ pos)
/**
* This property holds the size of the Toplevel's frame geometry.
*/
Q_PROPERTY(QSize size READ size)
/**
* This property holds the x position of the Toplevel's frame geometry.
*/
Q_PROPERTY(int x READ x)
/**
* This property holds the y position of the Toplevel's frame geometry.
*/
Q_PROPERTY(int y READ y)
/**
* This property holds the width of the Toplevel's frame geometry.
*/
Q_PROPERTY(int width READ width)
/**
* This property holds the height of the Toplevel's frame geometry.
*/
Q_PROPERTY(int height READ height)
Q_PROPERTY(QRect visibleRect READ visibleRect)
Q_PROPERTY(qreal opacity READ opacity WRITE setOpacity NOTIFY opacityChanged)
Q_PROPERTY(int screen READ screen NOTIFY screenChanged)
Q_PROPERTY(qulonglong windowId READ windowId CONSTANT)
Q_PROPERTY(int desktop READ desktop)
2019-07-03 16:56:36 +00:00
/**
* Whether the window is on all desktops. That is desktop is -1.
*/
Q_PROPERTY(bool onAllDesktops READ isOnAllDesktops)
2019-07-03 16:56:36 +00:00
Q_PROPERTY(QRect rect READ rect)
Q_PROPERTY(QPoint clientPos READ clientPos)
Q_PROPERTY(QSize clientSize READ clientSize)
Q_PROPERTY(QByteArray resourceName READ resourceName NOTIFY windowClassChanged)
Q_PROPERTY(QByteArray resourceClass READ resourceClass NOTIFY windowClassChanged)
Q_PROPERTY(QByteArray windowRole READ windowRole NOTIFY windowRoleChanged)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a desktop background window (the one with wallpaper).
* See _NET_WM_WINDOW_TYPE_DESKTOP at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool desktopWindow READ isDesktop)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a dock (i.e. a panel).
* See _NET_WM_WINDOW_TYPE_DOCK at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool dock READ isDock)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a standalone (detached) toolbar window.
* See _NET_WM_WINDOW_TYPE_TOOLBAR at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool toolbar READ isToolbar)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a torn-off menu.
* See _NET_WM_WINDOW_TYPE_MENU at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool menu READ isMenu)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a "normal" window, i.e. an application or any other window
* for which none of the specialized window types fit.
* See _NET_WM_WINDOW_TYPE_NORMAL at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool normalWindow READ isNormalWindow)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a dialog window.
* See _NET_WM_WINDOW_TYPE_DIALOG at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool dialog READ isDialog)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a splashscreen. Note that many (especially older) applications
* do not support marking their splash windows with this type.
* See _NET_WM_WINDOW_TYPE_SPLASH at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool splash READ isSplash)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a utility window, such as a tool window.
* See _NET_WM_WINDOW_TYPE_UTILITY at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool utility READ isUtility)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open
* from the applications menubar).
* See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool dropdownMenu READ isDropdownMenu)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a popup menu (that is not a torn-off or dropdown menu).
* See _NET_WM_WINDOW_TYPE_POPUP_MENU at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool popupMenu READ isPopupMenu)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a tooltip.
* See _NET_WM_WINDOW_TYPE_TOOLTIP at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool tooltip READ isTooltip)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a window with a notification.
* See _NET_WM_WINDOW_TYPE_NOTIFICATION at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool notification READ isNotification)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a window with a critical notification.
*/
Q_PROPERTY(bool criticalNotification READ isCriticalNotification)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is an On Screen Display.
*/
Q_PROPERTY(bool onScreenDisplay READ isOnScreenDisplay)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a combobox popup.
* See _NET_WM_WINDOW_TYPE_COMBO at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool comboBox READ isComboBox)
2019-07-03 16:56:36 +00:00
/**
* Returns whether the window is a Drag&Drop icon.
* See _NET_WM_WINDOW_TYPE_DND at https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(bool dndIcon READ isDNDIcon)
2019-07-03 16:56:36 +00:00
/**
* Returns the NETWM window type
* See https://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
*/
Q_PROPERTY(int windowType READ windowType)
2019-07-03 16:56:36 +00:00
Q_PROPERTY(QStringList activities READ activities NOTIFY activitiesChanged)
2019-07-03 16:56:36 +00:00
/**
* Whether this Toplevel is managed by KWin (it has control over its placement and other
* aspects, as opposed to override-redirect windows that are entirely handled by the application).
*/
Q_PROPERTY(bool managed READ isClient CONSTANT)
2019-07-03 16:56:36 +00:00
/**
* Whether this Toplevel represents an already deleted window and only kept for the compositor for animations.
*/
Q_PROPERTY(bool deleted READ isDeleted CONSTANT)
2019-07-03 16:56:36 +00:00
/**
* Whether the window has an own shape
*/
Q_PROPERTY(bool shaped READ shape NOTIFY shapedChanged)
2019-07-03 16:56:36 +00:00
/**
* Whether the window does not want to be animated on window close.
* There are legit reasons for this like a screenshot application which does not want it's
* window being captured.
*/
Q_PROPERTY(bool skipsCloseAnimation READ skipsCloseAnimation WRITE setSkipCloseAnimation NOTIFY skipCloseAnimationChanged)
2019-07-03 16:56:36 +00:00
/**
* The Id of the Wayland Surface associated with this Toplevel.
* On X11 only setups the value is @c 0.
*/
Q_PROPERTY(quint32 surfaceId READ surfaceId NOTIFY surfaceIdChanged)
/**
* Interface to the Wayland Surface.
* Relevant only in Wayland, in X11 it will be nullptr
*/
Q_PROPERTY(KWayland::Server::SurfaceInterface *surface READ surface)
/**
* Whether the window is a popup.
*/
Q_PROPERTY(bool popupWindow READ isPopupWindow)
/**
* Whether this Toplevel represents the outline.
*
* @note It's always @c false if compositing is turned off.
*/
Q_PROPERTY(bool outline READ isOutline)
/**
* This property holds a UUID to uniquely identify this Toplevel.
*/
Q_PROPERTY(QUuid internalId READ internalId CONSTANT)
2011-01-30 14:34:42 +00:00
public:
explicit Toplevel();
virtual xcb_window_t frameId() const;
xcb_window_t window() const;
/**
2019-01-12 10:31:32 +00:00
* @return a unique identifier for the Toplevel. On X11 same as @ref window
*/
virtual quint32 windowId() const;
/**
* Returns the geometry of the pixmap or buffer attached to this Toplevel.
*
* For X11 clients, this method returns server-side geometry of the Toplevel.
*
* For Wayland clients, this method returns rectangle that the main surface
* occupies on the screen, in global screen coordinates.
*/
virtual QRect bufferGeometry() const = 0;
/**
* Returns the extents of invisible portions in the pixmap.
*
* An X11 pixmap may contain invisible space around the actual contents of the
* client. That space is reserved for server-side decoration, which we usually
* want to skip when building contents window quads.
*
* Default implementation returns a margins object with all margins set to 0.
*/
virtual QMargins bufferMargins() const;
/**
* Returns the geometry of the Toplevel, excluding invisible portions, e.g.
* server-side and client-side drop shadows, etc.
*/
QRect frameGeometry() const;
/**
* Returns the extents of the server-side decoration.
*
* Note that the returned margins object will have all margins set to 0 if
* the client doesn't have a server-side decoration.
*
* Default implementation returns a margins object with all margins set to 0.
*/
virtual QMargins frameMargins() const;
/**
* The geometry of the Toplevel which accepts input events. This might be larger
* than the actual geometry, e.g. to support resizing outside the window.
*
* Default implementation returns same as geometry.
*/
virtual QRect inputGeometry() const;
2011-01-30 14:34:42 +00:00
QSize size() const;
QPoint pos() const;
QRect rect() const;
int x() const;
int y() const;
int width() const;
int height() const;
bool isOnScreen(int screen) const; // true if it's at least partially there
bool isOnActiveScreen() const;
2011-01-30 14:34:42 +00:00
int screen() const; // the screen where the center is
/**
* The scale of the screen this window is currently on
2019-01-11 13:36:17 +00:00
* @note The buffer scale can be different.
* @since 5.12
*/
qreal screenScale() const; //
/**
* Returns the ratio between physical pixels and device-independent pixels for
* the attached buffer (or pixmap).
*
* For X11 clients, this method always returns 1.
*/
virtual qreal bufferScale() const;
2011-01-30 14:34:42 +00:00
virtual QPoint clientPos() const = 0; // inside of geometry()
/**
* Describes how the client's content maps to the window geometry including the frame.
* The default implementation is a 1:1 mapping meaning the frame is part of the content.
*/
virtual QPoint clientContentPos() const;
2011-01-30 14:34:42 +00:00
virtual QSize clientSize() const = 0;
virtual QRect visibleRect() const; // the area the window occupies on the screen
virtual QRect decorationRect() const; // rect including the decoration shadows
virtual QRect transparentRect() const = 0;
virtual bool isClient() const;
virtual bool isDeleted() const;
2011-01-30 14:34:42 +00:00
// prefer isXXX() instead
// 0 for supported types means default for managed/unmanaged types
virtual NET::WindowType windowType(bool direct = false, int supported_types = 0) const = 0;
2011-01-30 14:34:42 +00:00
bool hasNETSupport() const;
bool isDesktop() const;
bool isDock() const;
bool isToolbar() const;
bool isMenu() const;
bool isNormalWindow() const; // normal as in 'NET::Normal or NET::Unknown non-transient'
bool isDialog() const;
bool isSplash() const;
bool isUtility() const;
bool isDropdownMenu() const;
bool isPopupMenu() const; // a context popup, not dropdown, not torn-off
bool isTooltip() const;
bool isNotification() const;
bool isCriticalNotification() const;
bool isOnScreenDisplay() const;
2011-01-30 14:34:42 +00:00
bool isComboBox() const;
bool isDNDIcon() const;
virtual bool isLockScreen() const;
virtual bool isInputMethod() const;
virtual bool isOutline() const;
/**
* Returns the virtual desktop within the workspace() the client window
* is located in, 0 if it isn't located on any special desktop (not mapped yet),
* or NET::OnAllDesktops. Do not use desktop() directly, use
* isOnDesktop() instead.
*/
2011-01-30 14:34:42 +00:00
virtual int desktop() const = 0;
virtual QVector<VirtualDesktop *> desktops() const = 0;
2011-01-30 14:34:42 +00:00
virtual QStringList activities() const = 0;
bool isOnDesktop(int d) const;
bool isOnActivity(const QString &activity) const;
bool isOnCurrentDesktop() const;
bool isOnCurrentActivity() const;
bool isOnAllDesktops() const;
bool isOnAllActivities() const;
virtual QByteArray windowRole() const;
QByteArray sessionId() const;
2011-01-30 14:34:42 +00:00
QByteArray resourceName() const;
QByteArray resourceClass() const;
QByteArray wmCommand();
2011-01-30 14:34:42 +00:00
QByteArray wmClientMachine(bool use_localhost) const;
Improved resolving whether a window is on local machine Most windows use the hostname in WM_CLIENT_MACHINE, but there are windows using the FQDN (for example libreoffice). So instead of "foo" it is "foo.local.net" or similar. The logic so far has been unable to properly determine whether windows with FQDN are on the local system. In order to solve this problem the handling is split out into an own class which stores the information of hostname and whether it is a local machine. This is to not query multiple times. To determine whether the Client is on the local system getaddrinfo is used for the own hostname and the FQDN provided in WM_CLIENT_MACHINE. If one of the queried names matches, we know that it is on the local machine. The old logic to compare the hostname is still used and getaddrinfo is only a fallback in case hostname does not match. The problem with getaddrinfo is, that it accesses the network and by that could block. To circumvent this problem the calls are moved into threads by using QtConcurrent::run. Obviously this brings disadvantages. When trying to resolve whether a Client is on the local machine and a FQDN is used, the information is initially wrong. The new ClientMachine class emits a signal when the information that the system is local becomes available, but for some things this is just too late: * window rules are already gathered * Session Management has already taken place In both cases this is an acceptable loss. For window rules it just needs a proper matching of the machine in case of localhost (remote hosts are not affected). And the case of session management is very academic as it is unlikely that a restoring session contains remote windows. BUG: 308391 FIXED-IN: 4.11 REVIEW: 108235
2013-01-07 07:07:27 +00:00
const ClientMachine *clientMachine() const;
virtual bool isLocalhost() const;
xcb_window_t wmClientLeader() const;
virtual pid_t pid() const;
2011-01-30 14:34:42 +00:00
static bool resourceMatch(const Toplevel* c1, const Toplevel* c2);
bool readyForPainting() const; // true if the window has been already painted its contents
xcb_visualid_t visual() const;
2011-01-30 14:34:42 +00:00
bool shape() const;
QRegion inputShape() const;
virtual void setOpacity(double opacity);
virtual double opacity() const;
2011-01-30 14:34:42 +00:00
int depth() const;
bool hasAlpha() const;
virtual bool setupCompositing();
virtual void finishCompositing(ReleaseReason releaseReason = ReleaseReason::Release);
Q_INVOKABLE void addRepaint(const QRect& r);
Q_INVOKABLE void addRepaint(const QRegion& r);
Q_INVOKABLE void addRepaint(int x, int y, int w, int h);
Q_INVOKABLE void addLayerRepaint(const QRect& r);
Q_INVOKABLE void addLayerRepaint(const QRegion& r);
Q_INVOKABLE void addLayerRepaint(int x, int y, int w, int h);
Q_INVOKABLE virtual void addRepaintFull();
2011-01-30 14:34:42 +00:00
// these call workspace->addRepaint(), but first transform the damage if needed
void addWorkspaceRepaint(const QRect& r);
void addWorkspaceRepaint(int x, int y, int w, int h);
QRegion repaints() const;
void resetRepaints();
2011-01-30 14:34:42 +00:00
QRegion damage() const;
void resetDamage();
2011-01-30 14:34:42 +00:00
EffectWindowImpl* effectWindow();
const EffectWindowImpl* effectWindow() const;
/**
* Window will be temporarily painted as if being at the top of the stack.
* Only available if Compositor is active, if not active, this method is a no-op.
*/
void elevate(bool elevate);
2011-01-30 14:34:42 +00:00
/**
* Returns the pointer to the Toplevel's Shadow. A Shadow
* is only available if Compositing is enabled and the corresponding X window
* has the Shadow property set.
* @returns The Shadow belonging to this Toplevel, @c null if there's no Shadow.
*/
const Shadow *shadow() const;
Shadow *shadow();
/**
* Updates the Shadow associated with this Toplevel from X11 Property.
* Call this method when the Property changes or Compositing is started.
*/
void updateShadow();
/**
* Whether the Toplevel currently wants the shadow to be rendered. Default
* implementation always returns @c true.
*/
virtual bool wantsShadowToBeRendered() const;
/**
* This method returns the area that the Toplevel window reports to be opaque.
2019-01-12 10:31:32 +00:00
* It is supposed to only provide valuable information if hasAlpha is @c true .
* @see hasAlpha
*/
const QRegion& opaqueRegion() const;
virtual Layer layer() const = 0;
/**
* Resets the damage state and sends a request for the damage region.
* A call to this function must be followed by a call to getDamageRegionReply(),
* or the reply will be leaked.
*
* Returns true if the window was damaged, and false otherwise.
*/
bool resetAndFetchDamage();
/**
* Gets the reply from a previous call to resetAndFetchDamage().
* Calling this function is a no-op if there is no pending reply.
* Call damage() to return the fetched region.
*/
void getDamageRegionReply();
bool skipsCloseAnimation() const;
void setSkipCloseAnimation(bool set);
quint32 surfaceId() const;
KWayland::Server::SurfaceInterface *surface() const;
void setSurface(KWayland::Server::SurfaceInterface *surface);
const QSharedPointer<QOpenGLFramebufferObject> &internalFramebufferObject() const;
QImage internalImageObject() const;
/**
* @returns Transformation to map from global to window coordinates.
*
* Default implementation returns a translation on negative pos().
* @see pos
*/
virtual QMatrix4x4 inputTransformation() const;
/**
* The window has a popup grab. This means that when it got mapped the
* parent window had an implicit (pointer) grab.
*
* Normally this is only relevant for transient windows.
*
* Once the popup grab ends (e.g. pointer press outside of any Toplevel of
* the client), the method popupDone should be invoked.
*
* The default implementation returns @c false.
* @see popupDone
* @since 5.10
*/
virtual bool hasPopupGrab() const {
return false;
}
/**
* This method should be invoked for Toplevels with a popup grab when
* the grab ends.
*
* The default implementation does nothing.
* @see hasPopupGrab
* @since 5.10
*/
virtual void popupDone() {};
/**
* @brief Finds the Toplevel matching the condition expressed in @p func in @p list.
*
* The method is templated to operate on either a list of Toplevels or on a list of
* a subclass type of Toplevel.
* @param list The list to search in
* @param func The condition function (compare std::find_if)
* @return T* The found Toplevel or @c null if there is no matching Toplevel
*/
template <class T, class U>
static T *findInList(const QList<T*> &list, std::function<bool (const U*)> func);
/**
* Whether the window is a popup.
*
* Popups can be used to implement popup menus, tooltips, combo boxes, etc.
*
* @since 5.15
*/
virtual bool isPopupWindow() const;
/**
* A UUID to uniquely identify this Toplevel independent of windowing system.
*/
QUuid internalId() const
{
return m_internalId;
}
Q_SIGNALS:
2011-03-06 09:30:23 +00:00
void opacityChanged(KWin::Toplevel* toplevel, qreal oldOpacity);
2011-03-12 14:04:22 +00:00
void damaged(KWin::Toplevel* toplevel, const QRect& damage);
void geometryChanged();
void geometryShapeChanged(KWin::Toplevel* toplevel, const QRect& old);
void paddingChanged(KWin::Toplevel* toplevel, const QRect& old);
void windowClosed(KWin::Toplevel* toplevel, KWin::Deleted* deleted);
void windowShown(KWin::Toplevel* toplevel);
void windowHidden(KWin::Toplevel* toplevel);
/**
* Signal emitted when the window's shape state changed. That is if it did not have a shape
* and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's
* decoration.
*/
void shapedChanged();
/**
* Emitted whenever the state changes in a way, that the Compositor should
* schedule a repaint of the scene.
*/
void needsRepaint();
void activitiesChanged(KWin::Toplevel* toplevel);
/**
* Emitted whenever the Toplevel's screen changes. This can happen either in consequence to
* a screen being removed/added or if the Toplevel's geometry changes.
* @since 4.11
*/
void screenChanged();
void skipCloseAnimationChanged();
/**
* Emitted whenever the window role of the window changes.
* @since 5.0
*/
void windowRoleChanged();
/**
* Emitted whenever the window class name or resource name of the window changes.
* @since 5.0
*/
void windowClassChanged();
/**
* Emitted when a Wayland Surface gets associated with this Toplevel.
* @since 5.3
*/
void surfaceIdChanged(quint32);
/**
* @since 5.4
*/
void hasAlphaChanged();
/**
* Emitted whenever the Surface for this Toplevel changes.
*/
void surfaceChanged();
/*
* Emitted when the client's screen changes onto a screen of a different scale
* or the screen we're on changes
* @since 5.12
*/
void screenScaleChanged();
/**
* Emitted whenever the client's shadow changes.
* @since 5.15
*/
void shadowChanged();
protected Q_SLOTS:
/**
* Checks whether the screen number for this Toplevel changed and updates if needed.
* Any method changing the geometry of the Toplevel should call this method.
*/
void checkScreen();
void setupCheckScreenConnection();
void removeCheckScreenConnection();
void setReadyForPainting();
2011-03-06 09:30:23 +00:00
2011-01-30 14:34:42 +00:00
protected:
Run clang-tidy with modernize-use-override check Summary: Currently code base of kwin can be viewed as two pieces. One is very ancient, and the other one is more modern, which uses new C++ features. The main problem with the ancient code is that it was written before C++11 era. So, no override or final keywords, lambdas, etc. Quite recently, KDE compiler settings were changed to show a warning if a virtual method has missing override keyword. As you might have already guessed, this fired back at us because of that ancient code. We had about 500 new compiler warnings. A "solution" was proposed to that problem - disable -Wno-suggest-override and the other similar warning for clang. It's hard to call a solution because those warnings are disabled not only for the old code, but also for new. This is not what we want! The main argument for not actually fixing the problem was that git history will be screwed as well because of human factor. While good git history is a very important thing, we should not go crazy about it and block every change that somehow alters git history. git blame allows to specify starting revision for a reason. The other argument (human factor) can be easily solved by using tools such as clang-tidy. clang-tidy is a clang-based linter for C++. It can be used for various things, e.g. fixing coding style(e.g. add missing braces to if statements, readability-braces-around-statements check), or in our case add missing override keywords. Test Plan: Compiles. Reviewers: #kwin, davidedmundson Reviewed By: #kwin, davidedmundson Subscribers: davidedmundson, apol, romangg, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D22371
2019-07-22 16:52:26 +00:00
~Toplevel() override;
void setWindowHandles(xcb_window_t client);
void detectShape(xcb_window_t id);
virtual void propertyNotifyEvent(xcb_property_notify_event_t *e);
virtual void damageNotifyEvent();
virtual void clientMessageEvent(xcb_client_message_event_t *e);
2011-01-30 14:34:42 +00:00
void discardWindowPixmap();
void addDamageFull();
virtual void addDamage(const QRegion &damage);
Xcb::Property fetchWmClientLeader() const;
void readWmClientLeader(Xcb::Property &p);
2011-01-30 14:34:42 +00:00
void getWmClientLeader();
void getWmClientMachine();
/**
* @returns Whether there is a compositor and it is active.
*/
bool compositing() const;
/**
* This function fetches the opaque region from this Toplevel.
* Will only be called on corresponding property changes and for initialization.
*/
void getWmOpaqueRegion();
2011-01-30 14:34:42 +00:00
void getResourceClass();
void setResourceClass(const QByteArray &name, const QByteArray &className = QByteArray());
Xcb::Property fetchSkipCloseAnimation() const;
void readSkipCloseAnimation(Xcb::Property &prop);
void getSkipCloseAnimation();
2011-01-30 14:34:42 +00:00
virtual void debug(QDebug& stream) const = 0;
void copyToDeleted(Toplevel* c);
void disownDataPassedToDeleted();
friend QDebug& operator<<(QDebug& stream, const Toplevel*);
void deleteEffectWindow();
void setDepth(int depth);
QRect m_frameGeometry;
xcb_visualid_t m_visual;
2011-01-30 14:34:42 +00:00
int bit_depth;
NETWinInfo* info;
2011-01-30 14:34:42 +00:00
bool ready_for_painting;
QRegion repaints_region; // updating, repaint just requires repaint of that area
QRegion layer_repaints_region;
/**
* An FBO object KWin internal windows might render to.
*/
QSharedPointer<QOpenGLFramebufferObject> m_internalFBO;
QImage m_internalImage;
protected:
bool m_isDamaged;
2011-01-30 14:34:42 +00:00
private:
// when adding new data members, check also copyToDeleted()
QUuid m_internalId;
Xcb::Window m_client;
xcb_damage_damage_t damage_handle;
2011-01-30 14:34:42 +00:00
QRegion damage_region; // damage is really damaged window (XDamage) and texture needs
bool is_shape;
EffectWindowImpl* effect_window;
QByteArray resource_name;
QByteArray resource_class;
Improved resolving whether a window is on local machine Most windows use the hostname in WM_CLIENT_MACHINE, but there are windows using the FQDN (for example libreoffice). So instead of "foo" it is "foo.local.net" or similar. The logic so far has been unable to properly determine whether windows with FQDN are on the local system. In order to solve this problem the handling is split out into an own class which stores the information of hostname and whether it is a local machine. This is to not query multiple times. To determine whether the Client is on the local system getaddrinfo is used for the own hostname and the FQDN provided in WM_CLIENT_MACHINE. If one of the queried names matches, we know that it is on the local machine. The old logic to compare the hostname is still used and getaddrinfo is only a fallback in case hostname does not match. The problem with getaddrinfo is, that it accesses the network and by that could block. To circumvent this problem the calls are moved into threads by using QtConcurrent::run. Obviously this brings disadvantages. When trying to resolve whether a Client is on the local machine and a FQDN is used, the information is initially wrong. The new ClientMachine class emits a signal when the information that the system is local becomes available, but for some things this is just too late: * window rules are already gathered * Session Management has already taken place In both cases this is an acceptable loss. For window rules it just needs a proper matching of the machine in case of localhost (remote hosts are not affected). And the case of session management is very academic as it is unlikely that a restoring session contains remote windows. BUG: 308391 FIXED-IN: 4.11 REVIEW: 108235
2013-01-07 07:07:27 +00:00
ClientMachine *m_clientMachine;
xcb_window_t m_wmClientLeader;
bool m_damageReplyPending;
QRegion opaque_region;
xcb_xfixes_fetch_region_cookie_t m_regionCookie;
int m_screen;
bool m_skipCloseAnimation;
quint32 m_surfaceId = 0;
KWayland::Server::SurfaceInterface *m_surface = nullptr;
2011-01-30 14:34:42 +00:00
// when adding new data members, check also copyToDeleted()
qreal m_screenScale = 1.0;
2011-01-30 14:34:42 +00:00
};
inline xcb_window_t Toplevel::window() const
2011-01-30 14:34:42 +00:00
{
return m_client;
2011-01-30 14:34:42 +00:00
}
inline void Toplevel::setWindowHandles(xcb_window_t w)
2011-01-30 14:34:42 +00:00
{
Q_ASSERT(!m_client.isValid() && w != XCB_WINDOW_NONE);
m_client.reset(w, false);
2011-01-30 14:34:42 +00:00
}
inline QRect Toplevel::frameGeometry() const
2011-01-30 14:34:42 +00:00
{
return m_frameGeometry;
2011-01-30 14:34:42 +00:00
}
inline QSize Toplevel::size() const
2011-01-30 14:34:42 +00:00
{
return m_frameGeometry.size();
2011-01-30 14:34:42 +00:00
}
inline QPoint Toplevel::pos() const
2011-01-30 14:34:42 +00:00
{
return m_frameGeometry.topLeft();
2011-01-30 14:34:42 +00:00
}
inline int Toplevel::x() const
2011-01-30 14:34:42 +00:00
{
return m_frameGeometry.x();
2011-01-30 14:34:42 +00:00
}
inline int Toplevel::y() const
2011-01-30 14:34:42 +00:00
{
return m_frameGeometry.y();
2011-01-30 14:34:42 +00:00
}
inline int Toplevel::width() const
2011-01-30 14:34:42 +00:00
{
return m_frameGeometry.width();
2011-01-30 14:34:42 +00:00
}
inline int Toplevel::height() const
2011-01-30 14:34:42 +00:00
{
return m_frameGeometry.height();
2011-01-30 14:34:42 +00:00
}
inline QRect Toplevel::rect() const
2011-01-30 14:34:42 +00:00
{
return QRect(0, 0, width(), height());
}
inline bool Toplevel::readyForPainting() const
2011-01-30 14:34:42 +00:00
{
return ready_for_painting;
2011-01-30 14:34:42 +00:00
}
inline xcb_visualid_t Toplevel::visual() const
2011-01-30 14:34:42 +00:00
{
return m_visual;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isDesktop() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::Desktop;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isDock() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::Dock;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isMenu() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::Menu;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isToolbar() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::Toolbar;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isSplash() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::Splash;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isUtility() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::Utility;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isDialog() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::Dialog;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isNormalWindow() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::Normal;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isDropdownMenu() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::DropdownMenu;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isPopupMenu() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::PopupMenu;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isTooltip() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::Tooltip;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isNotification() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::Notification;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isCriticalNotification() const
{
return windowType() == NET::CriticalNotification;
}
inline bool Toplevel::isOnScreenDisplay() const
{
return windowType() == NET::OnScreenDisplay;
}
inline bool Toplevel::isComboBox() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::ComboBox;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isDNDIcon() const
2011-01-30 14:34:42 +00:00
{
return windowType() == NET::DNDIcon;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isLockScreen() const
{
return false;
}
inline bool Toplevel::isInputMethod() const
{
return false;
}
inline bool Toplevel::isOutline() const
{
return false;
}
inline QRegion Toplevel::damage() const
2011-01-30 14:34:42 +00:00
{
return damage_region;
2011-01-30 14:34:42 +00:00
}
inline QRegion Toplevel::repaints() const
2011-01-30 14:34:42 +00:00
{
return repaints_region.translated(pos()) | layer_repaints_region;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::shape() const
2011-01-30 14:34:42 +00:00
{
return is_shape;
2011-01-30 14:34:42 +00:00
}
inline int Toplevel::depth() const
2011-01-30 14:34:42 +00:00
{
return bit_depth;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::hasAlpha() const
2011-01-30 14:34:42 +00:00
{
return depth() == 32;
2011-01-30 14:34:42 +00:00
}
inline const QRegion& Toplevel::opaqueRegion() const
{
return opaque_region;
}
inline
EffectWindowImpl* Toplevel::effectWindow()
2011-01-30 14:34:42 +00:00
{
return effect_window;
2011-01-30 14:34:42 +00:00
}
inline
const EffectWindowImpl* Toplevel::effectWindow() const
{
return effect_window;
}
inline bool Toplevel::isOnAllDesktops() const
2011-01-30 14:34:42 +00:00
{
return kwinApp()->operationMode() == Application::OperationModeWaylandOnly ||
kwinApp()->operationMode() == Application::OperationModeXwayland
//Wayland
? desktops().isEmpty()
//X11
: desktop() == NET::OnAllDesktops;
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isOnAllActivities() const
2011-01-30 14:34:42 +00:00
{
return activities().isEmpty();
2011-01-30 14:34:42 +00:00
}
2011-01-30 14:34:42 +00:00
inline bool Toplevel::isOnDesktop(int d) const
{
return (kwinApp()->operationMode() == Application::OperationModeWaylandOnly ||
kwinApp()->operationMode() == Application::OperationModeXwayland
? desktops().contains(VirtualDesktopManager::self()->desktopForX11Id(d))
: desktop() == d
) || isOnAllDesktops();
2011-01-30 14:34:42 +00:00
}
2011-01-30 14:34:42 +00:00
inline bool Toplevel::isOnActivity(const QString &activity) const
{
return activities().isEmpty() || activities().contains(activity);
2011-01-30 14:34:42 +00:00
}
inline bool Toplevel::isOnCurrentDesktop() const
2011-01-30 14:34:42 +00:00
{
return isOnDesktop(VirtualDesktopManager::self()->current());
2011-01-30 14:34:42 +00:00
}
inline QByteArray Toplevel::resourceName() const
2011-01-30 14:34:42 +00:00
{
return resource_name; // it is always lowercase
2011-01-30 14:34:42 +00:00
}
inline QByteArray Toplevel::resourceClass() const
2011-01-30 14:34:42 +00:00
{
return resource_class; // it is always lowercase
2011-01-30 14:34:42 +00:00
}
Improved resolving whether a window is on local machine Most windows use the hostname in WM_CLIENT_MACHINE, but there are windows using the FQDN (for example libreoffice). So instead of "foo" it is "foo.local.net" or similar. The logic so far has been unable to properly determine whether windows with FQDN are on the local system. In order to solve this problem the handling is split out into an own class which stores the information of hostname and whether it is a local machine. This is to not query multiple times. To determine whether the Client is on the local system getaddrinfo is used for the own hostname and the FQDN provided in WM_CLIENT_MACHINE. If one of the queried names matches, we know that it is on the local machine. The old logic to compare the hostname is still used and getaddrinfo is only a fallback in case hostname does not match. The problem with getaddrinfo is, that it accesses the network and by that could block. To circumvent this problem the calls are moved into threads by using QtConcurrent::run. Obviously this brings disadvantages. When trying to resolve whether a Client is on the local machine and a FQDN is used, the information is initially wrong. The new ClientMachine class emits a signal when the information that the system is local becomes available, but for some things this is just too late: * window rules are already gathered * Session Management has already taken place In both cases this is an acceptable loss. For window rules it just needs a proper matching of the machine in case of localhost (remote hosts are not affected). And the case of session management is very academic as it is unlikely that a restoring session contains remote windows. BUG: 308391 FIXED-IN: 4.11 REVIEW: 108235
2013-01-07 07:07:27 +00:00
inline const ClientMachine *Toplevel::clientMachine() const
{
return m_clientMachine;
}
inline quint32 Toplevel::surfaceId() const
{
return m_surfaceId;
}
inline KWayland::Server::SurfaceInterface *Toplevel::surface() const
{
return m_surface;
}
inline const QSharedPointer<QOpenGLFramebufferObject> &Toplevel::internalFramebufferObject() const
{
return m_internalFBO;
}
inline QImage Toplevel::internalImageObject() const
{
return m_internalImage;
}
inline QPoint Toplevel::clientContentPos() const
{
return QPoint(0, 0);
}
template <class T, class U>
inline T *Toplevel::findInList(const QList<T*> &list, std::function<bool (const U*)> func)
{
static_assert(std::is_base_of<U, T>::value,
"U must be derived from T");
const auto it = std::find_if(list.begin(), list.end(), func);
if (it == list.end()) {
return nullptr;
}
return *it;
}
inline bool Toplevel::isPopupWindow() const
{
switch (windowType()) {
case NET::ComboBox:
case NET::DropdownMenu:
case NET::PopupMenu:
case NET::Tooltip:
return true;
default:
return false;
}
}
2011-01-30 14:34:42 +00:00
QDebug& operator<<(QDebug& stream, const Toplevel*);
} // namespace
Q_DECLARE_METATYPE(KWin::Toplevel*)
#endif