Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
QQmlJS::Dom::QmldirFile Class Referencefinal

#include <qqmldomexternalitems_p.h>

+ Inheritance diagram for QQmlJS::Dom::QmldirFile:
+ Collaboration diagram for QQmlJS::Dom::QmldirFile:

Public Member Functions

DomType kind () const override
 
 QmldirFile (const QString &filePath=QString(), const QString &code=QString(), const QDateTime &lastDataUpdateAt=QDateTime::fromMSecsSinceEpoch(0, QTimeZone::UTC), int derivedFrom=0)
 
 QmldirFile (const QmldirFile &o)=default
 
std::shared_ptr< QmldirFile > makeCopy (const DomItem &self) const
 
bool iterateDirectSubpaths (const DomItem &self, DirectVisitor visitor) const override
 
QmlUri uri () const
 
const QSet< int > & majorVersions () const &
 
const QMultiMap< QString, Export > & exports () const &
 
const QList< Import > & imports () const &
 
const QList< Path > & qmltypesFilePaths () const &
 
QMap< QString, QString > qmlFiles () const
 
bool designerSupported () const
 
QStringList classNames () const
 
QList< ModuleAutoExport > autoExports () const
 
void setAutoExports (const QList< ModuleAutoExport > &autoExport)
 
void ensureInModuleIndex (const DomItem &self, const QString &uri) const
 
- Public Member Functions inherited from QQmlJS::Dom::ExternalOwningItem
 ExternalOwningItem (const QString &filePath, const QDateTime &lastDataUpdateAt, const Path &pathFromTop, int derivedFrom=0, const QString &code=QString())
 
 ExternalOwningItem (const ExternalOwningItem &o)=default
 
QString canonicalFilePath (const DomItem &) const override
 
QString canonicalFilePath () const
 
Path canonicalPath (const DomItem &) const override
 
Path canonicalPath () const
 
bool iterateSubOwners (const DomItem &self, function_ref< bool(const DomItem &owner)> visitor) override
 
bool isValid () const
 
void setIsValid (bool val)
 
const QString & code () const
 
- Public Member Functions inherited from QQmlJS::Dom::OwningItem
 OwningItem (const OwningItem &o)
 
 OwningItem (int derivedFrom=0)
 
 OwningItem (int derivedFrom, const QDateTime &lastDataUpdateAt)
 
 OwningItem (const OwningItem &&)=delete
 
OwningItem & operator= (const OwningItem &&)=delete
 
std::shared_ptr< OwningItem > makeCopy (const DomItem &self) const
 
Path pathFromOwner () const
 
Path pathFromOwner (const DomItem &) const override final
 
DomItem containingObject (const DomItem &self) const override
 
int derivedFrom () const
 
virtual int revision () const
 
QDateTime createdAt () const
 
virtual QDateTime lastDataUpdateAt () const
 
virtual void refreshedDataAt (QDateTime tNew)
 
virtual bool frozen () const
 
virtual bool freeze ()
 
QDateTime frozenAt () const
 
virtual void addError (const DomItem &self, ErrorMessage &&msg)
 
void addErrorLocal (ErrorMessage &&msg)
 
void clearErrors (const ErrorGroups &groups=ErrorGroups({}))
 
bool iterateErrors (const DomItem &self, function_ref< bool(const DomItem &source, const ErrorMessage &msg)> visitor, const Path &inPath=Path())
 
QMultiMap< Path, ErrorMessage > localErrors () const
 
QBasicMutex * mutex () const
 
- Public Member Functions inherited from QQmlJS::Dom::DomBase
virtual ~DomBase ()=default
 
DomBase * domBase ()
 
const DomBase * domBase () const
 
virtual DomKind domKind () const
 
bool iterateDirectSubpathsConst (const DomItem &self, DirectVisitor) const
 
virtual void dump (const DomItem &, const Sink &sink, int indent, FilterT filter) const
 
virtual quintptr id () const
 
QString typeName () const
 
virtual QList< QString > fields (const DomItem &self) const
 
virtual DomItem field (const DomItem &self, QStringView name) const
 
virtual index_type indexes (const DomItem &self) const
 
virtual DomItem index (const DomItem &self, index_type index) const
 
virtual QSet< QString > const keys (const DomItem &self) const
 
virtual DomItem key (const DomItem &self, const QString &name) const
 
virtual void writeOut (const DomItem &self, OutWriter &lw) const
 
virtual QCborValue value () const
 

Static Public Member Functions

static ErrorGroups myParsingErrors ()
 
static std::shared_ptr< QmldirFile > fromPathAndCode (const QString &path, const QString &code)
 
- Static Public Member Functions inherited from QQmlJS::Dom::OwningItem
static int nextRevision ()
 

Static Public Attributes

static constexpr DomType kindValue = DomType::QmldirFile
 

Protected Member Functions

std::shared_ptr< OwningItem > doCopy (const DomItem &) const override
 

Additional Inherited Members

- Public Types inherited from QQmlJS::Dom::DomBase
using FilterT = function_ref<bool(const DomItem &, const PathEls::PathComponent &, const DomItem &)>
 
- Protected Attributes inherited from QQmlJS::Dom::ExternalOwningItem
QString m_canonicalFilePath
 
QString m_code
 
Path m_path
 
bool m_isValid = false
 

Detailed Description

Definition at line 143 of file qqmldomexternalitems_p.h.

Constructor & Destructor Documentation

◆ QmldirFile() [1/2]

QQmlJS::Dom::QmldirFile::QmldirFile ( const QString & filePath = QString(),
const QString & code = QString(),
const QDateTime & lastDataUpdateAt = QDateTime::fromMSecsSinceEpoch(0, QTimeZone::UTC),
int derivedFrom = 0 )
inline

Definition at line 159 of file qqmldomexternalitems_p.h.

◆ QmldirFile() [2/2]

QQmlJS::Dom::QmldirFile::QmldirFile ( const QmldirFile & o)
default

Member Function Documentation

◆ autoExports()

QList< ModuleAutoExport > QQmlJS::Dom::QmldirFile::autoExports ( ) const

Definition at line 207 of file qqmldomexternalitems.cpp.

◆ classNames()

QStringList QQmlJS::Dom::QmldirFile::classNames ( ) const
inline

Definition at line 192 of file qqmldomexternalitems_p.h.

Referenced by iterateDirectSubpaths().

+ Here is the caller graph for this function:

◆ designerSupported()

bool QQmlJS::Dom::QmldirFile::designerSupported ( ) const
inline

Definition at line 190 of file qqmldomexternalitems_p.h.

Referenced by iterateDirectSubpaths().

+ Here is the caller graph for this function:

◆ doCopy()

std::shared_ptr< OwningItem > QQmlJS::Dom::QmldirFile::doCopy ( const DomItem & ) const
inlineoverrideprotectedvirtual

Implements QQmlJS::Dom::OwningItem.

Definition at line 147 of file qqmldomexternalitems_p.h.

References copy().

+ Here is the call graph for this function:

◆ ensureInModuleIndex()

void QQmlJS::Dom::QmldirFile::ensureInModuleIndex ( const DomItem & self,
const QString & uri ) const

Definition at line 217 of file qqmldomexternalitems.cpp.

References QQmlJS::Dom::Normal, QQmlJS::Dom::DomItem::ownerAs(), uri(), and QQmlJS::Dom::Writable.

+ Here is the call graph for this function:

◆ exports()

const QMultiMap< QString, Export > & QQmlJS::Dom::QmldirFile::exports ( ) const &
inline

Definition at line 182 of file qqmldomexternalitems_p.h.

◆ fromPathAndCode()

std::shared_ptr< QmldirFile > QQmlJS::Dom::QmldirFile::fromPathAndCode ( const QString & path,
const QString & code )
static

Definition at line 66 of file qqmldomexternalitems.cpp.

References arg, QFileInfo::canonicalFilePath(), QQmlJS::Dom::ExternalOwningItem::canonicalFilePath(), QQmlJS::Dom::ExternalOwningItem::code(), QDateTime::currentDateTimeUtc(), error, QString::isEmpty(), myParsingErrors(), and tr.

+ Here is the call graph for this function:

◆ imports()

const QList< Import > & QQmlJS::Dom::QmldirFile::imports ( ) const &
inline

Definition at line 184 of file qqmldomexternalitems_p.h.

◆ iterateDirectSubpaths()

bool QQmlJS::Dom::QmldirFile::iterateDirectSubpaths ( const DomItem & self,
DirectVisitor visitor ) const
overridevirtual

Reimplemented from QQmlJS::Dom::ExternalOwningItem.

Definition at line 243 of file qqmldomexternalitems.cpp.

References classNames(), designerSupported(), QQmlJS::Dom::ExternalOwningItem::iterateDirectSubpaths(), list, map, QQmlJS::Dom::Map, qmlFiles(), QStringLiteral, QQmlJS::Dom::toString(), and uri().

+ Here is the call graph for this function:

◆ kind()

DomType QQmlJS::Dom::QmldirFile::kind ( ) const
inlineoverridevirtual

Implements QQmlJS::Dom::DomBase.

Definition at line 155 of file qqmldomexternalitems_p.h.

◆ majorVersions()

const QSet< int > & QQmlJS::Dom::QmldirFile::majorVersions ( ) const &
inline

Definition at line 180 of file qqmldomexternalitems_p.h.

◆ makeCopy()

std::shared_ptr< QmldirFile > QQmlJS::Dom::QmldirFile::makeCopy ( const DomItem & self) const
inline

Definition at line 171 of file qqmldomexternalitems_p.h.

◆ myParsingErrors()

ErrorGroups QQmlJS::Dom::QmldirFile::myParsingErrors ( )
static

Definition at line 59 of file qqmldomexternalitems.cpp.

References QQmlJS::Dom::DomItem::domErrorGroup, and NewErrorGroup.

Referenced by fromPathAndCode().

+ Here is the caller graph for this function:

◆ qmlFiles()

QMap< QString, QString > QQmlJS::Dom::QmldirFile::qmlFiles ( ) const

Definition at line 284 of file qqmldomexternalitems.cpp.

References QString::insert(), and QStringLiteral.

Referenced by iterateDirectSubpaths().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ qmltypesFilePaths()

const QList< Path > & QQmlJS::Dom::QmldirFile::qmltypesFilePaths ( ) const &
inline

Definition at line 186 of file qqmldomexternalitems_p.h.

◆ setAutoExports()

void QQmlJS::Dom::QmldirFile::setAutoExports ( const QList< ModuleAutoExport > & autoExport)

Definition at line 212 of file qqmldomexternalitems.cpp.

◆ uri()

QmlUri QQmlJS::Dom::QmldirFile::uri ( ) const
inline

Definition at line 178 of file qqmldomexternalitems_p.h.

Referenced by ensureInModuleIndex(), and iterateDirectSubpaths().

+ Here is the caller graph for this function:

Member Data Documentation

◆ kindValue

constexpr DomType QQmlJS::Dom::QmldirFile::kindValue = DomType::QmldirFile
staticconstexpr

Definition at line 154 of file qqmldomexternalitems_p.h.

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