The base interface of visitors for API information, the interface and usage is almost identical to RecurisveASTVistor. More...
#include "clang/ExtractAPI/Serialization/APISetVisitor.h"
Public Member Functions | |
| bool | traverseAPISet () |
| bool | traverseAPIRecord (const APIRecord *Record) |
| bool | walkUpFromAPIRecord (const APIRecord *Record) |
| bool | visitAPIRecord (const APIRecord *Record) |
| bool | traverseRecordContext (const RecordContext *) |
| APISetVisitor ()=delete | |
| APISetVisitor (const APISetVisitor &)=delete | |
| APISetVisitor (APISetVisitor &&)=delete | |
| APISetVisitor & | operator= (const APISetVisitor &)=delete |
| APISetVisitor & | operator= (APISetVisitor &&)=delete |
Protected Member Functions | |
| APISetVisitor (const APISet &API) | |
| ~APISetVisitor ()=default | |
| Derived * | getDerived () |
Protected Attributes | |
| const APISet & | API |
Detailed Description
class clang::extractapi::APISetVisitor< Derived >
The base interface of visitors for API information, the interface and usage is almost identical to RecurisveASTVistor.
This class performs three distinct tasks:
- traverse the APISet (i.e. go to every record);
- at a given record, walk up the class hierarchy starting from the record's dynamic type until APIRecord is reached.
- given a (record, class) combination where 'class' is some base class of the dynamic type of 'record', call a user-overridable function to actually visit the record.
These tasks are done by three groups of methods, respectively:
- traverseRecord(APIRecord *x) does task #1, it is the entry point for traversing the records starting from x. This method simply forwards to traverseFoo(Foo *x) where Foo is the dynamic type of *x, which calls walkUpFromFoo(x) and then recursively visits the child records of x.
- walkUpFromFoo(Foo *x) does task #2. It doesn't visit children records of x, instead it first calls walkUpFromBar(x) where Bar is the direct parent class of Foo (unless Foo has no parent) and then calls visitFoo(x).
- visitFoo(Foo *x) does task #3.
These three method groups are tiered (traverse* > walkUpFrom* > visit*). A method (e.g. traverse*) may call methods from the same tier (e.g. other traverse*) or one tier lower (e.g. walkUpFrom*). It may not call methods from a higher tier.
Note that since walkUpFromFoo() calls walkUpFromBar() (where Bar is Foo's super class) before calling visitFoo(), the result is that the visit*() methods for a given record are called in the top-down order (e.g. for a record of type ObjCInstancePropertyRecord, the order will be visitRecord(), visitObjCPropertyRecord(), and then visitObjCInstancePropertyRecord()).
This scheme guarantees that all visit*() calls for the same record are grouped together. In other words, visit*() methods for different records are never interleaved.
Clients of this visitor should subclass the visitor (providing themselves as the template argument, using the curiously recurring template pattern) and override any of the traverse*, walkUpFrom*, and visit* methods for records where the visitor should customize behavior. Most users only need to override visit*. Advanced users may override traverse* and walkUpFrom* to implement custom traversal strategies. Returning false from one of these overridden functions will abort the entire traversal.
Definition at line 76 of file APISetVisitor.h.
Constructor & Destructor Documentation
◆ APISetVisitor() [1/4]
|
delete |
◆ APISetVisitor() [2/4]
|
delete |
◆ APISetVisitor() [3/4]
|
delete |
◆ APISetVisitor() [4/4]
|
inlineprotected |
Definition at line 132 of file APISetVisitor.h.
◆ ~APISetVisitor()
|
protecteddefault |
Member Function Documentation
◆ getDerived()
|
inlineprotected |
Definition at line 135 of file APISetVisitor.h.
◆ operator=() [1/2]
|
delete |
◆ operator=() [2/2]
|
delete |
◆ traverseAPIRecord()
| bool clang::extractapi::APISetVisitor< Derived >::traverseAPIRecord | ( | const APIRecord * | Record | ) |
Definition at line 151 of file APISetVisitor.h.
References clang::extractapi::APIRecord::RK_Unknown, and TRY_TO.
Referenced by clang::extractapi::APISetVisitor< Derived >::traverseAPISet().
◆ traverseAPISet()
|
inline |
Definition at line 78 of file APISetVisitor.h.
References clang::extractapi::APISetVisitor< Derived >::API, clang::extractapi::APISet::getTopLevelRecords(), clang::extractapi::APISetVisitor< Derived >::traverseAPIRecord(), and TRY_TO.
Referenced by clang::extractapi::SymbolGraphSerializer::serializeMainSymbolGraph(), and clang::extractapi::SymbolGraphSerializer::serializeWithExtensionGraphs().
◆ traverseRecordContext()
| bool clang::extractapi::APISetVisitor< Derived >::traverseRecordContext | ( | const RecordContext * | Context | ) |
Definition at line 139 of file APISetVisitor.h.
References TRY_TO.
◆ visitAPIRecord()
|
inline |
Definition at line 90 of file APISetVisitor.h.
Referenced by clang::extractapi::APISetVisitor< Derived >::walkUpFromAPIRecord().
◆ walkUpFromAPIRecord()
|
inline |
Definition at line 86 of file APISetVisitor.h.
References TRY_TO, and clang::extractapi::APISetVisitor< Derived >::visitAPIRecord().
Member Data Documentation
◆ API
|
protected |
Definition at line 122 of file APISetVisitor.h.
Referenced by clang::extractapi::APISetVisitor< Derived >::traverseAPISet().
The documentation for this class was generated from the following file:
- include/clang/ExtractAPI/Serialization/APISetVisitor.h
