From 2185206f1b39720bcf94991b1a9c0602525400a2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Moritz=20H=C3=B6lting?=
 <87192362+moritz-hoelting@users.noreply.github.com>
Date: Wed, 5 Mar 2025 14:43:10 +0100
Subject: [PATCH] improve debug formatting for Scope and FunctionData

---
 src/transpile/mod.rs        | 61 +++++++++++++++++++++++++++++++++++--
 src/transpile/transpiler.rs |  2 +-
 src/transpile/variables.rs  | 22 ++++++++++++-
 3 files changed, 80 insertions(+), 5 deletions(-)

diff --git a/src/transpile/mod.rs b/src/transpile/mod.rs
index 20e6ab5..ac21ba0 100644
--- a/src/transpile/mod.rs
+++ b/src/transpile/mod.rs
@@ -1,9 +1,12 @@
 //! The transpile module is responsible for transpiling the abstract syntax tree into a data pack.
 
-use std::collections::{BTreeMap, HashMap};
+use std::{
+    collections::{BTreeMap, HashMap},
+    fmt::Debug,
+};
 
 use crate::{
-    base::source_file::Span,
+    base::source_file::{SourceElement, Span},
     syntax::syntax_tree::{expression::Expression, statement::Statement, AnnotationValue},
 };
 
@@ -28,7 +31,7 @@ mod variables;
 
 pub mod util;
 
-#[derive(Debug, Clone, PartialEq, Eq)]
+#[derive(Clone, PartialEq, Eq)]
 pub(super) struct FunctionData {
     pub(super) namespace: String,
     pub(super) identifier_span: Span,
@@ -69,3 +72,55 @@ impl From<Option<AnnotationValue>> for TranspileAnnotationValue {
         }
     }
 }
+
+impl Debug for FunctionData {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let mut s = f.debug_struct("FunctionData");
+
+        struct HiddenList;
+        impl Debug for HiddenList {
+            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+                let mut list = f.debug_list();
+                list.finish_non_exhaustive()
+            }
+        }
+
+        struct AnnotationsWrapper<'a, I>(&'a I);
+        impl<'a, I> Debug for AnnotationsWrapper<'a, I>
+        where
+            &'a I: IntoIterator<Item = (&'a String, &'a TranspileAnnotationValue)>,
+        {
+            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+                struct AnnotationValueWrapper<'a>(&'a TranspileAnnotationValue);
+                impl<'a> Debug for AnnotationValueWrapper<'a> {
+                    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+                        match self.0 {
+                            TranspileAnnotationValue::None => None::<u8>.fmt(f),
+                            TranspileAnnotationValue::Expression(expr) => expr.span().str().fmt(f),
+                            TranspileAnnotationValue::Map(map) => AnnotationsWrapper(map).fmt(f),
+                        }
+                    }
+                }
+
+                let mut m = f.debug_map();
+
+                m.entries(
+                    self.0
+                        .into_iter()
+                        .map(|(k, v)| (k, AnnotationValueWrapper(v))),
+                );
+
+                m.finish()
+            }
+        }
+
+        s.field("namespace", &self.namespace);
+        s.field("identifier", &self.identifier_span.str());
+        s.field("public", &self.public);
+        s.field("parameters", &self.parameters);
+        s.field("statements", &HiddenList);
+        s.field("annotations", &AnnotationsWrapper(&self.annotations));
+
+        s.finish()
+    }
+}
diff --git a/src/transpile/transpiler.rs b/src/transpile/transpiler.rs
index 2bb5da5..80b0bfe 100644
--- a/src/transpile/transpiler.rs
+++ b/src/transpile/transpiler.rs
@@ -727,7 +727,7 @@ impl Transpiler {
             }
 
             scope.set_variable(
-                &name,
+                single.identifier().span.str(),
                 VariableType::ScoreboardValue {
                     objective: name.clone(),
                     target,
diff --git a/src/transpile/variables.rs b/src/transpile/variables.rs
index d9e9cbe..4aefbc4 100644
--- a/src/transpile/variables.rs
+++ b/src/transpile/variables.rs
@@ -2,6 +2,8 @@
 
 use std::{
     collections::HashMap,
+    fmt::Debug,
+    ops::Deref,
     sync::{Arc, OnceLock, RwLock},
 };
 
@@ -42,7 +44,7 @@ pub enum VariableType {
     },
 }
 
-#[derive(Debug, Default)]
+#[derive(Default)]
 pub struct Scope<'a> {
     parent: Option<&'a Arc<Self>>,
     variables: RwLock<HashMap<String, Arc<VariableType>>>,
@@ -87,6 +89,24 @@ impl<'a> Scope<'a> {
     }
 }
 
+impl<'a> Debug for Scope<'a> {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let mut s = f.debug_struct("Scope");
+        s.field("parent", &self.parent);
+
+        struct VariableWrapper<'a>(&'a RwLock<HashMap<String, Arc<VariableType>>>);
+        impl<'a> Debug for VariableWrapper<'a> {
+            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+                let s = self.0.read().unwrap();
+                s.deref().fmt(f)
+            }
+        }
+
+        s.field("variables", &VariableWrapper(&self.variables));
+        s.finish()
+    }
+}
+
 impl Transpiler {}
 
 #[cfg(test)]