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 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  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 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         QDeclarativeParser::LocationSpan location;
  86     };
  87
  88     class TypeReference
  89     {
  90     public:
  91         TypeReference(int typeId, const QString &typeName) : id(typeId), name(typeName) {}
  92
  93         int id;
  94         // type as it has been referenced in Qml
  95         QString name;
  96         // objects in parse tree referencing the type
  97         QList<QDeclarativeParser::Object*> refObjects;
  98     };
  99
 100     QDeclarativeScriptParser();
 101     ~QDeclarativeScriptParser();
 102
 103     bool parse(const QByteArray &data, const QUrl &url = QUrl());
 104
 105     QList<TypeReference*> referencedTypes() const;
 106
 107     QDeclarativeParser::Object *tree() const;
 108     QList<Import> imports() const;
 109
 110     void clear();
 111
 112     QList<QDeclarativeError> errors() const;
 113
 114     class JavaScriptMetaData {
 115     public:
 116         JavaScriptMetaData()
 117         : pragmas(QDeclarativeParser::Object::ScriptBlock::None) {}
 118
 119         QDeclarativeParser::Object::ScriptBlock::Pragmas pragmas;
 120         QList<Import> imports;
 121     };
 122
 123     static QDeclarativeParser::Object::ScriptBlock::Pragmas extractPragmas(QString &);
 124     static JavaScriptMetaData extractMetaData(QString &);
 125
 126
 127 // ### private:
 128     TypeReference *findOrCreateType(const QString &name);
 129     void setTree(QDeclarativeParser::Object *tree);
 130
 131     void setScriptFile(const QString &filename) {_scriptFile = filename; }
 132     QString scriptFile() const { return _scriptFile; }
 133
 134 // ### private:
 135     QList<QDeclarativeError> _errors;
 136
 137     QDeclarativeParser::Object *root;
 138     QList<Import> _imports;
 139     QList<TypeReference*> _refTypes;
 140     QString _scriptFile;
 141     QDeclarativeScriptParserJsASTData *data;
 142 };
 143
 144 QT_END_NAMESPACE
 145
 146 QT_END_HEADER
 147
 148 #endif // QDECLARATIVESCRIPTPARSER_P_H