1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#ifndef QQMLJSIMPORTER_P_H
#define QQMLJSIMPORTER_P_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
#include <qtqmlcompilerexports.h>
#include "qqmljscontextualtypes_p.h"
#include "qqmljsscope_p.h"
#include "qqmljsresourcefilemapper_p.h"
#include <QtQml/private/qqmldirparser_p.h>
#include <QtQml/private/qqmljsast_p.h>
#include <memory>
QT_BEGIN_NAMESPACE
namespace QQmlJS {
class Import
{
public:
Import() = default;
Import(QString prefix, QString name, QTypeRevision version, bool isFile, bool isDependency);
bool isValid() const;
QString prefix() const { return m_prefix; }
QString name() const { return m_name; }
QTypeRevision version() const { return m_version; }
bool isFile() const { return m_isFile; }
bool isDependency() const { return m_isDependency; }
private:
QString m_prefix;
QString m_name;
QTypeRevision m_version;
bool m_isFile = false;
bool m_isDependency = false;
friend inline size_t qHash(const Import &key, size_t seed = 0) noexcept
{
return qHashMulti(seed, key.m_prefix, key.m_name, key.m_version,
key.m_isFile, key.m_isDependency);
}
friend inline bool operator==(const Import &a, const Import &b)
{
return a.m_prefix == b.m_prefix && a.m_name == b.m_name && a.m_version == b.m_version
&& a.m_isFile == b.m_isFile && a.m_isDependency == b.m_isDependency;
}
};
}
class QQmlJSImportVisitor;
class QQmlJSLogger;
class Q_QMLCOMPILER_EXPORT QQmlJSImporter
{
public:
using ImportedTypes = QQmlJS::ContextualTypes;
QQmlJSImporter(const QStringList &importPaths, QQmlJSResourceFileMapper *mapper,
bool useOptionalImports = false);
QQmlJSResourceFileMapper *resourceFileMapper() const { return m_mapper; }
void setResourceFileMapper(QQmlJSResourceFileMapper *mapper) { m_mapper = mapper; }
QQmlJSResourceFileMapper *metaDataMapper() const { return m_metaDataMapper; }
void setMetaDataMapper(QQmlJSResourceFileMapper *mapper) { m_metaDataMapper = mapper; }
ImportedTypes importBuiltins();
void importQmldirs(const QStringList &qmltypesFiles);
QQmlJSScope::Ptr importFile(const QString &file);
ImportedTypes importDirectory(const QString &directory, const QString &prefix = QString());
// ### qmltc needs this. once re-written, we no longer need to expose this
QHash<QString, QQmlJSScope::Ptr> importedFiles() const { return m_importedFiles; }
ImportedTypes importModule(const QString &module, const QString &prefix = QString(),
QTypeRevision version = QTypeRevision(),
QStringList *staticModuleList = nullptr);
ImportedTypes builtinInternalNames();
QList<QQmlJS::DiagnosticMessage> takeWarnings()
{
const auto result = std::move(m_warnings);
m_warnings.clear();
return result;
}
QList<QQmlJS::DiagnosticMessage> takeGlobalWarnings()
{
const auto result = std::move(m_globalWarnings);
m_globalWarnings.clear();
return result;
}
QStringList importPaths() const { return m_importPaths; }
void setImportPaths(const QStringList &importPaths);
void clearCache();
QQmlJSScope::ConstPtr jsGlobalObject() const;
struct ImportVisitorPrerequisites
{
ImportVisitorPrerequisites(QQmlJSScope::Ptr target, QQmlJSLogger *logger,
const QString &implicitImportDirectory = {},
const QStringList &qmldirFiles = {})
: m_target(target),
m_logger(logger),
m_implicitImportDirectory(implicitImportDirectory),
m_qmldirFiles(qmldirFiles)
{
Q_ASSERT(target && logger);
}
QQmlJSScope::Ptr m_target;
QQmlJSLogger *m_logger;
QString m_implicitImportDirectory;
QStringList m_qmldirFiles;
};
void runImportVisitor(QQmlJS::AST::Node *rootNode,
const ImportVisitorPrerequisites &prerequisites);
/*!
\internal
When a qml file gets lazily loaded, it will be lexed and parsed and finally be constructed
via an ImportVisitor. By default, this is done via the QQmlJSImportVisitor, but can also be done
via other import visitors like QmltcVisitor, which is used by qmltc to compile a QML file, or
QQmlDomAstCreatorWithQQmlJSScope, which is used to construct the Dom of lazily loaded QML files.
*/
using ImportVisitor = std::function<void(QQmlJS::AST::Node *rootNode, QQmlJSImporter *self,
const ImportVisitorPrerequisites &prerequisites)>;
void setImportVisitor(ImportVisitor visitor) { m_importVisitor = visitor; }
private:
friend class QDeferredFactory<QQmlJSScope>;
struct AvailableTypes
{
AvailableTypes(ImportedTypes builtins)
: cppNames(std::move(builtins))
, qmlNames(QQmlJS::ContextualTypes::QML, {}, cppNames.arrayType())
{
}
// C++ names used in qmltypes files for non-composite types
ImportedTypes cppNames;
// Names the importing component sees, including any prefixes
ImportedTypes qmlNames;
// Static modules included here
QStringList staticModules;
// Whether a system module has been imported
bool hasSystemModule = false;
};
struct Import {
QString name;
bool isStaticModule = false;
bool isSystemModule = false;
QList<QQmlJSExportedScope> objects;
QHash<QString, QQmlJSExportedScope> scripts;
QList<QQmlDirParser::Import> imports;
QList<QQmlDirParser::Import> dependencies;
};
AvailableTypes builtinImportHelper();
bool importHelper(const QString &module, AvailableTypes *types,
const QString &prefix = QString(), QTypeRevision version = QTypeRevision(),
bool isDependency = false, bool isFile = false);
void processImport(const QQmlJS::Import &importDescription, const Import &import,
AvailableTypes *types);
void importDependencies(const QQmlJSImporter::Import &import, AvailableTypes *types,
const QString &prefix = QString(),
QTypeRevision version = QTypeRevision(), bool isDependency = false);
QQmlDirParser createQmldirParserForFile(const QString &filename);
void readQmltypes(const QString &filename, QList<QQmlJSExportedScope> *objects,
QList<QQmlDirParser::Import> *dependencies);
Import readQmldir(const QString &dirname);
Import readDirectory(const QString &directory);
QQmlJSScope::Ptr localFile2ScopeTree(const QString &filePath);
static void setQualifiedNamesOn(const Import &import);
QStringList m_importPaths;
QHash<QPair<QString, QTypeRevision>, QString> m_seenImports;
QHash<QQmlJS::Import, QSharedPointer<AvailableTypes>> m_cachedImportTypes;
QHash<QString, Import> m_seenQmldirFiles;
QHash<QString, QQmlJSScope::Ptr> m_importedFiles;
QList<QQmlJS::DiagnosticMessage> m_globalWarnings;
QList<QQmlJS::DiagnosticMessage> m_warnings;
std::optional<AvailableTypes> m_builtins;
QQmlJSResourceFileMapper *m_mapper = nullptr;
QQmlJSResourceFileMapper *m_metaDataMapper = nullptr;
bool m_useOptionalImports;
ImportVisitor m_importVisitor;
};
QT_END_NAMESPACE
#endif // QQMLJSIMPORTER_P_H
|
