1//===- IPDBSession.h - base interface for a PDB symbol context --*- 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_DEBUGINFO_PDB_IPDBSESSION_H
11#define LLVM_DEBUGINFO_PDB_IPDBSESSION_H
12
13#include "PDBSymbol.h"
14#include "PDBTypes.h"
15#include "llvm/ADT/StringRef.h"
16#include "llvm/Support/Casting.h"
17#include <memory>
18
19namespace llvm {
20namespace pdb {
21class PDBSymbolCompiland;
22class PDBSymbolExe;
23
24/// IPDBSession defines an interface used to provide a context for querying
25/// debug information from a debug data source (for example, a PDB).
26class IPDBSession {
27public:
28  virtual ~IPDBSession();
29
30  virtual uint64_t getLoadAddress() const = 0;
31  virtual void setLoadAddress(uint64_t Address) = 0;
32  virtual std::unique_ptr<PDBSymbolExe> getGlobalScope() = 0;
33  virtual std::unique_ptr<PDBSymbol> getSymbolById(uint32_t SymbolId) const = 0;
34
35  template <typename T>
36  std::unique_ptr<T> getConcreteSymbolById(uint32_t SymbolId) const {
37    return unique_dyn_cast_or_null<T>(getSymbolById(SymbolId));
38  }
39
40  virtual std::unique_ptr<PDBSymbol>
41  findSymbolByAddress(uint64_t Address, PDB_SymType Type) const = 0;
42
43  virtual std::unique_ptr<IPDBEnumLineNumbers>
44  findLineNumbers(const PDBSymbolCompiland &Compiland,
45                  const IPDBSourceFile &File) const = 0;
46  virtual std::unique_ptr<IPDBEnumLineNumbers>
47  findLineNumbersByAddress(uint64_t Address, uint32_t Length) const = 0;
48
49  virtual std::unique_ptr<IPDBEnumSourceFiles>
50  findSourceFiles(const PDBSymbolCompiland *Compiland, llvm::StringRef Pattern,
51                  PDB_NameSearchFlags Flags) const = 0;
52  virtual std::unique_ptr<IPDBSourceFile>
53  findOneSourceFile(const PDBSymbolCompiland *Compiland,
54                    llvm::StringRef Pattern,
55                    PDB_NameSearchFlags Flags) const = 0;
56  virtual std::unique_ptr<IPDBEnumChildren<PDBSymbolCompiland>>
57  findCompilandsForSourceFile(llvm::StringRef Pattern,
58                              PDB_NameSearchFlags Flags) const = 0;
59  virtual std::unique_ptr<PDBSymbolCompiland>
60  findOneCompilandForSourceFile(llvm::StringRef Pattern,
61                                PDB_NameSearchFlags Flags) const = 0;
62
63  virtual std::unique_ptr<IPDBEnumSourceFiles> getAllSourceFiles() const = 0;
64  virtual std::unique_ptr<IPDBEnumSourceFiles>
65  getSourceFilesForCompiland(const PDBSymbolCompiland &Compiland) const = 0;
66  virtual std::unique_ptr<IPDBSourceFile>
67  getSourceFileById(uint32_t FileId) const = 0;
68
69  virtual std::unique_ptr<IPDBEnumDataStreams> getDebugStreams() const = 0;
70};
71}
72}
73
74#endif
75