2020-08-02 22:22:19 +00:00
|
|
|
/*
|
|
|
|
|
KWin - the KDE window manager
|
|
|
|
|
This file is part of the KDE project.
|
2007-04-29 17:35:43 +00:00
|
|
|
|
2020-08-02 22:22:19 +00:00
|
|
|
SPDX-FileCopyrightText: 2006 Lubos Lunak <l.lunak@kde.org>
|
|
|
|
|
SPDX-FileCopyrightText: 2010, 2011 Martin Gräßlin <mgraesslin@kde.org>
|
2007-04-29 17:35:43 +00:00
|
|
|
|
2020-08-02 22:22:19 +00:00
|
|
|
SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
|
*/
|
2007-04-29 17:35:43 +00:00
|
|
|
|
|
|
|
|
#ifndef KWIN_EFFECTSIMPL_H
|
|
|
|
|
#define KWIN_EFFECTSIMPL_H
|
|
|
|
|
|
|
|
|
|
#include "kwineffects.h"
|
|
|
|
|
|
|
|
|
|
#include "scene.h"
|
|
|
|
|
|
2010-05-25 16:56:23 +00:00
|
|
|
#include <QHash>
|
2011-02-17 18:35:08 +00:00
|
|
|
#include <Plasma/FrameSvg>
|
2007-04-29 17:35:43 +00:00
|
|
|
|
2018-08-31 18:28:22 +00:00
|
|
|
#include <memory>
|
|
|
|
|
|
2013-07-22 14:10:47 +00:00
|
|
|
namespace Plasma {
|
|
|
|
|
class Theme;
|
|
|
|
|
}
|
|
|
|
|
|
2020-04-29 15:18:41 +00:00
|
|
|
namespace KWaylandServer
|
2015-08-31 13:47:01 +00:00
|
|
|
{
|
|
|
|
|
class Display;
|
|
|
|
|
}
|
|
|
|
|
|
2013-01-30 12:07:59 +00:00
|
|
|
class QDBusPendingCallWatcher;
|
|
|
|
|
class QDBusServiceWatcher;
|
2007-07-06 12:38:41 +00:00
|
|
|
|
2007-04-29 17:35:43 +00:00
|
|
|
|
|
|
|
|
namespace KWin
|
|
|
|
|
{
|
|
|
|
|
|
2012-03-29 13:32:41 +00:00
|
|
|
class AbstractThumbnailItem;
|
2012-03-29 18:17:57 +00:00
|
|
|
class DesktopThumbnailItem;
|
2012-03-29 13:46:53 +00:00
|
|
|
class WindowThumbnailItem;
|
2011-11-10 13:28:06 +00:00
|
|
|
|
2018-08-31 18:28:22 +00:00
|
|
|
class AbstractClient;
|
2012-08-23 16:04:36 +00:00
|
|
|
class Compositor;
|
2011-02-27 09:47:42 +00:00
|
|
|
class Deleted;
|
2014-01-24 14:42:40 +00:00
|
|
|
class EffectLoader;
|
2019-10-31 13:20:42 +00:00
|
|
|
class Group;
|
2018-08-31 18:28:22 +00:00
|
|
|
class Toplevel;
|
2011-02-25 21:06:02 +00:00
|
|
|
class Unmanaged;
|
2017-09-16 17:25:33 +00:00
|
|
|
class WindowPropertyNotifyX11Filter;
|
2011-02-25 21:06:02 +00:00
|
|
|
|
2015-11-12 10:29:56 +00:00
|
|
|
class KWIN_EXPORT EffectsHandlerImpl : public EffectsHandler
|
2007-04-29 17:35:43 +00:00
|
|
|
{
|
2011-02-25 19:41:10 +00:00
|
|
|
Q_OBJECT
|
2012-08-30 06:20:26 +00:00
|
|
|
Q_CLASSINFO("D-Bus Interface", "org.kde.kwin.Effects")
|
|
|
|
|
Q_PROPERTY(QStringList activeEffects READ activeEffects)
|
|
|
|
|
Q_PROPERTY(QStringList loadedEffects READ loadedEffects)
|
|
|
|
|
Q_PROPERTY(QStringList listOfEffects READ listOfEffects)
|
2011-01-30 14:34:42 +00:00
|
|
|
public:
|
2012-08-23 16:04:36 +00:00
|
|
|
EffectsHandlerImpl(Compositor *compositor, Scene *scene);
|
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
|
|
|
~EffectsHandlerImpl() override;
|
Provide expected presentation time to effects
Effects are given the interval between two consecutive frames. The main
flaw of this approach is that if the Compositor transitions from the idle
state to "active" state, i.e. when there is something to repaint,
effects may see a very large interval between the last painted frame and
the current. In order to address this issue, the Scene invalidates the
timer that is used to measure time between consecutive frames before the
Compositor is about to become idle.
While this works perfectly fine with Xinerama-style rendering, with per
screen rendering, determining whether the compositor is about to idle is
rather a tedious task mostly because a single output can't be used for
the test.
Furthermore, since the Compositor schedules pointless repaints just to
ensure that it's idle, it might take several attempts to figure out
whether the scene timer must be invalidated if you use (true) per screen
rendering.
Ideally, all effects should use a timeline helper that is aware of the
underlying render loop and its timings. However, this option is off the
table because it will involve a lot of work to implement it.
Alternative and much simpler option is to pass the expected presentation
time to effects rather than time between consecutive frames. This means
that effects are responsible for determining how much animation timelines
have to be advanced. Typically, an effect would have to store the
presentation timestamp provided in either prePaint{Screen,Window} and
use it in the subsequent prePaint{Screen,Window} call to estimate the
amount of time passed between the next and the last frames.
Unfortunately, this is an API incompatible change. However, it shouldn't
take a lot of work to port third-party binary effects, which don't use the
AnimationEffect class, to the new API. On the bright side, we no longer
need to be concerned about the Compositor getting idle.
We do still try to determine whether the Compositor is about to idle,
primarily, because the OpenGL render backend swaps buffers on present,
but that will change with the ongoing compositing timing rework.
2020-11-20 15:44:04 +00:00
|
|
|
void prePaintScreen(ScreenPrePaintData& data, std::chrono::milliseconds presentTime) override;
|
2019-10-29 22:04:15 +00:00
|
|
|
void paintScreen(int mask, const QRegion ®ion, ScreenPaintData& data) override;
|
2012-03-29 18:12:34 +00:00
|
|
|
/**
|
|
|
|
|
* Special hook to perform a paintScreen but just with the windows on @p desktop.
|
2019-07-29 18:58:33 +00:00
|
|
|
*/
|
2012-03-29 18:12:34 +00:00
|
|
|
void paintDesktop(int desktop, int mask, QRegion region, ScreenPaintData& data);
|
2014-02-27 10:57:59 +00:00
|
|
|
void postPaintScreen() override;
|
Provide expected presentation time to effects
Effects are given the interval between two consecutive frames. The main
flaw of this approach is that if the Compositor transitions from the idle
state to "active" state, i.e. when there is something to repaint,
effects may see a very large interval between the last painted frame and
the current. In order to address this issue, the Scene invalidates the
timer that is used to measure time between consecutive frames before the
Compositor is about to become idle.
While this works perfectly fine with Xinerama-style rendering, with per
screen rendering, determining whether the compositor is about to idle is
rather a tedious task mostly because a single output can't be used for
the test.
Furthermore, since the Compositor schedules pointless repaints just to
ensure that it's idle, it might take several attempts to figure out
whether the scene timer must be invalidated if you use (true) per screen
rendering.
Ideally, all effects should use a timeline helper that is aware of the
underlying render loop and its timings. However, this option is off the
table because it will involve a lot of work to implement it.
Alternative and much simpler option is to pass the expected presentation
time to effects rather than time between consecutive frames. This means
that effects are responsible for determining how much animation timelines
have to be advanced. Typically, an effect would have to store the
presentation timestamp provided in either prePaint{Screen,Window} and
use it in the subsequent prePaint{Screen,Window} call to estimate the
amount of time passed between the next and the last frames.
Unfortunately, this is an API incompatible change. However, it shouldn't
take a lot of work to port third-party binary effects, which don't use the
AnimationEffect class, to the new API. On the bright side, we no longer
need to be concerned about the Compositor getting idle.
We do still try to determine whether the Compositor is about to idle,
primarily, because the OpenGL render backend swaps buffers on present,
but that will change with the ongoing compositing timing rework.
2020-11-20 15:44:04 +00:00
|
|
|
void prePaintWindow(EffectWindow* w, WindowPrePaintData& data, std::chrono::milliseconds presentTime) override;
|
2019-10-29 22:04:15 +00:00
|
|
|
void paintWindow(EffectWindow* w, int mask, const QRegion ®ion, WindowPaintData& data) override;
|
2014-02-27 10:57:59 +00:00
|
|
|
void postPaintWindow(EffectWindow* w) override;
|
2019-10-29 22:04:15 +00:00
|
|
|
void paintEffectFrame(EffectFrame* frame, const QRegion ®ion, double opacity, double frameOpacity) override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2012-03-23 01:06:46 +00:00
|
|
|
Effect *provides(Effect::Feature ef);
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2019-10-29 22:04:15 +00:00
|
|
|
void drawWindow(EffectWindow* w, int mask, const QRegion ®ion, WindowPaintData& data) override;
|
2014-02-27 10:57:59 +00:00
|
|
|
|
|
|
|
|
void activateWindow(EffectWindow* c) override;
|
|
|
|
|
EffectWindow* activeWindow() const override;
|
|
|
|
|
void moveWindow(EffectWindow* w, const QPoint& pos, bool snap = false, double snapAdjust = 1.0) override;
|
|
|
|
|
void windowToDesktop(EffectWindow* w, int desktop) override;
|
|
|
|
|
void windowToScreen(EffectWindow* w, int screen) override;
|
|
|
|
|
void setShowingDesktop(bool showing) override;
|
|
|
|
|
|
|
|
|
|
QString currentActivity() const override;
|
|
|
|
|
int currentDesktop() const override;
|
|
|
|
|
int numberOfDesktops() const override;
|
|
|
|
|
void setCurrentDesktop(int desktop) override;
|
|
|
|
|
void setNumberOfDesktops(int desktops) override;
|
|
|
|
|
QSize desktopGridSize() const override;
|
|
|
|
|
int desktopGridWidth() const override;
|
|
|
|
|
int desktopGridHeight() const override;
|
|
|
|
|
int workspaceWidth() const override;
|
|
|
|
|
int workspaceHeight() const override;
|
|
|
|
|
int desktopAtCoords(QPoint coords) const override;
|
|
|
|
|
QPoint desktopGridCoords(int id) const override;
|
|
|
|
|
QPoint desktopCoords(int id) const override;
|
|
|
|
|
int desktopAbove(int desktop = 0, bool wrap = true) const override;
|
|
|
|
|
int desktopToRight(int desktop = 0, bool wrap = true) const override;
|
|
|
|
|
int desktopBelow(int desktop = 0, bool wrap = true) const override;
|
|
|
|
|
int desktopToLeft(int desktop = 0, bool wrap = true) const override;
|
|
|
|
|
QString desktopName(int desktop) const override;
|
|
|
|
|
bool optionRollOverDesktops() const override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 10:57:59 +00:00
|
|
|
QPoint cursorPos() const override;
|
|
|
|
|
bool grabKeyboard(Effect* effect) override;
|
|
|
|
|
void ungrabKeyboard() override;
|
2013-04-24 14:51:04 +00:00
|
|
|
// not performing XGrabPointer
|
2014-02-27 10:57:59 +00:00
|
|
|
void startMouseInterception(Effect *effect, Qt::CursorShape shape) override;
|
|
|
|
|
void stopMouseInterception(Effect *effect) override;
|
2016-02-23 11:29:05 +00:00
|
|
|
bool isMouseInterception() const;
|
2013-07-10 10:26:50 +00:00
|
|
|
void registerGlobalShortcut(const QKeySequence &shortcut, QAction *action) override;
|
2013-07-14 20:58:30 +00:00
|
|
|
void registerPointerShortcut(Qt::KeyboardModifiers modifiers, Qt::MouseButton pointerButtons, QAction *action) override;
|
2013-07-15 10:04:13 +00:00
|
|
|
void registerAxisShortcut(Qt::KeyboardModifiers modifiers, PointerAxisDirection axis, QAction *action) override;
|
2017-03-18 10:00:30 +00:00
|
|
|
void registerTouchpadSwipeShortcut(SwipeDirection direction, QAction *action) override;
|
2014-02-27 10:57:59 +00:00
|
|
|
void* getProxy(QString name) override;
|
|
|
|
|
void startMousePolling() override;
|
|
|
|
|
void stopMousePolling() override;
|
|
|
|
|
EffectWindow* findWindow(WId id) const override;
|
2020-04-29 15:18:41 +00:00
|
|
|
EffectWindow* findWindow(KWaylandServer::SurfaceInterface *surf) const override;
|
2019-01-13 16:50:32 +00:00
|
|
|
EffectWindow *findWindow(QWindow *w) const override;
|
2019-01-20 13:04:13 +00:00
|
|
|
EffectWindow *findWindow(const QUuid &id) const override;
|
2014-02-27 10:57:59 +00:00
|
|
|
EffectWindowList stackingOrder() const override;
|
2015-03-28 23:13:41 +00:00
|
|
|
void setElevatedWindow(KWin::EffectWindow* w, bool set) override;
|
2014-02-27 10:57:59 +00:00
|
|
|
|
|
|
|
|
void setTabBoxWindow(EffectWindow*) override;
|
|
|
|
|
void setTabBoxDesktop(int) override;
|
|
|
|
|
EffectWindowList currentTabBoxWindowList() const override;
|
|
|
|
|
void refTabBox() override;
|
|
|
|
|
void unrefTabBox() override;
|
|
|
|
|
void closeTabBox() override;
|
|
|
|
|
QList< int > currentTabBoxDesktopList() const override;
|
|
|
|
|
int currentTabBoxDesktop() const override;
|
|
|
|
|
EffectWindow* currentTabBoxWindow() const override;
|
|
|
|
|
|
|
|
|
|
void setActiveFullScreenEffect(Effect* e) override;
|
|
|
|
|
Effect* activeFullScreenEffect() const override;
|
2018-10-03 00:11:59 +00:00
|
|
|
bool hasActiveFullScreenEffect() const override;
|
2014-02-27 10:57:59 +00:00
|
|
|
|
|
|
|
|
void addRepaintFull() override;
|
|
|
|
|
void addRepaint(const QRect& r) override;
|
|
|
|
|
void addRepaint(const QRegion& r) override;
|
|
|
|
|
void addRepaint(int x, int y, int w, int h) override;
|
|
|
|
|
int activeScreen() const override;
|
|
|
|
|
int numScreens() const override;
|
|
|
|
|
int screenNumber(const QPoint& pos) const override;
|
|
|
|
|
QRect clientArea(clientAreaOption, int screen, int desktop) const override;
|
|
|
|
|
QRect clientArea(clientAreaOption, const EffectWindow* c) const override;
|
|
|
|
|
QRect clientArea(clientAreaOption, const QPoint& p, int desktop) const override;
|
2014-02-27 08:55:45 +00:00
|
|
|
QSize virtualScreenSize() const override;
|
|
|
|
|
QRect virtualScreenGeometry() const override;
|
2014-02-27 10:57:59 +00:00
|
|
|
double animationTimeFactor() const override;
|
|
|
|
|
|
|
|
|
|
void defineCursor(Qt::CursorShape shape) override;
|
2013-06-26 09:40:30 +00:00
|
|
|
bool checkInputWindowEvent(QMouseEvent *e);
|
2016-03-04 13:14:44 +00:00
|
|
|
bool checkInputWindowEvent(QWheelEvent *e);
|
2014-02-27 11:04:15 +00:00
|
|
|
void checkInputWindowStacking();
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 10:57:59 +00:00
|
|
|
void reserveElectricBorder(ElectricBorder border, Effect *effect) override;
|
|
|
|
|
void unreserveElectricBorder(ElectricBorder border, Effect *effect) override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2017-03-31 05:41:21 +00:00
|
|
|
void registerTouchBorder(ElectricBorder border, QAction *action) override;
|
|
|
|
|
void unregisterTouchBorder(ElectricBorder border, QAction *action) override;
|
|
|
|
|
|
2014-02-27 10:57:59 +00:00
|
|
|
QPainter* scenePainter() override;
|
|
|
|
|
void reconfigure() override;
|
|
|
|
|
QByteArray readRootProperty(long atom, long type, int format) const override;
|
|
|
|
|
xcb_atom_t announceSupportProperty(const QByteArray& propertyName, Effect* effect) override;
|
|
|
|
|
void removeSupportProperty(const QByteArray& propertyName, Effect* effect) override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 10:57:59 +00:00
|
|
|
bool hasDecorationShadows() const override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 10:57:59 +00:00
|
|
|
bool decorationsHaveAlpha() const override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 10:57:59 +00:00
|
|
|
bool decorationSupportsBlurBehind() const override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 10:57:59 +00:00
|
|
|
EffectFrame* effectFrame(EffectFrameStyle style, bool staticSize, const QPoint& position, Qt::Alignment alignment) const override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 10:57:59 +00:00
|
|
|
QVariant kwinOption(KWinOption kwopt) override;
|
|
|
|
|
bool isScreenLocked() const override;
|
2011-04-25 15:04:04 +00:00
|
|
|
|
2014-02-27 10:57:59 +00:00
|
|
|
bool makeOpenGLContextCurrent() override;
|
|
|
|
|
void doneOpenGLContextCurrent() override;
|
Better handling for making the compositing OpenGL context current
With QtQuick2 it's possible that the scene graph rendering context either
lives in an own thread or uses the main GUI thread. In the latter case
it's the same thread as our compositing OpenGL context lives in. This
means our basic assumption that between two rendering passes the context
stays current does not hold.
The code already ensured that before we start a rendering pass the
context is made current, but there are many more possible cases. If we
use OpenGL in areas not triggered by the rendering loop but in response
to other events the context needs to be made current. This includes the
loading and unloading of effects (some effects use OpenGL in the static
effect check, in the ctor and dtor), background loading of texture data,
lazy loading after first usage invoked by shortcut, etc. etc.
To properly handle these cases new methods are added to EffectsHandler
to make the compositing OpenGL context current. These calls delegate down
into the scene. On non-OpenGL scenes they are noop, but on OpenGL they go
into the backend and make the context current. In addition they ensure
that Qt doesn't think that it's QOpenGLContext is current by calling
doneCurrent() on the QOpenGLContext::currentContext(). This unfortunately
causes an additional call to makeCurrent with a null context, but there
is no other way to tell Qt - it doesn't notice when a different context
is made current with low level API calls. In the multi-threaded
architecture this doesn't matter as ::currentContext() returns null.
A short evaluation showed that a transition to QOpenGLContext doesn't
seem feasible. Qt only supports either GLX or EGL while KWin supports
both and when entering the transition phase for Wayland, it would become
extremely tricky if our native platform is X11, but we want a Wayland
EGL context. A future solution might be to have a "KWin-QPA plugin" which
uses either xcb or Wayland and hides everything from Qt.
The API documentation is extended to describe when the effects-framework
ensures that an OpenGL context is current. The effects are changed to
make the context current in cases where it's not guaranteed. This has
been done by looking for creation or deletion of GLTextures and Shaders.
If there are other OpenGL usages outside the rendering loop, ctor/dtor
this needs to be changed, too.
2013-11-22 14:05:36 +00:00
|
|
|
|
2014-04-16 13:58:06 +00:00
|
|
|
xcb_connection_t *xcbConnection() const override;
|
|
|
|
|
xcb_window_t x11RootWindow() const override;
|
|
|
|
|
|
2011-01-30 14:34:42 +00:00
|
|
|
// internal (used by kwin core or compositing code)
|
|
|
|
|
void startPaint();
|
|
|
|
|
void grabbedKeyboardEvent(QKeyEvent* e);
|
|
|
|
|
bool hasKeyboardGrab() const;
|
2011-11-26 15:15:46 +00:00
|
|
|
void desktopResized(const QSize &size);
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 10:57:59 +00:00
|
|
|
void reloadEffect(Effect *effect) override;
|
2011-01-30 14:34:42 +00:00
|
|
|
QStringList loadedEffects() const;
|
|
|
|
|
QStringList listOfEffects() const;
|
2015-11-12 10:29:56 +00:00
|
|
|
void unloadAllEffects();
|
2011-01-30 14:34:42 +00:00
|
|
|
|
|
|
|
|
QList<EffectWindow*> elevatedWindows() const;
|
2011-12-29 22:33:45 +00:00
|
|
|
QStringList activeEffects() const;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2021-02-02 13:26:43 +00:00
|
|
|
/**
|
|
|
|
|
* @returns whether or not any effect is currently active where KWin should not use direct scanout
|
|
|
|
|
*/
|
|
|
|
|
bool blocksDirectScanout() const;
|
|
|
|
|
|
2012-03-29 18:12:34 +00:00
|
|
|
/**
|
|
|
|
|
* @returns Whether we are currently in a desktop rendering process triggered by paintDesktop hook
|
2019-07-29 18:58:33 +00:00
|
|
|
*/
|
2012-03-29 18:12:34 +00:00
|
|
|
bool isDesktopRendering() const {
|
|
|
|
|
return m_desktopRendering;
|
|
|
|
|
}
|
|
|
|
|
/**
|
|
|
|
|
* @returns the desktop currently being rendered in the paintDesktop hook.
|
2019-07-29 18:58:33 +00:00
|
|
|
*/
|
2012-03-29 18:12:34 +00:00
|
|
|
int currentRenderedDesktop() const {
|
|
|
|
|
return m_currentRenderedDesktop;
|
|
|
|
|
}
|
|
|
|
|
|
2020-04-29 15:18:41 +00:00
|
|
|
KWaylandServer::Display *waylandDisplay() const override;
|
2015-08-31 13:47:01 +00:00
|
|
|
|
2016-08-10 07:24:53 +00:00
|
|
|
bool animationsSupported() const override;
|
|
|
|
|
|
2016-10-17 14:12:21 +00:00
|
|
|
PlatformCursorImage cursorImage() const override;
|
|
|
|
|
|
2016-10-20 08:25:37 +00:00
|
|
|
void hideCursor() override;
|
|
|
|
|
void showCursor() override;
|
|
|
|
|
|
2016-11-15 14:40:30 +00:00
|
|
|
void startInteractiveWindowSelection(std::function<void(KWin::EffectWindow*)> callback) override;
|
2016-11-23 14:53:17 +00:00
|
|
|
void startInteractivePositionSelection(std::function<void(const QPoint &)> callback) override;
|
2016-11-15 14:40:30 +00:00
|
|
|
|
2016-12-23 16:39:12 +00:00
|
|
|
void showOnScreenMessage(const QString &message, const QString &iconName = QString()) override;
|
2017-01-11 19:14:36 +00:00
|
|
|
void hideOnScreenMessage(OnScreenMessageHideFlags flags = OnScreenMessageHideFlags()) override;
|
2016-12-23 16:39:12 +00:00
|
|
|
|
2016-12-02 19:27:43 +00:00
|
|
|
KSharedConfigPtr config() const override;
|
2017-04-19 15:00:02 +00:00
|
|
|
KSharedConfigPtr inputConfig() const override;
|
2016-12-02 19:27:43 +00:00
|
|
|
|
2015-12-03 08:50:40 +00:00
|
|
|
Scene *scene() const {
|
|
|
|
|
return m_scene;
|
|
|
|
|
}
|
|
|
|
|
|
2019-08-11 19:57:45 +00:00
|
|
|
bool touchDown(qint32 id, const QPointF &pos, quint32 time);
|
|
|
|
|
bool touchMotion(qint32 id, const QPointF &pos, quint32 time);
|
|
|
|
|
bool touchUp(qint32 id, quint32 time);
|
2016-08-15 13:44:10 +00:00
|
|
|
|
2016-08-30 13:50:31 +00:00
|
|
|
void highlightWindows(const QVector<EffectWindow *> &windows);
|
|
|
|
|
|
2017-09-16 17:25:33 +00:00
|
|
|
bool isPropertyTypeRegistered(xcb_atom_t atom) const {
|
|
|
|
|
return registered_atoms.contains(atom);
|
|
|
|
|
}
|
|
|
|
|
|
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
|
|
|
void windowToDesktops(EffectWindow *w, const QVector<uint> &desktops) override;
|
2018-11-13 16:18:46 +00:00
|
|
|
|
2018-12-01 16:23:37 +00:00
|
|
|
/**
|
|
|
|
|
* Finds an effect with the given name.
|
|
|
|
|
*
|
|
|
|
|
* @param name The name of the effect.
|
|
|
|
|
* @returns The effect with the given name @p name, or nullptr if there
|
|
|
|
|
* is no such effect loaded.
|
2019-07-29 18:58:33 +00:00
|
|
|
*/
|
2018-12-01 16:23:37 +00:00
|
|
|
Effect *findEffect(const QString &name) const;
|
|
|
|
|
|
[libkwineffects] Introduce API to easily show a QtQuick scene in an effect
Summary:
EffectQuickView/Scene is a convenient class to render a QtQuick
scenegraph into an effect.
Current methods (such as present windows) involve creating an underlying
platform window which is expensive, causes a headache to filter out
again in the rest of the code, and only works as an overlay.
The new class exposes things more natively to an effect where we don't
mess with real windows, we can perform the painting anywhere in the view
and we don't have issues with hiding/closing.
QtQuick has both software and hardware accelerated modes, and kwin also
has 3 render backends. Every combination is supported.
* When used in OpenGL mode for both, we render into an FBO export the
texture ID then it's up to the effect to render that into a scene.
* When using software QtQuick rendering we blit into an image, upload
that into a KWinGLTexture which serves as an abstraction layer and
render that into the scene.
* When using GL for QtQuick and XRender/QPainter in kwin everything is
rendered into the internal FBO, blit and exported as an image.
* When using software rendering for both an image gets passed directly.
Mouse and keyboard events can be forwarded, only if the effect
intercepts them.
The class is meant to be generic enough that we can remove all the
QtQuick code from Aurorae.
The intention is also to replace EffectFrameImpl using this backend and
we can kill all of the EffectFrame code throughout the scenes.
The close button in present windows will also be ported to this,
simplifiying that code base.
Classes that handle the rendering and handling QML are intentionally
split so that in the future we can have a declarative effects API create
overlays from within the same context. Similar to how one can
instantiate windows from a typical QML scene.
Notes:
I don't like how I pass the kwin GL context from the backends into the
effect, but I need something that works with the library separation. It
also currently has wayland problem if I create a QOpenGLContext before
the QPA is set up with a scene - but I don't have anything better?
I know for the EffectFrame we need an API to push things through the
effects stack to handle blur/invert etc. Will deal with that when we
port the EffectFrame.
Test Plan: Used in an effect
Reviewers: #kwin, zzag
Reviewed By: #kwin, zzag
Subscribers: zzag, kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D24215
2019-09-27 15:06:37 +00:00
|
|
|
void renderEffectQuickView(EffectQuickView *effectQuickView) const override;
|
|
|
|
|
|
2019-11-01 17:14:55 +00:00
|
|
|
SessionState sessionState() const override;
|
2021-03-01 09:45:52 +00:00
|
|
|
QList<EffectScreen *> screens() const override;
|
|
|
|
|
EffectScreen *screenAt(const QPoint &point) const override;
|
|
|
|
|
EffectScreen *findScreen(const QString &name) const override;
|
|
|
|
|
EffectScreen *findScreen(int screenId) const override;
|
2019-11-01 17:14:55 +00:00
|
|
|
|
2011-02-28 20:03:13 +00:00
|
|
|
public Q_SLOTS:
|
2012-01-12 06:42:55 +00:00
|
|
|
void slotCurrentTabAboutToChange(EffectWindow* from, EffectWindow* to);
|
|
|
|
|
void slotTabAdded(EffectWindow* from, EffectWindow* to);
|
|
|
|
|
void slotTabRemoved(EffectWindow* c, EffectWindow* newActiveWindow);
|
2011-02-28 20:03:13 +00:00
|
|
|
|
2012-08-30 06:20:26 +00:00
|
|
|
// slots for D-Bus interface
|
|
|
|
|
Q_SCRIPTABLE void reconfigureEffect(const QString& name);
|
2014-03-25 12:43:56 +00:00
|
|
|
Q_SCRIPTABLE bool loadEffect(const QString& name);
|
2012-08-30 06:20:26 +00:00
|
|
|
Q_SCRIPTABLE void toggleEffect(const QString& name);
|
|
|
|
|
Q_SCRIPTABLE void unloadEffect(const QString& name);
|
|
|
|
|
Q_SCRIPTABLE bool isEffectLoaded(const QString& name) const;
|
2014-03-09 08:12:09 +00:00
|
|
|
Q_SCRIPTABLE bool isEffectSupported(const QString& name);
|
|
|
|
|
Q_SCRIPTABLE QList<bool> areEffectsSupported(const QStringList &names);
|
2012-08-30 06:20:26 +00:00
|
|
|
Q_SCRIPTABLE QString supportInformation(const QString& name) const;
|
2012-10-27 21:35:19 +00:00
|
|
|
Q_SCRIPTABLE QString debug(const QString& name, const QString& parameter = QString()) const;
|
2012-08-30 06:20:26 +00:00
|
|
|
|
2011-02-25 19:41:10 +00:00
|
|
|
protected Q_SLOTS:
|
2012-01-24 16:00:40 +00:00
|
|
|
void slotClientShown(KWin::Toplevel*);
|
2013-06-28 12:23:22 +00:00
|
|
|
void slotUnmanagedShown(KWin::Toplevel*);
|
2015-11-09 15:27:15 +00:00
|
|
|
void slotWindowClosed(KWin::Toplevel *c, KWin::Deleted *d);
|
2015-06-07 01:17:34 +00:00
|
|
|
void slotClientMaximized(KWin::AbstractClient *c, MaximizeMode maxMode);
|
2011-03-06 09:30:23 +00:00
|
|
|
void slotOpacityChanged(KWin::Toplevel *t, qreal oldOpacity);
|
2013-06-19 14:26:55 +00:00
|
|
|
void slotClientModalityChanged();
|
2011-06-19 20:07:19 +00:00
|
|
|
void slotGeometryShapeChanged(KWin::Toplevel *t, const QRect &old);
|
2020-02-11 17:03:23 +00:00
|
|
|
void slotFrameGeometryChanged(Toplevel *toplevel, const QRect &oldGeometry);
|
2020-09-22 00:13:11 +00:00
|
|
|
void slotWindowDamaged(KWin::Toplevel *t, const QRegion& r);
|
2021-03-01 09:45:52 +00:00
|
|
|
void slotOutputEnabled(AbstractOutput *output);
|
|
|
|
|
void slotOutputDisabled(AbstractOutput *output);
|
2011-02-25 19:41:10 +00:00
|
|
|
|
2011-01-30 14:34:42 +00:00
|
|
|
protected:
|
2015-02-07 16:12:53 +00:00
|
|
|
void connectNotify(const QMetaMethod &signal) override;
|
|
|
|
|
void disconnectNotify(const QMetaMethod &signal) override;
|
2011-01-30 14:34:42 +00:00
|
|
|
void effectsChanged();
|
2020-05-08 07:07:20 +00:00
|
|
|
void setupClientConnections(KWin::AbstractClient *client);
|
2011-03-06 10:13:11 +00:00
|
|
|
void setupUnmanagedConnections(KWin::Unmanaged *u);
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2017-09-23 18:21:26 +00:00
|
|
|
/**
|
|
|
|
|
* Default implementation does nothing and returns @c true.
|
2019-07-29 18:58:33 +00:00
|
|
|
*/
|
2017-09-23 18:21:26 +00:00
|
|
|
virtual bool doGrabKeyboard();
|
|
|
|
|
/**
|
|
|
|
|
* Default implementation does nothing.
|
2019-07-29 18:58:33 +00:00
|
|
|
*/
|
2017-09-23 18:21:26 +00:00
|
|
|
virtual void doUngrabKeyboard();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Default implementation sets Effects override cursor on the PointerInputRedirection.
|
2019-07-29 18:58:33 +00:00
|
|
|
*/
|
2017-09-23 18:21:26 +00:00
|
|
|
virtual void doStartMouseInterception(Qt::CursorShape shape);
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Default implementation removes the Effects override cursor on the PointerInputRedirection.
|
2019-07-29 18:58:33 +00:00
|
|
|
*/
|
2017-09-23 18:21:26 +00:00
|
|
|
virtual void doStopMouseInterception();
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Default implementation does nothing
|
2019-07-29 18:58:33 +00:00
|
|
|
*/
|
2017-09-23 18:21:26 +00:00
|
|
|
virtual void doCheckInputWindowStacking();
|
|
|
|
|
|
2011-01-30 14:34:42 +00:00
|
|
|
Effect* keyboard_grab_effect;
|
|
|
|
|
Effect* fullscreen_effect;
|
|
|
|
|
QList<EffectWindow*> elevated_windows;
|
|
|
|
|
QMultiMap< int, EffectPair > effect_order;
|
|
|
|
|
QHash< long, int > registered_atoms;
|
2011-08-27 09:21:31 +00:00
|
|
|
|
|
|
|
|
private:
|
2016-11-07 14:57:00 +00:00
|
|
|
void registerPropertyType(long atom, bool reg);
|
2018-12-19 14:44:06 +00:00
|
|
|
void destroyEffect(Effect *effect);
|
|
|
|
|
|
2013-07-19 09:46:42 +00:00
|
|
|
typedef QVector< Effect*> EffectsList;
|
2013-07-19 09:34:01 +00:00
|
|
|
typedef EffectsList::const_iterator EffectsIterator;
|
2013-07-19 09:46:42 +00:00
|
|
|
EffectsList m_activeEffects;
|
2013-07-19 09:34:01 +00:00
|
|
|
EffectsIterator m_currentDrawWindowIterator;
|
|
|
|
|
EffectsIterator m_currentPaintWindowIterator;
|
|
|
|
|
EffectsIterator m_currentPaintEffectFrameIterator;
|
|
|
|
|
EffectsIterator m_currentPaintScreenIterator;
|
2012-12-13 23:09:47 +00:00
|
|
|
typedef QHash< QByteArray, QList< Effect*> > PropertyEffectMap;
|
|
|
|
|
PropertyEffectMap m_propertiesForEffects;
|
|
|
|
|
QHash<QByteArray, qulonglong> m_managedProperties;
|
2012-08-23 16:04:36 +00:00
|
|
|
Compositor *m_compositor;
|
2012-08-16 19:19:54 +00:00
|
|
|
Scene *m_scene;
|
2012-03-29 18:12:34 +00:00
|
|
|
bool m_desktopRendering;
|
|
|
|
|
int m_currentRenderedDesktop;
|
2013-04-24 14:51:04 +00:00
|
|
|
QList<Effect*> m_grabbedMouseEffects;
|
2014-01-24 14:42:40 +00:00
|
|
|
EffectLoader *m_effectLoader;
|
2015-02-07 16:12:53 +00:00
|
|
|
int m_trackingCursorChanges;
|
2017-09-16 17:25:33 +00:00
|
|
|
std::unique_ptr<WindowPropertyNotifyX11Filter> m_x11WindowPropertyNotify;
|
2021-03-01 09:45:52 +00:00
|
|
|
QList<EffectScreen *> m_effectScreens;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
class EffectScreenImpl : public EffectScreen
|
|
|
|
|
{
|
|
|
|
|
Q_OBJECT
|
|
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
explicit EffectScreenImpl(AbstractOutput *output, QObject *parent = nullptr);
|
|
|
|
|
|
|
|
|
|
AbstractOutput *platformOutput() const;
|
|
|
|
|
|
|
|
|
|
QString name() const override;
|
|
|
|
|
qreal devicePixelRatio() const override;
|
|
|
|
|
QRect geometry() const override;
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
AbstractOutput *m_platformOutput;
|
2007-04-29 17:35:43 +00:00
|
|
|
};
|
|
|
|
|
|
2011-12-29 09:31:37 +00:00
|
|
|
class EffectWindowImpl : public EffectWindow
|
2007-04-29 17:35:43 +00:00
|
|
|
{
|
2011-11-10 13:28:06 +00:00
|
|
|
Q_OBJECT
|
2011-01-30 14:34:42 +00:00
|
|
|
public:
|
2012-12-29 06:34:38 +00:00
|
|
|
explicit EffectWindowImpl(Toplevel *toplevel);
|
2018-11-30 09:58:45 +00:00
|
|
|
~EffectWindowImpl() override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 11:07:41 +00:00
|
|
|
void enablePainting(int reason) override;
|
|
|
|
|
void disablePainting(int reason) override;
|
|
|
|
|
bool isPaintingEnabled() override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2019-01-07 16:29:00 +00:00
|
|
|
void addRepaint(const QRect &r) override;
|
|
|
|
|
void addRepaint(int x, int y, int w, int h) override;
|
|
|
|
|
void addRepaintFull() override;
|
|
|
|
|
void addLayerRepaint(const QRect &r) override;
|
|
|
|
|
void addLayerRepaint(int x, int y, int w, int h) override;
|
|
|
|
|
|
2014-02-27 11:07:41 +00:00
|
|
|
void refWindow() override;
|
|
|
|
|
void unrefWindow() override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 11:07:41 +00:00
|
|
|
const EffectWindowGroup* group() const override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2018-11-30 09:58:45 +00:00
|
|
|
bool isDeleted() const override;
|
|
|
|
|
bool isMinimized() const override;
|
|
|
|
|
double opacity() const override;
|
|
|
|
|
bool hasAlpha() const override;
|
|
|
|
|
|
|
|
|
|
QStringList activities() const override;
|
|
|
|
|
int desktop() const override;
|
|
|
|
|
QVector<uint> desktops() const override;
|
|
|
|
|
int x() const override;
|
|
|
|
|
int y() const override;
|
|
|
|
|
int width() const override;
|
|
|
|
|
int height() const override;
|
|
|
|
|
|
|
|
|
|
QSize basicUnit() const override;
|
|
|
|
|
QRect geometry() const override;
|
2019-09-28 15:09:12 +00:00
|
|
|
QRect frameGeometry() const override;
|
|
|
|
|
QRect bufferGeometry() const override;
|
2021-05-28 08:05:28 +00:00
|
|
|
QRect clientGeometry() const override;
|
2018-11-30 09:58:45 +00:00
|
|
|
|
|
|
|
|
QString caption() const override;
|
|
|
|
|
|
|
|
|
|
QRect expandedGeometry() const override;
|
2014-02-27 11:07:41 +00:00
|
|
|
QRegion shape() const override;
|
2018-11-30 09:58:45 +00:00
|
|
|
int screen() const override;
|
|
|
|
|
bool hasOwnShape() const override; // only for shadow effect, for now
|
|
|
|
|
QPoint pos() const override;
|
|
|
|
|
QSize size() const override;
|
|
|
|
|
QRect rect() const override;
|
|
|
|
|
|
|
|
|
|
bool isMovable() const override;
|
|
|
|
|
bool isMovableAcrossScreens() const override;
|
|
|
|
|
bool isUserMove() const override;
|
|
|
|
|
bool isUserResize() const override;
|
|
|
|
|
QRect iconGeometry() const override;
|
|
|
|
|
|
|
|
|
|
bool isDesktop() const override;
|
|
|
|
|
bool isDock() const override;
|
|
|
|
|
bool isToolbar() const override;
|
|
|
|
|
bool isMenu() const override;
|
|
|
|
|
bool isNormalWindow() const override;
|
|
|
|
|
bool isSpecialWindow() const override;
|
|
|
|
|
bool isDialog() const override;
|
|
|
|
|
bool isSplash() const override;
|
|
|
|
|
bool isUtility() const override;
|
|
|
|
|
bool isDropdownMenu() const override;
|
|
|
|
|
bool isPopupMenu() const override;
|
|
|
|
|
bool isTooltip() const override;
|
|
|
|
|
bool isNotification() const override;
|
2019-05-02 08:29:38 +00:00
|
|
|
bool isCriticalNotification() const override;
|
2018-11-30 09:58:45 +00:00
|
|
|
bool isOnScreenDisplay() const override;
|
|
|
|
|
bool isComboBox() const override;
|
|
|
|
|
bool isDNDIcon() const override;
|
|
|
|
|
bool skipsCloseAnimation() const override;
|
|
|
|
|
|
|
|
|
|
bool acceptsFocus() const override;
|
|
|
|
|
bool keepAbove() const override;
|
|
|
|
|
bool keepBelow() const override;
|
|
|
|
|
bool isModal() const override;
|
|
|
|
|
bool isPopupWindow() const override;
|
2019-03-19 14:01:29 +00:00
|
|
|
bool isOutline() const override;
|
2021-05-12 18:56:16 +00:00
|
|
|
bool isLockScreen() const override;
|
2018-11-30 09:58:45 +00:00
|
|
|
|
2020-04-29 15:18:41 +00:00
|
|
|
KWaylandServer::SurfaceInterface *surface() const override;
|
2018-11-30 09:58:45 +00:00
|
|
|
bool isFullScreen() const override;
|
|
|
|
|
bool isUnresponsive() const override;
|
|
|
|
|
|
|
|
|
|
QRect contentsRect() const override;
|
|
|
|
|
bool decorationHasAlpha() const override;
|
|
|
|
|
QIcon icon() const override;
|
|
|
|
|
QString windowClass() const override;
|
|
|
|
|
NET::WindowType windowType() const override;
|
|
|
|
|
bool isSkipSwitcher() const override;
|
|
|
|
|
bool isCurrentTab() const override;
|
|
|
|
|
QString windowRole() const override;
|
|
|
|
|
|
|
|
|
|
bool isManaged() const override;
|
|
|
|
|
bool isWaylandClient() const override;
|
|
|
|
|
bool isX11Client() const override;
|
|
|
|
|
|
2019-09-26 12:54:33 +00:00
|
|
|
pid_t pid() const override;
|
2020-11-01 14:25:15 +00:00
|
|
|
qlonglong windowId() const override;
|
2019-09-26 12:54:33 +00:00
|
|
|
|
2014-02-27 11:07:41 +00:00
|
|
|
QRect decorationInnerRect() const override;
|
|
|
|
|
QByteArray readProperty(long atom, long type, int format) const override;
|
|
|
|
|
void deleteProperty(long atom) const override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 11:07:41 +00:00
|
|
|
EffectWindow* findModal() override;
|
2020-08-02 10:25:28 +00:00
|
|
|
EffectWindow* transientFor() override;
|
2014-02-27 11:07:41 +00:00
|
|
|
EffectWindowList mainWindows() const override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2021-05-21 09:30:02 +00:00
|
|
|
WindowQuadList buildQuads() const override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2019-01-07 16:29:00 +00:00
|
|
|
void minimize() override;
|
|
|
|
|
void unminimize() override;
|
|
|
|
|
void closeWindow() override;
|
|
|
|
|
|
2014-02-27 11:07:41 +00:00
|
|
|
void referencePreviousWindowPixmap() override;
|
|
|
|
|
void unreferencePreviousWindowPixmap() override;
|
2013-05-13 06:17:28 +00:00
|
|
|
|
2019-01-13 16:50:32 +00:00
|
|
|
QWindow *internalWindow() const override;
|
|
|
|
|
|
2011-01-30 14:34:42 +00:00
|
|
|
const Toplevel* window() const;
|
|
|
|
|
Toplevel* window();
|
|
|
|
|
|
|
|
|
|
void setWindow(Toplevel* w); // internal
|
|
|
|
|
void setSceneWindow(Scene::Window* w); // internal
|
|
|
|
|
const Scene::Window* sceneWindow() const; // internal
|
|
|
|
|
Scene::Window* sceneWindow(); // internal
|
|
|
|
|
|
2013-04-24 08:46:34 +00:00
|
|
|
void elevate(bool elevate);
|
|
|
|
|
|
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
|
|
|
void setData(int role, const QVariant &data) override;
|
|
|
|
|
QVariant data(int role) const override;
|
2011-11-10 13:28:06 +00:00
|
|
|
|
2012-03-29 13:32:41 +00:00
|
|
|
void registerThumbnail(AbstractThumbnailItem *item);
|
2019-08-10 11:31:49 +00:00
|
|
|
QHash<WindowThumbnailItem*, QPointer<EffectWindowImpl> > const &thumbnails() const {
|
2011-11-10 13:28:06 +00:00
|
|
|
return m_thumbnails;
|
|
|
|
|
}
|
2012-03-29 18:17:57 +00:00
|
|
|
QList<DesktopThumbnailItem*> const &desktopThumbnails() const {
|
|
|
|
|
return m_desktopThumbnails;
|
|
|
|
|
}
|
2018-11-30 09:58:45 +00:00
|
|
|
|
2011-11-10 13:28:06 +00:00
|
|
|
private Q_SLOTS:
|
|
|
|
|
void thumbnailDestroyed(QObject *object);
|
|
|
|
|
void thumbnailTargetChanged();
|
2012-03-29 18:17:57 +00:00
|
|
|
void desktopThumbnailDestroyed(QObject *object);
|
2011-01-30 14:34:42 +00:00
|
|
|
private:
|
2012-03-29 13:46:53 +00:00
|
|
|
void insertThumbnail(WindowThumbnailItem *item);
|
2011-01-30 14:34:42 +00:00
|
|
|
Toplevel* toplevel;
|
|
|
|
|
Scene::Window* sw; // This one is used only during paint pass.
|
|
|
|
|
QHash<int, QVariant> dataMap;
|
2019-08-10 11:31:49 +00:00
|
|
|
QHash<WindowThumbnailItem*, QPointer<EffectWindowImpl> > m_thumbnails;
|
2012-03-29 18:17:57 +00:00
|
|
|
QList<DesktopThumbnailItem*> m_desktopThumbnails;
|
2018-11-30 09:58:45 +00:00
|
|
|
bool managed = false;
|
|
|
|
|
bool waylandClient;
|
|
|
|
|
bool x11Client;
|
2007-04-29 17:35:43 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
class EffectWindowGroupImpl
|
|
|
|
|
: public EffectWindowGroup
|
2011-01-30 14:34:42 +00:00
|
|
|
{
|
|
|
|
|
public:
|
2012-12-29 06:34:38 +00:00
|
|
|
explicit EffectWindowGroupImpl(Group* g);
|
2014-02-27 11:07:41 +00:00
|
|
|
EffectWindowList members() const override;
|
2011-01-30 14:34:42 +00:00
|
|
|
private:
|
|
|
|
|
Group* group;
|
|
|
|
|
};
|
2007-04-29 17:35:43 +00:00
|
|
|
|
2017-08-10 16:13:42 +00:00
|
|
|
class KWIN_EXPORT EffectFrameImpl
|
2010-07-18 16:32:37 +00:00
|
|
|
: public QObject, public EffectFrame
|
2011-01-30 14:34:42 +00:00
|
|
|
{
|
2010-07-18 16:32:37 +00:00
|
|
|
Q_OBJECT
|
2011-01-30 14:34:42 +00:00
|
|
|
public:
|
|
|
|
|
explicit EffectFrameImpl(EffectFrameStyle style, bool staticSize = true, QPoint position = QPoint(-1, -1),
|
|
|
|
|
Qt::Alignment alignment = Qt::AlignCenter);
|
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
|
|
|
~EffectFrameImpl() override;
|
2011-01-30 14:34:42 +00:00
|
|
|
|
2014-02-27 11:10:18 +00:00
|
|
|
void free() override;
|
2019-10-29 22:04:15 +00:00
|
|
|
void render(const QRegion ®ion = infiniteRegion(), double opacity = 1.0, double frameOpacity = 1.0) override;
|
2014-02-27 11:10:18 +00:00
|
|
|
Qt::Alignment alignment() const override;
|
|
|
|
|
void setAlignment(Qt::Alignment alignment) override;
|
|
|
|
|
const QFont& font() const override;
|
|
|
|
|
void setFont(const QFont& font) override;
|
|
|
|
|
const QRect& geometry() const override;
|
|
|
|
|
void setGeometry(const QRect& geometry, bool force = false) override;
|
|
|
|
|
const QIcon& icon() const override;
|
|
|
|
|
void setIcon(const QIcon& icon) override;
|
|
|
|
|
const QSize& iconSize() const override;
|
|
|
|
|
void setIconSize(const QSize& size) override;
|
|
|
|
|
void setPosition(const QPoint& point) override;
|
|
|
|
|
const QString& text() const override;
|
|
|
|
|
void setText(const QString& text) override;
|
|
|
|
|
EffectFrameStyle style() const override {
|
2011-01-30 14:34:42 +00:00
|
|
|
return m_style;
|
|
|
|
|
};
|
|
|
|
|
Plasma::FrameSvg& frame() {
|
|
|
|
|
return m_frame;
|
|
|
|
|
}
|
|
|
|
|
bool isStatic() const {
|
|
|
|
|
return m_static;
|
2010-07-18 16:32:37 +00:00
|
|
|
};
|
2011-01-30 14:34:42 +00:00
|
|
|
void finalRender(QRegion region, double opacity, double frameOpacity) const;
|
2014-02-27 11:10:18 +00:00
|
|
|
void setShader(GLShader* shader) override {
|
2011-01-30 14:34:42 +00:00
|
|
|
m_shader = shader;
|
|
|
|
|
}
|
2014-02-27 11:10:18 +00:00
|
|
|
GLShader* shader() const override {
|
2011-01-30 14:34:42 +00:00
|
|
|
return m_shader;
|
|
|
|
|
}
|
2014-02-27 11:10:18 +00:00
|
|
|
void setSelection(const QRect& selection) override;
|
2011-01-30 14:34:42 +00:00
|
|
|
const QRect& selection() const {
|
|
|
|
|
return m_selectionGeometry;
|
|
|
|
|
}
|
|
|
|
|
Plasma::FrameSvg& selectionFrame() {
|
|
|
|
|
return m_selection;
|
|
|
|
|
}
|
2011-02-17 18:35:08 +00:00
|
|
|
/**
|
|
|
|
|
* The foreground text color as specified by the default Plasma theme.
|
2019-07-29 18:58:33 +00:00
|
|
|
*/
|
2013-07-22 14:10:47 +00:00
|
|
|
QColor styledTextColor();
|
2011-01-30 14:34:42 +00:00
|
|
|
|
|
|
|
|
private Q_SLOTS:
|
|
|
|
|
void plasmaThemeChanged();
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
Q_DISABLE_COPY(EffectFrameImpl) // As we need to use Qt slots we cannot copy this class
|
|
|
|
|
void align(QRect &geometry); // positions geometry around m_point respecting m_alignment
|
|
|
|
|
void autoResize(); // Auto-resize if not a static size
|
|
|
|
|
|
|
|
|
|
EffectFrameStyle m_style;
|
|
|
|
|
Plasma::FrameSvg m_frame; // TODO: share between all EffectFrames
|
|
|
|
|
Plasma::FrameSvg m_selection;
|
|
|
|
|
|
|
|
|
|
// Position
|
|
|
|
|
bool m_static;
|
|
|
|
|
QPoint m_point;
|
|
|
|
|
Qt::Alignment m_alignment;
|
|
|
|
|
QRect m_geometry;
|
|
|
|
|
|
|
|
|
|
// Contents
|
|
|
|
|
QString m_text;
|
|
|
|
|
QFont m_font;
|
2013-12-06 13:41:23 +00:00
|
|
|
QIcon m_icon;
|
2011-01-30 14:34:42 +00:00
|
|
|
QSize m_iconSize;
|
|
|
|
|
QRect m_selectionGeometry;
|
|
|
|
|
|
|
|
|
|
Scene::EffectFrame* m_sceneFrame;
|
|
|
|
|
GLShader* m_shader;
|
2013-07-22 14:10:47 +00:00
|
|
|
|
|
|
|
|
Plasma::Theme *m_theme;
|
2011-01-30 14:34:42 +00:00
|
|
|
};
|
2007-05-24 14:41:56 +00:00
|
|
|
|
|
|
|
|
inline
|
2008-01-13 13:00:15 +00:00
|
|
|
QList<EffectWindow*> EffectsHandlerImpl::elevatedWindows() const
|
2011-01-30 14:34:42 +00:00
|
|
|
{
|
2015-05-10 09:15:16 +00:00
|
|
|
if (isScreenLocked())
|
|
|
|
|
return QList<EffectWindow*>();
|
2007-05-24 14:41:56 +00:00
|
|
|
return elevated_windows;
|
2011-01-30 14:34:42 +00:00
|
|
|
}
|
2007-05-24 14:41:56 +00:00
|
|
|
|
2014-04-16 13:58:06 +00:00
|
|
|
inline
|
|
|
|
|
xcb_window_t EffectsHandlerImpl::x11RootWindow() const
|
|
|
|
|
{
|
|
|
|
|
return rootWindow();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
inline
|
|
|
|
|
xcb_connection_t *EffectsHandlerImpl::xcbConnection() const
|
|
|
|
|
{
|
|
|
|
|
return connection();
|
|
|
|
|
}
|
2007-05-24 14:41:56 +00:00
|
|
|
|
2007-04-29 17:35:43 +00:00
|
|
|
inline
|
2011-01-30 14:34:42 +00:00
|
|
|
EffectWindowGroupImpl::EffectWindowGroupImpl(Group* g)
|
|
|
|
|
: group(g)
|
|
|
|
|
{
|
|
|
|
|
}
|
2007-04-29 17:35:43 +00:00
|
|
|
|
2011-01-30 14:34:42 +00:00
|
|
|
EffectWindow* effectWindow(Toplevel* w);
|
|
|
|
|
EffectWindow* effectWindow(Scene::Window* w);
|
2007-04-29 17:35:43 +00:00
|
|
|
|
2007-08-08 14:42:06 +00:00
|
|
|
inline
|
|
|
|
|
const Scene::Window* EffectWindowImpl::sceneWindow() const
|
2011-01-30 14:34:42 +00:00
|
|
|
{
|
2007-08-08 14:42:06 +00:00
|
|
|
return sw;
|
2011-01-30 14:34:42 +00:00
|
|
|
}
|
2007-08-08 14:42:06 +00:00
|
|
|
|
|
|
|
|
inline
|
|
|
|
|
Scene::Window* EffectWindowImpl::sceneWindow()
|
2011-01-30 14:34:42 +00:00
|
|
|
{
|
2007-08-08 14:42:06 +00:00
|
|
|
return sw;
|
2011-01-30 14:34:42 +00:00
|
|
|
}
|
2007-08-08 14:42:06 +00:00
|
|
|
|
|
|
|
|
inline
|
|
|
|
|
const Toplevel* EffectWindowImpl::window() const
|
2011-01-30 14:34:42 +00:00
|
|
|
{
|
2007-08-08 14:42:06 +00:00
|
|
|
return toplevel;
|
2011-01-30 14:34:42 +00:00
|
|
|
}
|
2007-08-08 14:42:06 +00:00
|
|
|
|
|
|
|
|
inline
|
|
|
|
|
Toplevel* EffectWindowImpl::window()
|
2011-01-30 14:34:42 +00:00
|
|
|
{
|
2007-08-08 14:42:06 +00:00
|
|
|
return toplevel;
|
2011-01-30 14:34:42 +00:00
|
|
|
}
|
2007-08-08 14:42:06 +00:00
|
|
|
|
2007-04-29 17:35:43 +00:00
|
|
|
|
|
|
|
|
} // namespace
|
|
|
|
|
|
|
|
|
|
#endif
|
