6a19f50cac
Summary: The idea behind the debugging console is to have a feature comparable to xprop and xwininfo just for Wayland. We cannot have command line utils as that violates the security restrictions, thus it needs to be exposed directly in KWin. The debugging console is invoked through DBus: qdbus org.kde.KWin /KWin showDebugConsole This opens a window with a tree view. The DebugConsoleModel which is used by the tree view groups all windows into four categories: * x11 clients (that is Workspace::clientList() and Workspace::desktopList()) * x11 unmanaged (Workspace::unmanagedList()) * wayland shell clients (WaylandServer::clients()) * wayland internal clients (KWin's own QWindows - WaylandServer::internalClients()) Each window is a child to one of the four categories. Each window itself has all it's QProperties exposed as children. This allows to properly inspect KWin's internal knowledge for windows and should make it easier to investigate problems. E.g. what's a window's geometry, what's it's window type and so on. The debugging console is intended as a developer tool and not expected to be used by users. That's why it's invokation is rather hidden. Due to the fact that it's internal to KWin it results in: * no window decoration * stealing keyboard focus * no way to resize, close, move from KWin side * rendered above all other windows There is a dedicated close button to get rid of it again. While the console is shown it's hardly possible to interact with the system in a normal way anymore. This is something which might be improved in future. At the moment the model is able to update when windows are added/removed, but not yet when a property changes. Due to the lack of interaction with the existing system, that's not a high priority at the moment, but can be added in future. Reviewers: #plasma Differential Revision: https://phabricator.kde.org/D1146
105 lines
3.3 KiB
C++
105 lines
3.3 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright (C) 2016 Martin Gräßlin <mgraesslin@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_DEBUG_CONSOLE_H
|
|
#define KWIN_DEBUG_CONSOLE_H
|
|
|
|
#include <kwin_export.h>
|
|
|
|
#include <QAbstractItemModel>
|
|
#include <QStyledItemDelegate>
|
|
#include <QVector>
|
|
|
|
namespace Ui
|
|
{
|
|
class DebugConsole;
|
|
}
|
|
|
|
namespace KWin
|
|
{
|
|
|
|
class Client;
|
|
class ShellClient;
|
|
class Unmanaged;
|
|
|
|
class KWIN_EXPORT DebugConsoleModel : public QAbstractItemModel
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
explicit DebugConsoleModel(QObject *parent = nullptr);
|
|
virtual ~DebugConsoleModel();
|
|
|
|
|
|
int columnCount(const QModelIndex &parent) const override;
|
|
QVariant data(const QModelIndex &index, int role) const override;
|
|
QModelIndex index(int row, int column, const QModelIndex & parent) const override;
|
|
int rowCount(const QModelIndex &parent) const override;
|
|
QModelIndex parent(const QModelIndex &child) const override;
|
|
|
|
private:
|
|
template <class T>
|
|
QModelIndex indexForClient(int row, int column, const QVector<T*> &clients, int id) const;
|
|
template <class T>
|
|
QModelIndex indexForProperty(int row, int column, const QModelIndex &parent, T *(DebugConsoleModel::*filter)(const QModelIndex&) const) const;
|
|
template <class T>
|
|
int propertyCount(const QModelIndex &parent, T *(DebugConsoleModel::*filter)(const QModelIndex&) const) const;
|
|
QVariant propertyData(QObject *object, const QModelIndex &index, int role) const;
|
|
template <class T>
|
|
QVariant clientData(const QModelIndex &index, int role, const QVector<T*> clients) const;
|
|
template <class T>
|
|
void add(int parentRow, QVector<T*> &clients, T *client);
|
|
template <class T>
|
|
void remove(int parentRow, QVector<T*> &clients, T *client);
|
|
ShellClient *shellClient(const QModelIndex &index) const;
|
|
ShellClient *internalClient(const QModelIndex &index) const;
|
|
Client *x11Client(const QModelIndex &index) const;
|
|
Unmanaged *unmanaged(const QModelIndex &index) const;
|
|
int topLevelRowCount() const;
|
|
|
|
QVector<ShellClient*> m_shellClients;
|
|
QVector<ShellClient*> m_internalClients;
|
|
QVector<Client*> m_x11Clients;
|
|
QVector<Unmanaged*> m_unmanageds;
|
|
|
|
};
|
|
|
|
class DebugConsoleDelegate : public QStyledItemDelegate
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
explicit DebugConsoleDelegate(QObject *parent = nullptr);
|
|
virtual ~DebugConsoleDelegate();
|
|
|
|
QString displayText(const QVariant &value, const QLocale &locale) const override;
|
|
};
|
|
|
|
class DebugConsole : public QWidget
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
DebugConsole();
|
|
virtual ~DebugConsole();
|
|
|
|
private:
|
|
QScopedPointer<Ui::DebugConsole> m_ui;
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|