1//===- IPDBInjectedSource.h - base class for PDB injected file --*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_DEBUGINFO_PDB_IPDBINJECTEDSOURCE_H
10#define LLVM_DEBUGINFO_PDB_IPDBINJECTEDSOURCE_H
11
12#include "llvm/Support/raw_ostream.h"
13#include <memory>
14#include <string>
15
16namespace llvm {
17class raw_ostream;
18
19namespace pdb {
20
21/// IPDBInjectedSource defines an interface used to represent source files
22/// which were injected directly into the PDB file during the compilation
23/// process.  This is used, for example, to add natvis files to a PDB, but
24/// in theory could be used to add arbitrary source code.
25class IPDBInjectedSource {
26public:
27  virtual ~IPDBInjectedSource();
28
29  virtual uint32_t getCrc32() const = 0;
30  virtual uint64_t getCodeByteSize() const = 0;
31  virtual std::string getFileName() const = 0;
32  virtual std::string getObjectFileName() const = 0;
33  virtual std::string getVirtualFileName() const = 0;
34  // The returned value depends on the PDB producer,
35  // but 0 is guaranteed to mean "no compression".
36  // The enum PDB_SourceCompression lists known return values.
37  virtual uint32_t getCompression() const = 0;
38  virtual std::string getCode() const = 0;
39};
40} // namespace pdb
41} // namespace llvm
42
43#endif // LLVM_DEBUGINFO_PDB_IPDBINJECTEDSOURCE_H
44