1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
//===-- MsgPackDocumentYAML.cpp - MsgPack Document YAML interface -------*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
/// This file implements YAMLIO on a msgpack::Document.
//
//===----------------------------------------------------------------------===//
#include "llvm/BinaryFormat/MsgPackDocument.h"
#include "llvm/Support/YAMLTraits.h"
using namespace llvm;
using namespace msgpack;
namespace {
// Struct used to represent scalar node. (MapDocNode and ArrayDocNode already
// exist in MsgPackDocument.h.)
struct ScalarDocNode : DocNode {
ScalarDocNode(DocNode N) : DocNode(N) {}
/// Get the YAML tag for this ScalarDocNode. This normally returns ""; it only
/// returns something else if the result of toString would be ambiguous, e.g.
/// a string that parses as a number or boolean.
StringRef getYAMLTag() const;
};
} // namespace
/// Convert this DocNode to a string, assuming it is scalar.
std::string DocNode::toString() const {
std::string S;
raw_string_ostream OS(S);
switch (getKind()) {
case msgpack::Type::String:
OS << Raw;
break;
case msgpack::Type::Nil:
break;
case msgpack::Type::Boolean:
OS << (Bool ? "true" : "false");
break;
case msgpack::Type::Int:
OS << Int;
break;
case msgpack::Type::UInt:
if (getDocument()->getHexMode())
OS << format("%#llx", (unsigned long long)UInt);
else
OS << UInt;
break;
case msgpack::Type::Float:
OS << Float;
break;
default:
llvm_unreachable("not scalar");
break;
}
return OS.str();
}
/// Convert the StringRef and use it to set this DocNode (assuming scalar). If
/// it is a string, copy the string into the Document's strings list so we do
/// not rely on S having a lifetime beyond this call. Tag is "" or a YAML tag.
StringRef DocNode::fromString(StringRef S, StringRef Tag) {
if (Tag == "tag:yaml.org,2002:str")
Tag = "";
if (Tag == "!int" || Tag == "") {
// Try unsigned int then signed int.
*this = getDocument()->getNode(uint64_t(0));
StringRef Err = yaml::ScalarTraits<uint64_t>::input(S, nullptr, getUInt());
if (Err != "") {
*this = getDocument()->getNode(int64_t(0));
Err = yaml::ScalarTraits<int64_t>::input(S, nullptr, getInt());
}
if (Err == "" || Tag != "")
return Err;
}
if (Tag == "!nil") {
*this = getDocument()->getNode();
return "";
}
if (Tag == "!bool" || Tag == "") {
*this = getDocument()->getNode(false);
StringRef Err = yaml::ScalarTraits<bool>::input(S, nullptr, getBool());
if (Err == "" || Tag != "")
return Err;
}
if (Tag == "!float" || Tag == "") {
*this = getDocument()->getNode(0.0);
StringRef Err = yaml::ScalarTraits<double>::input(S, nullptr, getFloat());
if (Err == "" || Tag != "")
return Err;
}
assert((Tag == "!str" || Tag == "") && "unsupported tag");
std::string V;
StringRef Err = yaml::ScalarTraits<std::string>::input(S, nullptr, V);
if (Err == "")
*this = getDocument()->getNode(V, /*Copy=*/true);
return Err;
}
/// Get the YAML tag for this ScalarDocNode. This normally returns ""; it only
/// returns something else if the result of toString would be ambiguous, e.g.
/// a string that parses as a number or boolean.
StringRef ScalarDocNode::getYAMLTag() const {
if (getKind() == msgpack::Type::Nil)
return "!nil";
// Try converting both ways and see if we get the same kind. If not, we need
// a tag.
ScalarDocNode N = getDocument()->getNode();
N.fromString(toString(), "");
if (N.getKind() == getKind())
return "";
// Tolerate signedness of int changing, as tags do not differentiate between
// them anyway.
if (N.getKind() == msgpack::Type::UInt && getKind() == msgpack::Type::Int)
return "";
if (N.getKind() == msgpack::Type::Int && getKind() == msgpack::Type::UInt)
return "";
// We do need a tag.
switch (getKind()) {
case msgpack::Type::String:
return "!str";
case msgpack::Type::Int:
return "!int";
case msgpack::Type::UInt:
return "!int";
case msgpack::Type::Boolean:
return "!bool";
case msgpack::Type::Float:
return "!float";
default:
llvm_unreachable("unrecognized kind");
}
}
namespace llvm {
namespace yaml {
/// YAMLIO for DocNode
template <> struct PolymorphicTraits<DocNode> {
static NodeKind getKind(const DocNode &N) {
switch (N.getKind()) {
case msgpack::Type::Map:
return NodeKind::Map;
case msgpack::Type::Array:
return NodeKind::Sequence;
default:
return NodeKind::Scalar;
}
}
static MapDocNode &getAsMap(DocNode &N) { return N.getMap(/*Convert=*/true); }
static ArrayDocNode &getAsSequence(DocNode &N) {
N.getArray(/*Convert=*/true);
return *static_cast<ArrayDocNode *>(&N);
}
static ScalarDocNode &getAsScalar(DocNode &N) {
return *static_cast<ScalarDocNode *>(&N);
}
};
/// YAMLIO for ScalarDocNode
template <> struct TaggedScalarTraits<ScalarDocNode> {
static void output(const ScalarDocNode &S, void *Ctxt, raw_ostream &OS,
raw_ostream &TagOS) {
TagOS << S.getYAMLTag();
OS << S.toString();
}
static StringRef input(StringRef Str, StringRef Tag, void *Ctxt,
ScalarDocNode &S) {
return S.fromString(Str, Tag);
}
static QuotingType mustQuote(const ScalarDocNode &S, StringRef ScalarStr) {
switch (S.getKind()) {
case Type::Int:
return ScalarTraits<int64_t>::mustQuote(ScalarStr);
case Type::UInt:
return ScalarTraits<uint64_t>::mustQuote(ScalarStr);
case Type::Nil:
return ScalarTraits<StringRef>::mustQuote(ScalarStr);
case Type::Boolean:
return ScalarTraits<bool>::mustQuote(ScalarStr);
case Type::Float:
return ScalarTraits<double>::mustQuote(ScalarStr);
case Type::Binary:
case Type::String:
return ScalarTraits<std::string>::mustQuote(ScalarStr);
default:
llvm_unreachable("unrecognized ScalarKind");
}
}
};
/// YAMLIO for MapDocNode
template <> struct CustomMappingTraits<MapDocNode> {
static void inputOne(IO &IO, StringRef Key, MapDocNode &M) {
ScalarDocNode KeyObj = M.getDocument()->getNode();
KeyObj.fromString(Key, "");
IO.mapRequired(Key.str().c_str(), M.getMap()[KeyObj]);
}
static void output(IO &IO, MapDocNode &M) {
for (auto I : M.getMap()) {
IO.mapRequired(I.first.toString().c_str(), I.second);
}
}
};
/// YAMLIO for ArrayNode
template <> struct SequenceTraits<ArrayDocNode> {
static size_t size(IO &IO, ArrayDocNode &A) { return A.size(); }
static DocNode &element(IO &IO, ArrayDocNode &A, size_t Index) {
return A[Index];
}
};
} // namespace yaml
} // namespace llvm
/// Convert MsgPack Document to YAML text.
void msgpack::Document::toYAML(raw_ostream &OS) {
yaml::Output Yout(OS);
Yout << getRoot();
}
/// Read YAML text into the MsgPack document. Returns false on failure.
bool msgpack::Document::fromYAML(StringRef S) {
clear();
yaml::Input Yin(S);
Yin >> getRoot();
return !Yin.error();
}
|