xref: /freebsd-src/contrib/llvm-project/llvm/tools/llvm-pdbutil/PrettyClassLayoutGraphicalDumper.h (revision 5f757f3ff9144b609b3c433dfd370cc6bdc191ad)
1*0b57cec5SDimitry Andric //===- PrettyClassLayoutGraphicalDumper.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_PRETTYCLASSLAYOUTGRAPHICALDUMPER_H
10*0b57cec5SDimitry Andric #define LLVM_TOOLS_LLVMPDBDUMP_PRETTYCLASSLAYOUTGRAPHICALDUMPER_H
11*0b57cec5SDimitry Andric 
12*0b57cec5SDimitry Andric #include "llvm/DebugInfo/PDB/PDBSymDumper.h"
13*0b57cec5SDimitry Andric 
14*0b57cec5SDimitry Andric namespace llvm {
15*0b57cec5SDimitry Andric 
16*0b57cec5SDimitry Andric namespace pdb {
17*0b57cec5SDimitry Andric 
18*0b57cec5SDimitry Andric class UDTLayoutBase;
19*0b57cec5SDimitry Andric class LayoutItemBase;
20*0b57cec5SDimitry Andric class LinePrinter;
21*0b57cec5SDimitry Andric 
22*0b57cec5SDimitry Andric class PrettyClassLayoutGraphicalDumper : public PDBSymDumper {
23*0b57cec5SDimitry Andric public:
24*0b57cec5SDimitry Andric   PrettyClassLayoutGraphicalDumper(LinePrinter &P, uint32_t RecurseLevel,
25*0b57cec5SDimitry Andric                                    uint32_t InitialOffset);
26*0b57cec5SDimitry Andric 
27*0b57cec5SDimitry Andric   bool start(const UDTLayoutBase &Layout);
28*0b57cec5SDimitry Andric 
29*0b57cec5SDimitry Andric   // Layout based symbol types.
30*0b57cec5SDimitry Andric   void dump(const PDBSymbolTypeBaseClass &Symbol) override;
31*0b57cec5SDimitry Andric   void dump(const PDBSymbolData &Symbol) override;
32*0b57cec5SDimitry Andric   void dump(const PDBSymbolTypeVTable &Symbol) override;
33*0b57cec5SDimitry Andric 
34*0b57cec5SDimitry Andric   // Non layout-based symbol types.
35*0b57cec5SDimitry Andric   void dump(const PDBSymbolTypeEnum &Symbol) override;
36*0b57cec5SDimitry Andric   void dump(const PDBSymbolFunc &Symbol) override;
37*0b57cec5SDimitry Andric   void dump(const PDBSymbolTypeTypedef &Symbol) override;
38*0b57cec5SDimitry Andric   void dump(const PDBSymbolTypeUDT &Symbol) override;
39*0b57cec5SDimitry Andric   void dump(const PDBSymbolTypeBuiltin &Symbol) override;
40*0b57cec5SDimitry Andric 
41*0b57cec5SDimitry Andric private:
42*0b57cec5SDimitry Andric   bool shouldRecurse() const;
43*0b57cec5SDimitry Andric   void printPaddingRow(uint32_t Amount);
44*0b57cec5SDimitry Andric 
45*0b57cec5SDimitry Andric   LinePrinter &Printer;
46*0b57cec5SDimitry Andric 
47*0b57cec5SDimitry Andric   LayoutItemBase *CurrentItem = nullptr;
48*0b57cec5SDimitry Andric   uint32_t RecursionLevel = 0;
49*0b57cec5SDimitry Andric   uint32_t ClassOffsetZero = 0;
50*0b57cec5SDimitry Andric   uint32_t CurrentAbsoluteOffset = 0;
51*0b57cec5SDimitry Andric   bool DumpedAnything = false;
52*0b57cec5SDimitry Andric };
53*0b57cec5SDimitry Andric }
54*0b57cec5SDimitry Andric }
55*0b57cec5SDimitry Andric #endif
56