1 //===- llvm/Supporrt/YAMLTraits.h -------------------------------*- C++ -*-===//
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_SUPPORT_YAMLTRAITS_H
11 #define LLVM_SUPPORT_YAMLTRAITS_H
14 #include "llvm/ADT/DenseMap.h"
15 #include "llvm/ADT/DenseMapInfo.h"
16 #include "llvm/ADT/SmallVector.h"
17 #include "llvm/ADT/StringMap.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/ADT/StringSwitch.h"
20 #include "llvm/ADT/Twine.h"
21 #include "llvm/Support/Compiler.h"
22 #include "llvm/Support/SourceMgr.h"
23 #include "llvm/Support/YAMLParser.h"
24 #include "llvm/Support/raw_ostream.h"
25 #include "llvm/Support/system_error.h"
26 #include "llvm/Support/type_traits.h"
33 /// This class should be specialized by any type that needs to be converted
34 /// to/from a YAML mapping. For example:
36 /// struct ScalarBitSetTraits<MyStruct> {
37 /// static void mapping(IO &io, MyStruct &s) {
38 /// io.mapRequired("name", s.name);
39 /// io.mapRequired("size", s.size);
40 /// io.mapOptional("age", s.age);
44 struct MappingTraits {
46 // static void mapping(IO &io, T &fields);
50 /// This class should be specialized by any integral type that converts
51 /// to/from a YAML scalar where there is a one-to-one mapping between
52 /// in-memory values and a string in YAML. For example:
54 /// struct ScalarEnumerationTraits<Colors> {
55 /// static void enumeration(IO &io, Colors &value) {
56 /// io.enumCase(value, "red", cRed);
57 /// io.enumCase(value, "blue", cBlue);
58 /// io.enumCase(value, "green", cGreen);
62 struct ScalarEnumerationTraits {
64 // static void enumeration(IO &io, T &value);
68 /// This class should be specialized by any integer type that is a union
69 /// of bit values and the YAML representation is a flow sequence of
70 /// strings. For example:
72 /// struct ScalarBitSetTraits<MyFlags> {
73 /// static void bitset(IO &io, MyFlags &value) {
74 /// io.bitSetCase(value, "big", flagBig);
75 /// io.bitSetCase(value, "flat", flagFlat);
76 /// io.bitSetCase(value, "round", flagRound);
80 struct ScalarBitSetTraits {
82 // static void bitset(IO &io, T &value);
86 /// This class should be specialized by type that requires custom conversion
87 /// to/from a yaml scalar. For example:
90 /// struct ScalarTraits<MyType> {
91 /// static void output(const MyType &val, void*, llvm::raw_ostream &out) {
92 /// // stream out custom formatting
93 /// out << llvm::format("%x", val);
95 /// static StringRef input(StringRef scalar, void*, MyType &value) {
96 /// // parse scalar and set `value`
97 /// // return empty string on success, or error string
98 /// return StringRef();
102 struct ScalarTraits {
105 // Function to write the value as a string:
106 //static void output(const T &value, void *ctxt, llvm::raw_ostream &out);
108 // Function to convert a string to a value. Returns the empty
109 // StringRef on success or an error string if string is malformed:
110 //static StringRef input(StringRef scalar, void *ctxt, T &value);
114 /// This class should be specialized by any type that needs to be converted
115 /// to/from a YAML sequence. For example:
118 /// struct SequenceTraits< std::vector<MyType> > {
119 /// static size_t size(IO &io, std::vector<MyType> &seq) {
120 /// return seq.size();
122 /// static MyType& element(IO &, std::vector<MyType> &seq, size_t index) {
123 /// if ( index >= seq.size() )
124 /// seq.resize(index+1);
125 /// return seq[index];
129 struct SequenceTraits {
131 // static size_t size(IO &io, T &seq);
132 // static T::value_type& element(IO &io, T &seq, size_t index);
134 // The following is option and will cause generated YAML to use
135 // a flow sequence (e.g. [a,b,c]).
136 // static const bool flow = true;
140 /// This class should be specialized by any type that needs to be converted
141 /// to/from a list of YAML documents.
143 struct DocumentListTraits {
145 // static size_t size(IO &io, T &seq);
146 // static T::value_type& element(IO &io, T &seq, size_t index);
150 // Only used by compiler if both template types are the same
151 template <typename T, T>
154 // Only used for better diagnostics of missing traits
155 template <typename T>
160 // Test if ScalarEnumerationTraits<T> is defined on type T.
162 struct has_ScalarEnumerationTraits
164 typedef void (*Signature_enumeration)(class IO&, T&);
166 template <typename U>
167 static char test(SameType<Signature_enumeration, &U::enumeration>*);
169 template <typename U>
170 static double test(...);
173 static bool const value = (sizeof(test<ScalarEnumerationTraits<T> >(0)) == 1);
177 // Test if ScalarBitSetTraits<T> is defined on type T.
179 struct has_ScalarBitSetTraits
181 typedef void (*Signature_bitset)(class IO&, T&);
183 template <typename U>
184 static char test(SameType<Signature_bitset, &U::bitset>*);
186 template <typename U>
187 static double test(...);
190 static bool const value = (sizeof(test<ScalarBitSetTraits<T> >(0)) == 1);
194 // Test if ScalarTraits<T> is defined on type T.
196 struct has_ScalarTraits
198 typedef StringRef (*Signature_input)(StringRef, void*, T&);
199 typedef void (*Signature_output)(const T&, void*, llvm::raw_ostream&);
201 template <typename U>
202 static char test(SameType<Signature_input, &U::input>*,
203 SameType<Signature_output, &U::output>*);
205 template <typename U>
206 static double test(...);
209 static bool const value = (sizeof(test<ScalarTraits<T> >(0,0)) == 1);
213 // Test if MappingTraits<T> is defined on type T.
215 struct has_MappingTraits
217 typedef void (*Signature_mapping)(class IO&, T&);
219 template <typename U>
220 static char test(SameType<Signature_mapping, &U::mapping>*);
222 template <typename U>
223 static double test(...);
226 static bool const value = (sizeof(test<MappingTraits<T> >(0)) == 1);
230 // Test if SequenceTraits<T> is defined on type T.
232 struct has_SequenceMethodTraits
234 typedef size_t (*Signature_size)(class IO&, T&);
236 template <typename U>
237 static char test(SameType<Signature_size, &U::size>*);
239 template <typename U>
240 static double test(...);
243 static bool const value = (sizeof(test<SequenceTraits<T> >(0)) == 1);
247 // has_FlowTraits<int> will cause an error with some compilers because
248 // it subclasses int. Using this wrapper only instantiates the
249 // real has_FlowTraits only if the template type is a class.
250 template <typename T, bool Enabled = llvm::is_class<T>::value>
254 static const bool value = false;
257 // Some older gcc compilers don't support straight forward tests
258 // for members, so test for ambiguity cause by the base and derived
259 // classes both defining the member.
261 struct has_FlowTraits<T, true>
263 struct Fallback { bool flow; };
264 struct Derived : T, Fallback { };
267 static char (&f(SameType<bool Fallback::*, &C::flow>*))[1];
270 static char (&f(...))[2];
273 static bool const value = sizeof(f<Derived>(0)) == 2;
278 // Test if SequenceTraits<T> is defined on type T
280 struct has_SequenceTraits : public llvm::integral_constant<bool,
281 has_SequenceMethodTraits<T>::value > { };
284 // Test if DocumentListTraits<T> is defined on type T
286 struct has_DocumentListTraits
288 typedef size_t (*Signature_size)(class IO&, T&);
290 template <typename U>
291 static char test(SameType<Signature_size, &U::size>*);
293 template <typename U>
294 static double test(...);
297 static bool const value = (sizeof(test<DocumentListTraits<T> >(0)) == 1);
304 struct missingTraits : public llvm::integral_constant<bool,
305 !has_ScalarEnumerationTraits<T>::value
306 && !has_ScalarBitSetTraits<T>::value
307 && !has_ScalarTraits<T>::value
308 && !has_MappingTraits<T>::value
309 && !has_SequenceTraits<T>::value
310 && !has_DocumentListTraits<T>::value > {};
313 // Base class for Input and Output.
320 virtual bool outputting() = 0;
322 virtual unsigned beginSequence() = 0;
323 virtual bool preflightElement(unsigned, void *&) = 0;
324 virtual void postflightElement(void*) = 0;
325 virtual void endSequence() = 0;
326 virtual bool canElideEmptySequence() = 0;
328 virtual unsigned beginFlowSequence() = 0;
329 virtual bool preflightFlowElement(unsigned, void *&) = 0;
330 virtual void postflightFlowElement(void*) = 0;
331 virtual void endFlowSequence() = 0;
333 virtual void beginMapping() = 0;
334 virtual void endMapping() = 0;
335 virtual bool preflightKey(const char*, bool, bool, bool &, void *&) = 0;
336 virtual void postflightKey(void*) = 0;
338 virtual void beginEnumScalar() = 0;
339 virtual bool matchEnumScalar(const char*, bool) = 0;
340 virtual void endEnumScalar() = 0;
342 virtual bool beginBitSetScalar(bool &) = 0;
343 virtual bool bitSetMatch(const char*, bool) = 0;
344 virtual void endBitSetScalar() = 0;
346 virtual void scalarString(StringRef &) = 0;
348 virtual void setError(const Twine &) = 0;
350 template <typename T>
351 void enumCase(T &Val, const char* Str, const T ConstVal) {
352 if ( matchEnumScalar(Str, outputting() && Val == ConstVal) ) {
357 // allow anonymous enum values to be used with LLVM_YAML_STRONG_TYPEDEF
358 template <typename T>
359 void enumCase(T &Val, const char* Str, const uint32_t ConstVal) {
360 if ( matchEnumScalar(Str, outputting() && Val == static_cast<T>(ConstVal)) ) {
365 template <typename T>
366 void bitSetCase(T &Val, const char* Str, const T ConstVal) {
367 if ( bitSetMatch(Str, outputting() && (Val & ConstVal) == ConstVal) ) {
368 Val = Val | ConstVal;
372 // allow anonymous enum values to be used with LLVM_YAML_STRONG_TYPEDEF
373 template <typename T>
374 void bitSetCase(T &Val, const char* Str, const uint32_t ConstVal) {
375 if ( bitSetMatch(Str, outputting() && (Val & ConstVal) == ConstVal) ) {
376 Val = Val | ConstVal;
381 void setContext(void *);
383 template <typename T>
384 void mapRequired(const char* Key, T& Val) {
385 this->processKey(Key, Val, true);
388 template <typename T>
389 typename llvm::enable_if_c<has_SequenceTraits<T>::value,void>::type
390 mapOptional(const char* Key, T& Val) {
391 // omit key/value instead of outputting empty sequence
392 if ( this->canElideEmptySequence() && !(Val.begin() != Val.end()) )
394 this->processKey(Key, Val, false);
397 template <typename T>
398 typename llvm::enable_if_c<!has_SequenceTraits<T>::value,void>::type
399 mapOptional(const char* Key, T& Val) {
400 this->processKey(Key, Val, false);
403 template <typename T>
404 void mapOptional(const char* Key, T& Val, const T& Default) {
405 this->processKeyWithDefault(Key, Val, Default, false);
410 template <typename T>
411 void processKeyWithDefault(const char *Key, T &Val, const T& DefaultValue,
415 const bool sameAsDefault = outputting() && Val == DefaultValue;
416 if ( this->preflightKey(Key, Required, sameAsDefault, UseDefault,
418 yamlize(*this, Val, Required);
419 this->postflightKey(SaveInfo);
427 template <typename T>
428 void processKey(const char *Key, T &Val, bool Required) {
431 if ( this->preflightKey(Key, Required, false, UseDefault, SaveInfo) ) {
432 yamlize(*this, Val, Required);
433 this->postflightKey(SaveInfo);
444 typename llvm::enable_if_c<has_ScalarEnumerationTraits<T>::value,void>::type
445 yamlize(IO &io, T &Val, bool) {
446 io.beginEnumScalar();
447 ScalarEnumerationTraits<T>::enumeration(io, Val);
452 typename llvm::enable_if_c<has_ScalarBitSetTraits<T>::value,void>::type
453 yamlize(IO &io, T &Val, bool) {
455 if ( io.beginBitSetScalar(DoClear) ) {
457 Val = static_cast<T>(0);
458 ScalarBitSetTraits<T>::bitset(io, Val);
459 io.endBitSetScalar();
465 typename llvm::enable_if_c<has_ScalarTraits<T>::value,void>::type
466 yamlize(IO &io, T &Val, bool) {
467 if ( io.outputting() ) {
469 llvm::raw_string_ostream Buffer(Storage);
470 ScalarTraits<T>::output(Val, io.getContext(), Buffer);
471 StringRef Str = Buffer.str();
472 io.scalarString(Str);
476 io.scalarString(Str);
477 StringRef Result = ScalarTraits<T>::input(Str, io.getContext(), Val);
478 if ( !Result.empty() ) {
479 io.setError(llvm::Twine(Result));
486 typename llvm::enable_if_c<has_MappingTraits<T>::value, void>::type
487 yamlize(IO &io, T &Val, bool) {
489 MappingTraits<T>::mapping(io, Val);
494 typename llvm::enable_if_c<missingTraits<T>::value, void>::type
495 yamlize(IO &io, T &Val, bool) {
496 char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
500 typename llvm::enable_if_c<has_SequenceTraits<T>::value,void>::type
501 yamlize(IO &io, T &Seq, bool) {
502 if ( has_FlowTraits< SequenceTraits<T> >::value ) {
503 unsigned incnt = io.beginFlowSequence();
504 unsigned count = io.outputting() ? SequenceTraits<T>::size(io, Seq) : incnt;
505 for(unsigned i=0; i < count; ++i) {
507 if ( io.preflightFlowElement(i, SaveInfo) ) {
508 yamlize(io, SequenceTraits<T>::element(io, Seq, i), true);
509 io.postflightFlowElement(SaveInfo);
512 io.endFlowSequence();
515 unsigned incnt = io.beginSequence();
516 unsigned count = io.outputting() ? SequenceTraits<T>::size(io, Seq) : incnt;
517 for(unsigned i=0; i < count; ++i) {
519 if ( io.preflightElement(i, SaveInfo) ) {
520 yamlize(io, SequenceTraits<T>::element(io, Seq, i), true);
521 io.postflightElement(SaveInfo);
530 struct ScalarTraits<bool> {
531 static void output(const bool &, void*, llvm::raw_ostream &);
532 static StringRef input(StringRef, void*, bool &);
536 struct ScalarTraits<StringRef> {
537 static void output(const StringRef &, void*, llvm::raw_ostream &);
538 static StringRef input(StringRef, void*, StringRef &);
542 struct ScalarTraits<uint8_t> {
543 static void output(const uint8_t &, void*, llvm::raw_ostream &);
544 static StringRef input(StringRef, void*, uint8_t &);
548 struct ScalarTraits<uint16_t> {
549 static void output(const uint16_t &, void*, llvm::raw_ostream &);
550 static StringRef input(StringRef, void*, uint16_t &);
554 struct ScalarTraits<uint32_t> {
555 static void output(const uint32_t &, void*, llvm::raw_ostream &);
556 static StringRef input(StringRef, void*, uint32_t &);
560 struct ScalarTraits<uint64_t> {
561 static void output(const uint64_t &, void*, llvm::raw_ostream &);
562 static StringRef input(StringRef, void*, uint64_t &);
566 struct ScalarTraits<int8_t> {
567 static void output(const int8_t &, void*, llvm::raw_ostream &);
568 static StringRef input(StringRef, void*, int8_t &);
572 struct ScalarTraits<int16_t> {
573 static void output(const int16_t &, void*, llvm::raw_ostream &);
574 static StringRef input(StringRef, void*, int16_t &);
578 struct ScalarTraits<int32_t> {
579 static void output(const int32_t &, void*, llvm::raw_ostream &);
580 static StringRef input(StringRef, void*, int32_t &);
584 struct ScalarTraits<int64_t> {
585 static void output(const int64_t &, void*, llvm::raw_ostream &);
586 static StringRef input(StringRef, void*, int64_t &);
590 struct ScalarTraits<float> {
591 static void output(const float &, void*, llvm::raw_ostream &);
592 static StringRef input(StringRef, void*, float &);
596 struct ScalarTraits<double> {
597 static void output(const double &, void*, llvm::raw_ostream &);
598 static StringRef input(StringRef, void*, double &);
603 // Utility for use within MappingTraits<>::mapping() method
604 // to [de]normalize an object for use with YAML conversion.
605 template <typename TNorm, typename TFinal>
606 struct MappingNormalization {
607 MappingNormalization(IO &i_o, TFinal &Obj)
608 : io(i_o), BufPtr(NULL), Result(Obj) {
609 if ( io.outputting() ) {
610 BufPtr = new (&Buffer) TNorm(io, Obj);
613 BufPtr = new (&Buffer) TNorm(io);
617 ~MappingNormalization() {
618 if ( ! io.outputting() ) {
619 Result = BufPtr->denormalize(io);
624 TNorm* operator->() { return BufPtr; }
627 typedef llvm::AlignedCharArrayUnion<TNorm> Storage;
637 // Utility for use within MappingTraits<>::mapping() method
638 // to [de]normalize an object for use with YAML conversion.
639 template <typename TNorm, typename TFinal>
640 struct MappingNormalizationHeap {
641 MappingNormalizationHeap(IO &i_o, TFinal &Obj)
642 : io(i_o), BufPtr(NULL), Result(Obj) {
643 if ( io.outputting() ) {
644 BufPtr = new (&Buffer) TNorm(io, Obj);
647 BufPtr = new TNorm(io);
651 ~MappingNormalizationHeap() {
652 if ( io.outputting() ) {
656 Result = BufPtr->denormalize(io);
660 TNorm* operator->() { return BufPtr; }
663 typedef llvm::AlignedCharArrayUnion<TNorm> Storage;
674 /// The Input class is used to parse a yaml document into in-memory structs
677 /// It works by using YAMLParser to do a syntax parse of the entire yaml
678 /// document, then the Input class builds a graph of HNodes which wraps
679 /// each yaml Node. The extra layer is buffering. The low level yaml
680 /// parser only lets you look at each node once. The buffering layer lets
681 /// you search and interate multiple times. This is necessary because
682 /// the mapRequired() method calls may not be in the same order
683 /// as the keys in the document.
685 class Input : public IO {
687 // Construct a yaml Input object from a StringRef and optional user-data.
688 Input(StringRef InputContent, void *Ctxt=NULL);
691 // Check if there was an syntax or semantic error during parsing.
692 llvm::error_code error();
694 // To set alternate error reporting.
695 void setDiagHandler(llvm::SourceMgr::DiagHandlerTy Handler, void *Ctxt = 0);
698 virtual bool outputting();
699 virtual void beginMapping();
700 virtual void endMapping();
701 virtual bool preflightKey(const char *, bool, bool, bool &, void *&);
702 virtual void postflightKey(void *);
703 virtual unsigned beginSequence();
704 virtual void endSequence();
705 virtual bool preflightElement(unsigned index, void *&);
706 virtual void postflightElement(void *);
707 virtual unsigned beginFlowSequence();
708 virtual bool preflightFlowElement(unsigned , void *&);
709 virtual void postflightFlowElement(void *);
710 virtual void endFlowSequence();
711 virtual void beginEnumScalar();
712 virtual bool matchEnumScalar(const char*, bool);
713 virtual void endEnumScalar();
714 virtual bool beginBitSetScalar(bool &);
715 virtual bool bitSetMatch(const char *, bool );
716 virtual void endBitSetScalar();
717 virtual void scalarString(StringRef &);
718 virtual void setError(const Twine &message);
719 virtual bool canElideEmptySequence();
723 HNode(Node *n) : _node(n) { }
725 static inline bool classof(const HNode *) { return true; }
730 class EmptyHNode : public HNode {
732 EmptyHNode(Node *n) : HNode(n) { }
733 virtual ~EmptyHNode() {}
734 static inline bool classof(const HNode *n) {
735 return NullNode::classof(n->_node);
737 static inline bool classof(const EmptyHNode *) { return true; }
740 class ScalarHNode : public HNode {
742 ScalarHNode(Node *n, StringRef s) : HNode(n), _value(s) { }
743 virtual ~ScalarHNode() { }
745 StringRef value() const { return _value; }
747 static inline bool classof(const HNode *n) {
748 return ScalarNode::classof(n->_node);
750 static inline bool classof(const ScalarHNode *) { return true; }
755 class MapHNode : public HNode {
757 MapHNode(Node *n) : HNode(n) { }
760 static inline bool classof(const HNode *n) {
761 return MappingNode::classof(n->_node);
763 static inline bool classof(const MapHNode *) { return true; }
765 typedef llvm::StringMap<HNode*> NameToNode;
767 bool isValidKey(StringRef key);
770 llvm::SmallVector<const char*, 6> ValidKeys;
773 class SequenceHNode : public HNode {
775 SequenceHNode(Node *n) : HNode(n) { }
776 virtual ~SequenceHNode();
778 static inline bool classof(const HNode *n) {
779 return SequenceNode::classof(n->_node);
781 static inline bool classof(const SequenceHNode *) { return true; }
783 std::vector<HNode*> Entries;
786 Input::HNode *createHNodes(Node *node);
787 void setError(HNode *hnode, const Twine &message);
788 void setError(Node *node, const Twine &message);
792 // These are only used by operator>>. They could be private
793 // if those templated things could be made friends.
794 bool setCurrentDocument();
798 llvm::SourceMgr SrcMgr; // must be before Strm
799 OwningPtr<llvm::yaml::Stream> Strm;
800 OwningPtr<HNode> TopNode;
802 llvm::BumpPtrAllocator StringAllocator;
803 llvm::yaml::document_iterator DocIterator;
804 std::vector<bool> BitValuesUsed;
806 bool ScalarMatchFound;
813 /// The Output class is used to generate a yaml document from in-memory structs
816 class Output : public IO {
818 Output(llvm::raw_ostream &, void *Ctxt=NULL);
821 virtual bool outputting();
822 virtual void beginMapping();
823 virtual void endMapping();
824 virtual bool preflightKey(const char *key, bool, bool, bool &, void *&);
825 virtual void postflightKey(void *);
826 virtual unsigned beginSequence();
827 virtual void endSequence();
828 virtual bool preflightElement(unsigned, void *&);
829 virtual void postflightElement(void *);
830 virtual unsigned beginFlowSequence();
831 virtual bool preflightFlowElement(unsigned, void *&);
832 virtual void postflightFlowElement(void *);
833 virtual void endFlowSequence();
834 virtual void beginEnumScalar();
835 virtual bool matchEnumScalar(const char*, bool);
836 virtual void endEnumScalar();
837 virtual bool beginBitSetScalar(bool &);
838 virtual bool bitSetMatch(const char *, bool );
839 virtual void endBitSetScalar();
840 virtual void scalarString(StringRef &);
841 virtual void setError(const Twine &message);
842 virtual bool canElideEmptySequence();
844 // These are only used by operator<<. They could be private
845 // if that templated operator could be made a friend.
846 void beginDocuments();
847 bool preflightDocument(unsigned);
848 void postflightDocument();
852 void output(StringRef s);
853 void outputUpToEndOfLine(StringRef s);
855 void outputNewLine();
856 void paddedKey(StringRef key);
858 enum InState { inSeq, inFlowSeq, inMapFirstKey, inMapOtherKey };
860 llvm::raw_ostream &Out;
861 SmallVector<InState, 8> StateStack;
863 int ColumnAtFlowStart;
864 bool NeedBitValueComma;
865 bool NeedFlowSequenceComma;
866 bool EnumerationMatchFound;
873 /// YAML I/O does conversion based on types. But often native data types
874 /// are just a typedef of built in intergral types (e.g. int). But the C++
875 /// type matching system sees through the typedef and all the typedefed types
876 /// look like a built in type. This will cause the generic YAML I/O conversion
877 /// to be used. To provide better control over the YAML conversion, you can
878 /// use this macro instead of typedef. It will create a class with one field
879 /// and automatic conversion operators to and from the base type.
880 /// Based on BOOST_STRONG_TYPEDEF
881 #define LLVM_YAML_STRONG_TYPEDEF(_base, _type) \
884 _type(const _base v) : value(v) { } \
885 _type(const _type &v) : value(v.value) {} \
886 _type &operator=(const _type &rhs) { value = rhs.value; return *this; }\
887 _type &operator=(const _base &rhs) { value = rhs; return *this; } \
888 operator const _base & () const { return value; } \
889 bool operator==(const _type &rhs) const { return value == rhs.value; } \
890 bool operator==(const _base &rhs) const { return value == rhs; } \
891 bool operator<(const _type &rhs) const { return value < rhs.value; } \
898 /// Use these types instead of uintXX_t in any mapping to have
899 /// its yaml output formatted as hexadecimal.
901 LLVM_YAML_STRONG_TYPEDEF(uint8_t, Hex8)
902 LLVM_YAML_STRONG_TYPEDEF(uint16_t, Hex16)
903 LLVM_YAML_STRONG_TYPEDEF(uint32_t, Hex32)
904 LLVM_YAML_STRONG_TYPEDEF(uint64_t, Hex64)
908 struct ScalarTraits<Hex8> {
909 static void output(const Hex8 &, void*, llvm::raw_ostream &);
910 static StringRef input(StringRef, void*, Hex8 &);
914 struct ScalarTraits<Hex16> {
915 static void output(const Hex16 &, void*, llvm::raw_ostream &);
916 static StringRef input(StringRef, void*, Hex16 &);
920 struct ScalarTraits<Hex32> {
921 static void output(const Hex32 &, void*, llvm::raw_ostream &);
922 static StringRef input(StringRef, void*, Hex32 &);
926 struct ScalarTraits<Hex64> {
927 static void output(const Hex64 &, void*, llvm::raw_ostream &);
928 static StringRef input(StringRef, void*, Hex64 &);
932 // Define non-member operator>> so that Input can stream in a document list.
933 template <typename T>
935 typename llvm::enable_if_c<has_DocumentListTraits<T>::value,Input &>::type
936 operator>>(Input &yin, T &docList) {
938 while ( yin.setCurrentDocument() ) {
939 yamlize(yin, DocumentListTraits<T>::element(yin, docList, i), true);
948 // Define non-member operator>> so that Input can stream in a map as a document.
949 template <typename T>
951 typename llvm::enable_if_c<has_MappingTraits<T>::value,Input &>::type
952 operator>>(Input &yin, T &docMap) {
953 yin.setCurrentDocument();
954 yamlize(yin, docMap, true);
958 // Define non-member operator>> so that Input can stream in a sequence as
960 template <typename T>
962 typename llvm::enable_if_c<has_SequenceTraits<T>::value,Input &>::type
963 operator>>(Input &yin, T &docSeq) {
964 yin.setCurrentDocument();
965 yamlize(yin, docSeq, true);
969 // Provide better error message about types missing a trait specialization
970 template <typename T>
972 typename llvm::enable_if_c<missingTraits<T>::value,Input &>::type
973 operator>>(Input &yin, T &docSeq) {
974 char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
979 // Define non-member operator<< so that Output can stream out document list.
980 template <typename T>
982 typename llvm::enable_if_c<has_DocumentListTraits<T>::value,Output &>::type
983 operator<<(Output &yout, T &docList) {
984 yout.beginDocuments();
985 const size_t count = DocumentListTraits<T>::size(yout, docList);
986 for(size_t i=0; i < count; ++i) {
987 if ( yout.preflightDocument(i) ) {
988 yamlize(yout, DocumentListTraits<T>::element(yout, docList, i), true);
989 yout.postflightDocument();
996 // Define non-member operator<< so that Output can stream out a map.
997 template <typename T>
999 typename llvm::enable_if_c<has_MappingTraits<T>::value,Output &>::type
1000 operator<<(Output &yout, T &map) {
1001 yout.beginDocuments();
1002 if ( yout.preflightDocument(0) ) {
1003 yamlize(yout, map, true);
1004 yout.postflightDocument();
1006 yout.endDocuments();
1010 // Define non-member operator<< so that Output can stream out a sequence.
1011 template <typename T>
1013 typename llvm::enable_if_c<has_SequenceTraits<T>::value,Output &>::type
1014 operator<<(Output &yout, T &seq) {
1015 yout.beginDocuments();
1016 if ( yout.preflightDocument(0) ) {
1017 yamlize(yout, seq, true);
1018 yout.postflightDocument();
1020 yout.endDocuments();
1024 // Provide better error message about types missing a trait specialization
1025 template <typename T>
1027 typename llvm::enable_if_c<missingTraits<T>::value,Output &>::type
1028 operator<<(Output &yout, T &seq) {
1029 char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
1038 /// Utility for declaring that a std::vector of a particular type
1039 /// should be considered a YAML sequence.
1040 #define LLVM_YAML_IS_SEQUENCE_VECTOR(_type) \
1044 struct SequenceTraits< std::vector<_type> > { \
1045 static size_t size(IO &io, std::vector<_type> &seq) { \
1046 return seq.size(); \
1048 static _type& element(IO &io, std::vector<_type> &seq, size_t index) {\
1049 if ( index >= seq.size() ) \
1050 seq.resize(index+1); \
1051 return seq[index]; \
1057 /// Utility for declaring that a std::vector of a particular type
1058 /// should be considered a YAML flow sequence.
1059 #define LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(_type) \
1063 struct SequenceTraits< std::vector<_type> > { \
1064 static size_t size(IO &io, std::vector<_type> &seq) { \
1065 return seq.size(); \
1067 static _type& element(IO &io, std::vector<_type> &seq, size_t index) {\
1068 if ( index >= seq.size() ) \
1069 seq.resize(index+1); \
1070 return seq[index]; \
1072 static const bool flow = true; \
1077 /// Utility for declaring that a std::vector of a particular type
1078 /// should be considered a YAML document list.
1079 #define LLVM_YAML_IS_DOCUMENT_LIST_VECTOR(_type) \
1083 struct DocumentListTraits< std::vector<_type> > { \
1084 static size_t size(IO &io, std::vector<_type> &seq) { \
1085 return seq.size(); \
1087 static _type& element(IO &io, std::vector<_type> &seq, size_t index) {\
1088 if ( index >= seq.size() ) \
1089 seq.resize(index+1); \
1090 return seq[index]; \
1098 #endif // LLVM_SUPPORT_YAMLTRAITS_H