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
QQmlJS::Dom::DomBase Class Referenceabstract

#include <qqmldomitem_p.h>

Inheritance diagram for QQmlJS::Dom::DomBase:
Collaboration diagram for QQmlJS::Dom::DomBase:

Public Types

using FilterT = function_ref<bool(const DomItem &, const PathEls::PathComponent &, const DomItem &)>

Public Member Functions

virtual ~DomBase ()=default
DomBase * domBase ()
const DomBase * domBase () const
virtual DomType kind () const =0
virtual DomKind domKind () const
virtual Path pathFromOwner () const =0
virtual Path canonicalPath (const DomItem &self) const =0
virtual bool iterateDirectSubpaths (const DomItem &self, DirectVisitor visitor) const =0
virtual DomItem containingObject (const DomItem &self) 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 QString canonicalFilePath (const DomItem &self) const
virtual void writeOut (const DomItem &self, OutWriter &lw) const
virtual QCborValue value () const

Detailed Description

Definition at line 201 of file qqmldomitem_p.h.

Member Typedef Documentation

◆ FilterT

using QQmlJS::Dom::DomBase::FilterT = function_ref<bool(const DomItem &, const PathEls::PathComponent &, const DomItem &)>

Definition at line 204 of file qqmldomitem_p.h.

Constructor & Destructor Documentation

◆ ~DomBase()

virtual QQmlJS::Dom::DomBase::~DomBase ( )
virtualdefault

Member Function Documentation

◆ canonicalFilePath()

QString QQmlJS::Dom::DomBase::canonicalFilePath ( const DomItem & self) const
virtual

Reimplemented in QQmlJS::Dom::ExternalItemInfoBase, QQmlJS::Dom::ExternalItemPairBase, and QQmlJS::Dom::ExternalOwningItem.

Definition at line 232 of file qqmldomitem.cpp.

References containingObject().

Here is the call graph for this function:

◆ canonicalPath()

virtual Path QQmlJS::Dom::DomBase::canonicalPath ( const DomItem & self) const
pure virtual

Implemented in QQmlJS::Dom::AstComments, QQmlJS::Dom::DomElement, QQmlJS::Dom::DomEnvironment, QQmlJS::Dom::DomTop, QQmlJS::Dom::DomUniverse, QQmlJS::Dom::Empty, QQmlJS::Dom::ExternalItemInfoBase, QQmlJS::Dom::ExternalItemPairBase, QQmlJS::Dom::ExternalOwningItem, QQmlJS::Dom::FileLocations::Node, QQmlJS::Dom::LoadInfo, QQmlJS::Dom::MockOwner, QQmlJS::Dom::ModuleIndex, QQmlJS::Dom::ModuleScope, QQmlJS::Dom::OwningItem, and QQmlJS::Dom::ScriptExpression.

Referenced by containingObject().

Here is the caller graph for this function:

◆ containingObject()

DomItem QQmlJS::Dom::DomBase::containingObject ( const DomItem & self) const
inlinevirtual

Reimplemented in QQmlJS::Dom::DomElement, QQmlJS::Dom::DomTop, QQmlJS::Dom::Empty, and QQmlJS::Dom::OwningItem.

Definition at line 2169 of file qqmldomitem_p.h.

References canonicalPath(), QQmlJS::Dom::DomItem::owner(), QQmlJS::Dom::DomItem::path(), pathFromOwner(), and QQmlJS::Dom::Path::split().

Referenced by canonicalFilePath(), and QQmlJS::Dom::DomElement::containingObject().

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

◆ domBase() [1/2]

DomBase * QQmlJS::Dom::DomBase::domBase ( )
inline

Definition at line 208 of file qqmldomitem_p.h.

◆ domBase() [2/2]

const DomBase * QQmlJS::Dom::DomBase::domBase ( ) const
inline

Definition at line 209 of file qqmldomitem_p.h.

◆ domKind()

DomKind QQmlJS::Dom::DomBase::domKind ( ) const
inlinevirtual

Reimplemented in QQmlJS::Dom::ConstantData, QQmlJS::Dom::ScriptElements::ScriptElementBase< type >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::List >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptBinaryExpression >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptBlockStatement >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptForStatement >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptGenericElement >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptIdentifierExpression >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptIfStatement >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptLiteral >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptReturnStatement >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptVariableDeclaration >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptVariableDeclarationEntry >, and QQmlJS::Dom::SimpleObjectWrapBase.

Definition at line 2164 of file qqmldomitem_p.h.

◆ dump()

void QQmlJS::Dom::DomBase::dump ( const DomItem & ,
const Sink & sink,
int indent,
FilterT filter ) const
virtual

Definition at line 2572 of file qqmldomitem.cpp.

References QQmlJS::Dom::DomItem::canonicalPath(), QQmlJS::Dom::PathEls::Field, QQmlJS::Dom::PathEls::Index, QQmlJS::Dom::DomItem::isCanonicalChild(), QQmlJS::Dom::PathEls::Key, QQmlJS::Dom::PathEls::PathComponent::kind(), and QQmlJS::Dom::NoOuterQuotes.

Here is the call graph for this function:

◆ field()

DomItem QQmlJS::Dom::DomBase::field ( const DomItem & self,
QStringView name ) const
inlinevirtual

Reimplemented in QQmlJS::Dom::Component, QQmlJS::Dom::DomEnvironment, QQmlJS::Dom::ExternalItemInfoBase, QQmlJS::Dom::ExternalItemPairBase, QQmlJS::Dom::QmlFile, QQmlJS::Dom::QmlObject, and QQmlJS::Dom::Reference.

Definition at line 2202 of file qqmldomitem_p.h.

References QQmlJS::Dom::PathEls::Field, and QQmlJS::Dom::PathEls::PathComponent::kind().

Here is the call graph for this function:

◆ fields()

QList< QString > QQmlJS::Dom::DomBase::fields ( const DomItem & self) const
inlinevirtual

Reimplemented in QQmlJS::Dom::QmlObject, and QQmlJS::Dom::Reference.

Definition at line 2191 of file qqmldomitem_p.h.

References QQmlJS::Dom::PathEls::Field, and QQmlJS::Dom::PathEls::PathComponent::kind().

Here is the call graph for this function:

◆ id()

quintptr QQmlJS::Dom::DomBase::id ( ) const
inlinevirtual

Reimplemented in QQmlJS::Dom::ConstantData, QQmlJS::Dom::Empty, QQmlJS::Dom::List, QQmlJS::Dom::ListPBase, QQmlJS::Dom::Map, QQmlJS::Dom::Reference, and QQmlJS::Dom::SimpleObjectWrapBase.

Definition at line 2181 of file qqmldomitem_p.h.

◆ index()

DomItem QQmlJS::Dom::DomBase::index ( const DomItem & self,
index_type index ) const
inlinevirtual

Reimplemented in QQmlJS::Dom::List, QQmlJS::Dom::ListPT< T >, and QQmlJS::Dom::Reference.

Definition at line 2230 of file qqmldomitem_p.h.

References QQmlJS::Dom::PathEls::Index, and QQmlJS::Dom::PathEls::PathComponent::kind().

Here is the call graph for this function:

◆ indexes()

index_type QQmlJS::Dom::DomBase::indexes ( const DomItem & self) const
inlinevirtual

Reimplemented in QQmlJS::Dom::List, QQmlJS::Dom::ListPBase, and QQmlJS::Dom::Reference.

Definition at line 2216 of file qqmldomitem_p.h.

References QQmlJS::Dom::PathEls::Index, and QQmlJS::Dom::PathEls::PathComponent::kind().

Here is the call graph for this function:

◆ iterateDirectSubpaths()

virtual bool QQmlJS::Dom::DomBase::iterateDirectSubpaths ( const DomItem & self,
DirectVisitor visitor ) const
pure virtual

Implemented in QQmlJS::Dom::AstComments, QQmlJS::Dom::CommentableDomElement, QQmlJS::Dom::Component, QQmlJS::Dom::ConstantData, QQmlJS::Dom::DomEnvironment, QQmlJS::Dom::DomTop, QQmlJS::Dom::DomUniverse, QQmlJS::Dom::Empty, QQmlJS::Dom::EnumDecl, QQmlJS::Dom::ExternalItemInfoBase, QQmlJS::Dom::ExternalItemPairBase, QQmlJS::Dom::ExternalOwningItem, QQmlJS::Dom::FileLocations::Node, QQmlJS::Dom::GlobalScope, QQmlJS::Dom::JsFile, QQmlJS::Dom::JsResource, QQmlJS::Dom::List, QQmlJS::Dom::ListPBase, QQmlJS::Dom::ListPT< T >, QQmlJS::Dom::LoadInfo, QQmlJS::Dom::Map, QQmlJS::Dom::MockObject, QQmlJS::Dom::MockOwner, QQmlJS::Dom::ModuleIndex, QQmlJS::Dom::ModuleScope, QQmlJS::Dom::OwningItem, QQmlJS::Dom::QmlComponent, QQmlJS::Dom::QmlDirectory, QQmlJS::Dom::QmldirFile, QQmlJS::Dom::QmlFile, QQmlJS::Dom::QmlObject, QQmlJS::Dom::QmltypesComponent, QQmlJS::Dom::QmltypesFile, QQmlJS::Dom::Reference, QQmlJS::Dom::ScriptElements::BinaryExpression, QQmlJS::Dom::ScriptElements::BlockStatement, QQmlJS::Dom::ScriptElements::ForStatement, QQmlJS::Dom::ScriptElements::GenericScriptElement, QQmlJS::Dom::ScriptElements::IdentifierExpression, QQmlJS::Dom::ScriptElements::IfStatement, QQmlJS::Dom::ScriptElements::Literal, QQmlJS::Dom::ScriptElements::ReturnStatement, QQmlJS::Dom::ScriptElements::ScriptList, QQmlJS::Dom::ScriptElements::VariableDeclaration, QQmlJS::Dom::ScriptElements::VariableDeclarationEntry, QQmlJS::Dom::ScriptExpression, QQmlJS::Dom::SimpleObjectWrapBase, and QQmlJS::Dom::SimpleObjectWrapT< T >.

◆ key()

DomItem QQmlJS::Dom::DomBase::key ( const DomItem & self,
const QString & name ) const
inlinevirtual

Reimplemented in QQmlJS::Dom::Map, and QQmlJS::Dom::Reference.

Definition at line 2255 of file qqmldomitem_p.h.

References QQmlJS::Dom::PathEls::Key, and QQmlJS::Dom::PathEls::PathComponent::kind().

Here is the call graph for this function:

◆ keys()

QSet< QString > const QQmlJS::Dom::DomBase::keys ( const DomItem & self) const
inlinevirtual

Reimplemented in QQmlJS::Dom::Map, and QQmlJS::Dom::Reference.

Definition at line 2244 of file qqmldomitem_p.h.

References QQmlJS::Dom::PathEls::Key, and QQmlJS::Dom::PathEls::PathComponent::kind().

Here is the call graph for this function:

◆ kind()

virtual DomType QQmlJS::Dom::DomBase::kind ( ) const
pure virtual

Implemented in QQmlJS::Dom::AstComments, QQmlJS::Dom::ConstantData, QQmlJS::Dom::DomEnvironment, QQmlJS::Dom::DomUniverse, QQmlJS::Dom::Empty, QQmlJS::Dom::EnumDecl, QQmlJS::Dom::ExternalItemInfoBase, QQmlJS::Dom::ExternalItemPairBase, QQmlJS::Dom::FileLocations::Node, QQmlJS::Dom::GlobalComponent, QQmlJS::Dom::GlobalScope, QQmlJS::Dom::JsFile, QQmlJS::Dom::JsResource, QQmlJS::Dom::List, QQmlJS::Dom::ListPBase, QQmlJS::Dom::LoadInfo, QQmlJS::Dom::Map, QQmlJS::Dom::MockObject, QQmlJS::Dom::MockOwner, QQmlJS::Dom::ModuleIndex, QQmlJS::Dom::ModuleScope, QQmlJS::Dom::QmlComponent, QQmlJS::Dom::QmlDirectory, QQmlJS::Dom::QmldirFile, QQmlJS::Dom::QmlFile, QQmlJS::Dom::QmlObject, QQmlJS::Dom::QmltypesComponent, QQmlJS::Dom::QmltypesFile, QQmlJS::Dom::Reference, QQmlJS::Dom::ScriptElements::GenericScriptElement, QQmlJS::Dom::ScriptElements::ScriptElementBase< type >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::List >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptBinaryExpression >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptBlockStatement >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptForStatement >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptGenericElement >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptIdentifierExpression >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptIfStatement >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptLiteral >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptReturnStatement >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptVariableDeclaration >, QQmlJS::Dom::ScriptElements::ScriptElementBase< DomType::ScriptVariableDeclarationEntry >, QQmlJS::Dom::ScriptExpression, and QQmlJS::Dom::SimpleObjectWrapBase.

◆ pathFromOwner()

virtual Path QQmlJS::Dom::DomBase::pathFromOwner ( ) const
pure virtual

Implemented in QQmlJS::Dom::DomElement, QQmlJS::Dom::Empty, QQmlJS::Dom::ModuleScope, and QQmlJS::Dom::OwningItem.

Referenced by containingObject().

Here is the caller graph for this function:

◆ typeName()

QString QQmlJS::Dom::DomBase::typeName ( ) const
inline

Definition at line 2186 of file qqmldomitem_p.h.

◆ value()

virtual QCborValue QQmlJS::Dom::DomBase::value ( ) const
inlinevirtual

Reimplemented in QQmlJS::Dom::ConstantData, QQmlJS::Dom::ScriptElements::GenericScriptElement, QQmlJS::Dom::ScriptElements::IdentifierExpression, and QQmlJS::Dom::ScriptElements::Literal.

Definition at line 240 of file qqmldomitem_p.h.

◆ writeOut()

void QQmlJS::Dom::DomBase::writeOut ( const DomItem & self,
OutWriter & lw ) const
virtual

Reimplemented in QQmlJS::Dom::EnumDecl, QQmlJS::Dom::JsFile, QQmlJS::Dom::List, QQmlJS::Dom::ListPBase, QQmlJS::Dom::QmlComponent, QQmlJS::Dom::QmlFile, QQmlJS::Dom::QmlObject, QQmlJS::Dom::ScriptExpression, and QQmlJS::Dom::SimpleObjectWrapT< T >.

Definition at line 240 of file qqmldomitem.cpp.

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