MLIR  16.0.0git
Public Member Functions | List of all members
mlir::InFlightDiagnostic Class Reference

This class represents a diagnostic that is inflight and set to be reported. More...

#include "mlir/IR/Diagnostics.h"

Public Member Functions

 InFlightDiagnostic ()=default
 
 InFlightDiagnostic (InFlightDiagnostic &&rhs)
 
 ~InFlightDiagnostic ()
 
template<typename Arg >
InFlightDiagnosticoperator<< (Arg &&arg) &
 Stream operator for new diagnostic arguments. More...
 
template<typename Arg >
InFlightDiagnostic && operator<< (Arg &&arg) &&
 
template<typename... Args>
InFlightDiagnosticappend (Args &&...args) &
 Append arguments to the diagnostic. More...
 
template<typename... Args>
InFlightDiagnostic && append (Args &&...args) &&
 
DiagnosticattachNote (Optional< Location > noteLoc=llvm::None)
 Attaches a note to this diagnostic. More...
 
DiagnosticgetUnderlyingDiagnostic ()
 Returns the underlying diagnostic or nullptr if this diagnostic isn't active. More...
 
void report ()
 Reports the diagnostic to the engine. More...
 
void abandon ()
 Abandons this diagnostic so that it will no longer be reported. More...
 
 operator LogicalResult () const
 Allow an inflight diagnostic to be converted to 'failure', otherwise 'success' if this is an empty diagnostic. More...
 
 operator ParseResult () const
 Allow an inflight diagnostic to be converted to 'failure', otherwise 'success' if this is an empty diagnostic. More...
 
template<typename T >
 operator FailureOr< T > () const
 Allow an inflight diagnostic to be converted to FailureOr<T>. More...
 

Detailed Description

This class represents a diagnostic that is inflight and set to be reported.

This allows for last minute modifications of the diagnostic before it is emitted by a DiagnosticEngine.

Definition at line 307 of file Diagnostics.h.

Constructor & Destructor Documentation

◆ InFlightDiagnostic() [1/2]

mlir::InFlightDiagnostic::InFlightDiagnostic ( )
default

◆ InFlightDiagnostic() [2/2]

mlir::InFlightDiagnostic::InFlightDiagnostic ( InFlightDiagnostic &&  rhs)
inline

Definition at line 310 of file Diagnostics.h.

◆ ~InFlightDiagnostic()

mlir::InFlightDiagnostic::~InFlightDiagnostic ( )
inline

Definition at line 316 of file Diagnostics.h.

References report().

Member Function Documentation

◆ abandon()

void InFlightDiagnostic::abandon ( )

Abandons this diagnostic so that it will no longer be reported.

Abandons this diagnostic.

Definition at line 216 of file Diagnostics.cpp.

◆ append() [1/2]

template<typename... Args>
InFlightDiagnostic& mlir::InFlightDiagnostic::append ( Args &&...  args) &
inline

◆ append() [2/2]

template<typename... Args>
InFlightDiagnostic&& mlir::InFlightDiagnostic::append ( Args &&...  args) &&
inline

Definition at line 340 of file Diagnostics.h.

References append().

◆ attachNote()

Diagnostic& mlir::InFlightDiagnostic::attachNote ( Optional< Location noteLoc = llvm::None)
inline

◆ getUnderlyingDiagnostic()

Diagnostic* mlir::InFlightDiagnostic::getUnderlyingDiagnostic ( )
inline

Returns the underlying diagnostic or nullptr if this diagnostic isn't active.

Definition at line 352 of file Diagnostics.h.

◆ operator FailureOr< T >()

template<typename T >
mlir::InFlightDiagnostic::operator FailureOr< T > ( ) const
inline

Allow an inflight diagnostic to be converted to FailureOr<T>.

Always results in 'failure' because this cast cannot possibly return an object of 'T'.

Definition at line 372 of file Diagnostics.h.

References mlir::failure().

◆ operator LogicalResult()

InFlightDiagnostic::operator LogicalResult ( ) const

Allow an inflight diagnostic to be converted to 'failure', otherwise 'success' if this is an empty diagnostic.

Definition at line 200 of file Diagnostics.cpp.

References mlir::failure().

◆ operator ParseResult()

mlir::InFlightDiagnostic::operator ParseResult ( ) const
inline

Allow an inflight diagnostic to be converted to 'failure', otherwise 'success' if this is an empty diagnostic.

Definition at line 366 of file Diagnostics.h.

◆ operator<<() [1/2]

template<typename Arg >
InFlightDiagnostic& mlir::InFlightDiagnostic::operator<< ( Arg &&  arg) &
inline

Stream operator for new diagnostic arguments.

Definition at line 323 of file Diagnostics.h.

References append().

◆ operator<<() [2/2]

template<typename Arg >
InFlightDiagnostic&& mlir::InFlightDiagnostic::operator<< ( Arg &&  arg) &&
inline

Definition at line 327 of file Diagnostics.h.

References append().

◆ report()

void InFlightDiagnostic::report ( )

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