OSDN Git Service

QmlJS: Improve tests/tools/qml-ast2dot.
[qt-creator-jp/qt-creator-jp.git] / src / libs / qmljs / qmljsdocument.h
index acbe3d9..65c500c 100644 (file)
@@ -2,43 +2,49 @@
 **
 ** This file is part of Qt Creator
 **
-** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
 **
-** Contact: Nokia Corporation (qt-info@nokia.com)
+** Contact: Nokia Corporation (info@qt.nokia.com)
 **
-** Commercial Usage
-**
-** Licensees holding valid Qt Commercial licenses may use this file in
-** accordance with the Qt Commercial License Agreement provided with the
-** Software or, alternatively, in accordance with the terms contained in
-** a written agreement between you and Nokia.
 **
 ** GNU Lesser General Public License Usage
 **
-** Alternatively, this file may be used under the terms of the GNU Lesser
-** General Public License version 2.1 as published by the Free Software
-** Foundation and appearing in the file LICENSE.LGPL included in the
-** packaging of this file.  Please review the following information to
-** ensure the GNU Lesser General Public License version 2.1 requirements
-** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this file.
+** Please review the following information to ensure the GNU Lesser General
+** Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
 **
-** If you are unsure which license is appropriate for your use, please
-** contact the sales department at http://qt.nokia.com/contact.
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at info@qt.nokia.com.
 **
 **************************************************************************/
 #ifndef QMLDOCUMENT_H
 #define QMLDOCUMENT_H
 
 #include <QtCore/QList>
-#include <QtCore/QMap>
 #include <QtCore/QPair>
 #include <QtCore/QSharedPointer>
 #include <QtCore/QString>
 
+#include <languageutils/fakemetaobject.h>
+
 #include "parser/qmldirparser_p.h"
 #include "parser/qmljsengine_p.h"
 #include "qmljs_global.h"
 
+QT_QML_BEGIN_NAMESPACE
+
 namespace QmlJS {
 
 class Bind;
@@ -49,22 +55,36 @@ class QMLJS_EXPORT Document
 public:
     typedef QSharedPointer<Document> Ptr;
 
+    // used in a 3-bit bitfield
+    enum Language
+    {
+        QmlLanguage = 0,
+        JavaScriptLanguage = 1,
+        JsonLanguage = 2,
+        UnknownLanguage = 3
+    };
+
 protected:
-    Document(const QString &fileName);
+    Document(const QString &fileName, Language language);
 
 public:
     ~Document();
 
-    static Document::Ptr create(const QString &fileName);
+    static Document::Ptr create(const QString &fileName, Language language);
+    static Language guessLanguageFromSuffix(const QString &fileName);
+
+    Document::Ptr ptr() const;
 
     bool isQmlDocument() const;
-    bool isJSDocument() const;
+    Language language() const;
 
     AST::UiProgram *qmlProgram() const;
     AST::Program *jsProgram() const;
     AST::ExpressionNode *expression() const;
     AST::Node *ast() const;
 
+    const QmlJS::Engine *engine() const;
+
     QList<DiagnosticMessage> diagnosticMessages() const;
 
     QString source() const;
@@ -80,8 +100,8 @@ public:
 
     Bind *bind() const;
 
-    int documentRevision() const;
-    void setDocumentRevision(int documentRevision);
+    int editorRevision() const;
+    void setEditorRevision(int revision);
 
     QString fileName() const;
     QString path() const;
@@ -89,21 +109,20 @@ public:
 
 private:
     bool parse_helper(int kind);
-    static void extractPragmas(QString *source);
 
 private:
     QmlJS::Engine *_engine;
-    NodePool *_pool;
     AST::Node *_ast;
     Bind *_bind;
-    bool _isQmlDocument;
-    int _documentRevision;
-    bool _parsedCorrectly;
     QList<QmlJS::DiagnosticMessage> _diagnosticMessages;
     QString _fileName;
     QString _path;
     QString _componentName;
     QString _source;
+    QWeakPointer<Document> _ptr;
+    int _editorRevision;
+    Language _language : 3;
+    bool _parsedCorrectly : 1;
 
     // for documentFromSource
     friend class Snapshot;
@@ -111,13 +130,35 @@ private:
 
 class QMLJS_EXPORT LibraryInfo
 {
-    bool _valid;
+public:
+    enum PluginTypeInfoStatus {
+        NoTypeInfo,
+        DumpDone,
+        DumpError,
+        TypeInfoFileDone,
+        TypeInfoFileError
+    };
+
+    enum Status {
+        NotScanned,
+        NotFound,
+        Found
+    };
+
+private:
+    Status _status;
     QList<QmlDirParser::Component> _components;
     QList<QmlDirParser::Plugin> _plugins;
+    QList<QmlDirParser::TypeInfo> _typeinfos;
+    typedef QList<LanguageUtils::FakeMetaObject::ConstPtr> FakeMetaObjectList;
+    FakeMetaObjectList _metaObjects;
+
+    PluginTypeInfoStatus _dumpStatus;
+    QString _dumpError;
 
 public:
-    LibraryInfo();
-    LibraryInfo(const QmlDirParser &parser);
+    explicit LibraryInfo(Status status = NotScanned);
+    explicit LibraryInfo(const QmlDirParser &parser);
     ~LibraryInfo();
 
     QList<QmlDirParser::Component> components() const
@@ -126,15 +167,36 @@ public:
     QList<QmlDirParser::Plugin> plugins() const
     { return _plugins; }
 
+    QList<QmlDirParser::TypeInfo> typeInfos() const
+    { return _typeinfos; }
+
+    FakeMetaObjectList metaObjects() const
+    { return _metaObjects; }
+
+    void setMetaObjects(const FakeMetaObjectList &objects)
+    { _metaObjects = objects; }
+
     bool isValid() const
-    { return _valid; }
+    { return _status == Found; }
+
+    bool wasScanned() const
+    { return _status != NotScanned; }
+
+    PluginTypeInfoStatus pluginTypeInfoStatus() const
+    { return _dumpStatus; }
+
+    QString pluginTypeInfoError() const
+    { return _dumpError; }
+
+    void setPluginTypeInfoStatus(PluginTypeInfoStatus dumped, const QString &error = QString())
+    { _dumpStatus = dumped; _dumpError = error; }
 };
 
 class QMLJS_EXPORT Snapshot
 {
     typedef QHash<QString, Document::Ptr> _Base;
     QHash<QString, Document::Ptr> _documents;
-    QMultiHash<QString, Document::Ptr> _documentsByPath;
+    QHash<QString, QList<Document::Ptr> > _documentsByPath;
     QHash<QString, LibraryInfo> _libraries;
 
 public:
@@ -147,7 +209,7 @@ public:
     const_iterator begin() const { return _documents.begin(); }
     const_iterator end() const { return _documents.end(); }
 
-    void insert(const Document::Ptr &document);
+    void insert(const Document::Ptr &document, bool allowInvalid = false);
     void insertLibraryInfo(const QString &path, const LibraryInfo &info);
     void remove(const QString &fileName);
 
@@ -156,12 +218,12 @@ public:
     LibraryInfo libraryInfo(const QString &path) const;
 
     Document::Ptr documentFromSource(const QString &code,
-                                     const QString &fileName) const;
-
-    QList<Document::Ptr> importedDocuments(const Document::Ptr &doc, const QString &importPath) const;
-    QMap<QString, Document::Ptr> componentsDefinedByImportedDocuments(const Document::Ptr &doc, const QString &importPath) const;
+                                     const QString &fileName,
+                                     Document::Language language) const;
 };
 
-} // end of namespace Qml
+} // namespace QmlJS
+
+QT_QML_END_NAMESPACE
 
 #endif // QMLDOCUMENT_H