Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQmlJSImporter Class Reference

#include <qqmljsimporter_p.h>

Collaboration diagram for QQmlJSImporter:

Classes

struct  ImportedTypes
struct  VersionedImport
struct  ImportVisitorPrerequisites

Public Types

using ImportVisitor

Public Member Functions

void registerVersionedImports (const ImportedTypes &imported)
QList< VersionedImport > versionedImports (const QString &filePath) const
 QQmlJSImporter (const QStringList &importPaths, QQmlJSResourceFileMapper *mapper, QQmlJSImporterFlags flags=QQmlJSImporterFlags{})
const QQmlJSResourceFileMapper * resourceFileMapper () const
void setResourceFileMapper (const QQmlJSResourceFileMapper *mapper)
QQmlJSResourceFileMapper * metaDataMapper () const
void setMetaDataMapper (QQmlJSResourceFileMapper *mapper)
ImportedTypes importHardCodedBuiltins ()
QList< QQmlJS::DiagnosticMessage > importQmldirs (const QStringList &qmltypesFiles)
 Imports types from the specified qmltypesFiles.
QQmlJSScope::Ptr importFile (const QString &file)
ImportedTypes importDirectory (const QString &directory, quint8 precedence, const QString &prefix=QString())
QHash< QString, QQmlJSScope::Ptr > importedFiles () const
ImportedTypes importModule (const QString &module, quint8 precedence, const QString &prefix=QString(), QTypeRevision version=QTypeRevision(), QStringList *staticModuleList=nullptr)
ImportedTypes builtinInternalNames ()
QList< QQmlJS::DiagnosticMessage > takeGlobalWarnings ()
QStringList importPaths () const
void setImportPaths (const QStringList &importPaths)
void clearCache ()
QQmlJSScope::ConstPtr jsGlobalObject ()
QString pathOfModule (const QString &moduleName, QTypeRevision revision) const
void runImportVisitor (QQmlJS::AST::Node *rootNode, const ImportVisitorPrerequisites &prerequisites)
void setImportVisitor (ImportVisitor visitor)
void setFlags (const QQmlJSImporterFlags &flags)
QQmlJSImporterFlags flags () const

Static Public Attributes

static constexpr QLatin1String s_inProcessMarker = QLatin1String("$InProcess$")

Detailed Description

Definition at line 75 of file qqmljsimporter_p.h.

Member Typedef Documentation

◆ ImportVisitor

using QQmlJSImporter::ImportVisitor
Initial value:
std::function<void(QQmlJS::AST::Node *rootNode, QQmlJSImporter *self,
const ImportVisitorPrerequisites &prerequisites)>
QQmlJSImporter::QQmlJSImporter
QQmlJSImporter(const QStringList &importPaths, QQmlJSResourceFileMapper *mapper, QQmlJSImporterFlags flags=QQmlJSImporterFlags{})
Definition qqmljsimporter.cpp:194
self
return self
Definition qcocoawindow.mm:53
void
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char return DBusMessage dbus_bool_t return DBusMessage dbus_uint32_t return DBusMessage void
Definition qdbus_symbols_p.h:410

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.

Definition at line 249 of file qqmljsimporter_p.h.

Constructor & Destructor Documentation

◆ QQmlJSImporter()

QQmlJSImporter::QQmlJSImporter ( const QStringList & importPaths,
QQmlJSResourceFileMapper * mapper,
QQmlJSImporterFlags flags = QQmlJSImporterFlags{} )

Definition at line 194 of file qqmljsimporter.cpp.

Member Function Documentation

◆ builtinInternalNames()

QQmlJSImporter::ImportedTypes QQmlJSImporter::builtinInternalNames ( )

Definition at line 879 of file qqmljsimporter.cpp.

◆ clearCache()

void QQmlJSImporter::clearCache ( )

Definition at line 1125 of file qqmljsimporter.cpp.

◆ flags()

QQmlJSImporterFlags QQmlJSImporter::flags ( ) const
inline

Definition at line 254 of file qqmljsimporter_p.h.

◆ importDirectory()

QQmlJSImporter::ImportedTypes QQmlJSImporter::importDirectory ( const QString & directory,
quint8 precedence,
const QString & prefix = QString() )

Definition at line 1044 of file qqmljsimporter.cpp.

◆ importedFiles()

QHash< QString, QQmlJSScope::Ptr > QQmlJSImporter::importedFiles ( ) const
inline

Definition at line 193 of file qqmljsimporter_p.h.

◆ importFile()

QQmlJSScope::Ptr QQmlJSImporter::importFile ( const QString & file)

Definition at line 1038 of file qqmljsimporter.cpp.

◆ importHardCodedBuiltins()

QQmlJSImporter::ImportedTypes QQmlJSImporter::importHardCodedBuiltins ( )

Imports builtins, but only the subset hardcoded into the parser.

Definition at line 766 of file qqmljsimporter.cpp.

◆ importModule()

QQmlJSImporter::ImportedTypes QQmlJSImporter::importModule ( const QString & module,
quint8 precedence,
const QString & prefix = QString(),
QTypeRevision version = QTypeRevision(),
QStringList * staticModuleList = nullptr )

Definition at line 856 of file qqmljsimporter.cpp.

◆ importPaths()

QStringList QQmlJSImporter::importPaths ( ) const
inline

Definition at line 209 of file qqmljsimporter_p.h.

◆ importQmldirs()

QList< QQmlJS::DiagnosticMessage > QQmlJSImporter::importQmldirs ( const QStringList & qmltypesFiles)

Imports types from the specified qmltypesFiles.

Definition at line 815 of file qqmljsimporter.cpp.

◆ jsGlobalObject()

QQmlJSScope::ConstPtr QQmlJSImporter::jsGlobalObject ( )

Definition at line 1135 of file qqmljsimporter.cpp.

◆ metaDataMapper()

QQmlJSResourceFileMapper * QQmlJSImporter::metaDataMapper ( ) const
inline

Definition at line 182 of file qqmljsimporter_p.h.

◆ pathOfModule()

QString QQmlJSImporter::pathOfModule ( const QString & moduleName,
QTypeRevision revision ) const
inline

Definition at line 215 of file qqmljsimporter_p.h.

◆ registerVersionedImports()

void QQmlJSImporter::registerVersionedImports ( const ImportedTypes & imported)

Records through which module imports the types in imported are visible, so that they can later be found again by name at run time. Only call this for the imports a document actually has. Directory imports are recorded with the module of the qmldir file in the directory and an invalid version, like the QML engine does.

Definition at line 1061 of file qqmljsimporter.cpp.

◆ resourceFileMapper()

const QQmlJSResourceFileMapper * QQmlJSImporter::resourceFileMapper ( ) const
inline

Definition at line 179 of file qqmljsimporter_p.h.

◆ runImportVisitor()

void QQmlJSImporter::runImportVisitor ( QQmlJS::AST::Node * rootNode,
const ImportVisitorPrerequisites & prerequisites )

Definition at line 1153 of file qqmljsimporter.cpp.

◆ setFlags()

void QQmlJSImporter::setFlags ( const QQmlJSImporterFlags & flags)
inline

Definition at line 253 of file qqmljsimporter_p.h.

◆ setImportPaths()

void QQmlJSImporter::setImportPaths ( const QStringList & importPaths)

Definition at line 1111 of file qqmljsimporter.cpp.

◆ setImportVisitor()

void QQmlJSImporter::setImportVisitor ( ImportVisitor visitor)
inline

Definition at line 252 of file qqmljsimporter_p.h.

◆ setMetaDataMapper()

void QQmlJSImporter::setMetaDataMapper ( QQmlJSResourceFileMapper * mapper)
inline

Definition at line 183 of file qqmljsimporter_p.h.

◆ setResourceFileMapper()

void QQmlJSImporter::setResourceFileMapper ( const QQmlJSResourceFileMapper * mapper)
inline

Definition at line 180 of file qqmljsimporter_p.h.

◆ takeGlobalWarnings()

QList< QQmlJS::DiagnosticMessage > QQmlJSImporter::takeGlobalWarnings ( )
inline

Definition at line 202 of file qqmljsimporter_p.h.

◆ versionedImports()

QList< VersionedImport > QQmlJSImporter::versionedImports ( const QString & filePath) const
inline

Definition at line 171 of file qqmljsimporter_p.h.

Member Data Documentation

◆ s_inProcessMarker

QLatin1String QQmlJSImporter::s_inProcessMarker = QLatin1String("$InProcess$")
inlinestaticconstexpr

Definition at line 86 of file qqmljsimporter_p.h.

The documentation for this class was generated from the following files: