1 //===--- YAMLParser.h - Simple YAML parser --------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is a YAML 1.2 parser.
12 // See http://www.yaml.org/spec/1.2/spec.html for the full standard.
14 // This currently does not implement the following:
15 // * Multi-line literal folding.
18 // * BOMs anywhere other than the first Unicode scalar value in the file.
20 // The most important class here is Stream. This represents a YAML stream with
21 // 0, 1, or many documents.
24 // StringRef input = getInput();
25 // yaml::Stream stream(input, sm);
27 // for (yaml::document_iterator di = stream.begin(), de = stream.end();
29 // yaml::Node *n = di->getRoot();
31 // // Do something with n...
36 //===----------------------------------------------------------------------===//
38 #ifndef LLVM_SUPPORT_YAMLPARSER_H
39 #define LLVM_SUPPORT_YAMLPARSER_H
41 #include "llvm/ADT/StringRef.h"
42 #include "llvm/Support/Allocator.h"
43 #include "llvm/Support/SMLoc.h"
48 class MemoryBufferRef;
55 class document_iterator;
61 /// \brief Dump all the tokens in this stream to OS.
62 /// \returns true if there was an error, false otherwise.
63 bool dumpTokens(StringRef Input, raw_ostream &);
65 /// \brief Scans all tokens in input without outputting anything. This is used
66 /// for benchmarking the tokenizer.
67 /// \returns true if there was an error, false otherwise.
68 bool scanTokens(StringRef Input);
70 /// \brief Escape \a Input for a double quoted scalar.
71 std::string escape(StringRef Input);
73 /// \brief This class represents a YAML stream potentially containing multiple
77 /// \brief This keeps a reference to the string referenced by \p Input.
78 Stream(StringRef Input, SourceMgr &, bool ShowColors = true);
80 Stream(MemoryBufferRef InputBuffer, SourceMgr &, bool ShowColors = true);
83 document_iterator begin();
84 document_iterator end();
92 void printError(Node *N, const Twine &Msg);
95 std::unique_ptr<Scanner> scanner;
96 std::unique_ptr<Document> CurrentDoc;
98 friend class Document;
101 /// \brief Abstract base class for all Nodes.
103 virtual void anchor();
116 Node(unsigned int Type, std::unique_ptr<Document> &, StringRef Anchor,
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; }
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; }
127 /// \brief Get the verbatium tag for a given Node. This performs tag resoluton
128 /// and substitution.
129 std::string getVerbatimTag() const;
131 SMRange getSourceRange() const { return SourceRange; }
132 void setSourceRange(SMRange SR) { SourceRange = SR; }
134 // These functions forward to Document and Scanner.
137 Node *parseBlockNode();
138 BumpPtrAllocator &getAllocator();
139 void setError(const Twine &Message, Token &Location) const;
142 virtual void skip() {}
144 unsigned int getType() const { return TypeID; }
146 void *operator new(size_t Size, BumpPtrAllocator &Alloc,
147 size_t Alignment = 16) LLVM_NOEXCEPT {
148 return Alloc.Allocate(Size, Alignment);
151 void operator delete(void *Ptr, BumpPtrAllocator &Alloc,
152 size_t Size) LLVM_NOEXCEPT {
153 Alloc.Deallocate(Ptr, Size);
157 std::unique_ptr<Document> &Doc;
160 void operator delete(void *) LLVM_NOEXCEPT = delete;
167 /// \brief The tag as typed in the document.
171 /// \brief A null value.
175 class NullNode final : public Node {
176 void anchor() override;
179 NullNode(std::unique_ptr<Document> &D)
180 : Node(NK_Null, D, StringRef(), StringRef()) {}
182 static inline bool classof(const Node *N) { return N->getType() == NK_Null; }
185 /// \brief A scalar node is an opaque datum that can be presented as a
186 /// series of zero or more Unicode scalar values.
190 class ScalarNode final : public Node {
191 void anchor() override;
194 ScalarNode(std::unique_ptr<Document> &D, StringRef Anchor, StringRef Tag,
196 : Node(NK_Scalar, D, Anchor, Tag), Value(Val) {
197 SMLoc Start = SMLoc::getFromPointer(Val.begin());
198 SMLoc End = SMLoc::getFromPointer(Val.end());
199 SourceRange = SMRange(Start, End);
202 // Return Value without any escaping or folding or other fun YAML stuff. This
203 // is the exact bytes that are contained in the file (after conversion to
205 StringRef getRawValue() const { return Value; }
207 /// \brief Gets the value of this node as a StringRef.
209 /// \param Storage is used to store the content of the returned StringRef iff
210 /// it requires any modification from how it appeared in the source.
211 /// This happens with escaped characters and multi-line literals.
212 StringRef getValue(SmallVectorImpl<char> &Storage) const;
214 static inline bool classof(const Node *N) {
215 return N->getType() == NK_Scalar;
221 StringRef unescapeDoubleQuoted(StringRef UnquotedValue,
222 StringRef::size_type Start,
223 SmallVectorImpl<char> &Storage) const;
226 /// \brief A block scalar node is an opaque datum that can be presented as a
227 /// series of zero or more Unicode scalar values.
233 class BlockScalarNode final : public Node {
234 void anchor() override;
237 BlockScalarNode(std::unique_ptr<Document> &D, StringRef Anchor, StringRef Tag,
238 StringRef Value, StringRef RawVal)
239 : Node(NK_BlockScalar, D, Anchor, Tag), Value(Value) {
240 SMLoc Start = SMLoc::getFromPointer(RawVal.begin());
241 SMLoc End = SMLoc::getFromPointer(RawVal.end());
242 SourceRange = SMRange(Start, End);
245 /// \brief Gets the value of this node as a StringRef.
246 StringRef getValue() const { return Value; }
248 static inline bool classof(const Node *N) {
249 return N->getType() == NK_BlockScalar;
256 /// \brief A key and value pair. While not technically a Node under the YAML
257 /// representation graph, it is easier to treat them this way.
259 /// TODO: Consider making this not a child of Node.
263 class KeyValueNode final : public Node {
264 void anchor() override;
267 KeyValueNode(std::unique_ptr<Document> &D)
268 : Node(NK_KeyValue, D, StringRef(), StringRef()), Key(nullptr),
271 /// \brief Parse and return the key.
273 /// This may be called multiple times.
275 /// \returns The key, or nullptr if failed() == true.
278 /// \brief Parse and return the value.
280 /// This may be called multiple times.
282 /// \returns The value, or nullptr if failed() == true.
285 void skip() override {
287 if (Node *Val = getValue())
291 static inline bool classof(const Node *N) {
292 return N->getType() == NK_KeyValue;
300 /// \brief This is an iterator abstraction over YAML collections shared by both
301 /// sequences and maps.
303 /// BaseT must have a ValueT* member named CurrentEntry and a member function
304 /// increment() which must set CurrentEntry to 0 to create an end iterator.
305 template <class BaseT, class ValueT>
306 class basic_collection_iterator
307 : public std::iterator<std::input_iterator_tag, ValueT> {
309 basic_collection_iterator() : Base(nullptr) {}
310 basic_collection_iterator(BaseT *B) : Base(B) {}
312 ValueT *operator->() const {
313 assert(Base && Base->CurrentEntry && "Attempted to access end iterator!");
314 return Base->CurrentEntry;
317 ValueT &operator*() const {
318 assert(Base && Base->CurrentEntry &&
319 "Attempted to dereference end iterator!");
320 return *Base->CurrentEntry;
323 operator ValueT *() const {
324 assert(Base && Base->CurrentEntry && "Attempted to access end iterator!");
325 return Base->CurrentEntry;
328 /// Note on EqualityComparable:
330 /// The iterator is not re-entrant,
331 /// it is meant to be used for parsing YAML on-demand
332 /// Once iteration started - it can point only to one entry at a time
333 /// hence Base.CurrentEntry and Other.Base.CurrentEntry are equal
334 /// iff Base and Other.Base are equal.
335 bool operator==(const basic_collection_iterator &Other) const {
336 if (Base && (Base == Other.Base)) {
337 assert((Base->CurrentEntry == Other.Base->CurrentEntry)
338 && "Equal Bases expected to point to equal Entries");
341 return Base == Other.Base;
344 bool operator!=(const basic_collection_iterator &Other) const {
345 return !(Base == Other.Base);
348 basic_collection_iterator &operator++() {
349 assert(Base && "Attempted to advance iterator past end!");
351 // Create an end iterator.
352 if (!Base->CurrentEntry)
361 // The following two templates are used for both MappingNode and Sequence Node.
362 template <class CollectionType>
363 typename CollectionType::iterator begin(CollectionType &C) {
364 assert(C.IsAtBeginning && "You may only iterate over a collection once!");
365 C.IsAtBeginning = false;
366 typename CollectionType::iterator ret(&C);
371 template <class CollectionType> void skip(CollectionType &C) {
372 // TODO: support skipping from the middle of a parsed collection ;/
373 assert((C.IsAtBeginning || C.IsAtEnd) && "Cannot skip mid parse!");
375 for (typename CollectionType::iterator i = begin(C), e = C.end(); i != e;
380 /// \brief Represents a YAML map created from either a block map for a flow map.
382 /// This parses the YAML stream as increment() is called.
387 class MappingNode final : public Node {
388 void anchor() override;
394 MT_Inline ///< An inline mapping node is used for "[key: value]".
397 MappingNode(std::unique_ptr<Document> &D, StringRef Anchor, StringRef Tag,
399 : Node(NK_Mapping, D, Anchor, Tag), Type(MT), IsAtBeginning(true),
400 IsAtEnd(false), CurrentEntry(nullptr) {}
402 friend class basic_collection_iterator<MappingNode, KeyValueNode>;
403 typedef basic_collection_iterator<MappingNode, KeyValueNode> iterator;
404 template <class T> friend typename T::iterator yaml::begin(T &);
405 template <class T> friend void yaml::skip(T &);
407 iterator begin() { return yaml::begin(*this); }
409 iterator end() { return iterator(); }
411 void skip() override { yaml::skip(*this); }
413 static inline bool classof(const Node *N) {
414 return N->getType() == NK_Mapping;
421 KeyValueNode *CurrentEntry;
426 /// \brief Represents a YAML sequence created from either a block sequence for a
429 /// This parses the YAML stream as increment() is called.
434 class SequenceNode final : public Node {
435 void anchor() override;
447 // As a BlockMappingEntry and BlockEnd are not created in this case.
451 SequenceNode(std::unique_ptr<Document> &D, StringRef Anchor, StringRef Tag,
453 : Node(NK_Sequence, D, Anchor, Tag), SeqType(ST), IsAtBeginning(true),
455 WasPreviousTokenFlowEntry(true), // Start with an imaginary ','.
456 CurrentEntry(nullptr) {}
458 friend class basic_collection_iterator<SequenceNode, Node>;
459 typedef basic_collection_iterator<SequenceNode, Node> iterator;
460 template <class T> friend typename T::iterator yaml::begin(T &);
461 template <class T> friend void yaml::skip(T &);
465 iterator begin() { return yaml::begin(*this); }
467 iterator end() { return iterator(); }
469 void skip() override { yaml::skip(*this); }
471 static inline bool classof(const Node *N) {
472 return N->getType() == NK_Sequence;
476 SequenceType SeqType;
479 bool WasPreviousTokenFlowEntry;
483 /// \brief Represents an alias to a Node with an anchor.
487 class AliasNode final : public Node {
488 void anchor() override;
491 AliasNode(std::unique_ptr<Document> &D, StringRef Val)
492 : Node(NK_Alias, D, StringRef(), StringRef()), Name(Val) {}
494 StringRef getName() const { return Name; }
497 static inline bool classof(const Node *N) { return N->getType() == NK_Alias; }
503 /// \brief A YAML Stream is a sequence of Documents. A document contains a root
507 /// \brief Root for parsing a node. Returns a single node.
508 Node *parseBlockNode();
510 Document(Stream &ParentStream);
512 /// \brief Finish parsing the current document and return true if there are
513 /// more. Return false otherwise.
516 /// \brief Parse and return the root level node.
520 return Root = parseBlockNode();
523 const std::map<StringRef, StringRef> &getTagMap() const { return TagMap; }
527 friend class document_iterator;
529 /// \brief Stream to read tokens from.
532 /// \brief Used to allocate nodes to. All are destroyed without calling their
533 /// destructor when the document is destroyed.
534 BumpPtrAllocator NodeAllocator;
536 /// \brief The root node. Used to support skipping a partially parsed
540 /// \brief Maps tag prefixes to their expansion.
541 std::map<StringRef, StringRef> TagMap;
545 void setError(const Twine &Message, Token &Location) const;
548 /// \brief Parse %BLAH directives and return true if any were encountered.
549 bool parseDirectives();
551 /// \brief Parse %YAML
552 void parseYAMLDirective();
554 /// \brief Parse %TAG
555 void parseTAGDirective();
557 /// \brief Consume the next token and error if it is not \a TK.
558 bool expectToken(int TK);
561 /// \brief Iterator abstraction for Documents over a Stream.
562 class document_iterator {
564 document_iterator() : Doc(nullptr) {}
565 document_iterator(std::unique_ptr<Document> &D) : Doc(&D) {}
567 bool operator==(const document_iterator &Other) {
568 if (isAtEnd() || Other.isAtEnd())
569 return isAtEnd() && Other.isAtEnd();
571 return Doc == Other.Doc;
573 bool operator!=(const document_iterator &Other) { return !(*this == Other); }
575 document_iterator operator++() {
576 assert(Doc && "incrementing iterator past the end.");
577 if (!(*Doc)->skip()) {
580 Stream &S = (*Doc)->stream;
581 Doc->reset(new Document(S));
586 Document &operator*() { return *Doc->get(); }
588 std::unique_ptr<Document> &operator->() { return *Doc; }
591 bool isAtEnd() const { return !Doc || !*Doc; }
593 std::unique_ptr<Document> *Doc;
596 } // End namespace yaml.
598 } // End namespace llvm.