The RecursiveASTVisitor to traverse symbol declarations and collect API information. More...
#include "clang/ExtractAPI/ExtractAPIVisitor.h"
Inheritance diagram for clang::extractapi::ExtractAPIVisitor< Derived >:
Public Member Functions | |
| ExtractAPIVisitor (ASTContext &Context, APISet &API) | |
| bool | shouldDeclBeIncluded (const Decl *D) const |
| const RawComment * | fetchRawCommentForDecl (const Decl *D) const |
 Public Member Functions inherited from clang::extractapi::impl::ExtractAPIVisitorBase< Derived > | |
| const APISet & | getAPI () const |
| bool | VisitVarDecl (const VarDecl *Decl) |
| bool | VisitFunctionDecl (const FunctionDecl *Decl) |
| bool | VisitEnumDecl (const EnumDecl *Decl) |
| bool | VisitRecordDecl (const RecordDecl *Decl) |
| bool | VisitObjCInterfaceDecl (const ObjCInterfaceDecl *Decl) |
| bool | VisitObjCProtocolDecl (const ObjCProtocolDecl *Decl) |
| bool | VisitTypedefNameDecl (const TypedefNameDecl *Decl) |
| bool | VisitObjCCategoryDecl (const ObjCCategoryDecl *Decl) |
| bool | shouldDeclBeIncluded (const Decl *Decl) const |
| const RawComment * | fetchRawCommentForDecl (const Decl *Decl) const |
| Public Member Functions inherited from clang::RecursiveASTVisitor< Derived > | |
| Derived & | getDerived () |
| Return a reference to the derived class. | |
| bool | shouldVisitTemplateInstantiations () const |
| Return whether this visitor should recurse into template instantiations. | |
| bool | shouldWalkTypesOfTypeLocs () const |
| Return whether this visitor should recurse into the types of TypeLocs. | |
| bool | shouldVisitImplicitCode () const |
| Return whether this visitor should recurse into implicit code, e.g., implicit constructors and destructors. | |
| bool | shouldVisitLambdaBody () const |
| Return whether this visitor should recurse into lambda body. | |
| bool | shouldTraversePostOrder () const |
| Return whether this visitor should traverse post-order. | |
| bool | TraverseAST (ASTContext &AST) |
| Recursively visits an entire AST, starting from the TranslationUnitDecl. | |
| bool | TraverseStmt (Stmt *S, DataRecursionQueue *Queue=nullptr) |
| Recursively visit a statement or expression, by dispatching to Traverse*() based on the argument's dynamic type. | |
| bool | dataTraverseStmtPre (Stmt *S) |
| Invoked before visiting a statement or expression via data recursion. | |
| bool | dataTraverseStmtPost (Stmt *S) |
| Invoked after visiting a statement or expression via data recursion. | |
| bool | TraverseType (QualType T) |
| Recursively visit a type, by dispatching to Traverse*Type() based on the argument's getTypeClass() property. | |
| bool | TraverseTypeLoc (TypeLoc TL) |
| Recursively visit a type with location, by dispatching to Traverse*TypeLoc() based on the argument type's getTypeClass() property. | |
| bool | TraverseAttr (Attr *At) |
| Recursively visit an attribute, by dispatching to Traverse*Attr() based on the argument's dynamic type. | |
| bool | TraverseDecl (Decl *D) |
| Recursively visit a declaration, by dispatching to Traverse*Decl() based on the argument's dynamic type. | |
| bool | TraverseNestedNameSpecifier (NestedNameSpecifier *NNS) |
| Recursively visit a C++ nested-name-specifier. | |
| bool | TraverseNestedNameSpecifierLoc (NestedNameSpecifierLoc NNS) |
| Recursively visit a C++ nested-name-specifier with location information. | |
| bool | TraverseDeclarationNameInfo (DeclarationNameInfo NameInfo) |
| Recursively visit a name with its location information. | |
| bool | TraverseTemplateName (TemplateName Template) |
| Recursively visit a template name and dispatch to the appropriate method. | |
| bool | TraverseTemplateArgument (const TemplateArgument &Arg) |
| Recursively visit a template argument and dispatch to the appropriate method for the argument type. | |
| bool | TraverseTemplateArgumentLoc (const TemplateArgumentLoc &ArgLoc) |
| Recursively visit a template argument location and dispatch to the appropriate method for the argument type. | |
| bool | TraverseTemplateArguments (ArrayRef< TemplateArgument > Args) |
| Recursively visit a set of template arguments. | |
| bool | TraverseCXXBaseSpecifier (const CXXBaseSpecifier &Base) |
| Recursively visit a base specifier. | |
| bool | TraverseConstructorInitializer (CXXCtorInitializer *Init) |
| Recursively visit a constructor initializer. | |
| bool | TraverseLambdaCapture (LambdaExpr *LE, const LambdaCapture *C, Expr *Init) |
| Recursively visit a lambda capture. | |
| bool | TraverseSynOrSemInitListExpr (InitListExpr *S, DataRecursionQueue *Queue=nullptr) |
| Recursively visit the syntactic or semantic form of an initialization list. | |
| bool | TraverseObjCProtocolLoc (ObjCProtocolLoc ProtocolLoc) |
| Recursively visit an Objective-C protocol reference with location information. | |
| bool | VisitAttr (Attr *A) |
| Stmt::child_range | getStmtChildren (Stmt *S) |
| bool | WalkUpFromStmt (Stmt *S) |
| bool | VisitStmt (Stmt *S) |
| bool | WalkUpFromType (Type *T) |
| bool | VisitType (Type *T) |
| bool | WalkUpFromTypeLoc (TypeLoc TL) |
| bool | VisitTypeLoc (TypeLoc TL) |
| bool | WalkUpFromQualifiedTypeLoc (QualifiedTypeLoc TL) |
| bool | VisitQualifiedTypeLoc (QualifiedTypeLoc TL) |
| bool | WalkUpFromUnqualTypeLoc (UnqualTypeLoc TL) |
| bool | VisitUnqualTypeLoc (UnqualTypeLoc TL) |
| bool | WalkUpFromDecl (Decl *D) |
| bool | VisitDecl (Decl *D) |
| bool | canIgnoreChildDeclWhileTraversingDeclContext (const Decl *Child) |
| bool | TraverseTypeConstraint (const TypeConstraint *C) |
| bool | TraverseConceptRequirement (concepts::Requirement *R) |
| bool | TraverseConceptTypeRequirement (concepts::TypeRequirement *R) |
| bool | TraverseConceptExprRequirement (concepts::ExprRequirement *R) |
| bool | TraverseConceptNestedRequirement (concepts::NestedRequirement *R) |
| bool | dataTraverseNode (Stmt *S, DataRecursionQueue *Queue) |
Additional Inherited Members | |
| Public Types inherited from clang::RecursiveASTVisitor< Derived > | |
| typedef SmallVectorImpl< llvm::PointerIntPair< Stmt *, 1, bool > > | DataRecursionQueue |
| A queue used for performing data recursion over statements. | |
| Protected Member Functions inherited from clang::extractapi::impl::ExtractAPIVisitorBase< Derived > | |
| ExtractAPIVisitorBase (ASTContext &Context, APISet &API) | |
| void | recordEnumConstants (EnumRecord *EnumRecord, const EnumDecl::enumerator_range Constants) |
| Collect API information for the enum constants and associate with the parent enum. | |
| void | recordStructFields (StructRecord *StructRecord, const RecordDecl::field_range Fields) |
| Collect API information for the struct fields and associate with the parent struct. | |
| void | recordObjCMethods (ObjCContainerRecord *Container, const ObjCContainerDecl::method_range Methods) |
| Collect API information for the Objective-C methods and associate with the parent container. | |
| void | recordObjCProperties (ObjCContainerRecord *Container, const ObjCContainerDecl::prop_range Properties) |
| void | recordObjCInstanceVariables (ObjCContainerRecord *Container, const llvm::iterator_range< DeclContext::specific_decl_iterator< ObjCIvarDecl > > Ivars) |
| void | recordObjCProtocols (ObjCContainerRecord *Container, ObjCInterfaceDecl::protocol_range Protocols) |
| StringRef | getTypedefName (const TagDecl *Decl) |
| bool | isInSystemHeader (const Decl *D) |
| Protected Attributes inherited from clang::extractapi::impl::ExtractAPIVisitorBase< Derived > | |
| ASTContext & | Context |
| APISet & | API |
Detailed Description
template<typename Derived = void>
class clang::extractapi::ExtractAPIVisitor< Derived >
class clang::extractapi::ExtractAPIVisitor< Derived >
The RecursiveASTVisitor to traverse symbol declarations and collect API information.
Definition at line 685 of file ExtractAPIVisitor.h.
Constructor & Destructor Documentation
◆ ExtractAPIVisitor()
template<typename Derived = void>
|
inline |
Definition at line 692 of file ExtractAPIVisitor.h.
Member Function Documentation
◆ fetchRawCommentForDecl()
template<typename Derived = void>
|
inline |
Definition at line 695 of file ExtractAPIVisitor.h.
References clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::Context, and clang::ASTContext::getRawCommentForDeclNoCache().
◆ shouldDeclBeIncluded()
template<typename Derived = void>
|
inline |
Definition at line 694 of file ExtractAPIVisitor.h.
The documentation for this class was generated from the following file:
- include/clang/ExtractAPI/ExtractAPIVisitor.h
