src/qml/qml/qqmldirparser_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml 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 QQMLDIRPARSER_P_H
  43 #define QQMLDIRPARSER_P_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 purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <QtCore/QUrl>
  57 #include <QtCore/QHash>
  58 #include <QtCore/QDebug>
  59 #include <private/qhashedstring_p.h>
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 class QQmlError;
  64 class QQmlEngine;
  65 class Q_AUTOTEST_EXPORT QQmlDirParser
  66 {
  67     Q_DISABLE_COPY(QQmlDirParser)
  68
  69 public:
  70     QQmlDirParser();
  71     ~QQmlDirParser();
  72
  73     bool parse(const QString &source);
  74
  75     bool hasError() const;
  76     void setError(const QQmlError &);
  77     QList<QQmlError> errors(const QString &uri) const;
  78
  79     QString typeNamespace() const;
  80     void setTypeNamespace(const QString &s);
  81
  82     struct Plugin
  83     {
  84         Plugin() {}
  85
  86         Plugin(const QString &name, const QString &path)
  87             : name(name), path(path) {}
  88
  89         QString name;
  90         QString path;
  91     };
  92
  93     struct Component
  94     {
  95         Component()
  96             : majorVersion(0), minorVersion(0), internal(false) {}
  97
  98         Component(const QString &typeName, const QString &fileName, int majorVersion, int minorVersion)
  99             : typeName(typeName), fileName(fileName), majorVersion(majorVersion), minorVersion(minorVersion),
 100             internal(false) {}
 101
 102         QString typeName;
 103         QString fileName;
 104         int majorVersion;
 105         int minorVersion;
 106         bool internal;
 107     };
 108
 109     struct Script
 110     {
 111         Script()
 112             : majorVersion(0), minorVersion(0) {}
 113
 114         Script(const QString &nameSpace, const QString &fileName, int majorVersion, int minorVersion)
 115             : nameSpace(nameSpace), fileName(fileName), majorVersion(majorVersion), minorVersion(minorVersion) {}
 116
 117         QString nameSpace;
 118         QString fileName;
 119         int majorVersion;
 120         int minorVersion;
 121     };
 122
 123     QHash<QHashedStringRef,Component> components() const;
 124     QList<Script> scripts() const;
 125     QList<Plugin> plugins() const;
 126
 127 #ifdef QT_CREATOR
 128     struct TypeInfo
 129     {
 130         TypeInfo() {}
 131         TypeInfo(const QString &fileName)
 132             : fileName(fileName) {}
 133
 134         QString fileName;
 135     };
 136
 137     QList<TypeInfo> typeInfos() const;
 138 #endif
 139
 140 private:
 141     void reportError(quint16 line, quint16 column, const QString &message);
 142
 143 private:
 144     QList<QQmlError> _errors;
 145     QString _typeNamespace;
 146     QHash<QHashedStringRef,Component> _components; // multi hash
 147     QList<Script> _scripts;
 148     QList<Plugin> _plugins;
 149 #ifdef QT_CREATOR
 150     QList<TypeInfo> _typeInfos;
 151 #endif
 152 };
 153
 154 typedef QHash<QHashedStringRef,QQmlDirParser::Component> QQmlDirComponents;
 155 typedef QList<QQmlDirParser::Script> QQmlDirScripts;
 156 typedef QList<QQmlDirParser::Plugin> QQmlDirPlugins;
 157
 158 QDebug &operator<< (QDebug &, const QQmlDirParser::Component &);
 159 QDebug &operator<< (QDebug &, const QQmlDirParser::Script &);
 160
 161 QT_END_NAMESPACE
 162
 163 #endif // QQMLDIRPARSER_P_H