#include <FunctionSupport.h>

Inheritance diagram for mlir::OpTrait::FunctionLike< ConcreteType >:

Collaboration diagram for mlir::OpTrait::FunctionLike< ConcreteType >:

Public Types
using	BlockListType = Region::BlockListType
	This is the list of blocks in the function. More...

using	iterator = BlockListType::iterator

using	reverse_iterator = BlockListType::reverse_iterator

using	args_iterator = Block::args_iterator

Public Member Functions
bool	isExternal ()
	Returns true if this function is external, i.e. it has no body. More...

Region &	getBody ()

void	eraseBody ()
	Delete all blocks from this function. More...

BlockListType &	getBlocks ()

iterator	begin ()

iterator	end ()

reverse_iterator	rbegin ()

reverse_iterator	rend ()

bool	empty ()

void	push_back (Block *block)

void	push_front (Block *block)

Block &	back ()

Block &	front ()

LogicalResult	verifyBody ()

TypeAttr	getTypeAttr ()

bool	isTypeAttrValid ()

unsigned	getNumArguments ()

unsigned	getNumResults ()

BlockArgument	getArgument (unsigned idx)
	Gets argument. More...

args_iterator	args_begin ()

args_iterator	args_end ()

iterator_range< args_iterator >	getArguments ()

ArrayRef< NamedAttribute >	getArgAttrs (unsigned index)
	Return all of the attributes for the argument at 'index'. More...

void	getAllArgAttrs (SmallVectorImpl< NamedAttributeList > &result)
	Return all argument attributes of this function. More...

Attribute	getArgAttr (unsigned index, Identifier name)

Attribute	getArgAttr (unsigned index, StringRef name)

template<typename AttrClass >
AttrClass	getArgAttrOfType (unsigned index, Identifier name)

template<typename AttrClass >
AttrClass	getArgAttrOfType (unsigned index, StringRef name)

void	setArgAttrs (unsigned index, ArrayRef< NamedAttribute > attributes)
	Set the attributes held by the argument at 'index'. More...

void	setArgAttrs (unsigned index, NamedAttributeList attributes)

void	setAllArgAttrs (ArrayRef< NamedAttributeList > attributes)

void	setArgAttr (unsigned index, Identifier name, Attribute value)

void	setArgAttr (unsigned index, StringRef name, Attribute value)

NamedAttributeList::RemoveResult	removeArgAttr (unsigned index, Identifier name)
	Remove the attribute 'name' from the argument at 'index'. More...

ArrayRef< NamedAttribute >	getResultAttrs (unsigned index)
	Return all of the attributes for the result at 'index'. More...

void	getAllResultAttrs (SmallVectorImpl< NamedAttributeList > &result)
	Return all result attributes of this function. More...

Attribute	getResultAttr (unsigned index, Identifier name)

Attribute	getResultAttr (unsigned index, StringRef name)

template<typename AttrClass >
AttrClass	getResultAttrOfType (unsigned index, Identifier name)

template<typename AttrClass >
AttrClass	getResultAttrOfType (unsigned index, StringRef name)

void	setResultAttrs (unsigned index, ArrayRef< NamedAttribute > attributes)
	Set the attributes held by the result at 'index'. More...

void	setResultAttrs (unsigned index, NamedAttributeList attributes)

void	setAllResultAttrs (ArrayRef< NamedAttributeList > attributes)

void	setResultAttr (unsigned index, Identifier name, Attribute value)

void	setResultAttr (unsigned index, StringRef name, Attribute value)

NamedAttributeList::RemoveResult	removeResultAttr (unsigned index, Identifier name)
	Remove the attribute 'name' from the result at 'index'. More...

Static Public Member Functions
static LogicalResult	verifyTrait (Operation *op)
	Verify that all of the argument attributes are dialect attributes. More...

static StringRef	getTypeAttrName ()
	Return the name of the attribute used for function types. More...

Protected Member Functions
DictionaryAttr	getArgAttrDict (unsigned index)

DictionaryAttr	getResultAttrDict (unsigned index)

LogicalResult	verifyType ()

Protected Member Functions inherited from mlir::OpTrait::TraitBase< ConcreteType, FunctionLike >
Operation *	getOperation ()
	Return the ultimate Operation being worked on. More...

Static Protected Member Functions
static StringRef	getArgAttrName (unsigned index, SmallVectorImpl< char > &out)

static StringRef	getResultAttrName (unsigned index, SmallVectorImpl< char > &out)

Static Protected Member Functions inherited from mlir::OpTrait::TraitBase< ConcreteType, FunctionLike >
static LogicalResult	verifyTrait (Operation *op)

static AbstractOperation::OperationProperties	getTraitProperties ()

Detailed Description

template<typename ConcreteType>
class mlir::OpTrait::FunctionLike< ConcreteType >

This trait provides APIs for Ops that behave like functions. In particular:

Ops must be symbols, i.e. also have the Symbol trait;
Ops have a single region with multiple blocks that corresponds to the body of the function;
the absence of a region corresponds to an external function;
leading arguments of the first block of the region are treated as function arguments;
they can have argument attributes that are stored in a dictionary attribute on the Op itself. This trait does NOT provide type support for the functions, meaning that concrete Ops must handle the type of the declared or defined function. getTypeAttrName() is a convenience function that returns the name of the attribute that can be used to store the function type, but the trait makes no assumption based on it.
Concrete ops must define a member function getNumFuncArguments() that returns the number of function arguments based exclusively on type (so that it can be called on function declarations).
Concrete ops must define a member function getNumFuncResults() that returns the number of function results based exclusively on type (so that it can be called on function declarations).
To verify that the type respects op-specific invariants, concrete ops may redefine the verifyType() hook that will be called after verifying the presence of the type attribute and before any call to getNumFuncArguments/getNumFuncResults from the verifier.
To verify that the body respects op-specific invariants, concrete ops may redefine the verifyBody() hook that will be called after verifying the function type and the presence of the (potentially empty) body region.