class IndexDataConsumer

Declaration

class IndexDataConsumer { /* full declaration omitted */ };

Declared at: clang/include/clang/Index/IndexDataConsumer.h:26

Method Overview

• public virtual void finish()
• public virtual bool handleDeclOccurrence(const clang::Decl * D, clang::index::SymbolRoleSet Roles, ArrayRef<clang::index::SymbolRelation> Relations, clang::SourceLocation Loc, clang::index::IndexDataConsumer::ASTNodeInfo ASTNode)
• public virtual bool handleMacroOccurrence(const clang::IdentifierInfo * Name, const clang::MacroInfo * MI, clang::index::SymbolRoleSet Roles, clang::SourceLocation Loc)
• public virtual bool handleModuleOccurrence(const clang::ImportDecl * ImportD, const clang::Module * Mod, clang::index::SymbolRoleSet Roles, clang::SourceLocation Loc)
• public virtual void initialize(clang::ASTContext & Ctx)
• public virtual void setPreprocessor(std::shared_ptr<Preprocessor> PP)
• public virtual ~IndexDataConsumer()

Methods

¶virtual void finish()

Declared at: clang/include/clang/Index/IndexDataConsumer.h:66

¶virtual bool handleDeclOccurrence(
    const clang::Decl* D,
    clang::index::SymbolRoleSet Roles,
    ArrayRef<clang::index::SymbolRelation>
        Relations,
    clang::SourceLocation Loc,
    clang::index::IndexDataConsumer::ASTNodeInfo
        ASTNode)

Declared at: clang/include/clang/Index/IndexDataConsumer.h:42

Parameters

const clang::Decl* D

clang::index::SymbolRoleSet Roles

ArrayRef<clang::index::SymbolRelation> Relations

clang::SourceLocation Loc

clang::index::IndexDataConsumer::ASTNodeInfo ASTNode

Returns

true to continue indexing, or false to abort.

¶virtual bool handleMacroOccurrence(
    const clang::IdentifierInfo* Name,
    const clang::MacroInfo* MI,
    clang::index::SymbolRoleSet Roles,
    clang::SourceLocation Loc)

Declared at: clang/include/clang/Index/IndexDataConsumer.h:49

Parameters

const clang::IdentifierInfo* Name

const clang::MacroInfo* MI

clang::index::SymbolRoleSet Roles

clang::SourceLocation Loc

Returns

true to continue indexing, or false to abort.

¶virtual bool handleModuleOccurrence(
    const clang::ImportDecl* ImportD,
    const clang::Module* Mod,
    clang::index::SymbolRoleSet Roles,
    clang::SourceLocation Loc)

Description

This will be called for each module reference in an import decl. For "@import MyMod.SubMod", there will be a call for 'MyMod' with the 'reference' role, and a call for 'SubMod' with the 'declaration' role.

Declared at: clang/include/clang/Index/IndexDataConsumer.h:60

Parameters

const clang::ImportDecl* ImportD

const clang::Module* Mod

clang::index::SymbolRoleSet Roles

clang::SourceLocation Loc

Returns

true to continue indexing, or false to abort.

¶virtual void initialize(clang::ASTContext& Ctx)

Declared at: clang/include/clang/Index/IndexDataConsumer.h:37

Parameters

clang::ASTContext& Ctx

¶virtual void setPreprocessor(
    std::shared_ptr<Preprocessor> PP)

Declared at: clang/include/clang/Index/IndexDataConsumer.h:39

Parameters

std::shared_ptr<Preprocessor> PP

¶virtual ~IndexDataConsumer()

Declared at: clang/include/clang/Index/IndexDataConsumer.h:35