feat(experimental): show macro errors where they happen (#7333)

Co-authored-by: jfecher <jake@aztecprotocol.com>
noir-lang · Feb 20, 2025 · 04dd6d9 · 04dd6d9
1 parent 44c35dc
commit 04dd6d9
Show file tree

Hide file tree

Showing 116 changed files with 4,610 additions and 2,682 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/compiler/noirc_errors/src/lib.rs b/compiler/noirc_errors/src/lib.rs
@@ -6,7 +6,7 @@
 pub mod debug_info;
 mod position;
 pub mod reporter;
-pub use position::{Location, Position, Span, Spanned};
+pub use position::{Located, Location, Position, Span, Spanned};
 pub use reporter::{CustomDiagnostic, DiagnosticKind};
 
 #[derive(Debug, Clone, PartialEq, Eq)]

diff --git a/compiler/noirc_errors/src/position.rs b/compiler/noirc_errors/src/position.rs
@@ -2,12 +2,68 @@ use codespan::Span as ByteSpan;
 use fm::FileId;
 use serde::{Deserialize, Serialize};
 use std::{
+    cmp::Ordering,
     hash::{Hash, Hasher},
     ops::Range,
 };
 
 pub type Position = u32;
 
+#[derive(Eq, Debug, Clone)]
+pub struct Located<T> {
+    pub contents: T,
+    location: Location,
+}
+
+/// This is important for tests. Two Located objects are equal if their content is equal
+/// They may not have the same location. Use `.location()` to test for Location being equal specifically
+impl<T: PartialEq> PartialEq<Located<T>> for Located<T> {
+    fn eq(&self, other: &Located<T>) -> bool {
+        self.contents == other.contents
+    }
+}
+
+impl<T: PartialOrd> PartialOrd<Located<T>> for Located<T> {
+    fn partial_cmp(&self, other: &Located<T>) -> Option<Ordering> {
+        self.contents.partial_cmp(&other.contents)
+    }
+}
+
+impl<T: Ord> Ord for Located<T> {
+    fn cmp(&self, other: &Located<T>) -> Ordering {
+        self.contents.cmp(&other.contents)
+    }
+}
+
+impl<T: Default> Default for Located<T> {
+    fn default() -> Self {
+        Self { contents: Default::default(), location: Location::dummy() }
+    }
+}
+
+/// Hash-based data structures (HashMap, HashSet) rely on the inverse of Hash
+/// being injective, i.e. x.eq(y) => hash(x, H) == hash(y, H), we hence align
+/// this with the above
+impl<T: Hash> Hash for Located<T> {
+    fn hash<H: Hasher>(&self, state: &mut H) {
+        self.contents.hash(state);
+    }
+}
+
+impl<T> Located<T> {
+    pub fn from(location: Location, contents: T) -> Located<T> {
+        Located { location, contents }
+    }
+
+    pub fn span(&self) -> Span {
+        self.location.span
+    }
+
+    pub fn location(&self) -> Location {
+        self.location
+    }
+}
+
 #[derive(PartialOrd, Eq, Ord, Debug, Clone, Default)]
 pub struct Spanned<T> {
     pub contents: T,
@@ -36,17 +92,13 @@ impl<T> Spanned<T> {
         Spanned { span: Span::inclusive(start, end), contents }
     }
 
-    pub const fn from(t_span: Span, contents: T) -> Spanned<T> {
+    pub fn from(t_span: Span, contents: T) -> Spanned<T> {
         Spanned { span: t_span, contents }
     }
 
     pub fn span(&self) -> Span {
         self.span
     }
-
-    pub fn set_span(&mut self, span: Span) {
-        self.span = span;
-    }
 }
 
 impl<T> std::borrow::Borrow<T> for Spanned<T> {
@@ -135,12 +187,33 @@ impl Location {
     }
 
     pub fn dummy() -> Self {
-        Self { span: Span::single_char(0), file: FileId::dummy() }
+        Self { span: Span::default(), file: FileId::dummy() }
     }
 
     pub fn contains(&self, other: &Location) -> bool {
         self.file == other.file && self.span.contains(&other.span)
     }
+
+    #[must_use]
+    pub fn merge(self, other: Location) -> Location {
+        if self.file == other.file {
+            Location::new(self.span.merge(other.span), self.file)
+        } else {
+            self
+        }
+    }
+}
+
+impl Ord for Location {
+    fn cmp(&self, other: &Self) -> Ordering {
+        (self.file, self.span).cmp(&(other.file, other.span))
+    }
+}
+
+impl PartialOrd for Location {
+    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+        Some(self.cmp(other))
+    }
 }
 
 #[cfg(test)]

diff --git a/compiler/noirc_evaluator/src/ssa/parser/mod.rs b/compiler/noirc_evaluator/src/ssa/parser/mod.rs
@@ -818,7 +818,7 @@ impl<'a> Parser<'a> {
     }
 
     fn eat_identifier(&mut self) -> ParseResult<Option<Identifier>> {
-        let span = self.token.to_span();
+        let span = self.token.span();
         if let Some(name) = self.eat_ident()? {
             Ok(Some(Identifier::new(name, span)))
         } else {
@@ -960,72 +960,69 @@ impl<'a> Parser<'a> {
     fn expected_instruction_or_terminator<T>(&mut self) -> ParseResult<T> {
         Err(ParserError::ExpectedInstructionOrTerminator {
             found: self.token.token().clone(),
-            span: self.token.to_span(),
+            span: self.token.span(),
         })
     }
 
     fn expected_string_or_data<T>(&mut self) -> ParseResult<T> {
         Err(ParserError::ExpectedStringOrData {
             found: self.token.token().clone(),
-            span: self.token.to_span(),
+            span: self.token.span(),
         })
     }
 
     fn expected_byte_string<T>(&mut self) -> ParseResult<T> {
         Err(ParserError::ExpectedByteString {
             found: self.token.token().clone(),
-            span: self.token.to_span(),
+            span: self.token.span(),
         })
     }
 
     fn expected_identifier<T>(&mut self) -> ParseResult<T> {
         Err(ParserError::ExpectedIdentifier {
             found: self.token.token().clone(),
-            span: self.token.to_span(),
+            span: self.token.span(),
         })
     }
 
     fn expected_int<T>(&mut self) -> ParseResult<T> {
-        Err(ParserError::ExpectedInt {
-            found: self.token.token().clone(),
-            span: self.token.to_span(),
-        })
+        Err(ParserError::ExpectedInt { found: self.token.token().clone(), span: self.token.span() })
     }
 
     fn expected_type<T>(&mut self) -> ParseResult<T> {
         Err(ParserError::ExpectedType {
             found: self.token.token().clone(),
-            span: self.token.to_span(),
+            span: self.token.span(),
         })
     }
 
     fn expected_value<T>(&mut self) -> ParseResult<T> {
         Err(ParserError::ExpectedValue {
             found: self.token.token().clone(),
-            span: self.token.to_span(),
+            span: self.token.span(),
         })
     }
 
     fn expected_global_value<T>(&mut self) -> ParseResult<T> {
         Err(ParserError::ExpectedGlobalValue {
             found: self.token.token().clone(),
-            span: self.token.to_span(),
+            span: self.token.span(),
         })
     }
 
     fn expected_token<T>(&mut self, token: Token) -> ParseResult<T> {
         Err(ParserError::ExpectedToken {
             token,
             found: self.token.token().clone(),
-            span: self.token.to_span(),
+            span: self.token.span(),
         })
     }
 
     fn expected_one_of_tokens<T>(&mut self, tokens: &[Token]) -> ParseResult<T> {
         Err(ParserError::ExpectedOneOfTokens {
             tokens: tokens.to_vec(),
             found: self.token.token().clone(),
-            span: self.token.to_span(),
+            span: self.token.span(),
         })
     }
 }

diff --git a/compiler/noirc_evaluator/src/ssa/parser/token.rs b/compiler/noirc_evaluator/src/ssa/parser/token.rs
@@ -12,7 +12,7 @@ impl SpannedToken {
         SpannedToken(Spanned::from(span, token))
     }
 
-    pub(crate) fn to_span(&self) -> Span {
+    pub(crate) fn span(&self) -> Span {
         self.0.span()
     }
 

diff --git a/compiler/noirc_evaluator/src/ssa/ssa_gen/mod.rs b/compiler/noirc_evaluator/src/ssa/ssa_gen/mod.rs
@@ -252,7 +252,7 @@ impl<'a> FunctionContext<'a> {
                             let value = value.replace('{', "{{").replace('}', "}}");
                             string.push_str(&value);
                         }
-                        FmtStrFragment::Interpolation(value, _span) => {
+                        FmtStrFragment::Interpolation(value, _) => {
                             string.push('{');
                             string.push_str(value);
                             string.push('}');

diff --git a/compiler/noirc_frontend/src/ast/enumeration.rs b/compiler/noirc_frontend/src/ast/enumeration.rs
@@ -4,7 +4,7 @@ use crate::ast::{Ident, UnresolvedGenerics, UnresolvedType};
 use crate::token::SecondaryAttribute;
 
 use iter_extended::vecmap;
-use noirc_errors::Span;
+use noirc_errors::Location;
 
 use super::{Documented, ItemVisibility};
 
@@ -16,7 +16,7 @@ pub struct NoirEnumeration {
     pub visibility: ItemVisibility,
     pub generics: UnresolvedGenerics,
     pub variants: Vec<Documented<EnumVariant>>,
-    pub span: Span,
+    pub location: Location,
 }
 
 impl NoirEnumeration {