Rename slice back to location

Author: kddnewton

docs/configuration.md

@@ -60,8 +60,8 @@ The available values for `type` are:
 * `string` - A field that is a string. For example, this is used as the name of the method in a call node, since it cannot directly reference the source string (as in `@-` or `foo=`). This is a `pm_string_t` in C.
 * `constant` - A field that is an integer that represents an index in the constant pool. This is a `pm_constant_id_t` in C.
 * `constant[]` - A field that is an array of constants. This is a `pm_constant_id_list_t` in C.
-* `location` - A field that is a location. This is a `pm_slice_t` in C.
-* `location?` - A field that is a location that is optionally present. This is a `pm_slice_t` in C, but if the value is not present then the `length` field will be `0`.
+* `location` - A field that is a location. This is a `pm_location_t` in C.
+* `location?` - A field that is a location that is optionally present. This is a `pm_location_t` in C, but if the value is not present then the `length` field will be `0`.
 * `uint8` - A field that is an 8-bit unsigned integer. This is a `uint8_t` in C.
 * `uint32` - A field that is a 32-bit unsigned integer. This is a `uint32_t` in C.
 

ext/prism/extension.c

@@ -461,17 +461,17 @@ parser_location(VALUE source, bool freeze, uint32_t start, uint32_t length) {
 }
 
 /**
- * Create a new Location instance from the given parser and slice.
+ * Create a new Location instance from the given parser and location.
  */
-#define PARSER_LOCATION_SLICE(source, freeze, slice) \
-    parser_location(source, freeze, slice.start, slice.length)
+#define PARSER_LOCATION(source, freeze, location) \
+    parser_location(source, freeze, location.start, location.length)
 
 /**
  * Build a new Comment instance from the given parser and comment.
  */
 static inline VALUE
 parser_comment(VALUE source, bool freeze, const pm_comment_t *comment) {
-    VALUE argv[] = { PARSER_LOCATION_SLICE(source, freeze, comment->location) };
+    VALUE argv[] = { PARSER_LOCATION(source, freeze, comment->location) };
     VALUE type = (comment->type == PM_COMMENT_EMBDOC) ? rb_cPrismEmbDocComment : rb_cPrismInlineComment;
     return rb_class_new_instance_freeze(1, argv, type, freeze);
 }
@@ -554,7 +554,7 @@ parser_errors(const pm_parser_t *parser, rb_encoding *encoding, VALUE source, bo
     ) {
         VALUE type = ID2SYM(rb_intern(pm_diagnostic_id_human(error->diag_id)));
         VALUE message = rb_obj_freeze(rb_enc_str_new_cstr(error->message, encoding));
-        VALUE location = PARSER_LOCATION_SLICE(source, freeze, error->location);
+        VALUE location = PARSER_LOCATION(source, freeze, error->location);
 
         VALUE level = Qnil;
         switch (error->level) {
@@ -594,7 +594,7 @@ parser_warnings(const pm_parser_t *parser, rb_encoding *encoding, VALUE source,
     ) {
         VALUE type = ID2SYM(rb_intern(pm_diagnostic_id_human(warning->diag_id)));
         VALUE message = rb_obj_freeze(rb_enc_str_new_cstr(warning->message, encoding));
-        VALUE location = PARSER_LOCATION_SLICE(source, freeze, warning->location);
+        VALUE location = PARSER_LOCATION(source, freeze, warning->location);
 
         VALUE level = Qnil;
         switch (warning->level) {

include/prism/parser.h

@@ -463,7 +463,7 @@ typedef struct pm_comment {
     pm_list_node_t node;
 
     /** The location of the comment in the source. */
-    pm_slice_t location;
+    pm_location_t location;
 
     /** The type of comment that we've found. */
     pm_comment_type_t type;
@@ -480,10 +480,10 @@ typedef struct {
     pm_list_node_t node;
 
     /** The key of the magic comment. */
-    pm_slice_t key;
+    pm_location_t key;
 
     /** The value of the magic comment. */
-    pm_slice_t value;
+    pm_location_t value;
 } pm_magic_comment_t;
 
 /**
@@ -531,7 +531,7 @@ typedef struct {
     pm_constant_id_t name;
 
     /** The location of the local variable in the source. */
-    pm_slice_t location;
+    pm_location_t location;
 
     /** The index of the local variable in the local table. */
     uint32_t index;
@@ -722,7 +722,7 @@ struct pm_parser {
      * and the rest of the content of the file. This content is loaded into the
      * DATA constant when the file being parsed is the main file being executed.
      */
-    pm_slice_t data_loc;
+    pm_location_t data_loc;
 
     /** The list of warnings that have been found while parsing. */
     pm_list_t warning_list;

rust/ruby-prism/build.rs

@@ -253,9 +253,9 @@ fn write_node(file: &mut File, flags: &[Flags], node: &Node) -> Result<(), Box<d
     writeln!(file)?;
     writeln!(file, "    /// Returns the location of this node.")?;
     writeln!(file, "    #[must_use]")?;
-    writeln!(file, "    pub fn location(&self) -> Slice<'pr> {{")?;
-    writeln!(file, "        let pointer: *mut pm_slice_t = unsafe {{ &raw mut (*self.pointer).base.location }};")?;
-    writeln!(file, "        Slice::new(self.parser, unsafe {{ &(*pointer) }})")?;
+    writeln!(file, "    pub fn location(&self) -> Location<'pr> {{")?;
+    writeln!(file, "        let pointer: *mut pm_location_t = unsafe {{ &raw mut (*self.pointer).base.location }};")?;
+    writeln!(file, "        Location::new(self.parser, unsafe {{ &(*pointer) }})")?;
     writeln!(file, "    }}")?;
     writeln!(file)?;
     writeln!(file, "    /// Returns the flags of this node.")?;
@@ -364,19 +364,19 @@ fn write_node(file: &mut File, flags: &[Flags], node: &Node) -> Result<(), Box<d
                 writeln!(file, "    }}")?;
             },
             NodeFieldType::Location => {
-                writeln!(file, "    pub fn {}(&self) -> Slice<'pr> {{", field.name)?;
-                writeln!(file, "        let pointer: *mut pm_slice_t = unsafe {{ &raw mut (*self.pointer).{} }};", field.name)?;
-                writeln!(file, "        Slice::new(self.parser, unsafe {{ &(*pointer) }})")?;
+                writeln!(file, "    pub fn {}(&self) -> Location<'pr> {{", field.name)?;
+                writeln!(file, "        let pointer: *mut pm_location_t = unsafe {{ &raw mut (*self.pointer).{} }};", field.name)?;
+                writeln!(file, "        Location::new(self.parser, unsafe {{ &(*pointer) }})")?;
                 writeln!(file, "    }}")?;
             },
             NodeFieldType::OptionalLocation => {
-                writeln!(file, "    pub fn {}(&self) -> Option<Slice<'pr>> {{", field.name)?;
-                writeln!(file, "        let pointer: *mut pm_slice_t = unsafe {{ &raw mut (*self.pointer).{} }};", field.name)?;
+                writeln!(file, "    pub fn {}(&self) -> Option<Location<'pr>> {{", field.name)?;
+                writeln!(file, "        let pointer: *mut pm_location_t = unsafe {{ &raw mut (*self.pointer).{} }};", field.name)?;
                 writeln!(file, "        let length = unsafe {{ (*pointer).length }};")?;
                 writeln!(file, "        if length == 0 {{")?;
                 writeln!(file, "            None")?;
                 writeln!(file, "        }} else {{")?;
-                writeln!(file, "            Some(Slice::new(self.parser, unsafe {{ &(*pointer) }}))")?;
+                writeln!(file, "            Some(Location::new(self.parser, unsafe {{ &(*pointer) }}))")?;
                 writeln!(file, "        }}")?;
                 writeln!(file, "    }}")?;
             },
@@ -558,7 +558,7 @@ use std::ptr::NonNull;
 
 #[allow(clippy::wildcard_imports)]
 use ruby_prism_sys::*;
-use crate::{{ConstantId, ConstantList, Integer, Slice, NodeList}};
+use crate::{{ConstantId, ConstantList, Integer, Location, NodeList}};
 "
     )?;
 
@@ -621,10 +621,10 @@ impl<'pr> Node<'pr> {{
 
     writeln!(file, "    /// Returns the location of this node.")?;
     writeln!(file, "    #[must_use]")?;
-    writeln!(file, "    pub fn location(&self) -> Slice<'pr> {{")?;
+    writeln!(file, "    pub fn location(&self) -> Location<'pr> {{")?;
     writeln!(file, "        match *self {{")?;
     for node in &config.nodes {
-        writeln!(file, "            Self::{} {{ pointer, parser, .. }} => Slice::new(parser, unsafe {{ &((*pointer.cast::<pm_node_t>()).location) }}),", node.name)?;
+        writeln!(file, "            Self::{} {{ pointer, parser, .. }} => Location::new(parser, unsafe {{ &((*pointer.cast::<pm_node_t>()).location) }}),", node.name)?;
     }
     writeln!(file, "        }}")?;
     writeln!(file, "    }}")?;

rust/ruby-prism/src/lib.rs

@@ -19,17 +19,17 @@ use std::mem::MaybeUninit;
 use std::ptr::NonNull;
 
 pub use self::bindings::*;
-use ruby_prism_sys::{pm_comment_t, pm_comment_type_t, pm_constant_id_list_t, pm_constant_id_t, pm_diagnostic_t, pm_integer_t, pm_magic_comment_t, pm_node_destroy, pm_node_list, pm_node_t, pm_parse, pm_parser_free, pm_parser_init, pm_parser_t, pm_slice_t};
+use ruby_prism_sys::{pm_comment_t, pm_comment_type_t, pm_constant_id_list_t, pm_constant_id_t, pm_diagnostic_t, pm_integer_t, pm_magic_comment_t, pm_node_destroy, pm_node_list, pm_node_t, pm_parse, pm_parser_free, pm_parser_init, pm_parser_t, pm_location_t};
 
 /// A range in the source file, represented as a start offset and length.
-pub struct Slice<'pr> {
+pub struct Location<'pr> {
     parser: NonNull<pm_parser_t>,
     pub(crate) start: u32,
     pub(crate) length: u32,
     marker: PhantomData<&'pr [u8]>,
 }
 
-impl<'pr> Slice<'pr> {
+impl<'pr> Location<'pr> {
     /// Returns a byte slice for the range.
     #[must_use]
     pub fn as_slice(&self) -> &'pr [u8] {
@@ -39,13 +39,13 @@ impl<'pr> Slice<'pr> {
         }
     }
 
-    /// Return a Slice from the given `pm_slice_t`.
+    /// Return a Location from the given `pm_location_t`.
     #[must_use]
-    pub(crate) const fn new(parser: NonNull<pm_parser_t>, slice: &'pr pm_slice_t) -> Self {
-        Slice {
+    pub(crate) const fn new(parser: NonNull<pm_parser_t>, location: &'pr pm_location_t) -> Self {
+        Location {
             parser,
-            start: slice.start,
-            length: slice.length,
+            start: location.start,
+            length: location.length,
             marker: PhantomData,
         }
     }
@@ -56,15 +56,15 @@ impl<'pr> Slice<'pr> {
         self.start + self.length
     }
 
-    /// Return a Slice starting at self and ending at the end of other.
+    /// Return a Location starting at self and ending at the end of other.
     /// Returns None if both locations did not originate from the same parser,
     /// or if self starts after other.
     #[must_use]
     pub fn join(&self, other: &Self) -> Option<Self> {
         if self.parser != other.parser || self.start > other.start {
             None
         } else {
-            Some(Slice {
+            Some(Location {
                 parser: self.parser,
                 start: self.start,
                 length: other.end() - self.start,
@@ -74,7 +74,7 @@ impl<'pr> Slice<'pr> {
     }
 }
 
-impl std::fmt::Debug for Slice<'_> {
+impl std::fmt::Debug for Location<'_> {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         let slice: &[u8] = self.as_slice();
 
@@ -332,8 +332,8 @@ impl<'pr> Diagnostic<'pr> {
 
     /// The location of the diagnostic in the source.
     #[must_use]
-    pub const fn location(&self) -> Slice<'pr> {
-        Slice::new(self.parser, unsafe { &self.diag.as_ref().location })
+    pub const fn location(&self) -> Location<'pr> {
+        Location::new(self.parser, unsafe { &self.diag.as_ref().location })
     }
 }
 
@@ -377,8 +377,8 @@ impl<'pr> Comment<'pr> {
 
     /// The location of the comment in the source.
     #[must_use]
-    pub const fn location(&self) -> Slice<'pr> {
-        Slice::new(self.parser, unsafe { &self.content.as_ref().location })
+    pub const fn location(&self) -> Location<'pr> {
+        Location::new(self.parser, unsafe { &self.content.as_ref().location })
     }
 }
 
@@ -510,9 +510,9 @@ impl<'pr> ParseResult<'pr> {
     /// Returns a slice of the source string that was parsed using the given
     /// slice range.
     #[must_use]
-    pub fn as_slice(&self, slice: &Slice<'pr>) -> &'pr [u8] {
-        let start = slice.start as usize;
-        let end = start + slice.length as usize;
+    pub fn as_slice(&self, location: &Location<'pr>) -> &'pr [u8] {
+        let start = location.start as usize;
+        let end = start + location.length as usize;
         &self.source[start..end]
     }
 
@@ -574,12 +574,12 @@ impl<'pr> ParseResult<'pr> {
 
     /// Returns an optional location of the __END__ marker and the rest of the content of the file.
     #[must_use]
-    pub fn data_loc(&self) -> Option<Slice<'_>> {
+    pub fn data_loc(&self) -> Option<Location<'_>> {
         let location = unsafe { &(*self.parser.as_ptr()).data_loc };
         if location.length == 0 {
             None
         } else {
-            Some(Slice::new(self.parser, location))
+            Some(Location::new(self.parser, location))
         }
     }