Emit the boilerplate for Type printer/parser dialect dispatching from ODS

[mehdi_amini]

Summary

Add a new useDefaultTypePrinterParser boolean settings on the dialect
(default to false for now) that emits the boilerplate to dispatch type
parsing/printing to the auto-generated method.
We will likely turn this on by default in the future.

Depends On D113329

[rriddle]

mlir/include/mlir/IR/OpBase.td

306

mlir/tools/mlir-tblgen/AttrOrTypeDefGen.cpp

534

549

mlir/include/mlir/Dialect/EmitC/IR/EmitCBase.td

def EmitC_Dialect : Dialect {
   let cppNamespace = "::mlir::emitc";
 
   let summary = "Dialect to generate C/C++ from MLIR.";
   let description = [{
     [include "Dialects/emitc.md"]
   }];
 
   let hasConstantMaterializer = 1;
+  let useDefaultTypePrinterParser = 1;
 }
 
 #endif // MLIR_DIALECT_EMITC_IR_EMITCBASE

mlir/include/mlir/IR/OpBase.td

class Dialect {
 
   // If this dialect overrides the hook for op interface fallback.
   bit hasOperationInterfaceFallback = 0;
 
   // If this dialect should use default generated attribute parser boilerplate:
   // it'll dispatch the parsing to every individual attributes directly.
   bit useDefaultAttributePrinterParser = 0;
 
+  // If this dialect should use default generated type parser boilerplate:
+  // it'll dispatch the parsing to every individual types directly.
+  bit useDefaultTypePrinterParser = 0;
+
   // If this dialect overrides the hook for canonicalization patterns.
   bit hasCanonicalizer = 0;
 
   // Whether to emit raw/with no prefix or format changes, or emit with
   // accessor with prefix only and UpperCamel suffix or to emit accessors with
   // both.
   //
   // If emitting with prefix is specified then the attribute/operand's

mlir/include/mlir/TableGen/Dialect.h

public:
 
   /// Returns true if this dialect has fallback interfaces for its operations.
   bool hasOperationInterfaceFallback() const;
 
   /// Returns true if this dialect should generate the default dispatch for
   /// attribute printing/parsing.
   bool useDefaultAttributePrinterParser() const;
 
+  /// Returns true if this dialect should generate the default dispatch for
+  /// type printing/parsing.
+  bool useDefaultTypePrinterParser() const;
+
   // Returns whether two dialects are equal by checking the equality of the
   // underlying record.
   bool operator==(const Dialect &other) const;
 
   bool operator!=(const Dialect &other) const { return !(*this == other); }
 
   // Compares two dialects by comparing the names of the dialects.
   bool operator<(const Dialect &other) const;

mlir/lib/Dialect/EmitC/IR/EmitC.cpp

if (parser.parseOptionalString(&value) || value.empty()) {
     parser.emitError(loc) << "expected non empty string";
     return Type();
   }
   if (parser.parseGreater())
     return Type();
   return get(parser.getContext(), value);
 }
 
-Type EmitCDialect::parseType(DialectAsmParser &parser) const {
-  llvm::SMLoc typeLoc = parser.getCurrentLocation();
-  StringRef mnemonic;
-  if (parser.parseKeyword(&mnemonic))
-    return Type();
-  Type genType;
-  OptionalParseResult parseResult =
-      generatedTypeParser(parser, mnemonic, genType);
-  if (parseResult.hasValue())
-    return genType;
-  parser.emitError(typeLoc, "unknown type in EmitC dialect");
-  return Type();
-}
-
-void EmitCDialect::printType(Type type, DialectAsmPrinter &os) const {
-  if (failed(generatedTypePrinter(type, os)))
-    llvm_unreachable("unexpected 'EmitC' type kind");
-}
-
 void emitc::OpaqueType::print(DialectAsmPrinter &printer) const {
   printer << "opaque<\"";
   llvm::printEscapedString(getValue(), printer.getStream());
   printer << "\">";
 }

mlir/lib/TableGen/Dialect.cpp

 bool Dialect::hasOperationInterfaceFallback() const {
   return def->getValueAsBit("hasOperationInterfaceFallback");
 }
 
 bool Dialect::useDefaultAttributePrinterParser() const {
   return def->getValueAsBit("useDefaultAttributePrinterParser");
 }
 
+bool Dialect::useDefaultTypePrinterParser() const {
+  return def->getValueAsBit("useDefaultTypePrinterParser");
+}
+
 Dialect::EmitPrefix Dialect::getEmitAccessorPrefix() const {
   int prefix = def->getValueAsInt("emitAccessorPrefix");
   if (prefix < 0 || prefix > static_cast<int>(EmitPrefix::Both))
     PrintFatalError(def->getLoc(), "Invalid accessor prefix value");
   return static_cast<EmitPrefix>(prefix);
 }
 
 bool Dialect::operator==(const Dialect &other) const {
   return def == other.def;
 }
 
 bool Dialect::operator<(const Dialect &other) const {
   return getName() < other.getName();
 }

mlir/tools/mlir-tblgen/AttrOrTypeDefGen.cpp

 /// Print an attribute registered to this dialect.
 void {0}::printAttribute(::mlir::Attribute attr,
                          ::mlir::DialectAsmPrinter &printer) const {{
   if (succeeded(generatedAttributePrinter(attr, printer)))
     return;
 }
 )";
 
+/// The code block for default type parser/printer dispatch boilerplate.
+/// {0}: the dialect fully qualified class name.
+static const char *const dialectDefaultTypePrinterParserDispatch = R"(
+/// Parse a type registered to this dialect.
+::mlir::Type {0}::parseType(::mlir::DialectAsmParser &parser) const {{
+  llvm::SMLoc typeLoc = parser.getCurrentLocation();
+  StringRef mnemonic;
+  if (parser.parseKeyword(&mnemonic))
+    return Type();
+  Type genType;
+  OptionalParseResult parseResult =
+      generatedTypeParser(parser, mnemonic, genType);
+  if (parseResult.hasValue())
+    return genType;
+  parser.emitError(typeLoc) << "unknown  type `"
+      << mnemonic << "` in dialect `" << getNamespace() << "`";
+  return {{};
+}
+/// Print a type registered to this dialect.
+void {0}::printType(::mlir::Type type,
+                    ::mlir::DialectAsmPrinter &printer) const {{
+  if (succeeded(generatedTypePrinter(type, printer)))
+    return;
+}
+)";
+
 /// The code block used to start the auto-generated printer function.
 ///
 /// {0}: The name of the base value type, e.g. Attribute or Type.
 static const char *const defPrinterDispatchStartStr = R"(
 static ::mlir::LogicalResult generated{0}Printer(
                          ::mlir::{0} def, ::mlir::DialectAsmPrinter &printer) {{
   return ::llvm::TypeSwitch<::mlir::{0}, ::mlir::LogicalResult>(def)
 )";
bool DefGenerator::emitDefs(StringRef selectedDialect) {
   }
 
   // Emit the default parser/printer for Attributes if the dialect asked for it.
   if (valueType == "Attribute" &&
       defs.front().getDialect().useDefaultAttributePrinterParser())
     os << llvm::formatv(dialectDefaultAttrPrinterParserDispatch,
                         defs.front().getDialect().getCppClassName());
 
+  // Emit the default parser/printer for Types if the dialect asked for it.
+  if (valueType == "Type" &&
+      defs.front().getDialect().useDefaultTypePrinterParser())
+    os << llvm::formatv(dialectDefaultTypePrinterParserDispatch,
+                        defs.front().getDialect().getCppClassName());
+
   return false;
 }
 
 //===----------------------------------------------------------------------===//
 // GEN: Registration hooks
 //===----------------------------------------------------------------------===//
 
 //===----------------------------------------------------------------------===//

mlir/tools/mlir-tblgen/DialectGen.cpp

// Emit all nested namespaces.
     std::string cppName = dialect.getCppClassName();
     os << llvm::formatv(dialectDeclBeginStr, cppName, dialect.getName(),
                         dependentDialectRegistrations);
 
     // Check for any attributes/types registered to this dialect.  If there are,
     // add the hooks for parsing/printing.
     if (!dialectAttrs.empty() || dialect.useDefaultAttributePrinterParser())
       os << attrParserDecl;
-    if (!dialectTypes.empty())
+    if (!dialectTypes.empty() || dialect.useDefaultTypePrinterParser())
       os << typeParserDecl;
 
     // Add the decls for the various features of the dialect.
     if (dialect.hasCanonicalizer())
       os << canonicalizerDecl;
     if (dialect.hasConstantMaterializer())
       os << constantMaterializerDecl;
     if (dialect.hasOperationAttrVerify())