LLVM  10.0.0svn
Public Member Functions | Public Attributes | List of all members
llvm::remarks::Serializer Struct Referenceabstract

This is the base class for a remark serializer. More...

#include "llvm/Remarks/RemarkSerializer.h"

Inheritance diagram for llvm::remarks::Serializer:
Inheritance graph
[legend]
Collaboration diagram for llvm::remarks::Serializer:
Collaboration graph
[legend]

Public Member Functions

 Serializer (raw_ostream &OS)
 
virtual ~Serializer ()=default
 This is just an interface. More...
 
virtual void emit (const Remark &Remark)=0
 

Public Attributes

raw_ostreamOS
 The open raw_ostream that the remark diagnostics are emitted to. More...
 
Optional< StringTableStrTab
 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 25 of file RemarkSerializer.h.

Constructor & Destructor Documentation

◆ Serializer()

llvm::remarks::Serializer::Serializer ( raw_ostream OS)
inline

Definition at line 32 of file RemarkSerializer.h.

References emit(), and ~Serializer().

◆ ~Serializer()

virtual llvm::remarks::Serializer::~Serializer ( )
virtualdefault

This is just an interface.

Referenced by Serializer().

Member Function Documentation

◆ emit()

virtual void llvm::remarks::Serializer::emit ( const Remark Remark)
pure virtual

Implemented in llvm::remarks::YAMLSerializer.

Referenced by Serializer().

Member Data Documentation

◆ OS

raw_ostream& llvm::remarks::Serializer::OS

The open raw_ostream that the remark diagnostics are emitted to.

Definition at line 27 of file RemarkSerializer.h.

◆ StrTab

Optional<StringTable> llvm::remarks::Serializer::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 30 of file RemarkSerializer.h.

Referenced by llvm::AsmPrinter::emitRemarksSection(), and llvm::remarks::YAMLStrTabSerializer::YAMLStrTabSerializer().


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