prism 0.29.0 → 1.3.0

data/include/prism/static_literals.h

@@ -95,9 +95,10 @@ typedef struct {
  * @param start_line The line number that the parser starts on.
  * @param literals The set of static literals to add the node to.
  * @param node The node to add to the set.
+ * @param replace Whether to replace the previous node if one already exists.
  * @return A pointer to the node that is being overwritten, if there is one.
  */
-pm_node_t * pm_static_literals_add(const pm_newline_list_t *newline_list, int32_t start_line, pm_static_literals_t *literals, pm_node_t *node);
+pm_node_t * pm_static_literals_add(const pm_newline_list_t *newline_list, int32_t start_line, pm_static_literals_t *literals, pm_node_t *node, bool replace);
 
 /**
  * Free the internal memory associated with the given static literals set.
@@ -115,6 +116,6 @@ void pm_static_literals_free(pm_static_literals_t *literals);
  * @param encoding_name The name of the encoding of the source being parsed.
  * @param node The node to create a string representation of.
  */
-PRISM_EXPORTED_FUNCTION void pm_static_literal_inspect(pm_buffer_t *buffer, const pm_newline_list_t *newline_list, int32_t start_line, const char *encoding_name, const pm_node_t *node);
+void pm_static_literal_inspect(pm_buffer_t *buffer, const pm_newline_list_t *newline_list, int32_t start_line, const char *encoding_name, const pm_node_t *node);
 
 #endif

data/include/prism/util/pm_char.h

@@ -34,8 +34,7 @@ size_t pm_strspn_whitespace(const uint8_t *string, ptrdiff_t length);
  * @return The number of characters at the start of the string that are
  *     whitespace.
  */
-size_t
-pm_strspn_whitespace_newlines(const uint8_t *string, ptrdiff_t length, pm_newline_list_t *newline_list);
+size_t pm_strspn_whitespace_newlines(const uint8_t *string, ptrdiff_t length, pm_newline_list_t *newline_list);
 
 /**
  * Returns the number of characters at the start of the string that are inline

data/include/prism/util/pm_constant_pool.h

@@ -87,14 +87,6 @@ void pm_constant_id_list_insert(pm_constant_id_list_t *list, size_t index, pm_co
  */
 bool pm_constant_id_list_includes(pm_constant_id_list_t *list, pm_constant_id_t id);
 
-/**
- * Get the memory size of a list of constant ids.
- *
- * @param list The list to get the memory size of.
- * @return The memory size of the list.
- */
-size_t pm_constant_id_list_memsize(pm_constant_id_list_t *list);
-
 /**
  * Free the memory associated with a list of constant ids.
  *

data/include/prism/util/pm_integer.h

@@ -18,12 +18,6 @@
  * A structure represents an arbitrary-sized integer.
  */
 typedef struct {
-    /**
-     * Embedded value for small integer. This value is set to 0 if the value
-     * does not fit into uint32_t.
-     */
-    uint32_t value;
-
     /**
      * The number of allocated values. length is set to 0 if the integer fits
      * into uint32_t.
@@ -35,6 +29,12 @@ typedef struct {
      */
     uint32_t *values;
 
+    /**
+     * Embedded value for small integer. This value is set to 0 if the value
+     * does not fit into uint32_t.
+     */
+    uint32_t value;
+
     /**
      * Whether or not the integer is negative. It is stored this way so that a
      * zeroed pm_integer_t is always positive zero.
@@ -48,6 +48,9 @@ typedef struct {
  * from the string itself.
  */
 typedef enum {
+    /** The default decimal base, with no prefix. Leading 0s will be ignored. */
+    PM_INTEGER_BASE_DEFAULT,
+
     /** The binary base, indicated by a 0b or 0B prefix. */
     PM_INTEGER_BASE_BINARY,
 
@@ -79,15 +82,7 @@ typedef enum {
  * @param start The start of the string.
  * @param end The end of the string.
  */
-PRISM_EXPORTED_FUNCTION void pm_integer_parse(pm_integer_t *integer, pm_integer_base_t base, const uint8_t *start, const uint8_t *end);
-
-/**
- * Return the memory size of the integer.
- *
- * @param integer The integer to get the memory size of.
- * @return The size of the memory associated with the integer.
- */
-size_t pm_integer_memsize(const pm_integer_t *integer);
+void pm_integer_parse(pm_integer_t *integer, pm_integer_base_t base, const uint8_t *start, const uint8_t *end);
 
 /**
  * Compare two integers. This function returns -1 if the left integer is less
@@ -100,6 +95,18 @@ size_t pm_integer_memsize(const pm_integer_t *integer);
  */
 int pm_integer_compare(const pm_integer_t *left, const pm_integer_t *right);
 
+/**
+ * Reduce a ratio of integers to its simplest form.
+ *
+ * If either the numerator or denominator do not fit into a 32-bit integer, then
+ * this function is a no-op. In the future, we may consider reducing even the
+ * larger numbers, but for now we're going to keep it simple.
+ *
+ * @param numerator The numerator of the ratio.
+ * @param denominator The denominator of the ratio.
+ */
+void pm_integers_reduce(pm_integer_t *numerator, pm_integer_t *denominator);
+
 /**
  * Convert an integer to a decimal string.
  *

data/include/prism/util/pm_newline_list.h

@@ -80,6 +80,17 @@ pm_newline_list_clear(pm_newline_list_t *list);
  */
 bool pm_newline_list_append(pm_newline_list_t *list, const uint8_t *cursor);
 
+/**
+ * Returns the line of the given offset. If the offset is not in the list, the
+ * line of the closest offset less than the given offset is returned.
+ *
+ * @param list The list to search.
+ * @param cursor A pointer to the offset to search for.
+ * @param start_line The line to start counting from.
+ * @return The line of the given offset.
+ */
+int32_t pm_newline_list_line(const pm_newline_list_t *list, const uint8_t *cursor, int32_t start_line);
+
 /**
  * Returns the line and column of the given offset. If the offset is not in the
  * list, the line and column of the closest offset less than the given offset

data/include/prism/util/pm_string.h

@@ -9,6 +9,7 @@
 #include "prism/defines.h"
 
 #include <assert.h>
+#include <errno.h>
 #include <stdbool.h>
 #include <stddef.h>
 #include <stdlib.h>
@@ -21,6 +22,9 @@
 #include <fcntl.h>
 #include <sys/mman.h>
 #include <sys/stat.h>
+#elif defined(PRISM_HAS_FILESYSTEM)
+#include <fcntl.h>
+#include <sys/stat.h>
 #endif
 
 /**
@@ -92,6 +96,26 @@ void pm_string_owned_init(pm_string_t *string, uint8_t *source, size_t length);
  */
 void pm_string_constant_init(pm_string_t *string, const char *source, size_t length);
 
+/**
+ * Represents the result of calling pm_string_mapped_init or
+ * pm_string_file_init. We need this additional information because there is
+ * not a platform-agnostic way to indicate that the file that was attempted to
+ * be opened was a directory.
+ */
+typedef enum {
+    /** Indicates that the string was successfully initialized. */
+    PM_STRING_INIT_SUCCESS = 0,
+    /**
+     * Indicates a generic error from a string_*_init function, where the type
+     * of error should be read from `errno` or `GetLastError()`.
+     */
+    PM_STRING_INIT_ERROR_GENERIC = 1,
+    /**
+     * Indicates that the file that was attempted to be opened was a directory.
+     */
+    PM_STRING_INIT_ERROR_DIRECTORY = 2
+} pm_string_init_result_t;
+
 /**
  * Read the file indicated by the filepath parameter into source and load its
  * contents and size into the given `pm_string_t`. The given `pm_string_t`
@@ -105,9 +129,9 @@ void pm_string_constant_init(pm_string_t *string, const char *source, size_t len
  *
  * @param string The string to initialize.
  * @param filepath The filepath to read.
- * @return Whether or not the file was successfully mapped.
+ * @return The success of the read, indicated by the value of the enum.
  */
-PRISM_EXPORTED_FUNCTION bool pm_string_mapped_init(pm_string_t *string, const char *filepath);
+PRISM_EXPORTED_FUNCTION pm_string_init_result_t pm_string_mapped_init(pm_string_t *string, const char *filepath);
 
 /**
  * Read the file indicated by the filepath parameter into source and load its
@@ -116,17 +140,9 @@ PRISM_EXPORTED_FUNCTION bool pm_string_mapped_init(pm_string_t *string, const ch
  *
  * @param string The string to initialize.
  * @param filepath The filepath to read.
- * @return Whether or not the file was successfully read.
- */
-PRISM_EXPORTED_FUNCTION bool pm_string_file_init(pm_string_t *string, const char *filepath);
-
-/**
- * Returns the memory size associated with the string.
- *
- * @param string The string to get the memory size of.
- * @return The size of the memory associated with the string.
+ * @return The success of the read, indicated by the value of the enum.
  */
-size_t pm_string_memsize(const pm_string_t *string);
+PRISM_EXPORTED_FUNCTION pm_string_init_result_t pm_string_file_init(pm_string_t *string, const char *filepath);
 
 /**
  * Ensure the string is owned. If it is not, then reinitialize it as owned and

data/include/prism/version.h

@@ -9,12 +9,12 @@
 /**
  * The major version of the Prism library as an int.
  */
-#define PRISM_VERSION_MAJOR 0
+#define PRISM_VERSION_MAJOR 1
 
 /**
  * The minor version of the Prism library as an int.
  */
-#define PRISM_VERSION_MINOR 29
+#define PRISM_VERSION_MINOR 3
 
 /**
  * The patch version of the Prism library as an int.
@@ -24,6 +24,6 @@
 /**
  * The version of the Prism library as a constant string.
  */
-#define PRISM_VERSION "0.29.0"
+#define PRISM_VERSION "1.3.0"
 
 #endif

data/include/prism.h

@@ -219,17 +219,6 @@ PRISM_EXPORTED_FUNCTION const char * pm_token_type_name(pm_token_type_t token_ty
  */
 const char * pm_token_type_human(pm_token_type_t token_type);
 
-/**
- * Format the errors on the parser into the given buffer.
- *
- * @param parser The parser to format the errors for.
- * @param error_list The list of errors to format.
- * @param buffer The buffer to format the errors into.
- * @param colorize Whether or not to colorize the errors with ANSI escape sequences.
- * @param inline_messages Whether or not to inline the messages with the source.
- */
-PRISM_EXPORTED_FUNCTION void pm_parser_errors_format(const pm_parser_t *parser, const pm_list_t *error_list, pm_buffer_t *buffer, bool colorize, bool inline_messages);
-
 // We optionally support dumping to JSON. For systems that don't want or need
 // this functionality, it can be turned off with the PRISM_EXCLUDE_JSON define.
 #ifndef PRISM_EXCLUDE_JSON
@@ -245,6 +234,53 @@ PRISM_EXPORTED_FUNCTION void pm_dump_json(pm_buffer_t *buffer, const pm_parser_t
 
 #endif
 
+/**
+ * Represents the results of a slice query.
+ */
+typedef enum {
+    /** Returned if the encoding given to a slice query was invalid. */
+    PM_STRING_QUERY_ERROR = -1,
+
+    /** Returned if the result of the slice query is false. */
+    PM_STRING_QUERY_FALSE,
+
+    /** Returned if the result of the slice query is true. */
+    PM_STRING_QUERY_TRUE
+} pm_string_query_t;
+
+/**
+ * Check that the slice is a valid local variable name.
+ *
+ * @param source The source to check.
+ * @param length The length of the source.
+ * @param encoding_name The name of the encoding of the source.
+ * @return PM_STRING_QUERY_TRUE if the query is true, PM_STRING_QUERY_FALSE if
+ *   the query is false, and PM_STRING_QUERY_ERROR if the encoding was invalid.
+ */
+PRISM_EXPORTED_FUNCTION pm_string_query_t pm_string_query_local(const uint8_t *source, size_t length, const char *encoding_name);
+
+/**
+ * Check that the slice is a valid constant name.
+ *
+ * @param source The source to check.
+ * @param length The length of the source.
+ * @param encoding_name The name of the encoding of the source.
+ * @return PM_STRING_QUERY_TRUE if the query is true, PM_STRING_QUERY_FALSE if
+ *   the query is false, and PM_STRING_QUERY_ERROR if the encoding was invalid.
+ */
+PRISM_EXPORTED_FUNCTION pm_string_query_t pm_string_query_constant(const uint8_t *source, size_t length, const char *encoding_name);
+
+/**
+ * Check that the slice is a valid method name.
+ *
+ * @param source The source to check.
+ * @param length The length of the source.
+ * @param encoding_name The name of the encoding of the source.
+ * @return PM_STRING_QUERY_TRUE if the query is true, PM_STRING_QUERY_FALSE if
+ *   the query is false, and PM_STRING_QUERY_ERROR if the encoding was invalid.
+ */
+PRISM_EXPORTED_FUNCTION pm_string_query_t pm_string_query_method_name(const uint8_t *source, size_t length, const char *encoding_name);
+
 /**
  * @mainpage
  *

data/lib/prism/compiler.rb

@@ -301,6 +301,9 @@ module Prism
     # Compile a InterpolatedXStringNode node
     alias visit_interpolated_x_string_node visit_child_nodes
 
+    # Compile a ItLocalVariableReadNode node
+    alias visit_it_local_variable_read_node visit_child_nodes
+
     # Compile a ItParametersNode node
     alias visit_it_parameters_node visit_child_nodes
 

data/lib/prism/desugar_compiler.rb

@@ -2,11 +2,13 @@
 
 module Prism
   class DesugarAndWriteNode # :nodoc:
-    attr_reader :node, :source, :read_class, :write_class, :arguments
+    include DSL
 
-    def initialize(node, source, read_class, write_class, *arguments)
+    attr_reader :node, :default_source, :read_class, :write_class, :arguments
+
+    def initialize(node, default_source, read_class, write_class, **arguments)
       @node = node
-      @source = source
+      @default_source = default_source
       @read_class = read_class
       @write_class = write_class
       @arguments = arguments
@@ -14,22 +16,30 @@ module Prism
 
     # Desugar `x &&= y` to `x && x = y`
     def compile
-      AndNode.new(
-        source,
-        read_class.new(source, *arguments, node.name_loc),
-        write_class.new(source, *arguments, node.name_loc, node.value, node.operator_loc, node.location),
-        node.operator_loc,
-        node.location
+      and_node(
+        location: node.location,
+        left: public_send(read_class, location: node.name_loc, **arguments),
+        right: public_send(
+          write_class,
+          location: node.location,
+          **arguments,
+          name_loc: node.name_loc,
+          value: node.value,
+          operator_loc: node.operator_loc
+        ),
+        operator_loc: node.operator_loc
       )
     end
   end
 
   class DesugarOrWriteDefinedNode # :nodoc:
-    attr_reader :node, :source, :read_class, :write_class, :arguments
+    include DSL
+
+    attr_reader :node, :default_source, :read_class, :write_class, :arguments
 
-    def initialize(node, source, read_class, write_class, *arguments)
+    def initialize(node, default_source, read_class, write_class, **arguments)
       @node = node
-      @source = source
+      @default_source = default_source
       @read_class = read_class
       @write_class = write_class
       @arguments = arguments
@@ -37,35 +47,50 @@ module Prism
 
     # Desugar `x ||= y` to `defined?(x) ? x : x = y`
     def compile
-      IfNode.new(
-        source,
-        node.operator_loc,
-        DefinedNode.new(source, nil, read_class.new(source, *arguments, node.name_loc), nil, node.operator_loc, node.name_loc),
-        node.operator_loc,
-        StatementsNode.new(source, [read_class.new(source, *arguments, node.name_loc)], node.location),
-        ElseNode.new(
-          source,
-          node.operator_loc,
-          StatementsNode.new(
-            source,
-            [write_class.new(source, *arguments, node.name_loc, node.value, node.operator_loc, node.location)],
-            node.location
+      if_node(
+        location: node.location,
+        if_keyword_loc: node.operator_loc,
+        predicate: defined_node(
+          location: node.name_loc,
+          value: public_send(read_class, location: node.name_loc, **arguments),
+          keyword_loc: node.operator_loc
+        ),
+        then_keyword_loc: node.operator_loc,
+        statements: statements_node(
+          location: node.location,
+          body: [public_send(read_class, location: node.name_loc, **arguments)]
+        ),
+        subsequent: else_node(
+          location: node.location,
+          else_keyword_loc: node.operator_loc,
+          statements: statements_node(
+            location: node.location,
+            body: [
+              public_send(
+                write_class,
+                location: node.location,
+                **arguments,
+                name_loc: node.name_loc,
+                value: node.value,
+                operator_loc: node.operator_loc
+              )
+            ]
           ),
-          node.operator_loc,
-          node.location
+          end_keyword_loc: node.operator_loc
         ),
-        node.operator_loc,
-        node.location
+        end_keyword_loc: node.operator_loc
       )
     end
   end
 
   class DesugarOperatorWriteNode # :nodoc:
-    attr_reader :node, :source, :read_class, :write_class, :arguments
+    include DSL
 
-    def initialize(node, source, read_class, write_class, *arguments)
+    attr_reader :node, :default_source, :read_class, :write_class, :arguments
+
+    def initialize(node, default_source, read_class, write_class, **arguments)
       @node = node
-      @source = source
+      @default_source = default_source
       @read_class = read_class
       @write_class = write_class
       @arguments = arguments
@@ -75,35 +100,41 @@ module Prism
     def compile
       binary_operator_loc = node.binary_operator_loc.chop
 
-      write_class.new(
-        source,
-        *arguments,
-        node.name_loc,
-        CallNode.new(
-          source,
-          0,
-          read_class.new(source, *arguments, node.name_loc),
-          nil,
-          binary_operator_loc.slice.to_sym,
-          binary_operator_loc,
-          nil,
-          ArgumentsNode.new(source, 0, [node.value], node.value.location),
-          nil,
-          nil,
-          node.location
+      public_send(
+        write_class,
+        location: node.location,
+        **arguments,
+        name_loc: node.name_loc,
+        value: call_node(
+          location: node.location,
+          receiver: public_send(
+            read_class,
+            location: node.name_loc,
+            **arguments
+          ),
+          name: binary_operator_loc.slice.to_sym,
+          message_loc: binary_operator_loc,
+          arguments: arguments_node(
+            location: node.value.location,
+            arguments: [node.value]
+          )
         ),
-        node.binary_operator_loc.copy(start_offset: node.binary_operator_loc.end_offset - 1, length: 1),
-        node.location
+        operator_loc: node.binary_operator_loc.copy(
+          start_offset: node.binary_operator_loc.end_offset - 1,
+          length: 1
+        )
       )
     end
   end
 
   class DesugarOrWriteNode # :nodoc:
-    attr_reader :node, :source, :read_class, :write_class, :arguments
+    include DSL
 
-    def initialize(node, source, read_class, write_class, *arguments)
+    attr_reader :node, :default_source, :read_class, :write_class, :arguments
+
+    def initialize(node, default_source, read_class, write_class, **arguments)
       @node = node
-      @source = source
+      @default_source = default_source
       @read_class = read_class
       @write_class = write_class
       @arguments = arguments
@@ -111,12 +142,18 @@ module Prism
 
     # Desugar `x ||= y` to `x || x = y`
     def compile
-      OrNode.new(
-        source,
-        read_class.new(source, *arguments, node.name_loc),
-        write_class.new(source, *arguments, node.name_loc, node.value, node.operator_loc, node.location),
-        node.operator_loc,
-        node.location
+      or_node(
+        location: node.location,
+        left: public_send(read_class, location: node.name_loc, **arguments),
+        right: public_send(
+          write_class,
+          location: node.location,
+          **arguments,
+          name_loc: node.name_loc,
+          value: node.value,
+          operator_loc: node.operator_loc
+        ),
+        operator_loc: node.operator_loc
       )
     end
   end
@@ -125,91 +162,91 @@ module Prism
 
   class ClassVariableAndWriteNode
     def desugar # :nodoc:
-      DesugarAndWriteNode.new(self, source, ClassVariableReadNode, ClassVariableWriteNode, name).compile
+      DesugarAndWriteNode.new(self, source, :class_variable_read_node, :class_variable_write_node, name: name).compile
     end
   end
 
   class ClassVariableOrWriteNode
     def desugar # :nodoc:
-      DesugarOrWriteDefinedNode.new(self, source, ClassVariableReadNode, ClassVariableWriteNode, name).compile
+      DesugarOrWriteDefinedNode.new(self, source, :class_variable_read_node, :class_variable_write_node, name: name).compile
     end
   end
 
   class ClassVariableOperatorWriteNode
     def desugar # :nodoc:
-      DesugarOperatorWriteNode.new(self, source, ClassVariableReadNode, ClassVariableWriteNode, name).compile
+      DesugarOperatorWriteNode.new(self, source, :class_variable_read_node, :class_variable_write_node, name: name).compile
     end
   end
 
   class ConstantAndWriteNode
     def desugar # :nodoc:
-      DesugarAndWriteNode.new(self, source, ConstantReadNode, ConstantWriteNode, name).compile
+      DesugarAndWriteNode.new(self, source, :constant_read_node, :constant_write_node, name: name).compile
     end
   end
 
   class ConstantOrWriteNode
     def desugar # :nodoc:
-      DesugarOrWriteDefinedNode.new(self, source, ConstantReadNode, ConstantWriteNode, name).compile
+      DesugarOrWriteDefinedNode.new(self, source, :constant_read_node, :constant_write_node, name: name).compile
     end
   end
 
   class ConstantOperatorWriteNode
     def desugar # :nodoc:
-      DesugarOperatorWriteNode.new(self, source, ConstantReadNode, ConstantWriteNode, name).compile
+      DesugarOperatorWriteNode.new(self, source, :constant_read_node, :constant_write_node, name: name).compile
     end
   end
 
   class GlobalVariableAndWriteNode
     def desugar # :nodoc:
-      DesugarAndWriteNode.new(self, source, GlobalVariableReadNode, GlobalVariableWriteNode, name).compile
+      DesugarAndWriteNode.new(self, source, :global_variable_read_node, :global_variable_write_node, name: name).compile
     end
   end
 
   class GlobalVariableOrWriteNode
     def desugar # :nodoc:
-      DesugarOrWriteDefinedNode.new(self, source, GlobalVariableReadNode, GlobalVariableWriteNode, name).compile
+      DesugarOrWriteDefinedNode.new(self, source, :global_variable_read_node, :global_variable_write_node, name: name).compile
     end
   end
 
   class GlobalVariableOperatorWriteNode
     def desugar # :nodoc:
-      DesugarOperatorWriteNode.new(self, source, GlobalVariableReadNode, GlobalVariableWriteNode, name).compile
+      DesugarOperatorWriteNode.new(self, source, :global_variable_read_node, :global_variable_write_node, name: name).compile
     end
   end
 
   class InstanceVariableAndWriteNode
     def desugar # :nodoc:
-      DesugarAndWriteNode.new(self, source, InstanceVariableReadNode, InstanceVariableWriteNode, name).compile
+      DesugarAndWriteNode.new(self, source, :instance_variable_read_node, :instance_variable_write_node, name: name).compile
     end
   end
 
   class InstanceVariableOrWriteNode
     def desugar # :nodoc:
-      DesugarOrWriteNode.new(self, source, InstanceVariableReadNode, InstanceVariableWriteNode, name).compile
+      DesugarOrWriteNode.new(self, source, :instance_variable_read_node, :instance_variable_write_node, name: name).compile
     end
   end
 
   class InstanceVariableOperatorWriteNode
     def desugar # :nodoc:
-      DesugarOperatorWriteNode.new(self, source, InstanceVariableReadNode, InstanceVariableWriteNode, name).compile
+      DesugarOperatorWriteNode.new(self, source, :instance_variable_read_node, :instance_variable_write_node, name: name).compile
     end
   end
 
   class LocalVariableAndWriteNode
     def desugar # :nodoc:
-      DesugarAndWriteNode.new(self, source, LocalVariableReadNode, LocalVariableWriteNode, name, depth).compile
+      DesugarAndWriteNode.new(self, source, :local_variable_read_node, :local_variable_write_node, name: name, depth: depth).compile
     end
   end
 
   class LocalVariableOrWriteNode
     def desugar # :nodoc:
-      DesugarOrWriteNode.new(self, source, LocalVariableReadNode, LocalVariableWriteNode, name, depth).compile
+      DesugarOrWriteNode.new(self, source, :local_variable_read_node, :local_variable_write_node, name: name, depth: depth).compile
     end
   end
 
   class LocalVariableOperatorWriteNode
     def desugar # :nodoc:
-      DesugarOperatorWriteNode.new(self, source, LocalVariableReadNode, LocalVariableWriteNode, name, depth).compile
+      DesugarOperatorWriteNode.new(self, source, :local_variable_read_node, :local_variable_write_node, name: name, depth: depth).compile
     end
   end