mlir::OpAsmDialectInterface Class Reference

#include "mlir/IR/OpImplementation.h"

Inheritance diagram for mlir::OpAsmDialectInterface:

Collaboration diagram for mlir::OpAsmDialectInterface:

Public Types
enum class	AliasResult { NoAlias , OverridableAlias , FinalAlias }
	Holds the result of getAlias hook call. More...
Public Types inherited from mlir::detail::DialectInterfaceBase< ConcreteType, BaseT >
using	Base = DialectInterfaceBase< ConcreteType, BaseT >

Public Member Functions
	OpAsmDialectInterface (Dialect *dialect)
virtual AliasResult	getAlias (Attribute attr, raw_ostream &os) const
	Hooks for getting an alias identifier alias for a given symbol, that is not necessarily a part of this dialect. More...
virtual AliasResult	getAlias (Type type, raw_ostream &os) const
virtual FailureOr< AsmDialectResourceHandle >	declareResource (StringRef key) const
	Declare a resource with the given key, returning a handle to use for any references of this resource key within the IR during parsing. More...
virtual std::string	getResourceKey (const AsmDialectResourceHandle &handle) const
	Return a key to use for the given resource. More...
virtual LogicalResult	parseResource (AsmParsedResourceEntry &entry) const
	Hook for parsing resource entries. More...
virtual void	buildResources (Operation *op, const SetVector< AsmDialectResourceHandle > &referencedResources, AsmResourceBuilder &builder) const
	Hook for building resources to use during printing. More...

Additional Inherited Members
Static Public Member Functions inherited from mlir::detail::DialectInterfaceBase< ConcreteType, BaseT >
static TypeID	getInterfaceID ()
	Get a unique id for the derived interface type. More...
Protected Member Functions inherited from mlir::detail::DialectInterfaceBase< ConcreteType, BaseT >
	DialectInterfaceBase (Dialect *dialect)

Detailed Description

Definition at line 1575 of file OpImplementation.h.

Member Enumeration Documentation

AliasResult

enum mlir::OpAsmDialectInterface::AliasResult

strong

Holds the result of getAlias hook call.

Enumerator
NoAlias	The object (type or attribute) is not supported by the hook and an alias was not provided.
OverridableAlias	An alias was provided, but it might be overriden by other hook.
FinalAlias	An alias was provided and it should be used (no other hooks will be checked).

Definition at line 1585 of file OpImplementation.h.

Constructor & Destructor Documentation

OpAsmDialectInterface()

mlir::OpAsmDialectInterface::OpAsmDialectInterface ( Dialect *  dialect )

inline

Definition at line 1578 of file OpImplementation.h.

Member Function Documentation

buildResources()

virtual void mlir::OpAsmDialectInterface::buildResources ( Operation *  op, const SetVector< AsmDialectResourceHandle > &  referencedResources, AsmResourceBuilder &  builder  ) const

inlinevirtual

Hook for building resources to use during printing.

The given op may be inspected to help determine what information to include. referencedResources contains all of the resources detected when printing 'op'.

Definition at line 1638 of file OpImplementation.h.

declareResource()

virtual FailureOr<AsmDialectResourceHandle> mlir::OpAsmDialectInterface::declareResource ( StringRef  key ) const

inlinevirtual

Declare a resource with the given key, returning a handle to use for any references of this resource key within the IR during parsing.

The result of getResourceKey on the returned handle is permitted to be different than key.

Definition at line 1616 of file OpImplementation.h.

References mlir::failure().

Referenced by mlir::detail::Parser::parseResourceHandle().

getAlias() [1/2]

virtual AliasResult mlir::OpAsmDialectInterface::getAlias ( Attribute  attr, raw_ostream &  os  ) const

inlinevirtual

Hooks for getting an alias identifier alias for a given symbol, that is not necessarily a part of this dialect.

The identifier is used in place of the symbol when printing textual IR. These aliases must not contain . or end with a numeric digit([0-9]+).

Definition at line 1600 of file OpImplementation.h.

References NoAlias.

getAlias() [2/2]

virtual AliasResult mlir::OpAsmDialectInterface::getAlias ( Type  type, raw_ostream &  os  ) const

inlinevirtual

Definition at line 1603 of file OpImplementation.h.

References NoAlias.

getResourceKey()

virtual std::string mlir::OpAsmDialectInterface::getResourceKey ( const AsmDialectResourceHandle &  handle ) const

inlinevirtual

Return a key to use for the given resource.

This key should uniquely identify this resource within the dialect.

Definition at line 1623 of file OpImplementation.h.

Referenced by mlir::detail::Parser::parseResourceHandle(), and mlir::AsmPrinter::Impl::printResourceHandle().

parseResource()

LogicalResult OpAsmDialectInterface::parseResource ( AsmParsedResourceEntry &  entry ) const

virtual

Hook for parsing resource entries.

The OpAsmOpInterface, see OpAsmInterface.td for more details.

Returns failure if the entry was not valid, or could otherwise not be processed correctly. Any necessary errors can be emitted via the provided entry.

Definition at line 117 of file AsmPrinter.cpp.

References mlir::AsmParsedResourceEntry::emitError(), and mlir::AsmParsedResourceEntry::getKey().

---

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

• include/mlir/IR/OpImplementation.h
• lib/IR/AsmPrinter.cpp