LLVM: llvm::remarks::Remark Struct Reference (original) (raw)

A remark type used for both emission and parsing. More...

#include "[llvm/Remarks/Remark.h](Remark%5F8h%5Fsource.html)"

Public Member Functions
Remark ()=default
Remark (Remark &&)=default
Remark & operator= (Remark &&)=default
LLVM_ABI std::string getArgsAsMsg () const
Return a message composed from the arguments as a string.
LLVM_ABI Argument * getArgByKey (StringRef Key)
Return the first argument with the specified key or nullptr if no such argument was found.
Remark clone () const
Clone this remark to explicitly ask for a copy.
LLVM_ABI void print (raw_ostream &OS) const
Implement operator<< on Remark.
Public Attributes
Type RemarkType = Type::Unknown
The type of the remark.
StringRef PassName
Name of the pass that triggers the emission of this remark.
StringRef RemarkName
Textual identifier for the remark (single-word, camel-case).
StringRef FunctionName
Mangled name of the function that triggers the emssion of this remark.
std::optional< RemarkLocation > Loc
The location in the source file of the remark.
std::optional< uint64_t > Hotness
If profile information is available, this is the number of times the corresponding code was executed in a profile instrumentation run.
SmallVector< Argument, 5 > Args
Arguments collected via the streaming interface.

A remark type used for both emission and parsing.

Definition at line 107 of file Remark.h.

◆ Remark() [1/2]

llvm::remarks::Remark::Remark ( ) default

◆ Remark() [2/2]

llvm::remarks::Remark::Remark ( Remark && ) default

References Remark().

◆ clone()

Remark llvm::remarks::Remark::clone ( ) const inline

Clone this remark to explicitly ask for a copy.

Definition at line 144 of file Remark.h.

References Remark().

◆ getArgByKey()

◆ getArgsAsMsg()

std::string Remark::getArgsAsMsg ( ) const

Return a message composed from the arguments as a string.

Definition at line 22 of file Remark.cpp.

References Args.

◆ operator=()

Remark & llvm::remarks::Remark::operator= ( Remark && ) default

◆ print()

◆ Args

◆ FunctionName

StringRef llvm::remarks::Remark::FunctionName

◆ Hotness

std::optional<uint64_t> llvm::remarks::Remark::Hotness

◆ Loc

◆ PassName

◆ RemarkName

◆ RemarkType

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