LLVM: llvm::remarks::BitstreamRemarkSerializer Struct Reference (original) (raw)

Implementation of the remark serializer using LLVM bitstream. More...

#include "[llvm/Remarks/BitstreamRemarkSerializer.h](BitstreamRemarkSerializer%5F8h%5Fsource.html)"

Public Member Functions
	BitstreamRemarkSerializer (raw_ostream &OS)
	Construct a serializer that will create its own string table.
	BitstreamRemarkSerializer (raw_ostream &OS, StringTable StrTab)
	Construct a serializer with a pre-filled string table.
	~BitstreamRemarkSerializer () override
void	emit (const Remark &Remark) override
	Emit a remark to the stream.
void	finalize () override
	Finalize emission of remarks.
std::unique_ptr< MetaSerializer >	metaSerializer (raw_ostream &OS, StringRef ExternalFilename) override
	The metadata serializer associated to this remark serializer.
Public Member Functions inherited from llvm::remarks::RemarkSerializer
	RemarkSerializer (Format SerializerFormat, raw_ostream &OS)
virtual	~RemarkSerializer ()=default

Public Attributes
std::optional< BitstreamRemarkSerializerHelper >	Helper
	The file should contain: 1) The block info block that describes how to read the blocks.
Public Attributes inherited from llvm::remarks::RemarkSerializer
Format	SerializerFormat
	The format of the serializer.
raw_ostream &	OS
	The open raw_ostream that the remark diagnostics are emitted to.
std::optional< StringTable >	StrTab
	The string table containing all the unique strings used in the output.

Implementation of the remark serializer using LLVM bitstream.

BitstreamRemarkSerializer::BitstreamRemarkSerializer	(	raw_ostream &	OS	)

◆ BitstreamRemarkSerializer() [2/2]

BitstreamRemarkSerializer::~BitstreamRemarkSerializer ( )	override

void BitstreamRemarkSerializer::emit ( const Remark & Remark)	overridevirtual

void BitstreamRemarkSerializer::finalize ( )	overridevirtual

The file should contain: 1) The block info block that describes how to read the blocks.

The metadata block that contains various information about the remarks in the file. 3) A number of remark blocks. 4) Another metadata block for metadata that is only finalized once all remarks were emitted (e.g. StrTab) The helper to emit bitstream. This is nullopt when the Serializer has not been setup yet.

Referenced by emit(), and finalize().

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