684b4b635e
Summary:
So far we were following a bit unique and rare doxygen comment style:
/**
* Contents of the comment.
**/
Doxygen comments with this style look balanced and neat, but many people
that contribute to KWin don't follow this style. Instead, they prefer
more traditional doxygen comment style, i.e.
/**
* Contents of the comment.
*/
Reviewing such changes has been a bit frustrating for me (so selfish!)
and for other contributors.
This change switches doxygen comment style in KWin to a more traditional
style. The main reason for doing this is to make code review process easier
for new contributors as well us.
Reviewers: #kwin, davidedmundson
Reviewed By: #kwin, davidedmundson
Subscribers: kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D22812
309 lines
11 KiB
C++
309 lines
11 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright (C) 2015 Martin Gräßlin <mgraesslin@kde.org>
|
|
Copyright (C) 2018 David Edmundson <davidedmundson@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_SHELL_CLIENT_H
|
|
#define KWIN_SHELL_CLIENT_H
|
|
|
|
#include "abstract_client.h"
|
|
#include <KWayland/Server/xdgshell_interface.h>
|
|
|
|
namespace KWayland
|
|
{
|
|
namespace Server
|
|
{
|
|
class ShellSurfaceInterface;
|
|
class ServerSideDecorationInterface;
|
|
class ServerSideDecorationPaletteInterface;
|
|
class AppMenuInterface;
|
|
class PlasmaShellSurfaceInterface;
|
|
class XdgDecorationInterface;
|
|
}
|
|
}
|
|
|
|
namespace KWin
|
|
{
|
|
|
|
/**
|
|
* @brief The reason for which the server pinged a client surface
|
|
*/
|
|
enum class PingReason {
|
|
CloseWindow = 0,
|
|
FocusWindow
|
|
};
|
|
|
|
class KWIN_EXPORT ShellClient : public AbstractClient
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
ShellClient(KWayland::Server::ShellSurfaceInterface *surface);
|
|
ShellClient(KWayland::Server::XdgShellSurfaceInterface *surface);
|
|
ShellClient(KWayland::Server::XdgShellPopupInterface *surface);
|
|
~ShellClient() override;
|
|
|
|
QStringList activities() const override;
|
|
QPoint clientContentPos() const override;
|
|
QSize clientSize() const override;
|
|
QRect transparentRect() const override;
|
|
NET::WindowType windowType(bool direct = false, int supported_types = 0) const override;
|
|
void debug(QDebug &stream) const override;
|
|
double opacity() const override;
|
|
void setOpacity(double opacity) override;
|
|
QByteArray windowRole() const override;
|
|
|
|
void blockActivityUpdates(bool b = true) override;
|
|
QString captionNormal() const override {
|
|
return m_caption;
|
|
}
|
|
QString captionSuffix() const override {
|
|
return m_captionSuffix;
|
|
}
|
|
void closeWindow() override;
|
|
AbstractClient *findModal(bool allow_itself = false) override;
|
|
bool isCloseable() const override;
|
|
bool isFullScreenable() const override;
|
|
bool isFullScreen() const override;
|
|
bool isMaximizable() const override;
|
|
bool isMinimizable() const override;
|
|
bool isMovable() const override;
|
|
bool isMovableAcrossScreens() const override;
|
|
bool isResizable() const override;
|
|
bool isShown(bool shaded_is_shown) const override;
|
|
bool isHiddenInternal() const override {
|
|
return m_unmapped || m_hidden;
|
|
}
|
|
void hideClient(bool hide) override;
|
|
MaximizeMode maximizeMode() const override;
|
|
MaximizeMode requestedMaximizeMode() const override;
|
|
|
|
QRect geometryRestore() const override {
|
|
return m_geomMaximizeRestore;
|
|
}
|
|
bool noBorder() const override;
|
|
void setFullScreen(bool set, bool user = true) override;
|
|
void setNoBorder(bool set) override;
|
|
void updateDecoration(bool check_workspace_pos, bool force = false) override;
|
|
void setOnAllActivities(bool set) override;
|
|
void takeFocus() override;
|
|
bool userCanSetFullScreen() const override;
|
|
bool userCanSetNoBorder() const override;
|
|
bool wantsInput() const override;
|
|
bool dockWantsInput() const override;
|
|
using AbstractClient::resizeWithChecks;
|
|
void resizeWithChecks(int w, int h, ForceGeometry_t force = NormalGeometrySet) override;
|
|
using AbstractClient::setGeometry;
|
|
void setGeometry(int x, int y, int w, int h, ForceGeometry_t force = NormalGeometrySet) override;
|
|
bool hasStrut() const override;
|
|
|
|
quint32 windowId() const override {
|
|
return m_windowId;
|
|
}
|
|
|
|
/**
|
|
* The process for this client.
|
|
* Note that processes started by kwin will share its process id.
|
|
* @since 5.11
|
|
* @returns the process if for this client.
|
|
*/
|
|
pid_t pid() const override;
|
|
|
|
bool isLockScreen() const override;
|
|
bool isInputMethod() const override;
|
|
virtual QWindow *internalWindow() const;
|
|
|
|
void installPlasmaShellSurface(KWayland::Server::PlasmaShellSurfaceInterface *surface);
|
|
void installServerSideDecoration(KWayland::Server::ServerSideDecorationInterface *decoration);
|
|
void installAppMenu(KWayland::Server::AppMenuInterface *appmenu);
|
|
void installPalette(KWayland::Server::ServerSideDecorationPaletteInterface *palette);
|
|
void installXdgDecoration(KWayland::Server::XdgDecorationInterface *decoration);
|
|
|
|
bool isInitialPositionSet() const override;
|
|
|
|
bool isTransient() const override;
|
|
bool hasTransientPlacementHint() const override;
|
|
QRect transientPlacement(const QRect &bounds) const override;
|
|
|
|
QMatrix4x4 inputTransformation() const override;
|
|
|
|
bool setupCompositing() override;
|
|
void finishCompositing(ReleaseReason releaseReason = ReleaseReason::Release) override;
|
|
|
|
void showOnScreenEdge() override;
|
|
|
|
void killWindow() override;
|
|
|
|
// TODO: const-ref
|
|
void placeIn(QRect &area);
|
|
|
|
bool hasPopupGrab() const override;
|
|
void popupDone() override;
|
|
|
|
void updateColorScheme() override;
|
|
|
|
bool isPopupWindow() const override;
|
|
|
|
bool isLocalhost() const override
|
|
{
|
|
return true;
|
|
}
|
|
|
|
bool supportsWindowRules() const override;
|
|
|
|
protected:
|
|
void addDamage(const QRegion &damage) override;
|
|
bool belongsToSameApplication(const AbstractClient *other, SameApplicationChecks checks) const override;
|
|
void doSetActive() override;
|
|
bool belongsToDesktop() const override;
|
|
Layer layerForDock() const override;
|
|
void changeMaximize(bool horizontal, bool vertical, bool adjust) override;
|
|
void setGeometryRestore(const QRect &geo) override {
|
|
m_geomMaximizeRestore = geo;
|
|
}
|
|
void doResizeSync() override;
|
|
bool isWaitingForMoveResizeSync() const override;
|
|
bool acceptsFocus() const override;
|
|
void doMinimize() override;
|
|
void updateCaption() override;
|
|
|
|
virtual bool requestGeometry(const QRect &rect);
|
|
virtual void doSetGeometry(const QRect &rect);
|
|
void unmap();
|
|
void markAsMapped();
|
|
|
|
void setClientSize(const QSize &size) {
|
|
m_clientSize = size;
|
|
}
|
|
|
|
bool isUnmapped() const {
|
|
return m_unmapped;
|
|
}
|
|
|
|
private Q_SLOTS:
|
|
void clientFullScreenChanged(bool fullScreen);
|
|
|
|
private:
|
|
/**
|
|
* Called when the shell is created.
|
|
*/
|
|
void init();
|
|
/**
|
|
* Called for the XDG case when the shell surface is committed to the surface.
|
|
* At this point all initial properties should have been set by the client.
|
|
*/
|
|
void finishInit();
|
|
template <class T>
|
|
void initSurface(T *shellSurface);
|
|
void createDecoration(const QRect &oldgeom);
|
|
void destroyClient();
|
|
void createWindowId();
|
|
void updateIcon();
|
|
void setTransient();
|
|
bool shouldExposeToWindowManagement();
|
|
void updateClientOutputs();
|
|
void updateWindowMargins();
|
|
KWayland::Server::XdgShellSurfaceInterface::States xdgSurfaceStates() const;
|
|
void updateShowOnScreenEdge();
|
|
void updateMaximizeMode(MaximizeMode maximizeMode);
|
|
// called on surface commit and processes all m_pendingConfigureRequests up to m_lastAckedConfigureReqest
|
|
void updatePendingGeometry();
|
|
QPoint popupOffset(const QRect &anchorRect, const Qt::Edges anchorEdge, const Qt::Edges gravity, const QSize popupSize) const;
|
|
static void deleteClient(ShellClient *c);
|
|
|
|
QSize toWindowGeometry(const QSize &geometry) const;
|
|
|
|
KWayland::Server::ShellSurfaceInterface *m_shellSurface;
|
|
KWayland::Server::XdgShellSurfaceInterface *m_xdgShellSurface;
|
|
KWayland::Server::XdgShellPopupInterface *m_xdgShellPopup;
|
|
|
|
// size of the last buffer
|
|
QSize m_clientSize;
|
|
// last size we requested or empty if we haven't sent an explicit request to the client
|
|
// if empty the client should choose their own default size
|
|
QSize m_requestedClientSize = QSize(0, 0);
|
|
|
|
struct PendingConfigureRequest {
|
|
//note for wl_shell we have no serial, so serialId and m_lastAckedConfigureRequest will always be 0
|
|
//meaning we treat a surface commit as having processed all requests
|
|
quint32 serialId = 0;
|
|
// position to apply after a resize operation has been completed
|
|
QPoint positionAfterResize;
|
|
MaximizeMode maximizeMode;
|
|
};
|
|
QVector<PendingConfigureRequest> m_pendingConfigureRequests;
|
|
quint32 m_lastAckedConfigureRequest = 0;
|
|
|
|
//mode in use by the current buffer
|
|
MaximizeMode m_maximizeMode = MaximizeRestore;
|
|
//mode we currently want to be, could be pending on client updating, could be not sent yet
|
|
MaximizeMode m_requestedMaximizeMode = MaximizeRestore;
|
|
|
|
QRect m_geomFsRestore; //size and position of the window before it was set to fullscreen
|
|
bool m_closing = false;
|
|
quint32 m_windowId = 0;
|
|
bool m_unmapped = true;
|
|
QRect m_geomMaximizeRestore; // size and position of the window before it was set to maximize
|
|
NET::WindowType m_windowType = NET::Normal;
|
|
QPointer<KWayland::Server::PlasmaShellSurfaceInterface> m_plasmaShellSurface;
|
|
QPointer<KWayland::Server::AppMenuInterface> m_appMenuInterface;
|
|
QPointer<KWayland::Server::ServerSideDecorationPaletteInterface> m_paletteInterface;
|
|
KWayland::Server::ServerSideDecorationInterface *m_serverDecoration = nullptr;
|
|
KWayland::Server::XdgDecorationInterface *m_xdgDecoration = nullptr;
|
|
bool m_userNoBorder = false;
|
|
bool m_fullScreen = false;
|
|
bool m_transient = false;
|
|
bool m_hidden = false;
|
|
bool m_internal;
|
|
bool m_hasPopupGrab = false;
|
|
qreal m_opacity = 1.0;
|
|
|
|
class RequestGeometryBlocker { //TODO rename ConfigureBlocker when this class is Xdg only
|
|
public:
|
|
RequestGeometryBlocker(ShellClient *client)
|
|
: m_client(client)
|
|
{
|
|
m_client->m_requestGeometryBlockCounter++;
|
|
}
|
|
~RequestGeometryBlocker()
|
|
{
|
|
m_client->m_requestGeometryBlockCounter--;
|
|
if (m_client->m_requestGeometryBlockCounter == 0) {
|
|
m_client->requestGeometry(m_client->m_blockedRequestGeometry);
|
|
}
|
|
}
|
|
private:
|
|
ShellClient *m_client;
|
|
};
|
|
friend class RequestGeometryBlocker;
|
|
int m_requestGeometryBlockCounter = 0;
|
|
QRect m_blockedRequestGeometry;
|
|
QString m_caption;
|
|
QString m_captionSuffix;
|
|
QHash<qint32, PingReason> m_pingSerials;
|
|
|
|
QMargins m_windowMargins;
|
|
|
|
bool m_compositingSetup = false;
|
|
bool m_isInitialized = false;
|
|
};
|
|
|
|
}
|
|
|
|
Q_DECLARE_METATYPE(KWin::ShellClient*)
|
|
|
|
#endif
|