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