Bug Summary

File:include/llvm/Support/YAMLTraits.h
Warning:line 797, column 51
The left operand of '==' is a garbage value

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name CodeViewYAMLSymbols.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mthread-model posix -fmath-errno -masm-verbose -mconstructor-aliases -munwind-tables -fuse-init-array -target-cpu x86-64 -dwarf-column-info -debugger-tuning=gdb -momit-leaf-frame-pointer -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-8/lib/clang/8.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-8~svn350071/build-llvm/lib/ObjectYAML -I /build/llvm-toolchain-snapshot-8~svn350071/lib/ObjectYAML -I /build/llvm-toolchain-snapshot-8~svn350071/build-llvm/include -I /build/llvm-toolchain-snapshot-8~svn350071/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/include/clang/8.0.0/include/ -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-8/lib/clang/8.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++11 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-8~svn350071/build-llvm/lib/ObjectYAML -fdebug-prefix-map=/build/llvm-toolchain-snapshot-8~svn350071=. -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -stack-protector 2 -fobjc-runtime=gcc -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -o /tmp/scan-build-2018-12-27-042839-1215-1 -x c++ /build/llvm-toolchain-snapshot-8~svn350071/lib/ObjectYAML/CodeViewYAMLSymbols.cpp -faddrsig

/build/llvm-toolchain-snapshot-8~svn350071/lib/ObjectYAML/CodeViewYAMLSymbols.cpp

→
1//===- CodeViewYAMLSymbols.cpp - CodeView YAMLIO Symbol implementation ----===//
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// This file defines classes for handling the YAML representation of CodeView
11// Debug Info.
12//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/ObjectYAML/CodeViewYAMLSymbols.h"
16#include "llvm/ADT/ArrayRef.h"
17#include "llvm/ADT/StringRef.h"
18#include "llvm/DebugInfo/CodeView/CodeView.h"
19#include "llvm/DebugInfo/CodeView/CodeViewError.h"
20#include "llvm/DebugInfo/CodeView/EnumTables.h"
21#include "llvm/DebugInfo/CodeView/RecordSerialization.h"
22#include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
23#include "llvm/DebugInfo/CodeView/SymbolRecord.h"
24#include "llvm/DebugInfo/CodeView/SymbolSerializer.h"
25#include "llvm/DebugInfo/CodeView/TypeIndex.h"
26#include "llvm/ObjectYAML/YAML.h"
27#include "llvm/Support/Allocator.h"
28#include "llvm/Support/Error.h"
29#include "llvm/Support/YAMLTraits.h"
30#include <algorithm>
31#include <cstdint>
32#include <cstring>
33#include <string>
34#include <vector>
35
36using namespace llvm;
37using namespace llvm::codeview;
38using namespace llvm::CodeViewYAML;
39using namespace llvm::CodeViewYAML::detail;
40using namespace llvm::yaml;
41
42LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(TypeIndex)namespace llvm { namespace yaml { static_assert( !std::is_fundamental
<TypeIndex>::value && !std::is_same<TypeIndex
, std::string>::value && !std::is_same<TypeIndex
, llvm::StringRef>::value, "only use LLVM_YAML_IS_SEQUENCE_VECTOR for types you control"
); template <> struct SequenceElementTraits<TypeIndex
> { static const bool flow = true; }; } }
43LLVM_YAML_IS_SEQUENCE_VECTOR(LocalVariableAddrGap)namespace llvm { namespace yaml { static_assert( !std::is_fundamental
<LocalVariableAddrGap>::value && !std::is_same<
LocalVariableAddrGap, std::string>::value && !std::
is_same<LocalVariableAddrGap, llvm::StringRef>::value, "only use LLVM_YAML_IS_SEQUENCE_VECTOR for types you control"
); template <> struct SequenceElementTraits<LocalVariableAddrGap
> { static const bool flow = false; }; } }
44
45// We only need to declare these, the definitions are in CodeViewYAMLTypes.cpp
46LLVM_YAML_DECLARE_SCALAR_TRAITS(APSInt, QuotingType::None)namespace llvm { namespace yaml { template <> struct ScalarTraits
<APSInt> { static void output(const APSInt &Value, void
*ctx, raw_ostream &Out); static StringRef input(StringRef
Scalar, void *ctxt, APSInt &Value); static QuotingType mustQuote
(StringRef) { return QuotingType::None; } }; } }
47LLVM_YAML_DECLARE_SCALAR_TRAITS(TypeIndex, QuotingType::None)namespace llvm { namespace yaml { template <> struct ScalarTraits
<TypeIndex> { static void output(const TypeIndex &Value
, void *ctx, raw_ostream &Out); static StringRef input(StringRef
Scalar, void *ctxt, TypeIndex &Value); static QuotingType
mustQuote(StringRef) { return QuotingType::None; } }; } }
48
49LLVM_YAML_DECLARE_ENUM_TRAITS(SymbolKind)namespace llvm { namespace yaml { template <> struct ScalarEnumerationTraits
<SymbolKind> { static void enumeration(IO &io, SymbolKind
&Value); }; } }
50LLVM_YAML_DECLARE_ENUM_TRAITS(FrameCookieKind)namespace llvm { namespace yaml { template <> struct ScalarEnumerationTraits
<FrameCookieKind> { static void enumeration(IO &io,
FrameCookieKind &Value); }; } }
51
52LLVM_YAML_DECLARE_BITSET_TRAITS(CompileSym2Flags)namespace llvm { namespace yaml { template <> struct ScalarBitSetTraits
<CompileSym2Flags> { static void bitset(IO &IO, CompileSym2Flags
&Options); }; } }
53LLVM_YAML_DECLARE_BITSET_TRAITS(CompileSym3Flags)namespace llvm { namespace yaml { template <> struct ScalarBitSetTraits
<CompileSym3Flags> { static void bitset(IO &IO, CompileSym3Flags
&Options); }; } }
54LLVM_YAML_DECLARE_BITSET_TRAITS(ExportFlags)namespace llvm { namespace yaml { template <> struct ScalarBitSetTraits
<ExportFlags> { static void bitset(IO &IO, ExportFlags
&Options); }; } }
55LLVM_YAML_DECLARE_BITSET_TRAITS(PublicSymFlags)namespace llvm { namespace yaml { template <> struct ScalarBitSetTraits
<PublicSymFlags> { static void bitset(IO &IO, PublicSymFlags
&Options); }; } }
56LLVM_YAML_DECLARE_BITSET_TRAITS(LocalSymFlags)namespace llvm { namespace yaml { template <> struct ScalarBitSetTraits
<LocalSymFlags> { static void bitset(IO &IO, LocalSymFlags
&Options); }; } }
57LLVM_YAML_DECLARE_BITSET_TRAITS(ProcSymFlags)namespace llvm { namespace yaml { template <> struct ScalarBitSetTraits
<ProcSymFlags> { static void bitset(IO &IO, ProcSymFlags
&Options); }; } }
58LLVM_YAML_DECLARE_BITSET_TRAITS(FrameProcedureOptions)namespace llvm { namespace yaml { template <> struct ScalarBitSetTraits
<FrameProcedureOptions> { static void bitset(IO &IO
, FrameProcedureOptions &Options); }; } }
59LLVM_YAML_DECLARE_ENUM_TRAITS(CPUType)namespace llvm { namespace yaml { template <> struct ScalarEnumerationTraits
<CPUType> { static void enumeration(IO &io, CPUType
&Value); }; } }
60LLVM_YAML_DECLARE_ENUM_TRAITS(RegisterId)namespace llvm { namespace yaml { template <> struct ScalarEnumerationTraits
<RegisterId> { static void enumeration(IO &io, RegisterId
&Value); }; } }
61LLVM_YAML_DECLARE_ENUM_TRAITS(TrampolineType)namespace llvm { namespace yaml { template <> struct ScalarEnumerationTraits
<TrampolineType> { static void enumeration(IO &io, TrampolineType
&Value); }; } }
62LLVM_YAML_DECLARE_ENUM_TRAITS(ThunkOrdinal)namespace llvm { namespace yaml { template <> struct ScalarEnumerationTraits
<ThunkOrdinal> { static void enumeration(IO &io, ThunkOrdinal
&Value); }; } }
63
64LLVM_YAML_STRONG_TYPEDEF(StringRef, TypeName)struct TypeName { TypeName() = default; TypeName(const StringRef
v) : value(v) {} TypeName(const TypeName &v) = default; TypeName
&operator=(const TypeName &rhs) = default; TypeName &
operator=(const StringRef &rhs) { value = rhs; return *this
; } operator const StringRef & () const { return value; }
bool operator==(const TypeName &rhs) const { return value
== rhs.value; } bool operator==(const StringRef &rhs) const
{ return value == rhs; } bool operator<(const TypeName &
rhs) const { return value < rhs.value; } StringRef value; using
BaseType = StringRef; };
65
66LLVM_YAML_DECLARE_SCALAR_TRAITS(TypeName, QuotingType::Single)namespace llvm { namespace yaml { template <> struct ScalarTraits
<TypeName> { static void output(const TypeName &Value
, void *ctx, raw_ostream &Out); static StringRef input(StringRef
Scalar, void *ctxt, TypeName &Value); static QuotingType
mustQuote(StringRef) { return QuotingType::Single; } }; } }
67
68StringRef ScalarTraits<TypeName>::input(StringRef S, void *V, TypeName &T) {
69 return ScalarTraits<StringRef>::input(S, V, T.value);
70}
71
72void ScalarTraits<TypeName>::output(const TypeName &T, void *V,
73 raw_ostream &R) {
74 ScalarTraits<StringRef>::output(T.value, V, R);
75}
76
77void ScalarEnumerationTraits<SymbolKind>::enumeration(IO &io,
78 SymbolKind &Value) {
79 auto SymbolNames = getSymbolTypeNames();
80 for (const auto &E : SymbolNames)
10
←
Assuming '__begin1' is not equal to '__end1'
→
81 io.enumCase(Value, E.Name.str().c_str(), E.Value);
11
←
Passing value via 1st parameter 'Val'
→
12
←
Calling 'IO::enumCase'
→
82}
83
84void ScalarBitSetTraits<CompileSym2Flags>::bitset(IO &io,
85 CompileSym2Flags &Flags) {
86 auto FlagNames = getCompileSym2FlagNames();
87 for (const auto &E : FlagNames) {
88 io.bitSetCase(Flags, E.Name.str().c_str(),
89 static_cast<CompileSym2Flags>(E.Value));
90 }
91}
92
93void ScalarBitSetTraits<CompileSym3Flags>::bitset(IO &io,
94 CompileSym3Flags &Flags) {
95 auto FlagNames = getCompileSym3FlagNames();
96 for (const auto &E : FlagNames) {
97 io.bitSetCase(Flags, E.Name.str().c_str(),
98 static_cast<CompileSym3Flags>(E.Value));
99 }
100}
101
102void ScalarBitSetTraits<ExportFlags>::bitset(IO &io, ExportFlags &Flags) {
103 auto FlagNames = getExportSymFlagNames();
104 for (const auto &E : FlagNames) {
105 io.bitSetCase(Flags, E.Name.str().c_str(),
106 static_cast<ExportFlags>(E.Value));
107 }
108}
109
110void ScalarBitSetTraits<PublicSymFlags>::bitset(IO &io, PublicSymFlags &Flags) {
111 auto FlagNames = getPublicSymFlagNames();
112 for (const auto &E : FlagNames) {
113 io.bitSetCase(Flags, E.Name.str().c_str(),
114 static_cast<PublicSymFlags>(E.Value));
115 }
116}
117
118void ScalarBitSetTraits<LocalSymFlags>::bitset(IO &io, LocalSymFlags &Flags) {
119 auto FlagNames = getLocalFlagNames();
120 for (const auto &E : FlagNames) {
121 io.bitSetCase(Flags, E.Name.str().c_str(),
122 static_cast<LocalSymFlags>(E.Value));
123 }
124}
125
126void ScalarBitSetTraits<ProcSymFlags>::bitset(IO &io, ProcSymFlags &Flags) {
127 auto FlagNames = getProcSymFlagNames();
128 for (const auto &E : FlagNames) {
129 io.bitSetCase(Flags, E.Name.str().c_str(),
130 static_cast<ProcSymFlags>(E.Value));
131 }
132}
133
134void ScalarBitSetTraits<FrameProcedureOptions>::bitset(
135 IO &io, FrameProcedureOptions &Flags) {
136 auto FlagNames = getFrameProcSymFlagNames();
137 for (const auto &E : FlagNames) {
138 io.bitSetCase(Flags, E.Name.str().c_str(),
139 static_cast<FrameProcedureOptions>(E.Value));
140 }
141}
142
143void ScalarEnumerationTraits<CPUType>::enumeration(IO &io, CPUType &Cpu) {
144 auto CpuNames = getCPUTypeNames();
145 for (const auto &E : CpuNames) {
146 io.enumCase(Cpu, E.Name.str().c_str(), static_cast<CPUType>(E.Value));
147 }
148}
149
150void ScalarEnumerationTraits<RegisterId>::enumeration(IO &io, RegisterId &Reg) {
151 auto RegNames = getRegisterNames();
152 for (const auto &E : RegNames) {
153 io.enumCase(Reg, E.Name.str().c_str(), static_cast<RegisterId>(E.Value));
154 }
155 io.enumFallback<Hex16>(Reg);
156}
157
158void ScalarEnumerationTraits<TrampolineType>::enumeration(
159 IO &io, TrampolineType &Tramp) {
160 auto TrampNames = getTrampolineNames();
161 for (const auto &E : TrampNames) {
162 io.enumCase(Tramp, E.Name.str().c_str(),
163 static_cast<TrampolineType>(E.Value));
164 }
165}
166
167void ScalarEnumerationTraits<ThunkOrdinal>::enumeration(IO &io,
168 ThunkOrdinal &Ord) {
169 auto ThunkNames = getThunkOrdinalNames();
170 for (const auto &E : ThunkNames) {
171 io.enumCase(Ord, E.Name.str().c_str(), static_cast<ThunkOrdinal>(E.Value));
172 }
173}
174
175void ScalarEnumerationTraits<FrameCookieKind>::enumeration(
176 IO &io, FrameCookieKind &FC) {
177 auto ThunkNames = getFrameCookieKindNames();
178 for (const auto &E : ThunkNames) {
179 io.enumCase(FC, E.Name.str().c_str(),
180 static_cast<FrameCookieKind>(E.Value));
181 }
182}
183
184namespace llvm {
185namespace yaml {
186template <> struct MappingTraits<LocalVariableAddrRange> {
187 static void mapping(IO &io, LocalVariableAddrRange &Range) {
188 io.mapRequired("OffsetStart", Range.OffsetStart);
189 io.mapRequired("ISectStart", Range.ISectStart);
190 io.mapRequired("Range", Range.Range);
191 }
192};
193template <> struct MappingTraits<LocalVariableAddrGap> {
194 static void mapping(IO &io, LocalVariableAddrGap &Gap) {
195 io.mapRequired("GapStartOffset", Gap.GapStartOffset);
196 io.mapRequired("Range", Gap.Range);
197 }
198};
199} // namespace yaml
200} // namespace llvm
201
202namespace llvm {
203namespace CodeViewYAML {
204namespace detail {
205
206struct SymbolRecordBase {
207 codeview::SymbolKind Kind;
208
209 explicit SymbolRecordBase(codeview::SymbolKind K) : Kind(K) {}
210 virtual ~SymbolRecordBase() = default;
211
212 virtual void map(yaml::IO &io) = 0;
213 virtual codeview::CVSymbol
214 toCodeViewSymbol(BumpPtrAllocator &Allocator,
215 CodeViewContainer Container) const = 0;
216 virtual Error fromCodeViewSymbol(codeview::CVSymbol Type) = 0;
217};
218
219template <typename T> struct SymbolRecordImpl : public SymbolRecordBase {
220 explicit SymbolRecordImpl(codeview::SymbolKind K)
221 : SymbolRecordBase(K), Symbol(static_cast<SymbolRecordKind>(K)) {}
222
223 void map(yaml::IO &io) override;
224
225 codeview::CVSymbol
226 toCodeViewSymbol(BumpPtrAllocator &Allocator,
227 CodeViewContainer Container) const override {
228 return SymbolSerializer::writeOneSymbol(Symbol, Allocator, Container);
229 }
230
231 Error fromCodeViewSymbol(codeview::CVSymbol CVS) override {
232 return SymbolDeserializer::deserializeAs<T>(CVS, Symbol);
233 }
234
235 mutable T Symbol;
236};
237
238struct UnknownSymbolRecord : public SymbolRecordBase {
239 explicit UnknownSymbolRecord(codeview::SymbolKind K) : SymbolRecordBase(K) {}
240
241 void map(yaml::IO &io) override;
242
243 CVSymbol toCodeViewSymbol(BumpPtrAllocator &Allocator,
244 CodeViewContainer Container) const override {
245 RecordPrefix Prefix;
246 uint32_t TotalLen = sizeof(RecordPrefix) + Data.size();
247 Prefix.RecordKind = Kind;
248 Prefix.RecordLen = TotalLen - 2;
249 uint8_t *Buffer = Allocator.Allocate<uint8_t>(TotalLen);
250 ::memcpy(Buffer, &Prefix, sizeof(RecordPrefix));
251 ::memcpy(Buffer + sizeof(RecordPrefix), Data.data(), Data.size());
252 return CVSymbol(Kind, ArrayRef<uint8_t>(Buffer, TotalLen));
253 }
254
255 Error fromCodeViewSymbol(CVSymbol CVS) override {
256 this->Kind = CVS.kind();
257 Data = CVS.RecordData.drop_front(sizeof(RecordPrefix));
258 return Error::success();
259 }
260
261 std::vector<uint8_t> Data;
262};
263
264template <> void SymbolRecordImpl<ScopeEndSym>::map(IO &IO) {}
265
266void UnknownSymbolRecord::map(yaml::IO &io) {
267 yaml::BinaryRef Binary;
268 if (io.outputting())
269 Binary = yaml::BinaryRef(Data);
270 io.mapRequired("Data", Binary);
271 if (!io.outputting()) {
272 std::string Str;
273 raw_string_ostream OS(Str);
274 Binary.writeAsBinary(OS);
275 OS.flush();
276 Data.assign(Str.begin(), Str.end());
277 }
278}
279
280template <> void SymbolRecordImpl<Thunk32Sym>::map(IO &IO) {
281 IO.mapRequired("Parent", Symbol.Parent);
282 IO.mapRequired("End", Symbol.End);
283 IO.mapRequired("Next", Symbol.Next);
284 IO.mapRequired("Off", Symbol.Offset);
285 IO.mapRequired("Seg", Symbol.Segment);
286 IO.mapRequired("Len", Symbol.Length);
287 IO.mapRequired("Ordinal", Symbol.Thunk);
288}
289
290template <> void SymbolRecordImpl<TrampolineSym>::map(IO &IO) {
291 IO.mapRequired("Type", Symbol.Type);
292 IO.mapRequired("Size", Symbol.Size);
293 IO.mapRequired("ThunkOff", Symbol.ThunkOffset);
294 IO.mapRequired("TargetOff", Symbol.TargetOffset);
295 IO.mapRequired("ThunkSection", Symbol.ThunkSection);
296 IO.mapRequired("TargetSection", Symbol.TargetSection);
297}
298
299template <> void SymbolRecordImpl<SectionSym>::map(IO &IO) {
300 IO.mapRequired("SectionNumber", Symbol.SectionNumber);
301 IO.mapRequired("Alignment", Symbol.Alignment);
302 IO.mapRequired("Rva", Symbol.Rva);
303 IO.mapRequired("Length", Symbol.Length);
304 IO.mapRequired("Characteristics", Symbol.Characteristics);
305 IO.mapRequired("Name", Symbol.Name);
306}
307
308template <> void SymbolRecordImpl<CoffGroupSym>::map(IO &IO) {
309 IO.mapRequired("Size", Symbol.Size);
310 IO.mapRequired("Characteristics", Symbol.Characteristics);
311 IO.mapRequired("Offset", Symbol.Offset);
312 IO.mapRequired("Segment", Symbol.Segment);
313 IO.mapRequired("Name", Symbol.Name);
314}
315
316template <> void SymbolRecordImpl<ExportSym>::map(IO &IO) {
317 IO.mapRequired("Ordinal", Symbol.Ordinal);
318 IO.mapRequired("Flags", Symbol.Flags);
319 IO.mapRequired("Name", Symbol.Name);
320}
321
322template <> void SymbolRecordImpl<ProcSym>::map(IO &IO) {
323 IO.mapOptional("PtrParent", Symbol.Parent, 0U);
324 IO.mapOptional("PtrEnd", Symbol.End, 0U);
325 IO.mapOptional("PtrNext", Symbol.Next, 0U);
326 IO.mapRequired("CodeSize", Symbol.CodeSize);
327 IO.mapRequired("DbgStart", Symbol.DbgStart);
328 IO.mapRequired("DbgEnd", Symbol.DbgEnd);
329 IO.mapRequired("FunctionType", Symbol.FunctionType);
330 IO.mapOptional("Offset", Symbol.CodeOffset, 0U);
331 IO.mapOptional("Segment", Symbol.Segment, uint16_t(0));
332 IO.mapRequired("Flags", Symbol.Flags);
333 IO.mapRequired("DisplayName", Symbol.Name);
334}
335
336template <> void SymbolRecordImpl<RegisterSym>::map(IO &IO) {
337 IO.mapRequired("Type", Symbol.Index);
338 IO.mapRequired("Seg", Symbol.Register);
339 IO.mapRequired("Name", Symbol.Name);
340}
341
342template <> void SymbolRecordImpl<PublicSym32>::map(IO &IO) {
343 IO.mapRequired("Flags", Symbol.Flags);
344 IO.mapOptional("Offset", Symbol.Offset, 0U);
345 IO.mapOptional("Segment", Symbol.Segment, uint16_t(0));
346 IO.mapRequired("Name", Symbol.Name);
347}
348
349template <> void SymbolRecordImpl<ProcRefSym>::map(IO &IO) {
350 IO.mapRequired("SumName", Symbol.SumName);
351 IO.mapRequired("SymOffset", Symbol.SymOffset);
352 IO.mapRequired("Mod", Symbol.Module);
353 IO.mapRequired("Name", Symbol.Name);
354}
355
356template <> void SymbolRecordImpl<EnvBlockSym>::map(IO &IO) {
357 IO.mapRequired("Entries", Symbol.Fields);
358}
359
360template <> void SymbolRecordImpl<InlineSiteSym>::map(IO &IO) {
361 IO.mapOptional("PtrParent", Symbol.Parent, 0U);
362 IO.mapOptional("PtrEnd", Symbol.End, 0U);
363 IO.mapRequired("Inlinee", Symbol.Inlinee);
364 // TODO: The binary annotations
365}
366
367template <> void SymbolRecordImpl<LocalSym>::map(IO &IO) {
368 IO.mapRequired("Type", Symbol.Type);
369 IO.mapRequired("Flags", Symbol.Flags);
370
371 IO.mapRequired("VarName", Symbol.Name);
372}
373
374template <> void SymbolRecordImpl<DefRangeSym>::map(IO &IO) {
375 IO.mapRequired("Program", Symbol.Program);
376 IO.mapRequired("Range", Symbol.Range);
377 IO.mapRequired("Gaps", Symbol.Gaps);
378}
379
380template <> void SymbolRecordImpl<DefRangeSubfieldSym>::map(IO &IO) {
381 IO.mapRequired("Program", Symbol.Program);
382 IO.mapRequired("OffsetInParent", Symbol.OffsetInParent);
383 IO.mapRequired("Range", Symbol.Range);
384 IO.mapRequired("Gaps", Symbol.Gaps);
385}
386
387template <> void SymbolRecordImpl<DefRangeRegisterSym>::map(IO &IO) {
388 IO.mapRequired("Register", Symbol.Hdr.Register);
389 IO.mapRequired("MayHaveNoName", Symbol.Hdr.MayHaveNoName);
390 IO.mapRequired("Range", Symbol.Range);
391 IO.mapRequired("Gaps", Symbol.Gaps);
392}
393
394template <> void SymbolRecordImpl<DefRangeFramePointerRelSym>::map(IO &IO) {
395 IO.mapRequired("Offset", Symbol.Offset);
396 IO.mapRequired("Range", Symbol.Range);
397 IO.mapRequired("Gaps", Symbol.Gaps);
398}
399
400template <> void SymbolRecordImpl<DefRangeSubfieldRegisterSym>::map(IO &IO) {
401 IO.mapRequired("Register", Symbol.Hdr.Register);
402 IO.mapRequired("MayHaveNoName", Symbol.Hdr.MayHaveNoName);
403 IO.mapRequired("OffsetInParent", Symbol.Hdr.OffsetInParent);
404 IO.mapRequired("Range", Symbol.Range);
405 IO.mapRequired("Gaps", Symbol.Gaps);
406}
407
408template <>
409void SymbolRecordImpl<DefRangeFramePointerRelFullScopeSym>::map(IO &IO) {
410 IO.mapRequired("Register", Symbol.Offset);
411}
412
413template <> void SymbolRecordImpl<DefRangeRegisterRelSym>::map(IO &IO) {
414 IO.mapRequired("Register", Symbol.Hdr.Register);
415 IO.mapRequired("Flags", Symbol.Hdr.Flags);
416 IO.mapRequired("BasePointerOffset", Symbol.Hdr.BasePointerOffset);
417 IO.mapRequired("Range", Symbol.Range);
418 IO.mapRequired("Gaps", Symbol.Gaps);
419}
420
421template <> void SymbolRecordImpl<BlockSym>::map(IO &IO) {
422 IO.mapOptional("PtrParent", Symbol.Parent, 0U);
423 IO.mapOptional("PtrEnd", Symbol.End, 0U);
424 IO.mapRequired("CodeSize", Symbol.CodeSize);
425 IO.mapOptional("Offset", Symbol.CodeOffset, 0U);
426 IO.mapOptional("Segment", Symbol.Segment, uint16_t(0));
427 IO.mapRequired("BlockName", Symbol.Name);
428}
429
430template <> void SymbolRecordImpl<LabelSym>::map(IO &IO) {
431 IO.mapOptional("Offset", Symbol.CodeOffset, 0U);
432 IO.mapOptional("Segment", Symbol.Segment, uint16_t(0));
433 IO.mapRequired("Flags", Symbol.Flags);
434 IO.mapRequired("Flags", Symbol.Flags);
435 IO.mapRequired("DisplayName", Symbol.Name);
436}
437
438template <> void SymbolRecordImpl<ObjNameSym>::map(IO &IO) {
439 IO.mapRequired("Signature", Symbol.Signature);
440 IO.mapRequired("ObjectName", Symbol.Name);
441}
442
443template <> void SymbolRecordImpl<Compile2Sym>::map(IO &IO) {
444 IO.mapRequired("Flags", Symbol.Flags);
445 IO.mapRequired("Machine", Symbol.Machine);
446 IO.mapRequired("FrontendMajor", Symbol.VersionFrontendMajor);
447 IO.mapRequired("FrontendMinor", Symbol.VersionFrontendMinor);
448 IO.mapRequired("FrontendBuild", Symbol.VersionFrontendBuild);
449 IO.mapRequired("BackendMajor", Symbol.VersionBackendMajor);
450 IO.mapRequired("BackendMinor", Symbol.VersionBackendMinor);
451 IO.mapRequired("BackendBuild", Symbol.VersionBackendBuild);
452 IO.mapRequired("Version", Symbol.Version);
453}
454
455template <> void SymbolRecordImpl<Compile3Sym>::map(IO &IO) {
456 IO.mapRequired("Flags", Symbol.Flags);
457 IO.mapRequired("Machine", Symbol.Machine);
458 IO.mapRequired("FrontendMajor", Symbol.VersionFrontendMajor);
459 IO.mapRequired("FrontendMinor", Symbol.VersionFrontendMinor);
460 IO.mapRequired("FrontendBuild", Symbol.VersionFrontendBuild);
461 IO.mapRequired("FrontendQFE", Symbol.VersionFrontendQFE);
462 IO.mapRequired("BackendMajor", Symbol.VersionBackendMajor);
463 IO.mapRequired("BackendMinor", Symbol.VersionBackendMinor);
464 IO.mapRequired("BackendBuild", Symbol.VersionBackendBuild);
465 IO.mapRequired("BackendQFE", Symbol.VersionBackendQFE);
466 IO.mapRequired("Version", Symbol.Version);
467}
468
469template <> void SymbolRecordImpl<FrameProcSym>::map(IO &IO) {
470 IO.mapRequired("TotalFrameBytes", Symbol.TotalFrameBytes);
471 IO.mapRequired("PaddingFrameBytes", Symbol.PaddingFrameBytes);
472 IO.mapRequired("OffsetToPadding", Symbol.OffsetToPadding);
473 IO.mapRequired("BytesOfCalleeSavedRegisters",
474 Symbol.BytesOfCalleeSavedRegisters);
475 IO.mapRequired("OffsetOfExceptionHandler", Symbol.OffsetOfExceptionHandler);
476 IO.mapRequired("SectionIdOfExceptionHandler",
477 Symbol.SectionIdOfExceptionHandler);
478 IO.mapRequired("Flags", Symbol.Flags);
479}
480
481template <> void SymbolRecordImpl<CallSiteInfoSym>::map(IO &IO) {
482 IO.mapOptional("Offset", Symbol.CodeOffset, 0U);
483 IO.mapOptional("Segment", Symbol.Segment, uint16_t(0));
484 IO.mapRequired("Type", Symbol.Type);
485}
486
487template <> void SymbolRecordImpl<FileStaticSym>::map(IO &IO) {
488 IO.mapRequired("Index", Symbol.Index);
489 IO.mapRequired("ModFilenameOffset", Symbol.ModFilenameOffset);
490 IO.mapRequired("Flags", Symbol.Flags);
491 IO.mapRequired("Name", Symbol.Name);
492}
493
494template <> void SymbolRecordImpl<HeapAllocationSiteSym>::map(IO &IO) {
495 IO.mapOptional("Offset", Symbol.CodeOffset, 0U);
496 IO.mapOptional("Segment", Symbol.Segment, uint16_t(0));
497 IO.mapRequired("CallInstructionSize", Symbol.CallInstructionSize);
498 IO.mapRequired("Type", Symbol.Type);
499}
500
501template <> void SymbolRecordImpl<FrameCookieSym>::map(IO &IO) {
502 IO.mapRequired("Register", Symbol.Register);
503 IO.mapRequired("CookieKind", Symbol.CookieKind);
504 IO.mapRequired("Flags", Symbol.Flags);
505}
506
507template <> void SymbolRecordImpl<CallerSym>::map(IO &IO) {
508 IO.mapRequired("FuncID", Symbol.Indices);
509}
510
511template <> void SymbolRecordImpl<UDTSym>::map(IO &IO) {
512 IO.mapRequired("Type", Symbol.Type);
513 IO.mapRequired("UDTName", Symbol.Name);
514}
515
516template <> void SymbolRecordImpl<BuildInfoSym>::map(IO &IO) {
517 IO.mapRequired("BuildId", Symbol.BuildId);
518}
519
520template <> void SymbolRecordImpl<BPRelativeSym>::map(IO &IO) {
521 IO.mapRequired("Offset", Symbol.Offset);
522 IO.mapRequired("Type", Symbol.Type);
523 IO.mapRequired("VarName", Symbol.Name);
524}
525
526template <> void SymbolRecordImpl<RegRelativeSym>::map(IO &IO) {
527 IO.mapRequired("Offset", Symbol.Offset);
528 IO.mapRequired("Type", Symbol.Type);
529 IO.mapRequired("Register", Symbol.Register);
530 IO.mapRequired("VarName", Symbol.Name);
531}
532
533template <> void SymbolRecordImpl<ConstantSym>::map(IO &IO) {
534 IO.mapRequired("Type", Symbol.Type);
535 IO.mapRequired("Value", Symbol.Value);
536 IO.mapRequired("Name", Symbol.Name);
537}
538
539template <> void SymbolRecordImpl<DataSym>::map(IO &IO) {
540 IO.mapRequired("Type", Symbol.Type);
541 IO.mapOptional("Offset", Symbol.DataOffset, 0U);
542 IO.mapOptional("Segment", Symbol.Segment, uint16_t(0));
543 IO.mapRequired("DisplayName", Symbol.Name);
544}
545
546template <> void SymbolRecordImpl<ThreadLocalDataSym>::map(IO &IO) {
547 IO.mapRequired("Type", Symbol.Type);
548 IO.mapOptional("Offset", Symbol.DataOffset, 0U);
549 IO.mapOptional("Segment", Symbol.Segment, uint16_t(0));
550 IO.mapRequired("DisplayName", Symbol.Name);
551}
552
553template <> void SymbolRecordImpl<UsingNamespaceSym>::map(IO &IO) {
554 IO.mapRequired("Namespace", Symbol.Name);
555}
556
557} // end namespace detail
558} // end namespace CodeViewYAML
559} // end namespace llvm
560
561CVSymbol CodeViewYAML::SymbolRecord::toCodeViewSymbol(
562 BumpPtrAllocator &Allocator, CodeViewContainer Container) const {
563 return Symbol->toCodeViewSymbol(Allocator, Container);
564}
565
566namespace llvm {
567namespace yaml {
568
569template <> struct MappingTraits<SymbolRecordBase> {
570 static void mapping(IO &io, SymbolRecordBase &Record) { Record.map(io); }
571};
572
573} // end namespace yaml
574} // end namespace llvm
575
576template <typename SymbolType>
577static inline Expected<CodeViewYAML::SymbolRecord>
578fromCodeViewSymbolImpl(CVSymbol Symbol) {
579 CodeViewYAML::SymbolRecord Result;
580
581 auto Impl = std::make_shared<SymbolType>(Symbol.kind());
582 if (auto EC = Impl->fromCodeViewSymbol(Symbol))
583 return std::move(EC);
584 Result.Symbol = Impl;
585 return Result;
586}
587
588Expected<CodeViewYAML::SymbolRecord>
589CodeViewYAML::SymbolRecord::fromCodeViewSymbol(CVSymbol Symbol) {
590#define SYMBOL_RECORD(EnumName, EnumVal, ClassName) \
591 case EnumName: \
592 return fromCodeViewSymbolImpl<SymbolRecordImpl<ClassName>>(Symbol);
593#define SYMBOL_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName) \
594 SYMBOL_RECORD(EnumName, EnumVal, ClassName)
595 switch (Symbol.kind()) {
596#include "llvm/DebugInfo/CodeView/CodeViewSymbols.def"
597 default:
598 return fromCodeViewSymbolImpl<UnknownSymbolRecord>(Symbol);
599 }
600 return make_error<CodeViewError>(cv_error_code::corrupt_record);
601}
602
603template <typename ConcreteType>
604static void mapSymbolRecordImpl(IO &IO, const char *Class, SymbolKind Kind,
605 CodeViewYAML::SymbolRecord &Obj) {
606 if (!IO.outputting())
607 Obj.Symbol = std::make_shared<ConcreteType>(Kind);
608
609 IO.mapRequired(Class, *Obj.Symbol);
610}
611
612void MappingTraits<CodeViewYAML::SymbolRecord>::mapping(
613 IO &IO, CodeViewYAML::SymbolRecord &Obj) {
614 SymbolKind Kind;
1
'Kind' declared without an initial value
→
615 if (IO.outputting())
2
←
Assuming the condition is false
→
3
←
Taking false branch
→
616 Kind = Obj.Symbol->Kind;
617 IO.mapRequired("Kind", Kind);
4
←
Calling 'IO::mapRequired'
→
618
619#define SYMBOL_RECORD(EnumName, EnumVal, ClassName) \
620 case EnumName: \
621 mapSymbolRecordImpl<SymbolRecordImpl<ClassName>>(IO, #ClassName, Kind, \
622 Obj); \
623 break;
624#define SYMBOL_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName) \
625 SYMBOL_RECORD(EnumName, EnumVal, ClassName)
626 switch (Kind) {
627#include "llvm/DebugInfo/CodeView/CodeViewSymbols.def"
628 default:
629 mapSymbolRecordImpl<UnknownSymbolRecord>(IO, "UnknownSym", Kind, Obj);
630 }
631}
←

/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/YAMLTraits.h

1//===- llvm/Support/YAMLTraits.h --------------------------------*- C++ -*-===//
2//
3// The LLVM Linker
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_SUPPORT_YAMLTRAITS_H
11#define LLVM_SUPPORT_YAMLTRAITS_H
12
13#include "llvm/ADT/Optional.h"
14#include "llvm/ADT/SmallVector.h"
15#include "llvm/ADT/StringExtras.h"
16#include "llvm/ADT/StringMap.h"
17#include "llvm/ADT/StringRef.h"
18#include "llvm/ADT/Twine.h"
19#include "llvm/Support/AlignOf.h"
20#include "llvm/Support/Allocator.h"
21#include "llvm/Support/Endian.h"
22#include "llvm/Support/Regex.h"
23#include "llvm/Support/SourceMgr.h"
24#include "llvm/Support/YAMLParser.h"
25#include "llvm/Support/raw_ostream.h"
26#include <cassert>
27#include <cctype>
28#include <cstddef>
29#include <cstdint>
30#include <iterator>
31#include <map>
32#include <memory>
33#include <new>
34#include <string>
35#include <system_error>
36#include <type_traits>
37#include <vector>
38
39namespace llvm {
40namespace yaml {
41
42enum class NodeKind : uint8_t {
43 Scalar,
44 Map,
45 Sequence,
46};
47
48struct EmptyContext {};
49
50/// This class should be specialized by any type that needs to be converted
51/// to/from a YAML mapping. For example:
52///
53/// struct MappingTraits<MyStruct> {
54/// static void mapping(IO &io, MyStruct &s) {
55/// io.mapRequired("name", s.name);
56/// io.mapRequired("size", s.size);
57/// io.mapOptional("age", s.age);
58/// }
59/// };
60template<class T>
61struct MappingTraits {
62 // Must provide:
63 // static void mapping(IO &io, T &fields);
64 // Optionally may provide:
65 // static StringRef validate(IO &io, T &fields);
66 //
67 // The optional flow flag will cause generated YAML to use a flow mapping
68 // (e.g. { a: 0, b: 1 }):
69 // static const bool flow = true;
70};
71
72/// This class is similar to MappingTraits<T> but allows you to pass in
73/// additional context for each map operation. For example:
74///
75/// struct MappingContextTraits<MyStruct, MyContext> {
76/// static void mapping(IO &io, MyStruct &s, MyContext &c) {
77/// io.mapRequired("name", s.name);
78/// io.mapRequired("size", s.size);
79/// io.mapOptional("age", s.age);
80/// ++c.TimesMapped;
81/// }
82/// };
83template <class T, class Context> struct MappingContextTraits {
84 // Must provide:
85 // static void mapping(IO &io, T &fields, Context &Ctx);
86 // Optionally may provide:
87 // static StringRef validate(IO &io, T &fields, Context &Ctx);
88 //
89 // The optional flow flag will cause generated YAML to use a flow mapping
90 // (e.g. { a: 0, b: 1 }):
91 // static const bool flow = true;
92};
93
94/// This class should be specialized by any integral type that converts
95/// to/from a YAML scalar where there is a one-to-one mapping between
96/// in-memory values and a string in YAML. For example:
97///
98/// struct ScalarEnumerationTraits<Colors> {
99/// static void enumeration(IO &io, Colors &value) {
100/// io.enumCase(value, "red", cRed);
101/// io.enumCase(value, "blue", cBlue);
102/// io.enumCase(value, "green", cGreen);
103/// }
104/// };
105template<typename T>
106struct ScalarEnumerationTraits {
107 // Must provide:
108 // static void enumeration(IO &io, T &value);
109};
110
111/// This class should be specialized by any integer type that is a union
112/// of bit values and the YAML representation is a flow sequence of
113/// strings. For example:
114///
115/// struct ScalarBitSetTraits<MyFlags> {
116/// static void bitset(IO &io, MyFlags &value) {
117/// io.bitSetCase(value, "big", flagBig);
118/// io.bitSetCase(value, "flat", flagFlat);
119/// io.bitSetCase(value, "round", flagRound);
120/// }
121/// };
122template<typename T>
123struct ScalarBitSetTraits {
124 // Must provide:
125 // static void bitset(IO &io, T &value);
126};
127
128/// Describe which type of quotes should be used when quoting is necessary.
129/// Some non-printable characters need to be double-quoted, while some others
130/// are fine with simple-quoting, and some don't need any quoting.
131enum class QuotingType { None, Single, Double };
132
133/// This class should be specialized by type that requires custom conversion
134/// to/from a yaml scalar. For example:
135///
136/// template<>
137/// struct ScalarTraits<MyType> {
138/// static void output(const MyType &val, void*, llvm::raw_ostream &out) {
139/// // stream out custom formatting
140/// out << llvm::format("%x", val);
141/// }
142/// static StringRef input(StringRef scalar, void*, MyType &value) {
143/// // parse scalar and set `value`
144/// // return empty string on success, or error string
145/// return StringRef();
146/// }
147/// static QuotingType mustQuote(StringRef) { return QuotingType::Single; }
148/// };
149template<typename T>
150struct ScalarTraits {
151 // Must provide:
152 //
153 // Function to write the value as a string:
154 // static void output(const T &value, void *ctxt, llvm::raw_ostream &out);
155 //
156 // Function to convert a string to a value. Returns the empty
157 // StringRef on success or an error string if string is malformed:
158 // static StringRef input(StringRef scalar, void *ctxt, T &value);
159 //
160 // Function to determine if the value should be quoted.
161 // static QuotingType mustQuote(StringRef);
162};
163
164/// This class should be specialized by type that requires custom conversion
165/// to/from a YAML literal block scalar. For example:
166///
167/// template <>
168/// struct BlockScalarTraits<MyType> {
169/// static void output(const MyType &Value, void*, llvm::raw_ostream &Out)
170/// {
171/// // stream out custom formatting
172/// Out << Value;
173/// }
174/// static StringRef input(StringRef Scalar, void*, MyType &Value) {
175/// // parse scalar and set `value`
176/// // return empty string on success, or error string
177/// return StringRef();
178/// }
179/// };
180template <typename T>
181struct BlockScalarTraits {
182 // Must provide:
183 //
184 // Function to write the value as a string:
185 // static void output(const T &Value, void *ctx, llvm::raw_ostream &Out);
186 //
187 // Function to convert a string to a value. Returns the empty
188 // StringRef on success or an error string if string is malformed:
189 // static StringRef input(StringRef Scalar, void *ctxt, T &Value);
190 //
191 // Optional:
192 // static StringRef inputTag(T &Val, std::string Tag)
193 // static void outputTag(const T &Val, raw_ostream &Out)
194};
195
196/// This class should be specialized by type that requires custom conversion
197/// to/from a YAML scalar with optional tags. For example:
198///
199/// template <>
200/// struct TaggedScalarTraits<MyType> {
201/// static void output(const MyType &Value, void*, llvm::raw_ostream
202/// &ScalarOut, llvm::raw_ostream &TagOut)
203/// {
204/// // stream out custom formatting including optional Tag
205/// Out << Value;
206/// }
207/// static StringRef input(StringRef Scalar, StringRef Tag, void*, MyType
208/// &Value) {
209/// // parse scalar and set `value`
210/// // return empty string on success, or error string
211/// return StringRef();
212/// }
213/// static QuotingType mustQuote(const MyType &Value, StringRef) {
214/// return QuotingType::Single;
215/// }
216/// };
217template <typename T> struct TaggedScalarTraits {
218 // Must provide:
219 //
220 // Function to write the value and tag as strings:
221 // static void output(const T &Value, void *ctx, llvm::raw_ostream &ScalarOut,
222 // llvm::raw_ostream &TagOut);
223 //
224 // Function to convert a string to a value. Returns the empty
225 // StringRef on success or an error string if string is malformed:
226 // static StringRef input(StringRef Scalar, StringRef Tag, void *ctxt, T
227 // &Value);
228 //
229 // Function to determine if the value should be quoted.
230 // static QuotingType mustQuote(const T &Value, StringRef Scalar);
231};
232
233/// This class should be specialized by any type that needs to be converted
234/// to/from a YAML sequence. For example:
235///
236/// template<>
237/// struct SequenceTraits<MyContainer> {
238/// static size_t size(IO &io, MyContainer &seq) {
239/// return seq.size();
240/// }
241/// static MyType& element(IO &, MyContainer &seq, size_t index) {
242/// if ( index >= seq.size() )
243/// seq.resize(index+1);
244/// return seq[index];
245/// }
246/// };
247template<typename T, typename EnableIf = void>
248struct SequenceTraits {
249 // Must provide:
250 // static size_t size(IO &io, T &seq);
251 // static T::value_type& element(IO &io, T &seq, size_t index);
252 //
253 // The following is option and will cause generated YAML to use
254 // a flow sequence (e.g. [a,b,c]).
255 // static const bool flow = true;
256};
257
258/// This class should be specialized by any type for which vectors of that
259/// type need to be converted to/from a YAML sequence.
260template<typename T, typename EnableIf = void>
261struct SequenceElementTraits {
262 // Must provide:
263 // static const bool flow;
264};
265
266/// This class should be specialized by any type that needs to be converted
267/// to/from a list of YAML documents.
268template<typename T>
269struct DocumentListTraits {
270 // Must provide:
271 // static size_t size(IO &io, T &seq);
272 // static T::value_type& element(IO &io, T &seq, size_t index);
273};
274
275/// This class should be specialized by any type that needs to be converted
276/// to/from a YAML mapping in the case where the names of the keys are not known
277/// in advance, e.g. a string map.
278template <typename T>
279struct CustomMappingTraits {
280 // static void inputOne(IO &io, StringRef key, T &elem);
281 // static void output(IO &io, T &elem);
282};
283
284/// This class should be specialized by any type that can be represented as
285/// a scalar, map, or sequence, decided dynamically. For example:
286///
287/// typedef std::unique_ptr<MyBase> MyPoly;
288///
289/// template<>
290/// struct PolymorphicTraits<MyPoly> {
291/// static NodeKind getKind(const MyPoly &poly) {
292/// return poly->getKind();
293/// }
294/// static MyScalar& getAsScalar(MyPoly &poly) {
295/// if (!poly || !isa<MyScalar>(poly))
296/// poly.reset(new MyScalar());
297/// return *cast<MyScalar>(poly.get());
298/// }
299/// // ...
300/// };
301template <typename T> struct PolymorphicTraits {
302 // Must provide:
303 // static NodeKind getKind(const T &poly);
304 // static scalar_type &getAsScalar(T &poly);
305 // static map_type &getAsMap(T &poly);
306 // static sequence_type &getAsSequence(T &poly);
307};
308
309// Only used for better diagnostics of missing traits
310template <typename T>
311struct MissingTrait;
312
313// Test if ScalarEnumerationTraits<T> is defined on type T.
314template <class T>
315struct has_ScalarEnumerationTraits
316{
317 using Signature_enumeration = void (*)(class IO&, T&);
318
319 template <typename U>
320 static char test(SameType<Signature_enumeration, &U::enumeration>*);
321
322 template <typename U>
323 static double test(...);
324
325 static bool const value =
326 (sizeof(test<ScalarEnumerationTraits<T>>(nullptr)) == 1);
327};
328
329// Test if ScalarBitSetTraits<T> is defined on type T.
330template <class T>
331struct has_ScalarBitSetTraits
332{
333 using Signature_bitset = void (*)(class IO&, T&);
334
335 template <typename U>
336 static char test(SameType<Signature_bitset, &U::bitset>*);
337
338 template <typename U>
339 static double test(...);
340
341 static bool const value = (sizeof(test<ScalarBitSetTraits<T>>(nullptr)) == 1);
342};
343
344// Test if ScalarTraits<T> is defined on type T.
345template <class T>
346struct has_ScalarTraits
347{
348 using Signature_input = StringRef (*)(StringRef, void*, T&);
349 using Signature_output = void (*)(const T&, void*, raw_ostream&);
350 using Signature_mustQuote = QuotingType (*)(StringRef);
351
352 template <typename U>
353 static char test(SameType<Signature_input, &U::input> *,
354 SameType<Signature_output, &U::output> *,
355 SameType<Signature_mustQuote, &U::mustQuote> *);
356
357 template <typename U>
358 static double test(...);
359
360 static bool const value =
361 (sizeof(test<ScalarTraits<T>>(nullptr, nullptr, nullptr)) == 1);
362};
363
364// Test if BlockScalarTraits<T> is defined on type T.
365template <class T>
366struct has_BlockScalarTraits
367{
368 using Signature_input = StringRef (*)(StringRef, void *, T &);
369 using Signature_output = void (*)(const T &, void *, raw_ostream &);
370
371 template <typename U>
372 static char test(SameType<Signature_input, &U::input> *,
373 SameType<Signature_output, &U::output> *);
374
375 template <typename U>
376 static double test(...);
377
378 static bool const value =
379 (sizeof(test<BlockScalarTraits<T>>(nullptr, nullptr)) == 1);
380};
381
382// Test if TaggedScalarTraits<T> is defined on type T.
383template <class T> struct has_TaggedScalarTraits {
384 using Signature_input = StringRef (*)(StringRef, StringRef, void *, T &);
385 using Signature_output = void (*)(const T &, void *, raw_ostream &,
386 raw_ostream &);
387 using Signature_mustQuote = QuotingType (*)(const T &, StringRef);
388
389 template <typename U>
390 static char test(SameType<Signature_input, &U::input> *,
391 SameType<Signature_output, &U::output> *,
392 SameType<Signature_mustQuote, &U::mustQuote> *);
393
394 template <typename U> static double test(...);
395
396 static bool const value =
397 (sizeof(test<TaggedScalarTraits<T>>(nullptr, nullptr, nullptr)) == 1);
398};
399
400// Test if MappingContextTraits<T> is defined on type T.
401template <class T, class Context> struct has_MappingTraits {
402 using Signature_mapping = void (*)(class IO &, T &, Context &);
403
404 template <typename U>
405 static char test(SameType<Signature_mapping, &U::mapping>*);
406
407 template <typename U>
408 static double test(...);
409
410 static bool const value =
411 (sizeof(test<MappingContextTraits<T, Context>>(nullptr)) == 1);
412};
413
414// Test if MappingTraits<T> is defined on type T.
415template <class T> struct has_MappingTraits<T, EmptyContext> {
416 using Signature_mapping = void (*)(class IO &, T &);
417
418 template <typename U>
419 static char test(SameType<Signature_mapping, &U::mapping> *);
420
421 template <typename U> static double test(...);
422
423 static bool const value = (sizeof(test<MappingTraits<T>>(nullptr)) == 1);
424};
425
426// Test if MappingContextTraits<T>::validate() is defined on type T.
427template <class T, class Context> struct has_MappingValidateTraits {
428 using Signature_validate = StringRef (*)(class IO &, T &, Context &);
429
430 template <typename U>
431 static char test(SameType<Signature_validate, &U::validate>*);
432
433 template <typename U>
434 static double test(...);
435
436 static bool const value =
437 (sizeof(test<MappingContextTraits<T, Context>>(nullptr)) == 1);
438};
439
440// Test if MappingTraits<T>::validate() is defined on type T.
441template <class T> struct has_MappingValidateTraits<T, EmptyContext> {
442 using Signature_validate = StringRef (*)(class IO &, T &);
443
444 template <typename U>
445 static char test(SameType<Signature_validate, &U::validate> *);
446
447 template <typename U> static double test(...);
448
449 static bool const value = (sizeof(test<MappingTraits<T>>(nullptr)) == 1);
450};
451
452// Test if SequenceTraits<T> is defined on type T.
453template <class T>
454struct has_SequenceMethodTraits
455{
456 using Signature_size = size_t (*)(class IO&, T&);
457
458 template <typename U>
459 static char test(SameType<Signature_size, &U::size>*);
460
461 template <typename U>
462 static double test(...);
463
464 static bool const value = (sizeof(test<SequenceTraits<T>>(nullptr)) == 1);
465};
466
467// Test if CustomMappingTraits<T> is defined on type T.
468template <class T>
469struct has_CustomMappingTraits
470{
471 using Signature_input = void (*)(IO &io, StringRef key, T &v);
472
473 template <typename U>
474 static char test(SameType<Signature_input, &U::inputOne>*);
475
476 template <typename U>
477 static double test(...);
478
479 static bool const value =
480 (sizeof(test<CustomMappingTraits<T>>(nullptr)) == 1);
481};
482
483// has_FlowTraits<int> will cause an error with some compilers because
484// it subclasses int. Using this wrapper only instantiates the
485// real has_FlowTraits only if the template type is a class.
486template <typename T, bool Enabled = std::is_class<T>::value>
487class has_FlowTraits
488{
489public:
490 static const bool value = false;
491};
492
493// Some older gcc compilers don't support straight forward tests
494// for members, so test for ambiguity cause by the base and derived
495// classes both defining the member.
496template <class T>
497struct has_FlowTraits<T, true>
498{
499 struct Fallback { bool flow; };
500 struct Derived : T, Fallback { };
501
502 template<typename C>
503 static char (&f(SameType<bool Fallback::*, &C::flow>*))[1];
504
505 template<typename C>
506 static char (&f(...))[2];
507
508 static bool const value = sizeof(f<Derived>(nullptr)) == 2;
509};
510
511// Test if SequenceTraits<T> is defined on type T
512template<typename T>
513struct has_SequenceTraits : public std::integral_constant<bool,
514 has_SequenceMethodTraits<T>::value > { };
515
516// Test if DocumentListTraits<T> is defined on type T
517template <class T>
518struct has_DocumentListTraits
519{
520 using Signature_size = size_t (*)(class IO &, T &);
521
522 template <typename U>
523 static char test(SameType<Signature_size, &U::size>*);
524
525 template <typename U>
526 static double test(...);
527
528 static bool const value = (sizeof(test<DocumentListTraits<T>>(nullptr))==1);
529};
530
531template <class T> struct has_PolymorphicTraits {
532 using Signature_getKind = NodeKind (*)(const T &);
533
534 template <typename U>
535 static char test(SameType<Signature_getKind, &U::getKind> *);
536
537 template <typename U> static double test(...);
538
539 static bool const value = (sizeof(test<PolymorphicTraits<T>>(nullptr)) == 1);
540};
541
542inline bool isNumeric(StringRef S) {
543 const static auto skipDigits = [](StringRef Input) {
544 return Input.drop_front(
545 std::min(Input.find_first_not_of("0123456789"), Input.size()));
546 };
547
548 // Make S.front() and S.drop_front().front() (if S.front() is [+-]) calls
549 // safe.
550 if (S.empty() || S.equals("+") || S.equals("-"))
551 return false;
552
553 if (S.equals(".nan") || S.equals(".NaN") || S.equals(".NAN"))
554 return true;
555
556 // Infinity and decimal numbers can be prefixed with sign.
557 StringRef Tail = (S.front() == '-' || S.front() == '+') ? S.drop_front() : S;
558
559 // Check for infinity first, because checking for hex and oct numbers is more
560 // expensive.
561 if (Tail.equals(".inf") || Tail.equals(".Inf") || Tail.equals(".INF"))
562 return true;
563
564 // Section 10.3.2 Tag Resolution
565 // YAML 1.2 Specification prohibits Base 8 and Base 16 numbers prefixed with
566 // [-+], so S should be used instead of Tail.
567 if (S.startswith("0o"))
568 return S.size() > 2 &&
569 S.drop_front(2).find_first_not_of("01234567") == StringRef::npos;
570
571 if (S.startswith("0x"))
572 return S.size() > 2 && S.drop_front(2).find_first_not_of(
573 "0123456789abcdefABCDEF") == StringRef::npos;
574
575 // Parse float: [-+]? (\. [0-9]+ | [0-9]+ (\. [0-9]* )?) ([eE] [-+]? [0-9]+)?
576 S = Tail;
577
578 // Handle cases when the number starts with '.' and hence needs at least one
579 // digit after dot (as opposed by number which has digits before the dot), but
580 // doesn't have one.
581 if (S.startswith(".") &&
582 (S.equals(".") ||
583 (S.size() > 1 && std::strchr("0123456789", S[1]) == nullptr)))
584 return false;
585
586 if (S.startswith("E") || S.startswith("e"))
587 return false;
588
589 enum ParseState {
590 Default,
591 FoundDot,
592 FoundExponent,
593 };
594 ParseState State = Default;
595
596 S = skipDigits(S);
597
598 // Accept decimal integer.
599 if (S.empty())
600 return true;
601
602 if (S.front() == '.') {
603 State = FoundDot;
604 S = S.drop_front();
605 } else if (S.front() == 'e' || S.front() == 'E') {
606 State = FoundExponent;
607 S = S.drop_front();
608 } else {
609 return false;
610 }
611
612 if (State == FoundDot) {
613 S = skipDigits(S);
614 if (S.empty())
615 return true;
616
617 if (S.front() == 'e' || S.front() == 'E') {
618 State = FoundExponent;
619 S = S.drop_front();
620 } else {
621 return false;
622 }
623 }
624
625 assert(State == FoundExponent && "Should have found exponent at this point.")((State == FoundExponent && "Should have found exponent at this point."
) ? static_cast<void> (0) : __assert_fail ("State == FoundExponent && \"Should have found exponent at this point.\""
, "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/YAMLTraits.h"
, 625, __PRETTY_FUNCTION__));
626 if (S.empty())
627 return false;
628
629 if (S.front() == '+' || S.front() == '-') {
630 S = S.drop_front();
631 if (S.empty())
632 return false;
633 }
634
635 return skipDigits(S).empty();
636}
637
638inline bool isNull(StringRef S) {
639 return S.equals("null") || S.equals("Null") || S.equals("NULL") ||
640 S.equals("~");
641}
642
643inline bool isBool(StringRef S) {
644 return S.equals("true") || S.equals("True") || S.equals("TRUE") ||
645 S.equals("false") || S.equals("False") || S.equals("FALSE");
646}
647
648// 5.1. Character Set
649// The allowed character range explicitly excludes the C0 control block #x0-#x1F
650// (except for TAB #x9, LF #xA, and CR #xD which are allowed), DEL #x7F, the C1
651// control block #x80-#x9F (except for NEL #x85 which is allowed), the surrogate
652// block #xD800-#xDFFF, #xFFFE, and #xFFFF.
653inline QuotingType needsQuotes(StringRef S) {
654 if (S.empty())
655 return QuotingType::Single;
656 if (isspace(S.front()) || isspace(S.back()))
657 return QuotingType::Single;
658 if (isNull(S))
659 return QuotingType::Single;
660 if (isBool(S))
661 return QuotingType::Single;
662 if (isNumeric(S))
663 return QuotingType::Single;
664
665 // 7.3.3 Plain Style
666 // Plain scalars must not begin with most indicators, as this would cause
667 // ambiguity with other YAML constructs.
668 static constexpr char Indicators[] = R"(-?:\,[]{}#&*!|>'"%@`)";
669 if (S.find_first_of(Indicators) == 0)
670 return QuotingType::Single;
671
672 QuotingType MaxQuotingNeeded = QuotingType::None;
673 for (unsigned char C : S) {
674 // Alphanum is safe.
675 if (isAlnum(C))
676 continue;
677
678 switch (C) {
679 // Safe scalar characters.
680 case '_':
681 case '-':
682 case '^':
683 case '.':
684 case ',':
685 case ' ':
686 // TAB (0x9) is allowed in unquoted strings.
687 case 0x9:
688 continue;
689 // LF(0xA) and CR(0xD) may delimit values and so require at least single
690 // quotes.
691 case 0xA:
692 case 0xD:
693 MaxQuotingNeeded = QuotingType::Single;
694 continue;
695 // DEL (0x7F) are excluded from the allowed character range.
696 case 0x7F:
697 return QuotingType::Double;
698 // Forward slash is allowed to be unquoted, but we quote it anyway. We have
699 // many tests that use FileCheck against YAML output, and this output often
700 // contains paths. If we quote backslashes but not forward slashes then
701 // paths will come out either quoted or unquoted depending on which platform
702 // the test is run on, making FileCheck comparisons difficult.
703 case '/':
704 default: {
705 // C0 control block (0x0 - 0x1F) is excluded from the allowed character
706 // range.
707 if (C <= 0x1F)
708 return QuotingType::Double;
709
710 // Always double quote UTF-8.
711 if ((C & 0x80) != 0)
712 return QuotingType::Double;
713
714 // The character is not safe, at least simple quoting needed.
715 MaxQuotingNeeded = QuotingType::Single;
716 }
717 }
718 }
719
720 return MaxQuotingNeeded;
721}
722
723template <typename T, typename Context>
724struct missingTraits
725 : public std::integral_constant<bool,
726 !has_ScalarEnumerationTraits<T>::value &&
727 !has_ScalarBitSetTraits<T>::value &&
728 !has_ScalarTraits<T>::value &&
729 !has_BlockScalarTraits<T>::value &&
730 !has_TaggedScalarTraits<T>::value &&
731 !has_MappingTraits<T, Context>::value &&
732 !has_SequenceTraits<T>::value &&
733 !has_CustomMappingTraits<T>::value &&
734 !has_DocumentListTraits<T>::value &&
735 !has_PolymorphicTraits<T>::value> {};
736
737template <typename T, typename Context>
738struct validatedMappingTraits
739 : public std::integral_constant<
740 bool, has_MappingTraits<T, Context>::value &&
741 has_MappingValidateTraits<T, Context>::value> {};
742
743template <typename T, typename Context>
744struct unvalidatedMappingTraits
745 : public std::integral_constant<
746 bool, has_MappingTraits<T, Context>::value &&
747 !has_MappingValidateTraits<T, Context>::value> {};
748
749// Base class for Input and Output.
750class IO {
751public:
752 IO(void *Ctxt = nullptr);
753 virtual ~IO();
754
755 virtual bool outputting() = 0;
756
757 virtual unsigned beginSequence() = 0;
758 virtual bool preflightElement(unsigned, void *&) = 0;
759 virtual void postflightElement(void*) = 0;
760 virtual void endSequence() = 0;
761 virtual bool canElideEmptySequence() = 0;
762
763 virtual unsigned beginFlowSequence() = 0;
764 virtual bool preflightFlowElement(unsigned, void *&) = 0;
765 virtual void postflightFlowElement(void*) = 0;
766 virtual void endFlowSequence() = 0;
767
768 virtual bool mapTag(StringRef Tag, bool Default=false) = 0;
769 virtual void beginMapping() = 0;
770 virtual void endMapping() = 0;
771 virtual bool preflightKey(const char*, bool, bool, bool &, void *&) = 0;
772 virtual void postflightKey(void*) = 0;
773 virtual std::vector<StringRef> keys() = 0;
774
775 virtual void beginFlowMapping() = 0;
776 virtual void endFlowMapping() = 0;
777
778 virtual void beginEnumScalar() = 0;
779 virtual bool matchEnumScalar(const char*, bool) = 0;
780 virtual bool matchEnumFallback() = 0;
781 virtual void endEnumScalar() = 0;
782
783 virtual bool beginBitSetScalar(bool &) = 0;
784 virtual bool bitSetMatch(const char*, bool) = 0;
785 virtual void endBitSetScalar() = 0;
786
787 virtual void scalarString(StringRef &, QuotingType) = 0;
788 virtual void blockScalarString(StringRef &) = 0;
789 virtual void scalarTag(std::string &) = 0;
790
791 virtual NodeKind getNodeKind() = 0;
792
793 virtual void setError(const Twine &) = 0;
794
795 template <typename T>
796 void enumCase(T &Val, const char* Str, const T ConstVal) {
797 if ( matchEnumScalar(Str, outputting() && Val == ConstVal) ) {
13
←
Assuming the condition is true
→
14
←
The left operand of '==' is a garbage value
798 Val = ConstVal;
799 }
800 }
801
802 // allow anonymous enum values to be used with LLVM_YAML_STRONG_TYPEDEF
803 template <typename T>
804 void enumCase(T &Val, const char* Str, const uint32_t ConstVal) {
805 if ( matchEnumScalar(Str, outputting() && Val == static_cast<T>(ConstVal)) ) {
806 Val = ConstVal;
807 }
808 }
809
810 template <typename FBT, typename T>
811 void enumFallback(T &Val) {
812 if (matchEnumFallback()) {
813 EmptyContext Context;
814 // FIXME: Force integral conversion to allow strong typedefs to convert.
815 FBT Res = static_cast<typename FBT::BaseType>(Val);
816 yamlize(*this, Res, true, Context);
817 Val = static_cast<T>(static_cast<typename FBT::BaseType>(Res));
818 }
819 }
820
821 template <typename T>
822 void bitSetCase(T &Val, const char* Str, const T ConstVal) {
823 if ( bitSetMatch(Str, outputting() && (Val & ConstVal) == ConstVal) ) {
824 Val = static_cast<T>(Val | ConstVal);
825 }
826 }
827
828 // allow anonymous enum values to be used with LLVM_YAML_STRONG_TYPEDEF
829 template <typename T>
830 void bitSetCase(T &Val, const char* Str, const uint32_t ConstVal) {
831 if ( bitSetMatch(Str, outputting() && (Val & ConstVal) == ConstVal) ) {
832 Val = static_cast<T>(Val | ConstVal);
833 }
834 }
835
836 template <typename T>
837 void maskedBitSetCase(T &Val, const char *Str, T ConstVal, T Mask) {
838 if (bitSetMatch(Str, outputting() && (Val & Mask) == ConstVal))
839 Val = Val | ConstVal;
840 }
841
842 template <typename T>
843 void maskedBitSetCase(T &Val, const char *Str, uint32_t ConstVal,
844 uint32_t Mask) {
845 if (bitSetMatch(Str, outputting() && (Val & Mask) == ConstVal))
846 Val = Val | ConstVal;
847 }
848
849 void *getContext();
850 void setContext(void *);
851
852 template <typename T> void mapRequired(const char *Key, T &Val) {
853 EmptyContext Ctx;
854 this->processKey(Key, Val, true, Ctx);
5
←
Calling 'IO::processKey'
→
855 }
856
857 template <typename T, typename Context>
858 void mapRequired(const char *Key, T &Val, Context &Ctx) {
859 this->processKey(Key, Val, true, Ctx);
860 }
861
862 template <typename T> void mapOptional(const char *Key, T &Val) {
863 EmptyContext Ctx;
864 mapOptionalWithContext(Key, Val, Ctx);
865 }
866
867 template <typename T>
868 void mapOptional(const char *Key, T &Val, const T &Default) {
869 EmptyContext Ctx;
870 mapOptionalWithContext(Key, Val, Default, Ctx);
871 }
872
873 template <typename T, typename Context>
874 typename std::enable_if<has_SequenceTraits<T>::value, void>::type
875 mapOptionalWithContext(const char *Key, T &Val, Context &Ctx) {
876 // omit key/value instead of outputting empty sequence
877 if (this->canElideEmptySequence() && !(Val.begin() != Val.end()))
878 return;
879 this->processKey(Key, Val, false, Ctx);
880 }
881
882 template <typename T, typename Context>
883 void mapOptionalWithContext(const char *Key, Optional<T> &Val, Context &Ctx) {
884 this->processKeyWithDefault(Key, Val, Optional<T>(), /*Required=*/false,
885 Ctx);
886 }
887
888 template <typename T, typename Context>
889 typename std::enable_if<!has_SequenceTraits<T>::value, void>::type
890 mapOptionalWithContext(const char *Key, T &Val, Context &Ctx) {
891 this->processKey(Key, Val, false, Ctx);
892 }
893
894 template <typename T, typename Context>
895 void mapOptionalWithContext(const char *Key, T &Val, const T &Default,
896 Context &Ctx) {
897 this->processKeyWithDefault(Key, Val, Default, false, Ctx);
898 }
899
900private:
901 template <typename T, typename Context>
902 void processKeyWithDefault(const char *Key, Optional<T> &Val,
903 const Optional<T> &DefaultValue, bool Required,
904 Context &Ctx) {
905 assert(DefaultValue.hasValue() == false &&((DefaultValue.hasValue() == false && "Optional<T> shouldn't have a value!"
) ? static_cast<void> (0) : __assert_fail ("DefaultValue.hasValue() == false && \"Optional<T> shouldn't have a value!\""
, "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/YAMLTraits.h"
, 906, __PRETTY_FUNCTION__))
906 "Optional<T> shouldn't have a value!")((DefaultValue.hasValue() == false && "Optional<T> shouldn't have a value!"
) ? static_cast<void> (0) : __assert_fail ("DefaultValue.hasValue() == false && \"Optional<T> shouldn't have a value!\""
, "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/YAMLTraits.h"
, 906, __PRETTY_FUNCTION__));
907 void *SaveInfo;
908 bool UseDefault = true;
909 const bool sameAsDefault = outputting() && !Val.hasValue();
910 if (!outputting() && !Val.hasValue())
911 Val = T();
912 if (Val.hasValue() &&
913 this->preflightKey(Key, Required, sameAsDefault, UseDefault,
914 SaveInfo)) {
915 yamlize(*this, Val.getValue(), Required, Ctx);
916 this->postflightKey(SaveInfo);
917 } else {
918 if (UseDefault)
919 Val = DefaultValue;
920 }
921 }
922
923 template <typename T, typename Context>
924 void processKeyWithDefault(const char *Key, T &Val, const T &DefaultValue,
925 bool Required, Context &Ctx) {
926 void *SaveInfo;
927 bool UseDefault;
928 const bool sameAsDefault = outputting() && Val == DefaultValue;
929 if ( this->preflightKey(Key, Required, sameAsDefault, UseDefault,
930 SaveInfo) ) {
931 yamlize(*this, Val, Required, Ctx);
932 this->postflightKey(SaveInfo);
933 }
934 else {
935 if ( UseDefault )
936 Val = DefaultValue;
937 }
938 }
939
940 template <typename T, typename Context>
941 void processKey(const char *Key, T &Val, bool Required, Context &Ctx) {
942 void *SaveInfo;
943 bool UseDefault;
944 if ( this->preflightKey(Key, Required, false, UseDefault, SaveInfo) ) {
6
←
Assuming the condition is true
→
7
←
Taking true branch
→
945 yamlize(*this, Val, Required, Ctx);
8
←
Calling 'yamlize<llvm::codeview::SymbolKind>'
→
946 this->postflightKey(SaveInfo);
947 }
948 }
949
950private:
951 void *Ctxt;
952};
953
954namespace detail {
955
956template <typename T, typename Context>
957void doMapping(IO &io, T &Val, Context &Ctx) {
958 MappingContextTraits<T, Context>::mapping(io, Val, Ctx);
959}
960
961template <typename T> void doMapping(IO &io, T &Val, EmptyContext &Ctx) {
962 MappingTraits<T>::mapping(io, Val);
963}
964
965} // end namespace detail
966
967template <typename T>
968typename std::enable_if<has_ScalarEnumerationTraits<T>::value, void>::type
969yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
970 io.beginEnumScalar();
971 ScalarEnumerationTraits<T>::enumeration(io, Val);
9
←
Calling 'ScalarEnumerationTraits::enumeration'
→
972 io.endEnumScalar();
973}
974
975template <typename T>
976typename std::enable_if<has_ScalarBitSetTraits<T>::value, void>::type
977yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
978 bool DoClear;
979 if ( io.beginBitSetScalar(DoClear) ) {
980 if ( DoClear )
981 Val = static_cast<T>(0);
982 ScalarBitSetTraits<T>::bitset(io, Val);
983 io.endBitSetScalar();
984 }
985}
986
987template <typename T>
988typename std::enable_if<has_ScalarTraits<T>::value, void>::type
989yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
990 if ( io.outputting() ) {
991 std::string Storage;
992 raw_string_ostream Buffer(Storage);
993 ScalarTraits<T>::output(Val, io.getContext(), Buffer);
994 StringRef Str = Buffer.str();
995 io.scalarString(Str, ScalarTraits<T>::mustQuote(Str));
996 }
997 else {
998 StringRef Str;
999 io.scalarString(Str, ScalarTraits<T>::mustQuote(Str));
1000 StringRef Result = ScalarTraits<T>::input(Str, io.getContext(), Val);
1001 if ( !Result.empty() ) {
1002 io.setError(Twine(Result));
1003 }
1004 }
1005}
1006
1007template <typename T>
1008typename std::enable_if<has_BlockScalarTraits<T>::value, void>::type
1009yamlize(IO &YamlIO, T &Val, bool, EmptyContext &Ctx) {
1010 if (YamlIO.outputting()) {
1011 std::string Storage;
1012 raw_string_ostream Buffer(Storage);
1013 BlockScalarTraits<T>::output(Val, YamlIO.getContext(), Buffer);
1014 StringRef Str = Buffer.str();
1015 YamlIO.blockScalarString(Str);
1016 } else {
1017 StringRef Str;
1018 YamlIO.blockScalarString(Str);
1019 StringRef Result =
1020 BlockScalarTraits<T>::input(Str, YamlIO.getContext(), Val);
1021 if (!Result.empty())
1022 YamlIO.setError(Twine(Result));
1023 }
1024}
1025
1026template <typename T>
1027typename std::enable_if<has_TaggedScalarTraits<T>::value, void>::type
1028yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
1029 if (io.outputting()) {
1030 std::string ScalarStorage, TagStorage;
1031 raw_string_ostream ScalarBuffer(ScalarStorage), TagBuffer(TagStorage);
1032 TaggedScalarTraits<T>::output(Val, io.getContext(), ScalarBuffer,
1033 TagBuffer);
1034 io.scalarTag(TagBuffer.str());
1035 StringRef ScalarStr = ScalarBuffer.str();
1036 io.scalarString(ScalarStr,
1037 TaggedScalarTraits<T>::mustQuote(Val, ScalarStr));
1038 } else {
1039 std::string Tag;
1040 io.scalarTag(Tag);
1041 StringRef Str;
1042 io.scalarString(Str, QuotingType::None);
1043 StringRef Result =
1044 TaggedScalarTraits<T>::input(Str, Tag, io.getContext(), Val);
1045 if (!Result.empty()) {
1046 io.setError(Twine(Result));
1047 }
1048 }
1049}
1050
1051template <typename T, typename Context>
1052typename std::enable_if<validatedMappingTraits<T, Context>::value, void>::type
1053yamlize(IO &io, T &Val, bool, Context &Ctx) {
1054 if (has_FlowTraits<MappingTraits<T>>::value)
1055 io.beginFlowMapping();
1056 else
1057 io.beginMapping();
1058 if (io.outputting()) {
1059 StringRef Err = MappingTraits<T>::validate(io, Val);
1060 if (!Err.empty()) {
1061 errs() << Err << "\n";
1062 assert(Err.empty() && "invalid struct trying to be written as yaml")((Err.empty() && "invalid struct trying to be written as yaml"
) ? static_cast<void> (0) : __assert_fail ("Err.empty() && \"invalid struct trying to be written as yaml\""
, "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/YAMLTraits.h"
, 1062, __PRETTY_FUNCTION__));
1063 }
1064 }
1065 detail::doMapping(io, Val, Ctx);
1066 if (!io.outputting()) {
1067 StringRef Err = MappingTraits<T>::validate(io, Val);
1068 if (!Err.empty())
1069 io.setError(Err);
1070 }
1071 if (has_FlowTraits<MappingTraits<T>>::value)
1072 io.endFlowMapping();
1073 else
1074 io.endMapping();
1075}
1076
1077template <typename T, typename Context>
1078typename std::enable_if<unvalidatedMappingTraits<T, Context>::value, void>::type
1079yamlize(IO &io, T &Val, bool, Context &Ctx) {
1080 if (has_FlowTraits<MappingTraits<T>>::value) {
1081 io.beginFlowMapping();
1082 detail::doMapping(io, Val, Ctx);
1083 io.endFlowMapping();
1084 } else {
1085 io.beginMapping();
1086 detail::doMapping(io, Val, Ctx);
1087 io.endMapping();
1088 }
1089}
1090
1091template <typename T>
1092typename std::enable_if<has_CustomMappingTraits<T>::value, void>::type
1093yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
1094 if ( io.outputting() ) {
1095 io.beginMapping();
1096 CustomMappingTraits<T>::output(io, Val);
1097 io.endMapping();
1098 } else {
1099 io.beginMapping();
1100 for (StringRef key : io.keys())
1101 CustomMappingTraits<T>::inputOne(io, key, Val);
1102 io.endMapping();
1103 }
1104}
1105
1106template <typename T>
1107typename std::enable_if<has_PolymorphicTraits<T>::value, void>::type
1108yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
1109 switch (io.outputting() ? PolymorphicTraits<T>::getKind(Val)
1110 : io.getNodeKind()) {
1111 case NodeKind::Scalar:
1112 return yamlize(io, PolymorphicTraits<T>::getAsScalar(Val), true, Ctx);
1113 case NodeKind::Map:
1114 return yamlize(io, PolymorphicTraits<T>::getAsMap(Val), true, Ctx);
1115 case NodeKind::Sequence:
1116 return yamlize(io, PolymorphicTraits<T>::getAsSequence(Val), true, Ctx);
1117 }
1118}
1119
1120template <typename T>
1121typename std::enable_if<missingTraits<T, EmptyContext>::value, void>::type
1122yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
1123 char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
1124}
1125
1126template <typename T, typename Context>
1127typename std::enable_if<has_SequenceTraits<T>::value, void>::type
1128yamlize(IO &io, T &Seq, bool, Context &Ctx) {
1129 if ( has_FlowTraits< SequenceTraits<T>>::value ) {
1130 unsigned incnt = io.beginFlowSequence();
1131 unsigned count = io.outputting() ? SequenceTraits<T>::size(io, Seq) : incnt;
1132 for(unsigned i=0; i < count; ++i) {
1133 void *SaveInfo;
1134 if ( io.preflightFlowElement(i, SaveInfo) ) {
1135 yamlize(io, SequenceTraits<T>::element(io, Seq, i), true, Ctx);
1136 io.postflightFlowElement(SaveInfo);
1137 }
1138 }
1139 io.endFlowSequence();
1140 }
1141 else {
1142 unsigned incnt = io.beginSequence();
1143 unsigned count = io.outputting() ? SequenceTraits<T>::size(io, Seq) : incnt;
1144 for(unsigned i=0; i < count; ++i) {
1145 void *SaveInfo;
1146 if ( io.preflightElement(i, SaveInfo) ) {
1147 yamlize(io, SequenceTraits<T>::element(io, Seq, i), true, Ctx);
1148 io.postflightElement(SaveInfo);
1149 }
1150 }
1151 io.endSequence();
1152 }
1153}
1154
1155template<>
1156struct ScalarTraits<bool> {
1157 static void output(const bool &, void* , raw_ostream &);
1158 static StringRef input(StringRef, void *, bool &);
1159 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1160};
1161
1162template<>
1163struct ScalarTraits<StringRef> {
1164 static void output(const StringRef &, void *, raw_ostream &);
1165 static StringRef input(StringRef, void *, StringRef &);
1166 static QuotingType mustQuote(StringRef S) { return needsQuotes(S); }
1167};
1168
1169template<>
1170struct ScalarTraits<std::string> {
1171 static void output(const std::string &, void *, raw_ostream &);
1172 static StringRef input(StringRef, void *, std::string &);
1173 static QuotingType mustQuote(StringRef S) { return needsQuotes(S); }
1174};
1175
1176template<>
1177struct ScalarTraits<uint8_t> {
1178 static void output(const uint8_t &, void *, raw_ostream &);
1179 static StringRef input(StringRef, void *, uint8_t &);
1180 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1181};
1182
1183template<>
1184struct ScalarTraits<uint16_t> {
1185 static void output(const uint16_t &, void *, raw_ostream &);
1186 static StringRef input(StringRef, void *, uint16_t &);
1187 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1188};
1189
1190template<>
1191struct ScalarTraits<uint32_t> {
1192 static void output(const uint32_t &, void *, raw_ostream &);
1193 static StringRef input(StringRef, void *, uint32_t &);
1194 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1195};
1196
1197template<>
1198struct ScalarTraits<uint64_t> {
1199 static void output(const uint64_t &, void *, raw_ostream &);
1200 static StringRef input(StringRef, void *, uint64_t &);
1201 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1202};
1203
1204template<>
1205struct ScalarTraits<int8_t> {
1206 static void output(const int8_t &, void *, raw_ostream &);
1207 static StringRef input(StringRef, void *, int8_t &);
1208 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1209};
1210
1211template<>
1212struct ScalarTraits<int16_t> {
1213 static void output(const int16_t &, void *, raw_ostream &);
1214 static StringRef input(StringRef, void *, int16_t &);
1215 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1216};
1217
1218template<>
1219struct ScalarTraits<int32_t> {
1220 static void output(const int32_t &, void *, raw_ostream &);
1221 static StringRef input(StringRef, void *, int32_t &);
1222 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1223};
1224
1225template<>
1226struct ScalarTraits<int64_t> {
1227 static void output(const int64_t &, void *, raw_ostream &);
1228 static StringRef input(StringRef, void *, int64_t &);
1229 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1230};
1231
1232template<>
1233struct ScalarTraits<float> {
1234 static void output(const float &, void *, raw_ostream &);
1235 static StringRef input(StringRef, void *, float &);
1236 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1237};
1238
1239template<>
1240struct ScalarTraits<double> {
1241 static void output(const double &, void *, raw_ostream &);
1242 static StringRef input(StringRef, void *, double &);
1243 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1244};
1245
1246// For endian types, we just use the existing ScalarTraits for the underlying
1247// type. This way endian aware types are supported whenever a ScalarTraits
1248// is defined for the underlying type.
1249template <typename value_type, support::endianness endian, size_t alignment>
1250struct ScalarTraits<support::detail::packed_endian_specific_integral<
1251 value_type, endian, alignment>> {
1252 using endian_type =
1253 support::detail::packed_endian_specific_integral<value_type, endian,
1254 alignment>;
1255
1256 static void output(const endian_type &E, void *Ctx, raw_ostream &Stream) {
1257 ScalarTraits<value_type>::output(static_cast<value_type>(E), Ctx, Stream);
1258 }
1259
1260 static StringRef input(StringRef Str, void *Ctx, endian_type &E) {
1261 value_type V;
1262 auto R = ScalarTraits<value_type>::input(Str, Ctx, V);
1263 E = static_cast<endian_type>(V);
1264 return R;
1265 }
1266
1267 static QuotingType mustQuote(StringRef Str) {
1268 return ScalarTraits<value_type>::mustQuote(Str);
1269 }
1270};
1271
1272// Utility for use within MappingTraits<>::mapping() method
1273// to [de]normalize an object for use with YAML conversion.
1274template <typename TNorm, typename TFinal>
1275struct MappingNormalization {
1276 MappingNormalization(IO &i_o, TFinal &Obj)
1277 : io(i_o), BufPtr(nullptr), Result(Obj) {
1278 if ( io.outputting() ) {
1279 BufPtr = new (&Buffer) TNorm(io, Obj);
1280 }
1281 else {
1282 BufPtr = new (&Buffer) TNorm(io);
1283 }
1284 }
1285
1286 ~MappingNormalization() {
1287 if ( ! io.outputting() ) {
1288 Result = BufPtr->denormalize(io);
1289 }
1290 BufPtr->~TNorm();
1291 }
1292
1293 TNorm* operator->() { return BufPtr; }
1294
1295private:
1296 using Storage = AlignedCharArrayUnion<TNorm>;
1297
1298 Storage Buffer;
1299 IO &io;
1300 TNorm *BufPtr;
1301 TFinal &Result;
1302};
1303
1304// Utility for use within MappingTraits<>::mapping() method
1305// to [de]normalize an object for use with YAML conversion.
1306template <typename TNorm, typename TFinal>
1307struct MappingNormalizationHeap {
1308 MappingNormalizationHeap(IO &i_o, TFinal &Obj, BumpPtrAllocator *allocator)
1309 : io(i_o), Result(Obj) {
1310 if ( io.outputting() ) {
1311 BufPtr = new (&Buffer) TNorm(io, Obj);
1312 }
1313 else if (allocator) {
1314 BufPtr = allocator->Allocate<TNorm>();
1315 new (BufPtr) TNorm(io);
1316 } else {
1317 BufPtr = new TNorm(io);
1318 }
1319 }
1320
1321 ~MappingNormalizationHeap() {
1322 if ( io.outputting() ) {
1323 BufPtr->~TNorm();
1324 }
1325 else {
1326 Result = BufPtr->denormalize(io);
1327 }
1328 }
1329
1330 TNorm* operator->() { return BufPtr; }
1331
1332private:
1333 using Storage = AlignedCharArrayUnion<TNorm>;
1334
1335 Storage Buffer;
1336 IO &io;
1337 TNorm *BufPtr = nullptr;
1338 TFinal &Result;
1339};
1340
1341///
1342/// The Input class is used to parse a yaml document into in-memory structs
1343/// and vectors.
1344///
1345/// It works by using YAMLParser to do a syntax parse of the entire yaml
1346/// document, then the Input class builds a graph of HNodes which wraps
1347/// each yaml Node. The extra layer is buffering. The low level yaml
1348/// parser only lets you look at each node once. The buffering layer lets
1349/// you search and interate multiple times. This is necessary because
1350/// the mapRequired() method calls may not be in the same order
1351/// as the keys in the document.
1352///
1353class Input : public IO {
1354public:
1355 // Construct a yaml Input object from a StringRef and optional
1356 // user-data. The DiagHandler can be specified to provide
1357 // alternative error reporting.
1358 Input(StringRef InputContent,
1359 void *Ctxt = nullptr,
1360 SourceMgr::DiagHandlerTy DiagHandler = nullptr,
1361 void *DiagHandlerCtxt = nullptr);
1362 Input(MemoryBufferRef Input,
1363 void *Ctxt = nullptr,
1364 SourceMgr::DiagHandlerTy DiagHandler = nullptr,
1365 void *DiagHandlerCtxt = nullptr);
1366 ~Input() override;
1367
1368 // Check if there was an syntax or semantic error during parsing.
1369 std::error_code error();
1370
1371private:
1372 bool outputting() override;
1373 bool mapTag(StringRef, bool) override;
1374 void beginMapping() override;
1375 void endMapping() override;
1376 bool preflightKey(const char *, bool, bool, bool &, void *&) override;
1377 void postflightKey(void *) override;
1378 std::vector<StringRef> keys() override;
1379 void beginFlowMapping() override;
1380 void endFlowMapping() override;
1381 unsigned beginSequence() override;
1382 void endSequence() override;
1383 bool preflightElement(unsigned index, void *&) override;
1384 void postflightElement(void *) override;
1385 unsigned beginFlowSequence() override;
1386 bool preflightFlowElement(unsigned , void *&) override;
1387 void postflightFlowElement(void *) override;
1388 void endFlowSequence() override;
1389 void beginEnumScalar() override;
1390 bool matchEnumScalar(const char*, bool) override;
1391 bool matchEnumFallback() override;
1392 void endEnumScalar() override;
1393 bool beginBitSetScalar(bool &) override;
1394 bool bitSetMatch(const char *, bool ) override;
1395 void endBitSetScalar() override;
1396 void scalarString(StringRef &, QuotingType) override;
1397 void blockScalarString(StringRef &) override;
1398 void scalarTag(std::string &) override;
1399 NodeKind getNodeKind() override;
1400 void setError(const Twine &message) override;
1401 bool canElideEmptySequence() override;
1402
1403 class HNode {
1404 virtual void anchor();
1405
1406 public:
1407 HNode(Node *n) : _node(n) { }
1408 virtual ~HNode() = default;
1409
1410 static bool classof(const HNode *) { return true; }
1411
1412 Node *_node;
1413 };
1414
1415 class EmptyHNode : public HNode {
1416 void anchor() override;
1417
1418 public:
1419 EmptyHNode(Node *n) : HNode(n) { }
1420
1421 static bool classof(const HNode *n) { return NullNode::classof(n->_node); }
1422
1423 static bool classof(const EmptyHNode *) { return true; }
1424 };
1425
1426 class ScalarHNode : public HNode {
1427 void anchor() override;
1428
1429 public:
1430 ScalarHNode(Node *n, StringRef s) : HNode(n), _value(s) { }
1431
1432 StringRef value() const { return _value; }
1433
1434 static bool classof(const HNode *n) {
1435 return ScalarNode::classof(n->_node) ||
1436 BlockScalarNode::classof(n->_node);
1437 }
1438
1439 static bool classof(const ScalarHNode *) { return true; }
1440
1441 protected:
1442 StringRef _value;
1443 };
1444
1445 class MapHNode : public HNode {
1446 void anchor() override;
1447
1448 public:
1449 MapHNode(Node *n) : HNode(n) { }
1450
1451 static bool classof(const HNode *n) {
1452 return MappingNode::classof(n->_node);
1453 }
1454
1455 static bool classof(const MapHNode *) { return true; }
1456
1457 using NameToNode = StringMap<std::unique_ptr<HNode>>;
1458
1459 NameToNode Mapping;
1460 SmallVector<std::string, 6> ValidKeys;
1461 };
1462
1463 class SequenceHNode : public HNode {
1464 void anchor() override;
1465
1466 public:
1467 SequenceHNode(Node *n) : HNode(n) { }
1468
1469 static bool classof(const HNode *n) {
1470 return SequenceNode::classof(n->_node);
1471 }
1472
1473 static bool classof(const SequenceHNode *) { return true; }
1474
1475 std::vector<std::unique_ptr<HNode>> Entries;
1476 };
1477
1478 std::unique_ptr<Input::HNode> createHNodes(Node *node);
1479 void setError(HNode *hnode, const Twine &message);
1480 void setError(Node *node, const Twine &message);
1481
1482public:
1483 // These are only used by operator>>. They could be private
1484 // if those templated things could be made friends.
1485 bool setCurrentDocument();
1486 bool nextDocument();
1487
1488 /// Returns the current node that's being parsed by the YAML Parser.
1489 const Node *getCurrentNode() const;
1490
1491private:
1492 SourceMgr SrcMgr; // must be before Strm
1493 std::unique_ptr<llvm::yaml::Stream> Strm;
1494 std::unique_ptr<HNode> TopNode;
1495 std::error_code EC;
1496 BumpPtrAllocator StringAllocator;
1497 document_iterator DocIterator;
1498 std::vector<bool> BitValuesUsed;
1499 HNode *CurrentNode = nullptr;
1500 bool ScalarMatchFound;
1501};
1502
1503///
1504/// The Output class is used to generate a yaml document from in-memory structs
1505/// and vectors.
1506///
1507class Output : public IO {
1508public:
1509 Output(raw_ostream &, void *Ctxt = nullptr, int WrapColumn = 70);
1510 ~Output() override;
1511
1512 /// Set whether or not to output optional values which are equal
1513 /// to the default value. By default, when outputting if you attempt
1514 /// to write a value that is equal to the default, the value gets ignored.
1515 /// Sometimes, it is useful to be able to see these in the resulting YAML
1516 /// anyway.
1517 void setWriteDefaultValues(bool Write) { WriteDefaultValues = Write; }
1518
1519 bool outputting() override;
1520 bool mapTag(StringRef, bool) override;
1521 void beginMapping() override;
1522 void endMapping() override;
1523 bool preflightKey(const char *key, bool, bool, bool &, void *&) override;
1524 void postflightKey(void *) override;
1525 std::vector<StringRef> keys() override;
1526 void beginFlowMapping() override;
1527 void endFlowMapping() override;
1528 unsigned beginSequence() override;
1529 void endSequence() override;
1530 bool preflightElement(unsigned, void *&) override;
1531 void postflightElement(void *) override;
1532 unsigned beginFlowSequence() override;
1533 bool preflightFlowElement(unsigned, void *&) override;
1534 void postflightFlowElement(void *) override;
1535 void endFlowSequence() override;
1536 void beginEnumScalar() override;
1537 bool matchEnumScalar(const char*, bool) override;
1538 bool matchEnumFallback() override;
1539 void endEnumScalar() override;
1540 bool beginBitSetScalar(bool &) override;
1541 bool bitSetMatch(const char *, bool ) override;
1542 void endBitSetScalar() override;
1543 void scalarString(StringRef &, QuotingType) override;
1544 void blockScalarString(StringRef &) override;
1545 void scalarTag(std::string &) override;
1546 NodeKind getNodeKind() override;
1547 void setError(const Twine &message) override;
1548 bool canElideEmptySequence() override;
1549
1550 // These are only used by operator<<. They could be private
1551 // if that templated operator could be made a friend.
1552 void beginDocuments();
1553 bool preflightDocument(unsigned);
1554 void postflightDocument();
1555 void endDocuments();
1556
1557private:
1558 void output(StringRef s);
1559 void outputUpToEndOfLine(StringRef s);
1560 void newLineCheck();
1561 void outputNewLine();
1562 void paddedKey(StringRef key);
1563 void flowKey(StringRef Key);
1564
1565 enum InState {
1566 inSeqFirstElement,
1567 inSeqOtherElement,
1568 inFlowSeqFirstElement,
1569 inFlowSeqOtherElement,
1570 inMapFirstKey,
1571 inMapOtherKey,
1572 inFlowMapFirstKey,
1573 inFlowMapOtherKey
1574 };
1575
1576 static bool inSeqAnyElement(InState State);
1577 static bool inFlowSeqAnyElement(InState State);
1578 static bool inMapAnyKey(InState State);
1579 static bool inFlowMapAnyKey(InState State);
1580
1581 raw_ostream &Out;
1582 int WrapColumn;
1583 SmallVector<InState, 8> StateStack;
1584 int Column = 0;
1585 int ColumnAtFlowStart = 0;
1586 int ColumnAtMapFlowStart = 0;
1587 bool NeedBitValueComma = false;
1588 bool NeedFlowSequenceComma = false;
1589 bool EnumerationMatchFound = false;
1590 bool NeedsNewLine = false;
1591 bool WriteDefaultValues = false;
1592};
1593
1594/// YAML I/O does conversion based on types. But often native data types
1595/// are just a typedef of built in intergral types (e.g. int). But the C++
1596/// type matching system sees through the typedef and all the typedefed types
1597/// look like a built in type. This will cause the generic YAML I/O conversion
1598/// to be used. To provide better control over the YAML conversion, you can
1599/// use this macro instead of typedef. It will create a class with one field
1600/// and automatic conversion operators to and from the base type.
1601/// Based on BOOST_STRONG_TYPEDEF
1602#define LLVM_YAML_STRONG_TYPEDEF(_base, _type)struct _type { _type() = default; _type(const _base v) : value
(v) {} _type(const _type &v) = default; _type &operator
=(const _type &rhs) = default; _type &operator=(const
_base &rhs) { value = rhs; return *this; } operator const
_base & () const { return value; } bool operator==(const
_type &rhs) const { return value == rhs.value; } bool operator
==(const _base &rhs) const { return value == rhs; } bool operator
<(const _type &rhs) const { return value < rhs.value
; } _base value; using BaseType = _base; }; \
1603 struct _type { \
1604 _type() = default; \
1605 _type(const _base v) : value(v) {} \
1606 _type(const _type &v) = default; \
1607 _type &operator=(const _type &rhs) = default; \
1608 _type &operator=(const _base &rhs) { value = rhs; return *this; } \
1609 operator const _base & () const { return value; } \
1610 bool operator==(const _type &rhs) const { return value == rhs.value; } \
1611 bool operator==(const _base &rhs) const { return value == rhs; } \
1612 bool operator<(const _type &rhs) const { return value < rhs.value; } \
1613 _base value; \
1614 using BaseType = _base; \
1615 };
1616
1617///
1618/// Use these types instead of uintXX_t in any mapping to have
1619/// its yaml output formatted as hexadecimal.
1620///
1621LLVM_YAML_STRONG_TYPEDEF(uint8_t, Hex8)struct Hex8 { Hex8() = default; Hex8(const uint8_t v) : value
(v) {} Hex8(const Hex8 &v) = default; Hex8 &operator=
(const Hex8 &rhs) = default; Hex8 &operator=(const uint8_t
&rhs) { value = rhs; return *this; } operator const uint8_t
& () const { return value; } bool operator==(const Hex8 &
rhs) const { return value == rhs.value; } bool operator==(const
uint8_t &rhs) const { return value == rhs; } bool operator
<(const Hex8 &rhs) const { return value < rhs.value
; } uint8_t value; using BaseType = uint8_t; };
1622LLVM_YAML_STRONG_TYPEDEF(uint16_t, Hex16)struct Hex16 { Hex16() = default; Hex16(const uint16_t v) : value
(v) {} Hex16(const Hex16 &v) = default; Hex16 &operator
=(const Hex16 &rhs) = default; Hex16 &operator=(const
uint16_t &rhs) { value = rhs; return *this; } operator const
uint16_t & () const { return value; } bool operator==(const
Hex16 &rhs) const { return value == rhs.value; } bool operator
==(const uint16_t &rhs) const { return value == rhs; } bool
operator<(const Hex16 &rhs) const { return value <
rhs.value; } uint16_t value; using BaseType = uint16_t; };
1623LLVM_YAML_STRONG_TYPEDEF(uint32_t, Hex32)struct Hex32 { Hex32() = default; Hex32(const uint32_t v) : value
(v) {} Hex32(const Hex32 &v) = default; Hex32 &operator
=(const Hex32 &rhs) = default; Hex32 &operator=(const
uint32_t &rhs) { value = rhs; return *this; } operator const
uint32_t & () const { return value; } bool operator==(const
Hex32 &rhs) const { return value == rhs.value; } bool operator
==(const uint32_t &rhs) const { return value == rhs; } bool
operator<(const Hex32 &rhs) const { return value <
rhs.value; } uint32_t value; using BaseType = uint32_t; };
1624LLVM_YAML_STRONG_TYPEDEF(uint64_t, Hex64)struct Hex64 { Hex64() = default; Hex64(const uint64_t v) : value
(v) {} Hex64(const Hex64 &v) = default; Hex64 &operator
=(const Hex64 &rhs) = default; Hex64 &operator=(const
uint64_t &rhs) { value = rhs; return *this; } operator const
uint64_t & () const { return value; } bool operator==(const
Hex64 &rhs) const { return value == rhs.value; } bool operator
==(const uint64_t &rhs) const { return value == rhs; } bool
operator<(const Hex64 &rhs) const { return value <
rhs.value; } uint64_t value; using BaseType = uint64_t; };
1625
1626template<>
1627struct ScalarTraits<Hex8> {
1628 static void output(const Hex8 &, void *, raw_ostream &);
1629 static StringRef input(StringRef, void *, Hex8 &);
1630 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1631};
1632
1633template<>
1634struct ScalarTraits<Hex16> {
1635 static void output(const Hex16 &, void *, raw_ostream &);
1636 static StringRef input(StringRef, void *, Hex16 &);
1637 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1638};
1639
1640template<>
1641struct ScalarTraits<Hex32> {
1642 static void output(const Hex32 &, void *, raw_ostream &);
1643 static StringRef input(StringRef, void *, Hex32 &);
1644 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1645};
1646
1647template<>
1648struct ScalarTraits<Hex64> {
1649 static void output(const Hex64 &, void *, raw_ostream &);
1650 static StringRef input(StringRef, void *, Hex64 &);
1651 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1652};
1653
1654// Define non-member operator>> so that Input can stream in a document list.
1655template <typename T>
1656inline
1657typename std::enable_if<has_DocumentListTraits<T>::value, Input &>::type
1658operator>>(Input &yin, T &docList) {
1659 int i = 0;
1660 EmptyContext Ctx;
1661 while ( yin.setCurrentDocument() ) {
1662 yamlize(yin, DocumentListTraits<T>::element(yin, docList, i), true, Ctx);
1663 if ( yin.error() )
1664 return yin;
1665 yin.nextDocument();
1666 ++i;
1667 }
1668 return yin;
1669}
1670
1671// Define non-member operator>> so that Input can stream in a map as a document.
1672template <typename T>
1673inline typename std::enable_if<has_MappingTraits<T, EmptyContext>::value,
1674 Input &>::type
1675operator>>(Input &yin, T &docMap) {
1676 EmptyContext Ctx;
1677 yin.setCurrentDocument();
1678 yamlize(yin, docMap, true, Ctx);
1679 return yin;
1680}
1681
1682// Define non-member operator>> so that Input can stream in a sequence as
1683// a document.
1684template <typename T>
1685inline
1686typename std::enable_if<has_SequenceTraits<T>::value, Input &>::type
1687operator>>(Input &yin, T &docSeq) {
1688 EmptyContext Ctx;
1689 if (yin.setCurrentDocument())
1690 yamlize(yin, docSeq, true, Ctx);
1691 return yin;
1692}
1693
1694// Define non-member operator>> so that Input can stream in a block scalar.
1695template <typename T>
1696inline
1697typename std::enable_if<has_BlockScalarTraits<T>::value, Input &>::type
1698operator>>(Input &In, T &Val) {
1699 EmptyContext Ctx;
1700 if (In.setCurrentDocument())
1701 yamlize(In, Val, true, Ctx);
1702 return In;
1703}
1704
1705// Define non-member operator>> so that Input can stream in a string map.
1706template <typename T>
1707inline
1708typename std::enable_if<has_CustomMappingTraits<T>::value, Input &>::type
1709operator>>(Input &In, T &Val) {
1710 EmptyContext Ctx;
1711 if (In.setCurrentDocument())
1712 yamlize(In, Val, true, Ctx);
1713 return In;
1714}
1715
1716// Define non-member operator>> so that Input can stream in a polymorphic type.
1717template <typename T>
1718inline typename std::enable_if<has_PolymorphicTraits<T>::value, Input &>::type
1719operator>>(Input &In, T &Val) {
1720 EmptyContext Ctx;
1721 if (In.setCurrentDocument())
1722 yamlize(In, Val, true, Ctx);
1723 return In;
1724}
1725
1726// Provide better error message about types missing a trait specialization
1727template <typename T>
1728inline typename std::enable_if<missingTraits<T, EmptyContext>::value,
1729 Input &>::type
1730operator>>(Input &yin, T &docSeq) {
1731 char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
1732 return yin;
1733}
1734
1735// Define non-member operator<< so that Output can stream out document list.
1736template <typename T>
1737inline
1738typename std::enable_if<has_DocumentListTraits<T>::value, Output &>::type
1739operator<<(Output &yout, T &docList) {
1740 EmptyContext Ctx;
1741 yout.beginDocuments();
1742 const size_t count = DocumentListTraits<T>::size(yout, docList);
1743 for(size_t i=0; i < count; ++i) {
1744 if ( yout.preflightDocument(i) ) {
1745 yamlize(yout, DocumentListTraits<T>::element(yout, docList, i), true,
1746 Ctx);
1747 yout.postflightDocument();
1748 }
1749 }
1750 yout.endDocuments();
1751 return yout;
1752}
1753
1754// Define non-member operator<< so that Output can stream out a map.
1755template <typename T>
1756inline typename std::enable_if<has_MappingTraits<T, EmptyContext>::value,
1757 Output &>::type
1758operator<<(Output &yout, T &map) {
1759 EmptyContext Ctx;
1760 yout.beginDocuments();
1761 if ( yout.preflightDocument(0) ) {
1762 yamlize(yout, map, true, Ctx);
1763 yout.postflightDocument();
1764 }
1765 yout.endDocuments();
1766 return yout;
1767}
1768
1769// Define non-member operator<< so that Output can stream out a sequence.
1770template <typename T>
1771inline
1772typename std::enable_if<has_SequenceTraits<T>::value, Output &>::type
1773operator<<(Output &yout, T &seq) {
1774 EmptyContext Ctx;
1775 yout.beginDocuments();
1776 if ( yout.preflightDocument(0) ) {
1777 yamlize(yout, seq, true, Ctx);
1778 yout.postflightDocument();
1779 }
1780 yout.endDocuments();
1781 return yout;
1782}
1783
1784// Define non-member operator<< so that Output can stream out a block scalar.
1785template <typename T>
1786inline
1787typename std::enable_if<has_BlockScalarTraits<T>::value, Output &>::type
1788operator<<(Output &Out, T &Val) {
1789 EmptyContext Ctx;
1790 Out.beginDocuments();
1791 if (Out.preflightDocument(0)) {
1792 yamlize(Out, Val, true, Ctx);
1793 Out.postflightDocument();
1794 }
1795 Out.endDocuments();
1796 return Out;
1797}
1798
1799// Define non-member operator<< so that Output can stream out a string map.
1800template <typename T>
1801inline
1802typename std::enable_if<has_CustomMappingTraits<T>::value, Output &>::type
1803operator<<(Output &Out, T &Val) {
1804 EmptyContext Ctx;
1805 Out.beginDocuments();
1806 if (Out.preflightDocument(0)) {
1807 yamlize(Out, Val, true, Ctx);
1808 Out.postflightDocument();
1809 }
1810 Out.endDocuments();
1811 return Out;
1812}
1813
1814// Define non-member operator<< so that Output can stream out a polymorphic
1815// type.
1816template <typename T>
1817inline typename std::enable_if<has_PolymorphicTraits<T>::value, Output &>::type
1818operator<<(Output &Out, T &Val) {
1819 EmptyContext Ctx;
1820 Out.beginDocuments();
1821 if (Out.preflightDocument(0)) {
1822 // FIXME: The parser does not support explicit documents terminated with a
1823 // plain scalar; the end-marker is included as part of the scalar token.
1824 assert(PolymorphicTraits<T>::getKind(Val) != NodeKind::Scalar && "plain scalar documents are not supported")((PolymorphicTraits<T>::getKind(Val) != NodeKind::Scalar
&& "plain scalar documents are not supported") ? static_cast
<void> (0) : __assert_fail ("PolymorphicTraits<T>::getKind(Val) != NodeKind::Scalar && \"plain scalar documents are not supported\""
, "/build/llvm-toolchain-snapshot-8~svn350071/include/llvm/Support/YAMLTraits.h"
, 1824, __PRETTY_FUNCTION__));
1825 yamlize(Out, Val, true, Ctx);
1826 Out.postflightDocument();
1827 }
1828 Out.endDocuments();
1829 return Out;
1830}
1831
1832// Provide better error message about types missing a trait specialization
1833template <typename T>
1834inline typename std::enable_if<missingTraits<T, EmptyContext>::value,
1835 Output &>::type
1836operator<<(Output &yout, T &seq) {
1837 char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
1838 return yout;
1839}
1840
1841template <bool B> struct IsFlowSequenceBase {};
1842template <> struct IsFlowSequenceBase<true> { static const bool flow = true; };
1843
1844template <typename T, bool Flow>
1845struct SequenceTraitsImpl : IsFlowSequenceBase<Flow> {
1846private:
1847 using type = typename T::value_type;
1848
1849public:
1850 static size_t size(IO &io, T &seq) { return seq.size(); }
1851
1852 static type &element(IO &io, T &seq, size_t index) {
1853 if (index >= seq.size())
1854 seq.resize(index + 1);
1855 return seq[index];
1856 }
1857};
1858
1859// Simple helper to check an expression can be used as a bool-valued template
1860// argument.
1861template <bool> struct CheckIsBool { static const bool value = true; };
1862
1863// If T has SequenceElementTraits, then vector<T> and SmallVector<T, N> have
1864// SequenceTraits that do the obvious thing.
1865template <typename T>
1866struct SequenceTraits<std::vector<T>,
1867 typename std::enable_if<CheckIsBool<
1868 SequenceElementTraits<T>::flow>::value>::type>
1869 : SequenceTraitsImpl<std::vector<T>, SequenceElementTraits<T>::flow> {};
1870template <typename T, unsigned N>
1871struct SequenceTraits<SmallVector<T, N>,
1872 typename std::enable_if<CheckIsBool<
1873 SequenceElementTraits<T>::flow>::value>::type>
1874 : SequenceTraitsImpl<SmallVector<T, N>, SequenceElementTraits<T>::flow> {};
1875
1876// Sequences of fundamental types use flow formatting.
1877template <typename T>
1878struct SequenceElementTraits<
1879 T, typename std::enable_if<std::is_fundamental<T>::value>::type> {
1880 static const bool flow = true;
1881};
1882
1883// Sequences of strings use block formatting.
1884template<> struct SequenceElementTraits<std::string> {
1885 static const bool flow = false;
1886};
1887template<> struct SequenceElementTraits<StringRef> {
1888 static const bool flow = false;
1889};
1890template<> struct SequenceElementTraits<std::pair<std::string, std::string>> {
1891 static const bool flow = false;
1892};
1893
1894/// Implementation of CustomMappingTraits for std::map<std::string, T>.
1895template <typename T> struct StdMapStringCustomMappingTraitsImpl {
1896 using map_type = std::map<std::string, T>;
1897
1898 static void inputOne(IO &io, StringRef key, map_type &v) {
1899 io.mapRequired(key.str().c_str(), v[key]);
1900 }
1901
1902 static void output(IO &io, map_type &v) {
1903 for (auto &p : v)
1904 io.mapRequired(p.first.c_str(), p.second);
1905 }
1906};
1907
1908} // end namespace yaml
1909} // end namespace llvm
1910
1911#define LLVM_YAML_IS_SEQUENCE_VECTOR_IMPL(TYPE, FLOW)namespace llvm { namespace yaml { static_assert( !std::is_fundamental
<TYPE>::value && !std::is_same<TYPE, std::string
>::value && !std::is_same<TYPE, llvm::StringRef
>::value, "only use LLVM_YAML_IS_SEQUENCE_VECTOR for types you control"
); template <> struct SequenceElementTraits<TYPE>
{ static const bool flow = FLOW; }; } } \
1912 namespace llvm { \
1913 namespace yaml { \
1914 static_assert( \
1915 !std::is_fundamental<TYPE>::value && \
1916 !std::is_same<TYPE, std::string>::value && \
1917 !std::is_same<TYPE, llvm::StringRef>::value, \
1918 "only use LLVM_YAML_IS_SEQUENCE_VECTOR for types you control"); \
1919 template <> struct SequenceElementTraits<TYPE> { \
1920 static const bool flow = FLOW; \
1921 }; \
1922 } \
1923 }
1924
1925/// Utility for declaring that a std::vector of a particular type
1926/// should be considered a YAML sequence.
1927#define LLVM_YAML_IS_SEQUENCE_VECTOR(type)namespace llvm { namespace yaml { static_assert( !std::is_fundamental
<type>::value && !std::is_same<type, std::string
>::value && !std::is_same<type, llvm::StringRef
>::value, "only use LLVM_YAML_IS_SEQUENCE_VECTOR for types you control"
); template <> struct SequenceElementTraits<type>
{ static const bool flow = false; }; } } \
1928 LLVM_YAML_IS_SEQUENCE_VECTOR_IMPL(type, false)namespace llvm { namespace yaml { static_assert( !std::is_fundamental
<type>::value && !std::is_same<type, std::string
>::value && !std::is_same<type, llvm::StringRef
>::value, "only use LLVM_YAML_IS_SEQUENCE_VECTOR for types you control"
); template <> struct SequenceElementTraits<type>
{ static const bool flow = false; }; } }
1929
1930/// Utility for declaring that a std::vector of a particular type
1931/// should be considered a YAML flow sequence.
1932#define LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(type)namespace llvm { namespace yaml { static_assert( !std::is_fundamental
<type>::value && !std::is_same<type, std::string
>::value && !std::is_same<type, llvm::StringRef
>::value, "only use LLVM_YAML_IS_SEQUENCE_VECTOR for types you control"
); template <> struct SequenceElementTraits<type>
{ static const bool flow = true; }; } } \
1933 LLVM_YAML_IS_SEQUENCE_VECTOR_IMPL(type, true)namespace llvm { namespace yaml { static_assert( !std::is_fundamental
<type>::value && !std::is_same<type, std::string
>::value && !std::is_same<type, llvm::StringRef
>::value, "only use LLVM_YAML_IS_SEQUENCE_VECTOR for types you control"
); template <> struct SequenceElementTraits<type>
{ static const bool flow = true; }; } }
1934
1935#define LLVM_YAML_DECLARE_MAPPING_TRAITS(Type)namespace llvm { namespace yaml { template <> struct MappingTraits
<Type> { static void mapping(IO &IO, Type &Obj)
; }; } } \
1936 namespace llvm { \
1937 namespace yaml { \
1938 template <> struct MappingTraits<Type> { \
1939 static void mapping(IO &IO, Type &Obj); \
1940 }; \
1941 } \
1942 }
1943
1944#define LLVM_YAML_DECLARE_ENUM_TRAITS(Type)namespace llvm { namespace yaml { template <> struct ScalarEnumerationTraits
<Type> { static void enumeration(IO &io, Type &
Value); }; } } \
1945 namespace llvm { \
1946 namespace yaml { \
1947 template <> struct ScalarEnumerationTraits<Type> { \
1948 static void enumeration(IO &io, Type &Value); \
1949 }; \
1950 } \
1951 }
1952
1953#define LLVM_YAML_DECLARE_BITSET_TRAITS(Type)namespace llvm { namespace yaml { template <> struct ScalarBitSetTraits
<Type> { static void bitset(IO &IO, Type &Options
); }; } } \
1954 namespace llvm { \
1955 namespace yaml { \
1956 template <> struct ScalarBitSetTraits<Type> { \
1957 static void bitset(IO &IO, Type &Options); \
1958 }; \
1959 } \
1960 }
1961
1962#define LLVM_YAML_DECLARE_SCALAR_TRAITS(Type, MustQuote)namespace llvm { namespace yaml { template <> struct ScalarTraits
<Type> { static void output(const Type &Value, void
*ctx, raw_ostream &Out); static StringRef input(StringRef
Scalar, void *ctxt, Type &Value); static QuotingType mustQuote
(StringRef) { return MustQuote; } }; } } \
1963 namespace llvm { \
1964 namespace yaml { \
1965 template <> struct ScalarTraits<Type> { \
1966 static void output(const Type &Value, void *ctx, raw_ostream &Out); \
1967 static StringRef input(StringRef Scalar, void *ctxt, Type &Value); \
1968 static QuotingType mustQuote(StringRef) { return MustQuote; } \
1969 }; \
1970 } \
1971 }
1972
1973/// Utility for declaring that a std::vector of a particular type
1974/// should be considered a YAML document list.
1975#define LLVM_YAML_IS_DOCUMENT_LIST_VECTOR(_type)namespace llvm { namespace yaml { template <unsigned N>
struct DocumentListTraits<SmallVector<_type, N>>
: public SequenceTraitsImpl<SmallVector<_type, N>, false
> {}; template <> struct DocumentListTraits<std::
vector<_type>> : public SequenceTraitsImpl<std::vector
<_type>, false> {}; } } \
1976 namespace llvm { \
1977 namespace yaml { \
1978 template <unsigned N> \
1979 struct DocumentListTraits<SmallVector<_type, N>> \
1980 : public SequenceTraitsImpl<SmallVector<_type, N>, false> {}; \
1981 template <> \
1982 struct DocumentListTraits<std::vector<_type>> \
1983 : public SequenceTraitsImpl<std::vector<_type>, false> {}; \
1984 } \
1985 }
1986
1987/// Utility for declaring that std::map<std::string, _type> should be considered
1988/// a YAML map.
1989#define LLVM_YAML_IS_STRING_MAP(_type)namespace llvm { namespace yaml { template <> struct CustomMappingTraits
<std::map<std::string, _type>> : public StdMapStringCustomMappingTraitsImpl
<_type> {}; } } \
1990 namespace llvm { \
1991 namespace yaml { \
1992 template <> \
1993 struct CustomMappingTraits<std::map<std::string, _type>> \
1994 : public StdMapStringCustomMappingTraitsImpl<_type> {}; \
1995 } \
1996 }
1997
1998#endif // LLVM_SUPPORT_YAMLTRAITS_H