Revert "Span struct has been replaced by std::ops::Range<usize>"

This reverts commit a31f76a.

Author: Ertanic

fluent-syntax/src/ast/helper.rs

@@ -1,6 +1,6 @@
 use super::Comment;
 #[cfg(feature = "spans")]
-use super::Range;
+use super::Span;
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
@@ -14,12 +14,12 @@ pub enum CommentDef<S> {
     Single {
         content: S,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
     Multi {
         content: Vec<S>,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
 }
 

fluent-syntax/src/ast/mod.rs

@@ -118,7 +118,7 @@ use std::ops::Range;
 pub struct Resource<S> {
     pub body: Vec<Entry<S>>,
     #[cfg(feature = "spans")]
-    pub span: Range<usize>,
+    pub span: Span,
 }
 
 /// A top-level node representing an entry of a [`Resource`].
@@ -209,7 +209,7 @@ pub enum Entry<S> {
     Junk {
         content: S,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
 }
 
@@ -269,7 +269,7 @@ pub struct Message<S> {
     pub attributes: Vec<Attribute<S>>,
     pub comment: Option<Comment<S>>,
     #[cfg(feature = "spans")]
-    pub span: Range<usize>,
+    pub span: Span,
 }
 
 /// A Fluent [`Term`].
@@ -325,7 +325,7 @@ pub struct Term<S> {
     pub attributes: Vec<Attribute<S>>,
     pub comment: Option<Comment<S>>,
     #[cfg(feature = "spans")]
-    pub span: Range<usize>,
+    pub span: Span,
 }
 
 /// Pattern contains a value of a [`Message`], [`Term`] or an [`Attribute`].
@@ -404,7 +404,7 @@ pub struct Term<S> {
 pub struct Pattern<S> {
     pub elements: Vec<PatternElement<S>>,
     #[cfg(feature = "spans")]
-    pub span: Range<usize>,
+    pub span: Span,
 }
 
 /// `PatternElement` is an element of a [`Pattern`].
@@ -485,12 +485,12 @@ pub enum PatternElement<S> {
     TextElement {
         value: S,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
     Placeable {
         expression: Expression<S>,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
 }
 
@@ -563,7 +563,7 @@ pub struct Attribute<S> {
     pub id: Identifier<S>,
     pub value: Pattern<S>,
     #[cfg(feature = "spans")]
-    pub span: Range<usize>,
+    pub span: Span,
 }
 
 /// Identifier is part of nodes such as [`Message`], [`Term`] and [`Attribute`].
@@ -613,7 +613,7 @@ pub struct Attribute<S> {
 pub struct Identifier<S> {
     pub name: S,
     #[cfg(feature = "spans")]
-    pub span: Range<usize>,
+    pub span: Span,
 }
 
 /// Variant is a single branch of a value in a [`Select`](Expression::Select) expression.
@@ -701,7 +701,7 @@ pub struct Variant<S> {
     pub value: Pattern<S>,
     pub default: bool,
     #[cfg(feature = "spans")]
-    pub span: Range<usize>,
+    pub span: Span,
 }
 
 /// A key of a [`Variant`].
@@ -832,7 +832,7 @@ pub enum VariantKey<S> {
 pub struct Comment<S> {
     pub content: Vec<S>,
     #[cfg(feature = "spans")]
-    pub span: Range<usize>,
+    pub span: Span,
 }
 
 /// List of arguments for a [`FunctionReference`](InlineExpression::FunctionReference) or a
@@ -916,7 +916,7 @@ pub struct CallArguments<S> {
     pub positional: Vec<InlineExpression<S>>,
     pub named: Vec<NamedArgument<S>>,
     #[cfg(feature = "spans")]
-    pub span: Range<usize>,
+    pub span: Span,
 }
 
 /// A key-value pair used in [`CallArguments`].
@@ -987,7 +987,7 @@ pub struct NamedArgument<S> {
     pub name: Identifier<S>,
     pub value: InlineExpression<S>,
     #[cfg(feature = "spans")]
-    pub span: Range<usize>,
+    pub span: Span,
 }
 
 /// A subset of expressions which can be used as [`Placeable`](PatternElement::Placeable),
@@ -1091,7 +1091,7 @@ pub enum InlineExpression<S> {
     StringLiteral {
         value: S,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
     /// A number literal.
     ///
@@ -1141,7 +1141,7 @@ pub enum InlineExpression<S> {
     NumberLiteral {
         value: S,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
     /// A function reference.
     ///
@@ -1195,7 +1195,7 @@ pub enum InlineExpression<S> {
         id: Identifier<S>,
         arguments: CallArguments<S>,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
     /// A reference to another message.
     ///
@@ -1249,7 +1249,7 @@ pub enum InlineExpression<S> {
         id: Identifier<S>,
         attribute: Option<Identifier<S>>,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
     /// A reference to a term.
     ///
@@ -1305,7 +1305,7 @@ pub enum InlineExpression<S> {
         attribute: Option<Identifier<S>>,
         arguments: Option<CallArguments<S>>,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
     /// A reference to a variable.
     ///
@@ -1357,7 +1357,7 @@ pub enum InlineExpression<S> {
     VariableReference {
         id: Identifier<S>,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
     /// A placeable which may contain another expression.
     ///
@@ -1413,21 +1413,21 @@ pub enum InlineExpression<S> {
     Placeable {
         expression: Box<Expression<S>>,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
 }
 
 #[cfg(feature = "spans")]
 impl<S> InlineExpression<S> {
-    pub fn get_span(&self) -> Range<usize> {
+    pub fn get_span(&self) -> Span {
         match self {
             InlineExpression::StringLiteral { span, .. }
             | InlineExpression::TermReference { span, .. }
             | InlineExpression::VariableReference { span, .. }
             | InlineExpression::Placeable { span, .. }
             | InlineExpression::NumberLiteral { span, .. }
             | InlineExpression::FunctionReference { span, .. }
-            | InlineExpression::MessageReference { span, .. } => span.clone(), // Why doesn't std::ops::Range implement the Copy trait...?
+            | InlineExpression::MessageReference { span, .. } => *span,
         }
     }
 }
@@ -1521,13 +1521,49 @@ pub enum Expression<S> {
         selector: InlineExpression<S>,
         variants: Vec<Variant<S>>,
         #[cfg(feature = "spans")]
-        span: Range<usize>,
+        span: Span,
     },
 
     /// An inline expression such as `${ username }`:
     ///
     /// ```ftl
     /// hello-user = Hello ${ username }
     /// ```
-    Inline(InlineExpression<S>, #[cfg(feature = "spans")] Range<usize>),
+    Inline(InlineExpression<S>, #[cfg(feature = "spans")] Span),
+}
+
+/// A span of a node. Allows you to get the index of the start and end character of a node.
+///
+/// # Example
+///
+/// ```
+/// #![cfg(feature = "spans")]
+/// 
+/// use fluent_syntax::parser;
+/// use fluent_syntax::ast::*;
+/// 
+/// let ftl = "hello-world = Hello, World!";
+/// 
+/// let resource = parser::parse(ftl).expect("Failed to parse an FTL resource.");
+/// let Entry::Message(Message { ref id, .. }) = resource.body[0] else { unreachable!() };
+///  
+/// assert_eq!(resource.span, Span { start: 0, end: 27 });
+/// assert_eq!(id.span, Span { start: 0, end: 11 }); // the span of hello-world identifier
+/// ```
+#[cfg(feature = "spans")]
+#[derive(Debug, Clone, Copy, Default, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+pub struct Span {
+    pub start: usize,
+    pub end: usize,
+}
+
+#[cfg(feature = "spans")]
+impl Span {
+    pub fn new(range: Range<usize>) -> Self {
+        Self {
+            start: range.start,
+            end: range.end,
+        }
+    }
 }

fluent-syntax/src/parser/comment.rs

@@ -54,7 +54,7 @@ where
             ast::Comment {
                 content,
                 #[cfg(feature = "spans")]
-                span: start_pos..self.ptr,
+                span: ast::Span::new(start_pos..self.ptr),
             },
             level,
         ))

fluent-syntax/src/parser/core.rs

@@ -70,7 +70,7 @@ where
                     body.push(ast::Entry::Junk {
                         content,
                         #[cfg(feature = "spans")]
-                        span: entry_start..self.ptr,
+                        span: ast::Span::new(entry_start..self.ptr),
                     });
                 }
             }
@@ -81,9 +81,9 @@ where
             body.push(ast::Entry::Comment(last_comment));
         }
         if errors.is_empty() {
-            Ok(ast::Resource { body, #[cfg(feature = "spans")] span: 0..self.length })
+            Ok(ast::Resource { body, #[cfg(feature = "spans")] span: ast::Span::new(0..self.length) })
         } else {
-            Err((ast::Resource { body, #[cfg(feature = "spans")] span: 0..self.length }, errors))
+            Err((ast::Resource { body, #[cfg(feature = "spans")] span: ast::Span::new(0..self.length) }, errors))
         }
     }
 
@@ -128,7 +128,7 @@ where
             attributes,
             comment: None,
             #[cfg(feature = "spans")]
-            span: entry_start..self.ptr,
+            span: ast::Span::new(entry_start..self.ptr),
         })
     }
 
@@ -152,7 +152,7 @@ where
                 attributes,
                 comment: None,
                 #[cfg(feature = "spans")]
-                span: entry_start..self.ptr,
+                span: ast::Span::new(entry_start..self.ptr),
             })
         } else {
             error!(
@@ -196,7 +196,7 @@ where
                 id,
                 value: pattern,
                 #[cfg(feature = "spans")]
-                span: self.ptr - 1..self.ptr,
+                span: ast::Span::new(self.ptr - 1..self.ptr),
             }),
             None => error!(ErrorKind::MissingValue, self.ptr),
         }
@@ -218,7 +218,7 @@ where
         ast::Identifier {
             name,
             #[cfg(feature = "spans")]
-            span: start..self.ptr,
+            span: ast::Span::new(start..self.ptr),
         }
     }
 
@@ -295,7 +295,7 @@ where
                     value,
                     default,
                     #[cfg(feature = "spans")]
-                    span: (if default { start - 1 } else { start })..self.ptr,
+                    span: ast::Span::new((if default { start - 1 } else { start })..self.ptr),
                 });
                 self.skip_blank();
             } else {