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 flagsflags=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 ()
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 &flagsflags)
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)>

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 242 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 949 of file qqmljsimporter.cpp.

clearCache()

void QQmlJSImporter::clearCache

(

)

Definition at line 1221 of file qqmljsimporter.cpp.

flags()

QQmlJSImporterFlags QQmlJSImporter::flags ( ) const

inline

Definition at line 247 of file qqmljsimporter_p.h.

importDirectory()

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

Definition at line 1139 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 1133 of file qqmljsimporter.cpp.

importHardCodedBuiltins()

QQmlJSImporter::ImportedTypes QQmlJSImporter::importHardCodedBuiltins

(

)

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

Definition at line 829 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 919 of file qqmljsimporter.cpp.

importPaths()

QStringList QQmlJSImporter::importPaths ( ) const

inline

Definition at line 202 of file qqmljsimporter_p.h.

importQmldirs()

QList< QQmlJS::DiagnosticMessage > QQmlJSImporter::importQmldirs

(

const QStringList &

qmltypesFiles

)

Imports types from the specified qmltypesFiles.

Definition at line 878 of file qqmljsimporter.cpp.

jsGlobalObject()

QQmlJSScope::ConstPtr QQmlJSImporter::jsGlobalObject

(

)

Definition at line 1231 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 208 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 1157 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 1249 of file qqmljsimporter.cpp.

setFlags()

void QQmlJSImporter::setFlags ( const QQmlJSImporterFlags & flags )

inline

Definition at line 246 of file qqmljsimporter_p.h.

setImportPaths()

void QQmlJSImporter::setImportPaths

(

const QStringList &

importPaths

)

Definition at line 1207 of file qqmljsimporter.cpp.

setImportVisitor()

void QQmlJSImporter::setImportVisitor ( ImportVisitor visitor )

inline

Definition at line 245 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.

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:

• qtdeclarative/src/qmlcompiler/qqmljsimporter_p.h (912d9380c08092d7fe8c203661a7b9329e80c089)
• qtdeclarative/src/qmlcompiler/qqmljsimporter.cpp (764baa19b42b33e3e89474d3d55a57e7faa13974)