LLVM 19.0.0git
Public Member Functions | Friends | List of all members
llvm::yaml::Document Class Reference

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

#include "llvm/Support/YAMLParser.h"

Public Member Functions

 Document (Stream &ParentStream)
 
NodeparseBlockNode ()
 Root for parsing a node. Returns a single node.
 
bool skip ()
 Finish parsing the current document and return true if there are more.
 
NodegetRoot ()
 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 536 of file YAMLParser.h.

Constructor & Destructor Documentation

◆ Document()

Document::Document ( Stream ParentStream)

Definition at line 2469 of file YAMLParser.cpp.

References 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 548 of file YAMLParser.h.

References parseBlockNode().

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

◆ getTagMap()

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

Definition at line 554 of file YAMLParser.h.

◆ parseBlockNode()

Node * Document::parseBlockNode ( )

◆ 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(), llvm::yaml::Node::skip(), skip(), llvm::yaml::Token::TK_DocumentEnd, and llvm::yaml::Token::TK_StreamEnd.

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

Friends And Related Function Documentation

◆ document_iterator

friend class document_iterator
friend

Definition at line 558 of file YAMLParser.h.

◆ Node

friend class Node
friend

Definition at line 557 of file YAMLParser.h.


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