f22ee41662ee7e0283872d618b7dec3fcc992895
[lldb.git] / lldb / tools / lldb-test / FormatUtil.h
1 //===- FormatUtil.h ------------------------------------------- *- C++ --*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #ifndef LLVM_TOOLS_LLDBTEST_FORMATUTIL_H
11 #define LLVM_TOOLS_LLDBTEST_FORMATUTIL_H
12
13 #include "llvm/ADT/ArrayRef.h"
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/ADT/Twine.h"
16 #include "llvm/Support/FormatVariadic.h"
17 #include "llvm/Support/raw_ostream.h"
18
19 #include <list>
20
21 namespace lldb_private {
22
23 class LinePrinter {
24   llvm::raw_ostream &OS;
25   int IndentSpaces;
26   int CurrentIndent;
27
28 public:
29   LinePrinter(int Indent, llvm::raw_ostream &Stream);
30
31   void Indent(uint32_t Amount = 0);
32   void Unindent(uint32_t Amount = 0);
33   void NewLine();
34
35   void printLine(const llvm::Twine &T);
36   void print(const llvm::Twine &T);
37   template <typename... Ts> void formatLine(const char *Fmt, Ts &&... Items) {
38     printLine(llvm::formatv(Fmt, std::forward<Ts>(Items)...));
39   }
40   template <typename... Ts> void format(const char *Fmt, Ts &&... Items) {
41     print(llvm::formatv(Fmt, std::forward<Ts>(Items)...));
42   }
43
44   void formatBinary(llvm::StringRef Label, llvm::ArrayRef<uint8_t> Data,
45                     uint32_t StartOffset);
46   void formatBinary(llvm::StringRef Label, llvm::ArrayRef<uint8_t> Data,
47                     uint64_t BaseAddr, uint32_t StartOffset);
48
49   llvm::raw_ostream &getStream() { return OS; }
50   int getIndentLevel() const { return CurrentIndent; }
51 };
52
53 struct AutoIndent {
54   explicit AutoIndent(LinePrinter &L, uint32_t Amount = 0)
55       : L(&L), Amount(Amount) {
56     L.Indent(Amount);
57   }
58   ~AutoIndent() {
59     if (L)
60       L->Unindent(Amount);
61   }
62
63   LinePrinter *L = nullptr;
64   uint32_t Amount = 0;
65 };
66
67 template <class T>
68 inline llvm::raw_ostream &operator<<(LinePrinter &Printer, const T &Item) {
69   Printer.getStream() << Item;
70   return Printer.getStream();
71 }
72
73 } // namespace lldb_private
74
75 #endif