MLIR  17.0.0git
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
mlir::AsmParser Class Referenceabstract

This base class exposes generic asm parser hooks, usable across the various derived parsers. More...

#include "mlir/IR/OpImplementation.h"

+ Inheritance diagram for mlir::AsmParser:

Classes

class  KeywordSwitch
 This class represents a StringSwitch like class that is useful for parsing expected keywords. More...
 

Public Types

enum class  Delimiter {
  None , Paren , Square , LessGreater ,
  Braces , OptionalParen , OptionalSquare , OptionalLessGreater ,
  OptionalBraces
}
 These are the supported delimiters around operand lists and region argument lists, used by parseOperandList. More...
 
template<typename AttrType >
using has_parse_method = decltype(AttrType::parse(std::declval< AsmParser & >(), std::declval< Type >()))
 Trait to check if AttrType provides a parse method. More...
 
template<typename AttrType >
using detect_has_parse_method = llvm::is_detected< has_parse_method, AttrType >
 
template<typename TypeT >
using type_has_parse_method = decltype(TypeT::parse(std::declval< AsmParser & >()))
 Trait to check if TypeT provides a parse method. More...
 
template<typename TypeT >
using detect_type_has_parse_method = llvm::is_detected< type_has_parse_method, TypeT >
 

Public Member Functions

 AsmParser ()=default
 
virtual ~AsmParser ()
 
MLIRContextgetContext () const
 
virtual SMLoc getNameLoc () const =0
 Return the location of the original name token. More...
 
virtual InFlightDiagnostic emitError (SMLoc loc, const Twine &message={})=0
 Emit a diagnostic at the specified location and return failure. More...
 
virtual BuildergetBuilder () const =0
 Return a builder which provides useful access to MLIRContext, global objects like types and attributes. More...
 
virtual SMLoc getCurrentLocation ()=0
 Get the location of the next token and store it into the argument. More...
 
ParseResult getCurrentLocation (SMLoc *loc)
 
virtual Location getEncodedSourceLoc (SMLoc loc)=0
 Re-encode the given source location as an MLIR location and return it. More...
 
virtual ParseResult parseArrow ()=0
 Parse a '->' token. More...
 
virtual ParseResult parseOptionalArrow ()=0
 Parse a '->' token if present. More...
 
virtual ParseResult parseLBrace ()=0
 Parse a { token. More...
 
virtual ParseResult parseOptionalLBrace ()=0
 Parse a { token if present. More...
 
virtual ParseResult parseRBrace ()=0
 Parse a } token. More...
 
virtual ParseResult parseOptionalRBrace ()=0
 Parse a } token if present. More...
 
virtual ParseResult parseColon ()=0
 Parse a : token. More...
 
virtual ParseResult parseOptionalColon ()=0
 Parse a : token if present. More...
 
virtual ParseResult parseComma ()=0
 Parse a , token. More...
 
virtual ParseResult parseOptionalComma ()=0
 Parse a , token if present. More...
 
virtual ParseResult parseEqual ()=0
 Parse a = token. More...
 
virtual ParseResult parseOptionalEqual ()=0
 Parse a = token if present. More...
 
virtual ParseResult parseLess ()=0
 Parse a '<' token. More...
 
virtual ParseResult parseOptionalLess ()=0
 Parse a '<' token if present. More...
 
virtual ParseResult parseGreater ()=0
 Parse a '>' token. More...
 
virtual ParseResult parseOptionalGreater ()=0
 Parse a '>' token if present. More...
 
virtual ParseResult parseQuestion ()=0
 Parse a '?' token. More...
 
virtual ParseResult parseOptionalQuestion ()=0
 Parse a '?' token if present. More...
 
virtual ParseResult parsePlus ()=0
 Parse a '+' token. More...
 
virtual ParseResult parseOptionalPlus ()=0
 Parse a '+' token if present. More...
 
virtual ParseResult parseStar ()=0
 Parse a '*' token. More...
 
virtual ParseResult parseOptionalStar ()=0
 Parse a '*' token if present. More...
 
virtual ParseResult parseVerticalBar ()=0
 Parse a '|' token. More...
 
virtual ParseResult parseOptionalVerticalBar ()=0
 Parse a '|' token if present. More...
 
ParseResult parseString (std::string *string)
 Parse a quoted string token. More...
 
virtual ParseResult parseOptionalString (std::string *string)=0
 Parse a quoted string token if present. More...
 
virtual ParseResult parseBase64Bytes (std::vector< char > *bytes)=0
 Parses a Base64 encoded string of bytes. More...
 
virtual ParseResult parseLParen ()=0
 Parse a ( token. More...
 
virtual ParseResult parseOptionalLParen ()=0
 Parse a ( token if present. More...
 
virtual ParseResult parseRParen ()=0
 Parse a ) token. More...
 
virtual ParseResult parseOptionalRParen ()=0
 Parse a ) token if present. More...
 
virtual ParseResult parseLSquare ()=0
 Parse a [ token. More...
 
virtual ParseResult parseOptionalLSquare ()=0
 Parse a [ token if present. More...
 
virtual ParseResult parseRSquare ()=0
 Parse a ] token. More...
 
virtual ParseResult parseOptionalRSquare ()=0
 Parse a ] token if present. More...
 
virtual ParseResult parseEllipsis ()=0
 Parse a ... token. More...
 
virtual ParseResult parseOptionalEllipsis ()=0
 Parse a ... token if present;. More...
 
virtual ParseResult parseFloat (double &result)=0
 Parse a floating point value from the stream. More...
 
template<typename IntT >
ParseResult parseInteger (IntT &result)
 Parse an integer value from the stream. More...
 
virtual OptionalParseResult parseOptionalInteger (APInt &result)=0
 Parse an optional integer value from the stream. More...
 
template<typename IntT >
OptionalParseResult parseOptionalInteger (IntT &result)
 
virtual ParseResult parseCommaSeparatedList (Delimiter delimiter, function_ref< ParseResult()> parseElementFn, StringRef contextMessage=StringRef())=0
 Parse a list of comma-separated items with an optional delimiter. More...
 
ParseResult parseCommaSeparatedList (function_ref< ParseResult()> parseElementFn)
 Parse a comma separated list of elements that must have at least one entry in it. More...
 
ParseResult parseKeyword (StringRef keyword)
 Parse a given keyword. More...
 
virtual ParseResult parseKeyword (StringRef keyword, const Twine &msg)=0
 
ParseResult parseKeyword (StringRef *keyword)
 Parse a keyword into 'keyword'. More...
 
virtual ParseResult parseOptionalKeyword (StringRef keyword)=0
 Parse the given keyword if present. More...
 
virtual ParseResult parseOptionalKeyword (StringRef *keyword)=0
 Parse a keyword, if present, into 'keyword'. More...
 
virtual ParseResult parseOptionalKeyword (StringRef *keyword, ArrayRef< StringRef > allowedValues)=0
 Parse a keyword, if present, and if one of the 'allowedValues', into 'keyword'. More...
 
ParseResult parseKeywordOrString (std::string *result)
 Parse a keyword or a quoted string. More...
 
virtual ParseResult parseOptionalKeywordOrString (std::string *result)=0
 Parse an optional keyword or string. More...
 
template<typename T , typename... ParamsT>
auto getChecked (SMLoc loc, ParamsT &&...params)
 Invoke the getChecked method of the given Attribute or Type class, using the provided location to emit errors in the case of failure. More...
 
template<typename T , typename... ParamsT>
auto getChecked (ParamsT &&...params)
 A variant of getChecked that uses the result of getNameLoc to emit errors. More...
 
virtual ParseResult parseAttribute (Attribute &result, Type type={})=0
 Parse an arbitrary attribute of a given type and return it in result. More...
 
virtual ParseResult parseCustomAttributeWithFallback (Attribute &result, Type type, function_ref< ParseResult(Attribute &result, Type type)> parseAttribute)=0
 Parse a custom attribute with the provided callback, unless the next token is #, in which case the generic parser is invoked. More...
 
template<typename AttrType >
ParseResult parseAttribute (AttrType &result, Type type={})
 Parse an attribute of a specific kind and type. More...
 
ParseResult parseAttribute (Attribute &result, StringRef attrName, NamedAttrList &attrs)
 Parse an arbitrary attribute and return it in result. More...
 
template<typename AttrType >
ParseResult parseAttribute (AttrType &result, StringRef attrName, NamedAttrList &attrs)
 Parse an attribute of a specific kind and type. More...
 
template<typename AttrType >
ParseResult parseAttribute (AttrType &result, Type type, StringRef attrName, NamedAttrList &attrs)
 Parse an arbitrary attribute of a given type and populate it in result. More...
 
template<typename AttrType >
std::enable_if_t< detect_has_parse_method< AttrType >::value, ParseResultparseCustomAttributeWithFallback (AttrType &result, Type type, StringRef attrName, NamedAttrList &attrs)
 Parse a custom attribute of a given type unless the next token is #, in which case the generic parser is invoked. More...
 
template<typename AttrType >
std::enable_if_t<!detect_has_parse_method< AttrType >::value, ParseResultparseCustomAttributeWithFallback (AttrType &result, Type type, StringRef attrName, NamedAttrList &attrs)
 SFINAE parsing method for Attribute that don't implement a parse method. More...
 
template<typename AttrType >
std::enable_if_t< detect_has_parse_method< AttrType >::value, ParseResultparseCustomAttributeWithFallback (AttrType &result)
 Parse a custom attribute of a given type unless the next token is #, in which case the generic parser is invoked. More...
 
template<typename AttrType >
std::enable_if_t<!detect_has_parse_method< AttrType >::value, ParseResultparseCustomAttributeWithFallback (AttrType &result)
 SFINAE parsing method for Attribute that don't implement a parse method. More...
 
virtual OptionalParseResult parseOptionalAttribute (Attribute &result, Type type={})=0
 Parse an arbitrary optional attribute of a given type and return it in result. More...
 
virtual OptionalParseResult parseOptionalAttribute (ArrayAttr &result, Type type={})=0
 Parse an optional array attribute and return it in result. More...
 
virtual OptionalParseResult parseOptionalAttribute (StringAttr &result, Type type={})=0
 Parse an optional string attribute and return it in result. More...
 
virtual OptionalParseResult parseOptionalAttribute (SymbolRefAttr &result, Type type={})=0
 Parse an optional symbol ref attribute and return it in result. More...
 
template<typename AttrType >
OptionalParseResult parseOptionalAttribute (AttrType &result, StringRef attrName, NamedAttrList &attrs)
 Parse an optional attribute of a specific type and add it to the list with the specified name. More...
 
template<typename AttrType >
OptionalParseResult parseOptionalAttribute (AttrType &result, Type type, StringRef attrName, NamedAttrList &attrs)
 Parse an optional attribute of a specific type and add it to the list with the specified name. More...
 
virtual ParseResult parseOptionalAttrDict (NamedAttrList &result)=0
 Parse a named dictionary into 'result' if it is present. More...
 
virtual ParseResult parseOptionalAttrDictWithKeyword (NamedAttrList &result)=0
 Parse a named dictionary into 'result' if the attributes keyword is present. More...
 
virtual ParseResult parseAffineMap (AffineMap &map)=0
 Parse an affine map instance into 'map'. More...
 
virtual ParseResult printIntegerSet (IntegerSet &set)=0
 Parse an integer set instance into 'set'. More...
 
ParseResult parseSymbolName (StringAttr &result)
 Parse an -identifier and store it (without the '@' symbol) in a string attribute. More...
 
ParseResult parseSymbolName (StringAttr &result, StringRef attrName, NamedAttrList &attrs)
 Parse an -identifier and store it (without the '@' symbol) in a string attribute named 'attrName'. More...
 
virtual ParseResult parseOptionalSymbolName (StringAttr &result)=0
 Parse an optional -identifier and store it (without the '@' symbol) in a string attribute. More...
 
ParseResult parseOptionalSymbolName (StringAttr &result, StringRef attrName, NamedAttrList &attrs)
 Parse an optional -identifier and store it (without the '@' symbol) in a string attribute named 'attrName'. More...
 
template<typename ResourceT >
FailureOr< ResourceT > parseResourceHandle ()
 Parse a handle to a resource within the assembly format. More...
 
virtual ParseResult parseType (Type &result)=0
 Parse a type. More...
 
virtual ParseResult parseCustomTypeWithFallback (Type &result, function_ref< ParseResult(Type &result)> parseType)=0
 Parse a custom type with the provided callback, unless the next token is #, in which case the generic parser is invoked. More...
 
virtual OptionalParseResult parseOptionalType (Type &result)=0
 Parse an optional type. More...
 
template<typename TypeT >
ParseResult parseType (TypeT &result)
 Parse a type of a specific type. More...
 
template<typename TypeT >
std::enable_if_t< detect_type_has_parse_method< TypeT >::value, ParseResultparseCustomTypeWithFallback (TypeT &result)
 Parse a custom Type of a given type unless the next token is #, in which case the generic parser is invoked. More...
 
template<typename TypeT >
std::enable_if_t<!detect_type_has_parse_method< TypeT >::value, ParseResultparseCustomTypeWithFallback (TypeT &result)
 SFINAE parsing method for Type that don't implement a parse method. More...
 
ParseResult parseTypeList (SmallVectorImpl< Type > &result)
 Parse a type list. More...
 
virtual ParseResult parseArrowTypeList (SmallVectorImpl< Type > &result)=0
 Parse an arrow followed by a type list. More...
 
virtual ParseResult parseOptionalArrowTypeList (SmallVectorImpl< Type > &result)=0
 Parse an optional arrow followed by a type list. More...
 
virtual ParseResult parseColonType (Type &result)=0
 Parse a colon followed by a type. More...
 
template<typename TypeType >
ParseResult parseColonType (TypeType &result)
 Parse a colon followed by a type of a specific kind, e.g. a FunctionType. More...
 
virtual ParseResult parseColonTypeList (SmallVectorImpl< Type > &result)=0
 Parse a colon followed by a type list, which must have at least one type. More...
 
virtual ParseResult parseOptionalColonTypeList (SmallVectorImpl< Type > &result)=0
 Parse an optional colon followed by a type list, which if present must have at least one type. More...
 
ParseResult parseKeywordType (const char *keyword, Type &result)
 Parse a keyword followed by a type. More...
 
ParseResult addTypeToList (Type type, SmallVectorImpl< Type > &result)
 Add the specified type to the end of the specified type list and return success. More...
 
ParseResult addTypesToList (ArrayRef< Type > types, SmallVectorImpl< Type > &result)
 Add the specified types to the end of the specified type list and return success. More...
 
virtual ParseResult parseDimensionList (SmallVectorImpl< int64_t > &dimensions, bool allowDynamic=true, bool withTrailingX=true)=0
 Parse a dimension list of a tensor or memref type. More...
 
virtual ParseResult parseXInDimensionList ()=0
 Parse an 'x' token in a dimension list, handling the case where the x is juxtaposed with an element type, as in "xf32", leaving the "f32" as the next token. More...
 

Protected Member Functions

virtual FailureOr< AsmDialectResourceHandleparseResourceHandle (Dialect *dialect)=0
 Parse a handle to a resource within the assembly format for the given dialect. More...
 
virtual ParseResult parseKeywordOrCompletion (StringRef *keyword)=0
 Parse a keyword, or an empty string if the current location signals a code completion. More...
 
virtual void codeCompleteExpectedTokens (ArrayRef< StringRef > tokens)=0
 Signal the code completion of a set of expected tokens. More...
 

Detailed Description

This base class exposes generic asm parser hooks, usable across the various derived parsers.

Definition at line 459 of file OpImplementation.h.

Member Typedef Documentation

◆ detect_has_parse_method

template<typename AttrType >
using mlir::AsmParser::detect_has_parse_method = llvm::is_detected<has_parse_method, AttrType>

Definition at line 893 of file OpImplementation.h.

◆ detect_type_has_parse_method

template<typename TypeT >
using mlir::AsmParser::detect_type_has_parse_method = llvm::is_detected<type_has_parse_method, TypeT>

Definition at line 1119 of file OpImplementation.h.

◆ has_parse_method

template<typename AttrType >
using mlir::AsmParser::has_parse_method = decltype(AttrType::parse(std::declval<AsmParser &>(), std::declval<Type>()))

Trait to check if AttrType provides a parse method.

Definition at line 890 of file OpImplementation.h.

◆ type_has_parse_method

template<typename TypeT >
using mlir::AsmParser::type_has_parse_method = decltype(TypeT::parse(std::declval<AsmParser &>()))

Trait to check if TypeT provides a parse method.

Definition at line 1116 of file OpImplementation.h.

Member Enumeration Documentation

◆ Delimiter

These are the supported delimiters around operand lists and region argument lists, used by parseOperandList.

Enumerator
None 

Zero or more operands with no delimiters.

Paren 

Parens surrounding zero or more operands.

Square 

Square brackets surrounding zero or more operands.

LessGreater 

<> brackets surrounding zero or more operands.

Braces 

{} brackets surrounding zero or more operands.

OptionalParen 

Parens supporting zero or more operands, or nothing.

OptionalSquare 

Square brackets supporting zero or more ops, or nothing.

OptionalLessGreater 

<> brackets supporting zero or more ops, or nothing.

OptionalBraces 

{} brackets surrounding zero or more operands, or nothing.

Definition at line 652 of file OpImplementation.h.

Constructor & Destructor Documentation

◆ AsmParser()

mlir::AsmParser::AsmParser ( )
default

◆ ~AsmParser()

AsmParser::~AsmParser ( )
virtualdefault

Member Function Documentation

◆ addTypesToList()

ParseResult mlir::AsmParser::addTypesToList ( ArrayRef< Type types,
SmallVectorImpl< Type > &  result 
)
inline

Add the specified types to the end of the specified type list and return success.

This is a helper designed to allow parse methods to be simple and chain through || operators.

Definition at line 1210 of file OpImplementation.h.

References mlir::success().

◆ addTypeToList()

ParseResult mlir::AsmParser::addTypeToList ( Type  type,
SmallVectorImpl< Type > &  result 
)
inline

Add the specified type to the end of the specified type list and return success.

This is a helper designed to allow parse methods to be simple and chain through || operators.

Definition at line 1202 of file OpImplementation.h.

References mlir::success().

Referenced by parseAffineMinMaxOp(), parseAtomicCompareExchangeImpl(), parseAtomicUpdateOp(), parseGroupNonUniformArithmeticOp(), and parseOneResultSameOperandTypeOp().

◆ codeCompleteExpectedTokens()

virtual void mlir::AsmParser::codeCompleteExpectedTokens ( ArrayRef< StringRef >  tokens)
protectedpure virtual

Signal the code completion of a set of expected tokens.

Referenced by mlir::AsmParser::KeywordSwitch< ResultT >::Case().

◆ emitError()

virtual InFlightDiagnostic mlir::AsmParser::emitError ( SMLoc  loc,
const Twine &  message = {} 
)
pure virtual

Emit a diagnostic at the specified location and return failure.

Referenced by buildLLVMFunctionType(), mlir::DynamicOpDefinition::get(), getChecked(), getElementType(), getLoadStoreElementType(), mlir::AsmParser::KeywordSwitch< ResultT >::operator ResultT(), mlir::DataLayoutEntryAttr::parse(), mlir::DataLayoutSpecAttr::parse(), mlir::AffineDmaStartOp::parse(), mlir::AffineDmaWaitOp::parse(), mlir::OpState::parse(), parseAllReduceOperation(), parseAndVerify(), parseAndVerifyMatrixType(), parseAndVerifySampledImageType(), parseAndVerifyType(), parseArithmeticExtendedBinaryOp(), parseArrayType(), mlir::OpAsmParser::parseAssignmentList(), parseAsyncDependencies(), parseAtomicBinOp(), parseAtomicCompareExchangeImpl(), parseAtomicOrdering(), parseAtomicUpdateOp(), parseAttribute(), mlir::Dialect::parseAttribute(), mlir::DynamicDialect::parseAttribute(), parseBound(), parseClauseAttr(), parseCmpOp(), parseColonType(), parseCooperativeMatrixType(), parseCustomAttributeWithFallback(), parseCustomTypeWithFallback(), mlir::parseDynamicIndexList(), parseEnumStrAttr(), parseExpressedTypeAndRange(), parseFunctionArgumentList(), mlir::function_interface_impl::parseFunctionOp(), parseGlobalMemrefOpTypeAndInitialValue(), parseInsertExtractValueElementType(), parseInteger(), parseInterfaceVarABIAttr(), parseJointMatrixType(), parseKeyword(), parseKeywordOrString(), parseMatrixType(), parseMultitileSizesTypes(), parseNamedStructuredOpRegion(), parseOneResultSameOperandTypeOp(), parseOptionalArrayStride(), parseOptionalInteger(), parseOptionalInterchange(), parseOptionalStaticSlice(), parsePDLType(), parsePointerType(), parseResourceHandle(), parseScheduleClause(), parseShuffleType(), parseStorageRange(), parseStorageType(), parseString(), parseStructMemberDecorations(), parseStructType(), parseSymbolName(), parseSynchronizationHint(), parseTargetEnvAttr(), parseTileLikeOp(), mlir::Dialect::parseType(), mlir::DynamicDialect::parseType(), parseType(), parseUniformType(), parseVerCapExtAttr(), mlir::OpAsmParser::resolveOperands(), and verifyScheduleModifiers().

◆ getBuilder()

virtual Builder& mlir::AsmParser::getBuilder ( ) const
pure virtual

◆ getChecked() [1/2]

template<typename T , typename... ParamsT>
auto mlir::AsmParser::getChecked ( ParamsT &&...  params)
inline

A variant of getChecked that uses the result of getNameLoc to emit errors.

Definition at line 816 of file OpImplementation.h.

References emitError(), and getNameLoc().

◆ getChecked() [2/2]

template<typename T , typename... ParamsT>
auto mlir::AsmParser::getChecked ( SMLoc  loc,
ParamsT &&...  params 
)
inline

Invoke the getChecked method of the given Attribute or Type class, using the provided location to emit errors in the case of failure.

Note that unlike OpBuilder::getType, this method does not implicitly insert a context parameter.

Definition at line 809 of file OpImplementation.h.

References emitError().

Referenced by mlir::DynamicAttr::parse(), mlir::DynamicType::parse(), parseAnyType(), parseCalibratedType(), and parseUniformType().

◆ getContext()

MLIRContext * AsmParser::getContext ( ) const

◆ getCurrentLocation() [1/2]

virtual SMLoc mlir::AsmParser::getCurrentLocation ( )
pure virtual

Get the location of the next token and store it into the argument.

This always succeeds.

Referenced by mlir::DynamicOpDefinition::get(), getCurrentLocation(), mlir::DataLayoutEntryAttr::parse(), parseAllReduceOperation(), parseAndVerify(), parseAndVerifyMatrixType(), parseAndVerifySampledImageType(), parseAndVerifyType(), parseArithmeticExtendedBinaryOp(), parseArrayType(), mlir::OpAsmParser::parseAssignmentList(), parseAsyncDependencies(), parseAtomicBinOp(), parseAtomicCompareExchangeImpl(), parseAtomicOrdering(), parseAtomicUpdateOp(), parseAttribute(), mlir::DynamicDialect::parseAttribute(), parseBound(), parseClauseAttr(), parseCmpOp(), parseColonType(), parseCommonStructuredOpParts(), parseCooperativeMatrixType(), parseCustomAttributeWithFallback(), parseCustomTypeWithFallback(), parseEnumStrAttr(), parseExpressedTypeAndRange(), parseFunctionArgumentList(), mlir::function_interface_impl::parseFunctionOp(), parseInsertExtractValueElementType(), parseInteger(), parseInterfaceVarABIAttr(), parseJointMatrixType(), parseKeyword(), parseKeywordOrString(), parseMatrixType(), parseMultitileSizesTypes(), parseNamedStructuredOpRegion(), parseOneResultSameOperandTypeOp(), parseOperandList(), parseOptionalArrayStride(), parseOptionalInteger(), parseOptionalStaticSlice(), parsePointerType(), parsePtrAccessChainOpImpl(), parseResourceHandle(), parseScheduleClause(), parseShuffleType(), parseStorageRange(), parseStorageType(), parseString(), parseStructMemberDecorations(), parseSymbolName(), parseSynchronizationHint(), parseTargetEnvAttr(), parseTileLikeOp(), mlir::DynamicDialect::parseType(), parseType(), parseUniformType(), and parseVerCapExtAttr().

◆ getCurrentLocation() [2/2]

ParseResult mlir::AsmParser::getCurrentLocation ( SMLoc *  loc)
inline

Definition at line 484 of file OpImplementation.h.

References getCurrentLocation(), and mlir::success().

◆ getEncodedSourceLoc()

virtual Location mlir::AsmParser::getEncodedSourceLoc ( SMLoc  loc)
pure virtual

Re-encode the given source location as an MLIR location and return it.

Note: This method should only be used when a Location is necessary, as the encoding process is not efficient.

◆ getNameLoc()

virtual SMLoc mlir::AsmParser::getNameLoc ( ) const
pure virtual

◆ parseAffineMap()

virtual ParseResult mlir::AsmParser::parseAffineMap ( AffineMap map)
pure virtual

Parse an affine map instance into 'map'.

Referenced by mlir::FieldParser< AffineMap >::parse().

◆ parseArrow()

virtual ParseResult mlir::AsmParser::parseArrow ( )
pure virtual

◆ parseArrowTypeList()

virtual ParseResult mlir::AsmParser::parseArrowTypeList ( SmallVectorImpl< Type > &  result)
pure virtual

Parse an arrow followed by a type list.

◆ parseAttribute() [1/5]

ParseResult mlir::AsmParser::parseAttribute ( Attribute result,
StringRef  attrName,
NamedAttrList attrs 
)
inline

Parse an arbitrary attribute and return it in result.

This also adds the attribute to the specified attribute list with the specified name.

Definition at line 854 of file OpImplementation.h.

References parseAttribute().

◆ parseAttribute() [2/5]

virtual ParseResult mlir::AsmParser::parseAttribute ( Attribute result,
Type  type = {} 
)
pure virtual

◆ parseAttribute() [3/5]

template<typename AttrType >
ParseResult mlir::AsmParser::parseAttribute ( AttrType &  result,
StringRef  attrName,
NamedAttrList attrs 
)
inline

Parse an attribute of a specific kind and type.

Definition at line 861 of file OpImplementation.h.

References parseAttribute().

◆ parseAttribute() [4/5]

template<typename AttrType >
ParseResult mlir::AsmParser::parseAttribute ( AttrType &  result,
Type  type,
StringRef  attrName,
NamedAttrList attrs 
)
inline

Parse an arbitrary attribute of a given type and populate it in result.

This also adds the attribute to the specified attribute list with the specified name.

Definition at line 870 of file OpImplementation.h.

References mlir::NamedAttrList::append(), mlir::Attribute::dyn_cast(), emitError(), mlir::failure(), getCurrentLocation(), parseAttribute(), and mlir::success().

◆ parseAttribute() [5/5]

template<typename AttrType >
ParseResult mlir::AsmParser::parseAttribute ( AttrType &  result,
Type  type = {} 
)
inline

Parse an attribute of a specific kind and type.

Definition at line 837 of file OpImplementation.h.

◆ parseBase64Bytes()

virtual ParseResult mlir::AsmParser::parseBase64Bytes ( std::vector< char > *  bytes)
pure virtual

Parses a Base64 encoded string of bytes.

◆ parseColon()

virtual ParseResult mlir::AsmParser::parseColon ( )
pure virtual

◆ parseColonType() [1/2]

virtual ParseResult mlir::AsmParser::parseColonType ( Type result)
pure virtual

◆ parseColonType() [2/2]

template<typename TypeType >
ParseResult mlir::AsmParser::parseColonType ( TypeType &  result)
inline

Parse a colon followed by a type of a specific kind, e.g. a FunctionType.

Definition at line 1170 of file OpImplementation.h.

References mlir::Type::dyn_cast(), emitError(), mlir::failure(), getCurrentLocation(), parseColonType(), and mlir::success().

◆ parseColonTypeList()

virtual ParseResult mlir::AsmParser::parseColonTypeList ( SmallVectorImpl< Type > &  result)
pure virtual

Parse a colon followed by a type list, which must have at least one type.

Referenced by mlir::AffineDmaStartOp::parse(), parseCommonStructuredOpParts(), parseCreateOperationOpResults(), and parseSwitchOpCases().

◆ parseComma()

virtual ParseResult mlir::AsmParser::parseComma ( )
pure virtual

◆ parseCommaSeparatedList() [1/2]

virtual ParseResult mlir::AsmParser::parseCommaSeparatedList ( Delimiter  delimiter,
function_ref< ParseResult()>  parseElementFn,
StringRef  contextMessage = StringRef() 
)
pure virtual

◆ parseCommaSeparatedList() [2/2]

ParseResult mlir::AsmParser::parseCommaSeparatedList ( function_ref< ParseResult()>  parseElementFn)
inline

Parse a comma separated list of elements that must have at least one entry in it.

Definition at line 687 of file OpImplementation.h.

References None, and parseCommaSeparatedList().

◆ parseCustomAttributeWithFallback() [1/5]

virtual ParseResult mlir::AsmParser::parseCustomAttributeWithFallback ( Attribute result,
Type  type,
function_ref< ParseResult(Attribute &result, Type type)>  parseAttribute 
)
pure virtual

Parse a custom attribute with the provided callback, unless the next token is #, in which case the generic parser is invoked.

Referenced by mlir::FieldParser< AttributeT, std::enable_if_t< std::is_base_of< Attribute, AttributeT >::value, AttributeT > >::parse(), and parseCustomAttributeWithFallback().

◆ parseCustomAttributeWithFallback() [2/5]

template<typename AttrType >
std::enable_if_t<detect_has_parse_method<AttrType>::value, ParseResult> mlir::AsmParser::parseCustomAttributeWithFallback ( AttrType &  result)
inline

Parse a custom attribute of a given type unless the next token is #, in which case the generic parser is invoked.

The parsed attribute is populated in result.

Definition at line 938 of file OpImplementation.h.

References mlir::Attribute::dyn_cast(), emitError(), mlir::failure(), getCurrentLocation(), parseCustomAttributeWithFallback(), and mlir::success().

◆ parseCustomAttributeWithFallback() [3/5]

template<typename AttrType >
std::enable_if_t<!detect_has_parse_method<AttrType>::value, ParseResult> mlir::AsmParser::parseCustomAttributeWithFallback ( AttrType &  result)
inline

SFINAE parsing method for Attribute that don't implement a parse method.

Definition at line 960 of file OpImplementation.h.

References parseAttribute().

◆ parseCustomAttributeWithFallback() [4/5]

template<typename AttrType >
std::enable_if_t<detect_has_parse_method<AttrType>::value, ParseResult> mlir::AsmParser::parseCustomAttributeWithFallback ( AttrType &  result,
Type  type,
StringRef  attrName,
NamedAttrList attrs 
)
inline

Parse a custom attribute of a given type unless the next token is #, in which case the generic parser is invoked.

The parsed attribute is populated in result and also added to the specified attribute list with the specified name.

Definition at line 901 of file OpImplementation.h.

References mlir::NamedAttrList::append(), mlir::Attribute::dyn_cast(), emitError(), mlir::failure(), getCurrentLocation(), parseCustomAttributeWithFallback(), and mlir::success().

◆ parseCustomAttributeWithFallback() [5/5]

template<typename AttrType >
std::enable_if_t<!detect_has_parse_method<AttrType>::value, ParseResult> mlir::AsmParser::parseCustomAttributeWithFallback ( AttrType &  result,
Type  type,
StringRef  attrName,
NamedAttrList attrs 
)
inline

SFINAE parsing method for Attribute that don't implement a parse method.

Definition at line 928 of file OpImplementation.h.

References parseAttribute().

◆ parseCustomTypeWithFallback() [1/3]

virtual ParseResult mlir::AsmParser::parseCustomTypeWithFallback ( Type result,
function_ref< ParseResult(Type &result)>  parseType 
)
pure virtual

Parse a custom type with the provided callback, unless the next token is #, in which case the generic parser is invoked.

Referenced by mlir::FieldParser< TypeT, std::enable_if_t< std::is_base_of< Type, TypeT >::value, TypeT > >::parse(), and parseCustomTypeWithFallback().

◆ parseCustomTypeWithFallback() [2/3]

template<typename TypeT >
std::enable_if_t<detect_type_has_parse_method<TypeT>::value, ParseResult> mlir::AsmParser::parseCustomTypeWithFallback ( TypeT &  result)
inline

Parse a custom Type of a given type unless the next token is #, in which case the generic parser is invoked.

The parsed Type is populated in result.

Definition at line 1127 of file OpImplementation.h.

References mlir::Type::dyn_cast(), emitError(), mlir::failure(), getCurrentLocation(), parseCustomTypeWithFallback(), and mlir::success().

◆ parseCustomTypeWithFallback() [3/3]

template<typename TypeT >
std::enable_if_t<!detect_type_has_parse_method<TypeT>::value, ParseResult> mlir::AsmParser::parseCustomTypeWithFallback ( TypeT &  result)
inline

SFINAE parsing method for Type that don't implement a parse method.

Definition at line 1148 of file OpImplementation.h.

References parseType().

◆ parseDimensionList()

virtual ParseResult mlir::AsmParser::parseDimensionList ( SmallVectorImpl< int64_t > &  dimensions,
bool  allowDynamic = true,
bool  withTrailingX = true 
)
pure virtual

Parse a dimension list of a tensor or memref type.

This populates the dimension list, using ShapedType::kDynamic for the ? dimensions if allowDynamic is set and errors out on ? otherwise. Parsing the trailing x is configurable.

dimension-list ::= eps | dimension (x dimension)* dimension-list-with-trailing-x ::= (dimension x)* dimension ::= ? | decimal-literal

When allowDynamic is not set, this is used to parse:

static-dimension-list ::= eps | decimal-literal (x decimal-literal)* static-dimension-list-with-trailing-x ::= (dimension x)*

Referenced by parseArrayType(), parseCooperativeMatrixType(), parseJointMatrixType(), and parseMatrixType().

◆ parseEllipsis()

virtual ParseResult mlir::AsmParser::parseEllipsis ( )
pure virtual

Parse a ... token.

◆ parseEqual()

virtual ParseResult mlir::AsmParser::parseEqual ( )
pure virtual

◆ parseFloat()

virtual ParseResult mlir::AsmParser::parseFloat ( double &  result)
pure virtual

Parse a floating point value from the stream.

Referenced by parseExpressedTypeAndRange(), and parseQuantParams().

◆ parseGreater()

virtual ParseResult mlir::AsmParser::parseGreater ( )
pure virtual

◆ parseInteger()

template<typename IntT >
ParseResult mlir::AsmParser::parseInteger ( IntT &  result)
inline

◆ parseKeyword() [1/3]

ParseResult mlir::AsmParser::parseKeyword ( StringRef *  keyword)
inline

Parse a keyword into 'keyword'.

Definition at line 770 of file OpImplementation.h.

References emitError(), getCurrentLocation(), parseOptionalKeyword(), and mlir::success().

◆ parseKeyword() [2/3]

ParseResult mlir::AsmParser::parseKeyword ( StringRef  keyword)
inline

◆ parseKeyword() [3/3]

virtual ParseResult mlir::AsmParser::parseKeyword ( StringRef  keyword,
const Twine &  msg 
)
pure virtual

◆ parseKeywordOrCompletion()

virtual ParseResult mlir::AsmParser::parseKeywordOrCompletion ( StringRef *  keyword)
protectedpure virtual

Parse a keyword, or an empty string if the current location signals a code completion.

Referenced by mlir::AsmParser::KeywordSwitch< ResultT >::KeywordSwitch().

◆ parseKeywordOrString()

ParseResult mlir::AsmParser::parseKeywordOrString ( std::string *  result)
inline

Parse a keyword or a quoted string.

Definition at line 790 of file OpImplementation.h.

References emitError(), mlir::failed(), getCurrentLocation(), parseOptionalKeywordOrString(), and mlir::success().

◆ parseKeywordType()

ParseResult mlir::AsmParser::parseKeywordType ( const char *  keyword,
Type result 
)
inline

Parse a keyword followed by a type.

Definition at line 1195 of file OpImplementation.h.

References mlir::failure(), parseKeyword(), and parseType().

◆ parseLBrace()

virtual ParseResult mlir::AsmParser::parseLBrace ( )
pure virtual

Parse a { token.

Referenced by parseUniformType().

◆ parseLess()

virtual ParseResult mlir::AsmParser::parseLess ( )
pure virtual

◆ parseLParen()

virtual ParseResult mlir::AsmParser::parseLParen ( )
pure virtual

◆ parseLSquare()

virtual ParseResult mlir::AsmParser::parseLSquare ( )
pure virtual

◆ parseOptionalArrow()

virtual ParseResult mlir::AsmParser::parseOptionalArrow ( )
pure virtual

◆ parseOptionalArrowTypeList()

virtual ParseResult mlir::AsmParser::parseOptionalArrowTypeList ( SmallVectorImpl< Type > &  result)
pure virtual

Parse an optional arrow followed by a type list.

Referenced by parseNamedStructuredOpResults().

◆ parseOptionalAttrDict()

virtual ParseResult mlir::AsmParser::parseOptionalAttrDict ( NamedAttrList result)
pure virtual

◆ parseOptionalAttrDictWithKeyword()

virtual ParseResult mlir::AsmParser::parseOptionalAttrDictWithKeyword ( NamedAttrList result)
pure virtual

Parse a named dictionary into 'result' if the attributes keyword is present.

Referenced by mlir::function_interface_impl::parseFunctionOp().

◆ parseOptionalAttribute() [1/6]

virtual OptionalParseResult mlir::AsmParser::parseOptionalAttribute ( ArrayAttr &  result,
Type  type = {} 
)
pure virtual

Parse an optional array attribute and return it in result.

◆ parseOptionalAttribute() [2/6]

virtual OptionalParseResult mlir::AsmParser::parseOptionalAttribute ( Attribute result,
Type  type = {} 
)
pure virtual

◆ parseOptionalAttribute() [3/6]

template<typename AttrType >
OptionalParseResult mlir::AsmParser::parseOptionalAttribute ( AttrType &  result,
StringRef  attrName,
NamedAttrList attrs 
)
inline

Parse an optional attribute of a specific type and add it to the list with the specified name.

Definition at line 984 of file OpImplementation.h.

References parseOptionalAttribute().

◆ parseOptionalAttribute() [4/6]

template<typename AttrType >
OptionalParseResult mlir::AsmParser::parseOptionalAttribute ( AttrType &  result,
Type  type,
StringRef  attrName,
NamedAttrList attrs 
)
inline

Parse an optional attribute of a specific type and add it to the list with the specified name.

Definition at line 993 of file OpImplementation.h.

References mlir::NamedAttrList::append(), mlir::OptionalParseResult::has_value(), parseOptionalAttribute(), and mlir::succeeded().

◆ parseOptionalAttribute() [5/6]

virtual OptionalParseResult mlir::AsmParser::parseOptionalAttribute ( StringAttr &  result,
Type  type = {} 
)
pure virtual

Parse an optional string attribute and return it in result.

◆ parseOptionalAttribute() [6/6]

virtual OptionalParseResult mlir::AsmParser::parseOptionalAttribute ( SymbolRefAttr &  result,
Type  type = {} 
)
pure virtual

Parse an optional symbol ref attribute and return it in result.

◆ parseOptionalColon()

virtual ParseResult mlir::AsmParser::parseOptionalColon ( )
pure virtual

Parse a : token if present.

Referenced by parseAnyType(), parseQuantParams(), parseTargetEnvAttr(), and parseUniformType().

◆ parseOptionalColonTypeList()

virtual ParseResult mlir::AsmParser::parseOptionalColonTypeList ( SmallVectorImpl< Type > &  result)
pure virtual

Parse an optional colon followed by a type list, which if present must have at least one type.

◆ parseOptionalComma()

virtual ParseResult mlir::AsmParser::parseOptionalComma ( )
pure virtual

◆ parseOptionalEllipsis()

virtual ParseResult mlir::AsmParser::parseOptionalEllipsis ( )
pure virtual

Parse a ... token if present;.

Referenced by parseFunctionArgumentList(), and parseFunctionTypes().

◆ parseOptionalEqual()

virtual ParseResult mlir::AsmParser::parseOptionalEqual ( )
pure virtual

◆ parseOptionalGreater()

virtual ParseResult mlir::AsmParser::parseOptionalGreater ( )
pure virtual

Parse a '>' token if present.

Referenced by mlir::DataLayoutSpecAttr::parse(), parseStructType(), and typeOrAttrParser().

◆ parseOptionalInteger() [1/2]

virtual OptionalParseResult mlir::AsmParser::parseOptionalInteger ( APInt &  result)
pure virtual

◆ parseOptionalInteger() [2/2]

template<typename IntT >
OptionalParseResult mlir::AsmParser::parseOptionalInteger ( IntT &  result)
inline

◆ parseOptionalKeyword() [1/3]

virtual ParseResult mlir::AsmParser::parseOptionalKeyword ( StringRef *  keyword)
pure virtual

Parse a keyword, if present, into 'keyword'.

◆ parseOptionalKeyword() [2/3]

virtual ParseResult mlir::AsmParser::parseOptionalKeyword ( StringRef *  keyword,
ArrayRef< StringRef >  allowedValues 
)
pure virtual

Parse a keyword, if present, and if one of the 'allowedValues', into 'keyword'.

◆ parseOptionalKeyword() [3/3]

virtual ParseResult mlir::AsmParser::parseOptionalKeyword ( StringRef  keyword)
pure virtual

◆ parseOptionalKeywordOrString()

virtual ParseResult mlir::AsmParser::parseOptionalKeywordOrString ( std::string *  result)
pure virtual

Parse an optional keyword or string.

Referenced by parseKeywordOrString().

◆ parseOptionalLBrace()

virtual ParseResult mlir::AsmParser::parseOptionalLBrace ( )
pure virtual

◆ parseOptionalLess()

virtual ParseResult mlir::AsmParser::parseOptionalLess ( )
pure virtual

Parse a '<' token if present.

Referenced by parseCreateOperationOpResults(), parseStorageRange(), and typeOrAttrParser().

◆ parseOptionalLParen()

virtual ParseResult mlir::AsmParser::parseOptionalLParen ( )
pure virtual

◆ parseOptionalLSquare()

virtual ParseResult mlir::AsmParser::parseOptionalLSquare ( )
pure virtual

◆ parseOptionalPlus()

virtual ParseResult mlir::AsmParser::parseOptionalPlus ( )
pure virtual

Parse a '+' token if present.

◆ parseOptionalQuestion()

virtual ParseResult mlir::AsmParser::parseOptionalQuestion ( )
pure virtual

Parse a '?' token if present.

◆ parseOptionalRBrace()

virtual ParseResult mlir::AsmParser::parseOptionalRBrace ( )
pure virtual

Parse a } token if present.

◆ parseOptionalRParen()

virtual ParseResult mlir::AsmParser::parseOptionalRParen ( )
pure virtual

◆ parseOptionalRSquare()

virtual ParseResult mlir::AsmParser::parseOptionalRSquare ( )
pure virtual

◆ parseOptionalStar()

virtual ParseResult mlir::AsmParser::parseOptionalStar ( )
pure virtual

Parse a '*' token if present.

◆ parseOptionalString()

virtual ParseResult mlir::AsmParser::parseOptionalString ( std::string *  string)
pure virtual

Parse a quoted string token if present.

Referenced by mlir::DataLayoutEntryAttr::parse(), and parseString().

◆ parseOptionalSymbolName() [1/2]

virtual ParseResult mlir::AsmParser::parseOptionalSymbolName ( StringAttr &  result)
pure virtual

Parse an optional -identifier and store it (without the '@' symbol) in a string attribute.

Referenced by parseOptionalSymbolName(), and parseSymbolName().

◆ parseOptionalSymbolName() [2/2]

ParseResult mlir::AsmParser::parseOptionalSymbolName ( StringAttr &  result,
StringRef  attrName,
NamedAttrList attrs 
)
inline

Parse an optional -identifier and store it (without the '@' symbol) in a string attribute named 'attrName'.

Definition at line 1045 of file OpImplementation.h.

References mlir::NamedAttrList::append(), mlir::failure(), parseOptionalSymbolName(), mlir::succeeded(), and mlir::success().

◆ parseOptionalType()

virtual OptionalParseResult mlir::AsmParser::parseOptionalType ( Type result)
pure virtual

Parse an optional type.

Referenced by mlir::DataLayoutEntryAttr::parse(), and parseStorageType().

◆ parseOptionalVerticalBar()

virtual ParseResult mlir::AsmParser::parseOptionalVerticalBar ( )
pure virtual

Parse a '|' token if present.

◆ parsePlus()

virtual ParseResult mlir::AsmParser::parsePlus ( )
pure virtual

Parse a '+' token.

◆ parseQuestion()

virtual ParseResult mlir::AsmParser::parseQuestion ( )
pure virtual

Parse a '?' token.

Referenced by parseOptionalStaticSlice().

◆ parseRBrace()

virtual ParseResult mlir::AsmParser::parseRBrace ( )
pure virtual

◆ parseResourceHandle() [1/2]

template<typename ResourceT >
FailureOr<ResourceT> mlir::AsmParser::parseResourceHandle ( )
inline

Parse a handle to a resource within the assembly format.

Definition at line 1060 of file OpImplementation.h.

References emitError(), mlir::failed(), mlir::failure(), getContext(), getCurrentLocation(), and mlir::MLIRContext::getOrLoadDialect().

◆ parseResourceHandle() [2/2]

virtual FailureOr<AsmDialectResourceHandle> mlir::AsmParser::parseResourceHandle ( Dialect dialect)
protectedpure virtual

Parse a handle to a resource within the assembly format for the given dialect.

◆ parseRParen()

virtual ParseResult mlir::AsmParser::parseRParen ( )
pure virtual

◆ parseRSquare()

virtual ParseResult mlir::AsmParser::parseRSquare ( )
pure virtual

◆ parseStar()

virtual ParseResult mlir::AsmParser::parseStar ( )
pure virtual

Parse a '*' token.

◆ parseString()

ParseResult mlir::AsmParser::parseString ( std::string *  string)
inline

Parse a quoted string token.

Definition at line 571 of file OpImplementation.h.

References emitError(), getCurrentLocation(), parseOptionalString(), and mlir::success().

Referenced by mlir::FieldParser< std::string >::parse().

◆ parseSymbolName() [1/2]

ParseResult mlir::AsmParser::parseSymbolName ( StringAttr &  result)
inline

Parse an -identifier and store it (without the '@' symbol) in a string attribute.

Definition at line 1022 of file OpImplementation.h.

References emitError(), mlir::failed(), getCurrentLocation(), parseOptionalSymbolName(), and mlir::success().

Referenced by mlir::function_interface_impl::parseFunctionOp(), and parseSymbolName().

◆ parseSymbolName() [2/2]

ParseResult mlir::AsmParser::parseSymbolName ( StringAttr &  result,
StringRef  attrName,
NamedAttrList attrs 
)
inline

Parse an -identifier and store it (without the '@' symbol) in a string attribute named 'attrName'.

Definition at line 1031 of file OpImplementation.h.

References mlir::NamedAttrList::append(), mlir::failure(), parseSymbolName(), and mlir::success().

◆ parseType() [1/2]

virtual ParseResult mlir::AsmParser::parseType ( Type result)
pure virtual

◆ parseType() [2/2]

template<typename TypeT >
ParseResult mlir::AsmParser::parseType ( TypeT &  result)
inline

Parse a type of a specific type.

Definition at line 1098 of file OpImplementation.h.

References mlir::Type::dyn_cast(), emitError(), mlir::failure(), getCurrentLocation(), parseType(), and mlir::success().

◆ parseTypeList()

ParseResult mlir::AsmParser::parseTypeList ( SmallVectorImpl< Type > &  result)
inline

Parse a type list.

Definition at line 1153 of file OpImplementation.h.

References parseCommaSeparatedList(), and parseType().

Referenced by parsePtrAccessChainOpImpl().

◆ parseVerticalBar()

virtual ParseResult mlir::AsmParser::parseVerticalBar ( )
pure virtual

Parse a '|' token.

◆ parseXInDimensionList()

virtual ParseResult mlir::AsmParser::parseXInDimensionList ( )
pure virtual

Parse an 'x' token in a dimension list, handling the case where the x is juxtaposed with an element type, as in "xf32", leaving the "f32" as the next token.

◆ printIntegerSet()

virtual ParseResult mlir::AsmParser::printIntegerSet ( IntegerSet set)
pure virtual

Parse an integer set instance into 'set'.


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