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
QQmlTypeLoader Class Reference

The QQmlTypeLoader class abstracts loading files and their dependencies over the network. More...

#include <qqmltypeloader_p.h>

Collaboration diagram for QQmlTypeLoader:

Classes

class  Blob

Public Types

enum  Mode { PreferSynchronous , Asynchronous , Synchronous }
enum  AddPathMode { PrependPath , AppendPath }
using ChecksumCache = QQmlTypeLoaderThreadData::ChecksumCache

Public Member Functions

 QQmlTypeLoader (QV4::ExecutionEngine *engine)
 Constructs a new type loader that uses the given engine.
 ~QQmlTypeLoader ()
 Destroys the type loader, first clearing the cache of any information about loaded files.
template<typename TypeReference>
QByteArray hashDependencies (QV4::CompiledData::ResolvedTypeReferenceMap *resolvedTypeCache, const QList< TypeReference > &compositeSingletons)
QQmlRefPointer< QQmlTypeData > getType (const QUrl &unNormalizedUrl, Mode modemode=PreferSynchronous)
 Returns a QQmlTypeData for the specified url.
QQmlRefPointer< QQmlTypeData > getType (const QByteArray &datadata, const QUrl &url, Mode modemode=PreferSynchronous)
 Returns a QQmlTypeData for the given data with the provided base url.
QQmlRefPointer< QQmlScriptBlob > getScript (const QUrl &unNormalizedUrl, Mode modemode=PreferSynchronous)
QQmlRefPointer< QV4::CompiledData::CompilationUnit > injectModule (const QUrl &relativeUrl, const QV4::CompiledData::Unit *unit)
QQmlRefPointer< QQmlScriptBlob > getScript (const QUrl &unNormalizedUrl, const QUrl &relativeUrl)
 Return a QQmlScriptBlob for unNormalizedUrl or relativeUrl.
QQmlRefPointer< QQmlQmldirData > getQmldir (const QUrl &)
 Returns a QQmlQmldirData for url.
QString cleanFilePath (const QString &pathpath) const
 Returns the clean filename of path via a directory cache.
bool fileExists (const QString &filePath) const
bool fileExists (const QString &dirPath, const QString &file) const
bool directoryExists (const QString &pathpath) const
 Returns true if the path is a directory via a directory cache.
const QQmlTypeLoaderQmldirContent qmldirContent (const QString &filePath)
void setQmldirContent (const QString &filePath, const QString &content)
void clearCache ()
 Clears cached information about loaded files, including any type data, scripts and qmldir information.
void trimCache ()
bool removeFromCache (const QUrl &url)
bool isTypeLoaded (const QUrl &url) const
bool isScriptLoaded (const QUrl &url) const
void loadWithStaticData (const QQmlDataBlob::Ptr &blob, const QByteArray &datadata, Mode modemode=PreferSynchronous)
 Load the provided blob with data.
void drop (const QQmlDataBlob::Ptr &blob)
void initializeEngine (QQmlEngineExtensionInterface *, const char *)
void initializeEngine (QQmlExtensionInterface *, const char *)
void invalidate ()
void addUrlInterceptor (QQmlAbstractUrlInterceptor *urlInterceptor)
void removeUrlInterceptor (QQmlAbstractUrlInterceptor *urlInterceptor)
QList< QQmlAbstractUrlInterceptor * > urlInterceptors () const
QUrl interceptUrl (const QUrl &url, QQmlAbstractUrlInterceptor::DataType typetype) const
bool hasUrlInterceptors () const
quintptr profiler () const
void setProfiler (quintptr)
QStringList importPathList () const
void setImportPathList (const QStringList &pathspaths)
void addImportPath (const QString &dir, AddPathMode modemode)
QStringList pluginPathList () const
void setPluginPathList (const QStringList &pathspaths)
void addPluginPath (const QString &pathpath, AddPathMode modemode)
void setPluginInitialized (const QString &plugin)
bool isPluginInitialized (const QString &plugin) const
void setModulePluginProcessingDone (const QString &module)
bool isModulePluginProcessingDone (const QString &module)
bool writeCacheFile ()
bool readCacheFile ()
bool isDebugging ()

Static Public Member Functions

template<typename Engine, typename EnginePrivate = QQmlEnginePrivate, typename = std::enable_if_t<std::is_base_of_v<QJSEngine, Engine>>>
static QQmlTypeLoader * get (Engine *engine)
template<typename Engine, typename = std::enable_if_t<std::is_base_of_v<QJSEnginePrivate, Engine>>>
static QQmlTypeLoader * get (Engine *engine)
static void sanitizeUNCPath (QString *pathpath)
static bool isResource (const QString &pathpath)

Friends

struct PlainLoader
struct CachedLoader
struct StaticLoader
class QQmlDataBlob
class QQmlTypeLoaderThread

Detailed Description

The QQmlTypeLoader class abstracts loading files and their dependencies over the network.

The QQmlTypeLoader class is provided for the exclusive use of the QQmlTypeLoader class.

Clients create QQmlDataBlob instances and submit them to the QQmlTypeLoader class through the QQmlTypeLoader::load() or QQmlTypeLoader::loadWithStaticData() methods. The loader then fetches the data over the network or from the local file system in an efficient way. QQmlDataBlob is an abstract class, so should always be specialized.

Once data is received, the QQmlDataBlob::dataReceived() method is invoked on the blob. The derived class should use this callback to process the received data. Processing of the data can result in an error being set (QQmlDataBlob::setError()), or one or more dependencies being created (QQmlDataBlob::addDependency()). Dependencies are other QQmlDataBlob's that are required before processing can fully complete.

To complete processing, the QQmlDataBlob::done() callback is invoked. done() is called when one of these three preconditions are met.

\list 1

Thus QQmlDataBlob::done() will always eventually be called, even if the blob has an error set.

Definition at line 46 of file qqmltypeloader_p.h.

Member Typedef Documentation

◆ ChecksumCache

using QQmlTypeLoader::ChecksumCache = QQmlTypeLoaderThreadData::ChecksumCache

Definition at line 50 of file qqmltypeloader_p.h.

Member Enumeration Documentation

◆ AddPathMode

enum QQmlTypeLoader::AddPathMode
Enumerator
PrependPath 
AppendPath 

Definition at line 259 of file qqmltypeloader_p.h.

◆ Mode

enum QQmlTypeLoader::Mode
Enumerator
PreferSynchronous 
Asynchronous 
Synchronous 

Definition at line 51 of file qqmltypeloader_p.h.

Constructor & Destructor Documentation

◆ QQmlTypeLoader()

QQmlTypeLoader::QQmlTypeLoader ( QV4::ExecutionEngine * engine)

Constructs a new type loader that uses the given engine.

Definition at line 1284 of file qqmltypeloader.cpp.

◆ ~QQmlTypeLoader()

QQmlTypeLoader::~QQmlTypeLoader ( )

Destroys the type loader, first clearing the cache of any information about loaded files.

Definition at line 1341 of file qqmltypeloader.cpp.

Member Function Documentation

◆ addImportPath()

void QQmlTypeLoader::addImportPath ( const QString & path,
AddPathMode mode )

Definition at line 562 of file qqmltypeloader.cpp.

◆ addPluginPath()

void QQmlTypeLoader::addPluginPath ( const QString & path,
AddPathMode mode )

Definition at line 635 of file qqmltypeloader.cpp.

◆ addUrlInterceptor()

void QQmlTypeLoader::addUrlInterceptor ( QQmlAbstractUrlInterceptor * urlInterceptor)

Definition at line 90 of file qqmltypeloader.cpp.

◆ cleanFilePath()

QString QQmlTypeLoader::cleanFilePath ( const QString & path) const

Returns the clean filename of path via a directory cache.

Returns a empty string if the path does not exist.

Why a directory cache? QML checks for files in many paths with invalid directories. By caching whether a directory exists we avoid many stats. We also cache the files' existence in the directory, for the same reason.

Definition at line 1562 of file qqmltypeloader.cpp.

◆ clearCache()

void QQmlTypeLoader::clearCache ( )

Clears cached information about loaded files, including any type data, scripts and qmldir information.

Definition at line 1745 of file qqmltypeloader.cpp.

Referenced by QQmlPreviewServiceImpl::messageReceived().

Here is the caller graph for this function:

◆ directoryExists()

bool QQmlTypeLoader::directoryExists ( const QString & path) const

Returns true if the path is a directory via a directory cache.

Cache is shared with cleanFilePath().

Definition at line 1628 of file qqmltypeloader.cpp.

◆ drop()

void QQmlTypeLoader::drop ( const QQmlDataBlob::Ptr & blob)

Definition at line 267 of file qqmltypeloader.cpp.

◆ fileExists() [1/2]

bool QQmlTypeLoader::fileExists ( const QString & dirPath,
const QString & file ) const

Definition at line 1591 of file qqmltypeloader.cpp.

◆ fileExists() [2/2]

bool QQmlTypeLoader::fileExists ( const QString & filePath) const
inline

Definition at line 210 of file qqmltypeloader_p.h.

◆ get() [1/2]

template<typename Engine, typename = std::enable_if_t<std::is_base_of_v<QJSEnginePrivate, Engine>>>
QQmlTypeLoader * QQmlTypeLoader::get ( Engine * engine)
inlinestatic

Definition at line 160 of file qqmltypeloader_p.h.

◆ get() [2/2]

template<typename Engine, typename EnginePrivate = QQmlEnginePrivate, typename = std::enable_if_t<std::is_base_of_v<QJSEngine, Engine>>>
QQmlTypeLoader * QQmlTypeLoader::get ( Engine * engine)
inlinestatic

Definition at line 152 of file qqmltypeloader_p.h.

◆ getQmldir()

QQmlRefPointer< QQmlQmldirData > QQmlTypeLoader::getQmldir ( const QUrl & url)

Returns a QQmlQmldirData for url.

The QQmlQmldirData may be cached.

Definition at line 1519 of file qqmltypeloader.cpp.

◆ getScript() [1/2]

QQmlRefPointer< QQmlScriptBlob > QQmlTypeLoader::getScript ( const QUrl & unNormalizedUrl,
const QUrl & relativeUrl )

Return a QQmlScriptBlob for unNormalizedUrl or relativeUrl.

This assumes PreferSynchronous, and therefore the result may not be ready yet.

Definition at line 1482 of file qqmltypeloader.cpp.

◆ getScript() [2/2]

QQmlRefPointer< QQmlScriptBlob > QQmlTypeLoader::getScript ( const QUrl & unNormalizedUrl,
Mode mode = PreferSynchronous )

Definition at line 1433 of file qqmltypeloader.cpp.

◆ getType() [1/2]

QQmlRefPointer< QQmlTypeData > QQmlTypeLoader::getType ( const QByteArray & data,
const QUrl & url,
Mode mode = PreferSynchronous )

Returns a QQmlTypeData for the given data with the provided base url.

The QQmlTypeData will not be cached.

Definition at line 1418 of file qqmltypeloader.cpp.

◆ getType() [2/2]

QQmlRefPointer< QQmlTypeData > QQmlTypeLoader::getType ( const QUrl & unNormalizedUrl,
Mode mode = PreferSynchronous )

Returns a QQmlTypeData for the specified url.

The QQmlTypeData may be cached.

Definition at line 1384 of file qqmltypeloader.cpp.

◆ hashDependencies()

template<typename TypeReference>
QByteArray QQmlTypeLoader::hashDependencies ( QV4::CompiledData::ResolvedTypeReferenceMap * resolvedTypeCache,
const QList< TypeReference > & compositeSingletons )
inline

Definition at line 180 of file qqmltypeloader_p.h.

◆ hasUrlInterceptors()

bool QQmlTypeLoader::hasUrlInterceptors ( ) const

Definition at line 129 of file qqmltypeloader.cpp.

◆ importPathList()

QStringList QQmlTypeLoader::importPathList ( ) const
inline

Definition at line 261 of file qqmltypeloader_p.h.

◆ initializeEngine() [1/2]

void QQmlTypeLoader::initializeEngine ( QQmlEngineExtensionInterface * iface,
const char * uri )

Definition at line 429 of file qqmltypeloader.cpp.

◆ initializeEngine() [2/2]

void QQmlTypeLoader::initializeEngine ( QQmlExtensionInterface * iface,
const char * uri )

Definition at line 435 of file qqmltypeloader.cpp.

◆ injectModule()

QQmlRefPointer< QV4::CompiledData::CompilationUnit > QQmlTypeLoader::injectModule ( const QUrl & relativeUrl,
const QV4::CompiledData::Unit * unit )

Definition at line 1459 of file qqmltypeloader.cpp.

◆ interceptUrl()

QUrl QQmlTypeLoader::interceptUrl ( const QUrl & url,
QQmlAbstractUrlInterceptor::DataType type ) const

Definition at line 121 of file qqmltypeloader.cpp.

◆ invalidate()

void QQmlTypeLoader::invalidate ( )

Definition at line 75 of file qqmltypeloader.cpp.

◆ isDebugging()

bool QQmlTypeLoader::isDebugging ( )

Definition at line 1223 of file qqmltypeloader.cpp.

◆ isModulePluginProcessingDone()

bool QQmlTypeLoader::isModulePluginProcessingDone ( const QString & module)
inline

Definition at line 293 of file qqmltypeloader_p.h.

◆ isPluginInitialized()

bool QQmlTypeLoader::isPluginInitialized ( const QString & plugin) const
inline

Definition at line 282 of file qqmltypeloader_p.h.

◆ isResource()

bool QQmlTypeLoader::isResource ( const QString & path)
static

Definition at line 1542 of file qqmltypeloader.cpp.

◆ isScriptLoaded()

bool QQmlTypeLoader::isScriptLoaded ( const QUrl & url) const

Definition at line 1863 of file qqmltypeloader.cpp.

◆ isTypeLoaded()

bool QQmlTypeLoader::isTypeLoaded ( const QUrl & url) const

Definition at line 1857 of file qqmltypeloader.cpp.

◆ loadWithStaticData()

void QQmlTypeLoader::loadWithStaticData ( const QQmlDataBlob::Ptr & blob,
const QByteArray & data,
Mode mode = PreferSynchronous )

Load the provided blob with data.

The blob's URL is not used by the data loader in this case.

The loader must be locked.

Definition at line 253 of file qqmltypeloader.cpp.

◆ pluginPathList()

QStringList QQmlTypeLoader::pluginPathList ( ) const
inline

Definition at line 269 of file qqmltypeloader_p.h.

◆ profiler()

quintptr QQmlTypeLoader::profiler ( ) const
inline

Definition at line 248 of file qqmltypeloader_p.h.

◆ qmldirContent()

const QQmlTypeLoaderQmldirContent QQmlTypeLoader::qmldirContent ( const QString & filePathIn)

Return a QQmlTypeLoaderQmldirContent for filePathIn. The QQmlTypeLoaderQmldirContent may be cached.

It can also be a remote path for a remote directory import, but it will have been cached by now in this case.

Definition at line 1659 of file qqmltypeloader.cpp.

◆ readCacheFile()

bool QQmlTypeLoader::readCacheFile ( )

Definition at line 1228 of file qqmltypeloader.cpp.

◆ removeFromCache()

bool QQmlTypeLoader::removeFromCache ( const QUrl & url)

Remove any cached artifacts for url.

Returns true if anything was removed, or false otherwise.

Definition at line 1777 of file qqmltypeloader.cpp.

◆ removeUrlInterceptor()

void QQmlTypeLoader::removeUrlInterceptor ( QQmlAbstractUrlInterceptor * urlInterceptor)

Definition at line 97 of file qqmltypeloader.cpp.

◆ sanitizeUNCPath()

void QQmlTypeLoader::sanitizeUNCPath ( QString * path)
inlinestatic

Definition at line 165 of file qqmltypeloader_p.h.

◆ setImportPathList()

void QQmlTypeLoader::setImportPathList ( const QStringList & paths)

Definition at line 608 of file qqmltypeloader.cpp.

◆ setModulePluginProcessingDone()

void QQmlTypeLoader::setModulePluginProcessingDone ( const QString & module)
inline

Definition at line 288 of file qqmltypeloader_p.h.

◆ setPluginInitialized()

void QQmlTypeLoader::setPluginInitialized ( const QString & plugin)
inline

Definition at line 277 of file qqmltypeloader_p.h.

◆ setPluginPathList()

void QQmlTypeLoader::setPluginPathList ( const QStringList & paths)

Definition at line 625 of file qqmltypeloader.cpp.

◆ setProfiler()

void QQmlTypeLoader::setProfiler ( quintptr )
inline

Definition at line 249 of file qqmltypeloader_p.h.

◆ setQmldirContent()

void QQmlTypeLoader::setQmldirContent ( const QString & filePath,
const QString & content )

Definition at line 1714 of file qqmltypeloader.cpp.

◆ trimCache()

void QQmlTypeLoader::trimCache ( )

Definition at line 1785 of file qqmltypeloader.cpp.

◆ urlInterceptors()

QList< QQmlAbstractUrlInterceptor * > QQmlTypeLoader::urlInterceptors ( ) const

Definition at line 104 of file qqmltypeloader.cpp.

◆ writeCacheFile()

bool QQmlTypeLoader::writeCacheFile ( )

Definition at line 1233 of file qqmltypeloader.cpp.

◆ CachedLoader

friend struct CachedLoader
friend

Definition at line 313 of file qqmltypeloader_p.h.

◆ PlainLoader

friend struct PlainLoader
friend

Definition at line 312 of file qqmltypeloader_p.h.

◆ QQmlDataBlob

friend class QQmlDataBlob
friend

Definition at line 316 of file qqmltypeloader_p.h.

◆ QQmlTypeLoaderThread

friend class QQmlTypeLoaderThread
friend

Definition at line 317 of file qqmltypeloader_p.h.

◆ StaticLoader

friend struct StaticLoader
friend

Definition at line 314 of file qqmltypeloader_p.h.

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