src/declarative/qml/qdeclarativescriptparser_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41 #ifndef QDECLARATIVESCRIPTPARSER_P_H
  42 #define QDECLARATIVESCRIPTPARSER_P_H
  43
  44 //
  45 //  W A R N I N G
  46 //  -------------
  47 //
  48 // This file is not part of the Qt API.  It exists purely as an
  49 // implementation detail.  This header file may change from version to
  50 // version without notice, or even be removed.
  51 //
  52 // We mean it.
  53 //
  54
  55 #include "qdeclarativeerror.h"
  56 #include "private/qdeclarativeparser_p.h"
  57
  58 #include <QtCore/QList>
  59 #include <QtCore/QUrl>
  60
  61 QT_BEGIN_HEADER
  62
  63 QT_BEGIN_NAMESPACE
  64
  65 QT_MODULE(Declarative)
  66
  67 class QByteArray;
  68
  69 class QDeclarativeScriptParserJsASTData;
  70 class Q_AUTOTEST_EXPORT QDeclarativeScriptParser
  71 {
  72 public:
  73     class Import
  74     {
  75     public:
  76         Import() : type(Library) {}
  77
  78         enum Type { Library, File, Script };
  79         Type type;
  80
  81         QString uri;
  82         QString qualifier;
  83         QString version;
  84
  85         void extractVersion(int *maj, int *min) const;
  86
  87         QDeclarativeParser::LocationSpan location;
  88     };
  89
  90     class TypeReference
  91     {
  92     public:
  93         TypeReference(int typeId, const QString &typeName) : id(typeId), name(typeName) {}
  94
  95         int id;
  96         // type as it has been referenced in Qml
  97         QString name;
  98         // objects in parse tree referencing the type
  99         QList<QDeclarativeParser::Object*> refObjects;
 100     };
 101
 102     QDeclarativeScriptParser();
 103     ~QDeclarativeScriptParser();
 104
 105     bool parse(const QByteArray &data, const QUrl &url = QUrl());
 106
 107     QList<TypeReference*> referencedTypes() const;
 108
 109     QDeclarativeParser::Object *tree() const;
 110     QList<Import> imports() const;
 111
 112     void clear();
 113
 114     QList<QDeclarativeError> errors() const;
 115
 116     class JavaScriptMetaData {
 117     public:
 118         JavaScriptMetaData()
 119         : pragmas(QDeclarativeParser::Object::ScriptBlock::None) {}
 120
 121         QDeclarativeParser::Object::ScriptBlock::Pragmas pragmas;
 122         QList<Import> imports;
 123     };
 124
 125     static QDeclarativeParser::Object::ScriptBlock::Pragmas extractPragmas(QString &);
 126     static JavaScriptMetaData extractMetaData(QString &);
 127
 128
 129 // ### private:
 130     TypeReference *findOrCreateType(const QString &name);
 131     void setTree(QDeclarativeParser::Object *tree);
 132
 133     void setScriptFile(const QString &filename) {_scriptFile = filename; }
 134     QString scriptFile() const { return _scriptFile; }
 135
 136 // ### private:
 137     QList<QDeclarativeError> _errors;
 138
 139     QDeclarativeParser::Object *root;
 140     QList<Import> _imports;
 141     QList<TypeReference*> _refTypes;
 142     QString _scriptFile;
 143     QDeclarativeScriptParserJsASTData *data;
 144 };
 145
 146 QT_END_NAMESPACE
 147
 148 QT_END_HEADER
 149
 150 #endif // QDECLARATIVESCRIPTPARSER_P_H