1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtDBus module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QDBUSINTROSPECTION_P_H
41#define QDBUSINTROSPECTION_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of the QLibrary class. This header file may change from
49// version to version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtDBus/private/qtdbusglobal_p.h>
55#include <QtCore/qstring.h>
56#include <QtCore/qvector.h>
57#include <QtCore/qstringlist.h>
58#include <QtCore/qmap.h>
59#include <QtCore/qpair.h>
60#include <QtCore/qshareddata.h>
61
62#ifndef QT_NO_DBUS
63
64QT_BEGIN_NAMESPACE
65
66class Q_DBUS_EXPORT QDBusIntrospection
67{
68public:
69 // forward declarations
70 struct Argument;
71 struct Method;
72 struct Signal;
73 struct Property;
74 struct Interface;
75 struct Object;
76 struct ObjectTree;
77
78 // typedefs
79 typedef QMap<QString, QString> Annotations;
80 typedef QVector<Argument> Arguments;
81 typedef QMultiMap<QString, Method> Methods;
82 typedef QMultiMap<QString, Signal> Signals;
83 typedef QMap<QString, Property> Properties;
84 typedef QMap<QString, QSharedDataPointer<Interface> > Interfaces;
85 typedef QMap<QString, QSharedDataPointer<ObjectTree> > Objects;
86
87public:
88 // the structs
89
90 struct Argument
91 {
92 QString type;
93 QString name;
94
95 inline bool operator==(const Argument& other) const
96 { return name == other.name && type == other.type; }
97 };
98
99 struct Method
100 {
101 QString name;
102 Arguments inputArgs;
103 Arguments outputArgs;
104 Annotations annotations;
105
106 inline bool operator==(const Method& other) const
107 { return name == other.name && annotations == other.annotations &&
108 inputArgs == other.inputArgs && outputArgs == other.outputArgs; }
109 };
110
111 struct Signal
112 {
113 QString name;
114 Arguments outputArgs;
115 Annotations annotations;
116
117 inline bool operator==(const Signal& other) const
118 { return name == other.name && annotations == other.annotations &&
119 outputArgs == other.outputArgs; }
120 };
121
122 struct Property
123 {
124 enum Access { Read, Write, ReadWrite };
125 QString name;
126 QString type;
127 Access access;
128 Annotations annotations;
129
130 inline bool operator==(const Property& other) const
131 { return access == other.access && name == other.name &&
132 annotations == other.annotations && type == other.type; }
133 };
134
135 struct Interface: public QSharedData
136 {
137 QString name;
138 QString introspection;
139
140 Annotations annotations;
141 Methods methods;
142 Signals signals_;
143 Properties properties;
144
145 inline bool operator==(const Interface &other) const
146 { return !name.isEmpty() && name == other.name; }
147 };
148
149 struct Object: public QSharedData
150 {
151 QString service;
152 QString path;
153
154 QStringList interfaces;
155 QStringList childObjects;
156 };
157
158public:
159 static Interface parseInterface(const QString &xml);
160 static Interfaces parseInterfaces(const QString &xml);
161 static Object parseObject(const QString &xml, const QString &service = QString(),
162 const QString &path = QString());
163
164private:
165 QDBusIntrospection();
166};
167
168QT_END_NAMESPACE
169
170#endif // QT_NO_DBUS
171#endif
172