Regular YAML to Remark parser. More...

#include "Remarks/YAMLRemarkParser.h"

Inheritance diagram for llvm::remarks::YAMLRemarkParser:

Public Member Functions
	YAMLRemarkParser (StringRef Buf)
Expected< std::unique_ptr< Remark > >	next () override
	If no error occurs, this returns a valid Remark object.
Public Member Functions inherited from llvm::remarks::RemarkParser
	RemarkParser (Format ParserFormat)
virtual	~RemarkParser ()=default

Static Public Member Functions
static bool	classof (const RemarkParser *P)

Public Attributes
std::string	LastErrorMessage
	Last error message that can come from the YAML parser diagnostics.
SourceMgr	SM
	Source manager for better error messages.
yaml::Stream	Stream
	Stream for yaml parsing.
yaml::document_iterator	YAMLIt
	Iterator in the YAML stream.
std::unique_ptr< MemoryBuffer >	SeparateBuf
	If we parse remark metadata in separate mode, we need to open a new file and parse that.
Public Attributes inherited from llvm::remarks::RemarkParser
Format	ParserFormat
	The format of the parser.
std::string	ExternalFilePrependPath
	Path to prepend when opening an external remark file.

Protected Member Functions
Error	error ()
	Create a YAMLParseError error from an existing error generated by the YAML parser.
Error	error (StringRef Message, yaml::Node &Node)
	Create a YAMLParseError error referencing a specific node.
Expected< std::unique_ptr< Remark > >	parseRemark (yaml::Document &Remark)
	Parse a YAML remark to a remarks::Remark object.
Expected< Type >	parseType (yaml::MappingNode &Node)
	Parse the type of a remark to an enum type.
Expected< StringRef >	parseKey (yaml::KeyValueNode &Node)
	Parse one key to a string.
virtual Expected< StringRef >	parseStr (yaml::KeyValueNode &Node)
	Parse one value to a string.
Expected< unsigned >	parseUnsigned (yaml::KeyValueNode &Node)
	Parse one value to an unsigned.
Expected< RemarkLocation >	parseDebugLoc (yaml::KeyValueNode &Node)
	Parse a debug location.
Expected< Argument >	parseArg (yaml::Node &Node)
	Parse an argument.

Detailed Description

Regular YAML to Remark parser.

Definition at line 48 of file YAMLRemarkParser.h.

Constructor & Destructor Documentation

◆ YAMLRemarkParser()

YAMLRemarkParser::YAMLRemarkParser ( StringRef Buf )

Definition at line 147 of file YAMLRemarkParser.cpp.

References LastErrorMessage, llvm::remarks::RemarkParser::RemarkParser(), setupSM(), SM, Stream, llvm::remarks::YAML, and YAMLIt.

Member Function Documentation

◆ classof()

bool llvm::remarks::YAMLRemarkParser::classof ( const RemarkParser * P )

inlinestatic

Definition at line 66 of file YAMLRemarkParser.h.

References P, llvm::remarks::RemarkParser::RemarkParser(), and llvm::remarks::YAML.

◆ error() [1/2]

Error YAMLRemarkParser::error ( )

protected

Create a YAMLParseError error from an existing error generated by the YAML parser.

If there is no error, this returns Success.

Definition at line 155 of file YAMLRemarkParser.cpp.

References LastErrorMessage, llvm::make_error(), and llvm::Error::success().

Referenced by parseArg(), parseDebugLoc(), parseKey(), parseRemark(), parseStr(), parseType(), and parseUnsigned().

◆ error() [2/2]

Error YAMLRemarkParser::error	(	StringRef	Message,
		yaml::Node &	Node )

protected

Create a YAMLParseError error referencing a specific node.

Definition at line 151 of file YAMLRemarkParser.cpp.

References llvm::make_error(), SM, and Stream.

◆ next()

Expected< std::unique_ptr< Remark > > YAMLRemarkParser::next ( )

overridevirtual

If no error occurs, this returns a valid Remark object.

If an error of type EndOfFileError occurs, it is safe to recover from it by stopping the parsing. If any other error occurs, it should be propagated to the user. The pointer should never be null.

Implements llvm::remarks::RemarkParser.

Definition at line 391 of file YAMLRemarkParser.cpp.

References llvm::make_error(), parseRemark(), Stream, llvm::Expected< T >::takeError(), and YAMLIt.