blob: c79f6be3e13bfe653fcfead069f33c55e6c41356 [file] [log] [blame]
//===--- IndexDataConsumer.h - Abstract index data consumer -----*- C++ -*-===//
// The LLVM Compiler Infrastructure
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
#include "clang/Index/IndexSymbol.h"
#include "clang/Lex/Preprocessor.h"
namespace clang {
class ASTContext;
class DeclContext;
class Expr;
class FileID;
class IdentifierInfo;
class ImportDecl;
class MacroInfo;
namespace index {
class IndexDataConsumer {
struct ASTNodeInfo {
const Expr *OrigE;
const Decl *OrigD;
const Decl *Parent;
const DeclContext *ContainerDC;
virtual ~IndexDataConsumer() {}
virtual void initialize(ASTContext &Ctx) {}
virtual void setPreprocessor(std::shared_ptr<Preprocessor> PP) {}
/// \returns true to continue indexing, or false to abort.
virtual bool handleDeclOccurence(const Decl *D, SymbolRoleSet Roles,
ArrayRef<SymbolRelation> Relations,
SourceLocation Loc, ASTNodeInfo ASTNode);
/// \returns true to continue indexing, or false to abort.
virtual bool handleMacroOccurence(const IdentifierInfo *Name,
const MacroInfo *MI, SymbolRoleSet Roles,
SourceLocation Loc);
/// \returns true to continue indexing, or false to abort.
/// 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.
virtual bool handleModuleOccurence(const ImportDecl *ImportD,
const Module *Mod,
SymbolRoleSet Roles, SourceLocation Loc);
virtual void finish() {}
} // namespace index
} // namespace clang