1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14** conditions see http://qt.digia.com/licensing. For further information
15** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 2.1 requirements
23** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24**
25** In addition, as a special exception, Digia gives you certain additional
26** rights. These rights are described in the Digia Qt LGPL Exception
27** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28**
29** GNU General Public License Usage
30** Alternatively, this file may be used under the terms of the GNU
31** General Public License version 3.0 as published by the Free Software
32** Foundation and appearing in the file LICENSE.GPL included in the
33** packaging of this file. Please review the following information to
34** ensure the GNU General Public License version 3.0 requirements will be
35** met: http://www.gnu.org/copyleft/gpl.html.
36**
37**
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QDBUSINTROSPECTION_H
43#define QDBUSINTROSPECTION_H
44
45//
46// W A R N I N G
47// -------------
48//
49// This file is not part of the Qt API. It exists for the convenience
50// of the QLibrary class. This header file may change from
51// version to version without notice, or even be removed.
52//
53// We mean it.
54//
55
56#include <QtCore/qstring.h>
57#include <QtCore/qlist.h>
58#include <QtCore/qstringlist.h>
59#include <QtCore/qmap.h>
60#include <QtCore/qpair.h>
61#include <QtCore/qshareddata.h>
62#include <qdbusmacros.h>
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 QList<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 QString introspection;
154
155 QStringList interfaces;
156 QStringList childObjects;
157 };
158
159 struct ObjectTree: public Object
160 {
161 Interfaces interfaceData;
162 Objects childObjectData;
163 };
164
165public:
166 static Interface parseInterface(const QString &xml);
167 static Interfaces parseInterfaces(const QString &xml);
168 static Object parseObject(const QString &xml, const QString &service = QString(),
169 const QString &path = QString());
170 static ObjectTree parseObjectTree(const QString &xml,
171 const QString &service,
172 const QString &path);
173
174private:
175 QDBusIntrospection();
176};
177
178QT_END_NAMESPACE
179
180#endif
181