Parser used to parse a raw buffer to remarks::Remark objects. More...

#include "llvm/Remarks/RemarkParser.h"

Inheritance diagram for llvm::remarks::RemarkParser:

[legend]

Public Member Functions
	RemarkParser (Format ParserFormat)

virtual Expected< std::unique_ptr< Remark > >	next ()=0
	If no error occurs, this returns a valid Remark object.

virtual	~RemarkParser ()=default

Public Attributes
Format	ParserFormat
	The format of the parser.

std::string	ExternalFilePrependPath
	Path to prepend when opening an external remark file.

Detailed Description

Parser used to parse a raw buffer to remarks::Remark objects.

Definition at line 40 of file RemarkParser.h.

Constructor & Destructor Documentation

◆ RemarkParser()

llvm::remarks::RemarkParser::RemarkParser ( Format ParserFormat )

inline

Definition at line 46 of file RemarkParser.h.

◆ ~RemarkParser()

virtual llvm::remarks::RemarkParser::~RemarkParser ( )

virtualdefault

Member Function Documentation

◆ next()

virtual Expected< std::unique_ptr< Remark > > llvm::remarks::RemarkParser::next ( )

pure virtual

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.

Implemented in llvm::remarks::BitstreamRemarkParser, and llvm::remarks::YAMLRemarkParser.

Referenced by llvm::remarks::RemarkLinker::link(), and LLVMRemarkParserGetNext().

Member Data Documentation

◆ ExternalFilePrependPath

std::string llvm::remarks::RemarkParser::ExternalFilePrependPath

Path to prepend when opening an external remark file.

Definition at line 44 of file RemarkParser.h.

◆ ParserFormat

Format llvm::remarks::RemarkParser::ParserFormat

The format of the parser.

Definition at line 42 of file RemarkParser.h.

The documentation for this struct was generated from the following file:

include/llvm/Remarks/RemarkParser.h

Public Member Functions

Public Attributes