Merge pull request toml-rs#434 from epage/span

fix(parser): Fill in some more span gaps
epage · Jan 13, 2023 · b811b3a · b811b3a
2 parents d356dc6 + c1dbe9e
commit b811b3a
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 31 deletions.
diff --git a/crates/toml_edit/src/array_of_tables.rs b/crates/toml_edit/src/array_of_tables.rs
@@ -32,6 +32,11 @@ impl ArrayOfTables {
         a
     }
 
+    /// Returns the location within the original document
+    pub(crate) fn span(&self) -> Option<std::ops::Range<usize>> {
+        self.span.clone()
+    }
+
     pub(crate) fn despan(&mut self, input: &str) {
         self.span = None;
         for value in &mut self.values {

diff --git a/crates/toml_edit/src/item.rs b/crates/toml_edit/src/item.rs
@@ -301,8 +301,8 @@ impl Item {
         match self {
             Item::None => None,
             Item::Value(v) => v.span(),
-            Item::Table(_) => None,
-            Item::ArrayOfTables(_) => None,
+            Item::Table(v) => v.span(),
+            Item::ArrayOfTables(v) => v.span(),
         }
     }
 

diff --git a/crates/toml_edit/src/parser/state.rs b/crates/toml_edit/src/parser/state.rs
@@ -98,6 +98,7 @@ impl ParseState {
         &mut self,
         path: Vec<Key>,
         decor: Decor,
+        span: std::ops::Range<usize>,
     ) -> Result<(), CustomError> {
         debug_assert!(!path.is_empty());
         debug_assert!(self.current_table.is_empty());
@@ -114,26 +115,22 @@ impl ParseState {
             .as_array_of_tables()
             .ok_or_else(|| CustomError::duplicate_key(&path, path.len() - 1))?;
 
-        let span = if let (Some(prefix), Some(suffix)) = (
-            decor.prefix().and_then(|r| r.span()),
-            decor.suffix().and_then(|r| r.span()),
-        ) {
-            Some((prefix.end)..(suffix.start))
-        } else {
-            None
-        };
-
         self.current_table_position += 1;
         self.current_table.decor = decor;
         self.current_table.set_position(self.current_table_position);
-        self.current_table.span = span;
+        self.current_table.span = Some(span);
         self.current_is_array = true;
         self.current_table_path = path;
 
         Ok(())
     }
 
-    pub(crate) fn start_table(&mut self, path: Vec<Key>, decor: Decor) -> Result<(), CustomError> {
+    pub(crate) fn start_table(
+        &mut self,
+        path: Vec<Key>,
+        decor: Decor,
+        span: std::ops::Range<usize>,
+    ) -> Result<(), CustomError> {
         debug_assert!(!path.is_empty());
         debug_assert!(self.current_table.is_empty());
         debug_assert!(self.current_table_path.is_empty());
@@ -153,19 +150,10 @@ impl ParseState {
             }
         }
 
-        let span = if let (Some(prefix), Some(suffix)) = (
-            decor.prefix().and_then(|r| r.span()),
-            decor.suffix().and_then(|r| r.span()),
-        ) {
-            Some((prefix.end)..(suffix.start))
-        } else {
-            None
-        };
-
         self.current_table_position += 1;
         self.current_table.decor = decor;
         self.current_table.set_position(self.current_table_position);
-        self.current_table.span = span;
+        self.current_table.span = Some(span);
         self.current_is_array = false;
         self.current_table_path = path;
 
@@ -278,6 +266,7 @@ impl ParseState {
         &mut self,
         path: Vec<Key>,
         trailing: std::ops::Range<usize>,
+        span: std::ops::Range<usize>,
     ) -> Result<(), CustomError> {
         debug_assert!(!path.is_empty());
 
@@ -287,7 +276,11 @@ impl ParseState {
             .take()
             .map(RawString::with_span)
             .unwrap_or_default();
-        self.start_table(path, Decor::new(leading, RawString::with_span(trailing)))?;
+        self.start_table(
+            path,
+            Decor::new(leading, RawString::with_span(trailing)),
+            span,
+        )?;
 
         Ok(())
     }
@@ -296,6 +289,7 @@ impl ParseState {
         &mut self,
         path: Vec<Key>,
         trailing: std::ops::Range<usize>,
+        span: std::ops::Range<usize>,
     ) -> Result<(), CustomError> {
         debug_assert!(!path.is_empty());
 
@@ -305,7 +299,11 @@ impl ParseState {
             .take()
             .map(RawString::with_span)
             .unwrap_or_default();
-        self.start_aray_table(path, Decor::new(leading, RawString::with_span(trailing)))?;
+        self.start_aray_table(
+            path,
+            Decor::new(leading, RawString::with_span(trailing)),
+            span,
+        )?;
 
         Ok(())
     }

diff --git a/crates/toml_edit/src/parser/table.rs b/crates/toml_edit/src/parser/table.rs
@@ -36,12 +36,13 @@ pub(crate) fn std_table<'s, 'i>(
                 cut(STD_TABLE_CLOSE)
                     .context(Context::Expected(ParserValue::CharLiteral('.')))
                     .context(Context::Expected(ParserValue::StringLiteral("]"))),
-            ),
+            )
+            .with_span(),
             cut(line_trailing)
                 .context(Context::Expected(ParserValue::CharLiteral('\n')))
                 .context(Context::Expected(ParserValue::CharLiteral('#'))),
         )
-            .map_res(|(h, t)| state.borrow_mut().deref_mut().on_std_header(h, t))
+            .map_res(|((h, span), t)| state.borrow_mut().deref_mut().on_std_header(h, t, span))
             .parse(i)
     }
 }
@@ -60,12 +61,13 @@ pub(crate) fn array_table<'s, 'i>(
                 cut(ARRAY_TABLE_CLOSE)
                     .context(Context::Expected(ParserValue::CharLiteral('.')))
                     .context(Context::Expected(ParserValue::StringLiteral("]]"))),
-            ),
+            )
+            .with_span(),
             cut(line_trailing)
                 .context(Context::Expected(ParserValue::CharLiteral('\n')))
                 .context(Context::Expected(ParserValue::CharLiteral('#'))),
         )
-            .map_res(|(h, t)| state.borrow_mut().deref_mut().on_array_header(h, t))
+            .map_res(|((h, span), t)| state.borrow_mut().deref_mut().on_array_header(h, t, span))
             .parse(i)
     }
 }

diff --git a/crates/toml_edit/tests/testsuite/serde.rs b/crates/toml_edit/tests/testsuite/serde.rs
@@ -258,7 +258,11 @@ fn missing_errors() {
     error! {
         Foo,
         Table(map! { }),
-        "missing field `bar`",
+        r#"TOML parse error at line 1, column 1
+  |
+1 | 
+  | ^
+missing field `bar`"#,
         "missing field `bar`"
     }
 }
@@ -544,7 +548,14 @@ debug = 'a'
 "#,
     );
     let err = res.unwrap_err();
-    snapbox::assert_eq(err.to_string(), "expected a boolean or an integer");
+    snapbox::assert_eq(
+        err.to_string(),
+        r#"TOML parse error at line 7, column 1
+  |
+7 | [profile.dev]
+  | ^^^^^^^^^^^^^
+expected a boolean or an integer"#,
+    );
 
     let res: Result<Package, _> = toml_edit::de::from_str(
         r#"