A factory class to build DeclarationFragments for different kinds of Decl. More...

#include "clang/ExtractAPI/DeclarationFragments.h"

Static Public Member Functions
template<typename FunctionT >
static FunctionSignature	getFunctionSignature (const FunctionT *Function)
	Build FunctionSignature for a function-like declaration `FunctionT` like FunctionDecl, ObjCMethodDecl, or CXXMethodDecl.

static AccessControl	getAccessControl (const Decl *Decl)

static DeclarationFragments	getFragmentsForNamespace (const NamespaceDecl *Decl)

static DeclarationFragments	getFragmentsForVar (const VarDecl *)
	Build DeclarationFragments for a variable declaration VarDecl.

static DeclarationFragments	getFragmentsForVarTemplate (const VarDecl *)

static DeclarationFragments	getFragmentsForFunction (const FunctionDecl *)
	Build DeclarationFragments for a function declaration FunctionDecl.

static DeclarationFragments	getFragmentsForEnumConstant (const EnumConstantDecl *)
	Build DeclarationFragments for an enum constant declaration EnumConstantDecl.

static DeclarationFragments	getFragmentsForEnum (const EnumDecl *)
	Build DeclarationFragments for an enum declaration EnumDecl.

static DeclarationFragments	getFragmentsForField (const FieldDecl *)
	Build DeclarationFragments for a field declaration FieldDecl.

static DeclarationFragments	getFragmentsForStruct (const RecordDecl *)
	Build DeclarationFragments for a struct record declaration RecordDecl.

static DeclarationFragments	getFragmentsForCXXClass (const CXXRecordDecl *)

static DeclarationFragments	getFragmentsForSpecialCXXMethod (const CXXMethodDecl *)

static DeclarationFragments	getFragmentsForCXXMethod (const CXXMethodDecl *)

static DeclarationFragments	getFragmentsForConversionFunction (const CXXConversionDecl *)

static DeclarationFragments	getFragmentsForOverloadedOperator (const CXXMethodDecl *)

static DeclarationFragments	getFragmentsForTemplateParameters (ArrayRef< NamedDecl * >)

static std::string	getNameForTemplateArgument (const ArrayRef< NamedDecl * >, std::string)

static DeclarationFragments	getFragmentsForTemplateArguments (const ArrayRef< TemplateArgument >, ASTContext &, const std::optional< ArrayRef< NamedDecl * > >)

static DeclarationFragments	getFragmentsForConcept (const ConceptDecl *)

static DeclarationFragments	getFragmentsForRedeclarableTemplate (const RedeclarableTemplateDecl *)

static DeclarationFragments	getFragmentsForClassTemplateSpecialization (const ClassTemplateSpecializationDecl *)

static DeclarationFragments	getFragmentsForClassTemplatePartialSpecialization (const ClassTemplatePartialSpecializationDecl *)

static DeclarationFragments	getFragmentsForVarTemplateSpecialization (const VarTemplateSpecializationDecl *)

static DeclarationFragments	getFragmentsForVarTemplatePartialSpecialization (const VarTemplatePartialSpecializationDecl *)

static DeclarationFragments	getFragmentsForFunctionTemplate (const FunctionTemplateDecl *Decl)

static DeclarationFragments	getFragmentsForFunctionTemplateSpecialization (const FunctionDecl *Decl)

static DeclarationFragments	getFragmentsForObjCCategory (const ObjCCategoryDecl *)
	Build DeclarationFragments for an Objective-C category declaration ObjCCategoryDecl.

static DeclarationFragments	getFragmentsForObjCInterface (const ObjCInterfaceDecl *)
	Build DeclarationFragments for an Objective-C interface declaration ObjCInterfaceDecl.

static DeclarationFragments	getFragmentsForObjCMethod (const ObjCMethodDecl *)
	Build DeclarationFragments for an Objective-C method declaration ObjCMethodDecl.

static DeclarationFragments	getFragmentsForObjCProperty (const ObjCPropertyDecl *)
	Build DeclarationFragments for an Objective-C property declaration ObjCPropertyDecl.

static DeclarationFragments	getFragmentsForObjCProtocol (const ObjCProtocolDecl *)
	Build DeclarationFragments for an Objective-C protocol declaration ObjCProtocolDecl.

static DeclarationFragments	getFragmentsForMacro (StringRef Name, const MacroDirective *MD)
	Build DeclarationFragments for a macro.

static DeclarationFragments	getFragmentsForTypedef (const TypedefNameDecl *Decl)
	Build DeclarationFragments for a typedef `TypedefNameDecl`.

static DeclarationFragments	getSubHeading (const NamedDecl *)
	Build sub-heading fragments for a NamedDecl.

static DeclarationFragments	getSubHeading (const ObjCMethodDecl *)
	Build sub-heading fragments for an Objective-C method.

static DeclarationFragments	getSubHeadingForMacro (StringRef Name)
	Build a sub-heading for macro `Name`.

Detailed Description

A factory class to build DeclarationFragments for different kinds of Decl.

Definition at line 251 of file DeclarationFragments.h.

Member Function Documentation

◆ getAccessControl()

static AccessControl clang::extractapi::DeclarationFragmentsBuilder::getAccessControl ( const Decl * Decl )

inlinestatic

Definition at line 262 of file DeclarationFragments.h.

References clang::AS_none, clang::AS_private, clang::AS_protected, clang::AS_public, and clang::Decl::getAccess().

◆ getFragmentsForClassTemplatePartialSpecialization()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForClassTemplatePartialSpecialization ( const ClassTemplatePartialSpecializationDecl * Decl )

static

Definition at line 966 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getASTContext(), getFragmentsForCXXClass(), getFragmentsForTemplateArguments(), getFragmentsForTemplateParameters(), clang::extractapi::DeclarationFragments::Keyword, clang::extractapi::DeclarationFragments::pop_back(), and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitClassTemplatePartialSpecializationDecl().

◆ getFragmentsForClassTemplateSpecialization()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForClassTemplateSpecialization ( const ClassTemplateSpecializationDecl * Decl )

static

Definition at line 946 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getASTContext(), getFragmentsForCXXClass(), getFragmentsForTemplateArguments(), clang::extractapi::DeclarationFragments::Keyword, clang::extractapi::DeclarationFragments::pop_back(), and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitClassTemplateSpecializationDecl().

◆ getFragmentsForConcept()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForConcept ( const ConceptDecl * Concept )

static

Definition at line 908 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), getFragmentsForTemplateParameters(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitConceptDecl().

◆ getFragmentsForConversionFunction()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForConversionFunction ( const CXXConversionDecl * ConversionFunction )

static

Definition at line 757 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::extractapi::DeclarationFragments::Keyword, clang::extractapi::DeclarationFragments::Text, and clang::extractapi::DeclarationFragments::TypeIdentifier.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConversionDecl().

◆ getFragmentsForCXXClass()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForCXXClass ( const CXXRecordDecl * Record )

static

Definition at line 671 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), getFragmentsForTypedef(), clang::extractapi::DeclarationFragments::getStructureTypeFragment(), clang::extractapi::DeclarationFragments::Identifier, and clang::extractapi::DeclarationFragments::Text.

Referenced by getFragmentsForClassTemplatePartialSpecialization(), getFragmentsForClassTemplateSpecialization(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXRecordDecl().

◆ getFragmentsForCXXMethod()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForCXXMethod ( const CXXMethodDecl * Method )

static

Definition at line 716 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getASTContext(), clang::extractapi::DeclarationFragments::getExceptionSpecificationString(), clang::FunctionDecl::getExceptionSpecType(), clang::NamedDecl::getName(), clang::FunctionDecl::getNumParams(), clang::FunctionDecl::getParamDecl(), clang::FunctionDecl::getReturnType(), clang::extractapi::DeclarationFragments::Identifier, clang::CXXMethodDecl::isConst(), clang::FunctionDecl::isConstexpr(), clang::CXXMethodDecl::isStatic(), clang::CXXMethodDecl::isVolatile(), clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXMethodDecl().

◆ getFragmentsForEnum()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForEnum ( const EnumDecl * EnumDecl )

static

Build DeclarationFragments for an enum declaration EnumDecl.

Definition at line 619 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getASTContext(), getFragmentsForTypedef(), clang::EnumDecl::getIntegerType(), clang::NamedDecl::getName(), clang::TagDecl::getTypedefNameForAnonDecl(), clang::extractapi::DeclarationFragments::Identifier, clang::QualType::isNull(), clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitEnumDecl().

◆ getFragmentsForEnumConstant()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForEnumConstant ( const EnumConstantDecl * EnumConstDecl )

static

Build DeclarationFragments for an enum constant declaration EnumConstantDecl.

Definition at line 611 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::NamedDecl::getName(), and clang::extractapi::DeclarationFragments::Identifier.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordEnumConstants().

◆ getFragmentsForField()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForField ( const FieldDecl * Field )

static

Build DeclarationFragments for a field declaration FieldDecl.

Definition at line 641 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCInstanceVariables(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordStructFields(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitFieldDecl().

◆ getFragmentsForFunction()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForFunction ( const FunctionDecl * Func )

static

Build DeclarationFragments for a function declaration FunctionDecl.

Definition at line 539 of file DeclarationFragments.cpp.

Referenced by getFragmentsForFunctionTemplate(), getFragmentsForFunctionTemplateSpecialization(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitFunctionDecl().

◆ getFragmentsForFunctionTemplate()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForFunctionTemplate ( const FunctionTemplateDecl * Decl )

static

Definition at line 1029 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getAsFunction(), getFragmentsForFunction(), getFragmentsForTemplateParameters(), clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXMethodDecl(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitFunctionTemplateDecl().

◆ getFragmentsForFunctionTemplateSpecialization()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForFunctionTemplateSpecialization ( const FunctionDecl * Decl )

static

Definition at line 1045 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), getFragmentsForFunction(), clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

◆ getFragmentsForMacro()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForMacro	(	StringRef	Name,
		const MacroDirective *	MD
	)

static

Build DeclarationFragments for a macro.

Parameters

Name	name of the macro.
MD	the associated MacroDirective.

Definition at line 1056 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::MacroDirective::getMacroInfo(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::InternalParam, clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

◆ getFragmentsForNamespace()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForNamespace ( const NamespaceDecl * Decl )

static

Definition at line 429 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitNamespaceDecl().

◆ getFragmentsForObjCCategory()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForObjCCategory ( const ObjCCategoryDecl * Category )

static

Build DeclarationFragments for an Objective-C category declaration ObjCCategoryDecl.

Definition at line 1086 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), Category, clang::index::generateUSRForDecl(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::Keyword, clang::extractapi::DeclarationFragments::Text, and clang::extractapi::DeclarationFragments::TypeIdentifier.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitObjCCategoryDecl().

◆ getFragmentsForObjCInterface()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForObjCInterface ( const ObjCInterfaceDecl * Interface )

static

Build DeclarationFragments for an Objective-C interface declaration ObjCInterfaceDecl.

Definition at line 1107 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::index::generateUSRForDecl(), clang::NamedDecl::getName(), clang::ObjCInterfaceDecl::getSuperClass(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::Keyword, clang::extractapi::DeclarationFragments::Text, and clang::extractapi::DeclarationFragments::TypeIdentifier.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitObjCInterfaceDecl().

◆ getFragmentsForObjCMethod()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForObjCMethod ( const ObjCMethodDecl * Method )

static

Build DeclarationFragments for an Objective-C method declaration ObjCMethodDecl.

Definition at line 1129 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getASTContext(), clang::Selector::getNameForSlot(), clang::Selector::getNumArgs(), clang::ObjCMethodDecl::getParamDecl(), clang::ObjCMethodDecl::getReturnType(), clang::ObjCMethodDecl::getSelector(), clang::extractapi::DeclarationFragments::Identifier, clang::ObjCMethodDecl::isClassMethod(), clang::ObjCMethodDecl::isInstanceMethod(), clang::ObjCMethodDecl::param_size(), and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCMethods().

◆ getFragmentsForObjCProperty()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForObjCProperty ( const ObjCPropertyDecl * Property )

static

Build DeclarationFragments for an Objective-C property declaration ObjCPropertyDecl.

Definition at line 1173 of file DeclarationFragments.cpp.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCProperties().

◆ getFragmentsForObjCProtocol()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForObjCProtocol ( const ObjCProtocolDecl * Protocol )

static

Build DeclarationFragments for an Objective-C protocol declaration ObjCProtocolDecl.

Definition at line 1261 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::index::generateUSRForDecl(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::Keyword, clang::extractapi::DeclarationFragments::Text, and clang::extractapi::DeclarationFragments::TypeIdentifier.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitObjCProtocolDecl().

◆ getFragmentsForOverloadedOperator()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForOverloadedOperator ( const CXXMethodDecl * Method )

static

Definition at line 788 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getASTContext(), clang::extractapi::DeclarationFragments::getExceptionSpecificationString(), clang::FunctionDecl::getExceptionSpecType(), clang::NamedDecl::getNameAsString(), clang::FunctionDecl::getNumParams(), clang::FunctionDecl::getParamDecl(), clang::FunctionDecl::getReturnType(), clang::extractapi::DeclarationFragments::Identifier, clang::CXXMethodDecl::isConst(), clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXMethodDecl().

◆ getFragmentsForRedeclarableTemplate()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForRedeclarableTemplate ( const RedeclarableTemplateDecl * RedeclarableTemplate )

static

Definition at line 925 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::TemplateParameterList::asArray(), getFragmentsForTemplateParameters(), clang::NamedDecl::getName(), clang::TemplateDecl::getTemplateParameters(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXRecordDecl(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitVarTemplateDecl().

◆ getFragmentsForSpecialCXXMethod()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForSpecialCXXMethod ( const CXXMethodDecl * Method )

static

Definition at line 687 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::extractapi::DeclarationFragments::getExceptionSpecificationString(), clang::FunctionDecl::getExceptionSpecType(), clang::NamedDecl::getNameAsString(), clang::FunctionDecl::getNumParams(), clang::FunctionDecl::getParamDecl(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConstructorDecl(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXDestructorDecl().

◆ getFragmentsForStruct()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForStruct ( const RecordDecl * Record )

static

Build DeclarationFragments for a struct record declaration RecordDecl.

Definition at line 657 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), getFragmentsForTypedef(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitRecordDecl().

◆ getFragmentsForTemplateArguments()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForTemplateArguments	(	const ArrayRef< TemplateArgument >	TemplateArguments,
		ASTContext &	Context,
		const std::optional< ArrayRef< NamedDecl * > >	TemplateParameters
	)

static

Definition at line 880 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::extractapi::DeclarationFragments::begin(), getNameForTemplateArgument(), and clang::extractapi::DeclarationFragments::Text.

Referenced by getFragmentsForClassTemplatePartialSpecialization(), getFragmentsForClassTemplateSpecialization(), getFragmentsForVarTemplatePartialSpecialization(), and getFragmentsForVarTemplateSpecialization().

◆ getFragmentsForTemplateParameters()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForTemplateParameters ( ArrayRef< NamedDecl * > ParameterArray )

static

Definition at line 821 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::extractapi::DeclarationFragments::GenericParameter, clang::extractapi::DeclarationFragments::Keyword, clang::TemplateParam, clang::extractapi::DeclarationFragments::Text, and clang::extractapi::DeclarationFragments::TypeIdentifier.

Referenced by getFragmentsForClassTemplatePartialSpecialization(), getFragmentsForConcept(), getFragmentsForFunctionTemplate(), getFragmentsForRedeclarableTemplate(), and getFragmentsForVarTemplatePartialSpecialization().

◆ getFragmentsForTypedef()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForTypedef ( const TypedefNameDecl * Decl )

static

Build DeclarationFragments for a typedef TypedefNameDecl.

Definition at line 1291 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getASTContext(), clang::extractapi::DeclarationFragments::Identifier, clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by getFragmentsForCXXClass(), getFragmentsForEnum(), getFragmentsForStruct(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitTypedefNameDecl().

◆ getFragmentsForVar()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForVar ( const VarDecl * Var )

static

Build DeclarationFragments for a variable declaration VarDecl.

Definition at line 440 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getASTContext(), clang::NamedDecl::getName(), clang::VarDecl::getStorageClass(), clang::VarDecl::getStorageClassSpecifierString(), clang::ValueDecl::getType(), clang::TypeSourceInfo::getType(), clang::DeclaratorDecl::getTypeSourceInfo(), clang::ASTContext::getUnqualifiedObjCPointerType(), clang::extractapi::DeclarationFragments::Identifier, clang::VarDecl::isConstexpr(), clang::extractapi::DeclarationFragments::Keyword, clang::SC_None, and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitVarDecl().

◆ getFragmentsForVarTemplate()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForVarTemplate ( const VarDecl * Var )

static

Definition at line 471 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::TemplateParameterList::asArray(), clang::extractapi::DeclarationFragments::begin(), clang::Decl::getASTContext(), clang::VarDecl::getDescribedVarTemplate(), clang::NamedDecl::getName(), getNameForTemplateArgument(), clang::TemplateDecl::getTemplateParameters(), clang::ValueDecl::getType(), clang::TypeSourceInfo::getType(), clang::DeclaratorDecl::getTypeSourceInfo(), clang::ASTContext::getUnqualifiedObjCPointerType(), clang::extractapi::DeclarationFragments::Identifier, clang::VarDecl::isConstexpr(), clang::VarDecl::isStaticDataMember(), clang::extractapi::DeclarationFragments::Keyword, and clang::extractapi::DeclarationFragments::Text.

Referenced by getFragmentsForVarTemplatePartialSpecialization(), getFragmentsForVarTemplateSpecialization(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitVarTemplateDecl().

◆ getFragmentsForVarTemplatePartialSpecialization()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForVarTemplatePartialSpecialization ( const VarTemplatePartialSpecializationDecl * Decl )

static

Definition at line 1007 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getASTContext(), getFragmentsForTemplateArguments(), getFragmentsForTemplateParameters(), getFragmentsForVarTemplate(), clang::extractapi::DeclarationFragments::Keyword, clang::extractapi::DeclarationFragments::pop_back(), and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitVarTemplatePartialSpecializationDecl().

◆ getFragmentsForVarTemplateSpecialization()

DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForVarTemplateSpecialization ( const VarTemplateSpecializationDecl * Decl )

static

Definition at line 988 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::appendSpace(), clang::Decl::getASTContext(), getFragmentsForTemplateArguments(), getFragmentsForVarTemplate(), clang::extractapi::DeclarationFragments::Keyword, clang::extractapi::DeclarationFragments::pop_back(), and clang::extractapi::DeclarationFragments::Text.

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitVarTemplateSpecializationDecl().

◆ getFunctionSignature()

template<typename FunctionT >

template FunctionSignature DeclarationFragmentsBuilder::getFunctionSignature ( const FunctionT * Function )

static

Build FunctionSignature for a function-like declaration FunctionT like FunctionDecl, ObjCMethodDecl, or CXXMethodDecl.

The logic and implementation of building a signature for a FunctionDecl, CXXMethodDecl, and ObjCMethodDecl are exactly the same, but they do not share a common base. This template helps reuse the code.

Definition at line 417 of file DeclarationFragments.h.

References clang::extractapi::FunctionSignature::addParameter(), clang::extractapi::DeclarationFragments::append(), clang::extractapi::DeclarationFragments::begin(), getNameForTemplateArgument(), and clang::extractapi::FunctionSignature::setReturnType().

Referenced by clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::recordObjCMethods(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConstructorDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXConversionDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXDestructorDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitCXXMethodDecl(), clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitFunctionDecl(), and clang::extractapi::impl::ExtractAPIVisitorBase< Derived >::VisitFunctionTemplateDecl().

◆ getNameForTemplateArgument()

std::string DeclarationFragmentsBuilder::getNameForTemplateArgument	(	const ArrayRef< NamedDecl * >	TemplateParameters,
		std::string	TypeParameter
	)

static

Definition at line 855 of file DeclarationFragments.cpp.

References getName(), and clang::Parameter.

Referenced by getFragmentsForFunction(), getFragmentsForTemplateArguments(), getFragmentsForVarTemplate(), and getFunctionSignature().

◆ getSubHeading() [1/2]

DeclarationFragments DeclarationFragmentsBuilder::getSubHeading ( const NamedDecl * Decl )

static

Build sub-heading fragments for a NamedDecl.

Definition at line 1315 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::getAsString(), clang::Decl::getDeclContext(), and clang::extractapi::DeclarationFragments::Identifier.

◆ getSubHeading() [2/2]

DeclarationFragments DeclarationFragmentsBuilder::getSubHeading ( const ObjCMethodDecl * Method )

static

Build sub-heading fragments for an Objective-C method.

Definition at line 1337 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), clang::NamedDecl::getNameAsString(), clang::extractapi::DeclarationFragments::Identifier, clang::ObjCMethodDecl::isClassMethod(), clang::ObjCMethodDecl::isInstanceMethod(), and clang::extractapi::DeclarationFragments::Text.

◆ getSubHeadingForMacro()

DeclarationFragments DeclarationFragmentsBuilder::getSubHeadingForMacro ( StringRef Name )

static

Build a sub-heading for macro Name.

Definition at line 1350 of file DeclarationFragments.cpp.

References clang::extractapi::DeclarationFragments::append(), and clang::extractapi::DeclarationFragments::Identifier.

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

include/clang/ExtractAPI/DeclarationFragments.h
lib/ExtractAPI/DeclarationFragments.cpp

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ getAccessControl()

◆ getFragmentsForClassTemplatePartialSpecialization()

◆ getFragmentsForClassTemplateSpecialization()

◆ getFragmentsForConcept()

◆ getFragmentsForConversionFunction()

◆ getFragmentsForCXXClass()

◆ getFragmentsForCXXMethod()

◆ getFragmentsForEnum()

◆ getFragmentsForEnumConstant()

◆ getFragmentsForField()

◆ getFragmentsForFunction()

◆ getFragmentsForFunctionTemplate()

◆ getFragmentsForFunctionTemplateSpecialization()

◆ getFragmentsForMacro()

◆ getFragmentsForNamespace()

◆ getFragmentsForObjCCategory()

◆ getFragmentsForObjCInterface()

◆ getFragmentsForObjCMethod()

◆ getFragmentsForObjCProperty()

◆ getFragmentsForObjCProtocol()

◆ getFragmentsForOverloadedOperator()

◆ getFragmentsForRedeclarableTemplate()

◆ getFragmentsForSpecialCXXMethod()

◆ getFragmentsForStruct()

◆ getFragmentsForTemplateArguments()

◆ getFragmentsForTemplateParameters()

◆ getFragmentsForTypedef()

◆ getFragmentsForVar()

◆ getFragmentsForVarTemplate()

◆ getFragmentsForVarTemplatePartialSpecialization()

◆ getFragmentsForVarTemplateSpecialization()

◆ getFunctionSignature()

◆ getNameForTemplateArgument()

◆ getSubHeading() [1/2]

◆ getSubHeading() [2/2]

◆ getSubHeadingForMacro()