xref: /freebsd/contrib/llvm-project/llvm/include/llvm/DebugInfo/PDB/IPDBInjectedSource.h (revision 700637cbb5e582861067a11aaca4d053546871d2)
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/Compiler.h"
13 #include <cstdint>
14 #include <string>
15 
16 namespace llvm {
17 namespace pdb {
18 /// IPDBInjectedSource defines an interface used to represent source files
19 /// which were injected directly into the PDB file during the compilation
20 /// process.  This is used, for example, to add natvis files to a PDB, but
21 /// in theory could be used to add arbitrary source code.
22 class LLVM_ABI IPDBInjectedSource {
23 public:
24   virtual ~IPDBInjectedSource();
25 
26   virtual uint32_t getCrc32() const = 0;
27   virtual uint64_t getCodeByteSize() const = 0;
28   virtual std::string getFileName() const = 0;
29   virtual std::string getObjectFileName() const = 0;
30   virtual std::string getVirtualFileName() const = 0;
31   // The returned value depends on the PDB producer,
32   // but 0 is guaranteed to mean "no compression".
33   // The enum PDB_SourceCompression lists known return values.
34   virtual uint32_t getCompression() const = 0;
35   virtual std::string getCode() const = 0;
36 };
37 } // namespace pdb
38 } // namespace llvm
39 
40 #endif // LLVM_DEBUGINFO_PDB_IPDBINJECTEDSOURCE_H
41