src/dbus/qdbusintrospection_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtDBus module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  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
  64 QT_BEGIN_NAMESPACE
  65
  66 class Q_DBUS_EXPORT QDBusIntrospection
  67 {
  68 public:
  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
  87 public:
  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
 158 public:
 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
 164 private:
 165     QDBusIntrospection();
 166 };
 167
 168 QT_END_NAMESPACE
 169
 170 #endif