contrib/llvm/tools/clang/lib/Index/IndexingContext.h

   1 //===- IndexingContext.h - Indexing context data ----------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLVM_CLANG_LIB_INDEX_INDEXINGCONTEXT_H
  11 #define LLVM_CLANG_LIB_INDEX_INDEXINGCONTEXT_H
  12
  13 #include "clang/Basic/LLVM.h"
  14 #include "clang/Index/IndexSymbol.h"
  15 #include "clang/Index/IndexingAction.h"
  16 #include "llvm/ADT/ArrayRef.h"
  17
  18 namespace clang {
  19   class ASTContext;
  20   class Decl;
  21   class DeclGroupRef;
  22   class ImportDecl;
  23   class TagDecl;
  24   class TypeSourceInfo;
  25   class NamedDecl;
  26   class ObjCMethodDecl;
  27   class DeclContext;
  28   class NestedNameSpecifierLoc;
  29   class Stmt;
  30   class Expr;
  31   class TypeLoc;
  32   class SourceLocation;
  33
  34 namespace index {
  35   class IndexDataConsumer;
  36
  37 class IndexingContext {
  38   IndexingOptions IndexOpts;
  39   IndexDataConsumer &DataConsumer;
  40   ASTContext *Ctx = nullptr;
  41
  42 public:
  43   IndexingContext(IndexingOptions IndexOpts, IndexDataConsumer &DataConsumer)
  44     : IndexOpts(IndexOpts), DataConsumer(DataConsumer) {}
  45
  46   const IndexingOptions &getIndexOpts() const { return IndexOpts; }
  47   IndexDataConsumer &getDataConsumer() { return DataConsumer; }
  48
  49   void setASTContext(ASTContext &ctx) { Ctx = &ctx; }
  50
  51   bool shouldSuppressRefs() const {
  52     return false;
  53   }
  54
  55   bool shouldIndexFunctionLocalSymbols() const;
  56
  57   bool shouldIndexImplicitTemplateInsts() const {
  58     return false;
  59   }
  60
  61   static bool isFunctionLocalDecl(const Decl *D);
  62   static bool isTemplateImplicitInstantiation(const Decl *D);
  63
  64   bool handleDecl(const Decl *D, SymbolRoleSet Roles = SymbolRoleSet(),
  65                   ArrayRef<SymbolRelation> Relations = None);
  66
  67   bool handleDecl(const Decl *D, SourceLocation Loc,
  68                   SymbolRoleSet Roles = SymbolRoleSet(),
  69                   ArrayRef<SymbolRelation> Relations = None,
  70                   const DeclContext *DC = nullptr);
  71
  72   bool handleReference(const NamedDecl *D, SourceLocation Loc,
  73                        const NamedDecl *Parent,
  74                        const DeclContext *DC,
  75                        SymbolRoleSet Roles,
  76                        ArrayRef<SymbolRelation> Relations = None,
  77                        const Expr *RefE = nullptr,
  78                        const Decl *RefD = nullptr);
  79
  80   bool importedModule(const ImportDecl *ImportD);
  81
  82   bool indexDecl(const Decl *D);
  83
  84   void indexTagDecl(const TagDecl *D);
  85
  86   void indexTypeSourceInfo(TypeSourceInfo *TInfo, const NamedDecl *Parent,
  87                            const DeclContext *DC = nullptr,
  88                            bool isBase = false,
  89                            bool isIBType = false);
  90
  91   void indexTypeLoc(TypeLoc TL, const NamedDecl *Parent,
  92                     const DeclContext *DC = nullptr,
  93                     bool isBase = false,
  94                     bool isIBType = false);
  95
  96   void indexNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS,
  97                                    const NamedDecl *Parent,
  98                                    const DeclContext *DC = nullptr);
  99
 100   bool indexDeclContext(const DeclContext *DC);
 101
 102   void indexBody(const Stmt *S, const NamedDecl *Parent,
 103                  const DeclContext *DC = nullptr);
 104
 105   bool indexTopLevelDecl(const Decl *D);
 106   bool indexDeclGroupRef(DeclGroupRef DG);
 107
 108 private:
 109   bool shouldIgnoreIfImplicit(const Decl *D);
 110
 111   bool handleDeclOccurrence(const Decl *D, SourceLocation Loc,
 112                             bool IsRef, const Decl *Parent,
 113                             SymbolRoleSet Roles,
 114                             ArrayRef<SymbolRelation> Relations,
 115                             const Expr *RefE,
 116                             const Decl *RefD,
 117                             const DeclContext *ContainerDC);
 118 };
 119
 120 } // end namespace index
 121 } // end namespace clang
 122
 123 #endif