tools/llvm-readobj/StreamWriter.h

   1 //===-- StreamWriter.h ----------------------------------------------------===//
   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_LLVM_READOBJ_STREAMWRITER_H
  11 #define LLVM_TOOLS_LLVM_READOBJ_STREAMWRITER_H
  12
  13 #include "llvm/ADT/ArrayRef.h"
  14 #include "llvm/ADT/SmallVector.h"
  15 #include "llvm/ADT/StringRef.h"
  16 #include "llvm/Support/DataTypes.h"
  17 #include "llvm/Support/Endian.h"
  18 #include "llvm/Support/raw_ostream.h"
  19 #include <algorithm>
  20
  21 using namespace llvm;
  22 using namespace llvm::support;
  23
  24 namespace llvm {
  25
  26 template<typename T>
  27 struct EnumEntry {
  28   StringRef Name;
  29   T Value;
  30 };
  31
  32 struct HexNumber {
  33   // To avoid sign-extension we have to explicitly cast to the appropriate
  34   // unsigned type. The overloads are here so that every type that is implicitly
  35   // convertible to an integer (including enums and endian helpers) can be used
  36   // without requiring type traits or call-site changes.
  37   HexNumber(int8_t   Value) : Value(static_cast<uint8_t >(Value)) { }
  38   HexNumber(int16_t  Value) : Value(static_cast<uint16_t>(Value)) { }
  39   HexNumber(int32_t  Value) : Value(static_cast<uint32_t>(Value)) { }
  40   HexNumber(int64_t  Value) : Value(static_cast<uint64_t>(Value)) { }
  41   HexNumber(uint8_t  Value) : Value(Value) { }
  42   HexNumber(uint16_t Value) : Value(Value) { }
  43   HexNumber(uint32_t Value) : Value(Value) { }
  44   HexNumber(uint64_t Value) : Value(Value) { }
  45   uint64_t Value;
  46 };
  47
  48 raw_ostream &operator<<(raw_ostream &OS, const HexNumber& Value);
  49
  50 class StreamWriter {
  51 public:
  52   StreamWriter(raw_ostream &OS)
  53     : OS(OS)
  54     , IndentLevel(0) {
  55   }
  56
  57   void flush() {
  58     OS.flush();
  59   }
  60
  61   void indent(int Levels = 1) {
  62     IndentLevel += Levels;
  63   }
  64
  65   void unindent(int Levels = 1) {
  66     IndentLevel = std::max(0, IndentLevel - Levels);
  67   }
  68
  69   void printIndent() {
  70     for (int i = 0; i < IndentLevel; ++i)
  71       OS << "  ";
  72   }
  73
  74   template<typename T>
  75   HexNumber hex(T Value) {
  76     return HexNumber(Value);
  77   }
  78
  79   template<typename T, typename TEnum>
  80   void printEnum(StringRef Label, T Value,
  81                  ArrayRef<EnumEntry<TEnum> > EnumValues) {
  82     StringRef Name;
  83     bool Found = false;
  84     for (const auto &EnumItem : EnumValues) {
  85       if (EnumItem.Value == Value) {
  86         Name = EnumItem.Name;
  87         Found = true;
  88         break;
  89       }
  90     }
  91
  92     if (Found) {
  93       startLine() << Label << ": " << Name << " (" << hex(Value) << ")\n";
  94     } else {
  95       startLine() << Label << ": " << hex(Value) << "\n";
  96     }
  97   }
  98
  99   template <typename T, typename TFlag>
 100   void printFlags(StringRef Label, T Value, ArrayRef<EnumEntry<TFlag>> Flags,
 101                   TFlag EnumMask1 = {}, TFlag EnumMask2 = {},
 102                   TFlag EnumMask3 = {}) {
 103     typedef EnumEntry<TFlag> FlagEntry;
 104     typedef SmallVector<FlagEntry, 10> FlagVector;
 105     FlagVector SetFlags;
 106
 107     for (const auto &Flag : Flags) {
 108       if (Flag.Value == 0)
 109         continue;
 110
 111       TFlag EnumMask{};
 112       if (Flag.Value & EnumMask1)
 113         EnumMask = EnumMask1;
 114       else if (Flag.Value & EnumMask2)
 115         EnumMask = EnumMask2;
 116       else if (Flag.Value & EnumMask3)
 117         EnumMask = EnumMask3;
 118       bool IsEnum = (Flag.Value & EnumMask) != 0;
 119       if ((!IsEnum && (Value & Flag.Value) == Flag.Value) ||
 120           (IsEnum  && (Value & EnumMask) == Flag.Value)) {
 121         SetFlags.push_back(Flag);
 122       }
 123     }
 124
 125     std::sort(SetFlags.begin(), SetFlags.end(), &flagName<TFlag>);
 126
 127     startLine() << Label << " [ (" << hex(Value) << ")\n";
 128     for (const auto &Flag : SetFlags) {
 129       startLine() << "  " << Flag.Name << " (" << hex(Flag.Value) << ")\n";
 130     }
 131     startLine() << "]\n";
 132   }
 133
 134   template<typename T>
 135   void printFlags(StringRef Label, T Value) {
 136     startLine() << Label << " [ (" << hex(Value) << ")\n";
 137     uint64_t Flag = 1;
 138     uint64_t Curr = Value;
 139     while (Curr > 0) {
 140       if (Curr & 1)
 141         startLine() << "  " << hex(Flag) << "\n";
 142       Curr >>= 1;
 143       Flag <<= 1;
 144     }
 145     startLine() << "]\n";
 146   }
 147
 148   void printNumber(StringRef Label, uint64_t Value) {
 149     startLine() << Label << ": " << Value << "\n";
 150   }
 151
 152   void printNumber(StringRef Label, uint32_t Value) {
 153     startLine() << Label << ": " << Value << "\n";
 154   }
 155
 156   void printNumber(StringRef Label, uint16_t Value) {
 157     startLine() << Label << ": " << Value << "\n";
 158   }
 159
 160   void printNumber(StringRef Label, uint8_t Value) {
 161     startLine() << Label << ": " << unsigned(Value) << "\n";
 162   }
 163
 164   void printNumber(StringRef Label, int64_t Value) {
 165     startLine() << Label << ": " << Value << "\n";
 166   }
 167
 168   void printNumber(StringRef Label, int32_t Value) {
 169     startLine() << Label << ": " << Value << "\n";
 170   }
 171
 172   void printNumber(StringRef Label, int16_t Value) {
 173     startLine() << Label << ": " << Value << "\n";
 174   }
 175
 176   void printNumber(StringRef Label, int8_t Value) {
 177     startLine() << Label << ": " << int(Value) << "\n";
 178   }
 179
 180   void printBoolean(StringRef Label, bool Value) {
 181     startLine() << Label << ": " << (Value ? "Yes" : "No") << '\n';
 182   }
 183
 184   template <typename T>
 185   void printList(StringRef Label, const T &List) {
 186     startLine() << Label << ": [";
 187     bool Comma = false;
 188     for (const auto &Item : List) {
 189       if (Comma)
 190         OS << ", ";
 191       OS << Item;
 192       Comma = true;
 193     }
 194     OS << "]\n";
 195   }
 196
 197   template<typename T>
 198   void printHex(StringRef Label, T Value) {
 199     startLine() << Label << ": " << hex(Value) << "\n";
 200   }
 201
 202   template<typename T>
 203   void printHex(StringRef Label, StringRef Str, T Value) {
 204     startLine() << Label << ": " << Str << " (" << hex(Value) << ")\n";
 205   }
 206
 207   void printString(StringRef Label, StringRef Value) {
 208     startLine() << Label << ": " << Value << "\n";
 209   }
 210
 211   void printString(StringRef Label, const std::string &Value) {
 212     startLine() << Label << ": " << Value << "\n";
 213   }
 214
 215   template<typename T>
 216   void printNumber(StringRef Label, StringRef Str, T Value) {
 217     startLine() << Label << ": " << Str << " (" << Value << ")\n";
 218   }
 219
 220   void printBinary(StringRef Label, StringRef Str, ArrayRef<uint8_t> Value) {
 221     printBinaryImpl(Label, Str, Value, false);
 222   }
 223
 224   void printBinary(StringRef Label, StringRef Str, ArrayRef<char> Value) {
 225     auto V = makeArrayRef(reinterpret_cast<const uint8_t*>(Value.data()),
 226                           Value.size());
 227     printBinaryImpl(Label, Str, V, false);
 228   }
 229
 230   void printBinary(StringRef Label, ArrayRef<uint8_t> Value) {
 231     printBinaryImpl(Label, StringRef(), Value, false);
 232   }
 233
 234   void printBinary(StringRef Label, ArrayRef<char> Value) {
 235     auto V = makeArrayRef(reinterpret_cast<const uint8_t*>(Value.data()),
 236                           Value.size());
 237     printBinaryImpl(Label, StringRef(), V, false);
 238   }
 239
 240   void printBinary(StringRef Label, StringRef Value) {
 241     auto V = makeArrayRef(reinterpret_cast<const uint8_t*>(Value.data()),
 242                           Value.size());
 243     printBinaryImpl(Label, StringRef(), V, false);
 244   }
 245
 246   void printBinaryBlock(StringRef Label, StringRef Value) {
 247     auto V = makeArrayRef(reinterpret_cast<const uint8_t*>(Value.data()),
 248                           Value.size());
 249     printBinaryImpl(Label, StringRef(), V, true);
 250   }
 251
 252   raw_ostream& startLine() {
 253     printIndent();
 254     return OS;
 255   }
 256
 257   raw_ostream& getOStream() {
 258     return OS;
 259   }
 260
 261 private:
 262   template<typename T>
 263   static bool flagName(const EnumEntry<T>& lhs, const EnumEntry<T>& rhs) {
 264     return lhs.Name < rhs.Name;
 265   }
 266
 267   void printBinaryImpl(StringRef Label, StringRef Str, ArrayRef<uint8_t> Value,
 268                        bool Block);
 269
 270   raw_ostream &OS;
 271   int IndentLevel;
 272 };
 273
 274 struct DictScope {
 275   DictScope(StreamWriter& W, StringRef N) : W(W) {
 276     W.startLine() << N << " {\n";
 277     W.indent();
 278   }
 279
 280   ~DictScope() {
 281     W.unindent();
 282     W.startLine() << "}\n";
 283   }
 284
 285   StreamWriter& W;
 286 };
 287
 288 struct ListScope {
 289   ListScope(StreamWriter& W, StringRef N) : W(W) {
 290     W.startLine() << N << " [\n";
 291     W.indent();
 292   }
 293
 294   ~ListScope() {
 295     W.unindent();
 296     W.startLine() << "]\n";
 297   }
 298
 299   StreamWriter& W;
 300 };
 301
 302 } // namespace llvm
 303
 304 #endif