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
  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"
  27
  28
  29 namespace llvm {
  30 namespace yaml {
  31
  32
  33 /// This class should be specialized by any type that needs to be converted
  34 /// to/from a YAML mapping.  For example:
  35 ///
  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);
  41 ///       }
  42 ///     };
  43 template<class T>
  44 struct MappingTraits {
  45   // Must provide:
  46   // static void mapping(IO &io, T &fields);
  47 };
  48
  49
  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:
  53 ///
  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);
  59 ///         }
  60 ///       };
  61 template<typename T>
  62 struct ScalarEnumerationTraits {
  63   // Must provide:
  64   // static void enumeration(IO &io, T &value);
  65 };
  66
  67
  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:
  71 ///
  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);
  77 ///        }
  78 ///      };
  79 template<typename T>
  80 struct ScalarBitSetTraits {
  81   // Must provide:
  82   // static void bitset(IO &io, T &value);
  83 };
  84
  85
  86 /// This class should be specialized by type that requires custom conversion
  87 /// to/from a yaml scalar.  For example:
  88 ///
  89 ///    template<>
  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);
  94 ///      }
  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();
  99 ///      }
 100 ///    };
 101 template<typename T>
 102 struct ScalarTraits {
 103   // Must provide:
 104   //
 105   // Function to write the value as a string:
 106   //static void output(const T &value, void *ctxt, llvm::raw_ostream &out);
 107   //
 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);
 111 };
 112
 113
 114 /// This class should be specialized by any type that needs to be converted
 115 /// to/from a YAML sequence.  For example:
 116 ///
 117 ///    template<>
 118 ///    struct SequenceTraits< std::vector<MyType> > {
 119 ///      static size_t size(IO &io, std::vector<MyType> &seq) {
 120 ///        return seq.size();
 121 ///      }
 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];
 126 ///      }
 127 ///    };
 128 template<typename T>
 129 struct SequenceTraits {
 130   // Must provide:
 131   // static size_t size(IO &io, T &seq);
 132   // static T::value_type& element(IO &io, T &seq, size_t index);
 133   //
 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;
 137 };
 138
 139
 140 /// This class should be specialized by any type that needs to be converted
 141 /// to/from a list of YAML documents.
 142 template<typename T>
 143 struct DocumentListTraits {
 144   // Must provide:
 145   // static size_t size(IO &io, T &seq);
 146   // static T::value_type& element(IO &io, T &seq, size_t index);
 147 };
 148
 149
 150 // Only used by compiler if both template types are the same
 151 template <typename T, T>
 152 struct SameType;
 153
 154 // Only used for better diagnostics of missing traits
 155 template <typename T>
 156 struct MissingTrait;
 157
 158
 159
 160 // Test if ScalarEnumerationTraits<T> is defined on type T.
 161 template <class T>
 162 struct has_ScalarEnumerationTraits
 163 {
 164   typedef void (*Signature_enumeration)(class IO&, T&);
 165
 166   template <typename U>
 167   static char test(SameType<Signature_enumeration, &U::enumeration>*);
 168
 169   template <typename U>
 170   static double test(...);
 171
 172 public:
 173   static bool const value = (sizeof(test<ScalarEnumerationTraits<T> >(0)) == 1);
 174 };
 175
 176
 177 // Test if ScalarBitSetTraits<T> is defined on type T.
 178 template <class T>
 179 struct has_ScalarBitSetTraits
 180 {
 181   typedef void (*Signature_bitset)(class IO&, T&);
 182
 183   template <typename U>
 184   static char test(SameType<Signature_bitset, &U::bitset>*);
 185
 186   template <typename U>
 187   static double test(...);
 188
 189 public:
 190   static bool const value = (sizeof(test<ScalarBitSetTraits<T> >(0)) == 1);
 191 };
 192
 193
 194 // Test if ScalarTraits<T> is defined on type T.
 195 template <class T>
 196 struct has_ScalarTraits
 197 {
 198   typedef StringRef (*Signature_input)(StringRef, void*, T&);
 199   typedef void (*Signature_output)(const T&, void*, llvm::raw_ostream&);
 200
 201   template <typename U>
 202   static char test(SameType<Signature_input, &U::input>*,
 203                    SameType<Signature_output, &U::output>*);
 204
 205   template <typename U>
 206   static double test(...);
 207
 208 public:
 209   static bool const value = (sizeof(test<ScalarTraits<T> >(0,0)) == 1);
 210 };
 211
 212
 213 // Test if MappingTraits<T> is defined on type T.
 214 template <class T>
 215 struct has_MappingTraits
 216 {
 217   typedef void (*Signature_mapping)(class IO&, T&);
 218
 219   template <typename U>
 220   static char test(SameType<Signature_mapping, &U::mapping>*);
 221
 222   template <typename U>
 223   static double test(...);
 224
 225 public:
 226   static bool const value = (sizeof(test<MappingTraits<T> >(0)) == 1);
 227 };
 228
 229
 230 // Test if SequenceTraits<T> is defined on type T.
 231 template <class T>
 232 struct has_SequenceMethodTraits
 233 {
 234   typedef size_t (*Signature_size)(class IO&, T&);
 235
 236   template <typename U>
 237   static char test(SameType<Signature_size, &U::size>*);
 238
 239   template <typename U>
 240   static double test(...);
 241
 242 public:
 243   static bool const value =  (sizeof(test<SequenceTraits<T> >(0)) == 1);
 244 };
 245
 246
 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>
 251 class has_FlowTraits
 252 {
 253 public:
 254    static const bool value = false;
 255 };
 256
 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.
 260 template <class T>
 261 struct has_FlowTraits<T, true>
 262 {
 263   struct Fallback { bool flow; };
 264   struct Derived : T, Fallback { };
 265
 266   template<typename C>
 267   static char (&f(SameType<bool Fallback::*, &C::flow>*))[1];
 268
 269   template<typename C>
 270   static char (&f(...))[2];
 271
 272 public:
 273   static bool const value = sizeof(f<Derived>(0)) == 2;
 274 };
 275
 276
 277
 278 // Test if SequenceTraits<T> is defined on type T
 279 template<typename T>
 280 struct has_SequenceTraits : public  llvm::integral_constant<bool,
 281                                       has_SequenceMethodTraits<T>::value > { };
 282
 283
 284 // Test if DocumentListTraits<T> is defined on type T
 285 template <class T>
 286 struct has_DocumentListTraits
 287 {
 288   typedef size_t (*Signature_size)(class IO&, T&);
 289
 290   template <typename U>
 291   static char test(SameType<Signature_size, &U::size>*);
 292
 293   template <typename U>
 294   static double test(...);
 295
 296 public:
 297   static bool const value =  (sizeof(test<DocumentListTraits<T> >(0)) == 1);
 298 };
 299
 300
 301
 302
 303 template<typename T>
 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 >  {};
 311
 312
 313 // Base class for Input and Output.
 314 class IO {
 315 public:
 316
 317   IO(void *Ctxt=NULL);
 318   virtual ~IO();
 319
 320   virtual bool outputting() = 0;
 321
 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;
 327
 328   virtual unsigned beginFlowSequence() = 0;
 329   virtual bool preflightFlowElement(unsigned, void *&) = 0;
 330   virtual void postflightFlowElement(void*) = 0;
 331   virtual void endFlowSequence() = 0;
 332
 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;
 337
 338   virtual void beginEnumScalar() = 0;
 339   virtual bool matchEnumScalar(const char*, bool) = 0;
 340   virtual void endEnumScalar() = 0;
 341
 342   virtual bool beginBitSetScalar(bool &) = 0;
 343   virtual bool bitSetMatch(const char*, bool) = 0;
 344   virtual void endBitSetScalar() = 0;
 345
 346   virtual void scalarString(StringRef &) = 0;
 347
 348   virtual void setError(const Twine &) = 0;
 349
 350   template <typename T>
 351   void enumCase(T &Val, const char* Str, const T ConstVal) {
 352     if ( matchEnumScalar(Str, outputting() && Val == ConstVal) ) {
 353       Val = ConstVal;
 354     }
 355   }
 356
 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)) ) {
 361       Val = ConstVal;
 362     }
 363   }
 364
 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;
 369     }
 370   }
 371
 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;
 377     }
 378   }
 379
 380   void *getContext();
 381   void setContext(void *);
 382
 383   template <typename T>
 384   void mapRequired(const char* Key, T& Val) {
 385     this->processKey(Key, Val, true);
 386   }
 387
 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()) )
 393       return;
 394     this->processKey(Key, Val, false);
 395   }
 396
 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);
 401   }
 402
 403   template <typename T>
 404   void mapOptional(const char* Key, T& Val, const T& Default) {
 405     this->processKeyWithDefault(Key, Val, Default, false);
 406   }
 407
 408
 409 private:
 410   template <typename T>
 411   void processKeyWithDefault(const char *Key, T &Val, const T& DefaultValue,
 412                                                                 bool Required) {
 413     void *SaveInfo;
 414     bool UseDefault;
 415     const bool sameAsDefault = outputting() && Val == DefaultValue;
 416     if ( this->preflightKey(Key, Required, sameAsDefault, UseDefault,
 417                                                                   SaveInfo) ) {
 418       yamlize(*this, Val, Required);
 419       this->postflightKey(SaveInfo);
 420     }
 421     else {
 422       if ( UseDefault )
 423         Val = DefaultValue;
 424     }
 425   }
 426
 427   template <typename T>
 428   void processKey(const char *Key, T &Val, bool Required) {
 429     void *SaveInfo;
 430     bool UseDefault;
 431     if ( this->preflightKey(Key, Required, false, UseDefault, SaveInfo) ) {
 432       yamlize(*this, Val, Required);
 433       this->postflightKey(SaveInfo);
 434     }
 435   }
 436
 437 private:
 438   void  *Ctxt;
 439 };
 440
 441
 442
 443 template<typename T>
 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);
 448   io.endEnumScalar();
 449 }
 450
 451 template<typename T>
 452 typename llvm::enable_if_c<has_ScalarBitSetTraits<T>::value,void>::type
 453 yamlize(IO &io, T &Val, bool) {
 454   bool DoClear;
 455   if ( io.beginBitSetScalar(DoClear) ) {
 456     if ( DoClear )
 457       Val = static_cast<T>(0);
 458     ScalarBitSetTraits<T>::bitset(io, Val);
 459     io.endBitSetScalar();
 460   }
 461 }
 462
 463
 464 template<typename T>
 465 typename llvm::enable_if_c<has_ScalarTraits<T>::value,void>::type
 466 yamlize(IO &io, T &Val, bool) {
 467   if ( io.outputting() ) {
 468     std::string Storage;
 469     llvm::raw_string_ostream Buffer(Storage);
 470     ScalarTraits<T>::output(Val, io.getContext(), Buffer);
 471     StringRef Str = Buffer.str();
 472     io.scalarString(Str);
 473   }
 474   else {
 475     StringRef 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));
 480     }
 481   }
 482 }
 483
 484
 485 template<typename T>
 486 typename llvm::enable_if_c<has_MappingTraits<T>::value, void>::type
 487 yamlize(IO &io, T &Val, bool) {
 488   io.beginMapping();
 489   MappingTraits<T>::mapping(io, Val);
 490   io.endMapping();
 491 }
 492
 493 template<typename T>
 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>)];
 497 }
 498
 499 template<typename 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) {
 506       void *SaveInfo;
 507       if ( io.preflightFlowElement(i, SaveInfo) ) {
 508         yamlize(io, SequenceTraits<T>::element(io, Seq, i), true);
 509         io.postflightFlowElement(SaveInfo);
 510       }
 511     }
 512     io.endFlowSequence();
 513   }
 514   else {
 515     unsigned incnt = io.beginSequence();
 516     unsigned count = io.outputting() ? SequenceTraits<T>::size(io, Seq) : incnt;
 517     for(unsigned i=0; i < count; ++i) {
 518       void *SaveInfo;
 519       if ( io.preflightElement(i, SaveInfo) ) {
 520         yamlize(io, SequenceTraits<T>::element(io, Seq, i), true);
 521         io.postflightElement(SaveInfo);
 522       }
 523     }
 524     io.endSequence();
 525   }
 526 }
 527
 528
 529 template<>
 530 struct ScalarTraits<bool> {
 531   static void output(const bool &, void*, llvm::raw_ostream &);
 532   static StringRef input(StringRef, void*, bool &);
 533 };
 534
 535 template<>
 536 struct ScalarTraits<StringRef> {
 537   static void output(const StringRef &, void*, llvm::raw_ostream &);
 538   static StringRef input(StringRef, void*, StringRef &);
 539 };
 540
 541 template<>
 542 struct ScalarTraits<std::string> {
 543   static void output(const std::string &, void*, llvm::raw_ostream &);
 544   static StringRef input(StringRef, void*, std::string &);
 545 };
 546
 547 template<>
 548 struct ScalarTraits<uint8_t> {
 549   static void output(const uint8_t &, void*, llvm::raw_ostream &);
 550   static StringRef input(StringRef, void*, uint8_t &);
 551 };
 552
 553 template<>
 554 struct ScalarTraits<uint16_t> {
 555   static void output(const uint16_t &, void*, llvm::raw_ostream &);
 556   static StringRef input(StringRef, void*, uint16_t &);
 557 };
 558
 559 template<>
 560 struct ScalarTraits<uint32_t> {
 561   static void output(const uint32_t &, void*, llvm::raw_ostream &);
 562   static StringRef input(StringRef, void*, uint32_t &);
 563 };
 564
 565 template<>
 566 struct ScalarTraits<uint64_t> {
 567   static void output(const uint64_t &, void*, llvm::raw_ostream &);
 568   static StringRef input(StringRef, void*, uint64_t &);
 569 };
 570
 571 template<>
 572 struct ScalarTraits<int8_t> {
 573   static void output(const int8_t &, void*, llvm::raw_ostream &);
 574   static StringRef input(StringRef, void*, int8_t &);
 575 };
 576
 577 template<>
 578 struct ScalarTraits<int16_t> {
 579   static void output(const int16_t &, void*, llvm::raw_ostream &);
 580   static StringRef input(StringRef, void*, int16_t &);
 581 };
 582
 583 template<>
 584 struct ScalarTraits<int32_t> {
 585   static void output(const int32_t &, void*, llvm::raw_ostream &);
 586   static StringRef input(StringRef, void*, int32_t &);
 587 };
 588
 589 template<>
 590 struct ScalarTraits<int64_t> {
 591   static void output(const int64_t &, void*, llvm::raw_ostream &);
 592   static StringRef input(StringRef, void*, int64_t &);
 593 };
 594
 595 template<>
 596 struct ScalarTraits<float> {
 597   static void output(const float &, void*, llvm::raw_ostream &);
 598   static StringRef input(StringRef, void*, float &);
 599 };
 600
 601 template<>
 602 struct ScalarTraits<double> {
 603   static void output(const double &, void*, llvm::raw_ostream &);
 604   static StringRef input(StringRef, void*, double &);
 605 };
 606
 607
 608
 609 // Utility for use within MappingTraits<>::mapping() method
 610 // to [de]normalize an object for use with YAML conversion.
 611 template <typename TNorm, typename TFinal>
 612 struct MappingNormalization {
 613   MappingNormalization(IO &i_o, TFinal &Obj)
 614       : io(i_o), BufPtr(NULL), Result(Obj) {
 615     if ( io.outputting() ) {
 616       BufPtr = new (&Buffer) TNorm(io, Obj);
 617     }
 618     else {
 619       BufPtr = new (&Buffer) TNorm(io);
 620     }
 621   }
 622
 623   ~MappingNormalization() {
 624     if ( ! io.outputting() ) {
 625       Result = BufPtr->denormalize(io);
 626     }
 627     BufPtr->~TNorm();
 628   }
 629
 630   TNorm* operator->() { return BufPtr; }
 631
 632 private:
 633   typedef llvm::AlignedCharArrayUnion<TNorm> Storage;
 634
 635   Storage       Buffer;
 636   IO           &io;
 637   TNorm        *BufPtr;
 638   TFinal       &Result;
 639 };
 640
 641
 642
 643 // Utility for use within MappingTraits<>::mapping() method
 644 // to [de]normalize an object for use with YAML conversion.
 645 template <typename TNorm, typename TFinal>
 646 struct MappingNormalizationHeap {
 647   MappingNormalizationHeap(IO &i_o, TFinal &Obj)
 648     : io(i_o), BufPtr(NULL), Result(Obj) {
 649     if ( io.outputting() ) {
 650       BufPtr = new (&Buffer) TNorm(io, Obj);
 651     }
 652     else {
 653       BufPtr = new TNorm(io);
 654     }
 655   }
 656
 657   ~MappingNormalizationHeap() {
 658     if ( io.outputting() ) {
 659       BufPtr->~TNorm();
 660     }
 661     else {
 662       Result = BufPtr->denormalize(io);
 663     }
 664   }
 665
 666   TNorm* operator->() { return BufPtr; }
 667
 668 private:
 669   typedef llvm::AlignedCharArrayUnion<TNorm> Storage;
 670
 671   Storage       Buffer;
 672   IO           &io;
 673   TNorm        *BufPtr;
 674   TFinal       &Result;
 675 };
 676
 677
 678
 679 ///
 680 /// The Input class is used to parse a yaml document into in-memory structs
 681 /// and vectors.
 682 ///
 683 /// It works by using YAMLParser to do a syntax parse of the entire yaml
 684 /// document, then the Input class builds a graph of HNodes which wraps
 685 /// each yaml Node.  The extra layer is buffering.  The low level yaml
 686 /// parser only lets you look at each node once.  The buffering layer lets
 687 /// you search and interate multiple times.  This is necessary because
 688 /// the mapRequired() method calls may not be in the same order
 689 /// as the keys in the document.
 690 ///
 691 class Input : public IO {
 692 public:
 693   // Construct a yaml Input object from a StringRef and optional user-data.
 694   Input(StringRef InputContent, void *Ctxt=NULL);
 695   ~Input();
 696
 697   // Check if there was an syntax or semantic error during parsing.
 698   llvm::error_code error();
 699
 700   // To set alternate error reporting.
 701   void setDiagHandler(llvm::SourceMgr::DiagHandlerTy Handler, void *Ctxt = 0);
 702
 703 private:
 704   virtual bool outputting();
 705   virtual void beginMapping();
 706   virtual void endMapping();
 707   virtual bool preflightKey(const char *, bool, bool, bool &, void *&);
 708   virtual void postflightKey(void *);
 709   virtual unsigned beginSequence();
 710   virtual void endSequence();
 711   virtual bool preflightElement(unsigned index, void *&);
 712   virtual void postflightElement(void *);
 713   virtual unsigned beginFlowSequence();
 714   virtual bool preflightFlowElement(unsigned , void *&);
 715   virtual void postflightFlowElement(void *);
 716   virtual void endFlowSequence();
 717   virtual void beginEnumScalar();
 718   virtual bool matchEnumScalar(const char*, bool);
 719   virtual void endEnumScalar();
 720   virtual bool beginBitSetScalar(bool &);
 721   virtual bool bitSetMatch(const char *, bool );
 722   virtual void endBitSetScalar();
 723   virtual void scalarString(StringRef &);
 724   virtual void setError(const Twine &message);
 725   virtual bool canElideEmptySequence();
 726
 727   class HNode {
 728   public:
 729     HNode(Node *n) : _node(n) { }
 730     virtual ~HNode() { }
 731     static inline bool classof(const HNode *) { return true; }
 732
 733     Node *_node;
 734   };
 735
 736   class EmptyHNode : public HNode {
 737   public:
 738     EmptyHNode(Node *n) : HNode(n) { }
 739     virtual ~EmptyHNode() {}
 740     static inline bool classof(const HNode *n) {
 741       return NullNode::classof(n->_node);
 742     }
 743     static inline bool classof(const EmptyHNode *) { return true; }
 744   };
 745
 746   class ScalarHNode : public HNode {
 747   public:
 748     ScalarHNode(Node *n, StringRef s) : HNode(n), _value(s) { }
 749     virtual ~ScalarHNode() { }
 750
 751     StringRef value() const { return _value; }
 752
 753     static inline bool classof(const HNode *n) {
 754       return ScalarNode::classof(n->_node);
 755     }
 756     static inline bool classof(const ScalarHNode *) { return true; }
 757   protected:
 758     StringRef _value;
 759   };
 760
 761   class MapHNode : public HNode {
 762   public:
 763     MapHNode(Node *n) : HNode(n) { }
 764     virtual ~MapHNode();
 765
 766     static inline bool classof(const HNode *n) {
 767       return MappingNode::classof(n->_node);
 768     }
 769     static inline bool classof(const MapHNode *) { return true; }
 770
 771     typedef llvm::StringMap<HNode*> NameToNode;
 772
 773     bool isValidKey(StringRef key);
 774
 775     NameToNode                        Mapping;
 776     llvm::SmallVector<const char*, 6> ValidKeys;
 777   };
 778
 779   class SequenceHNode : public HNode {
 780   public:
 781     SequenceHNode(Node *n) : HNode(n) { }
 782     virtual ~SequenceHNode();
 783
 784     static inline bool classof(const HNode *n) {
 785       return SequenceNode::classof(n->_node);
 786     }
 787     static inline bool classof(const SequenceHNode *) { return true; }
 788
 789     std::vector<HNode*> Entries;
 790   };
 791
 792   Input::HNode *createHNodes(Node *node);
 793   void setError(HNode *hnode, const Twine &message);
 794   void setError(Node *node, const Twine &message);
 795
 796
 797 public:
 798   // These are only used by operator>>. They could be private
 799   // if those templated things could be made friends.
 800   bool setCurrentDocument();
 801   void nextDocument();
 802
 803 private:
 804   llvm::SourceMgr                  SrcMgr; // must be before Strm
 805   OwningPtr<llvm::yaml::Stream>    Strm;
 806   OwningPtr<HNode>                 TopNode;
 807   llvm::error_code                 EC;
 808   llvm::BumpPtrAllocator           StringAllocator;
 809   llvm::yaml::document_iterator    DocIterator;
 810   std::vector<bool>                BitValuesUsed;
 811   HNode                           *CurrentNode;
 812   bool                             ScalarMatchFound;
 813 };
 814
 815
 816
 817
 818 ///
 819 /// The Output class is used to generate a yaml document from in-memory structs
 820 /// and vectors.
 821 ///
 822 class Output : public IO {
 823 public:
 824   Output(llvm::raw_ostream &, void *Ctxt=NULL);
 825   virtual ~Output();
 826
 827   virtual bool outputting();
 828   virtual void beginMapping();
 829   virtual void endMapping();
 830   virtual bool preflightKey(const char *key, bool, bool, bool &, void *&);
 831   virtual void postflightKey(void *);
 832   virtual unsigned beginSequence();
 833   virtual void endSequence();
 834   virtual bool preflightElement(unsigned, void *&);
 835   virtual void postflightElement(void *);
 836   virtual unsigned beginFlowSequence();
 837   virtual bool preflightFlowElement(unsigned, void *&);
 838   virtual void postflightFlowElement(void *);
 839   virtual void endFlowSequence();
 840   virtual void beginEnumScalar();
 841   virtual bool matchEnumScalar(const char*, bool);
 842   virtual void endEnumScalar();
 843   virtual bool beginBitSetScalar(bool &);
 844   virtual bool bitSetMatch(const char *, bool );
 845   virtual void endBitSetScalar();
 846   virtual void scalarString(StringRef &);
 847   virtual void setError(const Twine &message);
 848   virtual bool canElideEmptySequence();
 849 public:
 850   // These are only used by operator<<. They could be private
 851   // if that templated operator could be made a friend.
 852   void beginDocuments();
 853   bool preflightDocument(unsigned);
 854   void postflightDocument();
 855   void endDocuments();
 856
 857 private:
 858   void output(StringRef s);
 859   void outputUpToEndOfLine(StringRef s);
 860   void newLineCheck();
 861   void outputNewLine();
 862   void paddedKey(StringRef key);
 863
 864   enum InState { inSeq, inFlowSeq, inMapFirstKey, inMapOtherKey };
 865
 866   llvm::raw_ostream       &Out;
 867   SmallVector<InState, 8>  StateStack;
 868   int                      Column;
 869   int                      ColumnAtFlowStart;
 870   bool                     NeedBitValueComma;
 871   bool                     NeedFlowSequenceComma;
 872   bool                     EnumerationMatchFound;
 873   bool                     NeedsNewLine;
 874 };
 875
 876
 877
 878
 879 /// YAML I/O does conversion based on types. But often native data types
 880 /// are just a typedef of built in intergral types (e.g. int).  But the C++
 881 /// type matching system sees through the typedef and all the typedefed types
 882 /// look like a built in type. This will cause the generic YAML I/O conversion
 883 /// to be used. To provide better control over the YAML conversion, you can
 884 /// use this macro instead of typedef.  It will create a class with one field
 885 /// and automatic conversion operators to and from the base type.
 886 /// Based on BOOST_STRONG_TYPEDEF
 887 #define LLVM_YAML_STRONG_TYPEDEF(_base, _type)                                 \
 888     struct _type {                                                             \
 889         _type() { }                                                            \
 890         _type(const _base v) : value(v) { }                                    \
 891         _type(const _type &v) : value(v.value) {}                              \
 892         _type &operator=(const _type &rhs) { value = rhs.value; return *this; }\
 893         _type &operator=(const _base &rhs) { value = rhs; return *this; }      \
 894         operator const _base & () const { return value; }                      \
 895         bool operator==(const _type &rhs) const { return value == rhs.value; } \
 896         bool operator==(const _base &rhs) const { return value == rhs; }       \
 897         bool operator<(const _type &rhs) const { return value < rhs.value; }   \
 898         _base value;                                                           \
 899     };
 900
 901
 902
 903 ///
 904 /// Use these types instead of uintXX_t in any mapping to have
 905 /// its yaml output formatted as hexadecimal.
 906 ///
 907 LLVM_YAML_STRONG_TYPEDEF(uint8_t, Hex8)
 908 LLVM_YAML_STRONG_TYPEDEF(uint16_t, Hex16)
 909 LLVM_YAML_STRONG_TYPEDEF(uint32_t, Hex32)
 910 LLVM_YAML_STRONG_TYPEDEF(uint64_t, Hex64)
 911
 912
 913 template<>
 914 struct ScalarTraits<Hex8> {
 915   static void output(const Hex8 &, void*, llvm::raw_ostream &);
 916   static StringRef input(StringRef, void*, Hex8 &);
 917 };
 918
 919 template<>
 920 struct ScalarTraits<Hex16> {
 921   static void output(const Hex16 &, void*, llvm::raw_ostream &);
 922   static StringRef input(StringRef, void*, Hex16 &);
 923 };
 924
 925 template<>
 926 struct ScalarTraits<Hex32> {
 927   static void output(const Hex32 &, void*, llvm::raw_ostream &);
 928   static StringRef input(StringRef, void*, Hex32 &);
 929 };
 930
 931 template<>
 932 struct ScalarTraits<Hex64> {
 933   static void output(const Hex64 &, void*, llvm::raw_ostream &);
 934   static StringRef input(StringRef, void*, Hex64 &);
 935 };
 936
 937
 938 // Define non-member operator>> so that Input can stream in a document list.
 939 template <typename T>
 940 inline
 941 typename llvm::enable_if_c<has_DocumentListTraits<T>::value,Input &>::type
 942 operator>>(Input &yin, T &docList) {
 943   int i = 0;
 944   while ( yin.setCurrentDocument() ) {
 945     yamlize(yin, DocumentListTraits<T>::element(yin, docList, i), true);
 946     if ( yin.error() )
 947       return yin;
 948     yin.nextDocument();
 949     ++i;
 950   }
 951   return yin;
 952 }
 953
 954 // Define non-member operator>> so that Input can stream in a map as a document.
 955 template <typename T>
 956 inline
 957 typename llvm::enable_if_c<has_MappingTraits<T>::value,Input &>::type
 958 operator>>(Input &yin, T &docMap) {
 959   yin.setCurrentDocument();
 960   yamlize(yin, docMap, true);
 961   return yin;
 962 }
 963
 964 // Define non-member operator>> so that Input can stream in a sequence as
 965 // a document.
 966 template <typename T>
 967 inline
 968 typename llvm::enable_if_c<has_SequenceTraits<T>::value,Input &>::type
 969 operator>>(Input &yin, T &docSeq) {
 970   yin.setCurrentDocument();
 971   yamlize(yin, docSeq, true);
 972   return yin;
 973 }
 974
 975 // Provide better error message about types missing a trait specialization
 976 template <typename T>
 977 inline
 978 typename llvm::enable_if_c<missingTraits<T>::value,Input &>::type
 979 operator>>(Input &yin, T &docSeq) {
 980   char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
 981   return yin;
 982 }
 983
 984
 985 // Define non-member operator<< so that Output can stream out document list.
 986 template <typename T>
 987 inline
 988 typename llvm::enable_if_c<has_DocumentListTraits<T>::value,Output &>::type
 989 operator<<(Output &yout, T &docList) {
 990   yout.beginDocuments();
 991   const size_t count = DocumentListTraits<T>::size(yout, docList);
 992   for(size_t i=0; i < count; ++i) {
 993     if ( yout.preflightDocument(i) ) {
 994       yamlize(yout, DocumentListTraits<T>::element(yout, docList, i), true);
 995       yout.postflightDocument();
 996     }
 997   }
 998   yout.endDocuments();
 999   return yout;
1000 }
1001
1002 // Define non-member operator<< so that Output can stream out a map.
1003 template <typename T>
1004 inline
1005 typename llvm::enable_if_c<has_MappingTraits<T>::value,Output &>::type
1006 operator<<(Output &yout, T &map) {
1007   yout.beginDocuments();
1008   if ( yout.preflightDocument(0) ) {
1009     yamlize(yout, map, true);
1010     yout.postflightDocument();
1011   }
1012   yout.endDocuments();
1013   return yout;
1014 }
1015
1016 // Define non-member operator<< so that Output can stream out a sequence.
1017 template <typename T>
1018 inline
1019 typename llvm::enable_if_c<has_SequenceTraits<T>::value,Output &>::type
1020 operator<<(Output &yout, T &seq) {
1021   yout.beginDocuments();
1022   if ( yout.preflightDocument(0) ) {
1023     yamlize(yout, seq, true);
1024     yout.postflightDocument();
1025   }
1026   yout.endDocuments();
1027   return yout;
1028 }
1029
1030 // Provide better error message about types missing a trait specialization
1031 template <typename T>
1032 inline
1033 typename llvm::enable_if_c<missingTraits<T>::value,Output &>::type
1034 operator<<(Output &yout, T &seq) {
1035   char missing_yaml_trait_for_type[sizeof(MissingTrait<T>)];
1036   return yout;
1037 }
1038
1039
1040 } // namespace yaml
1041 } // namespace llvm
1042
1043
1044 /// Utility for declaring that a std::vector of a particular type
1045 /// should be considered a YAML sequence.
1046 #define LLVM_YAML_IS_SEQUENCE_VECTOR(_type)                                 \
1047   namespace llvm {                                                          \
1048   namespace yaml {                                                          \
1049     template<>                                                              \
1050     struct SequenceTraits< std::vector<_type> > {                           \
1051       static size_t size(IO &io, std::vector<_type> &seq) {                 \
1052         return seq.size();                                                  \
1053       }                                                                     \
1054       static _type& element(IO &io, std::vector<_type> &seq, size_t index) {\
1055         if ( index >= seq.size() )                                          \
1056           seq.resize(index+1);                                              \
1057         return seq[index];                                                  \
1058       }                                                                     \
1059     };                                                                      \
1060   }                                                                         \
1061   }
1062
1063 /// Utility for declaring that a std::vector of a particular type
1064 /// should be considered a YAML flow sequence.
1065 #define LLVM_YAML_IS_FLOW_SEQUENCE_VECTOR(_type)                            \
1066   namespace llvm {                                                          \
1067   namespace yaml {                                                          \
1068     template<>                                                              \
1069     struct SequenceTraits< std::vector<_type> > {                           \
1070       static size_t size(IO &io, std::vector<_type> &seq) {                 \
1071         return seq.size();                                                  \
1072       }                                                                     \
1073       static _type& element(IO &io, std::vector<_type> &seq, size_t index) {\
1074         if ( index >= seq.size() )                                          \
1075           seq.resize(index+1);                                              \
1076         return seq[index];                                                  \
1077       }                                                                     \
1078       static const bool flow = true;                                        \
1079     };                                                                      \
1080   }                                                                         \
1081   }
1082
1083 /// Utility for declaring that a std::vector of a particular type
1084 /// should be considered a YAML document list.
1085 #define LLVM_YAML_IS_DOCUMENT_LIST_VECTOR(_type)                            \
1086   namespace llvm {                                                          \
1087   namespace yaml {                                                          \
1088     template<>                                                              \
1089     struct DocumentListTraits< std::vector<_type> > {                       \
1090       static size_t size(IO &io, std::vector<_type> &seq) {                 \
1091         return seq.size();                                                  \
1092       }                                                                     \
1093       static _type& element(IO &io, std::vector<_type> &seq, size_t index) {\
1094         if ( index >= seq.size() )                                          \
1095           seq.resize(index+1);                                              \
1096         return seq[index];                                                  \
1097       }                                                                     \
1098     };                                                                      \
1099   }                                                                         \
1100   }
1101
1102
1103
1104 #endif // LLVM_SUPPORT_YAMLTRAITS_H