summaryrefslogtreecommitdiffstats
path: root/include/clang/Index/Analyzer.h
blob: f6b5465148e6808310d976f11ddc86d3d3469db1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
//===--- Analyzer.h - Analysis for indexing information ---------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file declares the Analyzer interface.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_INDEX_ANALYZER_H
#define LLVM_CLANG_INDEX_ANALYZER_H

namespace clang {
  class Decl;
  class ObjCMessageExpr;

namespace idx {
  class Program;
  class IndexProvider;
  class TULocationHandler;

/// \brief Provides indexing information, like finding all references of an
/// Entity across translation units.
class Analyzer {
  Program &Prog;
  IndexProvider &Idxer;

  Analyzer(const Analyzer&); // do not implement
  Analyzer &operator=(const Analyzer &); // do not implement

public:
  explicit Analyzer(Program &prog, IndexProvider &idxer)
    : Prog(prog), Idxer(idxer) { }

  /// \brief Find all TULocations for declarations of the given Decl and pass
  /// them to Handler.
  void FindDeclarations(Decl *D, TULocationHandler &Handler);

  /// \brief Find all TULocations for references of the given Decl and pass
  /// them to Handler.
  void FindReferences(Decl *D, TULocationHandler &Handler);

  /// \brief Find methods that may respond to the given message and pass them
  /// to Handler.
  void FindObjCMethods(ObjCMessageExpr *MsgE, TULocationHandler &Handler);
};

} // namespace idx

} // namespace clang

#endif