Bug Summary

File:include/llvm/Support/YAMLTraits.h
Warning:line 691, 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 -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~svn345461/build-llvm/lib/ObjectYAML -I /build/llvm-toolchain-snapshot-8~svn345461/lib/ObjectYAML -I /build/llvm-toolchain-snapshot-8~svn345461/build-llvm/include -I /build/llvm-toolchain-snapshot-8~svn345461/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~svn345461/build-llvm/lib/ObjectYAML -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -fobjc-runtime=gcc -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -o /tmp/scan-build-2018-10-27-211344-32123-1 -x c++ /build/llvm-toolchain-snapshot-8~svn345461/lib/ObjectYAML/CodeViewYAMLSymbols.cpp -faddrsig

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