Bug Summary

File:lib/ObjectYAML/CodeViewYAMLSymbols.cpp
Warning:line 640, 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-eagerly-assume -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-7/lib/clang/7.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-7~svn325118/build-llvm/lib/ObjectYAML -I /build/llvm-toolchain-snapshot-7~svn325118/lib/ObjectYAML -I /build/llvm-toolchain-snapshot-7~svn325118/build-llvm/include -I /build/llvm-toolchain-snapshot-7~svn325118/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/7.3.0/../../../../include/c++/7.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/7.3.0/../../../../include/x86_64-linux-gnu/c++/7.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/7.3.0/../../../../include/x86_64-linux-gnu/c++/7.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/7.3.0/../../../../include/c++/7.3.0/backward -internal-isystem /usr/include/clang/7.0.0/include/ -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-7/lib/clang/7.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-7~svn325118/build-llvm/lib/ObjectYAML -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -fobjc-runtime=gcc -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-checker optin.performance.Padding -analyzer-output=html -analyzer-config stable-report-filename=true -o /tmp/scan-build-2018-02-14-150435-17243-1 -x c++ /build/llvm-toolchain-snapshot-7~svn325118/lib/ObjectYAML/CodeViewYAMLSymbols.cpp

/build/llvm-toolchain-snapshot-7~svn325118/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)
12
Assuming '__begin' is not equal to '__end'
81 io.enumCase(Value, E.Name.str().c_str(), E.Value);
13
Passing value via 1st parameter 'Val'
14
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
553} // end namespace detail
554} // end namespace CodeViewYAML
555} // end namespace llvm
556
557CVSymbol CodeViewYAML::SymbolRecord::toCodeViewSymbol(
558 BumpPtrAllocator &Allocator, CodeViewContainer Container) const {
559 return Symbol->toCodeViewSymbol(Allocator, Container);
560}
561
562namespace llvm {
563namespace yaml {
564
565template <> struct MappingTraits<SymbolRecordBase> {
566 static void mapping(IO &io, SymbolRecordBase &Record) { Record.map(io); }
567};
568
569} // end namespace yaml
570} // end namespace llvm
571
572template <typename SymbolType>
573static inline Expected<CodeViewYAML::SymbolRecord>
574fromCodeViewSymbolImpl(CVSymbol Symbol) {
575 CodeViewYAML::SymbolRecord Result;
576
577 auto Impl = std::make_shared<SymbolType>(Symbol.kind());
578 if (auto EC = Impl->fromCodeViewSymbol(Symbol))
579 return std::move(EC);
580 Result.Symbol = Impl;
581 return Result;
582}
583
584Expected<CodeViewYAML::SymbolRecord>
585CodeViewYAML::SymbolRecord::fromCodeViewSymbol(CVSymbol Symbol) {
586#define SYMBOL_RECORD(EnumName, EnumVal, ClassName) \
587 case EnumName: \
588 return fromCodeViewSymbolImpl<SymbolRecordImpl<ClassName>>(Symbol);
589#define SYMBOL_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName) \
590 SYMBOL_RECORD(EnumName, EnumVal, ClassName)
591 switch (Symbol.kind()) {
592#include "llvm/DebugInfo/CodeView/CodeViewSymbols.def"
593 default:
594 return fromCodeViewSymbolImpl<UnknownSymbolRecord>(Symbol);
595 }
596 return make_error<CodeViewError>(cv_error_code::corrupt_record);
597}
598
599template <typename ConcreteType>
600static void mapSymbolRecordImpl(IO &IO, const char *Class, SymbolKind Kind,
601 CodeViewYAML::SymbolRecord &Obj) {
602 if (!IO.outputting())
603 Obj.Symbol = std::make_shared<ConcreteType>(Kind);
604
605 IO.mapRequired(Class, *Obj.Symbol);
606}
607
608void MappingTraits<CodeViewYAML::SymbolRecord>::mapping(
609 IO &IO, CodeViewYAML::SymbolRecord &Obj) {
610 SymbolKind Kind;
1
'Kind' declared without an initial value
611 if (IO.outputting())
2
Assuming the condition is false
3
Taking false branch
612 Kind = Obj.Symbol->Kind;
613 IO.mapRequired("Kind", Kind);
4
Calling 'IO::mapRequired'
614
615#define SYMBOL_RECORD(EnumName, EnumVal, ClassName) \
616 case EnumName: \
617 mapSymbolRecordImpl<SymbolRecordImpl<ClassName>>(IO, #ClassName, Kind, \
618 Obj); \
619 break;
620#define SYMBOL_RECORD_ALIAS(EnumName, EnumVal, AliasName, ClassName) \
621 SYMBOL_RECORD(EnumName, EnumVal, ClassName)
622 switch (Kind) {
623#include "llvm/DebugInfo/CodeView/CodeViewSymbols.def"
624 default:
625 mapSymbolRecordImpl<UnknownSymbolRecord>(IO, "UnknownSym", Kind, Obj);
626 }
627}

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