prism 0.24.0 → 0.26.0

data/include/prism/ast.h

@@ -5,6 +5,7 @@
 /* if you are looking to modify the                                           */
 /* template                                                                   */
 /******************************************************************************/
+
 /**
  * @file ast.h
  *
@@ -15,6 +16,7 @@
 
 #include "prism/defines.h"
 #include "prism/util/pm_constant_pool.h"
+#include "prism/util/pm_integer.h"
 #include "prism/util/pm_string.h"
 
 #include <assert.h>
@@ -829,188 +831,194 @@ enum pm_node_type {
     /** InterpolatedXStringNode */
     PM_INTERPOLATED_X_STRING_NODE = 87,
 
+    /** ItParametersNode */
+    PM_IT_PARAMETERS_NODE = 88,
+
     /** KeywordHashNode */
-    PM_KEYWORD_HASH_NODE = 88,
+    PM_KEYWORD_HASH_NODE = 89,
 
     /** KeywordRestParameterNode */
-    PM_KEYWORD_REST_PARAMETER_NODE = 89,
+    PM_KEYWORD_REST_PARAMETER_NODE = 90,
 
     /** LambdaNode */
-    PM_LAMBDA_NODE = 90,
+    PM_LAMBDA_NODE = 91,
 
     /** LocalVariableAndWriteNode */
-    PM_LOCAL_VARIABLE_AND_WRITE_NODE = 91,
+    PM_LOCAL_VARIABLE_AND_WRITE_NODE = 92,
 
     /** LocalVariableOperatorWriteNode */
-    PM_LOCAL_VARIABLE_OPERATOR_WRITE_NODE = 92,
+    PM_LOCAL_VARIABLE_OPERATOR_WRITE_NODE = 93,
 
     /** LocalVariableOrWriteNode */
-    PM_LOCAL_VARIABLE_OR_WRITE_NODE = 93,
+    PM_LOCAL_VARIABLE_OR_WRITE_NODE = 94,
 
     /** LocalVariableReadNode */
-    PM_LOCAL_VARIABLE_READ_NODE = 94,
+    PM_LOCAL_VARIABLE_READ_NODE = 95,
 
     /** LocalVariableTargetNode */
-    PM_LOCAL_VARIABLE_TARGET_NODE = 95,
+    PM_LOCAL_VARIABLE_TARGET_NODE = 96,
 
     /** LocalVariableWriteNode */
-    PM_LOCAL_VARIABLE_WRITE_NODE = 96,
+    PM_LOCAL_VARIABLE_WRITE_NODE = 97,
 
     /** MatchLastLineNode */
-    PM_MATCH_LAST_LINE_NODE = 97,
+    PM_MATCH_LAST_LINE_NODE = 98,
 
     /** MatchPredicateNode */
-    PM_MATCH_PREDICATE_NODE = 98,
+    PM_MATCH_PREDICATE_NODE = 99,
 
     /** MatchRequiredNode */
-    PM_MATCH_REQUIRED_NODE = 99,
+    PM_MATCH_REQUIRED_NODE = 100,
 
     /** MatchWriteNode */
-    PM_MATCH_WRITE_NODE = 100,
+    PM_MATCH_WRITE_NODE = 101,
 
     /** MissingNode */
-    PM_MISSING_NODE = 101,
+    PM_MISSING_NODE = 102,
 
     /** ModuleNode */
-    PM_MODULE_NODE = 102,
+    PM_MODULE_NODE = 103,
 
     /** MultiTargetNode */
-    PM_MULTI_TARGET_NODE = 103,
+    PM_MULTI_TARGET_NODE = 104,
 
     /** MultiWriteNode */
-    PM_MULTI_WRITE_NODE = 104,
+    PM_MULTI_WRITE_NODE = 105,
 
     /** NextNode */
-    PM_NEXT_NODE = 105,
+    PM_NEXT_NODE = 106,
 
     /** NilNode */
-    PM_NIL_NODE = 106,
+    PM_NIL_NODE = 107,
 
     /** NoKeywordsParameterNode */
-    PM_NO_KEYWORDS_PARAMETER_NODE = 107,
+    PM_NO_KEYWORDS_PARAMETER_NODE = 108,
 
     /** NumberedParametersNode */
-    PM_NUMBERED_PARAMETERS_NODE = 108,
+    PM_NUMBERED_PARAMETERS_NODE = 109,
 
     /** NumberedReferenceReadNode */
-    PM_NUMBERED_REFERENCE_READ_NODE = 109,
+    PM_NUMBERED_REFERENCE_READ_NODE = 110,
 
     /** OptionalKeywordParameterNode */
-    PM_OPTIONAL_KEYWORD_PARAMETER_NODE = 110,
+    PM_OPTIONAL_KEYWORD_PARAMETER_NODE = 111,
 
     /** OptionalParameterNode */
-    PM_OPTIONAL_PARAMETER_NODE = 111,
+    PM_OPTIONAL_PARAMETER_NODE = 112,
 
     /** OrNode */
-    PM_OR_NODE = 112,
+    PM_OR_NODE = 113,
 
     /** ParametersNode */
-    PM_PARAMETERS_NODE = 113,
+    PM_PARAMETERS_NODE = 114,
 
     /** ParenthesesNode */
-    PM_PARENTHESES_NODE = 114,
+    PM_PARENTHESES_NODE = 115,
 
     /** PinnedExpressionNode */
-    PM_PINNED_EXPRESSION_NODE = 115,
+    PM_PINNED_EXPRESSION_NODE = 116,
 
     /** PinnedVariableNode */
-    PM_PINNED_VARIABLE_NODE = 116,
+    PM_PINNED_VARIABLE_NODE = 117,
 
     /** PostExecutionNode */
-    PM_POST_EXECUTION_NODE = 117,
+    PM_POST_EXECUTION_NODE = 118,
 
     /** PreExecutionNode */
-    PM_PRE_EXECUTION_NODE = 118,
+    PM_PRE_EXECUTION_NODE = 119,
 
     /** ProgramNode */
-    PM_PROGRAM_NODE = 119,
+    PM_PROGRAM_NODE = 120,
 
     /** RangeNode */
-    PM_RANGE_NODE = 120,
+    PM_RANGE_NODE = 121,
 
     /** RationalNode */
-    PM_RATIONAL_NODE = 121,
+    PM_RATIONAL_NODE = 122,
 
     /** RedoNode */
-    PM_REDO_NODE = 122,
+    PM_REDO_NODE = 123,
 
     /** RegularExpressionNode */
-    PM_REGULAR_EXPRESSION_NODE = 123,
+    PM_REGULAR_EXPRESSION_NODE = 124,
 
     /** RequiredKeywordParameterNode */
-    PM_REQUIRED_KEYWORD_PARAMETER_NODE = 124,
+    PM_REQUIRED_KEYWORD_PARAMETER_NODE = 125,
 
     /** RequiredParameterNode */
-    PM_REQUIRED_PARAMETER_NODE = 125,
+    PM_REQUIRED_PARAMETER_NODE = 126,
 
     /** RescueModifierNode */
-    PM_RESCUE_MODIFIER_NODE = 126,
+    PM_RESCUE_MODIFIER_NODE = 127,
 
     /** RescueNode */
-    PM_RESCUE_NODE = 127,
+    PM_RESCUE_NODE = 128,
 
     /** RestParameterNode */
-    PM_REST_PARAMETER_NODE = 128,
+    PM_REST_PARAMETER_NODE = 129,
 
     /** RetryNode */
-    PM_RETRY_NODE = 129,
+    PM_RETRY_NODE = 130,
 
     /** ReturnNode */
-    PM_RETURN_NODE = 130,
+    PM_RETURN_NODE = 131,
 
     /** SelfNode */
-    PM_SELF_NODE = 131,
+    PM_SELF_NODE = 132,
+
+    /** ShareableConstantNode */
+    PM_SHAREABLE_CONSTANT_NODE = 133,
 
     /** SingletonClassNode */
-    PM_SINGLETON_CLASS_NODE = 132,
+    PM_SINGLETON_CLASS_NODE = 134,
 
     /** SourceEncodingNode */
-    PM_SOURCE_ENCODING_NODE = 133,
+    PM_SOURCE_ENCODING_NODE = 135,
 
     /** SourceFileNode */
-    PM_SOURCE_FILE_NODE = 134,
+    PM_SOURCE_FILE_NODE = 136,
 
     /** SourceLineNode */
-    PM_SOURCE_LINE_NODE = 135,
+    PM_SOURCE_LINE_NODE = 137,
 
     /** SplatNode */
-    PM_SPLAT_NODE = 136,
+    PM_SPLAT_NODE = 138,
 
     /** StatementsNode */
-    PM_STATEMENTS_NODE = 137,
+    PM_STATEMENTS_NODE = 139,
 
     /** StringNode */
-    PM_STRING_NODE = 138,
+    PM_STRING_NODE = 140,
 
     /** SuperNode */
-    PM_SUPER_NODE = 139,
+    PM_SUPER_NODE = 141,
 
     /** SymbolNode */
-    PM_SYMBOL_NODE = 140,
+    PM_SYMBOL_NODE = 142,
 
     /** TrueNode */
-    PM_TRUE_NODE = 141,
+    PM_TRUE_NODE = 143,
 
     /** UndefNode */
-    PM_UNDEF_NODE = 142,
+    PM_UNDEF_NODE = 144,
 
     /** UnlessNode */
-    PM_UNLESS_NODE = 143,
+    PM_UNLESS_NODE = 145,
 
     /** UntilNode */
-    PM_UNTIL_NODE = 144,
+    PM_UNTIL_NODE = 146,
 
     /** WhenNode */
-    PM_WHEN_NODE = 145,
+    PM_WHEN_NODE = 147,
 
     /** WhileNode */
-    PM_WHILE_NODE = 146,
+    PM_WHILE_NODE = 148,
 
     /** XStringNode */
-    PM_X_STRING_NODE = 147,
+    PM_X_STRING_NODE = 149,
 
     /** YieldNode */
-    PM_YIELD_NODE = 148,
+    PM_YIELD_NODE = 150,
 
     /** A special kind of node used for compilation. */
     PM_SCOPE_NODE
@@ -2179,21 +2187,46 @@ typedef struct pm_class_variable_write_node {
 
     /**
      * ClassVariableWriteNode#name
+     *
+     * The name of the class variable, which is a `@@` followed by an [identifier](https://github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers).
+     *
+     *     @@abc = 123     # name `@@abc`
+     *
+     *     @@_test = :test # name `@@_test`
      */
     pm_constant_id_t name;
 
     /**
      * ClassVariableWriteNode#name_loc
+     *
+     * The location of the variable name.
+     *
+     *     @@foo = :bar
+     *     ^^^^^
      */
     pm_location_t name_loc;
 
     /**
      * ClassVariableWriteNode#value
+     *
+     * The value to assign to the class variable. Can be any node that
+     * represents a non-void expression.
+     *
+     *     @@foo = :bar
+     *             ^^^^
+     *
+     *     @@_xyz = 123
+     *              ^^^
      */
     struct pm_node *value;
 
     /**
      * ClassVariableWriteNode#operator_loc
+     *
+     * The location of the `=` operator.
+     *
+     *     @@foo = :bar
+     *           ^
      */
     pm_location_t operator_loc;
 } pm_class_variable_write_node_t;
@@ -2838,6 +2871,13 @@ typedef struct pm_flip_flop_node {
 typedef struct pm_float_node {
     /** The embedded base node. */
     pm_node_t base;
+
+    /**
+     * FloatNode#value
+     *
+     * The value of the floating point number as a Float.
+     */
+    double value;
 } pm_float_node_t;
 
 /**
@@ -3675,21 +3715,46 @@ typedef struct pm_instance_variable_write_node {
 
     /**
      * InstanceVariableWriteNode#name
+     *
+     * The name of the instance variable, which is a `@` followed by an [identifier](https://github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers).
+     *
+     *     @x = :y       # name `:@x`
+     *
+     *     @_foo = "bar" # name `@_foo`
      */
     pm_constant_id_t name;
 
     /**
      * InstanceVariableWriteNode#name_loc
+     *
+     * The location of the variable name.
+     *
+     *     @_x = 1
+     *     ^^^
      */
     pm_location_t name_loc;
 
     /**
      * InstanceVariableWriteNode#value
+     *
+     * The value to assign to the instance variable. Can be any node that
+     * represents a non-void expression.
+     *
+     *     @foo = :bar
+     *            ^^^^
+     *
+     *     @_x = 1234
+     *           ^^^^
      */
     struct pm_node *value;
 
     /**
      * InstanceVariableWriteNode#operator_loc
+     *
+     * The location of the `=` operator.
+     *
+     *     @x = y
+     *        ^
      */
     pm_location_t operator_loc;
 } pm_instance_variable_write_node_t;
@@ -3709,6 +3774,13 @@ typedef struct pm_instance_variable_write_node {
 typedef struct pm_integer_node {
     /** The embedded base node. */
     pm_node_t base;
+
+    /**
+     * IntegerNode#value
+     *
+     * The value of the integer literal as a number.
+     */
+    pm_integer_t value;
 } pm_integer_node_t;
 
 /**
@@ -3793,6 +3865,9 @@ typedef struct pm_interpolated_regular_expression_node {
  * InterpolatedStringNode
  *
  * Type: PM_INTERPOLATED_STRING_NODE
+ * Flags:
+ *    PM_INTERPOLATED_STRING_NODE_FLAGS_FROZEN
+ *    PM_INTERPOLATED_STRING_NODE_FLAGS_MUTABLE
  *
  * @extends pm_node_t
  */
@@ -3870,6 +3945,18 @@ typedef struct pm_interpolated_x_string_node {
     pm_location_t closing_loc;
 } pm_interpolated_x_string_node_t;
 
+/**
+ * ItParametersNode
+ *
+ * Type: PM_IT_PARAMETERS_NODE
+ *
+ * @extends pm_node_t
+ */
+typedef struct pm_it_parameters_node {
+    /** The embedded base node. */
+    pm_node_t base;
+} pm_it_parameters_node_t;
+
 /**
  * KeywordHashNode
  *
@@ -4524,13 +4611,13 @@ typedef struct pm_numbered_reference_read_node {
     /**
      * NumberedReferenceReadNode#number
      *
-     * The (1-indexed, from the left) number of the capture group. Numbered references that would overflow a `uint32`  result in a `number` of exactly `2**32 - 1`.
+     * The (1-indexed, from the left) number of the capture group. Numbered references that are too large result in this value being `0`.
      *
      *     $1          # number `1`
      *
      *     $5432       # number `5432`
      *
-     *     $4294967296 # number `4294967295`
+     *     $4294967296 # number `0`
      */
     uint32_t number;
 } pm_numbered_reference_read_node_t;
@@ -5168,6 +5255,29 @@ typedef struct pm_self_node {
     pm_node_t base;
 } pm_self_node_t;
 
+/**
+ * ShareableConstantNode
+ *
+ * Type: PM_SHAREABLE_CONSTANT_NODE
+ * Flags:
+ *    PM_SHAREABLE_CONSTANT_NODE_FLAGS_LITERAL
+ *    PM_SHAREABLE_CONSTANT_NODE_FLAGS_EXPERIMENTAL_EVERYTHING
+ *    PM_SHAREABLE_CONSTANT_NODE_FLAGS_EXPERIMENTAL_COPY
+ *
+ * @extends pm_node_t
+ */
+typedef struct pm_shareable_constant_node {
+    /** The embedded base node. */
+    pm_node_t base;
+
+    /**
+     * ShareableConstantNode#write
+     *
+     * The constant write that should be modified with the shareability state.
+     */
+    struct pm_node *write;
+} pm_shareable_constant_node_t;
+
 /**
  * SingletonClassNode
  *
@@ -5226,6 +5336,11 @@ typedef struct pm_source_encoding_node {
  * SourceFileNode
  *
  * Type: PM_SOURCE_FILE_NODE
+ * Flags:
+ *    PM_STRING_FLAGS_FORCED_UTF8_ENCODING
+ *    PM_STRING_FLAGS_FORCED_BINARY_ENCODING
+ *    PM_STRING_FLAGS_FROZEN
+ *    PM_STRING_FLAGS_MUTABLE
  *
  * @extends pm_node_t
  */
@@ -5298,6 +5413,7 @@ typedef struct pm_statements_node {
  *    PM_STRING_FLAGS_FORCED_UTF8_ENCODING
  *    PM_STRING_FLAGS_FORCED_BINARY_ENCODING
  *    PM_STRING_FLAGS_FROZEN
+ *    PM_STRING_FLAGS_MUTABLE
  *
  * @extends pm_node_t
  */
@@ -5530,6 +5646,11 @@ typedef struct pm_when_node {
      */
     struct pm_node_list conditions;
 
+    /**
+     * WhenNode#then_keyword_loc
+     */
+    pm_location_t then_keyword_loc;
+
     /**
      * WhenNode#statements
      */
@@ -5698,6 +5819,17 @@ typedef enum pm_integer_base_flags {
     PM_INTEGER_BASE_FLAGS_HEXADECIMAL = 8,
 } pm_integer_base_flags_t;
 
+/**
+ * Flags for interpolated string nodes that indicated mutability if they are also marked as literals.
+ */
+typedef enum pm_interpolated_string_node_flags {
+    /** frozen by virtue of a `frozen_string_literal: true` comment or `--enable-frozen-string-literal`; only for adjacent string literals like `'a' 'b'` */
+    PM_INTERPOLATED_STRING_NODE_FLAGS_FROZEN = 1,
+
+    /** mutable by virtue of a `frozen_string_literal: false` comment or `--disable-frozen-string-literal`; only for adjacent string literals like `'a' 'b'` */
+    PM_INTERPOLATED_STRING_NODE_FLAGS_MUTABLE = 2,
+} pm_interpolated_string_node_flags_t;
+
 /**
  * Flags for keyword hash nodes.
  */
@@ -5768,6 +5900,20 @@ typedef enum pm_regular_expression_flags {
     PM_REGULAR_EXPRESSION_FLAGS_FORCED_US_ASCII_ENCODING = 1024,
 } pm_regular_expression_flags_t;
 
+/**
+ * Flags for shareable constant nodes.
+ */
+typedef enum pm_shareable_constant_node_flags {
+    /** constant writes that should be modified with shareable constant value literal */
+    PM_SHAREABLE_CONSTANT_NODE_FLAGS_LITERAL = 1,
+
+    /** constant writes that should be modified with shareable constant value experimental everything */
+    PM_SHAREABLE_CONSTANT_NODE_FLAGS_EXPERIMENTAL_EVERYTHING = 2,
+
+    /** constant writes that should be modified with shareable constant value experimental copy */
+    PM_SHAREABLE_CONSTANT_NODE_FLAGS_EXPERIMENTAL_COPY = 4,
+} pm_shareable_constant_node_flags_t;
+
 /**
  * Flags for string nodes.
  */
@@ -5778,8 +5924,11 @@ typedef enum pm_string_flags {
     /** internal bytes forced the encoding to binary */
     PM_STRING_FLAGS_FORCED_BINARY_ENCODING = 2,
 
-    /** frozen by virtue of a `frozen_string_literal` comment */
+    /** frozen by virtue of a `frozen_string_literal: true` comment or `--enable-frozen-string-literal` */
     PM_STRING_FLAGS_FROZEN = 4,
+
+    /** mutable by virtue of a `frozen_string_literal: false` comment or `--disable-frozen-string-literal` */
+    PM_STRING_FLAGS_MUTABLE = 8,
 } pm_string_flags_t;
 
 /**

data/include/prism/defines.h

@@ -10,6 +10,8 @@
 #define PRISM_DEFINES_H
 
 #include <ctype.h>
+#include <limits.h>
+#include <math.h>
 #include <stdarg.h>
 #include <stddef.h>
 #include <stdint.h>
@@ -21,7 +23,6 @@
  * some platforms they aren't included unless this is already defined.
  */
 #define __STDC_FORMAT_MACROS
-
 #include <inttypes.h>
 
 /**
@@ -48,7 +49,11 @@
  * compiler-agnostic way.
  */
 #if defined(__GNUC__)
-#   define PRISM_ATTRIBUTE_FORMAT(string_index, argument_index) __attribute__((format(printf, string_index, argument_index)))
+#   if defined(__MINGW_PRINTF_FORMAT)
+#       define PRISM_ATTRIBUTE_FORMAT(string_index, argument_index) __attribute__((format(__MINGW_PRINTF_FORMAT, string_index, argument_index)))
+#   else
+#       define PRISM_ATTRIBUTE_FORMAT(string_index, argument_index) __attribute__((format(printf, string_index, argument_index)))
+#   endif
 #elif defined(__clang__)
 #   define PRISM_ATTRIBUTE_FORMAT(string_index, argument_index) __attribute__((__format__(__printf__, string_index, argument_index)))
 #else
@@ -99,4 +104,103 @@
 #   define PM_STATIC_ASSERT(line, condition, message) typedef char PM_CONCATENATE(static_assert_, line)[(condition) ? 1 : -1]
 #endif
 
+/**
+ * In general, libc for embedded systems does not support memory-mapped files.
+ * If the target platform is POSIX or Windows, we can map a file in memory and
+ * read it in a more efficient manner.
+ */
+#ifdef _WIN32
+#   define PRISM_HAS_MMAP
+#else
+#   include <unistd.h>
+#   ifdef _POSIX_MAPPED_FILES
+#       define PRISM_HAS_MMAP
+#   endif
+#endif
+
+/**
+ * isinf on Windows is defined as accepting a float, but on POSIX systems it
+ * accepts a float, a double, or a long double. We want to mirror this behavior
+ * on windows.
+ */
+#ifdef _WIN32
+#   include <float.h>
+#   undef isinf
+#   define isinf(x) (sizeof(x) == sizeof(float) ? !_finitef(x) : !_finite(x))
+#endif
+
+/**
+ * If you build prism with a custom allocator, configure it with
+ * "-D PRISM_XALLOCATOR" to use your own allocator that defines xmalloc,
+ * xrealloc, xcalloc, and xfree.
+ *
+ * For example, your `prism_xallocator.h` file could look like this:
+ *
+ * ```
+ * #ifndef PRISM_XALLOCATOR_H
+ * #define PRISM_XALLOCATOR_H
+ * #define xmalloc      my_malloc
+ * #define xrealloc     my_realloc
+ * #define xcalloc      my_calloc
+ * #define xfree        my_free
+ * #endif
+ * ```
+ */
+#ifdef PRISM_XALLOCATOR
+    #include "prism_xallocator.h"
+#else
+    #ifndef xmalloc
+        /**
+         * The malloc function that should be used. This can be overridden with
+         * the PRISM_XALLOCATOR define.
+         */
+        #define xmalloc malloc
+    #endif
+
+    #ifndef xrealloc
+        /**
+         * The realloc function that should be used. This can be overridden with
+         * the PRISM_XALLOCATOR define.
+         */
+        #define xrealloc realloc
+    #endif
+
+    #ifndef xcalloc
+        /**
+         * The calloc function that should be used. This can be overridden with
+         * the PRISM_XALLOCATOR define.
+         */
+        #define xcalloc calloc
+    #endif
+
+    #ifndef xfree
+        /**
+         * The free function that should be used. This can be overridden with the
+         * PRISM_XALLOCATOR define.
+         */
+        #define xfree free
+    #endif
+#endif
+
+/**
+ * If PRISM_BUILD_MINIMAL is defined, then we're going to define every possible
+ * switch that will turn off certain features of prism.
+ */
+#ifdef PRISM_BUILD_MINIMAL
+    /** Exclude the serialization API. */
+    #define PRISM_EXCLUDE_SERIALIZATION
+
+    /** Exclude the JSON serialization API. */
+    #define PRISM_EXCLUDE_JSON
+
+    /** Exclude the Array#pack parser API. */
+    #define PRISM_EXCLUDE_PACK
+
+    /** Exclude the prettyprint API. */
+    #define PRISM_EXCLUDE_PRETTYPRINT
+
+    /** Exclude the full set of encodings, using the minimal only. */
+    #define PRISM_ENCODING_EXCLUDE_FULL
+#endif
+
 #endif