1 //===- llvm/Support/YAMLTraits.h --------------------------------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 #ifndef LLVM_SUPPORT_YAMLTRAITS_H
10 #define LLVM_SUPPORT_YAMLTRAITS_H
12 #include "llvm/ADT/BitVector.h"
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/SMLoc.h"
23 #include "llvm/Support/SourceMgr.h"
24 #include "llvm/Support/YAMLParser.h"
25 #include "llvm/Support/raw_ostream.h"
31 #include <system_error>
32 #include <type_traits>
41 enum class NodeKind : uint8_t {
47 struct EmptyContext {};
49 /// This class should be specialized by any type that needs to be converted
50 /// to/from a YAML mapping. For example:
52 /// struct MappingTraits<MyStruct> {
53 /// static void mapping(IO &io, MyStruct &s) {
54 /// io.mapRequired("name", s.name);
55 /// io.mapRequired("size", s.size);
56 /// io.mapOptional("age", s.age);
60 struct MappingTraits {
62 // static void mapping(IO &io, T &fields);
63 // Optionally may provide:
64 // static std::string validate(IO &io, T &fields);
65 // static void enumInput(IO &io, T &value);
67 // The optional flow flag will cause generated YAML to use a flow mapping
68 // (e.g. { a: 0, b: 1 }):
69 // static const bool flow = true;
72 /// This class is similar to MappingTraits<T> but allows you to pass in
73 /// additional context for each map operation. For example:
75 /// struct MappingContextTraits<MyStruct, MyContext> {
76 /// static void mapping(IO &io, MyStruct &s, MyContext &c) {
77 /// io.mapRequired("name", s.name);
78 /// io.mapRequired("size", s.size);
79 /// io.mapOptional("age", s.age);
83 template <class T, class Context> struct MappingContextTraits {
85 // static void mapping(IO &io, T &fields, Context &Ctx);
86 // Optionally may provide:
87 // static std::string validate(IO &io, T &fields, Context &Ctx);
89 // The optional flow flag will cause generated YAML to use a flow mapping
90 // (e.g. { a: 0, b: 1 }):
91 // static const bool flow = true;
94 /// This class should be specialized by any integral type that converts
95 /// to/from a YAML scalar where there is a one-to-one mapping between
96 /// in-memory values and a string in YAML. For example:
98 /// struct ScalarEnumerationTraits<Colors> {
99 /// static void enumeration(IO &io, Colors &value) {
100 /// io.enumCase(value, "red", cRed);
101 /// io.enumCase(value, "blue", cBlue);
102 /// io.enumCase(value, "green", cGreen);
105 template <typename T, typename Enable = void> struct ScalarEnumerationTraits {
107 // static void enumeration(IO &io, T &value);
110 /// This class should be specialized by any integer type that is a union
111 /// of bit values and the YAML representation is a flow sequence of
112 /// strings. For example:
114 /// struct ScalarBitSetTraits<MyFlags> {
115 /// static void bitset(IO &io, MyFlags &value) {
116 /// io.bitSetCase(value, "big", flagBig);
117 /// io.bitSetCase(value, "flat", flagFlat);
118 /// io.bitSetCase(value, "round", flagRound);
121 template <typename T, typename Enable = void> struct ScalarBitSetTraits {
123 // static void bitset(IO &io, T &value);
126 /// Describe which type of quotes should be used when quoting is necessary.
127 /// Some non-printable characters need to be double-quoted, while some others
128 /// are fine with simple-quoting, and some don't need any quoting.
129 enum class QuotingType { None, Single, Double };
131 /// This class should be specialized by type that requires custom conversion
132 /// to/from a yaml scalar. For example:
135 /// struct ScalarTraits<MyType> {
136 /// static void output(const MyType &val, void*, llvm::raw_ostream &out) {
137 /// // stream out custom formatting
138 /// out << llvm::format("%x", val);
140 /// static StringRef input(StringRef scalar, void*, MyType &value) {
141 /// // parse scalar and set `value`
142 /// // return empty string on success, or error string
143 /// return StringRef();
145 /// static QuotingType mustQuote(StringRef) { return QuotingType::Single; }
147 template <typename T, typename Enable = void> struct ScalarTraits {
150 // Function to write the value as a string:
151 // static void output(const T &value, void *ctxt, llvm::raw_ostream &out);
153 // Function to convert a string to a value. Returns the empty
154 // StringRef on success or an error string if string is malformed:
155 // static StringRef input(StringRef scalar, void *ctxt, T &value);
157 // Function to determine if the value should be quoted.
158 // static QuotingType mustQuote(StringRef);
161 /// This class should be specialized by type that requires custom conversion
162 /// to/from a YAML literal block scalar. For example:
165 /// struct BlockScalarTraits<MyType> {
166 /// static void output(const MyType &Value, void*, llvm::raw_ostream &Out)
168 /// // stream out custom formatting
171 /// static StringRef input(StringRef Scalar, void*, MyType &Value) {
172 /// // parse scalar and set `value`
173 /// // return empty string on success, or error string
174 /// return StringRef();
177 template <typename T>
178 struct BlockScalarTraits {
181 // Function to write the value as a string:
182 // static void output(const T &Value, void *ctx, llvm::raw_ostream &Out);
184 // Function to convert a string to a value. Returns the empty
185 // StringRef on success or an error string if string is malformed:
186 // static StringRef input(StringRef Scalar, void *ctxt, T &Value);
189 // static StringRef inputTag(T &Val, std::string Tag)
190 // static void outputTag(const T &Val, raw_ostream &Out)
193 /// This class should be specialized by type that requires custom conversion
194 /// to/from a YAML scalar with optional tags. For example:
197 /// struct TaggedScalarTraits<MyType> {
198 /// static void output(const MyType &Value, void*, llvm::raw_ostream
199 /// &ScalarOut, llvm::raw_ostream &TagOut)
201 /// // stream out custom formatting including optional Tag
204 /// static StringRef input(StringRef Scalar, StringRef Tag, void*, MyType
206 /// // parse scalar and set `value`
207 /// // return empty string on success, or error string
208 /// return StringRef();
210 /// static QuotingType mustQuote(const MyType &Value, StringRef) {
211 /// return QuotingType::Single;
214 template <typename T> struct TaggedScalarTraits {
217 // Function to write the value and tag as strings:
218 // static void output(const T &Value, void *ctx, llvm::raw_ostream &ScalarOut,
219 // llvm::raw_ostream &TagOut);
221 // Function to convert a string to a value. Returns the empty
222 // StringRef on success or an error string if string is malformed:
223 // static StringRef input(StringRef Scalar, StringRef Tag, void *ctxt, T
226 // Function to determine if the value should be quoted.
227 // static QuotingType mustQuote(const T &Value, StringRef Scalar);
230 /// This class should be specialized by any type that needs to be converted
231 /// to/from a YAML sequence. For example:
234 /// struct SequenceTraits<MyContainer> {
235 /// static size_t size(IO &io, MyContainer &seq) {
236 /// return seq.size();
238 /// static MyType& element(IO &, MyContainer &seq, size_t index) {
239 /// if ( index >= seq.size() )
240 /// seq.resize(index+1);
241 /// return seq[index];
244 template<typename T, typename EnableIf = void>
245 struct SequenceTraits {
247 // static size_t size(IO &io, T &seq);
248 // static T::value_type& element(IO &io, T &seq, size_t index);
250 // The following is option and will cause generated YAML to use
251 // a flow sequence (e.g. [a,b,c]).
252 // static const bool flow = true;
255 /// This class should be specialized by any type for which vectors of that
256 /// type need to be converted to/from a YAML sequence.
257 template<typename T, typename EnableIf = void>
258 struct SequenceElementTraits {
260 // static const bool flow;
263 /// This class should be specialized by any type that needs to be converted
264 /// to/from a list of YAML documents.
266 struct DocumentListTraits {
268 // static size_t size(IO &io, T &seq);
269 // static T::value_type& element(IO &io, T &seq, size_t index);
272 /// This class should be specialized by any type that needs to be converted
273 /// to/from a YAML mapping in the case where the names of the keys are not known
274 /// in advance, e.g. a string map.
275 template <typename T>
276 struct CustomMappingTraits {
277 // static void inputOne(IO &io, StringRef key, T &elem);
278 // static void output(IO &io, T &elem);
281 /// This class should be specialized by any type that can be represented as
282 /// a scalar, map, or sequence, decided dynamically. For example:
284 /// typedef std::unique_ptr<MyBase> MyPoly;
287 /// struct PolymorphicTraits<MyPoly> {
288 /// static NodeKind getKind(const MyPoly &poly) {
289 /// return poly->getKind();
291 /// static MyScalar& getAsScalar(MyPoly &poly) {
292 /// if (!poly || !isa<MyScalar>(poly))
293 /// poly.reset(new MyScalar());
294 /// return *cast<MyScalar>(poly.get());
298 template <typename T> struct PolymorphicTraits {
300 // static NodeKind getKind(const T &poly);
301 // static scalar_type &getAsScalar(T &poly);
302 // static map_type &getAsMap(T &poly);
303 // static sequence_type &getAsSequence(T &poly);
306 // Only used for better diagnostics of missing traits
307 template <typename T>
310 // Test if ScalarEnumerationTraits<T> is defined on type T.
312 struct has_ScalarEnumerationTraits
314 using Signature_enumeration = void (*)(class IO&, T&);
316 template <typename U>
317 static char test(SameType<Signature_enumeration, &U::enumeration>*);
319 template <typename U>
320 static double test(...);
322 static bool const value =
323 (sizeof(test<ScalarEnumerationTraits<T>>(nullptr)) == 1);
326 // Test if ScalarBitSetTraits<T> is defined on type T.
328 struct has_ScalarBitSetTraits
330 using Signature_bitset = void (*)(class IO&, T&);
332 template <typename U>
333 static char test(SameType<Signature_bitset, &U::bitset>*);
335 template <typename U>
336 static double test(...);
338 static bool const value = (sizeof(test<ScalarBitSetTraits<T>>(nullptr)) == 1);
341 // Test if ScalarTraits<T> is defined on type T.
343 struct has_ScalarTraits
345 using Signature_input = StringRef (*)(StringRef, void*, T&);
346 using Signature_output = void (*)(const T&, void*, raw_ostream&);
347 using Signature_mustQuote = QuotingType (*)(StringRef);
349 template <typename U>
350 static char test(SameType<Signature_input, &U::input> *,
351 SameType<Signature_output, &U::output> *,
352 SameType<Signature_mustQuote, &U::mustQuote> *);
354 template <typename U>
355 static double test(...);
357 static bool const value =
358 (sizeof(test<ScalarTraits<T>>(nullptr, nullptr, nullptr)) == 1);
361 // Test if BlockScalarTraits<T> is defined on type T.
363 struct has_BlockScalarTraits
365 using Signature_input = StringRef (*)(StringRef, void *, T &);
366 using Signature_output = void (*)(const T &, void *, raw_ostream &);
368 template <typename U>
369 static char test(SameType<Signature_input, &U::input> *,
370 SameType<Signature_output, &U::output> *);
372 template <typename U>
373 static double test(...);
375 static bool const value =
376 (sizeof(test<BlockScalarTraits<T>>(nullptr, nullptr)) == 1);
379 // Test if TaggedScalarTraits<T> is defined on type T.
380 template <class T> struct has_TaggedScalarTraits {
381 using Signature_input = StringRef (*)(StringRef, StringRef, void *, T &);
382 using Signature_output = void (*)(const T &, void *, raw_ostream &,
384 using Signature_mustQuote = QuotingType (*)(const T &, StringRef);
386 template <typename U>
387 static char test(SameType<Signature_input, &U::input> *,
388 SameType<Signature_output, &U::output> *,
389 SameType<Signature_mustQuote, &U::mustQuote> *);
391 template <typename U> static double test(...);
393 static bool const value =
394 (sizeof(test<TaggedScalarTraits<T>>(nullptr, nullptr, nullptr)) == 1);
397 // Test if MappingContextTraits<T> is defined on type T.
398 template <class T, class Context> struct has_MappingTraits {
399 using Signature_mapping = void (*)(class IO &, T &, Context &);
401 template <typename U>
402 static char test(SameType<Signature_mapping, &U::mapping>*);
404 template <typename U>
405 static double test(...);
407 static bool const value =
408 (sizeof(test<MappingContextTraits<T, Context>>(nullptr)) == 1);
411 // Test if MappingTraits<T> is defined on type T.
412 template <class T> struct has_MappingTraits<T, EmptyContext> {
413 using Signature_mapping = void (*)(class IO &, T &);
415 template <typename U>
416 static char test(SameType<Signature_mapping, &U::mapping> *);
418 template <typename U> static double test(...);
420 static bool const value = (sizeof(test<MappingTraits<T>>(nullptr)) == 1);
423 // Test if MappingContextTraits<T>::validate() is defined on type T.
424 template <class T, class Context> struct has_MappingValidateTraits {
425 using Signature_validate = std::string (*)(class IO &, T &, Context &);
427 template <typename U>
428 static char test(SameType<Signature_validate, &U::validate>*);
430 template <typename U>
431 static double test(...);
433 static bool const value =
434 (sizeof(test<MappingContextTraits<T, Context>>(nullptr)) == 1);
437 // Test if MappingTraits<T>::validate() is defined on type T.
438 template <class T> struct has_MappingValidateTraits<T, EmptyContext> {
439 using Signature_validate = std::string (*)(class IO &, T &);
441 template <typename U>
442 static char test(SameType<Signature_validate, &U::validate> *);
444 template <typename U> static double test(...);
446 static bool const value = (sizeof(test<MappingTraits<T>>(nullptr)) == 1);
449 // Test if MappingContextTraits<T>::enumInput() is defined on type T.
450 template <class T, class Context> struct has_MappingEnumInputTraits {
451 using Signature_validate = void (*)(class IO &, T &);
453 template <typename U>
454 static char test(SameType<Signature_validate, &U::enumInput> *);
456 template <typename U> static double test(...);
458 static bool const value =
459 (sizeof(test<MappingContextTraits<T, Context>>(nullptr)) == 1);
462 // Test if MappingTraits<T>::enumInput() is defined on type T.
463 template <class T> struct has_MappingEnumInputTraits<T, EmptyContext> {
464 using Signature_validate = void (*)(class IO &, T &);
466 template <typename U>
467 static char test(SameType<Signature_validate, &U::enumInput> *);
469 template <typename U> static double test(...);
471 static bool const value = (sizeof(test<MappingTraits<T>>(nullptr)) == 1);
474 // Test if SequenceTraits<T> is defined on type T.
476 struct has_SequenceMethodTraits
478 using Signature_size = size_t (*)(class IO&, T&);
480 template <typename U>
481 static char test(SameType<Signature_size, &U::size>*);
483 template <typename U>
484 static double test(...);
486 static bool const value = (sizeof(test<SequenceTraits<T>>(nullptr)) == 1);
489 // Test if CustomMappingTraits<T> is defined on type T.
491 struct has_CustomMappingTraits
493 using Signature_input = void (*)(IO &io, StringRef key, T &v);
495 template <typename U>
496 static char test(SameType<Signature_input, &U::inputOne>*);
498 template <typename U>
499 static double test(...);
501 static bool const value =
502 (sizeof(test<CustomMappingTraits<T>>(nullptr)) == 1);
505 // has_FlowTraits<int> will cause an error with some compilers because
506 // it subclasses int. Using this wrapper only instantiates the
507 // real has_FlowTraits only if the template type is a class.
508 template <typename T, bool Enabled = std::is_class<T>::value>
512 static const bool value = false;
515 // Some older gcc compilers don't support straight forward tests
516 // for members, so test for ambiguity cause by the base and derived
517 // classes both defining the member.
519 struct has_FlowTraits<T, true>
521 struct Fallback { bool flow; };
522 struct Derived : T, Fallback { };
525 static char (&f(SameType<bool Fallback::*, &C::flow>*))[1];
528 static char (&f(...))[2];
530 static bool const value = sizeof(f<Derived>(nullptr)) == 2;
533 // Test if SequenceTraits<T> is defined on type T
535 struct has_SequenceTraits : public std::integral_constant<bool,
536 has_SequenceMethodTraits<T>::value > { };
538 // Test if DocumentListTraits<T> is defined on type T
540 struct has_DocumentListTraits
542 using Signature_size = size_t (*)(class IO &, T &);
544 template <typename U>
545 static char test(SameType<Signature_size, &U::size>*);
547 template <typename U>
548 static double test(...);
550 static bool const value = (sizeof(test<DocumentListTraits<T>>(nullptr))==1);
553 template <class T> struct has_PolymorphicTraits {
554 using Signature_getKind = NodeKind (*)(const T &);
556 template <typename U>
557 static char test(SameType<Signature_getKind, &U::getKind> *);
559 template <typename U> static double test(...);
561 static bool const value = (sizeof(test<PolymorphicTraits<T>>(nullptr)) == 1);
564 inline bool isNumeric(StringRef S) {
565 const auto skipDigits = [](StringRef Input) {
566 return Input.ltrim("0123456789");
569 // Make S.front() and S.drop_front().front() (if S.front() is [+-]) calls
571 if (S.empty() || S.equals("+") || S.equals("-"))
574 if (S.equals(".nan") || S.equals(".NaN") || S.equals(".NAN"))
577 // Infinity and decimal numbers can be prefixed with sign.
578 StringRef Tail = (S.front() == '-' || S.front() == '+') ? S.drop_front() : S;
580 // Check for infinity first, because checking for hex and oct numbers is more
582 if (Tail.equals(".inf") || Tail.equals(".Inf") || Tail.equals(".INF"))
585 // Section 10.3.2 Tag Resolution
586 // YAML 1.2 Specification prohibits Base 8 and Base 16 numbers prefixed with
587 // [-+], so S should be used instead of Tail.
588 if (S.startswith("0o"))
589 return S.size() > 2 &&
590 S.drop_front(2).find_first_not_of("01234567") == StringRef::npos;
592 if (S.startswith("0x"))
593 return S.size() > 2 && S.drop_front(2).find_first_not_of(
594 "0123456789abcdefABCDEF") == StringRef::npos;
596 // Parse float: [-+]? (\. [0-9]+ | [0-9]+ (\. [0-9]* )?) ([eE] [-+]? [0-9]+)?
599 // Handle cases when the number starts with '.' and hence needs at least one
600 // digit after dot (as opposed by number which has digits before the dot), but
602 if (S.startswith(".") &&
604 (S.size() > 1 && std::strchr("0123456789", S[1]) == nullptr)))
607 if (S.startswith("E") || S.startswith("e"))
615 ParseState State = Default;
619 // Accept decimal integer.
623 if (S.front() == '.') {
626 } else if (S.front() == 'e' || S.front() == 'E') {
627 State = FoundExponent;
633 if (State == FoundDot) {
638 if (S.front() == 'e' || S.front() == 'E') {
639 State = FoundExponent;
646 assert(State == FoundExponent && "Should have found exponent at this point.");
650 if (S.front() == '+' || S.front() == '-') {
656 return skipDigits(S).empty();
659 inline bool isNull(StringRef S) {
660 return S.equals("null") || S.equals("Null") || S.equals("NULL") ||
664 inline bool isBool(StringRef S) {
665 // FIXME: using parseBool is causing multiple tests to fail.
666 return S.equals("true") || S.equals("True") || S.equals("TRUE") ||
667 S.equals("false") || S.equals("False") || S.equals("FALSE");
670 // 5.1. Character Set
671 // The allowed character range explicitly excludes the C0 control block #x0-#x1F
672 // (except for TAB #x9, LF #xA, and CR #xD which are allowed), DEL #x7F, the C1
673 // control block #x80-#x9F (except for NEL #x85 which is allowed), the surrogate
674 // block #xD800-#xDFFF, #xFFFE, and #xFFFF.
675 inline QuotingType needsQuotes(StringRef S) {
677 return QuotingType::Single;
679 QuotingType MaxQuotingNeeded = QuotingType::None;
680 if (isSpace(static_cast<unsigned char>(S.front())) ||
681 isSpace(static_cast<unsigned char>(S.back())))
682 MaxQuotingNeeded = QuotingType::Single;
684 MaxQuotingNeeded = QuotingType::Single;
686 MaxQuotingNeeded = QuotingType::Single;
688 MaxQuotingNeeded = QuotingType::Single;
691 // Plain scalars must not begin with most indicators, as this would cause
692 // ambiguity with other YAML constructs.
693 if (std::strchr(R"(-?:\,[]{}#&*!|>'"%@`)", S[0]) != nullptr)
694 MaxQuotingNeeded = QuotingType::Single;
696 for (unsigned char C : S) {
702 // Safe scalar characters.
709 // TAB (0x9) is allowed in unquoted strings.
712 // LF(0xA) and CR(0xD) may delimit values and so require at least single
713 // quotes. LLVM YAML parser cannot handle single quoted multiline so use
714 // double quoting to produce valid YAML.
717 return QuotingType::Double;
718 // DEL (0x7F) are excluded from the allowed character range.
720 return QuotingType::Double;
721 // Forward slash is allowed to be unquoted, but we quote it anyway. We have
722 // many tests that use FileCheck against YAML output, and this output often
723 // contains paths. If we quote backslashes but not forward slashes then
724 // paths will come out either quoted or unquoted depending on which platform
725 // the test is run on, making FileCheck comparisons difficult.
728 // C0 control block (0x0 - 0x1F) is excluded from the allowed character
731 return QuotingType::Double;
733 // Always double quote UTF-8.
735 return QuotingType::Double;
737 // The character is not safe, at least simple quoting needed.
738 MaxQuotingNeeded = QuotingType::Single;
743 return MaxQuotingNeeded;
746 template <typename T, typename Context>
748 : public std::integral_constant<bool,
749 !has_ScalarEnumerationTraits<T>::value &&
750 !has_ScalarBitSetTraits<T>::value &&
751 !has_ScalarTraits<T>::value &&
752 !has_BlockScalarTraits<T>::value &&
753 !has_TaggedScalarTraits<T>::value &&
754 !has_MappingTraits<T, Context>::value &&
755 !has_SequenceTraits<T>::value &&
756 !has_CustomMappingTraits<T>::value &&
757 !has_DocumentListTraits<T>::value &&
758 !has_PolymorphicTraits<T>::value> {};
760 template <typename T, typename Context>
761 struct validatedMappingTraits
762 : public std::integral_constant<
763 bool, has_MappingTraits<T, Context>::value &&
764 has_MappingValidateTraits<T, Context>::value> {};
766 template <typename T, typename Context>
767 struct unvalidatedMappingTraits
768 : public std::integral_constant<
769 bool, has_MappingTraits<T, Context>::value &&
770 !has_MappingValidateTraits<T, Context>::value> {};
772 // Base class for Input and Output.
775 IO(void *Ctxt = nullptr);
778 virtual bool outputting() const = 0;
780 virtual unsigned beginSequence() = 0;
781 virtual bool preflightElement(unsigned, void *&) = 0;
782 virtual void postflightElement(void*) = 0;
783 virtual void endSequence() = 0;
784 virtual bool canElideEmptySequence() = 0;
786 virtual unsigned beginFlowSequence() = 0;
787 virtual bool preflightFlowElement(unsigned, void *&) = 0;
788 virtual void postflightFlowElement(void*) = 0;
789 virtual void endFlowSequence() = 0;
791 virtual bool mapTag(StringRef Tag, bool Default=false) = 0;
792 virtual void beginMapping() = 0;
793 virtual void endMapping() = 0;
794 virtual bool preflightKey(const char*, bool, bool, bool &, void *&) = 0;
795 virtual void postflightKey(void*) = 0;
796 virtual std::vector<StringRef> keys() = 0;
798 virtual void beginFlowMapping() = 0;
799 virtual void endFlowMapping() = 0;
801 virtual void beginEnumScalar() = 0;
802 virtual bool matchEnumScalar(const char*, bool) = 0;
803 virtual bool matchEnumFallback() = 0;
804 virtual void endEnumScalar() = 0;
806 virtual bool beginBitSetScalar(bool &) = 0;
807 virtual bool bitSetMatch(const char*, bool) = 0;
808 virtual void endBitSetScalar() = 0;
810 virtual void scalarString(StringRef &, QuotingType) = 0;
811 virtual void blockScalarString(StringRef &) = 0;
812 virtual void scalarTag(std::string &) = 0;
814 virtual NodeKind getNodeKind() = 0;
816 virtual void setError(const Twine &) = 0;
817 virtual void setAllowUnknownKeys(bool Allow);
819 template <typename T>
820 void enumCase(T &Val, const char* Str, const T ConstVal) {
821 if ( matchEnumScalar(Str, outputting() && Val == ConstVal) ) {
826 // allow anonymous enum values to be used with LLVM_YAML_STRONG_TYPEDEF
827 template <typename T>
828 void enumCase(T &Val, const char* Str, const uint32_t ConstVal) {
829 if ( matchEnumScalar(Str, outputting() && Val == static_cast<T>(ConstVal)) ) {
834 template <typename FBT, typename T>
835 void enumFallback(T &Val) {
836 if (matchEnumFallback()) {
837 EmptyContext Context;
838 // FIXME: Force integral conversion to allow strong typedefs to convert.
839 FBT Res = static_cast<typename FBT::BaseType>(Val);
840 yamlize(*this, Res, true, Context);
841 Val = static_cast<T>(static_cast<typename FBT::BaseType>(Res));
845 template <typename T>
846 void bitSetCase(T &Val, const char* Str, const T ConstVal) {
847 if ( bitSetMatch(Str, outputting() && (Val & ConstVal) == ConstVal) ) {
848 Val = static_cast<T>(Val | ConstVal);
852 // allow anonymous enum values to be used with LLVM_YAML_STRONG_TYPEDEF
853 template <typename T>
854 void bitSetCase(T &Val, const char* Str, const uint32_t ConstVal) {
855 if ( bitSetMatch(Str, outputting() && (Val & ConstVal) == ConstVal) ) {
856 Val = static_cast<T>(Val | ConstVal);
860 template <typename T>
861 void maskedBitSetCase(T &Val, const char *Str, T ConstVal, T Mask) {
862 if (bitSetMatch(Str, outputting() && (Val & Mask) == ConstVal))
863 Val = Val | ConstVal;
866 template <typename T>
867 void maskedBitSetCase(T &Val, const char *Str, uint32_t ConstVal,
869 if (bitSetMatch(Str, outputting() && (Val & Mask) == ConstVal))
870 Val = Val | ConstVal;
873 void *getContext() const;
874 void setContext(void *);
876 template <typename T> void mapRequired(const char *Key, T &Val) {
878 this->processKey(Key, Val, true, Ctx);
881 template <typename T, typename Context>
882 void mapRequired(const char *Key, T &Val, Context &Ctx) {
883 this->processKey(Key, Val, true, Ctx);
886 template <typename T> void mapOptional(const char *Key, T &Val) {
888 mapOptionalWithContext(Key, Val, Ctx);
891 template <typename T, typename DefaultT>
892 void mapOptional(const char *Key, T &Val, const DefaultT &Default) {
894 mapOptionalWithContext(Key, Val, Default, Ctx);
897 template <typename T, typename Context>
898 std::enable_if_t<has_SequenceTraits<T>::value, void>
899 mapOptionalWithContext(const char *Key, T &Val, Context &Ctx) {
900 // omit key/value instead of outputting empty sequence
901 if (this->canElideEmptySequence() && !(Val.begin() != Val.end()))
903 this->processKey(Key, Val, false, Ctx);
906 template <typename T, typename Context>
907 void mapOptionalWithContext(const char *Key, Optional<T> &Val, Context &Ctx) {
908 this->processKeyWithDefault(Key, Val, Optional<T>(), /*Required=*/false,
912 template <typename T, typename Context>
913 std::enable_if_t<!has_SequenceTraits<T>::value, void>
914 mapOptionalWithContext(const char *Key, T &Val, Context &Ctx) {
915 this->processKey(Key, Val, false, Ctx);
918 template <typename T, typename Context, typename DefaultT>
919 void mapOptionalWithContext(const char *Key, T &Val, const DefaultT &Default,
921 static_assert(std::is_convertible<DefaultT, T>::value,
922 "Default type must be implicitly convertible to value type!");
923 this->processKeyWithDefault(Key, Val, static_cast<const T &>(Default),
928 template <typename T, typename Context>
929 void processKeyWithDefault(const char *Key, Optional<T> &Val,
930 const Optional<T> &DefaultValue, bool Required,
933 template <typename T, typename Context>
934 void processKeyWithDefault(const char *Key, T &Val, const T &DefaultValue,
935 bool Required, Context &Ctx) {
938 const bool sameAsDefault = outputting() && Val == DefaultValue;
939 if ( this->preflightKey(Key, Required, sameAsDefault, UseDefault,
941 yamlize(*this, Val, Required, Ctx);
942 this->postflightKey(SaveInfo);
950 template <typename T, typename Context>
951 void processKey(const char *Key, T &Val, bool Required, Context &Ctx) {
954 if ( this->preflightKey(Key, Required, false, UseDefault, SaveInfo) ) {
955 yamlize(*this, Val, Required, Ctx);
956 this->postflightKey(SaveInfo);
966 template <typename T, typename Context>
967 void doMapping(IO &io, T &Val, Context &Ctx) {
968 MappingContextTraits<T, Context>::mapping(io, Val, Ctx);
971 template <typename T> void doMapping(IO &io, T &Val, EmptyContext &Ctx) {
972 MappingTraits<T>::mapping(io, Val);
975 } // end namespace detail
977 template <typename T>
978 std::enable_if_t<has_ScalarEnumerationTraits<T>::value, void>
979 yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
980 io.beginEnumScalar();
981 ScalarEnumerationTraits<T>::enumeration(io, Val);
985 template <typename T>
986 std::enable_if_t<has_ScalarBitSetTraits<T>::value, void>
987 yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
989 if ( io.beginBitSetScalar(DoClear) ) {
992 ScalarBitSetTraits<T>::bitset(io, Val);
993 io.endBitSetScalar();
997 template <typename T>
998 std::enable_if_t<has_ScalarTraits<T>::value, void> yamlize(IO &io, T &Val, bool,
1000 if ( io.outputting() ) {
1001 std::string Storage;
1002 raw_string_ostream Buffer(Storage);
1003 ScalarTraits<T>::output(Val, io.getContext(), Buffer);
1004 StringRef Str = Buffer.str();
1005 io.scalarString(Str, ScalarTraits<T>::mustQuote(Str));
1009 io.scalarString(Str, ScalarTraits<T>::mustQuote(Str));
1010 StringRef Result = ScalarTraits<T>::input(Str, io.getContext(), Val);
1011 if ( !Result.empty() ) {
1012 io.setError(Twine(Result));
1017 template <typename T>
1018 std::enable_if_t<has_BlockScalarTraits<T>::value, void>
1019 yamlize(IO &YamlIO, T &Val, bool, EmptyContext &Ctx) {
1020 if (YamlIO.outputting()) {
1021 std::string Storage;
1022 raw_string_ostream Buffer(Storage);
1023 BlockScalarTraits<T>::output(Val, YamlIO.getContext(), Buffer);
1024 StringRef Str = Buffer.str();
1025 YamlIO.blockScalarString(Str);
1028 YamlIO.blockScalarString(Str);
1030 BlockScalarTraits<T>::input(Str, YamlIO.getContext(), Val);
1031 if (!Result.empty())
1032 YamlIO.setError(Twine(Result));
1036 template <typename T>
1037 std::enable_if_t<has_TaggedScalarTraits<T>::value, void>
1038 yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
1039 if (io.outputting()) {
1040 std::string ScalarStorage, TagStorage;
1041 raw_string_ostream ScalarBuffer(ScalarStorage), TagBuffer(TagStorage);
1042 TaggedScalarTraits<T>::output(Val, io.getContext(), ScalarBuffer,
1044 io.scalarTag(TagBuffer.str());
1045 StringRef ScalarStr = ScalarBuffer.str();
1046 io.scalarString(ScalarStr,
1047 TaggedScalarTraits<T>::mustQuote(Val, ScalarStr));
1052 io.scalarString(Str, QuotingType::None);
1054 TaggedScalarTraits<T>::input(Str, Tag, io.getContext(), Val);
1055 if (!Result.empty()) {
1056 io.setError(Twine(Result));
1061 template <typename T, typename Context>
1062 std::enable_if_t<validatedMappingTraits<T, Context>::value, void>
1063 yamlize(IO &io, T &Val, bool, Context &Ctx) {
1064 if (has_FlowTraits<MappingTraits<T>>::value)
1065 io.beginFlowMapping();
1068 if (io.outputting()) {
1069 std::string Err = MappingTraits<T>::validate(io, Val);
1071 errs() << Err << "\n";
1072 assert(Err.empty() && "invalid struct trying to be written as yaml");
1075 detail::doMapping(io, Val, Ctx);
1076 if (!io.outputting()) {
1077 std::string Err = MappingTraits<T>::validate(io, Val);
1081 if (has_FlowTraits<MappingTraits<T>>::value)
1082 io.endFlowMapping();
1087 template <typename T, typename Context>
1088 std::enable_if_t<!has_MappingEnumInputTraits<T, Context>::value, bool>
1089 yamlizeMappingEnumInput(IO &io, T &Val) {
1093 template <typename T, typename Context>
1094 std::enable_if_t<has_MappingEnumInputTraits<T, Context>::value, bool>
1095 yamlizeMappingEnumInput(IO &io, T &Val) {
1096 if (io.outputting())
1099 io.beginEnumScalar();
1100 MappingTraits<T>::enumInput(io, Val);
1101 bool Matched = !io.matchEnumFallback();
1106 template <typename T, typename Context>
1107 std::enable_if_t<unvalidatedMappingTraits<T, Context>::value, void>
1108 yamlize(IO &io, T &Val, bool, Context &Ctx) {
1109 if (yamlizeMappingEnumInput<T, Context>(io, Val))
1111 if (has_FlowTraits<MappingTraits<T>>::value) {
1112 io.beginFlowMapping();
1113 detail::doMapping(io, Val, Ctx);
1114 io.endFlowMapping();
1117 detail::doMapping(io, Val, Ctx);
1122 template <typename T>
1123 std::enable_if_t<has_CustomMappingTraits<T>::value, void>
1124 yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
1125 if ( io.outputting() ) {
1127 CustomMappingTraits<T>::output(io, Val);
1131 for (StringRef key : io.keys())
1132 CustomMappingTraits<T>::inputOne(io, key, Val);
1137 template <typename T>
1138 std::enable_if_t<has_PolymorphicTraits<T>::value, void>
1139 yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
1140 switch (io.outputting() ? PolymorphicTraits<T>::getKind(Val)
1141 : io.getNodeKind()) {
1142 case NodeKind::Scalar:
1143 return yamlize(io, PolymorphicTraits<T>::getAsScalar(Val), true, Ctx);
1145 return yamlize(io, PolymorphicTraits<T>::getAsMap(Val), true, Ctx);
1146 case NodeKind::Sequence:
1147 return yamlize(io, PolymorphicTraits<T>::getAsSequence(Val), true, Ctx);
1151 template <typename T>
1152 std::enable_if_t<missingTraits<T, EmptyContext>::value, void>
1153 yamlize(IO &io, T &Val, bool, EmptyContext &Ctx) {
1154 char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
1157 template <typename T, typename Context>
1158 std::enable_if_t<has_SequenceTraits<T>::value, void>
1159 yamlize(IO &io, T &Seq, bool, Context &Ctx) {
1160 if ( has_FlowTraits< SequenceTraits<T>>::value ) {
1161 unsigned incnt = io.beginFlowSequence();
1162 unsigned count = io.outputting() ? SequenceTraits<T>::size(io, Seq) : incnt;
1163 for(unsigned i=0; i < count; ++i) {
1165 if ( io.preflightFlowElement(i, SaveInfo) ) {
1166 yamlize(io, SequenceTraits<T>::element(io, Seq, i), true, Ctx);
1167 io.postflightFlowElement(SaveInfo);
1170 io.endFlowSequence();
1173 unsigned incnt = io.beginSequence();
1174 unsigned count = io.outputting() ? SequenceTraits<T>::size(io, Seq) : incnt;
1175 for(unsigned i=0; i < count; ++i) {
1177 if ( io.preflightElement(i, SaveInfo) ) {
1178 yamlize(io, SequenceTraits<T>::element(io, Seq, i), true, Ctx);
1179 io.postflightElement(SaveInfo);
1187 struct ScalarTraits<bool> {
1188 static void output(const bool &, void* , raw_ostream &);
1189 static StringRef input(StringRef, void *, bool &);
1190 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1194 struct ScalarTraits<StringRef> {
1195 static void output(const StringRef &, void *, raw_ostream &);
1196 static StringRef input(StringRef, void *, StringRef &);
1197 static QuotingType mustQuote(StringRef S) { return needsQuotes(S); }
1201 struct ScalarTraits<std::string> {
1202 static void output(const std::string &, void *, raw_ostream &);
1203 static StringRef input(StringRef, void *, std::string &);
1204 static QuotingType mustQuote(StringRef S) { return needsQuotes(S); }
1208 struct ScalarTraits<uint8_t> {
1209 static void output(const uint8_t &, void *, raw_ostream &);
1210 static StringRef input(StringRef, void *, uint8_t &);
1211 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1215 struct ScalarTraits<uint16_t> {
1216 static void output(const uint16_t &, void *, raw_ostream &);
1217 static StringRef input(StringRef, void *, uint16_t &);
1218 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1222 struct ScalarTraits<uint32_t> {
1223 static void output(const uint32_t &, void *, raw_ostream &);
1224 static StringRef input(StringRef, void *, uint32_t &);
1225 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1229 struct ScalarTraits<uint64_t> {
1230 static void output(const uint64_t &, void *, raw_ostream &);
1231 static StringRef input(StringRef, void *, uint64_t &);
1232 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1236 struct ScalarTraits<int8_t> {
1237 static void output(const int8_t &, void *, raw_ostream &);
1238 static StringRef input(StringRef, void *, int8_t &);
1239 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1243 struct ScalarTraits<int16_t> {
1244 static void output(const int16_t &, void *, raw_ostream &);
1245 static StringRef input(StringRef, void *, int16_t &);
1246 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1250 struct ScalarTraits<int32_t> {
1251 static void output(const int32_t &, void *, raw_ostream &);
1252 static StringRef input(StringRef, void *, int32_t &);
1253 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1257 struct ScalarTraits<int64_t> {
1258 static void output(const int64_t &, void *, raw_ostream &);
1259 static StringRef input(StringRef, void *, int64_t &);
1260 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1264 struct ScalarTraits<float> {
1265 static void output(const float &, void *, raw_ostream &);
1266 static StringRef input(StringRef, void *, float &);
1267 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1271 struct ScalarTraits<double> {
1272 static void output(const double &, void *, raw_ostream &);
1273 static StringRef input(StringRef, void *, double &);
1274 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1277 // For endian types, we use existing scalar Traits class for the underlying
1278 // type. This way endian aware types are supported whenever the traits are
1279 // defined for the underlying type.
1280 template <typename value_type, support::endianness endian, size_t alignment>
1281 struct ScalarTraits<support::detail::packed_endian_specific_integral<
1282 value_type, endian, alignment>,
1283 std::enable_if_t<has_ScalarTraits<value_type>::value>> {
1285 support::detail::packed_endian_specific_integral<value_type, endian,
1288 static void output(const endian_type &E, void *Ctx, raw_ostream &Stream) {
1289 ScalarTraits<value_type>::output(static_cast<value_type>(E), Ctx, Stream);
1292 static StringRef input(StringRef Str, void *Ctx, endian_type &E) {
1294 auto R = ScalarTraits<value_type>::input(Str, Ctx, V);
1295 E = static_cast<endian_type>(V);
1299 static QuotingType mustQuote(StringRef Str) {
1300 return ScalarTraits<value_type>::mustQuote(Str);
1304 template <typename value_type, support::endianness endian, size_t alignment>
1305 struct ScalarEnumerationTraits<
1306 support::detail::packed_endian_specific_integral<value_type, endian,
1308 std::enable_if_t<has_ScalarEnumerationTraits<value_type>::value>> {
1310 support::detail::packed_endian_specific_integral<value_type, endian,
1313 static void enumeration(IO &io, endian_type &E) {
1315 ScalarEnumerationTraits<value_type>::enumeration(io, V);
1320 template <typename value_type, support::endianness endian, size_t alignment>
1321 struct ScalarBitSetTraits<
1322 support::detail::packed_endian_specific_integral<value_type, endian,
1324 std::enable_if_t<has_ScalarBitSetTraits<value_type>::value>> {
1326 support::detail::packed_endian_specific_integral<value_type, endian,
1328 static void bitset(IO &io, endian_type &E) {
1330 ScalarBitSetTraits<value_type>::bitset(io, V);
1335 // Utility for use within MappingTraits<>::mapping() method
1336 // to [de]normalize an object for use with YAML conversion.
1337 template <typename TNorm, typename TFinal>
1338 struct MappingNormalization {
1339 MappingNormalization(IO &i_o, TFinal &Obj)
1340 : io(i_o), BufPtr(nullptr), Result(Obj) {
1341 if ( io.outputting() ) {
1342 BufPtr = new (&Buffer) TNorm(io, Obj);
1345 BufPtr = new (&Buffer) TNorm(io);
1349 ~MappingNormalization() {
1350 if ( ! io.outputting() ) {
1351 Result = BufPtr->denormalize(io);
1356 TNorm* operator->() { return BufPtr; }
1359 using Storage = AlignedCharArrayUnion<TNorm>;
1367 // Utility for use within MappingTraits<>::mapping() method
1368 // to [de]normalize an object for use with YAML conversion.
1369 template <typename TNorm, typename TFinal>
1370 struct MappingNormalizationHeap {
1371 MappingNormalizationHeap(IO &i_o, TFinal &Obj, BumpPtrAllocator *allocator)
1372 : io(i_o), Result(Obj) {
1373 if ( io.outputting() ) {
1374 BufPtr = new (&Buffer) TNorm(io, Obj);
1376 else if (allocator) {
1377 BufPtr = allocator->Allocate<TNorm>();
1378 new (BufPtr) TNorm(io);
1380 BufPtr = new TNorm(io);
1384 ~MappingNormalizationHeap() {
1385 if ( io.outputting() ) {
1389 Result = BufPtr->denormalize(io);
1393 TNorm* operator->() { return BufPtr; }
1396 using Storage = AlignedCharArrayUnion<TNorm>;
1400 TNorm *BufPtr = nullptr;
1405 /// The Input class is used to parse a yaml document into in-memory structs
1408 /// It works by using YAMLParser to do a syntax parse of the entire yaml
1409 /// document, then the Input class builds a graph of HNodes which wraps
1410 /// each yaml Node. The extra layer is buffering. The low level yaml
1411 /// parser only lets you look at each node once. The buffering layer lets
1412 /// you search and interate multiple times. This is necessary because
1413 /// the mapRequired() method calls may not be in the same order
1414 /// as the keys in the document.
1416 class Input : public IO {
1418 // Construct a yaml Input object from a StringRef and optional
1419 // user-data. The DiagHandler can be specified to provide
1420 // alternative error reporting.
1421 Input(StringRef InputContent,
1422 void *Ctxt = nullptr,
1423 SourceMgr::DiagHandlerTy DiagHandler = nullptr,
1424 void *DiagHandlerCtxt = nullptr);
1425 Input(MemoryBufferRef Input,
1426 void *Ctxt = nullptr,
1427 SourceMgr::DiagHandlerTy DiagHandler = nullptr,
1428 void *DiagHandlerCtxt = nullptr);
1431 // Check if there was an syntax or semantic error during parsing.
1432 std::error_code error();
1435 bool outputting() const override;
1436 bool mapTag(StringRef, bool) override;
1437 void beginMapping() override;
1438 void endMapping() override;
1439 bool preflightKey(const char *, bool, bool, bool &, void *&) override;
1440 void postflightKey(void *) override;
1441 std::vector<StringRef> keys() override;
1442 void beginFlowMapping() override;
1443 void endFlowMapping() override;
1444 unsigned beginSequence() override;
1445 void endSequence() override;
1446 bool preflightElement(unsigned index, void *&) override;
1447 void postflightElement(void *) override;
1448 unsigned beginFlowSequence() override;
1449 bool preflightFlowElement(unsigned , void *&) override;
1450 void postflightFlowElement(void *) override;
1451 void endFlowSequence() override;
1452 void beginEnumScalar() override;
1453 bool matchEnumScalar(const char*, bool) override;
1454 bool matchEnumFallback() override;
1455 void endEnumScalar() override;
1456 bool beginBitSetScalar(bool &) override;
1457 bool bitSetMatch(const char *, bool ) override;
1458 void endBitSetScalar() override;
1459 void scalarString(StringRef &, QuotingType) override;
1460 void blockScalarString(StringRef &) override;
1461 void scalarTag(std::string &) override;
1462 NodeKind getNodeKind() override;
1463 void setError(const Twine &message) override;
1464 bool canElideEmptySequence() override;
1467 virtual void anchor();
1470 HNode(Node *n) : _node(n) { }
1471 virtual ~HNode() = default;
1473 static bool classof(const HNode *) { return true; }
1478 class EmptyHNode : public HNode {
1479 void anchor() override;
1482 EmptyHNode(Node *n) : HNode(n) { }
1484 static bool classof(const HNode *n) { return NullNode::classof(n->_node); }
1486 static bool classof(const EmptyHNode *) { return true; }
1489 class ScalarHNode : public HNode {
1490 void anchor() override;
1493 ScalarHNode(Node *n, StringRef s) : HNode(n), _value(s) { }
1495 StringRef value() const { return _value; }
1497 static bool classof(const HNode *n) {
1498 return ScalarNode::classof(n->_node) ||
1499 BlockScalarNode::classof(n->_node);
1502 static bool classof(const ScalarHNode *) { return true; }
1508 class MapHNode : public HNode {
1509 void anchor() override;
1512 MapHNode(Node *n) : HNode(n) { }
1514 static bool classof(const HNode *n) {
1515 return MappingNode::classof(n->_node);
1518 static bool classof(const MapHNode *) { return true; }
1520 using NameToNodeAndLoc =
1521 StringMap<std::pair<std::unique_ptr<HNode>, SMRange>>;
1523 NameToNodeAndLoc Mapping;
1524 SmallVector<std::string, 6> ValidKeys;
1527 class SequenceHNode : public HNode {
1528 void anchor() override;
1531 SequenceHNode(Node *n) : HNode(n) { }
1533 static bool classof(const HNode *n) {
1534 return SequenceNode::classof(n->_node);
1537 static bool classof(const SequenceHNode *) { return true; }
1539 std::vector<std::unique_ptr<HNode>> Entries;
1542 std::unique_ptr<Input::HNode> createHNodes(Node *node);
1543 void setError(HNode *hnode, const Twine &message);
1544 void setError(Node *node, const Twine &message);
1545 void setError(const SMRange &Range, const Twine &message);
1547 void reportWarning(HNode *hnode, const Twine &message);
1548 void reportWarning(Node *hnode, const Twine &message);
1549 void reportWarning(const SMRange &Range, const Twine &message);
1552 // These are only used by operator>>. They could be private
1553 // if those templated things could be made friends.
1554 bool setCurrentDocument();
1555 bool nextDocument();
1557 /// Returns the current node that's being parsed by the YAML Parser.
1558 const Node *getCurrentNode() const;
1560 void setAllowUnknownKeys(bool Allow) override;
1563 SourceMgr SrcMgr; // must be before Strm
1564 std::unique_ptr<llvm::yaml::Stream> Strm;
1565 std::unique_ptr<HNode> TopNode;
1567 BumpPtrAllocator StringAllocator;
1568 document_iterator DocIterator;
1569 llvm::BitVector BitValuesUsed;
1570 HNode *CurrentNode = nullptr;
1571 bool ScalarMatchFound = false;
1572 bool AllowUnknownKeys = false;
1576 /// The Output class is used to generate a yaml document from in-memory structs
1579 class Output : public IO {
1581 Output(raw_ostream &, void *Ctxt = nullptr, int WrapColumn = 70);
1584 /// Set whether or not to output optional values which are equal
1585 /// to the default value. By default, when outputting if you attempt
1586 /// to write a value that is equal to the default, the value gets ignored.
1587 /// Sometimes, it is useful to be able to see these in the resulting YAML
1589 void setWriteDefaultValues(bool Write) { WriteDefaultValues = Write; }
1591 bool outputting() const override;
1592 bool mapTag(StringRef, bool) override;
1593 void beginMapping() override;
1594 void endMapping() override;
1595 bool preflightKey(const char *key, bool, bool, bool &, void *&) override;
1596 void postflightKey(void *) override;
1597 std::vector<StringRef> keys() override;
1598 void beginFlowMapping() override;
1599 void endFlowMapping() override;
1600 unsigned beginSequence() override;
1601 void endSequence() override;
1602 bool preflightElement(unsigned, void *&) override;
1603 void postflightElement(void *) override;
1604 unsigned beginFlowSequence() override;
1605 bool preflightFlowElement(unsigned, void *&) override;
1606 void postflightFlowElement(void *) override;
1607 void endFlowSequence() override;
1608 void beginEnumScalar() override;
1609 bool matchEnumScalar(const char*, bool) override;
1610 bool matchEnumFallback() override;
1611 void endEnumScalar() override;
1612 bool beginBitSetScalar(bool &) override;
1613 bool bitSetMatch(const char *, bool ) override;
1614 void endBitSetScalar() override;
1615 void scalarString(StringRef &, QuotingType) override;
1616 void blockScalarString(StringRef &) override;
1617 void scalarTag(std::string &) override;
1618 NodeKind getNodeKind() override;
1619 void setError(const Twine &message) override;
1620 bool canElideEmptySequence() override;
1622 // These are only used by operator<<. They could be private
1623 // if that templated operator could be made a friend.
1624 void beginDocuments();
1625 bool preflightDocument(unsigned);
1626 void postflightDocument();
1627 void endDocuments();
1630 void output(StringRef s);
1631 void outputUpToEndOfLine(StringRef s);
1632 void newLineCheck(bool EmptySequence = false);
1633 void outputNewLine();
1634 void paddedKey(StringRef key);
1635 void flowKey(StringRef Key);
1640 inFlowSeqFirstElement,
1641 inFlowSeqOtherElement,
1648 static bool inSeqAnyElement(InState State);
1649 static bool inFlowSeqAnyElement(InState State);
1650 static bool inMapAnyKey(InState State);
1651 static bool inFlowMapAnyKey(InState State);
1655 SmallVector<InState, 8> StateStack;
1657 int ColumnAtFlowStart = 0;
1658 int ColumnAtMapFlowStart = 0;
1659 bool NeedBitValueComma = false;
1660 bool NeedFlowSequenceComma = false;
1661 bool EnumerationMatchFound = false;
1662 bool WriteDefaultValues = false;
1664 StringRef PaddingBeforeContainer;
1667 template <typename T, typename Context>
1668 void IO::processKeyWithDefault(const char *Key, Optional<T> &Val,
1669 const Optional<T> &DefaultValue, bool Required,
1671 assert(!DefaultValue && "Optional<T> shouldn't have a value!");
1673 bool UseDefault = true;
1674 const bool sameAsDefault = outputting() && !Val;
1675 if (!outputting() && !Val)
1678 this->preflightKey(Key, Required, sameAsDefault, UseDefault, SaveInfo)) {
1680 // When reading an Optional<X> key from a YAML description, we allow the
1681 // special "<none>" value, which can be used to specify that no value was
1682 // requested, i.e. the DefaultValue will be assigned. The DefaultValue is
1684 bool IsNone = false;
1686 if (const auto *Node = dyn_cast<ScalarNode>(((Input *)this)->getCurrentNode()))
1687 // We use rtrim to ignore possible white spaces that might exist when a
1688 // comment is present on the same line.
1689 IsNone = Node->getRawValue().rtrim(' ') == "<none>";
1694 yamlize(*this, *Val, Required, Ctx);
1695 this->postflightKey(SaveInfo);
1702 /// YAML I/O does conversion based on types. But often native data types
1703 /// are just a typedef of built in intergral types (e.g. int). But the C++
1704 /// type matching system sees through the typedef and all the typedefed types
1705 /// look like a built in type. This will cause the generic YAML I/O conversion
1706 /// to be used. To provide better control over the YAML conversion, you can
1707 /// use this macro instead of typedef. It will create a class with one field
1708 /// and automatic conversion operators to and from the base type.
1709 /// Based on BOOST_STRONG_TYPEDEF
1710 #define LLVM_YAML_STRONG_TYPEDEF(_base, _type) \
1712 _type() = default; \
1713 _type(const _base v) : value(v) {} \
1714 _type(const _type &v) = default; \
1715 _type &operator=(const _type &rhs) = default; \
1716 _type &operator=(const _base &rhs) { value = rhs; return *this; } \
1717 operator const _base & () const { return value; } \
1718 bool operator==(const _type &rhs) const { return value == rhs.value; } \
1719 bool operator==(const _base &rhs) const { return value == rhs; } \
1720 bool operator<(const _type &rhs) const { return value < rhs.value; } \
1722 using BaseType = _base; \
1726 /// Use these types instead of uintXX_t in any mapping to have
1727 /// its yaml output formatted as hexadecimal.
1729 LLVM_YAML_STRONG_TYPEDEF(uint8_t, Hex8)
1730 LLVM_YAML_STRONG_TYPEDEF(uint16_t, Hex16)
1731 LLVM_YAML_STRONG_TYPEDEF(uint32_t, Hex32)
1732 LLVM_YAML_STRONG_TYPEDEF(uint64_t, Hex64)
1735 struct ScalarTraits<Hex8> {
1736 static void output(const Hex8 &, void *, raw_ostream &);
1737 static StringRef input(StringRef, void *, Hex8 &);
1738 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1742 struct ScalarTraits<Hex16> {
1743 static void output(const Hex16 &, void *, raw_ostream &);
1744 static StringRef input(StringRef, void *, Hex16 &);
1745 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1749 struct ScalarTraits<Hex32> {
1750 static void output(const Hex32 &, void *, raw_ostream &);
1751 static StringRef input(StringRef, void *, Hex32 &);
1752 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1756 struct ScalarTraits<Hex64> {
1757 static void output(const Hex64 &, void *, raw_ostream &);
1758 static StringRef input(StringRef, void *, Hex64 &);
1759 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1762 template <> struct ScalarTraits<VersionTuple> {
1763 static void output(const VersionTuple &Value, void *, llvm::raw_ostream &Out);
1764 static StringRef input(StringRef, void *, VersionTuple &);
1765 static QuotingType mustQuote(StringRef) { return QuotingType::None; }
1768 // Define non-member operator>> so that Input can stream in a document list.
1769 template <typename T>
1770 inline std::enable_if_t<has_DocumentListTraits<T>::value, Input &>
1771 operator>>(Input &yin, T &docList) {
1774 while ( yin.setCurrentDocument() ) {
1775 yamlize(yin, DocumentListTraits<T>::element(yin, docList, i), true, Ctx);
1784 // Define non-member operator>> so that Input can stream in a map as a document.
1785 template <typename T>
1786 inline std::enable_if_t<has_MappingTraits<T, EmptyContext>::value, Input &>
1787 operator>>(Input &yin, T &docMap) {
1789 yin.setCurrentDocument();
1790 yamlize(yin, docMap, true, Ctx);
1794 // Define non-member operator>> so that Input can stream in a sequence as
1796 template <typename T>
1797 inline std::enable_if_t<has_SequenceTraits<T>::value, Input &>
1798 operator>>(Input &yin, T &docSeq) {
1800 if (yin.setCurrentDocument())
1801 yamlize(yin, docSeq, true, Ctx);
1805 // Define non-member operator>> so that Input can stream in a block scalar.
1806 template <typename T>
1807 inline std::enable_if_t<has_BlockScalarTraits<T>::value, Input &>
1808 operator>>(Input &In, T &Val) {
1810 if (In.setCurrentDocument())
1811 yamlize(In, Val, true, Ctx);
1815 // Define non-member operator>> so that Input can stream in a string map.
1816 template <typename T>
1817 inline std::enable_if_t<has_CustomMappingTraits<T>::value, Input &>
1818 operator>>(Input &In, T &Val) {
1820 if (In.setCurrentDocument())
1821 yamlize(In, Val, true, Ctx);
1825 // Define non-member operator>> so that Input can stream in a polymorphic type.
1826 template <typename T>
1827 inline std::enable_if_t<has_PolymorphicTraits<T>::value, Input &>
1828 operator>>(Input &In, T &Val) {
1830 if (In.setCurrentDocument())
1831 yamlize(In, Val, true, Ctx);
1835 // Provide better error message about types missing a trait specialization
1836 template <typename T>
1837 inline std::enable_if_t<missingTraits<T, EmptyContext>::value, Input &>
1838 operator>>(Input &yin, T &docSeq) {
1839 char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
1843 // Define non-member operator<< so that Output can stream out document list.
1844 template <typename T>
1845 inline std::enable_if_t<has_DocumentListTraits<T>::value, Output &>
1846 operator<<(Output &yout, T &docList) {
1848 yout.beginDocuments();
1849 const size_t count = DocumentListTraits<T>::size(yout, docList);
1850 for(size_t i=0; i < count; ++i) {
1851 if ( yout.preflightDocument(i) ) {
1852 yamlize(yout, DocumentListTraits<T>::element(yout, docList, i), true,
1854 yout.postflightDocument();
1857 yout.endDocuments();
1861 // Define non-member operator<< so that Output can stream out a map.
1862 template <typename T>
1863 inline std::enable_if_t<has_MappingTraits<T, EmptyContext>::value, Output &>
1864 operator<<(Output &yout, T &map) {
1866 yout.beginDocuments();
1867 if ( yout.preflightDocument(0) ) {
1868 yamlize(yout, map, true, Ctx);
1869 yout.postflightDocument();
1871 yout.endDocuments();
1875 // Define non-member operator<< so that Output can stream out a sequence.
1876 template <typename T>
1877 inline std::enable_if_t<has_SequenceTraits<T>::value, Output &>
1878 operator<<(Output &yout, T &seq) {
1880 yout.beginDocuments();
1881 if ( yout.preflightDocument(0) ) {
1882 yamlize(yout, seq, true, Ctx);
1883 yout.postflightDocument();
1885 yout.endDocuments();
1889 // Define non-member operator<< so that Output can stream out a block scalar.
1890 template <typename T>
1891 inline std::enable_if_t<has_BlockScalarTraits<T>::value, Output &>
1892 operator<<(Output &Out, T &Val) {
1894 Out.beginDocuments();
1895 if (Out.preflightDocument(0)) {
1896 yamlize(Out, Val, true, Ctx);
1897 Out.postflightDocument();
1903 // Define non-member operator<< so that Output can stream out a string map.
1904 template <typename T>
1905 inline std::enable_if_t<has_CustomMappingTraits<T>::value, Output &>
1906 operator<<(Output &Out, T &Val) {
1908 Out.beginDocuments();
1909 if (Out.preflightDocument(0)) {
1910 yamlize(Out, Val, true, Ctx);
1911 Out.postflightDocument();
1917 // Define non-member operator<< so that Output can stream out a polymorphic
1919 template <typename T>
1920 inline std::enable_if_t<has_PolymorphicTraits<T>::value, Output &>
1921 operator<<(Output &Out, T &Val) {
1923 Out.beginDocuments();
1924 if (Out.preflightDocument(0)) {
1925 // FIXME: The parser does not support explicit documents terminated with a
1926 // plain scalar; the end-marker is included as part of the scalar token.
1927 assert(PolymorphicTraits<T>::getKind(Val) != NodeKind::Scalar && "plain scalar documents are not supported");
1928 yamlize(Out, Val, true, Ctx);
1929 Out.postflightDocument();
1935 // Provide better error message about types missing a trait specialization
1936 template <typename T>
1937 inline std::enable_if_t<missingTraits<T, EmptyContext>::value, Output &>
1938 operator<<(Output &yout, T &seq) {
1939 char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
1943 template <bool B> struct IsFlowSequenceBase {};
1944 template <> struct IsFlowSequenceBase<true> { static const bool flow = true; };
1946 template <typename T, bool Flow>
1947 struct SequenceTraitsImpl : IsFlowSequenceBase<Flow> {
1949 using type = typename T::value_type;
1952 static size_t size(IO &io, T &seq) { return seq.size(); }
1954 static type &element(IO &io, T &seq, size_t index) {
1955 if (index >= seq.size())
1956 seq.resize(index + 1);
1961 // Simple helper to check an expression can be used as a bool-valued template
1963 template <bool> struct CheckIsBool { static const bool value = true; };
1965 // If T has SequenceElementTraits, then vector<T> and SmallVector<T, N> have
1966 // SequenceTraits that do the obvious thing.
1967 template <typename T>
1968 struct SequenceTraits<
1970 std::enable_if_t<CheckIsBool<SequenceElementTraits<T>::flow>::value>>
1971 : SequenceTraitsImpl<std::vector<T>, SequenceElementTraits<T>::flow> {};
1972 template <typename T, unsigned N>
1973 struct SequenceTraits<
1975 std::enable_if_t<CheckIsBool<SequenceElementTraits<T>::flow>::value>>
1976 : SequenceTraitsImpl<SmallVector<T, N>, SequenceElementTraits<T>::flow> {};
1977 template <typename T>
1978 struct SequenceTraits<
1980 std::enable_if_t<CheckIsBool<SequenceElementTraits<T>::flow>::value>>
1981 : SequenceTraitsImpl<SmallVectorImpl<T>, SequenceElementTraits<T>::flow> {};
1983 // Sequences of fundamental types use flow formatting.
1984 template <typename T>
1985 struct SequenceElementTraits<T,
1986 std::enable_if_t<std::is_fundamental<T>::value>> {
1987 static const bool flow = true;
1990 // Sequences of strings use block formatting.
1991 template<> struct SequenceElementTraits<std::string> {
1992 static const bool flow = false;
1994 template<> struct SequenceElementTraits<StringRef> {
1995 static const bool flow = false;
1997 template<> struct SequenceElementTraits<std::pair<std::string, std::string>> {
1998 static const bool flow = false;
2001 /// Implementation of CustomMappingTraits for std::map<std::string, T>.
2002 template <typename T> struct StdMapStringCustomMappingTraitsImpl {
2003 using map_type = std::map<std::string, T>;
2005 static void inputOne(IO &io, StringRef key, map_type &v) {
2006 io.mapRequired(key.str().c_str(), v[std::string(key)]);
2009 static void output(IO &io, map_type &v) {
2011 io.mapRequired(p.first.c_str(), p.second);
2015 } // end namespace yaml
2016 } // end namespace llvm
2018 #define LLVM_YAML_IS_SEQUENCE_VECTOR_IMPL(TYPE, FLOW) \
2022 !std::is_fundamental<TYPE>::value && \
2023 !std::is_same<TYPE, std::string>::value && \
2024 !std::is_same<TYPE, llvm::StringRef>::value, \
2025 "only use LLVM_YAML_IS_SEQUENCE_VECTOR for types you control"); \
2026 template <> struct SequenceElementTraits<TYPE> { \
2027 static const bool flow = FLOW; \
2032 /// Utility for declaring that a std::vector of a particular type
2033 /// should be considered a YAML sequence.
2034 #define LLVM_YAML_IS_SEQUENCE_VECTOR(type) \
2035 LLVM_YAML_IS_SEQUENCE_VECTOR_IMPL(type, false)
2037 /// Utility for declaring that a std::vector of a particular type
2038 /// should be considered a YAML flow sequence.
2039 #define LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(type) \
2040 LLVM_YAML_IS_SEQUENCE_VECTOR_IMPL(type, true)
2042 #define LLVM_YAML_DECLARE_MAPPING_TRAITS(Type) \
2045 template <> struct MappingTraits<Type> { \
2046 static void mapping(IO &IO, Type &Obj); \
2051 #define LLVM_YAML_DECLARE_ENUM_TRAITS(Type) \
2054 template <> struct ScalarEnumerationTraits<Type> { \
2055 static void enumeration(IO &io, Type &Value); \
2060 #define LLVM_YAML_DECLARE_BITSET_TRAITS(Type) \
2063 template <> struct ScalarBitSetTraits<Type> { \
2064 static void bitset(IO &IO, Type &Options); \
2069 #define LLVM_YAML_DECLARE_SCALAR_TRAITS(Type, MustQuote) \
2072 template <> struct ScalarTraits<Type> { \
2073 static void output(const Type &Value, void *ctx, raw_ostream &Out); \
2074 static StringRef input(StringRef Scalar, void *ctxt, Type &Value); \
2075 static QuotingType mustQuote(StringRef) { return MustQuote; } \
2080 /// Utility for declaring that a std::vector of a particular type
2081 /// should be considered a YAML document list.
2082 #define LLVM_YAML_IS_DOCUMENT_LIST_VECTOR(_type) \
2085 template <unsigned N> \
2086 struct DocumentListTraits<SmallVector<_type, N>> \
2087 : public SequenceTraitsImpl<SmallVector<_type, N>, false> {}; \
2089 struct DocumentListTraits<std::vector<_type>> \
2090 : public SequenceTraitsImpl<std::vector<_type>, false> {}; \
2094 /// Utility for declaring that std::map<std::string, _type> should be considered
2096 #define LLVM_YAML_IS_STRING_MAP(_type) \
2100 struct CustomMappingTraits<std::map<std::string, _type>> \
2101 : public StdMapStringCustomMappingTraitsImpl<_type> {}; \
2105 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(llvm::yaml::Hex64)
2106 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(llvm::yaml::Hex32)
2107 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(llvm::yaml::Hex16)
2108 LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(llvm::yaml::Hex8)
2110 #endif // LLVM_SUPPORT_YAMLTRAITS_H