Allow to print MLIR instead of xDSL (#136)

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog 
+
+All changes should be documented in this file.
+
+## [Unreleased]
+### Added
+- Changelog file
+### Changed
+- Rename `module` to `builtin.module`

src/xdsl/dialects/builtin.py

@@ -3,8 +3,8 @@
 from dataclasses import dataclass
 from typing import TypeAlias, List, cast, Type, Sequence, Optional
 
-from xdsl.ir import (MLContext, TYPE_CHECKING, Data, ParametrizedAttribute,
-                     Operation)
+from xdsl.ir import (MLContext, TYPE_CHECKING, Data, MLIRType,
+                     ParametrizedAttribute, Operation)
 from xdsl.irdl import (irdl_attr_definition, attr_constr_coercion,
                        irdl_to_attr_constraint, irdl_op_definition, builder,
                        ParameterDef, SingleBlockRegionDef, TypeVar, Generic,
@@ -263,7 +263,7 @@ def from_type_list(types: List[Attribute]) -> TupleType:
 
 
 @irdl_attr_definition
-class VectorType(Generic[_VectorTypeElems], ParametrizedAttribute):
+class VectorType(Generic[_VectorTypeElems], ParametrizedAttribute, MLIRType):
     name = "vector"
 
     shape: ParameterDef[ArrayAttr[AnyIntegerAttr]]
@@ -305,7 +305,7 @@ def from_params(
 
 
 @irdl_attr_definition
-class TensorType(Generic[_TensorTypeElems], ParametrizedAttribute):
+class TensorType(Generic[_TensorTypeElems], ParametrizedAttribute, MLIRType):
     name = "tensor"
 
     shape: ParameterDef[ArrayAttr[AnyIntegerAttr]]
@@ -389,14 +389,14 @@ def tensor_from_list(
 
 
 @irdl_attr_definition
-class Float32Type(ParametrizedAttribute):
+class Float32Type(ParametrizedAttribute, MLIRType):
     name = "f32"
 
 
 f32 = Float32Type()
 
 
-class Float64Type(ParametrizedAttribute):
+class Float64Type(ParametrizedAttribute, MLIRType):
     name = "f64"
 
 
@@ -457,7 +457,7 @@ class UnitAttr(ParametrizedAttribute):
 
 
 @irdl_attr_definition
-class FunctionType(ParametrizedAttribute):
+class FunctionType(ParametrizedAttribute, MLIRType):
     name = "fun"
 
     inputs: ParameterDef[ArrayAttr[Attribute]]

src/xdsl/dialects/cmath.py

@@ -2,7 +2,7 @@
 from dataclasses import dataclass
 
 from xdsl.dialects.builtin import Float32Type, Float64Type
-from xdsl.ir import MLContext
+from xdsl.ir import MLContext, MLIRType
 from xdsl.irdl import (irdl_op_definition, Operation, OperandDef,
                        irdl_attr_definition, ParameterDef, ParamAttrConstraint,
                        AnyOf, ResultDef, ParametrizedAttribute,
@@ -21,7 +21,7 @@ def __post_init__(self):
 
 
 @irdl_attr_definition
-class ComplexType(ParametrizedAttribute):
+class ComplexType(ParametrizedAttribute, MLIRType):
     name = "cmath.complex"
     data: ParameterDef[Float64Type | Float32Type]
 

src/xdsl/dialects/llvm.py

@@ -5,7 +5,8 @@
 from xdsl.irdl import (ParameterDef, AnyAttr, irdl_op_builder,
                        irdl_attr_definition, AttributeDef, OperandDef,
                        ResultDef, irdl_op_definition, builder)
-from xdsl.ir import (MLContext, ParametrizedAttribute, Attribute, Operation)
+from xdsl.ir import (MLContext, MLIRType, ParametrizedAttribute, Attribute,
+                     Operation)
 from xdsl.dialects.builtin import (StringAttr, ArrayOfConstraint, ArrayAttr,
                                    IntegerAttr, IntegerType)
 
@@ -27,7 +28,7 @@ def __post_init__(self):
 
 
 @irdl_attr_definition
-class LLVMStructType(ParametrizedAttribute):
+class LLVMStructType(ParametrizedAttribute, MLIRType):
     name = "llvm.struct"
 
     # An empty string refers to a struct without a name.
@@ -44,6 +45,12 @@ def from_type_list(types: list[Attribute]) -> LLVMStructType:
             [StringAttr.from_str(""),
              ArrayAttr.from_list(types)])
 
+    def print_parameters_as_mlir(self, printer: Printer) -> None:
+        assert self.struct_name.data == ""
+        printer.print("<(")
+        printer.print_list(self.types.data, printer.print_attribute)
+        printer.print(")>")
+
 
 @irdl_op_definition
 class LLVMExtractValue(Operation):

src/xdsl/dialects/memref.py

@@ -6,7 +6,7 @@
 from xdsl.dialects.builtin import (IntegerAttr, IndexType, ArrayAttr,
                                    IntegerType, FlatSymbolRefAttr, StringAttr,
                                    DenseIntOrFPElementsAttr)
-from xdsl.ir import Operation, SSAValue, MLContext
+from xdsl.ir import MLIRType, Operation, SSAValue, MLContext
 from xdsl.irdl import (irdl_attr_definition, irdl_op_definition, builder,
                        ParameterDef, Generic, Attribute, ParametrizedAttribute,
                        AnyAttr, OperandDef, VarOperandDef, ResultDef,
@@ -36,7 +36,7 @@ def __post_init__(self):
 
 
 @irdl_attr_definition
-class MemRefType(Generic[_MemRefTypeElement], ParametrizedAttribute):
+class MemRefType(Generic[_MemRefTypeElement], ParametrizedAttribute, MLIRType):
     name = "memref"
 
     shape: ParameterDef[ArrayAttr[AnyIntegerAttr]]

src/xdsl/ir.py

@@ -173,6 +173,22 @@ def __hash__(self) -> int:
         return hash(id(self))
 
 
+@dataclass
+class MLIRType:
+    """
+    A class representing an MLIR type.
+    This class should only be inherited by classes inheriting Attribute.
+    This class is only used for printing attributes in the MLIR format,
+    inheriting this class prefix the attribute by `!` instead of `#`.
+    """
+
+    def __post_init__(self):
+        if not isinstance(self, Attribute):
+            raise TypeError(
+                "MLIRType should only be inherited by classes inheriting Attribute"
+            )
+
+
 A = TypeVar('A', bound='Attribute')
 
 
@@ -221,6 +237,10 @@ def parse_parameter(parser: Parser) -> DataElement:
     def print_parameter(data: DataElement, printer: Printer) -> None:
         """Print the attribute parameter."""
 
+    def print_parameter_as_mlir(self, printer: Printer) -> None:
+        """Print the attribute parameter in MLIR format."""
+        self.print_parameter(self.data, printer)
+
 
 @dataclass(frozen=True)
 class ParametrizedAttribute(Attribute):
@@ -234,6 +254,12 @@ def irdl_definition(cls) -> ParamAttrDef:
         """Get the IRDL attribute definition."""
         ...
 
+    def print_parameters_as_mlir(self, printer: Printer) -> None:
+        if len(self.parameters) != 0:
+            printer.print("<")
+            printer.print_list(self.parameters, printer.print_attribute)
+            printer.print(">")
+
 
 @dataclass
 class Operation: