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/StringRef.h"
  42 #include "llvm/Support/Allocator.h"
  43 #include "llvm/Support/SMLoc.h"
  44 #include <limits>
  45 #include <map>
  46 #include <utility>
  47
  48 namespace llvm {
  49 class MemoryBufferRef;
  50 class SourceMgr;
  51 class Twine;
  52 class raw_ostream;
  53
  54 namespace yaml {
  55
  56 class document_iterator;
  57 class Document;
  58 class Node;
  59 class Scanner;
  60 struct Token;
  61
  62 /// \brief Dump all the tokens in this stream to OS.
  63 /// \returns true if there was an error, false otherwise.
  64 bool dumpTokens(StringRef Input, raw_ostream &);
  65
  66 /// \brief Scans all tokens in input without outputting anything. This is used
  67 ///        for benchmarking the tokenizer.
  68 /// \returns true if there was an error, false otherwise.
  69 bool scanTokens(StringRef Input);
  70
  71 /// \brief Escape \a Input for a double quoted scalar.
  72 std::string escape(StringRef Input);
  73
  74 /// \brief This class represents a YAML stream potentially containing multiple
  75 ///        documents.
  76 class Stream {
  77 public:
  78   /// \brief This keeps a reference to the string referenced by \p Input.
  79   Stream(StringRef Input, SourceMgr &, bool ShowColors = true);
  80
  81   Stream(MemoryBufferRef InputBuffer, SourceMgr &, bool ShowColors = true);
  82   ~Stream();
  83
  84   document_iterator begin();
  85   document_iterator end();
  86   void skip();
  87   bool failed();
  88   bool validate() {
  89     skip();
  90     return !failed();
  91   }
  92
  93   void printError(Node *N, const Twine &Msg);
  94
  95 private:
  96   std::unique_ptr<Scanner> scanner;
  97   std::unique_ptr<Document> CurrentDoc;
  98
  99   friend class Document;
 100 };
 101
 102 /// \brief Abstract base class for all Nodes.
 103 class Node {
 104   virtual void anchor();
 105
 106 public:
 107   enum NodeKind {
 108     NK_Null,
 109     NK_Scalar,
 110     NK_KeyValue,
 111     NK_Mapping,
 112     NK_Sequence,
 113     NK_Alias
 114   };
 115
 116   Node(unsigned int Type, std::unique_ptr<Document> &, StringRef Anchor,
 117        StringRef Tag);
 118
 119   /// \brief Get the value of the anchor attached to this node. If it does not
 120   ///        have one, getAnchor().size() will be 0.
 121   StringRef getAnchor() const { return Anchor; }
 122
 123   /// \brief Get the tag as it was written in the document. This does not
 124   ///   perform tag resolution.
 125   StringRef getRawTag() const { return Tag; }
 126
 127   /// \brief Get the verbatium tag for a given Node. This performs tag resoluton
 128   ///   and substitution.
 129   std::string getVerbatimTag() const;
 130
 131   SMRange getSourceRange() const { return SourceRange; }
 132   void setSourceRange(SMRange SR) { SourceRange = SR; }
 133
 134   // These functions forward to Document and Scanner.
 135   Token &peekNext();
 136   Token getNext();
 137   Node *parseBlockNode();
 138   BumpPtrAllocator &getAllocator();
 139   void setError(const Twine &Message, Token &Location) const;
 140   bool failed() const;
 141
 142   virtual void skip() {}
 143
 144   unsigned int getType() const { return TypeID; }
 145
 146   void *operator new(size_t Size, BumpPtrAllocator &Alloc,
 147                      size_t Alignment = 16) throw() {
 148     return Alloc.Allocate(Size, Alignment);
 149   }
 150
 151   void operator delete(void *Ptr, BumpPtrAllocator &Alloc, size_t Size) throw() {
 152     Alloc.Deallocate(Ptr, Size);
 153   }
 154
 155 protected:
 156   std::unique_ptr<Document> &Doc;
 157   SMRange SourceRange;
 158
 159   void operator delete(void *) throw() {}
 160
 161   virtual ~Node() {}
 162
 163 private:
 164   unsigned int TypeID;
 165   StringRef Anchor;
 166   /// \brief The tag as typed in the document.
 167   StringRef Tag;
 168 };
 169
 170 /// \brief A null value.
 171 ///
 172 /// Example:
 173 ///   !!null null
 174 class NullNode : public Node {
 175   void anchor() override;
 176
 177 public:
 178   NullNode(std::unique_ptr<Document> &D)
 179       : Node(NK_Null, D, StringRef(), StringRef()) {}
 180
 181   static inline bool classof(const Node *N) { return N->getType() == NK_Null; }
 182 };
 183
 184 /// \brief A scalar node is an opaque datum that can be presented as a
 185 ///        series of zero or more Unicode scalar values.
 186 ///
 187 /// Example:
 188 ///   Adena
 189 class ScalarNode : public Node {
 190   void anchor() override;
 191
 192 public:
 193   ScalarNode(std::unique_ptr<Document> &D, StringRef Anchor, StringRef Tag,
 194              StringRef Val)
 195       : Node(NK_Scalar, D, Anchor, Tag), Value(Val) {
 196     SMLoc Start = SMLoc::getFromPointer(Val.begin());
 197     SMLoc End = SMLoc::getFromPointer(Val.end());
 198     SourceRange = SMRange(Start, End);
 199   }
 200
 201   // Return Value without any escaping or folding or other fun YAML stuff. This
 202   // is the exact bytes that are contained in the file (after conversion to
 203   // utf8).
 204   StringRef getRawValue() const { return Value; }
 205
 206   /// \brief Gets the value of this node as a StringRef.
 207   ///
 208   /// \param Storage is used to store the content of the returned StringRef iff
 209   ///        it requires any modification from how it appeared in the source.
 210   ///        This happens with escaped characters and multi-line literals.
 211   StringRef getValue(SmallVectorImpl<char> &Storage) const;
 212
 213   static inline bool classof(const Node *N) {
 214     return N->getType() == NK_Scalar;
 215   }
 216
 217 private:
 218   StringRef Value;
 219
 220   StringRef unescapeDoubleQuoted(StringRef UnquotedValue,
 221                                  StringRef::size_type Start,
 222                                  SmallVectorImpl<char> &Storage) const;
 223 };
 224
 225 /// \brief A key and value pair. While not technically a Node under the YAML
 226 ///        representation graph, it is easier to treat them this way.
 227 ///
 228 /// TODO: Consider making this not a child of Node.
 229 ///
 230 /// Example:
 231 ///   Section: .text
 232 class KeyValueNode : public Node {
 233   void anchor() override;
 234
 235 public:
 236   KeyValueNode(std::unique_ptr<Document> &D)
 237       : Node(NK_KeyValue, D, StringRef(), StringRef()), Key(nullptr),
 238         Value(nullptr) {}
 239
 240   /// \brief Parse and return the key.
 241   ///
 242   /// This may be called multiple times.
 243   ///
 244   /// \returns The key, or nullptr if failed() == true.
 245   Node *getKey();
 246
 247   /// \brief Parse and return the value.
 248   ///
 249   /// This may be called multiple times.
 250   ///
 251   /// \returns The value, or nullptr if failed() == true.
 252   Node *getValue();
 253
 254   void skip() override {
 255     getKey()->skip();
 256     if (Node *Val = getValue())
 257       Val->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) &&
 301            Base->CurrentEntry != 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> void skip(CollectionType &C) {
 328   // TODO: support skipping from the middle of a parsed collection ;/
 329   assert((C.IsAtBeginning || C.IsAtEnd) && "Cannot skip mid parse!");
 330   if (C.IsAtBeginning)
 331     for (typename CollectionType::iterator i = begin(C), e = C.end(); i != e;
 332          ++i)
 333       i->skip();
 334 }
 335
 336 /// \brief Represents a YAML map created from either a block map for a flow map.
 337 ///
 338 /// This parses the YAML stream as increment() is called.
 339 ///
 340 /// Example:
 341 ///   Name: _main
 342 ///   Scope: Global
 343 class MappingNode : public Node {
 344   void anchor() override;
 345
 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() { return yaml::begin(*this); }
 364
 365   iterator end() { return iterator(); }
 366
 367   void skip() override { yaml::skip(*this); }
 368
 369   static inline bool classof(const Node *N) {
 370     return N->getType() == NK_Mapping;
 371   }
 372
 373 private:
 374   MappingType Type;
 375   bool IsAtBeginning;
 376   bool IsAtEnd;
 377   KeyValueNode *CurrentEntry;
 378
 379   void increment();
 380 };
 381
 382 /// \brief Represents a YAML sequence created from either a block sequence for a
 383 ///        flow sequence.
 384 ///
 385 /// This parses the YAML stream as increment() is called.
 386 ///
 387 /// Example:
 388 ///   - Hello
 389 ///   - World
 390 class SequenceNode : public Node {
 391   void anchor() override;
 392
 393 public:
 394   enum SequenceType {
 395     ST_Block,
 396     ST_Flow,
 397     // Use for:
 398     //
 399     // key:
 400     // - val1
 401     // - val2
 402     //
 403     // As a BlockMappingEntry and BlockEnd are not created in this case.
 404     ST_Indentless
 405   };
 406
 407   SequenceNode(std::unique_ptr<Document> &D, StringRef Anchor, StringRef Tag,
 408                SequenceType ST)
 409       : Node(NK_Sequence, D, Anchor, Tag), SeqType(ST), IsAtBeginning(true),
 410         IsAtEnd(false),
 411         WasPreviousTokenFlowEntry(true), // Start with an imaginary ','.
 412         CurrentEntry(nullptr) {}
 413
 414   friend class basic_collection_iterator<SequenceNode, Node>;
 415   typedef basic_collection_iterator<SequenceNode, Node> iterator;
 416   template <class T> friend typename T::iterator yaml::begin(T &);
 417   template <class T> friend void yaml::skip(T &);
 418
 419   void increment();
 420
 421   iterator begin() { return yaml::begin(*this); }
 422
 423   iterator end() { return iterator(); }
 424
 425   void skip() override { yaml::skip(*this); }
 426
 427   static inline bool classof(const Node *N) {
 428     return N->getType() == NK_Sequence;
 429   }
 430
 431 private:
 432   SequenceType SeqType;
 433   bool IsAtBeginning;
 434   bool IsAtEnd;
 435   bool WasPreviousTokenFlowEntry;
 436   Node *CurrentEntry;
 437 };
 438
 439 /// \brief Represents an alias to a Node with an anchor.
 440 ///
 441 /// Example:
 442 ///   *AnchorName
 443 class AliasNode : public Node {
 444   void anchor() override;
 445
 446 public:
 447   AliasNode(std::unique_ptr<Document> &D, StringRef Val)
 448       : Node(NK_Alias, D, StringRef(), StringRef()), Name(Val) {}
 449
 450   StringRef getName() const { return Name; }
 451   Node *getTarget();
 452
 453   static inline bool classof(const Node *N) { return N->getType() == NK_Alias; }
 454
 455 private:
 456   StringRef Name;
 457 };
 458
 459 /// \brief A YAML Stream is a sequence of Documents. A document contains a root
 460 ///        node.
 461 class Document {
 462 public:
 463   /// \brief Root for parsing a node. Returns a single node.
 464   Node *parseBlockNode();
 465
 466   Document(Stream &ParentStream);
 467
 468   /// \brief Finish parsing the current document and return true if there are
 469   ///        more. Return false otherwise.
 470   bool skip();
 471
 472   /// \brief Parse and return the root level node.
 473   Node *getRoot() {
 474     if (Root)
 475       return Root;
 476     return Root = parseBlockNode();
 477   }
 478
 479   const std::map<StringRef, StringRef> &getTagMap() const { return TagMap; }
 480
 481 private:
 482   friend class Node;
 483   friend class document_iterator;
 484
 485   /// \brief Stream to read tokens from.
 486   Stream &stream;
 487
 488   /// \brief Used to allocate nodes to. All are destroyed without calling their
 489   ///        destructor when the document is destroyed.
 490   BumpPtrAllocator NodeAllocator;
 491
 492   /// \brief The root node. Used to support skipping a partially parsed
 493   ///        document.
 494   Node *Root;
 495
 496   /// \brief Maps tag prefixes to their expansion.
 497   std::map<StringRef, StringRef> TagMap;
 498
 499   Token &peekNext();
 500   Token getNext();
 501   void setError(const Twine &Message, Token &Location) const;
 502   bool failed() const;
 503
 504   /// \brief Parse %BLAH directives and return true if any were encountered.
 505   bool parseDirectives();
 506
 507   /// \brief Parse %YAML
 508   void parseYAMLDirective();
 509
 510   /// \brief Parse %TAG
 511   void parseTAGDirective();
 512
 513   /// \brief Consume the next token and error if it is not \a TK.
 514   bool expectToken(int TK);
 515 };
 516
 517 /// \brief Iterator abstraction for Documents over a Stream.
 518 class document_iterator {
 519 public:
 520   document_iterator() : Doc(nullptr) {}
 521   document_iterator(std::unique_ptr<Document> &D) : Doc(&D) {}
 522
 523   bool operator==(const document_iterator &Other) {
 524     if (isAtEnd() || Other.isAtEnd())
 525       return isAtEnd() && Other.isAtEnd();
 526
 527     return Doc == Other.Doc;
 528   }
 529   bool operator!=(const document_iterator &Other) { return !(*this == Other); }
 530
 531   document_iterator operator++() {
 532     assert(Doc && "incrementing iterator past the end.");
 533     if (!(*Doc)->skip()) {
 534       Doc->reset(nullptr);
 535     } else {
 536       Stream &S = (*Doc)->stream;
 537       Doc->reset(new Document(S));
 538     }
 539     return *this;
 540   }
 541
 542   Document &operator*() { return *Doc->get(); }
 543
 544   std::unique_ptr<Document> &operator->() { return *Doc; }
 545
 546 private:
 547   bool isAtEnd() const { return !Doc || !*Doc; }
 548
 549   std::unique_ptr<Document> *Doc;
 550 };
 551
 552 } // End namespace yaml.
 553
 554 } // End namespace llvm.
 555
 556 #endif