Public Types
enum class	AttrTypeElision { Never , May , Must }
	This enum describes the different kinds of elision for the type of an attribute when printing it. More...

Public Member Functions
	Impl (raw_ostream &os, AsmStateImpl &state)
	Impl (Impl &other)
raw_ostream &	getStream ()
	Returns the output stream of the printer.
void	printNewline ()
	Print a newline and indent the printer to the start of the current operation/attribute/type.
void	increaseIndent ()
	Increase indentation.
void	decreaseIndent ()
	Decrease indentation.
template<typename Container, typename UnaryFunctor>
void	interleaveComma (const Container &c, UnaryFunctor eachFn) const
void	printAttribute (Attribute attr, AttrTypeElision typeElision=AttrTypeElision::Never)
	Print the given attribute or an alias.
void	printAttributeImpl (Attribute attr, AttrTypeElision typeElision=AttrTypeElision::Never)
	Print the given attribute without considering an alias.
void	printNamedAttribute (NamedAttribute attr)
LogicalResult	printAlias (Attribute attr)
	Print the alias for the given attribute, return failure if no alias could be printed.
void	printType (Type type)
	Print the given type or an alias.
void	printTypeImpl (Type type)
	Print the given type.
LogicalResult	printAlias (Type type)
	Print the alias for the given type, return failure if no alias could be printed.
void	printLocation (LocationAttr loc, bool allowAlias=false)
	Print the given location to the stream.
void	printResourceHandle (const AsmDialectResourceHandle &resource)
	Print a reference to the given resource that is owned by the given dialect.
void	printAffineMap (AffineMap map)
void	printAffineExpr (AffineExpr expr, function_ref< void(unsigned, bool)> printValueName=nullptr)
void	printAffineConstraint (AffineExpr expr, bool isEq)
void	printIntegerSet (IntegerSet set)
LogicalResult	pushCyclicPrinting (const void *opaquePointer)
void	popCyclicPrinting ()
void	printDimensionList (ArrayRef< int64_t > shape)

Protected Types
enum class	BindingStrength { Weak , Strong }
	This enum is used to represent the binding strength of the enclosing context that an AffineExprStorage is being printed in, so we can intelligently produce parens. More...

Protected Member Functions
void	printOptionalAttrDict (ArrayRef< NamedAttribute > attrs, ArrayRef< StringRef > elidedAttrs={}, bool withKeyword=false)
void	printTrailingLocation (Location loc, bool allowAlias=true)
void	printLocationInternal (LocationAttr loc, bool pretty=false, bool isTopLevel=false)
void	printDenseElementsAttr (DenseElementsAttr attr, bool allowHex)
	Print a dense elements attribute.
void	printDenseStringElementsAttr (DenseStringElementsAttr attr)
	Print a dense string elements attribute.
void	printDenseTypedElementsAttr (DenseTypedElementsAttr attr, bool allowHex)
	Print a dense elements attribute in the literal-first syntax.
void	printTypeFirstDenseElementsAttr (DenseElementsAttr attr, DenseElementType denseEltType)
	Print a dense elements attribute using the type-first syntax and the DenseElementTypeInterface, which provides the attribute printer for each element.
void	printDenseArrayAttr (DenseArrayAttr attr)
	Print a dense array attribute.
void	printDialectAttribute (Attribute attr)
void	printDialectType (Type type)
void	printEscapedString (StringRef str)
	Print an escaped string, wrapped with "".
void	printHexString (StringRef str)
	Print a hex string, wrapped with "".
void	printHexString (ArrayRef< char > data)
void	printAffineExprInternal (AffineExpr expr, BindingStrength enclosingTightness, function_ref< void(unsigned, bool)> printValueName=nullptr)

Protected Attributes
raw_ostream &	os
	The output stream for the printer.
AsmStateImpl &	state
	An underlying assembly printer state.
OpPrintingFlags	printerFlags
	A set of flags to control the printer's behavior.
NewLineCounter	newLine
	A tracker for the number of new lines emitted during printing.
unsigned	currentIndent = 0
	This is the current indentation level for nested structures.

Static Protected Attributes
static const unsigned	indentWidth = 2
	The number of spaces used as an indent.

Detailed Description

Definition at line 438 of file AsmPrinter.cpp.

Member Enumeration Documentation

◆ AttrTypeElision

enum class mlir::AsmPrinter::Impl::AttrTypeElision

strong

This enum describes the different kinds of elision for the type of an attribute when printing it.

Enumerator
Never	The type must not be elided,.
May	The type may be elided when it matches the default used in the parser (for example i64 is the default for integer attributes).
Must	The type must be elided.

Definition at line 468 of file AsmPrinter.cpp.

◆ BindingStrength

enum class mlir::AsmPrinter::Impl::BindingStrength

strongprotected

This enum is used to represent the binding strength of the enclosing context that an AffineExprStorage is being printed in, so we can intelligently produce parens.

Enumerator
Weak
Strong

Definition at line 562 of file AsmPrinter.cpp.

Constructor & Destructor Documentation

◆ Impl() [1/2]

AsmPrinter::Impl::Impl	(	raw_ostream &	os,
		AsmStateImpl &	state )

Definition at line 2188 of file AsmPrinter.cpp.

References os, printerFlags, and state.

Referenced by Impl(), printDialectAttribute(), and printDialectType().

◆ Impl() [2/2]

mlir::AsmPrinter::Impl::Impl ( Impl & other )

inlineexplicit

Definition at line 441 of file AsmPrinter.cpp.

References Impl(), os, and state.

Member Function Documentation

◆ decreaseIndent()

void mlir::AsmPrinter::Impl::decreaseIndent ( )

inline

Decrease indentation.

Definition at line 459 of file AsmPrinter.cpp.

References currentIndent, and indentWidth.

◆ getStream()

raw_ostream & mlir::AsmPrinter::Impl::getStream ( )

inline

Returns the output stream of the printer.

Definition at line 444 of file AsmPrinter.cpp.

References os.

Referenced by printDenseArrayAttr().

◆ increaseIndent()

void mlir::AsmPrinter::Impl::increaseIndent ( )

inline

Increase indentation.

Definition at line 456 of file AsmPrinter.cpp.

References currentIndent, and indentWidth.

◆ interleaveComma()

template<typename Container, typename UnaryFunctor>

void mlir::AsmPrinter::Impl::interleaveComma	(	const Container &	c,
		UnaryFunctor	eachFn ) const

inline

Definition at line 462 of file AsmPrinter.cpp.

References os.

Referenced by printAffineMap(), printAttributeImpl(), printLocationInternal(), printOptionalAttrDict(), and printTypeImpl().

◆ popCyclicPrinting()

void AsmPrinter::Impl::popCyclicPrinting ( )

Definition at line 3076 of file AsmPrinter.cpp.

References state.

◆ printAffineConstraint()

void AsmPrinter::Impl::printAffineConstraint	(	AffineExpr	expr,
		bool	isEq )

Definition at line 3322 of file AsmPrinter.cpp.

References os, printAffineExprInternal(), and Weak.

Referenced by printIntegerSet().

◆ printAffineExpr()

void AsmPrinter::Impl::printAffineExpr	(	AffineExpr	expr,
		function_ref< void(unsigned, bool)>	printValueName = nullptr )

Definition at line 3181 of file AsmPrinter.cpp.

References printAffineExprInternal(), and Weak.

Referenced by mlir::AffineExpr::print().

◆ printAffineExprInternal()

void AsmPrinter::Impl::printAffineExprInternal	(	AffineExpr	expr,
		BindingStrength	enclosingTightness,
		function_ref< void(unsigned, bool)>	printValueName = nullptr )

protected

Definition at line 3186 of file AsmPrinter.cpp.

References mlir::Add, mlir::CeilDiv, mlir::Constant, mlir::DimId, mlir::FloorDiv, mlir::AffineExpr::getKind(), mlir::Mod, mlir::Mul, os, printAffineExprInternal(), Strong, mlir::SymbolId, and Weak.

Referenced by printAffineConstraint(), printAffineExpr(), and printAffineExprInternal().

◆ printAffineMap()

void AsmPrinter::Impl::printAffineMap ( AffineMap map )

Definition at line 3327 of file AsmPrinter.cpp.

References mlir::AffineMap::getNumDims(), mlir::AffineMap::getNumSymbols(), mlir::AffineMap::getResults(), interleaveComma(), and os.

Referenced by mlir::AffineMap::print().

◆ printAlias() [1/2]

LogicalResult AsmPrinter::Impl::printAlias ( Attribute attr )

Print the alias for the given attribute, return failure if no alias could be printed.

Definition at line 2444 of file AsmPrinter.cpp.

References os, and state.

Referenced by mlir::Attribute::printStripped().

◆ printAlias() [2/2]

LogicalResult AsmPrinter::Impl::printAlias ( Type type )

Print the alias for the given type, return failure if no alias could be printed.

Definition at line 2448 of file AsmPrinter.cpp.

References os, and state.

◆ printAttribute()

void AsmPrinter::Impl::printAttribute	(	Attribute	attr,
		AttrTypeElision	typeElision = AttrTypeElision::Never )

Print the given attribute or an alias.

Definition at line 2452 of file AsmPrinter.cpp.

References os, mlir::AsmPrinter::printAlias(), and printAttributeImpl().

Referenced by mlir::Attribute::print().

◆ printAttributeImpl()

void AsmPrinter::Impl::printAttributeImpl	(	Attribute	attr,
		AttrTypeElision	typeElision = AttrTypeElision::Never )

Print the given attribute without considering an alias.

Definition at line 2464 of file AsmPrinter.cpp.

References mlir::Attribute::getDialect(), mlir::DistinctAttr::getReferencedAttr(), indices, interleaveComma(), mlir::Type::isSignlessInteger(), mlir::Type::isUnsignedInteger(), May, Must, os, mlir::AsmPrinter::printAttribute(), printDenseArrayAttr(), printDenseElementsAttr(), printDenseStringElementsAttr(), printDenseTypedElementsAttr(), printDialectAttribute(), printDialectSymbol(), printElidedElementsAttr(), printerFlags, printEscapedString(), printFloatValue(), printLocation(), mlir::AsmPrinter::printResourceHandle(), printSymbolReference(), mlir::AsmPrinter::printType(), printTypeFirstDenseElementsAttr(), and state.

Referenced by printAttribute().

◆ printDenseArrayAttr()

void AsmPrinter::Impl::printDenseArrayAttr ( DenseArrayAttr attr )

protected

Print a dense array attribute.

Definition at line 2796 of file AsmPrinter.cpp.

References getFloatSemantics(), mlir::Type::getIntOrFloatBitWidth(), mlir::AsmPrinter::getStream(), getStream(), mlir::Type::isInteger(), mlir::Type::isIntOrIndex(), printDenseIntElement(), and printFloatValue().

Referenced by printAttributeImpl().

◆ printDenseElementsAttr()

void AsmPrinter::Impl::printDenseElementsAttr	(	DenseElementsAttr	attr,
		bool	allowHex )

protected

Print a dense elements attribute.

If 'allowHex' is true, a hex string is used instead of individual elements when the elements attr is large.

Definition at line 2687 of file AsmPrinter.cpp.

References printDenseStringElementsAttr(), and printDenseTypedElementsAttr().

Referenced by printAttributeImpl().

◆ printDenseStringElementsAttr()

void AsmPrinter::Impl::printDenseStringElementsAttr ( DenseStringElementsAttr attr )

protected

Print a dense string elements attribute.

Definition at line 2768 of file AsmPrinter.cpp.

References os, printDenseElementsAttrImpl(), and printEscapedString().

Referenced by printAttributeImpl(), and printDenseElementsAttr().

◆ printDenseTypedElementsAttr()

void AsmPrinter::Impl::printDenseTypedElementsAttr	(	DenseTypedElementsAttr	attr,
		bool	allowHex )

protected

Print a dense elements attribute in the literal-first syntax.

If 'allowHex' is true, a hex string is used instead of individual elements when the elements attr is large.

Definition at line 2696 of file AsmPrinter.cpp.

References os, printDenseElementsAttrImpl(), printerFlags, and printHexString().

Referenced by printAttributeImpl(), and printDenseElementsAttr().

◆ printDialectAttribute()

void AsmPrinter::Impl::printDialectAttribute ( Attribute attr )

protected

Definition at line 3017 of file AsmPrinter.cpp.

References currentIndent, mlir::Attribute::getDialect(), Impl(), newLine, os, printDialectSymbol(), and state.

Referenced by printAttributeImpl().

◆ printDialectType()

void AsmPrinter::Impl::printDialectType ( Type type )

protected

Definition at line 3038 of file AsmPrinter.cpp.

References currentIndent, mlir::Type::getDialect(), Impl(), newLine, os, printDialectSymbol(), and state.

Referenced by printTypeImpl().

◆ printDimensionList()

void AsmPrinter::Impl::printDimensionList ( ArrayRef< int64_t > shape )

Definition at line 3078 of file AsmPrinter.cpp.

References os, and mlir::detail::printDimensionList().

◆ printEscapedString()

void AsmPrinter::Impl::printEscapedString ( StringRef str )

protected

Print an escaped string, wrapped with "".

Definition at line 3059 of file AsmPrinter.cpp.

References os.

Referenced by printAttributeImpl(), printDenseStringElementsAttr(), and printLocationInternal().

◆ printHexString() [1/2]

void AsmPrinter::Impl::printHexString ( ArrayRef< char > data )

protected

Definition at line 3068 of file AsmPrinter.cpp.

References printHexString().

◆ printHexString() [2/2]

void AsmPrinter::Impl::printHexString ( StringRef str )

protected

Print a hex string, wrapped with "".

Definition at line 3065 of file AsmPrinter.cpp.

References os.

Referenced by printDenseTypedElementsAttr(), and printHexString().

◆ printIntegerSet()

void AsmPrinter::Impl::printIntegerSet ( IntegerSet set )

Definition at line 3353 of file AsmPrinter.cpp.

References mlir::IntegerSet::getConstraint(), mlir::IntegerSet::getNumConstraints(), mlir::IntegerSet::getNumDims(), mlir::IntegerSet::getNumSymbols(), mlir::IntegerSet::isEq(), os, and printAffineConstraint().

Referenced by mlir::IntegerSet::print().

◆ printLocation()

void AsmPrinter::Impl::printLocation	(	LocationAttr	loc,
		bool	allowAlias = false )

Print the given location to the stream.

If allowAlias is true, this allows for the internal location to use an attribute alias.

Definition at line 2343 of file AsmPrinter.cpp.

References os, mlir::AsmPrinter::printAlias(), printerFlags, and printLocationInternal().

Referenced by printAttributeImpl(), and printTrailingLocation().

◆ printLocationInternal()

void AsmPrinter::Impl::printLocationInternal	(	LocationAttr	loc,
		bool	pretty = false,
		bool	isTopLevel = false )

protected

Definition at line 2200 of file AsmPrinter.cpp.

References interleaveComma(), newLine, os, mlir::AsmPrinter::printAttribute(), printEscapedString(), printLocationInternal(), and state.

Referenced by printLocation(), and printLocationInternal().

◆ printNamedAttribute()

void AsmPrinter::Impl::printNamedAttribute ( NamedAttribute attr )

Definition at line 3005 of file AsmPrinter.cpp.

References mlir::NamedAttribute::getName(), mlir::NamedAttribute::getValue(), os, mlir::AsmPrinter::printAttribute(), and mlir::AsmPrinter::printKeywordOrString().

◆ printNewline()

void mlir::AsmPrinter::Impl::printNewline ( )

inline

Print a newline and indent the printer to the start of the current operation/attribute/type.

Note: For attributes and types this method should only be used in custom dialects. Usage in MLIR dialects is disallowed.

Definition at line 450 of file AsmPrinter.cpp.

References currentIndent, newLine, and os.

◆ printOptionalAttrDict()

void AsmPrinter::Impl::printOptionalAttrDict	(	ArrayRef< NamedAttribute >	attrs,
		ArrayRef< StringRef >	elidedAttrs = {},
		bool	withKeyword = false )

protected

Definition at line 2972 of file AsmPrinter.cpp.

References mlir::NamedAttribute::getName(), interleaveComma(), os, and mlir::AsmPrinter::printNamedAttribute().

◆ printResourceHandle()

void AsmPrinter::Impl::printResourceHandle ( const AsmDialectResourceHandle & resource )

Print a reference to the given resource that is owned by the given dialect.

Definition at line 2437 of file AsmPrinter.cpp.

References mlir::AsmDialectResourceHandle::getDialect(), os, mlir::AsmPrinter::printKeywordOrString(), and state.

◆ printTrailingLocation()

void AsmPrinter::Impl::printTrailingLocation	(	Location	loc,
		bool	allowAlias = true )

protected

Definition at line 2191 of file AsmPrinter.cpp.

References os, printerFlags, and printLocation().

◆ printType()

void AsmPrinter::Impl::printType ( Type type )

Print the given type or an alias.

Definition at line 2821 of file AsmPrinter.cpp.

References os, mlir::AsmPrinter::printAlias(), and printTypeImpl().

Referenced by mlir::Type::print().

◆ printTypeFirstDenseElementsAttr()

void AsmPrinter::Impl::printTypeFirstDenseElementsAttr	(	DenseElementsAttr	attr,
		DenseElementType	denseEltType )

protected

Print a dense elements attribute using the type-first syntax and the DenseElementTypeInterface, which provides the attribute printer for each element.

Definition at line 2775 of file AsmPrinter.cpp.

References mlir::DenseElementsAttr::getRawData(), mlir::DenseElementsAttr::getType(), mlir::DenseElementsAttr::isSplat(), os, printDenseElementsAttrImpl(), and mlir::AsmPrinter::printType().

Referenced by printAttributeImpl().

◆ printTypeImpl()

void AsmPrinter::Impl::printTypeImpl ( Type type )

Print the given type.

Definition at line 2833 of file AsmPrinter.cpp.

References interleaveComma(), May, os, mlir::AsmPrinter::printAttribute(), printDialectSymbol(), printDialectType(), mlir::AsmPrinter::printDimensionList(), and mlir::AsmPrinter::printType().

Referenced by printType().

◆ pushCyclicPrinting()

LogicalResult AsmPrinter::Impl::pushCyclicPrinting ( const void * opaquePointer )

Definition at line 3072 of file AsmPrinter.cpp.

References state.

Member Data Documentation

◆ currentIndent

unsigned mlir::AsmPrinter::Impl::currentIndent = 0

protected

This is the current indentation level for nested structures.

Definition at line 586 of file AsmPrinter.cpp.

Referenced by decreaseIndent(), increaseIndent(), printDialectAttribute(), printDialectType(), and printNewline().

◆ indentWidth

const unsigned mlir::AsmPrinter::Impl::indentWidth = 2

staticprotected

The number of spaces used as an indent.

Definition at line 583 of file AsmPrinter.cpp.

Referenced by decreaseIndent(), and increaseIndent().

◆ newLine

NewLineCounter mlir::AsmPrinter::Impl::newLine

protected

A tracker for the number of new lines emitted during printing.

Definition at line 580 of file AsmPrinter.cpp.

Referenced by printDialectAttribute(), printDialectType(), printLocationInternal(), and printNewline().

◆ os

raw_ostream& mlir::AsmPrinter::Impl::os

protected

The output stream for the printer.

Definition at line 571 of file AsmPrinter.cpp.

Referenced by getStream(), Impl(), Impl(), interleaveComma(), printAffineConstraint(), printAffineExprInternal(), printAffineMap(), printAlias(), printAlias(), printAttribute(), printAttributeImpl(), printDenseStringElementsAttr(), printDenseTypedElementsAttr(), printDialectAttribute(), printDialectType(), printDimensionList(), printEscapedString(), printHexString(), printIntegerSet(), printLocation(), printLocationInternal(), printNamedAttribute(), printNewline(), printOptionalAttrDict(), printResourceHandle(), printTrailingLocation(), printType(), printTypeFirstDenseElementsAttr(), and printTypeImpl().

◆ printerFlags

OpPrintingFlags mlir::AsmPrinter::Impl::printerFlags

protected

A set of flags to control the printer's behavior.

Definition at line 577 of file AsmPrinter.cpp.

Referenced by Impl(), printAttributeImpl(), printDenseTypedElementsAttr(), printLocation(), and printTrailingLocation().

◆ state

AsmStateImpl& mlir::AsmPrinter::Impl::state

protected

An underlying assembly printer state.

Definition at line 574 of file AsmPrinter.cpp.

Referenced by Impl(), Impl(), popCyclicPrinting(), printAlias(), printAlias(), printAttributeImpl(), printDialectAttribute(), printDialectType(), printLocationInternal(), printResourceHandle(), and pushCyclicPrinting().

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

lib/IR/AsmPrinter.cpp

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ AttrTypeElision

◆ BindingStrength

Constructor & Destructor Documentation

◆ Impl() [1/2]

◆ Impl() [2/2]

Member Function Documentation

◆ decreaseIndent()

◆ getStream()

◆ increaseIndent()

◆ interleaveComma()

◆ popCyclicPrinting()

◆ printAffineConstraint()

◆ printAffineExpr()

◆ printAffineExprInternal()

◆ printAffineMap()

◆ printAlias() [1/2]

◆ printAlias() [2/2]

◆ printAttribute()

◆ printAttributeImpl()

◆ printDenseArrayAttr()

◆ printDenseElementsAttr()

◆ printDenseStringElementsAttr()

◆ printDenseTypedElementsAttr()

◆ printDialectAttribute()

◆ printDialectType()

◆ printDimensionList()

◆ printEscapedString()

◆ printHexString() [1/2]

◆ printHexString() [2/2]

◆ printIntegerSet()

◆ printLocation()

◆ printLocationInternal()

◆ printNamedAttribute()

◆ printNewline()

◆ printOptionalAttrDict()

◆ printResourceHandle()

◆ printTrailingLocation()

◆ printType()

◆ printTypeFirstDenseElementsAttr()

◆ printTypeImpl()

◆ pushCyclicPrinting()

Member Data Documentation

◆ currentIndent

◆ indentWidth

◆ newLine

◆ os

◆ printerFlags

◆ state