mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark Class Reference

Wrapper around an MlirRemark as delivered to a remark callback. More...

#include "mlir/Bindings/Python/IRCore.h"

Public Member Functions
	PyRemark (MlirRemark remark)
void	invalidate ()
bool	isValid () const
PyRemarkKind	getKind () const
nanobind::str	getRemarkName () const
nanobind::str	getCategoryName () const
nanobind::str	getFullCategoryName () const
nanobind::str	getFunctionName () const
nanobind::typed< nanobind::object, PyLocation >	getLocation () const
uint64_t	getId () const
nanobind::list	getArgs () const
	The key/value arguments as a list of (key, value) tuples.
nanobind::str	getMessage () const
	The textual form of the remark, without its location.

Detailed Description

Wrapper around an MlirRemark as delivered to a remark callback.

Like a PyDiagnostic it is only valid for the duration of the callback; accessing an invalidated remark raises ValueError.

Definition at line 457 of file IRCore.h.

Constructor & Destructor Documentation

PyRemark()

mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::PyRemark ( MlirRemark remark )

inlineexplicit

Definition at line 459 of file IRCore.h.

Member Function Documentation

getArgs()

nb::list mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::getArgs

(

)

const

The key/value arguments as a list of (key, value) tuples.

Definition at line 162 of file IRRemarks.cpp.

References mlirRemarkGetArgKey(), mlirRemarkGetArgValue(), mlirRemarkGetNumArgs(), and mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::remarkStr().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRRemarks().

getCategoryName()

nb::str mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::getCategoryName

(

)

const

Definition at line 135 of file IRRemarks.cpp.

References mlirRemarkGetCategoryName(), and mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::remarkStr().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRRemarks().

getFullCategoryName()

nb::str mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::getFullCategoryName

(

)

const

Definition at line 140 of file IRRemarks.cpp.

References mlirRemarkGetFullCategoryName(), and mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::remarkStr().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRRemarks().

getFunctionName()

nb::str mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::getFunctionName

(

)

const

Definition at line 145 of file IRRemarks.cpp.

References mlirRemarkGetFunctionName(), and mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::remarkStr().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRRemarks().

getId()

uint64_t mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::getId

(

)

const

Definition at line 157 of file IRRemarks.cpp.

References mlirRemarkGetId().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRRemarks().

getKind()

PyRemarkKind mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::getKind

(

)

const

Definition at line 125 of file IRRemarks.cpp.

References mlirRemarkGetKind().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRRemarks().

getLocation()

nb::typed< nb::object, PyLocation > mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::getLocation

(

)

const

Definition at line 150 of file IRRemarks.cpp.

References mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyMlirContext::forContext(), mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyLocation::maybeDownCast(), mlirLocationGetContext(), and mlirRemarkGetLocation().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRRemarks().

getMessage()

nb::str mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::getMessage

(

)

const

The textual form of the remark, without its location.

Definition at line 173 of file IRRemarks.cpp.

References MlirStringRef::data, MlirStringRef::length, and mlirRemarkPrint().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRRemarks().

getRemarkName()

nb::str mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::getRemarkName

(

)

const

Definition at line 130 of file IRRemarks.cpp.

References mlirRemarkGetRemarkName(), and mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::remarkStr().

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRRemarks().

invalidate()

void mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::invalidate ( )

inline

Definition at line 460 of file IRCore.h.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::pyRemarkCallback().

isValid()

bool mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::PyRemark::isValid ( ) const

inline

Definition at line 461 of file IRCore.h.

Referenced by mlir::python::MLIR_BINDINGS_PYTHON_DOMAIN::populateIRRemarks().

---

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

• include/mlir/Bindings/Python/IRCore.h
• lib/Bindings/Python/IRRemarks.cpp