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  ImportVisitorPrerequisites

Public Types

using ImportVisitor

Public Member Functions

 QQmlJSImporter (const QStringList &importPaths, QQmlJSResourceFileMapper *mapper, QQmlJSImporterFlags flags=QQmlJSImporterFlags{})
QQmlJSResourceFileMapper * resourceFileMapper () const
void setResourceFileMapper (QQmlJSResourceFileMapper *mapper)
QQmlJSResourceFileMapper * metaDataMapper () const
void setMetaDataMapper (QQmlJSResourceFileMapper *mapper)
ImportedTypes importHardCodedBuiltins ()
QList< QQmlJS::DiagnosticMessage > importQmldirs (const QStringList &qmltypesFiles)
 Imports types from the specified qmltypesFiles.
bool registerScope (const QQmlJSScope::Ptr &scope)
QQmlJSScope::Ptr importFile (const QString &file)
ImportedTypes importDirectory (const QString &directory, const QString &prefix=QString())
QHash< QString, QQmlJSScope::Ptr > importedFiles () const
ImportedTypes importModule (const QString &module, 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)

Friends

class QDeferredFactory< QQmlJSScope >

Detailed Description

Definition at line 73 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:171
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 202 of file qqmljsimporter_p.h.

Constructor & Destructor Documentation

◆ QQmlJSImporter()

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

Definition at line 171 of file qqmljsimporter.cpp.

Member Function Documentation

◆ builtinInternalNames()

QQmlJSImporter::ImportedTypes QQmlJSImporter::builtinInternalNames ( )

Definition at line 790 of file qqmljsimporter.cpp.

◆ clearCache()

void QQmlJSImporter::clearCache ( )

Definition at line 993 of file qqmljsimporter.cpp.

◆ importDirectory()

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

Definition at line 972 of file qqmljsimporter.cpp.

◆ importedFiles()

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

Definition at line 147 of file qqmljsimporter_p.h.

◆ importFile()

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

Definition at line 967 of file qqmljsimporter.cpp.

◆ importHardCodedBuiltins()

QQmlJSImporter::ImportedTypes QQmlJSImporter::importHardCodedBuiltins ( )

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

Definition at line 679 of file qqmljsimporter.cpp.

◆ importModule()

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

Definition at line 768 of file qqmljsimporter.cpp.

◆ importPaths()

QStringList QQmlJSImporter::importPaths ( ) const
inline

Definition at line 162 of file qqmljsimporter_p.h.

◆ importQmldirs()

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

Imports types from the specified qmltypesFiles.

Definition at line 727 of file qqmljsimporter.cpp.

◆ jsGlobalObject()

QQmlJSScope::ConstPtr QQmlJSImporter::jsGlobalObject ( )

Definition at line 1002 of file qqmljsimporter.cpp.

◆ metaDataMapper()

QQmlJSResourceFileMapper * QQmlJSImporter::metaDataMapper ( ) const
inline

Definition at line 136 of file qqmljsimporter_p.h.

◆ pathOfModule()

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

Definition at line 168 of file qqmljsimporter_p.h.

◆ registerScope()

bool QQmlJSImporter::registerScope ( const QQmlJSScope::Ptr & scope)

Add scopes manually created and QQmlJSImportVisited to QQmlJSImporter. This allows theses scopes to not get loaded twice during linting, for example.

Returns false if the importer contains a scope different than scope for the same QQmlJSScope::filePath.

Definition at line 956 of file qqmljsimporter.cpp.

◆ resourceFileMapper()

QQmlJSResourceFileMapper * QQmlJSImporter::resourceFileMapper ( ) const
inline

Definition at line 133 of file qqmljsimporter_p.h.

◆ runImportVisitor()

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

Definition at line 1020 of file qqmljsimporter.cpp.

◆ setImportPaths()

void QQmlJSImporter::setImportPaths ( const QStringList & importPaths)

Definition at line 982 of file qqmljsimporter.cpp.

◆ setImportVisitor()

void QQmlJSImporter::setImportVisitor ( ImportVisitor visitor)
inline

Definition at line 205 of file qqmljsimporter_p.h.

◆ setMetaDataMapper()

void QQmlJSImporter::setMetaDataMapper ( QQmlJSResourceFileMapper * mapper)
inline

Definition at line 137 of file qqmljsimporter_p.h.

◆ setResourceFileMapper()

void QQmlJSImporter::setResourceFileMapper ( QQmlJSResourceFileMapper * mapper)
inline

Definition at line 134 of file qqmljsimporter_p.h.

◆ takeGlobalWarnings()

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

Definition at line 155 of file qqmljsimporter_p.h.

◆ QDeferredFactory< QQmlJSScope >

friend class QDeferredFactory< QQmlJSScope >
friend

Definition at line 205 of file qqmljsimporter_p.h.

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