1/****************************************************************************
2**
3** Copyright (C) 2019 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QQMLTYPEDATA_P_H
41#define QQMLTYPEDATA_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <private/qqmltypeloader_p.h>
55#include <private/qv4executablecompilationunit_p.h>
56
57QT_BEGIN_NAMESPACE
58
59class Q_AUTOTEST_EXPORT QQmlTypeData : public QQmlTypeLoader::Blob
60{
61 Q_DECLARE_TR_FUNCTIONS(QQmlTypeData)
62public:
63 struct TypeReference
64 {
65 TypeReference() : majorVersion(0), minorVersion(0), needsCreation(true) {}
66
67 QV4::CompiledData::Location location;
68 QQmlType type;
69 int majorVersion;
70 int minorVersion;
71 QQmlRefPointer<QQmlTypeData> typeData;
72 QString prefix; // used by CompositeSingleton types
73 QString qualifiedName() const;
74 bool needsCreation;
75 };
76
77 struct ScriptReference
78 {
79 QV4::CompiledData::Location location;
80 QString qualifier;
81 QQmlRefPointer<QQmlScriptBlob> script;
82 };
83
84private:
85 friend class QQmlTypeLoader;
86
87 QQmlTypeData(const QUrl &, QQmlTypeLoader *);
88
89public:
90 ~QQmlTypeData() override;
91
92 const QList<ScriptReference> &resolvedScripts() const;
93
94 QV4::ExecutableCompilationUnit *compilationUnit() const;
95
96 // Used by QQmlComponent to get notifications
97 struct TypeDataCallback {
98 virtual ~TypeDataCallback();
99 virtual void typeDataProgress(QQmlTypeData *, qreal) {}
100 virtual void typeDataReady(QQmlTypeData *) {}
101 };
102 void registerCallback(TypeDataCallback *);
103 void unregisterCallback(TypeDataCallback *);
104
105protected:
106 void done() override;
107 void completed() override;
108 void dataReceived(const SourceCodeData &) override;
109 void initializeFromCachedUnit(const QV4::CompiledData::Unit *unit) override;
110 void allDependenciesDone() override;
111 void downloadProgressChanged(qreal) override;
112
113 QString stringAt(int index) const override;
114
115private:
116 bool tryLoadFromDiskCache();
117 bool loadFromSource();
118 void restoreIR(QV4::CompiledData::CompilationUnit &&unit);
119 void continueLoadFromIR();
120 void resolveTypes();
121 QQmlJS::DiagnosticMessage buildTypeResolutionCaches(
122 QQmlRefPointer<QQmlTypeNameCache> *typeNameCache,
123 QV4::ResolvedTypeReferenceMap *resolvedTypeCache
124 ) const;
125 void compile(const QQmlRefPointer<QQmlTypeNameCache> &typeNameCache,
126 QV4::ResolvedTypeReferenceMap *resolvedTypeCache,
127 const QV4::CompiledData::DependentTypesHasher &dependencyHasher);
128 void createTypeAndPropertyCaches(const QQmlRefPointer<QQmlTypeNameCache> &typeNameCache,
129 const QV4::ResolvedTypeReferenceMap &resolvedTypeCache);
130 bool resolveType(const QString &typeName, int &majorVersion, int &minorVersion,
131 TypeReference &ref, int lineNumber = -1, int columnNumber = -1,
132 bool reportErrors = true,
133 QQmlType::RegistrationType registrationType = QQmlType::AnyRegistrationType);
134
135 void scriptImported(const QQmlRefPointer<QQmlScriptBlob> &blob, const QV4::CompiledData::Location &location, const QString &qualifier, const QString &nameSpace) override;
136
137
138 SourceCodeData m_backupSourceCode; // used when cache verification fails.
139 QScopedPointer<QmlIR::Document> m_document;
140 QV4::CompiledData::TypeReferenceMap m_typeReferences;
141
142 QList<ScriptReference> m_scripts;
143
144 QSet<QString> m_namespaces;
145 QList<TypeReference> m_compositeSingletons;
146
147 // map from name index to resolved type
148 // While this could be a hash, a map is chosen here to provide a stable
149 // order, which is used to calculating a check-sum on dependent meta-objects.
150 QMap<int, TypeReference> m_resolvedTypes;
151 bool m_typesResolved:1;
152
153 QQmlRefPointer<QV4::ExecutableCompilationUnit> m_compiledData;
154
155 QList<TypeDataCallback *> m_callbacks;
156
157 bool m_implicitImportLoaded;
158 bool loadImplicitImport();
159};
160
161QT_END_NAMESPACE
162
163#endif // QQMLTYPEDATA_P_H
164