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::AstRangesVisitor Class Referencefinal
Inheritance diagram for QQmlJS::Dom::AstRangesVisitor:
Collaboration diagram for QQmlJS::Dom::AstRangesVisitor:

Public Member Functions

 AstRangesVisitor ()=default
void addNodeRanges (AST::Node *rootNode)
void addItemRanges (const DomItem &item, const FileLocations::Tree &itemLocations, const Path &currentP)
void throwRecursionDepthError () override
void addSourceLocations (Node *n, qsizetype start, qsizetype end, CommentAnchor commentAnchor)
void addSourceLocations (Node *n)
void addSourceLocations (Node *n, const SourceLocation &sourceLocation)
bool preVisit (Node *n) override
bool visit (Block *block) override
bool visit (ArrayPattern *array) override
bool visit (ObjectPattern *object) override
bool visit (Elision *elision) override
bool visit (CaseClause *caseClause) override
bool visit (ClassDeclaration *classDeclaration) override
bool visit (DoWhileStatement *doWhileStatement) override
bool visit (FormalParameterList *list) override
bool visit (ForStatement *forStatement) override
bool visit (FunctionExpression *fExpr) override
bool visit (FunctionDeclaration *fExpr) override
bool visit (WhileStatement *whileStatement) override
bool visit (Type *type) override
bool visit (UiQualifiedId *id) override
bool visit (TryStatement *tryStatement) override
bool visit (Catch *catchStatement) override
bool visit (Finally *finallyStatement) override
 AstRangesVisitor ()=default
void addNodeRanges (AST::Node *rootNode)
void addItemRanges (const DomItem &item, const FileLocations::Tree &itemLocations, const Path &currentP)
void throwRecursionDepthError () override
void addSourceLocations (Node *n, qsizetype start, qsizetype end, CommentAnchor commentAnchor)
void addSourceLocations (Node *n)
void addSourceLocations (Node *n, const SourceLocation &sourceLocation)
bool preVisit (Node *n) override
bool visit (Block *block) override
bool visit (ArrayPattern *array) override
bool visit (ObjectPattern *object) override
bool visit (Elision *elision) override
bool visit (CaseClause *caseClause) override
bool visit (ClassDeclaration *classDeclaration) override
bool visit (DoWhileStatement *doWhileStatement) override
bool visit (FormalParameterList *list) override
bool visit (ForStatement *forStatement) override
bool visit (FunctionExpression *fExpr) override
bool visit (FunctionDeclaration *fExpr) override
bool visit (WhileStatement *whileStatement) override
bool visit (Type *type) override
bool visit (UiQualifiedId *id) override
bool visit (TryStatement *tryStatement) override
bool visit (Catch *catchStatement) override
bool visit (Finally *finallyStatement) override
bool visit (AST::UiPublicMember *el) override
bool visit (AST::UiSourceElement *el) override
bool visit (AST::UiObjectDefinition *el) override
bool visit (AST::UiObjectBinding *el) override
bool visit (AST::UiScriptBinding *el) override
bool visit (AST::UiArrayBinding *el) override
bool visit (AST::UiParameterList *el) override
bool visit (AST::UiEnumDeclaration *el) override
bool visit (AST::UiInlineComponent *el) override
bool visit (AST::TemplateLiteral *el) override

Static Public Member Functions

static const QSet< int > kindsToSkip ()
static bool shouldSkipRegion (const DomItem &item, FileLocationRegion region)
 returns true if comments should skip attaching to this region
static const QSet< int > kindsToSkip ()
static bool shouldSkipRegion (const DomItem &item, FileLocationRegion region)

Public Attributes

QMap< qsizetype, ElementRefstarts
QMap< qsizetype, ElementRefends

Additional Inherited Members

Protected Member Functions inherited from QQmlJS::Dom::VisitAll
 VisitAll ()=default
void throwRecursionDepthError () override
bool visit (AST::UiPublicMember *el) override
bool visit (AST::UiSourceElement *el) override
bool visit (AST::UiObjectDefinition *el) override
bool visit (AST::UiObjectBinding *el) override
bool visit (AST::UiScriptBinding *el) override
bool visit (AST::UiArrayBinding *el) override
bool visit (AST::UiParameterList *el) override
bool visit (AST::UiQualifiedId *el) override
bool visit (AST::UiEnumDeclaration *el) override
bool visit (AST::UiInlineComponent *el) override
void endVisit (AST::UiImport *el) override
void endVisit (AST::UiPublicMember *el) override
void endVisit (AST::UiParameterList *el) override
void endVisit (AST::UiEnumMemberList *el) override
bool visit (AST::TemplateLiteral *el) override
void endVisit (AST::Elision *el) override
Protected Member Functions inherited from QQmlJS::AST::Visitor
 Visitor (quint16 parentRecursionDepth=0)
bool preVisit (Node *) override
void postVisit (Node *) override
Protected Member Functions inherited from QQmlJS::AST::BaseVisitor
 BaseVisitor (quint16 parentRecursionDepth=0)
virtual ~BaseVisitor ()
quint16 recursionDepth () const
Static Protected Member Functions inherited from QQmlJS::Dom::VisitAll
static QSet< int > uiKinds ()
 returns a set with all Ui* Nodes (i.e.
Protected Attributes inherited from QQmlJS::AST::BaseVisitor
quint16 m_recursionDepth = 0

Detailed Description

Definition at line 345 of file qqmldomcomments.cpp.

Constructor & Destructor Documentation

◆ AstRangesVisitor() [1/2]

QQmlJS::Dom::AstRangesVisitor::AstRangesVisitor ( )
default

◆ AstRangesVisitor() [2/2]

QQmlJS::Dom::AstRangesVisitor::AstRangesVisitor ( )
default

Member Function Documentation

◆ addItemRanges() [1/2]

void QQmlJS::Dom::AstRangesVisitor::addItemRanges ( const DomItem & item,
const FileLocations::Tree & itemLocations,
const Path & currentP )

Definition at line 548 of file qqmldomcomments.cpp.

References addItemRanges(), QQmlJS::Dom::DomItem::canonicalPath(), QQmlJS::Dom::DomItem::path(), shouldSkipRegion(), and QQmlJS::Dom::Path::withPath().

Referenced by addItemRanges(), and QQmlJS::Dom::CommentCollector::collectComments().

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

◆ addItemRanges() [2/2]

void QQmlJS::Dom::AstRangesVisitor::addItemRanges ( const DomItem & item,
const FileLocations::Tree & itemLocations,
const Path & currentP )

◆ addNodeRanges() [1/2]

void QQmlJS::Dom::AstRangesVisitor::addNodeRanges ( AST::Node * rootNode)

Definition at line 543 of file qqmldomcomments.cpp.

◆ addNodeRanges() [2/2]

void QQmlJS::Dom::AstRangesVisitor::addNodeRanges ( AST::Node * rootNode)

◆ addSourceLocations() [1/6]

void QQmlJS::Dom::AstRangesVisitor::addSourceLocations ( Node * n)
inline

Definition at line 366 of file qqmldomcomments.cpp.

◆ addSourceLocations() [2/6]

void QQmlJS::Dom::AstRangesVisitor::addSourceLocations ( Node * n)
inline

Definition at line 366 of file qqmldomcomments.cpp.

◆ addSourceLocations() [3/6]

void QQmlJS::Dom::AstRangesVisitor::addSourceLocations ( Node * n,
const SourceLocation & sourceLocation )
inline

Definition at line 371 of file qqmldomcomments.cpp.

◆ addSourceLocations() [4/6]

void QQmlJS::Dom::AstRangesVisitor::addSourceLocations ( Node * n,
const SourceLocation & sourceLocation )
inline

Definition at line 371 of file qqmldomcomments.cpp.

◆ addSourceLocations() [5/6]

void QQmlJS::Dom::AstRangesVisitor::addSourceLocations ( Node * n,
qsizetype start,
qsizetype end,
CommentAnchor commentAnchor )
inline

Definition at line 359 of file qqmldomcomments.cpp.

◆ addSourceLocations() [6/6]

void QQmlJS::Dom::AstRangesVisitor::addSourceLocations ( Node * n,
qsizetype start,
qsizetype end,
CommentAnchor commentAnchor )
inline

Definition at line 359 of file qqmldomcomments.cpp.

◆ kindsToSkip() [1/2]

const QSet< int > QQmlJS::Dom::AstRangesVisitor::kindsToSkip ( )
static

Definition at line 579 of file qqmldomcomments.cpp.

◆ kindsToSkip() [2/2]

const QSet< int > QQmlJS::Dom::AstRangesVisitor::kindsToSkip ( )
static

◆ preVisit() [1/2]

bool QQmlJS::Dom::AstRangesVisitor::preVisit ( Node * n)
inlineoverridevirtual

Implements QQmlJS::AST::BaseVisitor.

Definition at line 379 of file qqmldomcomments.cpp.

◆ preVisit() [2/2]

bool QQmlJS::Dom::AstRangesVisitor::preVisit ( Node * n)
inlineoverridevirtual

Implements QQmlJS::AST::BaseVisitor.

Definition at line 379 of file qqmldomcomments.cpp.

◆ shouldSkipRegion() [1/2]

bool QQmlJS::Dom::AstRangesVisitor::shouldSkipRegion ( const DomItem & item,
FileLocationRegion region )
static

returns true if comments should skip attaching to this region

Definition at line 602 of file qqmldomcomments.cpp.

References QQmlJS::Dom::DomItem::internalKind().

Referenced by addItemRanges().

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

◆ shouldSkipRegion() [2/2]

bool QQmlJS::Dom::AstRangesVisitor::shouldSkipRegion ( const DomItem & item,
FileLocationRegion region )
static

◆ throwRecursionDepthError() [1/2]

void QQmlJS::Dom::AstRangesVisitor::throwRecursionDepthError ( )
inlineoverridevirtual

Implements QQmlJS::AST::BaseVisitor.

Definition at line 354 of file qqmldomcomments.cpp.

◆ throwRecursionDepthError() [2/2]

void QQmlJS::Dom::AstRangesVisitor::throwRecursionDepthError ( )
inlineoverridevirtual

Implements QQmlJS::AST::BaseVisitor.

Definition at line 354 of file qqmldomcomments.cpp.

◆ visit() [1/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( ArrayPattern * array)
inlineoverride

Definition at line 397 of file qqmldomcomments.cpp.

◆ visit() [2/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( ArrayPattern * array)
inlineoverride

Definition at line 397 of file qqmldomcomments.cpp.

◆ visit() [3/44]

Definition at line 389 of file qqmldomcomments_p.h.

◆ visit() [4/44]

Definition at line 345 of file qqmldomcomments_p.h.

◆ visit() [5/44]

Definition at line 363 of file qqmldomcomments_p.h.

◆ visit() [6/44]

Definition at line 369 of file qqmldomcomments_p.h.

◆ visit() [7/44]

Definition at line 333 of file qqmldomcomments_p.h.

◆ visit() [8/44]

Definition at line 327 of file qqmldomcomments_p.h.

◆ visit() [9/44]

Definition at line 351 of file qqmldomcomments_p.h.

◆ visit() [10/44]

Definition at line 314 of file qqmldomcomments_p.h.

◆ visit() [11/44]

Definition at line 339 of file qqmldomcomments_p.h.

◆ visit() [12/44]

Definition at line 321 of file qqmldomcomments_p.h.

◆ visit() [13/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( Block * block)
inlineoverride

Definition at line 388 of file qqmldomcomments.cpp.

◆ visit() [14/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( Block * block)
inlineoverride

Definition at line 388 of file qqmldomcomments.cpp.

◆ visit() [15/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( CaseClause * caseClause)
inlineoverride

Definition at line 418 of file qqmldomcomments.cpp.

◆ visit() [16/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( CaseClause * caseClause)
inlineoverride

Definition at line 418 of file qqmldomcomments.cpp.

◆ visit() [17/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( Catch * catchStatement)
inlineoverride

Definition at line 521 of file qqmldomcomments.cpp.

◆ visit() [18/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( Catch * catchStatement)
inlineoverride

Definition at line 521 of file qqmldomcomments.cpp.

◆ visit() [19/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( ClassDeclaration * classDeclaration)
inlineoverride

Definition at line 425 of file qqmldomcomments.cpp.

◆ visit() [20/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( ClassDeclaration * classDeclaration)
inlineoverride

Definition at line 425 of file qqmldomcomments.cpp.

◆ visit() [21/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( DoWhileStatement * doWhileStatement)
inlineoverride

Definition at line 434 of file qqmldomcomments.cpp.

◆ visit() [22/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( DoWhileStatement * doWhileStatement)
inlineoverride

Definition at line 434 of file qqmldomcomments.cpp.

◆ visit() [23/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( Elision * elision)
inlineoverride

Definition at line 412 of file qqmldomcomments.cpp.

◆ visit() [24/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( Elision * elision)
inlineoverride

Definition at line 412 of file qqmldomcomments.cpp.

◆ visit() [25/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( Finally * finallyStatement)
inlineoverride

Definition at line 530 of file qqmldomcomments.cpp.

◆ visit() [26/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( Finally * finallyStatement)
inlineoverride

Definition at line 530 of file qqmldomcomments.cpp.

◆ visit() [27/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( FormalParameterList * list)
inlineoverride

Definition at line 443 of file qqmldomcomments.cpp.

◆ visit() [28/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( FormalParameterList * list)
inlineoverride

Definition at line 443 of file qqmldomcomments.cpp.

◆ visit() [29/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( ForStatement * forStatement)
inlineoverride

Definition at line 449 of file qqmldomcomments.cpp.

◆ visit() [30/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( ForStatement * forStatement)
inlineoverride

Definition at line 449 of file qqmldomcomments.cpp.

◆ visit() [31/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( FunctionDeclaration * fExpr)
inlineoverride

Definition at line 469 of file qqmldomcomments.cpp.

◆ visit() [32/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( FunctionDeclaration * fExpr)
inlineoverride

Definition at line 469 of file qqmldomcomments.cpp.

◆ visit() [33/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( FunctionExpression * fExpr)
inlineoverride

Definition at line 458 of file qqmldomcomments.cpp.

◆ visit() [34/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( FunctionExpression * fExpr)
inlineoverride

Definition at line 458 of file qqmldomcomments.cpp.

◆ visit() [35/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( ObjectPattern * object)
inlineoverride

Definition at line 405 of file qqmldomcomments.cpp.

◆ visit() [36/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( ObjectPattern * object)
inlineoverride

Definition at line 405 of file qqmldomcomments.cpp.

◆ visit() [37/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( TryStatement * tryStatement)
inlineoverride

Definition at line 515 of file qqmldomcomments.cpp.

◆ visit() [38/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( TryStatement * tryStatement)
inlineoverride

Definition at line 515 of file qqmldomcomments.cpp.

◆ visit() [39/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( Type * type)
inlineoverride

Definition at line 483 of file qqmldomcomments.cpp.

◆ visit() [40/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( Type * type)
inlineoverride

Definition at line 483 of file qqmldomcomments.cpp.

◆ visit() [41/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( UiQualifiedId * id)
inlineoverride

Definition at line 499 of file qqmldomcomments.cpp.

◆ visit() [42/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( UiQualifiedId * id)
inlineoverride

Definition at line 499 of file qqmldomcomments.cpp.

◆ visit() [43/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( WhileStatement * whileStatement)
inlineoverride

Definition at line 474 of file qqmldomcomments.cpp.

◆ visit() [44/44]

bool QQmlJS::Dom::AstRangesVisitor::visit ( WhileStatement * whileStatement)
inlineoverride

Definition at line 474 of file qqmldomcomments.cpp.

Member Data Documentation

◆ ends

QMap< qsizetype, ElementRef > QQmlJS::Dom::AstRangesVisitor::ends

Definition at line 537 of file qqmldomcomments.cpp.

◆ starts

QMap< qsizetype, ElementRef > QQmlJS::Dom::AstRangesVisitor::starts

Definition at line 536 of file qqmldomcomments.cpp.


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