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 >
InFlightDiagnostic &	operator<< (Arg &&arg) &
	Stream operator for new diagnostic arguments. More...
template<typename Arg >
InFlightDiagnostic &&	operator<< (Arg &&arg) &&
template<typename... Args>
InFlightDiagnostic &	append (Args &&...args) &
	Append arguments to the diagnostic. More...
template<typename... Args>
InFlightDiagnostic &&	append (Args &&...args) &&
Diagnostic &	attachNote (std::optional< Location > noteLoc=std::nullopt)
	Attaches a note to this diagnostic. More...
Diagnostic *	getUnderlyingDiagnostic ()
	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 313 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 316 of file Diagnostics.h.

~InFlightDiagnostic()

mlir::InFlightDiagnostic::~InFlightDiagnostic ( )

inline

Definition at line 322 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 217 of file Diagnostics.cpp.

append() [1/2]

template<typename... Args>

InFlightDiagnostic& mlir::InFlightDiagnostic::append ( Args &&...  args ) &

inline

Append arguments to the diagnostic.

Definition at line 339 of file Diagnostics.h.

Referenced by append(), mlir::emitOptionalError(), mlir::emitOptionalRemark(), mlir::emitOptionalWarning(), and operator<<().

append() [2/2]

template<typename... Args>

InFlightDiagnostic&& mlir::InFlightDiagnostic::append ( Args &&...  args ) &&

inline

Definition at line 346 of file Diagnostics.h.

References append().

attachNote()

Diagnostic& mlir::InFlightDiagnostic::attachNote ( std::optional< Location >  noteLoc = std::nullopt )

inline

Attaches a note to this diagnostic.

Definition at line 351 of file Diagnostics.h.

Referenced by mlir::DiagnosedDefiniteFailure::attachNote(), and mlir::detail::Parser::parseFloatFromIntegerLiteral().

getUnderlyingDiagnostic()

Diagnostic* mlir::InFlightDiagnostic::getUnderlyingDiagnostic ( )

inline

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

Definition at line 358 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 378 of file Diagnostics.h.

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 201 of file Diagnostics.cpp.

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 372 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 329 of file Diagnostics.h.

References append().

operator<<() [2/2]

template<typename Arg >

InFlightDiagnostic&& mlir::InFlightDiagnostic::operator<< ( Arg &&  arg ) &&

inline

Definition at line 333 of file Diagnostics.h.

References append().

report()

void InFlightDiagnostic::report

(

)

Reports the diagnostic to the engine.

Definition at line 206 of file Diagnostics.cpp.

References mlir::DiagnosticEngine::emit().

Referenced by mlir::DiagnosedDefiniteFailure::operator DiagnosedSilenceableFailure(), mlir::DiagnosedDefiniteFailure::operator LogicalResult(), and ~InFlightDiagnostic().

---

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

• include/mlir/IR/Diagnostics.h
• lib/IR/Diagnostics.cpp
• lib/Tools/PDLL/AST/Diagnostic.cpp