2013-08-12 16:58:05 +04:00
|
|
|
/********************************************************************
|
|
|
|
KWin - the KDE window manager
|
|
|
|
This file is part of the KDE project.
|
|
|
|
|
2020-08-03 01:10:35 +03:00
|
|
|
SPDX-FileCopyrightText: 2013 Martin Gräßlin <mgraesslin@kde.org>
|
2013-08-12 16:58:05 +04:00
|
|
|
|
2020-08-03 01:10:35 +03:00
|
|
|
SPDX-License-Identifier: GPL-2.0-or-later
|
2013-08-12 16:58:05 +04:00
|
|
|
*********************************************************************/
|
|
|
|
#ifndef KWIN_DBUSCALL_H
|
|
|
|
#define KWIN_DBUSCALL_H
|
|
|
|
|
|
|
|
#include <QObject>
|
|
|
|
#include <QString>
|
|
|
|
|
|
|
|
namespace KWin
|
|
|
|
{
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Qml export for providing a wrapper for sending a message over the DBus
|
|
|
|
* session bus.
|
|
|
|
*
|
|
|
|
* Allows to setup the connection arguments just like in QDBusMessage and supports
|
2019-01-12 13:31:32 +03:00
|
|
|
* adding arguments to the call. To invoke the message use the slot @ref call.
|
2013-08-12 16:58:05 +04:00
|
|
|
*
|
2019-01-12 13:31:32 +03:00
|
|
|
* If the call succeeds the signal @ref finished is emitted, if the call fails
|
|
|
|
* the signal @ref failed is emitted.
|
2013-08-12 16:58:05 +04:00
|
|
|
*
|
|
|
|
* Note: the DBusCall always uses the session bus and performs an async call.
|
|
|
|
*
|
|
|
|
* Example on how to use in Qml:
|
|
|
|
* @code
|
|
|
|
* DBusCall {
|
|
|
|
* id: dbus
|
|
|
|
* service: "org.kde.KWin"
|
|
|
|
* path: "/KWin"
|
|
|
|
* method: "nextDesktop"
|
|
|
|
* Component.onCompleted: dbus.call()
|
|
|
|
* }
|
|
|
|
* @endcode
|
|
|
|
*
|
|
|
|
* Example with arguments:
|
|
|
|
* @code
|
|
|
|
* DBusCall {
|
|
|
|
* id: dbus
|
|
|
|
* service: "org.kde.KWin"
|
|
|
|
* path: "/KWin"
|
|
|
|
* method: "setCurrentDesktop"
|
|
|
|
* arguments: [1]
|
|
|
|
* Component.onCompleted: dbus.call()
|
|
|
|
* }
|
|
|
|
* @endcode
|
|
|
|
*
|
|
|
|
* Example with a callback:
|
|
|
|
* @code
|
|
|
|
* DBusCall {
|
|
|
|
* id: dbus
|
|
|
|
* service: "org.kde.KWin"
|
|
|
|
* path: "/KWin"
|
|
|
|
* method: "currentDesktop"
|
|
|
|
* onFinished: console.log(returnValue[0])
|
|
|
|
* }
|
|
|
|
* @endcode
|
2019-07-29 21:58:33 +03:00
|
|
|
*/
|
2013-08-12 16:58:05 +04:00
|
|
|
class DBusCall : public QObject
|
|
|
|
{
|
|
|
|
Q_OBJECT
|
|
|
|
Q_PROPERTY(QString service READ service WRITE setService NOTIFY serviceChanged)
|
|
|
|
Q_PROPERTY(QString path READ path WRITE setPath NOTIFY pathChanged)
|
|
|
|
Q_PROPERTY(QString dbusInterface READ interface WRITE setInterface NOTIFY interfaceChanged)
|
|
|
|
Q_PROPERTY(QString method READ method WRITE setMethod NOTIFY methodChanged)
|
|
|
|
Q_PROPERTY(QVariantList arguments READ arguments WRITE setArguments NOTIFY argumentsChanged)
|
|
|
|
public:
|
Use nullptr everywhere
Summary:
Because KWin is a very old project, we use three kinds of null pointer
literals: 0, NULL, and nullptr. Since C++11, it's recommended to use
nullptr keyword.
This change converts all usages of 0 and NULL literal to nullptr. Even
though it breaks git history, we need to do it in order to have consistent
code as well to ease code reviews (it's very tempting for some people to
add unrelated changes to their patches, e.g. converting NULL to nullptr).
Test Plan: Compiles.
Reviewers: #kwin, davidedmundson, romangg
Reviewed By: #kwin, davidedmundson, romangg
Subscribers: romangg, kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D23618
2019-09-19 17:46:54 +03:00
|
|
|
explicit DBusCall(QObject* parent = nullptr);
|
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 19:52:26 +03:00
|
|
|
~DBusCall() override;
|
2013-08-12 16:58:05 +04:00
|
|
|
|
|
|
|
const QString &service() const;
|
|
|
|
const QString &path() const;
|
|
|
|
const QString &interface() const;
|
|
|
|
const QString &method() const;
|
|
|
|
const QVariantList &arguments() const;
|
|
|
|
|
|
|
|
public Q_SLOTS:
|
|
|
|
void call();
|
|
|
|
|
|
|
|
void setService(const QString &service);
|
|
|
|
void setPath(const QString &path);
|
|
|
|
void setInterface(const QString &interface);
|
|
|
|
void setMethod(const QString &method);
|
|
|
|
void setArguments(const QVariantList &arguments);
|
|
|
|
|
|
|
|
Q_SIGNALS:
|
|
|
|
void finished(QVariantList returnValue);
|
|
|
|
void failed();
|
|
|
|
|
|
|
|
void serviceChanged();
|
|
|
|
void pathChanged();
|
|
|
|
void interfaceChanged();
|
|
|
|
void methodChanged();
|
|
|
|
void argumentsChanged();
|
|
|
|
|
|
|
|
private:
|
|
|
|
QString m_service;
|
|
|
|
QString m_path;
|
|
|
|
QString m_interface;
|
|
|
|
QString m_method;
|
|
|
|
QVariantList m_arguments;
|
|
|
|
};
|
|
|
|
|
|
|
|
#define GENERIC_WRAPPER(type, name, upperName) \
|
|
|
|
inline type DBusCall::name() const \
|
|
|
|
{ \
|
|
|
|
return m_##name; \
|
|
|
|
}\
|
|
|
|
inline void DBusCall::set##upperName(type name) \
|
|
|
|
{\
|
|
|
|
if (m_##name == name) { \
|
|
|
|
return; \
|
|
|
|
} \
|
|
|
|
m_##name = name; \
|
|
|
|
emit name##Changed(); \
|
|
|
|
}
|
|
|
|
#define WRAPPER(name, upperName) \
|
|
|
|
GENERIC_WRAPPER(const QString&, name, upperName)
|
|
|
|
|
|
|
|
WRAPPER(interface, Interface)
|
|
|
|
WRAPPER(method, Method)
|
|
|
|
WRAPPER(path, Path)
|
|
|
|
WRAPPER(service, Service)
|
|
|
|
|
|
|
|
GENERIC_WRAPPER(const QVariantList &, arguments, Arguments)
|
|
|
|
#undef WRAPPER
|
|
|
|
#undef GENERIC_WRAPPER
|
|
|
|
|
|
|
|
} // KWin
|
|
|
|
|
|
|
|
#endif // KWIN_SCRIPTING_DBUSCALL_H
|