xref: /freebsd/contrib/llvm-project/llvm/tools/llvm-pdbutil/ExplainOutputStyle.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1*0b57cec5SDimitry Andric //===- ExplainOutputStyle.h ----------------------------------- *- C++ --*-===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric 
9*0b57cec5SDimitry Andric #ifndef LLVM_TOOLS_LLVMPDBDUMP_EXPLAINOUTPUTSTYLE_H
10*0b57cec5SDimitry Andric #define LLVM_TOOLS_LLVMPDBDUMP_EXPLAINOUTPUTSTYLE_H
11*0b57cec5SDimitry Andric 
12*0b57cec5SDimitry Andric #include "LinePrinter.h"
13*0b57cec5SDimitry Andric #include "OutputStyle.h"
14*0b57cec5SDimitry Andric 
15*0b57cec5SDimitry Andric #include <string>
16*0b57cec5SDimitry Andric 
17*0b57cec5SDimitry Andric namespace llvm {
18*0b57cec5SDimitry Andric 
19*0b57cec5SDimitry Andric namespace pdb {
20*0b57cec5SDimitry Andric 
21*0b57cec5SDimitry Andric class DbiStream;
22*0b57cec5SDimitry Andric class InfoStream;
23*0b57cec5SDimitry Andric class InputFile;
24*0b57cec5SDimitry Andric 
25*0b57cec5SDimitry Andric class ExplainOutputStyle : public OutputStyle {
26*0b57cec5SDimitry Andric 
27*0b57cec5SDimitry Andric public:
28*0b57cec5SDimitry Andric   ExplainOutputStyle(InputFile &File, uint64_t FileOffset);
29*0b57cec5SDimitry Andric 
30*0b57cec5SDimitry Andric   Error dump() override;
31*0b57cec5SDimitry Andric 
32*0b57cec5SDimitry Andric private:
33*0b57cec5SDimitry Andric   Error explainPdbFile();
34*0b57cec5SDimitry Andric   Error explainBinaryFile();
35*0b57cec5SDimitry Andric 
36*0b57cec5SDimitry Andric   bool explainPdbBlockStatus();
37*0b57cec5SDimitry Andric 
38*0b57cec5SDimitry Andric   bool isPdbFpm1() const;
39*0b57cec5SDimitry Andric   bool isPdbFpm2() const;
40*0b57cec5SDimitry Andric 
41*0b57cec5SDimitry Andric   bool isPdbSuperBlock() const;
42*0b57cec5SDimitry Andric   bool isPdbFpmBlock() const;
43*0b57cec5SDimitry Andric   bool isPdbBlockMapBlock() const;
44*0b57cec5SDimitry Andric   bool isPdbStreamDirectoryBlock() const;
45*0b57cec5SDimitry Andric   Optional<uint32_t> getPdbBlockStreamIndex() const;
46*0b57cec5SDimitry Andric 
47*0b57cec5SDimitry Andric   void explainPdbSuperBlockOffset();
48*0b57cec5SDimitry Andric   void explainPdbFpmBlockOffset();
49*0b57cec5SDimitry Andric   void explainPdbBlockMapOffset();
50*0b57cec5SDimitry Andric   void explainPdbStreamDirectoryOffset();
51*0b57cec5SDimitry Andric   void explainPdbStreamOffset(uint32_t Stream);
52*0b57cec5SDimitry Andric   void explainPdbUnknownBlock();
53*0b57cec5SDimitry Andric 
54*0b57cec5SDimitry Andric   void explainStreamOffset(DbiStream &Stream, uint32_t OffsetInStream);
55*0b57cec5SDimitry Andric   void explainStreamOffset(InfoStream &Stream, uint32_t OffsetInStream);
56*0b57cec5SDimitry Andric 
57*0b57cec5SDimitry Andric   uint32_t pdbBlockIndex() const;
58*0b57cec5SDimitry Andric   uint32_t pdbBlockOffset() const;
59*0b57cec5SDimitry Andric 
60*0b57cec5SDimitry Andric   InputFile &File;
61*0b57cec5SDimitry Andric   const uint64_t FileOffset;
62*0b57cec5SDimitry Andric   LinePrinter P;
63*0b57cec5SDimitry Andric };
64*0b57cec5SDimitry Andric } // namespace pdb
65*0b57cec5SDimitry Andric } // namespace llvm
66*0b57cec5SDimitry Andric 
67*0b57cec5SDimitry Andric #endif
68