Add attribute displaying to IR printer (#493)

UnsignedByte · web-flow · commit dfcd749056ab · 2025-02-27T21:36:03.000Z
* attribute display trait

* add display to IR printer

* cleanup

* manual display trait implementation
diff --git a/crates/filament/src/ast_passes/toplevel.rs b/crates/filament/src/ast_passes/toplevel.rs
@@ -72,7 +72,9 @@ impl Visitor for TopLevel {
         // If no toplevel component was found, find the component with the name "main"
         if self.has_toplevel.is_none() {
             for comp in ast.components.iter_mut() {
-                if comp.sig.name.as_ref() == "main" {
+                if comp.sig.name.as_ref() == "main"
+                    && !comp.sig.attributes.has(utils::CompBool::TopLevel)
+                {
                     // Add the toplevel attribute to the component
                     comp.sig.attributes.set(
                         utils::CompBool::TopLevel,
diff --git a/crates/ir/src/printer/comp.rs b/crates/ir/src/printer/comp.rs
@@ -133,9 +133,11 @@ impl<'a, 'b> Printer<'a, 'b> {
 
     fn port(&self, idx: ir::PortIdx, indent: usize) -> String {
         let port = self.comp.get(idx);
+        let port_attrs = self.comp.port_attrs.get(idx);
         format!(
-            "{:indent$}{}: {} {}",
+            "{:indent$}{}{}: {} {}",
             "",
+            port_attrs,
             self.comp.display(idx),
             self.comp.display(&port.live),
             self.comp.display(port.width),
@@ -149,6 +151,8 @@ impl<'a, 'b> Printer<'a, 'b> {
         indent: usize,
         f: &mut F,
     ) -> io::Result<()> {
+        writeln!(f, "{}", self.comp.attrs)?;
+
         if self.comp.is_ext() {
             write!(f, "ext ")?;
         };
diff --git a/crates/utils/src/attr/attributes.rs b/crates/utils/src/attr/attributes.rs
@@ -1,14 +1,14 @@
 use super::{AttrCtx, AttrStore};
 use crate::GPosIdx;
-use std::{hash::Hash, str::FromStr};
+use std::{fmt::Display, hash::Hash};
 
 /// Stores the attributes of a component
 #[derive(Clone)]
 pub struct Attributes<Bool, Num, Float>
 where
-    Bool: FromStr + Hash + Eq + Copy,
-    Num: FromStr + Hash + Eq + Copy,
-    Float: FromStr + Hash + Eq + Copy,
+    Bool: Hash + Eq + Copy,
+    Num: Hash + Eq + Copy,
+    Float: Hash + Eq + Copy,
 {
     /// Numerical attributes
     num_attrs: AttrStore<Num, u64>,
@@ -20,9 +20,9 @@ where
 
 impl<Bool, Num, Float> AttrCtx<Num, u64> for Attributes<Bool, Num, Float>
 where
-    Bool: FromStr + Hash + Eq + Copy,
-    Num: FromStr + Hash + Eq + Copy,
-    Float: FromStr + Hash + Eq + Copy,
+    Bool: Hash + Eq + Copy,
+    Num: Hash + Eq + Copy,
+    Float: Hash + Eq + Copy,
 {
     fn get(&self, attr: Num) -> Option<&u64> {
         self.num_attrs.get(attr)
@@ -43,9 +43,9 @@ where
 
 impl<Bool, Num, Float> AttrCtx<Bool, bool> for Attributes<Bool, Num, Float>
 where
-    Bool: FromStr + Hash + Eq + Copy,
-    Num: FromStr + Hash + Eq + Copy,
-    Float: FromStr + Hash + Eq + Copy,
+    Bool: Hash + Eq + Copy,
+    Num: Hash + Eq + Copy,
+    Float: Hash + Eq + Copy,
 {
     fn get(&self, attr: Bool) -> Option<&bool> {
         self.bool_attrs.get(attr)
@@ -66,9 +66,9 @@ where
 
 impl<Bool, Num, Float> AttrCtx<Float, f64> for Attributes<Bool, Num, Float>
 where
-    Bool: FromStr + Hash + Eq + Copy,
-    Num: FromStr + Hash + Eq + Copy,
-    Float: FromStr + Hash + Eq + Copy,
+    Bool: Hash + Eq + Copy,
+    Num: Hash + Eq + Copy,
+    Float: Hash + Eq + Copy,
 {
     fn get(&self, attr: Float) -> Option<&f64> {
         self.float_attrs.get(attr)
@@ -89,9 +89,9 @@ where
 
 impl<Bool, Num, Float> Default for Attributes<Bool, Num, Float>
 where
-    Bool: FromStr + Hash + Eq + Copy,
-    Num: FromStr + Hash + Eq + Copy,
-    Float: FromStr + Hash + Eq + Copy,
+    Bool: Hash + Eq + Copy,
+    Num: Hash + Eq + Copy,
+    Float: Hash + Eq + Copy,
 {
     fn default() -> Self {
         Self {
@@ -101,3 +101,39 @@ where
         }
     }
 }
+
+impl<Bool, Num, Float> Display for Attributes<Bool, Num, Float>
+where
+    Bool: Display + Hash + Eq + Copy,
+    Num: Display + Hash + Eq + Copy,
+    Float: Display + Hash + Eq + Copy,
+{
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "#[")?;
+        let bool_attrs =
+            self.bool_attrs.iter().map(|(attr, value)| match value {
+                true => format!("{}", attr),
+                false => format!("not({})", attr),
+            });
+        let num_attrs = self
+            .num_attrs
+            .iter()
+            .map(|(attr, value)| format!("{}={}", attr, value));
+        let float_attrs = self
+            .float_attrs
+            .iter()
+            .map(|(attr, value)| format!("{}={}", attr, value));
+
+        write!(
+            f,
+            "{}",
+            bool_attrs
+                .chain(num_attrs)
+                .chain(float_attrs)
+                .collect::<Vec<_>>()
+                .join(", ")
+        )?;
+
+        write!(f, "]")
+    }
+}
diff --git a/crates/utils/src/attr/store.rs b/crates/utils/src/attr/store.rs
@@ -1,18 +1,18 @@
 use crate::{attr::AttrCtx, GPosIdx};
-use std::collections::HashMap;
+use std::{collections::HashMap, hash::Hash};
 
 /// A store for attributes
 #[derive(Clone)]
 pub struct AttrStore<Attr, Value>
 where
-    Attr: Eq + std::hash::Hash + Copy,
+    Attr: Eq + Hash + Copy,
 {
     attrs: HashMap<Attr, (Value, GPosIdx)>,
 }
 
 impl<Attr, Value> AttrStore<Attr, Value>
 where
-    Attr: Eq + std::hash::Hash + Copy,
+    Attr: Eq + Hash + Copy,
 {
     /// iterates over the attributes
     pub fn iter(&self) -> impl Iterator<Item = (Attr, &Value)> {
@@ -22,7 +22,7 @@ where
 
 impl<Attr, Value> AttrCtx<Attr, Value> for AttrStore<Attr, Value>
 where
-    Attr: Eq + std::hash::Hash + Copy,
+    Attr: Eq + Hash + Copy,
 {
     fn get(&self, attr: Attr) -> Option<&Value> {
         self.attrs.get(&attr).map(|(value, _)| value)
@@ -43,7 +43,7 @@ where
 
 impl<Attr, Value> Default for AttrStore<Attr, Value>
 where
-    Attr: Eq + std::hash::Hash + Copy,
+    Attr: Eq + Hash + Copy,
 {
     fn default() -> Self {
         Self {
diff --git a/crates/utils/src/macros.rs b/crates/utils/src/macros.rs
@@ -35,7 +35,7 @@ macro_rules! attr_enum {
           )*
       };
   ) => {
-      #[derive(Clone, Copy, PartialEq, strum_macros::EnumString, Eq, Hash)]
+      #[derive(Clone, Copy, PartialEq, strum_macros::EnumString, Debug, Eq, Hash)]
       pub enum $name {
           $(
               $(#[$pub_meta])*
@@ -48,6 +48,23 @@ macro_rules! attr_enum {
               $priv,
           )*
       }
+
+      impl std::fmt::Display for $name {
+            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+                match self {
+                    $(
+                        Self::$pub => write!(f, "{}", $pub_str),
+                    )*
+                    $(
+                        Self::$priv => write!(f, "{}", stringify!($priv)),
+                    )*
+                    // Unreachable pattern here to handle the case where the enum
+                    // has no variants
+                    #[allow(unreachable_patterns)]
+                    _ => write!(f, "{}", stringify!($name)),
+                }
+            }
+      }
   };
   (enum $name:ident;)  => {
       $crate::attr_enum! {
@@ -89,7 +106,7 @@ macro_rules! attr_enum {
           priv {
               $(
                   $(#[$priv_meta])*
-                  $priv,
+                  $priv: $priv_str,
               )*
           };
       }
