llvm::yaml::Document Class Reference

A YAML Stream is a sequence of Documents. More...

#include "llvm/Support/YAMLParser.h"

Public Member Functions
LLVM_ABI	Document (Stream &ParentStream)
LLVM_ABI Node *	parseBlockNode ()
	Root for parsing a node. Returns a single node.
LLVM_ABI bool	skip ()
	Finish parsing the current document and return true if there are more.
Node *	getRoot ()
	Parse and return the root level node.
const std::map< StringRef, StringRef > &	getTagMap () const

Friends
class	Node
class	document_iterator

Detailed Description

A YAML Stream is a sequence of Documents.

A document contains a root node.

Definition at line 538 of file YAMLParser.h.

Constructor & Destructor Documentation

Document()

Document::Document

(

Stream &

ParentStream

)

Definition at line 2469 of file YAMLParser.cpp.

References T, and llvm::yaml::Token::TK_DocumentStart.

Member Function Documentation

getRoot()

Node * llvm::yaml::Document::getRoot ( )

inline

Parse and return the root level node.

Definition at line 550 of file YAMLParser.h.

References Node, and parseBlockNode().

Referenced by llvm::remarks::YAMLRemarkParser::parseRemark(), and skip().

getTagMap()

const std::map< StringRef, StringRef > & llvm::yaml::Document::getTagMap ( ) const

inline

Definition at line 556 of file YAMLParser.h.

parseBlockNode()

Node * Document::parseBlockNode

(

)

Root for parsing a node. Returns a single node.

Definition at line 2513 of file YAMLParser.cpp.

References llvm::StringRef::copy(), llvm::StringRef::drop_back(), llvm::isa(), llvm::yaml::Token::Kind, llvm_unreachable, llvm::yaml::MappingNode::MT_Block, llvm::yaml::MappingNode::MT_Flow, llvm::yaml::MappingNode::MT_Inline, Node, llvm::yaml::Token::Range, llvm::yaml::SequenceNode::ST_Block, llvm::yaml::SequenceNode::ST_Flow, llvm::yaml::SequenceNode::ST_Indentless, llvm::StringRef::substr(), T, llvm::yaml::Token::TK_Alias, llvm::yaml::Token::TK_Anchor, llvm::yaml::Token::TK_BlockEntry, llvm::yaml::Token::TK_BlockMappingStart, llvm::yaml::Token::TK_BlockScalar, llvm::yaml::Token::TK_BlockSequenceStart, llvm::yaml::Token::TK_DocumentEnd, llvm::yaml::Token::TK_DocumentStart, llvm::yaml::Token::TK_Error, llvm::yaml::Token::TK_FlowEntry, llvm::yaml::Token::TK_FlowMappingEnd, llvm::yaml::Token::TK_FlowMappingStart, llvm::yaml::Token::TK_FlowSequenceEnd, llvm::yaml::Token::TK_FlowSequenceStart, llvm::yaml::Token::TK_Key, llvm::yaml::Token::TK_Scalar, llvm::yaml::Token::TK_StreamEnd, and llvm::yaml::Token::TK_Tag.

Referenced by getRoot().

skip()

bool Document::skip

(

)

Finish parsing the current document and return true if there are more.

Return false otherwise.

Definition at line 2481 of file YAMLParser.cpp.

References getRoot(), skip(), T, llvm::yaml::Token::TK_DocumentEnd, and llvm::yaml::Token::TK_StreamEnd.

Referenced by skip(), and llvm::yaml::Stream::skip().

Friends And Related Symbol Documentation

document_iterator

friend class document_iterator

friend

Definition at line 560 of file YAMLParser.h.

References document_iterator, and Node.

Referenced by document_iterator.

Node

friend class Node

friend

Definition at line 559 of file YAMLParser.h.

References Node.

Referenced by document_iterator, getRoot(), Node, and parseBlockNode().

---

The documentation for this class was generated from the following files:

• include/llvm/Support/YAMLParser.h
• lib/Support/YAMLParser.cpp