Qt 6.x
The Qt SDK
Loading...
Searching...
No Matches
QQmlJS::Dom::QmlFile Class Referencefinal

#include <qqmldomexternalitems_p.h>

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

Public Member Functions

DomType kind () const override
 
 QmlFile (const QmlFile &o)
 
 QmlFile (QString filePath=QString(), QString code=QString(), QDateTime lastDataUpdate=QDateTime::fromMSecsSinceEpoch(0, QTimeZone::UTC), int derivedFrom=0)
 
bool iterateDirectSubpaths (DomItem &self, DirectVisitor) override
 
DomItem field (DomItem &self, QStringView name) const override
 
DomItem field (DomItem &self, QStringView name)
 
std::shared_ptr< QmlFilemakeCopy (DomItem &self) const
 
void addError (DomItem &self, ErrorMessage msg) override
 
const QMultiMap< QString, QmlComponent > & components () const &
 
void setComponents (const QMultiMap< QString, QmlComponent > &components)
 
Path addComponent (const QmlComponent &component, AddOption option=AddOption::Overwrite, QmlComponent **cPtr=nullptr)
 
void writeOut (DomItem &self, OutWriter &lw) const override
 
AST::UiProgramast () const
 
const QList< Import > & imports () const &
 
void setImports (const QList< Import > &imports)
 
Path addImport (const Import &i)
 
std::shared_ptr< QQmlJS::Engineengine () const
 
RegionCommentscomments ()
 
std::shared_ptr< AstCommentsastComments () const
 
void setAstComments (std::shared_ptr< AstComments > comm)
 
FileLocations::Tree fileLocationsTree () const
 
void setFileLocationsTree (FileLocations::Tree v)
 
const QList< Pragma > & pragmas () const &
 
void setPragmas (QList< Pragma > pragmas)
 
Path addPragma (const Pragma &pragma)
 
ImportScopeimportScope ()
 
const ImportScopeimportScope () const
 
std::optional< std::shared_ptr< QQmlJSTypeResolver > > typeResolver () const
 
void setTypeResolver (const std::shared_ptr< QQmlJSTypeResolver > &typeResolver)
 
- Public Member Functions inherited from QQmlJS::Dom::ExternalOwningItem
 ExternalOwningItem (QString filePath, QDateTime lastDataUpdateAt, Path pathFromTop, int derivedFrom=0, QString code=QString())
 
 ExternalOwningItem (const ExternalOwningItem &o)=default
 
QString canonicalFilePath (DomItem &) const override
 
QString canonicalFilePath () const
 
Path canonicalPath (DomItem &) const override
 
Path canonicalPath () const
 
bool iterateDirectSubpaths (DomItem &self, DirectVisitor visitor) override
 
bool iterateSubOwners (DomItem &self, function_ref< bool(DomItem &owner)> visitor) override
 
bool isValid () const
 
void setIsValid (bool val)
 
const QStringcode () const
 
- Public Member Functions inherited from QQmlJS::Dom::OwningItem
 OwningItem (const OwningItem &o)
 
 OwningItem (int derivedFrom=0)
 
 OwningItem (int derivedFrom, QDateTime lastDataUpdateAt)
 
 OwningItem (const OwningItem &&)=delete
 
OwningItemoperator= (const OwningItem &&)=delete
 
Path canonicalPath (DomItem &self) const override=0
 
bool iterateDirectSubpaths (DomItem &self, DirectVisitor) override
 
std::shared_ptr< OwningItemmakeCopy (DomItem &self) const
 
Path pathFromOwner () const
 
Path pathFromOwner (DomItem &) const override final
 
DomItem containingObject (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 (DomItem &self, ErrorMessage msg)
 
void addErrorLocal (ErrorMessage msg)
 
void clearErrors (ErrorGroups groups=ErrorGroups({}))
 
bool iterateErrors (DomItem &self, function_ref< bool(DomItem source, ErrorMessage msg)> visitor, Path inPath=Path())
 
QMultiMap< Path, ErrorMessagelocalErrors () const
 
virtual bool iterateSubOwners (DomItem &self, function_ref< bool(DomItem &owner)> visitor)
 
QBasicMutexmutex () const
 
- Public Member Functions inherited from QQmlJS::Dom::DomBase
virtual ~DomBase ()=default
 
DomBasedomBase ()
 
virtual DomType kind () const =0
 
virtual DomKind domKind () const
 
virtual Path pathFromOwner (DomItem &self) const =0
 
virtual Path canonicalPath (DomItem &self) const =0
 
virtual bool iterateDirectSubpaths (DomItem &self, DirectVisitor visitor)=0
 
bool iterateDirectSubpathsConst (DomItem &self, DirectVisitor) const
 
virtual DomItem containingObject (DomItem &self) const
 
virtual void dump (DomItem &, Sink sink, int indent, FilterT filter) const
 
virtual quintptr id () const
 
QString typeName () const
 
virtual QList< QStringfields (DomItem &self) const
 
virtual DomItem field (DomItem &self, QStringView name) const
 
virtual index_type indexes (DomItem &self) const
 
virtual DomItem index (DomItem &self, index_type index) const
 
virtual QSet< QString > const keys (DomItem &self) const
 
virtual DomItem key (DomItem &self, QString name) const
 
virtual QString canonicalFilePath (DomItem &self) const
 
virtual void writeOut (DomItem &self, OutWriter &lw) const
 
virtual QCborValue value () const
 

Static Public Member Functions

static ErrorGroups myParsingErrors ()
 
- Static Public Member Functions inherited from QQmlJS::Dom::OwningItem
static int nextRevision ()
 

Static Public Attributes

static constexpr DomType kindValue = DomType::QmlFile
 

Protected Member Functions

std::shared_ptr< OwningItemdoCopy (DomItem &self) const override
 
virtual std::shared_ptr< OwningItemdoCopy (DomItem &self) const =0
 

Friends

class QQmlDomAstCreator
 

Additional Inherited Members

- Public Types inherited from QQmlJS::Dom::DomBase
using FilterT = function_ref< bool(DomItem &, const PathEls::PathComponent &, 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 242 of file qqmldomexternalitems_p.h.

Constructor & Destructor Documentation

◆ QmlFile() [1/2]

QQmlJS::Dom::QmlFile::QmlFile ( const QmlFile o)

Definition at line 298 of file qqmldomexternalitems.cpp.

◆ QmlFile() [2/2]

QQmlJS::Dom::QmlFile::QmlFile ( QString  filePath = QString(),
QString  code = QString(),
QDateTime  lastDataUpdate = QDateTime::fromMSecsSinceEpoch(0, QTimeZone::UTC),
int  derivedFrom = 0 
)

Member Function Documentation

◆ addComponent()

Path QQmlJS::Dom::QmlFile::addComponent ( const QmlComponent component,
AddOption  option = AddOption::Overwrite,
QmlComponent **  cPtr = nullptr 
)
inline

Definition at line 274 of file qqmldomexternalitems_p.h.

References component(), QChar::fromLatin1(), and QQmlJS::Dom::insertUpdatableElementInMultiMap().

+ Here is the call graph for this function:

◆ addError()

void QQmlJS::Dom::QmlFile::addError ( DomItem self,
ErrorMessage  msg 
)
overridevirtual

Reimplemented from QQmlJS::Dom::OwningItem.

Definition at line 357 of file qqmldomexternalitems.cpp.

◆ addImport()

Path QQmlJS::Dom::QmlFile::addImport ( const Import i)
inline

Definition at line 291 of file qqmldomexternalitems_p.h.

References QChar::fromLatin1(), and i.

+ Here is the call graph for this function:

◆ addPragma()

Path QQmlJS::Dom::QmlFile::addPragma ( const Pragma pragma)
inline

Definition at line 318 of file qqmldomexternalitems_p.h.

References QQmlJS::Dom::Path::index().

+ Here is the call graph for this function:

◆ ast()

AST::UiProgram * QQmlJS::Dom::QmlFile::ast ( ) const
inline

Definition at line 285 of file qqmldomexternalitems_p.h.

◆ astComments()

std::shared_ptr< AstComments > QQmlJS::Dom::QmlFile::astComments ( ) const
inline

Definition at line 312 of file qqmldomexternalitems_p.h.

◆ comments()

RegionComments & QQmlJS::Dom::QmlFile::comments ( )
inline

Definition at line 311 of file qqmldomexternalitems_p.h.

◆ components()

const QMultiMap< QString, QmlComponent > & QQmlJS::Dom::QmlFile::components ( ) const &
inline

Definition at line 269 of file qqmldomexternalitems_p.h.

◆ doCopy()

std::shared_ptr< OwningItem > QQmlJS::Dom::QmlFile::doCopy ( DomItem self) const
overrideprotectedvirtual

Implements QQmlJS::Dom::OwningItem.

Definition at line 292 of file qqmldomexternalitems.cpp.

◆ engine()

std::shared_ptr< QQmlJS::Engine > QQmlJS::Dom::QmlFile::engine ( ) const
inline

Definition at line 310 of file qqmldomexternalitems_p.h.

◆ field() [1/2]

DomItem QQmlJS::Dom::QmlFile::field ( DomItem self,
QStringView  name 
)

Definition at line 350 of file qqmldomexternalitems.cpp.

References QQmlJS::Dom::DomBase::field().

+ Here is the call graph for this function:

◆ field() [2/2]

DomItem QQmlJS::Dom::QmlFile::field ( DomItem self,
QStringView  name 
) const
inlineoverridevirtual

Reimplemented from QQmlJS::Dom::DomBase.

Definition at line 258 of file qqmldomexternalitems_p.h.

◆ fileLocationsTree()

FileLocations::Tree QQmlJS::Dom::QmlFile::fileLocationsTree ( ) const
inline

Definition at line 314 of file qqmldomexternalitems_p.h.

◆ imports()

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

Definition at line 289 of file qqmldomexternalitems_p.h.

◆ importScope() [1/2]

ImportScope & QQmlJS::Dom::QmlFile::importScope ( )
inline

Definition at line 324 of file qqmldomexternalitems_p.h.

◆ importScope() [2/2]

const ImportScope & QQmlJS::Dom::QmlFile::importScope ( ) const
inline

Definition at line 325 of file qqmldomexternalitems_p.h.

◆ iterateDirectSubpaths()

bool QQmlJS::Dom::QmlFile::iterateDirectSubpaths ( DomItem self,
DirectVisitor  visitor 
)
overridevirtual

Reimplemented from QQmlJS::Dom::ExternalOwningItem.

Definition at line 337 of file qqmldomexternalitems.cpp.

References QQmlJS::Dom::ExternalOwningItem::iterateDirectSubpaths().

+ Here is the call graph for this function:

◆ kind()

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

Implements QQmlJS::Dom::DomBase.

Definition at line 249 of file qqmldomexternalitems_p.h.

◆ makeCopy()

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

Definition at line 263 of file qqmldomexternalitems_p.h.

◆ myParsingErrors()

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

Definition at line 330 of file qqmldomexternalitems.cpp.

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

Referenced by QmlFile().

+ Here is the caller graph for this function:

◆ pragmas()

const QList< Pragma > & QQmlJS::Dom::QmlFile::pragmas ( ) const &
inline

Definition at line 316 of file qqmldomexternalitems_p.h.

◆ setAstComments()

void QQmlJS::Dom::QmlFile::setAstComments ( std::shared_ptr< AstComments comm)
inline

Definition at line 313 of file qqmldomexternalitems_p.h.

◆ setComponents()

void QQmlJS::Dom::QmlFile::setComponents ( const QMultiMap< QString, QmlComponent > &  components)
inline

Definition at line 270 of file qqmldomexternalitems_p.h.

◆ setFileLocationsTree()

void QQmlJS::Dom::QmlFile::setFileLocationsTree ( FileLocations::Tree  v)
inline

Definition at line 315 of file qqmldomexternalitems_p.h.

◆ setImports()

void QQmlJS::Dom::QmlFile::setImports ( const QList< Import > &  imports)
inline

Definition at line 290 of file qqmldomexternalitems_p.h.

◆ setPragmas()

void QQmlJS::Dom::QmlFile::setPragmas ( QList< Pragma pragmas)
inline

Definition at line 317 of file qqmldomexternalitems_p.h.

◆ setTypeResolver()

void QQmlJS::Dom::QmlFile::setTypeResolver ( const std::shared_ptr< QQmlJSTypeResolver > &  typeResolver)
inline

Definition at line 331 of file qqmldomexternalitems_p.h.

◆ typeResolver()

std::optional< std::shared_ptr< QQmlJSTypeResolver > > QQmlJS::Dom::QmlFile::typeResolver ( ) const
inline

Definition at line 327 of file qqmldomexternalitems_p.h.

◆ writeOut()

void QQmlJS::Dom::QmlFile::writeOut ( DomItem self,
OutWriter lw 
) const
overridevirtual

Reimplemented from QQmlJS::Dom::DomBase.

Definition at line 362 of file qqmldomexternalitems.cpp.

References QQmlJS::Dom::OutWriter::ensureNewline(), i, and QQmlJS::Dom::DomItem::writeOut().

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ QQmlDomAstCreator

friend class QQmlDomAstCreator
friend

Definition at line 337 of file qqmldomexternalitems_p.h.

Member Data Documentation

◆ kindValue

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

Definition at line 248 of file qqmldomexternalitems_p.h.


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