Merge #146: Add getters for Span and improve error handling

f00714d added getters for span in parse and ast structs (Volodymyr Herashchenko)
23e637c added getter for span in parse.rs and ast.rs (Volodymyr Herashchenko)
b2ab9f4 added getters to span and error in RichError (Volodymyr Herashchenko)

Pull request description:

  ## Description
  This pull request introduces getter methods for Span in Parse and AST nodes, and adds getters for RichError fields. These changes make span and error information more accessible, simplifying the development of tools for SimplicityHL.
  
  ## Impact
  - Supports easier integration with developer tooling (e.g., LSP, analyzers).
  - No breaking changes introduced.


ACKs for top commit:
  apoelstra:
    ACK f00714d; successfully ran local tests


Tree-SHA512: 25e66a907858973241544a897273f3242fc234f4ce8057b5db65d952738eec113dcbfdcdebcb3a825a3fd603cc47ef93577f5a4f6de5fa8064df4dfb46929254

Author: apoelstra

src/ast.rs

@@ -126,6 +126,11 @@ impl Assignment {
     pub fn expression(&self) -> &Expression {
         &self.expression
     }
+
+    /// Access the span of the assignment.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl_eq_hash!(Assignment; pattern, expression);
@@ -150,6 +155,11 @@ impl Expression {
     pub fn ty(&self) -> &ResolvedType {
         &self.ty
     }
+
+    /// Access the span of the expression.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 /// Variant of an expression.
@@ -193,6 +203,11 @@ impl SingleExpression {
     pub fn ty(&self) -> &ResolvedType {
         &self.ty
     }
+
+    /// Access the span of the expression.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl_eq_hash!(SingleExpression; inner, ty);
@@ -244,6 +259,11 @@ impl Call {
     pub fn args(&self) -> &Arc<[Expression]> {
         &self.args
     }
+
+    /// Access the span of the call.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl_eq_hash!(Call; name, args);
@@ -355,6 +375,11 @@ impl Match {
     pub fn right(&self) -> &MatchArm {
         &self.right
     }
+
+    /// Access the span of the match statement.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl_eq_hash!(Match; scrutinee, left, right);
@@ -397,6 +422,11 @@ impl Module {
     pub fn assignments(&self) -> &[ModuleAssignment] {
         &self.assignments
     }
+
+    /// Access the span of the module.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 #[derive(Clone, Debug, Eq, PartialEq, Hash)]
@@ -416,6 +446,11 @@ impl ModuleAssignment {
     pub fn value(&self) -> &Value {
         &self.value
     }
+
+    /// Access the span of the module.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]

src/error.rs

@@ -221,6 +221,14 @@ impl RichError {
             file: Some(file),
         }
     }
+
+    pub fn error(&self) -> &Error {
+        &self.error
+    }
+
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl fmt::Display for RichError {

src/parse.rs

@@ -86,6 +86,11 @@ impl Function {
     pub fn body(&self) -> &Expression {
         &self.body
     }
+
+    /// Access the span of the function.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl_eq_hash!(Function; name, params, ret, body);
@@ -143,6 +148,11 @@ impl Assignment {
     pub fn expression(&self) -> &Expression {
         &self.expression
     }
+
+    /// Access the span of the expression.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl_eq_hash!(Assignment; pattern, ty, expression);
@@ -165,6 +175,11 @@ impl Call {
     pub fn args(&self) -> &[Expression] {
         self.args.as_ref()
     }
+
+    /// Access the span of the call.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl_eq_hash!(Call; name, args);
@@ -223,6 +238,11 @@ impl TypeAlias {
     pub fn ty(&self) -> &AliasedType {
         &self.ty
     }
+
+    /// Access the span of the alias.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl_eq_hash!(TypeAlias; name, ty);
@@ -240,6 +260,11 @@ impl Expression {
         &self.inner
     }
 
+    /// Access the span of the expression.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
+
     /// Convert the expression into a block expression.
     #[cfg(feature = "arbitrary")]
     fn into_block(self) -> Self {
@@ -278,6 +303,11 @@ impl SingleExpression {
     pub fn inner(&self) -> &SingleExpressionInner {
         &self.inner
     }
+
+    /// Access the span of the expression.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl_eq_hash!(SingleExpression; inner);
@@ -344,6 +374,11 @@ impl Match {
         &self.right
     }
 
+    /// Access the span of the match statement.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
+
     /// Get the type of the expression that is matched.
     pub fn scrutinee_type(&self) -> AliasedType {
         match (&self.left.pattern, &self.right.pattern) {
@@ -430,6 +465,11 @@ impl ModuleProgram {
     pub fn items(&self) -> &[ModuleItem] {
         &self.items
     }
+
+    /// Access the span of the program.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 impl_eq_hash!(ModuleProgram; items);
@@ -458,6 +498,11 @@ impl Module {
     pub fn assignments(&self) -> &[ModuleAssignment] {
         &self.assignments
     }
+
+    /// Access the span of the module.
+    pub fn span(&self) -> &Span {
+        &self.span
+    }
 }
 
 #[derive(Clone, Debug, Eq, PartialEq, Hash)]