1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3
4#ifndef QDBUSEXTRATYPES_H
5#define QDBUSEXTRATYPES_H
6
7// define some useful types for D-Bus
8
9#include <QtDBus/qtdbusglobal.h>
10#include <QtCore/qvariant.h>
11#include <QtCore/qstring.h>
12#include <QtCore/qhashfunctions.h>
13
14#ifndef QT_NO_DBUS
15
16QT_BEGIN_NAMESPACE
17
18class Q_DBUS_EXPORT QDBusObjectPath
19{
20 QString m_path;
21public:
22 QDBusObjectPath() noexcept : m_path() {}
23 // compiler-generated copy/move constructor/assignment operators are ok!
24 // compiler-generated destructor is ok!
25
26 inline explicit QDBusObjectPath(const char *path);
27 inline explicit QDBusObjectPath(QLatin1StringView path);
28 inline explicit QDBusObjectPath(const QString &path);
29 explicit QDBusObjectPath(QString &&p) : m_path(std::move(p)) { doCheck(); }
30
31 void swap(QDBusObjectPath &other) noexcept { m_path.swap(other&: other.m_path); }
32
33 inline void setPath(const QString &path);
34
35 inline QString path() const
36 { return m_path; }
37
38 operator QVariant() const;
39
40private:
41#ifndef QT_NO_DEBUG_STREAM
42 Q_DBUS_EXPORT friend QDebug operator<<(QDebug, const QDBusObjectPath &);
43#endif
44 void doCheck();
45};
46Q_DECLARE_SHARED(QDBusObjectPath)
47
48inline QDBusObjectPath::QDBusObjectPath(const char *objectPath)
49 : m_path(QString::fromLatin1(ba: objectPath))
50{ doCheck(); }
51
52inline QDBusObjectPath::QDBusObjectPath(QLatin1StringView objectPath)
53 : m_path(objectPath)
54{ doCheck(); }
55
56inline QDBusObjectPath::QDBusObjectPath(const QString &objectPath)
57 : m_path(objectPath)
58{ doCheck(); }
59
60inline void QDBusObjectPath::setPath(const QString &objectPath)
61{ m_path = objectPath; doCheck(); }
62
63inline bool operator==(const QDBusObjectPath &lhs, const QDBusObjectPath &rhs)
64{ return lhs.path() == rhs.path(); }
65
66inline bool operator!=(const QDBusObjectPath &lhs, const QDBusObjectPath &rhs)
67{ return lhs.path() != rhs.path(); }
68
69inline bool operator<(const QDBusObjectPath &lhs, const QDBusObjectPath &rhs)
70{ return lhs.path() < rhs.path(); }
71
72inline size_t qHash(const QDBusObjectPath &objectPath, size_t seed = 0)
73{ return qHash(key: objectPath.path(), seed); }
74
75
76class Q_DBUS_EXPORT QDBusSignature
77{
78 QString m_signature;
79public:
80 QDBusSignature() noexcept;
81 // compiler-generated copy/move constructor/assignment operators are ok!
82 // compiler-generated destructor is ok!
83
84 inline explicit QDBusSignature(const char *signature);
85 inline explicit QDBusSignature(QLatin1StringView signature);
86 inline explicit QDBusSignature(const QString &signature);
87 explicit QDBusSignature(QString &&sig) : m_signature(std::move(sig)) { doCheck(); }
88
89 void swap(QDBusSignature &other) noexcept { m_signature.swap(other&: other.m_signature); }
90
91 inline void setSignature(const QString &signature);
92
93 inline QString signature() const
94 { return m_signature; }
95
96private:
97 void doCheck();
98};
99Q_DECLARE_SHARED(QDBusSignature)
100
101inline QDBusSignature::QDBusSignature(const char *dBusSignature)
102 : m_signature(QString::fromLatin1(ba: dBusSignature))
103{ doCheck(); }
104
105inline QDBusSignature::QDBusSignature(QLatin1StringView dBusSignature)
106 : m_signature(dBusSignature)
107{ doCheck(); }
108
109inline QDBusSignature::QDBusSignature(const QString &dBusSignature)
110 : m_signature(dBusSignature)
111{ doCheck(); }
112
113inline void QDBusSignature::setSignature(const QString &dBusSignature)
114{ m_signature = dBusSignature; doCheck(); }
115
116inline bool operator==(const QDBusSignature &lhs, const QDBusSignature &rhs)
117{ return lhs.signature() == rhs.signature(); }
118
119inline bool operator!=(const QDBusSignature &lhs, const QDBusSignature &rhs)
120{ return lhs.signature() != rhs.signature(); }
121
122inline bool operator<(const QDBusSignature &lhs, const QDBusSignature &rhs)
123{ return lhs.signature() < rhs.signature(); }
124
125inline size_t qHash(const QDBusSignature &signature, size_t seed = 0)
126{ return qHash(key: signature.signature(), seed); }
127
128class QDBusVariant
129{
130 QVariant m_variant;
131public:
132 QDBusVariant() noexcept : m_variant() {}
133 // compiler-generated copy/move constructor/assignment operators are ok!
134 // compiler-generated destructor is ok!
135
136 inline explicit QDBusVariant(const QVariant &variant);
137 explicit QDBusVariant(QVariant &&v) noexcept : m_variant(std::move(v)) {}
138
139 void swap(QDBusVariant &other) noexcept { m_variant.swap(other&: other.m_variant); }
140
141 inline void setVariant(const QVariant &variant);
142
143 inline QVariant variant() const
144 { return m_variant; }
145};
146Q_DECLARE_SHARED(QDBusVariant)
147
148inline QDBusVariant::QDBusVariant(const QVariant &dBusVariant)
149 : m_variant(dBusVariant) { }
150
151inline void QDBusVariant::setVariant(const QVariant &dBusVariant)
152{ m_variant = dBusVariant; }
153
154inline bool operator==(const QDBusVariant &v1, const QDBusVariant &v2)
155{ return v1.variant() == v2.variant(); }
156
157QT_END_NAMESPACE
158
159QT_DECL_METATYPE_EXTERN(QDBusVariant, Q_DBUS_EXPORT)
160QT_DECL_METATYPE_EXTERN(QDBusObjectPath, Q_DBUS_EXPORT)
161QT_DECL_METATYPE_EXTERN(QDBusSignature, Q_DBUS_EXPORT)
162
163#endif // QT_NO_DBUS
164#endif
165

source code of qtbase/src/dbus/qdbusextratypes.h