1 //===-- StreamWriter.h ----------------------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_TOOLS_LLVM_READOBJ_STREAMWRITER_H
11 #define LLVM_TOOLS_LLVM_READOBJ_STREAMWRITER_H
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"
22 using namespace llvm::support;
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) { }
48 raw_ostream &operator<<(raw_ostream &OS, const HexNumber& Value);
52 StreamWriter(raw_ostream &OS)
61 void indent(int Levels = 1) {
62 IndentLevel += Levels;
65 void unindent(int Levels = 1) {
66 IndentLevel = std::max(0, IndentLevel - Levels);
70 for (int i = 0; i < IndentLevel; ++i)
75 HexNumber hex(T Value) {
76 return HexNumber(Value);
79 template<typename T, typename TEnum>
80 void printEnum(StringRef Label, T Value,
81 ArrayRef<EnumEntry<TEnum> > EnumValues) {
84 for (const auto &EnumItem : EnumValues) {
85 if (EnumItem.Value == Value) {
93 startLine() << Label << ": " << Name << " (" << hex(Value) << ")\n";
95 startLine() << Label << ": " << hex(Value) << "\n";
99 template<typename T, typename TFlag>
100 void printFlags(StringRef Label, T Value, ArrayRef<EnumEntry<TFlag> > Flags,
101 TFlag EnumMask = TFlag(0)) {
102 typedef EnumEntry<TFlag> FlagEntry;
103 typedef SmallVector<FlagEntry, 10> FlagVector;
106 for (const auto &Flag : Flags) {
110 bool IsEnum = (Flag.Value & EnumMask) != 0;
111 if ((!IsEnum && (Value & Flag.Value) == Flag.Value) ||
112 (IsEnum && (Value & EnumMask) == Flag.Value)) {
113 SetFlags.push_back(Flag);
117 std::sort(SetFlags.begin(), SetFlags.end(), &flagName<TFlag>);
119 startLine() << Label << " [ (" << hex(Value) << ")\n";
120 for (const auto &Flag : SetFlags) {
121 startLine() << " " << Flag.Name << " (" << hex(Flag.Value) << ")\n";
123 startLine() << "]\n";
127 void printFlags(StringRef Label, T Value) {
128 startLine() << Label << " [ (" << hex(Value) << ")\n";
130 uint64_t Curr = Value;
133 startLine() << " " << hex(Flag) << "\n";
137 startLine() << "]\n";
140 void printNumber(StringRef Label, uint64_t Value) {
141 startLine() << Label << ": " << Value << "\n";
144 void printNumber(StringRef Label, uint32_t Value) {
145 startLine() << Label << ": " << Value << "\n";
148 void printNumber(StringRef Label, uint16_t Value) {
149 startLine() << Label << ": " << Value << "\n";
152 void printNumber(StringRef Label, uint8_t Value) {
153 startLine() << Label << ": " << unsigned(Value) << "\n";
156 void printNumber(StringRef Label, int64_t Value) {
157 startLine() << Label << ": " << Value << "\n";
160 void printNumber(StringRef Label, int32_t Value) {
161 startLine() << Label << ": " << Value << "\n";
164 void printNumber(StringRef Label, int16_t Value) {
165 startLine() << Label << ": " << Value << "\n";
168 void printNumber(StringRef Label, int8_t Value) {
169 startLine() << Label << ": " << int(Value) << "\n";
172 void printBoolean(StringRef Label, bool Value) {
173 startLine() << Label << ": " << (Value ? "Yes" : "No") << '\n';
176 template <typename T_>
177 void printList(StringRef Label, const SmallVectorImpl<T_> &List) {
178 startLine() << Label << ": [";
180 for (const auto &Item : List) {
190 void printHex(StringRef Label, T Value) {
191 startLine() << Label << ": " << hex(Value) << "\n";
195 void printHex(StringRef Label, StringRef Str, T Value) {
196 startLine() << Label << ": " << Str << " (" << hex(Value) << ")\n";
199 void printString(StringRef Label, StringRef Value) {
200 startLine() << Label << ": " << Value << "\n";
203 void printString(StringRef Label, const std::string &Value) {
204 startLine() << Label << ": " << Value << "\n";
208 void printNumber(StringRef Label, StringRef Str, T Value) {
209 startLine() << Label << ": " << Str << " (" << Value << ")\n";
212 void printBinary(StringRef Label, StringRef Str, ArrayRef<uint8_t> Value) {
213 printBinaryImpl(Label, Str, Value, false);
216 void printBinary(StringRef Label, StringRef Str, ArrayRef<char> Value) {
217 auto V = makeArrayRef(reinterpret_cast<const uint8_t*>(Value.data()),
219 printBinaryImpl(Label, Str, V, false);
222 void printBinary(StringRef Label, ArrayRef<uint8_t> Value) {
223 printBinaryImpl(Label, StringRef(), Value, false);
226 void printBinary(StringRef Label, ArrayRef<char> Value) {
227 auto V = makeArrayRef(reinterpret_cast<const uint8_t*>(Value.data()),
229 printBinaryImpl(Label, StringRef(), V, false);
232 void printBinary(StringRef Label, StringRef Value) {
233 auto V = makeArrayRef(reinterpret_cast<const uint8_t*>(Value.data()),
235 printBinaryImpl(Label, StringRef(), V, false);
238 void printBinaryBlock(StringRef Label, StringRef Value) {
239 auto V = makeArrayRef(reinterpret_cast<const uint8_t*>(Value.data()),
241 printBinaryImpl(Label, StringRef(), V, true);
244 raw_ostream& startLine() {
249 raw_ostream& getOStream() {
255 static bool flagName(const EnumEntry<T>& lhs, const EnumEntry<T>& rhs) {
256 return lhs.Name < rhs.Name;
259 void printBinaryImpl(StringRef Label, StringRef Str, ArrayRef<uint8_t> Value,
267 DictScope(StreamWriter& W, StringRef N) : W(W) {
268 W.startLine() << N << " {\n";
274 W.startLine() << "}\n";
281 ListScope(StreamWriter& W, StringRef N) : W(W) {
282 W.startLine() << N << " [\n";
288 W.startLine() << "]\n";