LLVM  12.0.0git
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
llvm::remarks::YAMLRemarkSerializer Struct Reference

Serialize the remarks to YAML. More...

#include "llvm/Remarks/YAMLRemarkSerializer.h"

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

Public Member Functions

 YAMLRemarkSerializer (raw_ostream &OS, SerializerMode Mode, Optional< StringTable > StrTab=None)
 
void emit (const Remark &Remark) override
 Emit a remark to the stream. More...
 
std::unique_ptr< MetaSerializermetaSerializer (raw_ostream &OS, Optional< StringRef > ExternalFilename=None) override
 Return the corresponding metadata serializer. More...
 
- Public Member Functions inherited from llvm::remarks::RemarkSerializer
 RemarkSerializer (Format SerializerFormat, raw_ostream &OS, SerializerMode Mode)
 
virtual ~RemarkSerializer ()=default
 This is just an interface. More...
 

Static Public Member Functions

static bool classof (const RemarkSerializer *S)
 

Public Attributes

yaml::Output YAMLOutput
 The YAML streamer. More...
 
- Public Attributes inherited from llvm::remarks::RemarkSerializer
Format SerializerFormat
 The format of the serializer. More...
 
raw_ostreamOS
 The open raw_ostream that the remark diagnostics are emitted to. More...
 
SerializerMode Mode
 The serialization mode. More...
 
Optional< StringTableStrTab
 The string table containing all the unique strings used in the output. More...
 

Protected Member Functions

 YAMLRemarkSerializer (Format SerializerFormat, raw_ostream &OS, SerializerMode Mode, Optional< StringTable > StrTab=None)
 

Detailed Description

Serialize the remarks to YAML.

One remark entry looks like this: — !<TYPE> Pass: <PASSNAME> Name: <REMARKNAME> DebugLoc: { File: <SOURCEFILENAME>, Line: <SOURCELINE>, Column: <SOURCECOLUMN> } Function: <FUNCTIONNAME> Args:

DebugLoc: { File: <FILE>, Line: <LINE>, Column: <COL> } ...

Definition at line 33 of file YAMLRemarkSerializer.h.

Constructor & Destructor Documentation

◆ YAMLRemarkSerializer() [1/2]

YAMLRemarkSerializer::YAMLRemarkSerializer ( raw_ostream OS,
SerializerMode  Mode,
Optional< StringTable StrTab = None 
)

Definition at line 161 of file YAMLRemarkSerializer.cpp.

Referenced by classof().

◆ YAMLRemarkSerializer() [2/2]

YAMLRemarkSerializer::YAMLRemarkSerializer ( Format  SerializerFormat,
raw_ostream OS,
SerializerMode  Mode,
Optional< StringTable StrTab = None 
)
protected

Definition at line 165 of file YAMLRemarkSerializer.cpp.

References llvm::remarks::RemarkSerializer::StrTab.

Member Function Documentation

◆ classof()

static bool llvm::remarks::YAMLRemarkSerializer::classof ( const RemarkSerializer S)
inlinestatic

◆ emit()

void YAMLRemarkSerializer::emit ( const Remark Remark)
overridevirtual

◆ metaSerializer()

std::unique_ptr< MetaSerializer > YAMLRemarkSerializer::metaSerializer ( raw_ostream OS,
Optional< StringRef ExternalFilename = None 
)
overridevirtual

Member Data Documentation

◆ YAMLOutput

yaml::Output llvm::remarks::YAMLRemarkSerializer::YAMLOutput

The YAML streamer.

Definition at line 35 of file YAMLRemarkSerializer.h.

Referenced by emit().


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