include/llvm/Support/YAMLParser.h

   1 //===--- YAMLParser.h - Simple YAML parser --------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This is a YAML 1.2 parser.
  11 //
  12 //  See http://www.yaml.org/spec/1.2/spec.html for the full standard.
  13 //
  14 //  This currently does not implement the following:
  15 //    * Multi-line literal folding.
  16 //    * Tag resolution.
  17 //    * UTF-16.
  18 //    * BOMs anywhere other than the first Unicode scalar value in the file.
  19 //
  20 //  The most important class here is Stream. This represents a YAML stream with
  21 //  0, 1, or many documents.
  22 //
  23 //  SourceMgr sm;
  24 //  StringRef input = getInput();
  25 //  yaml::Stream stream(input, sm);
  26 //
  27 //  for (yaml::document_iterator di = stream.begin(), de = stream.end();
  28 //       di != de; ++di) {
  29 //    yaml::Node *n = di->getRoot();
  30 //    if (n) {
  31 //      // Do something with n...
  32 //    } else
  33 //      break;
  34 //  }
  35 //
  36 //===----------------------------------------------------------------------===//
  37
  38 #ifndef LLVM_SUPPORT_YAMLPARSER_H
  39 #define LLVM_SUPPORT_YAMLPARSER_H
  40
  41 #include "llvm/ADT/SmallString.h"
  42 #include "llvm/ADT/StringRef.h"
  43 #include "llvm/Support/Allocator.h"
  44 #include "llvm/Support/SMLoc.h"
  45 #include <limits>
  46 #include <map>
  47 #include <utility>
  48
  49 namespace llvm {
  50 class MemoryBuffer;
  51 class SourceMgr;
  52 class raw_ostream;
  53 class Twine;
  54
  55 namespace yaml {
  56
  57 class document_iterator;
  58 class Document;
  59 class Node;
  60 class Scanner;
  61 struct Token;
  62
  63 /// @brief Dump all the tokens in this stream to OS.
  64 /// @returns true if there was an error, false otherwise.
  65 bool dumpTokens(StringRef Input, raw_ostream &);
  66
  67 /// @brief Scans all tokens in input without outputting anything. This is used
  68 ///        for benchmarking the tokenizer.
  69 /// @returns true if there was an error, false otherwise.
  70 bool scanTokens(StringRef Input);
  71
  72 /// @brief Escape \a Input for a double quoted scalar.
  73 std::string escape(StringRef Input);
  74
  75 /// @brief This class represents a YAML stream potentially containing multiple
  76 ///        documents.
  77 class Stream {
  78 public:
  79   /// @brief This keeps a reference to the string referenced by \p Input.
  80   Stream(StringRef Input, SourceMgr &);
  81
  82   /// @brief This takes ownership of \p InputBuffer.
  83   Stream(MemoryBuffer *InputBuffer, SourceMgr &);
  84   ~Stream();
  85
  86   document_iterator begin();
  87   document_iterator end();
  88   void skip();
  89   bool failed();
  90   bool validate() {
  91     skip();
  92     return !failed();
  93   }
  94
  95   void printError(Node *N, const Twine &Msg);
  96
  97 private:
  98   std::unique_ptr<Scanner> scanner;
  99   std::unique_ptr<Document> CurrentDoc;
 100
 101   friend class Document;
 102 };
 103
 104 /// @brief Abstract base class for all Nodes.
 105 class Node {
 106    virtual void anchor();
 107 public:
 108   enum NodeKind {
 109     NK_Null,
 110     NK_Scalar,
 111     NK_KeyValue,
 112     NK_Mapping,
 113     NK_Sequence,
 114     NK_Alias
 115   };
 116
 117   Node(unsigned int Type, std::unique_ptr<Document> &, StringRef Anchor,
 118        StringRef Tag);
 119
 120   /// @brief Get the value of the anchor attached to this node. If it does not
 121   ///        have one, getAnchor().size() will be 0.
 122   StringRef getAnchor() const { return Anchor; }
 123
 124   /// \brief Get the tag as it was written in the document. This does not
 125   ///   perform tag resolution.
 126   StringRef getRawTag() const { return Tag; }
 127
 128   /// \brief Get the verbatium tag for a given Node. This performs tag resoluton
 129   ///   and substitution.
 130   std::string getVerbatimTag() const;
 131
 132   SMRange getSourceRange() const { return SourceRange; }
 133   void setSourceRange(SMRange SR) { SourceRange = SR; }
 134
 135   // These functions forward to Document and Scanner.
 136   Token &peekNext();
 137   Token getNext();
 138   Node *parseBlockNode();
 139   BumpPtrAllocator &getAllocator();
 140   void setError(const Twine &Message, Token &Location) const;
 141   bool failed() const;
 142
 143   virtual void skip() {}
 144
 145   unsigned int getType() const { return TypeID; }
 146
 147   void *operator new ( size_t Size
 148                      , BumpPtrAllocator &Alloc
 149                      , size_t Alignment = 16) throw() {
 150     return Alloc.Allocate(Size, Alignment);
 151   }
 152
 153   void operator delete(void *Ptr, BumpPtrAllocator &Alloc, size_t) throw() {
 154     Alloc.Deallocate(Ptr);
 155   }
 156
 157 protected:
 158   std::unique_ptr<Document> &Doc;
 159   SMRange SourceRange;
 160
 161   void operator delete(void *) throw() {}
 162
 163   virtual ~Node() {}
 164
 165 private:
 166   unsigned int TypeID;
 167   StringRef Anchor;
 168   /// \brief The tag as typed in the document.
 169   StringRef Tag;
 170 };
 171
 172 /// @brief A null value.
 173 ///
 174 /// Example:
 175 ///   !!null null
 176 class NullNode : public Node {
 177   void anchor() override;
 178 public:
 179   NullNode(std::unique_ptr<Document> &D)
 180       : Node(NK_Null, D, StringRef(), StringRef()) {}
 181
 182   static inline bool classof(const Node *N) {
 183     return N->getType() == NK_Null;
 184   }
 185 };
 186
 187 /// @brief A scalar node is an opaque datum that can be presented as a
 188 ///        series of zero or more Unicode scalar values.
 189 ///
 190 /// Example:
 191 ///   Adena
 192 class ScalarNode : public Node {
 193   void anchor() override;
 194 public:
 195   ScalarNode(std::unique_ptr<Document> &D, StringRef Anchor, StringRef Tag,
 196              StringRef Val)
 197       : Node(NK_Scalar, D, Anchor, Tag), Value(Val) {
 198     SMLoc Start = SMLoc::getFromPointer(Val.begin());
 199     SMLoc End = SMLoc::getFromPointer(Val.end());
 200     SourceRange = SMRange(Start, End);
 201   }
 202
 203   // Return Value without any escaping or folding or other fun YAML stuff. This
 204   // is the exact bytes that are contained in the file (after conversion to
 205   // utf8).
 206   StringRef getRawValue() const { return Value; }
 207
 208   /// @brief Gets the value of this node as a StringRef.
 209   ///
 210   /// @param Storage is used to store the content of the returned StringRef iff
 211   ///        it requires any modification from how it appeared in the source.
 212   ///        This happens with escaped characters and multi-line literals.
 213   StringRef getValue(SmallVectorImpl<char> &Storage) const;
 214
 215   static inline bool classof(const Node *N) {
 216     return N->getType() == NK_Scalar;
 217   }
 218
 219 private:
 220   StringRef Value;
 221
 222   StringRef unescapeDoubleQuoted( StringRef UnquotedValue
 223                                 , StringRef::size_type Start
 224                                 , SmallVectorImpl<char> &Storage) const;
 225 };
 226
 227 /// @brief A key and value pair. While not technically a Node under the YAML
 228 ///        representation graph, it is easier to treat them this way.
 229 ///
 230 /// TODO: Consider making this not a child of Node.
 231 ///
 232 /// Example:
 233 ///   Section: .text
 234 class KeyValueNode : public Node {
 235   void anchor() override;
 236 public:
 237   KeyValueNode(std::unique_ptr<Document> &D)
 238     : Node(NK_KeyValue, D, StringRef(), StringRef()), Key(nullptr),
 239       Value(nullptr) {}
 240
 241   /// @brief Parse and return the key.
 242   ///
 243   /// This may be called multiple times.
 244   ///
 245   /// @returns The key, or nullptr if failed() == true.
 246   Node *getKey();
 247
 248   /// @brief Parse and return the value.
 249   ///
 250   /// This may be called multiple times.
 251   ///
 252   /// @returns The value, or nullptr if failed() == true.
 253   Node *getValue();
 254
 255   void skip() override {
 256     getKey()->skip();
 257     getValue()->skip();
 258   }
 259
 260   static inline bool classof(const Node *N) {
 261     return N->getType() == NK_KeyValue;
 262   }
 263
 264 private:
 265   Node *Key;
 266   Node *Value;
 267 };
 268
 269 /// @brief This is an iterator abstraction over YAML collections shared by both
 270 ///        sequences and maps.
 271 ///
 272 /// BaseT must have a ValueT* member named CurrentEntry and a member function
 273 /// increment() which must set CurrentEntry to 0 to create an end iterator.
 274 template <class BaseT, class ValueT>
 275 class basic_collection_iterator
 276   : public std::iterator<std::forward_iterator_tag, ValueT> {
 277 public:
 278   basic_collection_iterator() : Base(nullptr) {}
 279   basic_collection_iterator(BaseT *B) : Base(B) {}
 280
 281   ValueT *operator ->() const {
 282     assert(Base && Base->CurrentEntry && "Attempted to access end iterator!");
 283     return Base->CurrentEntry;
 284   }
 285
 286   ValueT &operator *() const {
 287     assert(Base && Base->CurrentEntry &&
 288            "Attempted to dereference end iterator!");
 289     return *Base->CurrentEntry;
 290   }
 291
 292   operator ValueT*() const {
 293     assert(Base && Base->CurrentEntry && "Attempted to access end iterator!");
 294     return Base->CurrentEntry;
 295   }
 296
 297   bool operator !=(const basic_collection_iterator &Other) const {
 298     if(Base != Other.Base)
 299       return true;
 300     return (Base && Other.Base) && Base->CurrentEntry
 301                                    != Other.Base->CurrentEntry;
 302   }
 303
 304   basic_collection_iterator &operator++() {
 305     assert(Base && "Attempted to advance iterator past end!");
 306     Base->increment();
 307     // Create an end iterator.
 308     if (!Base->CurrentEntry)
 309       Base = nullptr;
 310     return *this;
 311   }
 312
 313 private:
 314   BaseT *Base;
 315 };
 316
 317 // The following two templates are used for both MappingNode and Sequence Node.
 318 template <class CollectionType>
 319 typename CollectionType::iterator begin(CollectionType &C) {
 320   assert(C.IsAtBeginning && "You may only iterate over a collection once!");
 321   C.IsAtBeginning = false;
 322   typename CollectionType::iterator ret(&C);
 323   ++ret;
 324   return ret;
 325 }
 326
 327 template <class CollectionType>
 328 void skip(CollectionType &C) {
 329   // TODO: support skipping from the middle of a parsed collection ;/
 330   assert((C.IsAtBeginning || C.IsAtEnd) && "Cannot skip mid parse!");
 331   if (C.IsAtBeginning)
 332     for (typename CollectionType::iterator i = begin(C), e = C.end();
 333                                            i != e; ++i)
 334       i->skip();
 335 }
 336
 337 /// @brief Represents a YAML map created from either a block map for a flow map.
 338 ///
 339 /// This parses the YAML stream as increment() is called.
 340 ///
 341 /// Example:
 342 ///   Name: _main
 343 ///   Scope: Global
 344 class MappingNode : public Node {
 345   void anchor() override;
 346 public:
 347   enum MappingType {
 348     MT_Block,
 349     MT_Flow,
 350     MT_Inline ///< An inline mapping node is used for "[key: value]".
 351   };
 352
 353   MappingNode(std::unique_ptr<Document> &D, StringRef Anchor, StringRef Tag,
 354               MappingType MT)
 355       : Node(NK_Mapping, D, Anchor, Tag), Type(MT), IsAtBeginning(true),
 356         IsAtEnd(false), CurrentEntry(nullptr) {}
 357
 358   friend class basic_collection_iterator<MappingNode, KeyValueNode>;
 359   typedef basic_collection_iterator<MappingNode, KeyValueNode> iterator;
 360   template <class T> friend typename T::iterator yaml::begin(T &);
 361   template <class T> friend void yaml::skip(T &);
 362
 363   iterator begin() {
 364     return yaml::begin(*this);
 365   }
 366
 367   iterator end() { return iterator(); }
 368
 369   void skip() override {
 370     yaml::skip(*this);
 371   }
 372
 373   static inline bool classof(const Node *N) {
 374     return N->getType() == NK_Mapping;
 375   }
 376
 377 private:
 378   MappingType Type;
 379   bool IsAtBeginning;
 380   bool IsAtEnd;
 381   KeyValueNode *CurrentEntry;
 382
 383   void increment();
 384 };
 385
 386 /// @brief Represents a YAML sequence created from either a block sequence for a
 387 ///        flow sequence.
 388 ///
 389 /// This parses the YAML stream as increment() is called.
 390 ///
 391 /// Example:
 392 ///   - Hello
 393 ///   - World
 394 class SequenceNode : public Node {
 395   void anchor() override;
 396 public:
 397   enum SequenceType {
 398     ST_Block,
 399     ST_Flow,
 400     // Use for:
 401     //
 402     // key:
 403     // - val1
 404     // - val2
 405     //
 406     // As a BlockMappingEntry and BlockEnd are not created in this case.
 407     ST_Indentless
 408   };
 409
 410   SequenceNode(std::unique_ptr<Document> &D, StringRef Anchor, StringRef Tag,
 411                SequenceType ST)
 412       : Node(NK_Sequence, D, Anchor, Tag), SeqType(ST), IsAtBeginning(true),
 413         IsAtEnd(false),
 414         WasPreviousTokenFlowEntry(true), // Start with an imaginary ','.
 415         CurrentEntry(nullptr) {}
 416
 417   friend class basic_collection_iterator<SequenceNode, Node>;
 418   typedef basic_collection_iterator<SequenceNode, Node> iterator;
 419   template <class T> friend typename T::iterator yaml::begin(T &);
 420   template <class T> friend void yaml::skip(T &);
 421
 422   void increment();
 423
 424   iterator begin() {
 425     return yaml::begin(*this);
 426   }
 427
 428   iterator end() { return iterator(); }
 429
 430   void skip() override {
 431     yaml::skip(*this);
 432   }
 433
 434   static inline bool classof(const Node *N) {
 435     return N->getType() == NK_Sequence;
 436   }
 437
 438 private:
 439   SequenceType SeqType;
 440   bool IsAtBeginning;
 441   bool IsAtEnd;
 442   bool WasPreviousTokenFlowEntry;
 443   Node *CurrentEntry;
 444 };
 445
 446 /// @brief Represents an alias to a Node with an anchor.
 447 ///
 448 /// Example:
 449 ///   *AnchorName
 450 class AliasNode : public Node {
 451   void anchor() override;
 452 public:
 453   AliasNode(std::unique_ptr<Document> &D, StringRef Val)
 454       : Node(NK_Alias, D, StringRef(), StringRef()), Name(Val) {}
 455
 456   StringRef getName() const { return Name; }
 457   Node *getTarget();
 458
 459   static inline bool classof(const Node *N) {
 460     return N->getType() == NK_Alias;
 461   }
 462
 463 private:
 464   StringRef Name;
 465 };
 466
 467 /// @brief A YAML Stream is a sequence of Documents. A document contains a root
 468 ///        node.
 469 class Document {
 470 public:
 471   /// @brief Root for parsing a node. Returns a single node.
 472   Node *parseBlockNode();
 473
 474   Document(Stream &ParentStream);
 475
 476   /// @brief Finish parsing the current document and return true if there are
 477   ///        more. Return false otherwise.
 478   bool skip();
 479
 480   /// @brief Parse and return the root level node.
 481   Node *getRoot() {
 482     if (Root)
 483       return Root;
 484     return Root = parseBlockNode();
 485   }
 486
 487   const std::map<StringRef, StringRef> &getTagMap() const {
 488     return TagMap;
 489   }
 490
 491 private:
 492   friend class Node;
 493   friend class document_iterator;
 494
 495   /// @brief Stream to read tokens from.
 496   Stream &stream;
 497
 498   /// @brief Used to allocate nodes to. All are destroyed without calling their
 499   ///        destructor when the document is destroyed.
 500   BumpPtrAllocator NodeAllocator;
 501
 502   /// @brief The root node. Used to support skipping a partially parsed
 503   ///        document.
 504   Node *Root;
 505
 506   /// \brief Maps tag prefixes to their expansion.
 507   std::map<StringRef, StringRef> TagMap;
 508
 509   Token &peekNext();
 510   Token getNext();
 511   void setError(const Twine &Message, Token &Location) const;
 512   bool failed() const;
 513
 514   /// @brief Parse %BLAH directives and return true if any were encountered.
 515   bool parseDirectives();
 516
 517   /// \brief Parse %YAML
 518   void parseYAMLDirective();
 519
 520   /// \brief Parse %TAG
 521   void parseTAGDirective();
 522
 523   /// @brief Consume the next token and error if it is not \a TK.
 524   bool expectToken(int TK);
 525 };
 526
 527 /// @brief Iterator abstraction for Documents over a Stream.
 528 class document_iterator {
 529 public:
 530   document_iterator() : Doc(nullptr) {}
 531   document_iterator(std::unique_ptr<Document> &D) : Doc(&D) {}
 532
 533   bool operator ==(const document_iterator &Other) {
 534     if (isAtEnd() || Other.isAtEnd())
 535       return isAtEnd() && Other.isAtEnd();
 536
 537     return Doc == Other.Doc;
 538   }
 539   bool operator !=(const document_iterator &Other) {
 540     return !(*this == Other);
 541   }
 542
 543   document_iterator operator ++() {
 544     assert(Doc != 0 && "incrementing iterator past the end.");
 545     if (!(*Doc)->skip()) {
 546       Doc->reset(nullptr);
 547     } else {
 548       Stream &S = (*Doc)->stream;
 549       Doc->reset(new Document(S));
 550     }
 551     return *this;
 552   }
 553
 554   Document &operator *() {
 555     return *Doc->get();
 556   }
 557
 558   std::unique_ptr<Document> &operator->() { return *Doc; }
 559
 560 private:
 561   bool isAtEnd() const {
 562     return !Doc || !*Doc;
 563   }
 564
 565   std::unique_ptr<Document> *Doc;
 566 };
 567
 568 }
 569 }
 570
 571 #endif