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

#include <qqmlscriptblob_p.h>

Inheritance diagram for QQmlScriptBlob:
Collaboration diagram for QQmlScriptBlob:

Classes

struct  ScriptReference

Public Types

enum class  IsESModule { No , Yes }
Public Types inherited from QQmlTypeLoader::Blob
using PendingImportPtr = std::shared_ptr<PendingImport>
Public Types inherited from QQmlDataBlob
enum  Status {
  Null , Loading , WaitingForDependencies , ResolvingDependencies ,
  Complete , Error
}
 This enum describes the status of the data blob. More...
enum  Type { QmlFile = QQmlAbstractUrlInterceptor::QmlFile , JavaScriptFile = QQmlAbstractUrlInterceptor::JavaScriptFile , QmldirFile = QQmlAbstractUrlInterceptor::QmldirFile }
 This enum describes the type of the data blob. More...
using Ptr = QQmlRefPointer<QQmlDataBlob>

Public Member Functions

 QQmlScriptBlob (const QUrl &url, QQmlTypeLoader *typeLoader, IsESModule isESModule)
 ~QQmlScriptBlob () override
QQmlRefPointer< QQmlScriptData > scriptData () const
Public Member Functions inherited from QQmlNotifyingBlob
 QQmlNotifyingBlob (const QUrl &url, QQmlDataBlob::Type type, QQmlTypeLoader *loader)
void registerCallback (Callback *callback)
void unregisterCallback (Callback *callback)
Public Member Functions inherited from QQmlTypeLoader::Blob
 Blob (const QUrl &url, QQmlDataBlob::Type type, QQmlTypeLoader *loader)
 ~Blob () override
const QQmlImports * imports () const
void setCachedUnitStatus (QQmlMetaType::CachedUnitLookupError status)
void importQmldirScripts (const PendingImportPtr &import, const QQmlTypeLoaderQmldirContent &qmldir, const QUrl &qmldirUrl)
bool handleLocalQmldirForImport (const PendingImportPtr &import, const QString &qmldirFilePath, const QString &qmldirUrl, QList< QQmlError > *errors)
Public Member Functions inherited from QQmlDataBlob
 QQmlDataBlob (const QUrl &, Type, QQmlTypeLoader *manager)
 Create a new QQmlDataBlob for url and of the provided type.
virtual ~QQmlDataBlob ()
void startLoading ()
 Must be called before loading can occur.
QQmlTypeLoader * typeLoader () const
void resetTypeLoader ()
Type type () const
 Returns the type provided to the constructor.
Status status () const
 Returns the blob's status.
bool isNull () const
 Returns true if the status is Null.
bool isLoading () const
 Returns true if the status is Loading.
bool isWaiting () const
 Returns true if the status is WaitingForDependencies.
bool isComplete () const
 Returns true if the status is Complete.
bool isError () const
 Returns true if the status is Error.
bool isCompleteOrError () const
 Returns true if the status is Complete or Error.
bool isAsync () const
qreal progress () const
 Returns the data download progress from 0 to 1.
QUrl url () const
 Returns the physical url of the data.
QString urlString () const
QUrl finalUrl () const
 Returns the logical URL to be used for resolving further URLs referred to in the code.
QString finalUrlString () const
 Returns the finalUrl() as a string.
QList< QQmlError > errors () const
 Return the errors on this blob.
template<typename Loader = QQmlTypeLoader>
void assertTypeLoaderThreadIfRunning () const
template<typename Loader = QQmlTypeLoader>
void assertTypeLoaderThread () const
template<typename Loader = QQmlTypeLoader>
void assertEngineThreadIfRunning () const
template<typename Loader = QQmlTypeLoader>
void assertEngineThread () const
Public Member Functions inherited from QQmlRefCounted< QQmlDataBlob >
void release () const
Public Member Functions inherited from QQmlRefCount
 QQmlRefCount ()
void addref () const
int count () const

Protected Member Functions

void dataReceived (const SourceCodeData &) override
 Invoked when data for the blob is received.
void initializeFromCachedUnit (const QQmlPrivate::CachedQmlUnit *unit) override
void done () override
 Invoked once data has either been received or a network error occurred, and all dependencies are complete.
QString stringAt (int index) const override
Protected Member Functions inherited from QQmlNotifyingBlob
void completed () override
 Invoked on the main thread sometime after done() was called on the load thread.
void downloadProgressChanged (qreal) override
 Called when the download progress of this blob changes.
Protected Member Functions inherited from QQmlTypeLoader::Blob
bool addImport (const QV4::CompiledData::Import *import, QQmlImports::ImportFlags, QList< QQmlError > *errors)
bool addImport (const PendingImportPtr &import, QList< QQmlError > *errors)
bool fetchQmldir (const QUrl &url, const PendingImportPtr &import, int priority, QList< QQmlError > *errors)
bool updateQmldir (const QQmlRefPointer< QQmlQmldirData > &data, const PendingImportPtr &import, QList< QQmlError > *errors)
bool registerPendingTypes (const PendingImportPtr &import)
bool loadDependentImports (const QList< QQmlDirParser::Import > &imports, const QString &qualifier, QTypeRevision version, quint8 precedence, QQmlImports::ImportFlags flags, QList< QQmlError > *errors)
Protected Member Functions inherited from QQmlDataBlob
void setError (const QQmlError &)
 Mark this blob as having errors.
void setError (const QList< QQmlError > &errors)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
void setError (const QQmlJS::DiagnosticMessage &error)
void setError (const QString &description)
void addDependency (const QQmlDataBlob::Ptr &)
 Wait for blob to become complete or to error.
virtual void dependencyError (const QQmlDataBlob::Ptr &)
 Called if blob, which was previously waited for, has an error.
virtual void allDependenciesDone ()
 Called when all blobs waited for have completed.
Protected Member Functions inherited from QQmlRefCounted< QQmlDataBlob >
 ~QQmlRefCounted ()

Private Member Functions

void scriptImported (const QQmlRefPointer< QQmlScriptBlob > &blob, const QV4::CompiledData::Location &location, const QString &qualifier, const QString &nameSpace) override

Friends

class QQmlTypeLoader

Additional Inherited Members

Protected Attributes inherited from QQmlTypeLoader::Blob
QQmlRefPointer< QQmlImports > m_importCache
QVector< PendingImportPtr > m_unresolvedImports
QVector< QQmlRefPointer< QQmlQmldirData > > m_qmldirs
QQmlMetaType::CachedUnitLookupError m_cachedUnitStatus = QQmlMetaType::CachedUnitLookupError::NoError
Protected Attributes inherited from QQmlDataBlob
QQmlTypeLoader * m_typeLoader
QList< QQmlDataBlob * > m_waitingOnMe

Detailed Description

Definition at line 25 of file qqmlscriptblob_p.h.

Member Enumeration Documentation

◆ IsESModule

enum class QQmlScriptBlob::IsESModule
strong
Enumerator
No 
Yes 

Definition at line 31 of file qqmlscriptblob_p.h.

Constructor & Destructor Documentation

◆ QQmlScriptBlob()

QT_BEGIN_NAMESPACE QQmlScriptBlob::QQmlScriptBlob ( const QUrl & url,
QQmlTypeLoader * typeLoader,
IsESModule isESModule )

Definition at line 18 of file qqmlscriptblob.cpp.

◆ ~QQmlScriptBlob()

QQmlScriptBlob::~QQmlScriptBlob ( )
override

Definition at line 24 of file qqmlscriptblob.cpp.

Member Function Documentation

◆ dataReceived()

void QQmlScriptBlob::dataReceived ( const SourceCodeData & )
overrideprotectedvirtual

Invoked when data for the blob is received.

Implementors should use this callback to determine a blob's dependencies. Within this callback you may call setError() or addDependency().

Implements QQmlDataBlob.

Definition at line 28 of file qqmlscriptblob.cpp.

◆ done()

void QQmlScriptBlob::done ( )
overrideprotectedvirtual

Invoked once data has either been received or a network error occurred, and all dependencies are complete.

You can set an error in this method, but you cannot add new dependencies. Implementors should use this callback to finalize processing of data.

The default implementation does nothing.

XXX Rename processData() or some such to avoid confusion between done() (processing thread) and completed() (main thread)

Reimplemented from QQmlDataBlob.

Definition at line 131 of file qqmlscriptblob.cpp.

◆ initializeFromCachedUnit()

void QQmlScriptBlob::initializeFromCachedUnit ( const QQmlPrivate::CachedQmlUnit * unit)
overrideprotectedvirtual

Implements QQmlDataBlob.

Definition at line 124 of file qqmlscriptblob.cpp.

◆ scriptData()

QQmlRefPointer< QQmlScriptData > QQmlScriptBlob::scriptData ( ) const
inline

Definition at line 43 of file qqmlscriptblob_p.h.

◆ scriptImported()

void QQmlScriptBlob::scriptImported ( const QQmlRefPointer< QQmlScriptBlob > & blob,
const QV4::CompiledData::Location & location,
const QString & qualifier,
const QString & nameSpace )
overrideprivatevirtual

Reimplemented from QQmlTypeLoader::Blob.

Definition at line 195 of file qqmlscriptblob.cpp.

◆ stringAt()

QString QQmlScriptBlob::stringAt ( int index) const
overrideprotectedvirtual

Reimplemented from QQmlTypeLoader::Blob.

Definition at line 190 of file qqmlscriptblob.cpp.

◆ QQmlTypeLoader

friend class QQmlTypeLoader
friend

Definition at line 28 of file qqmlscriptblob_p.h.

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