This is the base class for a remark serializer. More...
#include "llvm/Remarks/RemarkSerializer.h"
Public Member Functions | |
| RemarkSerializer (Format SerializerFormat, raw_ostream &OS, SerializerMode Mode) | |
| virtual | ~RemarkSerializer ()=default |
| This is just an interface. More... | |
| virtual void | emit (const Remark &Remark)=0 |
| Emit a remark to the stream. More... | |
| virtual std::unique_ptr< MetaSerializer > | metaSerializer (raw_ostream &OS, std::optional< StringRef > ExternalFilename=std::nullopt)=0 |
| Return the corresponding metadata serializer. More... | |
Public Attributes | |
| Format | SerializerFormat |
| The format of the serializer. More... | |
| raw_ostream & | OS |
| The open raw_ostream that the remark diagnostics are emitted to. More... | |
| SerializerMode | Mode |
| The serialization mode. More... | |
| std::optional< StringTable > | StrTab |
| The string table containing all the unique strings used in the output. More... | |
Detailed Description
This is the base class for a remark serializer.
It includes support for using a string table while emitting.
Definition at line 42 of file RemarkSerializer.h.
Constructor & Destructor Documentation
◆ RemarkSerializer()
|
inline |
Definition at line 53 of file RemarkSerializer.h.
◆ ~RemarkSerializer()
|
virtualdefault |
This is just an interface.
Member Function Documentation
◆ emit()
Emit a remark to the stream.
Implemented in llvm::remarks::BitstreamRemarkSerializer, llvm::remarks::YAMLStrTabRemarkSerializer, and llvm::remarks::YAMLRemarkSerializer.
Referenced by llvm::LLVMRemarkStreamer::emit().
◆ metaSerializer()
|
pure virtual |
Return the corresponding metadata serializer.
Implemented in llvm::remarks::BitstreamRemarkSerializer, llvm::remarks::YAMLStrTabRemarkSerializer, and llvm::remarks::YAMLRemarkSerializer.
Referenced by llvm::AsmPrinter::emitRemarksSection().
Member Data Documentation
◆ Mode
| SerializerMode llvm::remarks::RemarkSerializer::Mode |
The serialization mode.
Definition at line 48 of file RemarkSerializer.h.
Referenced by llvm::remarks::BitstreamRemarkSerializer::BitstreamRemarkSerializer(), llvm::remarks::YAMLStrTabRemarkSerializer::emit(), and llvm::remarks::RemarkStreamer::needsSection().
◆ OS
| raw_ostream& llvm::remarks::RemarkSerializer::OS |
The open raw_ostream that the remark diagnostics are emitted to.
Definition at line 46 of file RemarkSerializer.h.
Referenced by llvm::remarks::YAMLStrTabRemarkSerializer::emit(), llvm::remarks::BitstreamRemarkSerializer::emit(), llvm::remarks::RemarkStreamer::getStream(), llvm::remarks::YAMLRemarkSerializer::metaSerializer(), llvm::remarks::YAMLStrTabRemarkSerializer::metaSerializer(), and llvm::remarks::BitstreamRemarkSerializer::metaSerializer().
◆ SerializerFormat
| Format llvm::remarks::RemarkSerializer::SerializerFormat |
The format of the serializer.
Definition at line 44 of file RemarkSerializer.h.
Referenced by llvm::remarks::RemarkStreamer::needsSection().
◆ StrTab
| std::optional<StringTable> llvm::remarks::RemarkSerializer::StrTab |
The string table containing all the unique strings used in the output.
The table can be serialized to be consumed after the compilation.
Definition at line 51 of file RemarkSerializer.h.
Referenced by llvm::remarks::BitstreamRemarkSerializer::BitstreamRemarkSerializer(), llvm::remarks::BitstreamRemarkSerializer::emit(), llvm::remarks::YAMLStrTabRemarkSerializer::metaSerializer(), llvm::remarks::BitstreamRemarkSerializer::metaSerializer(), llvm::remarks::YAMLRemarkSerializer::YAMLRemarkSerializer(), and llvm::remarks::YAMLStrTabRemarkSerializer::YAMLStrTabRemarkSerializer().
The documentation for this struct was generated from the following file:
- include/llvm/Remarks/RemarkSerializer.h
