struct YAMLRemarkSerializer

Declaration

struct YAMLRemarkSerializer : public RemarkSerializer { /* full declaration omitted */ };

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: - <KEY >: <VALUE > DebugLoc: { File: <FILE >, Line: <LINE >, Column: <COL > } ...

Declared at: llvm/include/llvm/Remarks/YAMLRemarkSerializer.h:33

Inherits from: RemarkSerializer

Member Variables

public yaml::Output YAMLOutput
The YAML streamer.

Inherited from RemarkSerializer:

public SerializerFormat
public OS
public Mode
public StrTab

Method Overview

  • public YAMLRemarkSerializer(llvm::raw_ostream & OS, llvm::remarks::SerializerMode Mode, Optional<llvm::remarks::StringTable> StrTab = None)
  • protected YAMLRemarkSerializer(llvm::remarks::Format SerializerFormat, llvm::raw_ostream & OS, llvm::remarks::SerializerMode Mode, Optional<llvm::remarks::StringTable> StrTab = None)
  • public static bool classof(const llvm::remarks::RemarkSerializer * S)
  • public void emit(const llvm::remarks::Remark & Remark)
  • public std::unique_ptr<MetaSerializer> metaSerializer(llvm::raw_ostream & OS, Optional<llvm::StringRef> ExternalFilename = None)

Inherited from RemarkSerializer:

Methods

YAMLRemarkSerializer(
    llvm::raw_ostream& OS,
    llvm::remarks::SerializerMode Mode,
    Optional<llvm::remarks::StringTable> StrTab =
        None)

Declared at: llvm/include/llvm/Remarks/YAMLRemarkSerializer.h:37

Parameters

llvm::raw_ostream& OS
llvm::remarks::SerializerMode Mode
Optional<llvm::remarks::StringTable> StrTab = None

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

Declared at: llvm/include/llvm/Remarks/YAMLRemarkSerializer.h:50

Parameters

llvm::remarks::Format SerializerFormat
llvm::raw_ostream& OS
llvm::remarks::SerializerMode Mode
Optional<llvm::remarks::StringTable> StrTab = None

static bool classof(
    const llvm::remarks::RemarkSerializer* S)

Declared at: llvm/include/llvm/Remarks/YAMLRemarkSerializer.h:45

Parameters

const llvm::remarks::RemarkSerializer* S

void emit(const llvm::remarks::Remark& Remark)

Description

Emit a remark to the stream.

Declared at: llvm/include/llvm/Remarks/YAMLRemarkSerializer.h:40

Parameters

const llvm::remarks::Remark& Remark

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

Description

Return the corresponding metadata serializer.

Declared at: llvm/include/llvm/Remarks/YAMLRemarkSerializer.h:42

Parameters

llvm::raw_ostream& OS
Optional<llvm::StringRef> ExternalFilename = None