class RemarkStreamer

Declaration

class RemarkStreamer { /* full declaration omitted */ };

Declared at: llvm/include/llvm/Remarks/RemarkStreamer.h:44

Member Variables

private Optional<llvm::Regex> PassFilter

The regex used to filter remarks based on the passes that emit them.

private std::unique_ptr<remarks::RemarkSerializer> RemarkSerializer

The object used to serialize the remarks to a specific format.

private const Optional<std::string> Filename

The filename that the remark diagnostics are emitted to.

Method Overview

• public RemarkStreamer(std::unique_ptr<remarks::RemarkSerializer> RemarkSerializer, Optional<llvm::StringRef> Filename = None)
• public Optional<llvm::StringRef> getFilename() const
• public remarks::RemarkSerializer & getSerializer()
• public llvm::raw_ostream & getStream()
• public bool matchesFilter(llvm::StringRef Str)
• public bool needsSection() const
• public llvm::Error setFilter(llvm::StringRef Filter)

Methods

¶RemarkStreamer(
    std::unique_ptr<remarks::RemarkSerializer>
        RemarkSerializer,
    Optional<llvm::StringRef> Filename = None)

Declared at: llvm/include/llvm/Remarks/RemarkStreamer.h:53

Parameters

std::unique_ptr<remarks::RemarkSerializer> RemarkSerializer

Optional<llvm::StringRef> Filename = None

¶Optional<llvm::StringRef> getFilename() const

Description

Return the filename that the remark diagnostics are emitted to.

Declared at: llvm/include/llvm/Remarks/RemarkStreamer.h:57

¶remarks::RemarkSerializer& getSerializer()

Description

Return the serializer used for this stream.

Declared at: llvm/include/llvm/Remarks/RemarkStreamer.h:63

¶llvm::raw_ostream& getStream()

Description

Return stream that the remark diagnostics are emitted to.

Declared at: llvm/include/llvm/Remarks/RemarkStreamer.h:61

¶bool matchesFilter(llvm::StringRef Str)

Description

Check wether the string matches the filter.

Declared at: llvm/include/llvm/Remarks/RemarkStreamer.h:68

Parameters

llvm::StringRef Str

¶bool needsSection() const

Description

Check if the remarks also need to have associated metadata in a section.

Declared at: llvm/include/llvm/Remarks/RemarkStreamer.h:70

¶llvm::Error setFilter(llvm::StringRef Filter)

Description

Set a pass filter based on a regex \p Filter. Returns an error if the regex is invalid.

Declared at: llvm/include/llvm/Remarks/RemarkStreamer.h:66

Parameters

llvm::StringRef Filter