Classes
class	CodegenNameGenerator

class	CommentToXMLConverter

class	IndexDataConsumer

class	IndexingContext

struct	IndexingOptions

class	SimpleFormatContext
	A small class to be used by libclang clients to format a declaration string in memory. More...

struct	SymbolInfo

struct	SymbolRelation
	Represents a relation to another symbol for a symbol occurrence. More...

Typedefs
typedef uint8_t	SymbolPropertySet

typedef unsigned	SymbolRoleSet

Enumerations
enum	SymbolKind : uint8_t { SymbolKind::Unknown, SymbolKind::Module, SymbolKind::Namespace, SymbolKind::NamespaceAlias, SymbolKind::Macro, SymbolKind::Enum, SymbolKind::Struct, SymbolKind::Class, SymbolKind::Protocol, SymbolKind::Extension, SymbolKind::Union, SymbolKind::TypeAlias, SymbolKind::Function, SymbolKind::Variable, SymbolKind::Field, SymbolKind::EnumConstant, SymbolKind::InstanceMethod, SymbolKind::ClassMethod, SymbolKind::StaticMethod, SymbolKind::InstanceProperty, SymbolKind::ClassProperty, SymbolKind::StaticProperty, SymbolKind::Constructor, SymbolKind::Destructor, SymbolKind::ConversionFunction, SymbolKind::Parameter, SymbolKind::Using }

enum	SymbolLanguage : uint8_t { SymbolLanguage::C, SymbolLanguage::ObjC, SymbolLanguage::CXX, SymbolLanguage::Swift }

enum	SymbolSubKind : uint8_t { SymbolSubKind::None, SymbolSubKind::CXXCopyConstructor, SymbolSubKind::CXXMoveConstructor, SymbolSubKind::AccessorGetter, SymbolSubKind::AccessorSetter, SymbolSubKind::UsingTypename, SymbolSubKind::UsingValue }
	Language specific sub-kinds. More...

enum	SymbolProperty : SymbolPropertySet { SymbolProperty::Generic = 1 << 0, SymbolProperty::TemplatePartialSpecialization = 1 << 1, SymbolProperty::TemplateSpecialization = 1 << 2, SymbolProperty::UnitTest = 1 << 3, SymbolProperty::IBAnnotated = 1 << 4, SymbolProperty::IBOutletCollection = 1 << 5, SymbolProperty::GKInspectable = 1 << 6, SymbolProperty::Local = 1 << 7 }
	Set of properties that provide additional info about a symbol. More...

enum	SymbolRole : uint32_t { SymbolRole::Declaration = 1 << 0, SymbolRole::Definition = 1 << 1, SymbolRole::Reference = 1 << 2, SymbolRole::Read = 1 << 3, SymbolRole::Write = 1 << 4, SymbolRole::Call = 1 << 5, SymbolRole::Dynamic = 1 << 6, SymbolRole::AddressOf = 1 << 7, SymbolRole::Implicit = 1 << 8, SymbolRole::RelationChildOf = 1 << 9, SymbolRole::RelationBaseOf = 1 << 10, SymbolRole::RelationOverrideOf = 1 << 11, SymbolRole::RelationReceivedBy = 1 << 12, SymbolRole::RelationCalledBy = 1 << 13, SymbolRole::RelationExtendedBy = 1 << 14, SymbolRole::RelationAccessorOf = 1 << 15, SymbolRole::RelationContainedBy = 1 << 16, SymbolRole::RelationIBTypeOf = 1 << 17, SymbolRole::RelationSpecializationOf = 1 << 18 }
	Set of roles that are attributed to symbol occurrences. More...

Functions
std::unique_ptr< FrontendAction >	createIndexingAction (std::shared_ptr< IndexDataConsumer > DataConsumer, IndexingOptions Opts, std::unique_ptr< FrontendAction > WrappedAction)

void	indexASTUnit (ASTUnit &Unit, IndexDataConsumer &DataConsumer, IndexingOptions Opts)

void	indexTopLevelDecls (ASTContext &Ctx, ArrayRef< const Decl *> Decls, IndexDataConsumer &DataConsumer, IndexingOptions Opts)

void	indexModuleFile (serialization::ModuleFile &Mod, ASTReader &Reader, IndexDataConsumer &DataConsumer, IndexingOptions Opts)

SymbolInfo	getSymbolInfo (const Decl *D)

bool	isFunctionLocalSymbol (const Decl *D)

void	applyForEachSymbolRole (SymbolRoleSet Roles, llvm::function_ref< void(SymbolRole)> Fn)

bool	applyForEachSymbolRoleInterruptible (SymbolRoleSet Roles, llvm::function_ref< bool(SymbolRole)> Fn)

void	printSymbolRoles (SymbolRoleSet Roles, raw_ostream &OS)

bool	printSymbolName (const Decl *D, const LangOptions &LO, raw_ostream &OS)

StringRef	getSymbolKindString (SymbolKind K)

StringRef	getSymbolSubKindString (SymbolSubKind K)

StringRef	getSymbolLanguageString (SymbolLanguage K)

void	applyForEachSymbolProperty (SymbolPropertySet Props, llvm::function_ref< void(SymbolProperty)> Fn)

void	printSymbolProperties (SymbolPropertySet Props, raw_ostream &OS)

static StringRef	getUSRSpacePrefix ()

bool	generateUSRForDecl (const Decl *D, SmallVectorImpl< char > &Buf)
	Generate a USR for a Decl, including the USR prefix. More...

void	generateUSRForObjCClass (StringRef Cls, raw_ostream &OS, StringRef ExtSymbolDefinedIn="", StringRef CategoryContextExtSymbolDefinedIn="")
	Generate a USR fragment for an Objective-C class. More...

void	generateUSRForObjCCategory (StringRef Cls, StringRef Cat, raw_ostream &OS, StringRef ClsExtSymbolDefinedIn="", StringRef CatExtSymbolDefinedIn="")
	Generate a USR fragment for an Objective-C class category. More...

void	generateUSRForObjCIvar (StringRef Ivar, raw_ostream &OS)
	Generate a USR fragment for an Objective-C instance variable. More...

void	generateUSRForObjCMethod (StringRef Sel, bool IsInstanceMethod, raw_ostream &OS)
	Generate a USR fragment for an Objective-C method. More...

void	generateUSRForObjCProperty (StringRef Prop, bool isClassProp, raw_ostream &OS)
	Generate a USR fragment for an Objective-C property. More...

void	generateUSRForObjCProtocol (StringRef Prot, raw_ostream &OS, StringRef ExtSymbolDefinedIn="")
	Generate a USR fragment for an Objective-C protocol. More...

void	generateUSRForGlobalEnum (StringRef EnumName, raw_ostream &OS, StringRef ExtSymbolDefinedIn="")
	Generate USR fragment for a global (non-nested) enum. More...

void	generateUSRForEnumConstant (StringRef EnumConstantName, raw_ostream &OS)
	Generate a USR fragment for an enum constant. More...

bool	generateUSRForMacro (const MacroDefinitionRecord *MD, const SourceManager &SM, SmallVectorImpl< char > &Buf)
	Generate a USR for a macro, including the USR prefix. More...

bool	generateUSRForMacro (StringRef MacroName, SourceLocation Loc, const SourceManager &SM, SmallVectorImpl< char > &Buf)

Variables
static const unsigned	SymbolPropertyBitNum = 8

static const unsigned	SymbolRoleBitNum = 19

Typedef Documentation

◆ SymbolPropertySet

typedef uint8_t clang::index::SymbolPropertySet

Definition at line 77 of file IndexSymbol.h.

◆ SymbolRoleSet

typedef unsigned clang::index::SymbolRoleSet

Definition at line 118 of file IndexSymbol.h.

Enumeration Type Documentation

◆ SymbolKind

enum clang::index::SymbolKind : uint8_t

strong

Enumerator
Unknown
Module
Namespace
NamespaceAlias
Macro
Enum
Struct
Class
Protocol
Extension
Union
TypeAlias
Function
Variable
Field
EnumConstant
InstanceMethod
ClassMethod
StaticMethod
InstanceProperty
ClassProperty
StaticProperty
Constructor
Destructor
ConversionFunction
Parameter
Using

Definition at line 23 of file IndexSymbol.h.

◆ SymbolLanguage

enum clang::index::SymbolLanguage : uint8_t

strong

Enumerator
C
ObjC
CXX
Swift

Definition at line 59 of file IndexSymbol.h.

◆ SymbolProperty

enum clang::index::SymbolProperty : SymbolPropertySet

strong

Set of properties that provide additional info about a symbol.

Enumerator
Generic
TemplatePartialSpecialization
TemplateSpecialization
UnitTest
IBAnnotated
IBOutletCollection
GKInspectable
Local

Definition at line 79 of file IndexSymbol.h.

◆ SymbolRole

enum clang::index::SymbolRole : uint32_t

strong

Set of roles that are attributed to symbol occurrences.

Low 9 bits of clang-c/include/Index.h CXSymbolRole mirrors this enum.

Enumerator
Declaration
Definition
Reference
Read
Write
Call
Dynamic
AddressOf
Implicit
RelationChildOf
RelationBaseOf
RelationOverrideOf
RelationReceivedBy
RelationCalledBy
RelationExtendedBy
RelationAccessorOf
RelationContainedBy
RelationIBTypeOf
RelationSpecializationOf

Definition at line 94 of file IndexSymbol.h.

◆ SymbolSubKind

enum clang::index::SymbolSubKind : uint8_t

strong

Language specific sub-kinds.

Enumerator
None
CXXCopyConstructor
CXXMoveConstructor
AccessorGetter
AccessorSetter
UsingTypename
UsingValue

Definition at line 67 of file IndexSymbol.h.

Function Documentation

◆ applyForEachSymbolProperty()

void clang::index::applyForEachSymbolProperty	(	SymbolPropertySet	Props,
		llvm::function_ref< void(SymbolProperty)>	Fn
	)

Definition at line 496 of file IndexSymbol.cpp.

References APPLY_FOR_PROPERTY, Generic, GKInspectable, IBAnnotated, IBOutletCollection, Local, TemplatePartialSpecialization, TemplateSpecialization, and UnitTest.

Referenced by printSymbolProperties().

◆ applyForEachSymbolRole()

void clang::index::applyForEachSymbolRole	(	SymbolRoleSet	Roles,
		llvm::function_ref< void(SymbolRole)>	Fn
	)

Definition at line 383 of file IndexSymbol.cpp.

References applyForEachSymbolRoleInterruptible().

Referenced by printSymbolRoles().

◆ applyForEachSymbolRoleInterruptible()

bool clang::index::applyForEachSymbolRoleInterruptible	(	SymbolRoleSet	Roles,
		llvm::function_ref< bool(SymbolRole)>	Fn
	)

Definition at line 351 of file IndexSymbol.cpp.

References AddressOf, APPLY_FOR_ROLE, Call, Declaration, Definition, Dynamic, Implicit, Read, Reference, RelationAccessorOf, RelationBaseOf, RelationCalledBy, RelationChildOf, RelationContainedBy, RelationExtendedBy, RelationIBTypeOf, RelationOverrideOf, RelationReceivedBy, RelationSpecializationOf, and Write.

Referenced by applyForEachSymbolRole(), and shouldReportOccurrenceForSystemDeclOnlyMode().

◆ createIndexingAction()

std::unique_ptr< FrontendAction > clang::index::createIndexingAction	(	std::shared_ptr< IndexDataConsumer >	DataConsumer,
		IndexingOptions	Opts,
		std::unique_ptr< FrontendAction >	WrappedAction
	)

Parameters

WrappedAction another frontend action to wrap over or null.

Definition at line 156 of file IndexingAction.cpp.

◆ generateUSRForDecl()

bool clang::index::generateUSRForDecl	(	const Decl *	D,
		SmallVectorImpl< char > &	Buf
	)

Generate a USR for a Decl, including the USR prefix.

Returns: true if the results should be ignored, false otherwise.

Definition at line 1054 of file USRGeneration.cpp.

Referenced by clang::cross_tu::CrossTranslationUnitContext::getLookupName(), clang::tooling::getUSRForDecl(), and getUSRSpacePrefix().

◆ generateUSRForEnumConstant()

void clang::index::generateUSRForEnumConstant	(	StringRef	EnumConstantName,
		raw_ostream &	OS
	)

Generate a USR fragment for an enum constant.

Definition at line 1049 of file USRGeneration.cpp.

Referenced by getUSRSpacePrefix().

◆ generateUSRForGlobalEnum()

void clang::index::generateUSRForGlobalEnum	(	StringRef	EnumName,
		raw_ostream &	OS,
		StringRef	ExtSymbolDefinedIn = `""`
	)

Generate USR fragment for a global (non-nested) enum.

Definition at line 1042 of file USRGeneration.cpp.

Referenced by getUSRSpacePrefix().

◆ generateUSRForMacro() [1/2]

bool clang::index::generateUSRForMacro	(	const MacroDefinitionRecord *	MD,
		const SourceManager &	SM,
		SmallVectorImpl< char > &	Buf
	)

Generate a USR for a macro, including the USR prefix.

Returns: true on error, false on success.

Definition at line 1067 of file USRGeneration.cpp.

References clang::MacroDefinitionRecord::getLocation(), clang::IdentifierInfo::getName(), clang::MacroDefinitionRecord::getName(), and SM.

Referenced by getUSRSpacePrefix().

◆ generateUSRForMacro() [2/2]

bool clang::index::generateUSRForMacro	(	StringRef	MacroName,
		SourceLocation	Loc,
		const SourceManager &	SM,
		SmallVectorImpl< char > &	Buf
	)

Definition at line 1077 of file USRGeneration.cpp.

References getUSRSpacePrefix(), clang::SourceManager::isInSystemHeader(), clang::SourceLocation::isInvalid(), and printLoc().

◆ generateUSRForObjCCategory()

void clang::index::generateUSRForObjCCategory	(	StringRef	Cls,
		StringRef	Cat,
		raw_ostream &	OS,
		StringRef	ClsExtSymbolDefinedIn = `""`,
		StringRef	CatExtSymbolDefinedIn = `""`
	)

Generate a USR fragment for an Objective-C class category.

Definition at line 1012 of file USRGeneration.cpp.

Referenced by getUSRSpacePrefix().

◆ generateUSRForObjCClass()

void clang::index::generateUSRForObjCClass	(	StringRef	Cls,
		raw_ostream &	OS,
		StringRef	ExtSymbolDefinedIn = `""`,
		StringRef	CategoryContextExtSymbolDefinedIn = `""`
	)

Generate a USR fragment for an Objective-C class.

Definition at line 1004 of file USRGeneration.cpp.

Referenced by getUSRSpacePrefix().

◆ generateUSRForObjCIvar()

void clang::index::generateUSRForObjCIvar	(	StringRef	Ivar,
		raw_ostream &	OS
	)

Generate a USR fragment for an Objective-C instance variable.

The complete USR can be created by concatenating the USR for the encompassing class with this USR fragment.

Definition at line 1020 of file USRGeneration.cpp.

Referenced by getUSRSpacePrefix().

◆ generateUSRForObjCMethod()

void clang::index::generateUSRForObjCMethod	(	StringRef	Sel,
		bool	IsInstanceMethod,
		raw_ostream &	OS
	)

Generate a USR fragment for an Objective-C method.

Definition at line 1024 of file USRGeneration.cpp.

Referenced by getUSRSpacePrefix().

◆ generateUSRForObjCProperty()

void clang::index::generateUSRForObjCProperty	(	StringRef	Prop,
		bool	isClassProp,
		raw_ostream &	OS
	)

Generate a USR fragment for an Objective-C property.

Definition at line 1030 of file USRGeneration.cpp.

Referenced by getUSRSpacePrefix().

◆ generateUSRForObjCProtocol()

void clang::index::generateUSRForObjCProtocol	(	StringRef	Prot,
		raw_ostream &	OS,
		StringRef	ExtSymbolDefinedIn = `""`
	)

Generate a USR fragment for an Objective-C protocol.

Definition at line 1035 of file USRGeneration.cpp.

Referenced by getUSRSpacePrefix().

◆ getSymbolInfo()

SymbolInfo clang::index::getSymbolInfo ( const Decl * D )

Definition at line 87 of file IndexSymbol.cpp.

References AccessorGetter, AccessorSetter, C, checkForIBOutlets(), Class, ClassMethod, Constructor, ConversionFunction, CXX, CXXCopyConstructor, CXXMoveConstructor, Destructor, Enum, EnumConstant, Extension, Field, Function, Generic, clang::Decl::getAttr(), clang::Decl::getDeclContext(), clang::Decl::getKind(), GKInspectable, clang::Decl::hasAttr(), IBAnnotated, clang::if(), InstanceMethod, InstanceProperty, isFunctionLocalSymbol(), clang::ObjCMethodDecl::isInstanceMethod(), clang::ObjCMethodDecl::isPropertyAccessor(), clang::CXXMethodDecl::isStatic(), isUnitTest(), isUnitTestCase(), clang::index::SymbolInfo::Kind, clang::index::SymbolInfo::Lang, Local, Module, Namespace, NamespaceAlias, None, ObjC, clang::ObjCMethodDecl::param_size(), Parameter, clang::index::SymbolInfo::Properties, Protocol, StaticMethod, StaticProperty, Struct, clang::index::SymbolInfo::SubKind, Swift, TemplatePartialSpecialization, TemplateSpecialization, clang::FunctionDecl::TK_FunctionTemplateSpecialization, clang::TTK_Class, clang::TTK_Enum, clang::TTK_Interface, clang::TTK_Struct, clang::TTK_Union, TypeAlias, Union, UnitTest, Unknown, Using, UsingTypename, UsingValue, and Variable.

◆ getSymbolKindString()

StringRef clang::index::getSymbolKindString ( SymbolKind K )

Definition at line 440 of file IndexSymbol.cpp.

References Class, ClassMethod, ClassProperty, Constructor, ConversionFunction, Destructor, Enum, EnumConstant, Extension, Field, Function, InstanceMethod, InstanceProperty, Macro, Module, Namespace, NamespaceAlias, Parameter, Protocol, StaticMethod, StaticProperty, Struct, TypeAlias, Union, Unknown, Using, and Variable.

◆ getSymbolLanguageString()

StringRef clang::index::getSymbolLanguageString ( SymbolLanguage K )

Definition at line 486 of file IndexSymbol.cpp.

References C, CXX, ObjC, and Swift.

◆ getSymbolSubKindString()

StringRef clang::index::getSymbolSubKindString ( SymbolSubKind K )

Definition at line 473 of file IndexSymbol.cpp.

References AccessorGetter, AccessorSetter, CXXCopyConstructor, CXXMoveConstructor, None, UsingTypename, and UsingValue.

◆ getUSRSpacePrefix()

static StringRef clang::index::getUSRSpacePrefix ( )

inlinestatic

Definition at line 24 of file USRGeneration.h.

References generateUSRForDecl(), generateUSRForEnumConstant(), generateUSRForGlobalEnum(), generateUSRForMacro(), generateUSRForObjCCategory(), generateUSRForObjCClass(), generateUSRForObjCIvar(), generateUSRForObjCMethod(), generateUSRForObjCProperty(), generateUSRForObjCProtocol(), and SM.

Referenced by generateUSRForMacro().

◆ indexASTUnit()

void clang::index::indexASTUnit	(	ASTUnit &	Unit,
		IndexDataConsumer &	DataConsumer,
		IndexingOptions	Opts
	)

Definition at line 176 of file IndexingAction.cpp.

References clang::index::IndexDataConsumer::finish(), clang::ASTUnit::getASTContext(), clang::ASTUnit::getPreprocessorPtr(), indexTranslationUnit(), clang::index::IndexDataConsumer::initialize(), clang::index::IndexingContext::setASTContext(), and clang::index::IndexDataConsumer::setPreprocessor().

◆ indexModuleFile()

void clang::index::indexModuleFile	(	serialization::ModuleFile &	Mod,
		ASTReader &	Reader,
		IndexDataConsumer &	DataConsumer,
		IndexingOptions	Opts
	)

Definition at line 198 of file IndexingAction.cpp.

References clang::index::IndexDataConsumer::finish(), clang::ASTReader::getContext(), clang::ASTReader::getModuleFileLevelDecls(), clang::index::IndexingContext::indexTopLevelDecl(), clang::index::IndexDataConsumer::initialize(), and clang::index::IndexingContext::setASTContext().

◆ indexTopLevelDecls()

void clang::index::indexTopLevelDecls	(	ASTContext &	Ctx,
		ArrayRef< const Decl *>	Decls,
		IndexDataConsumer &	DataConsumer,
		IndexingOptions	Opts
	)

Definition at line 186 of file IndexingAction.cpp.

References clang::index::IndexDataConsumer::finish(), clang::index::IndexingContext::indexTopLevelDecl(), clang::index::IndexDataConsumer::initialize(), and clang::index::IndexingContext::setASTContext().

◆ isFunctionLocalSymbol()

bool clang::index::isFunctionLocalSymbol ( const Decl * D )

Definition at line 52 of file IndexSymbol.cpp.

References clang::ExternalLinkage, clang::Decl::getParentFunctionOrMethod(), clang::InternalLinkage, clang::ModuleInternalLinkage, clang::ModuleLinkage, clang::NoLinkage, clang::UniqueExternalLinkage, and clang::VisibleNoLinkage.

Referenced by getSymbolInfo(), clang::index::IndexingContext::handleReference(), clang::index::IndexingContext::indexTagDecl(), and shouldReportOccurrenceForSystemDeclOnlyMode().

◆ printSymbolName()

bool clang::index::printSymbolName	(	const Decl *	D,
		const LangOptions &	LO,
		raw_ostream &	OS
	)

Returns: true if no name was printed, false otherwise.

Definition at line 422 of file IndexSymbol.cpp.

References clang::DeclarationName::isEmpty(), clang::DeclarationName::print(), and clang::PrintingPolicy::SuppressTemplateArgsInCXXConstructors.

◆ printSymbolProperties()

void clang::index::printSymbolProperties	(	SymbolPropertySet	Props,
		raw_ostream &	OS
	)

Definition at line 514 of file IndexSymbol.cpp.

References applyForEachSymbolProperty(), Generic, GKInspectable, IBAnnotated, IBOutletCollection, Local, TemplatePartialSpecialization, TemplateSpecialization, and UnitTest.

◆ printSymbolRoles()

void clang::index::printSymbolRoles	(	SymbolRoleSet	Roles,
		raw_ostream &	OS
	)

Definition at line 391 of file IndexSymbol.cpp.

References AddressOf, applyForEachSymbolRole(), Call, Declaration, Definition, Dynamic, Implicit, Read, Reference, RelationAccessorOf, RelationBaseOf, RelationCalledBy, RelationChildOf, RelationContainedBy, RelationExtendedBy, RelationIBTypeOf, RelationOverrideOf, RelationReceivedBy, RelationSpecializationOf, and Write.

Variable Documentation

◆ SymbolPropertyBitNum

const unsigned clang::index::SymbolPropertyBitNum = 8

static

Definition at line 89 of file IndexSymbol.h.

◆ SymbolRoleBitNum

const unsigned clang::index::SymbolRoleBitNum = 19

static

Definition at line 117 of file IndexSymbol.h.

Classes

Typedefs

Enumerations

Functions

Variables

Typedef Documentation

◆ SymbolPropertySet

◆ SymbolRoleSet

Enumeration Type Documentation

◆ SymbolKind

◆ SymbolLanguage

◆ SymbolProperty

◆ SymbolRole

◆ SymbolSubKind

Function Documentation

◆ applyForEachSymbolProperty()

◆ applyForEachSymbolRole()

◆ applyForEachSymbolRoleInterruptible()

◆ createIndexingAction()

◆ generateUSRForDecl()

◆ generateUSRForEnumConstant()

◆ generateUSRForGlobalEnum()

◆ generateUSRForMacro() [1/2]

◆ generateUSRForMacro() [2/2]

◆ generateUSRForObjCCategory()

◆ generateUSRForObjCClass()

◆ generateUSRForObjCIvar()

◆ generateUSRForObjCMethod()

◆ generateUSRForObjCProperty()

◆ generateUSRForObjCProtocol()

◆ getSymbolInfo()

◆ getSymbolKindString()

◆ getSymbolLanguageString()

◆ getSymbolSubKindString()

◆ getUSRSpacePrefix()

◆ indexASTUnit()

◆ indexModuleFile()

◆ indexTopLevelDecls()

◆ isFunctionLocalSymbol()

◆ printSymbolName()

◆ printSymbolProperties()

◆ printSymbolRoles()

Variable Documentation

◆ SymbolPropertyBitNum

◆ SymbolRoleBitNum