prism 1.2.0 → 1.4.0

data/sig/prism.rbs

@@ -12,6 +12,7 @@ module Prism
     String source,
     ?encoding: Encoding | false,
     ?filepath: String,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -24,6 +25,7 @@ module Prism
     String source,
     ?encoding: Encoding | false,
     ?filepath: String,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -36,6 +38,7 @@ module Prism
     String source,
     ?encoding: Encoding | false,
     ?filepath: String,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -48,6 +51,7 @@ module Prism
     String source,
     ?encoding: Encoding | false,
     ?filepath: String,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -60,6 +64,7 @@ module Prism
     String source,
     ?encoding: Encoding | false,
     ?filepath: String,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -72,6 +77,7 @@ module Prism
     String source,
     ?encoding: Encoding | false,
     ?filepath: String,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -84,6 +90,7 @@ module Prism
     String source,
     ?encoding: Encoding | false,
     ?filepath: String,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -96,6 +103,7 @@ module Prism
     String source,
     ?encoding: Encoding | false,
     ?filepath: String,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -108,6 +116,7 @@ module Prism
     String source,
     ?encoding: Encoding | false,
     ?filepath: String,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -118,7 +127,8 @@ module Prism
 
   def self.load: (
     String source,
-    String serialized
+    String serialized,
+    ?bool freeze
   ) -> ParseResult
 
   def self.lex_ripper: (
@@ -130,6 +140,7 @@ module Prism
   def self.parse_file: (
     String filepath,
     ?encoding: Encoding | false,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -141,6 +152,7 @@ module Prism
   def self.profile_file: (
     String filepath,
     ?encoding: Encoding | false,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -152,6 +164,7 @@ module Prism
   def self.lex_file: (
     String filepath,
     ?encoding: Encoding | false,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -163,6 +176,7 @@ module Prism
   def self.parse_lex_file: (
     String filepath,
     ?encoding: Encoding | false,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -174,6 +188,7 @@ module Prism
   def self.dump_file: (
     String filepath,
     ?encoding: Encoding | false,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -185,6 +200,7 @@ module Prism
   def self.parse_file_comments: (
     String filepath,
     ?encoding: Encoding | false,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -196,6 +212,7 @@ module Prism
   def self.parse_file_success?: (
     String filepath,
     ?encoding: Encoding | false,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -207,6 +224,7 @@ module Prism
   def self.parse_file_failure?: (
     String filepath,
     ?encoding: Encoding | false,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -223,6 +241,7 @@ module Prism
     _Stream stream,
     ?encoding: Encoding | false,
     ?filepath: String,
+    ?freeze: bool,
     ?frozen_string_literal: bool,
     ?line: Integer,
     ?main_script: bool,
@@ -230,4 +249,6 @@ module Prism
     ?scopes: Array[Array[Symbol]],
     ?verbose: bool
   ) -> ParseResult
+
+  def self.scope: (?locals: Array[Symbol], ?forwarding: Array[Symbol]) -> Scope
 end

data/src/diagnostic.c

@@ -257,8 +257,8 @@ static const pm_diagnostic_data_t diagnostic_messages[PM_DIAGNOSTIC_ID_MAX] = {
     [PM_ERR_INVALID_VARIABLE_GLOBAL_3_3]        = { "`%.*s' is not allowed as a global variable name", PM_ERROR_LEVEL_SYNTAX },
     [PM_ERR_INVALID_VARIABLE_GLOBAL]            = { "'%.*s' is not allowed as a global variable name", PM_ERROR_LEVEL_SYNTAX },
     [PM_ERR_INVALID_YIELD]                      = { "Invalid yield", PM_ERROR_LEVEL_SYNTAX },
-    [PM_ERR_IT_NOT_ALLOWED_NUMBERED]            = { "`it` is not allowed when a numbered parameter is already used", PM_ERROR_LEVEL_SYNTAX },
-    [PM_ERR_IT_NOT_ALLOWED_ORDINARY]            = { "`it` is not allowed when an ordinary parameter is defined", PM_ERROR_LEVEL_SYNTAX },
+    [PM_ERR_IT_NOT_ALLOWED_NUMBERED]            = { "'it' is not allowed when a numbered parameter is already used", PM_ERROR_LEVEL_SYNTAX },
+    [PM_ERR_IT_NOT_ALLOWED_ORDINARY]            = { "'it' is not allowed when an ordinary parameter is defined", PM_ERROR_LEVEL_SYNTAX },
     [PM_ERR_LAMBDA_OPEN]                        = { "expected a `do` keyword or a `{` to open the lambda block", PM_ERROR_LEVEL_SYNTAX },
     [PM_ERR_LAMBDA_TERM_BRACE]                  = { "expected a lambda block beginning with `{` to end with `}`", PM_ERROR_LEVEL_SYNTAX },
     [PM_ERR_LAMBDA_TERM_END]                    = { "expected a lambda block beginning with `do` to end with `end`", PM_ERROR_LEVEL_SYNTAX },

data/src/node.c

@@ -7347,6 +7347,18 @@ pm_dump_json(pm_buffer_t *buffer, const pm_parser_t *parser, const pm_node_t *no
             const pm_parentheses_node_t *cast = (const pm_parentheses_node_t *) node;
             pm_dump_json_location(buffer, parser, &cast->base.location);
 
+            // Dump the ParenthesesNodeFlags field
+            pm_buffer_append_byte(buffer, ',');
+            pm_buffer_append_string(buffer, "\"ParenthesesNodeFlags\":", 23);
+            size_t flags = 0;
+            pm_buffer_append_byte(buffer, '[');
+            if (PM_NODE_FLAG_P(cast, PM_PARENTHESES_NODE_FLAGS_MULTIPLE_STATEMENTS)) {
+                if (flags != 0) pm_buffer_append_byte(buffer, ',');
+                pm_buffer_append_string(buffer, "\"MULTIPLE_STATEMENTS\"", 21);
+                flags++;
+            }
+            pm_buffer_append_byte(buffer, ']');
+
             // Dump the body field
             pm_buffer_append_byte(buffer, ',');
             pm_buffer_append_string(buffer, "\"body\":", 7);
@@ -7824,6 +7836,15 @@ pm_dump_json(pm_buffer_t *buffer, const pm_parser_t *parser, const pm_node_t *no
                 pm_buffer_append_string(buffer, "null", 4);
             }
 
+            // Dump the then_keyword_loc field
+            pm_buffer_append_byte(buffer, ',');
+            pm_buffer_append_string(buffer, "\"then_keyword_loc\":", 19);
+            if (cast->then_keyword_loc.start != NULL) {
+                pm_dump_json_location(buffer, parser, &cast->then_keyword_loc);
+            } else {
+                pm_buffer_append_string(buffer, "null", 4);
+            }
+
             // Dump the statements field
             pm_buffer_append_byte(buffer, ',');
             pm_buffer_append_string(buffer, "\"statements\":", 13);
@@ -8418,6 +8439,15 @@ pm_dump_json(pm_buffer_t *buffer, const pm_parser_t *parser, const pm_node_t *no
             pm_buffer_append_string(buffer, "\"keyword_loc\":", 14);
             pm_dump_json_location(buffer, parser, &cast->keyword_loc);
 
+            // Dump the do_keyword_loc field
+            pm_buffer_append_byte(buffer, ',');
+            pm_buffer_append_string(buffer, "\"do_keyword_loc\":", 17);
+            if (cast->do_keyword_loc.start != NULL) {
+                pm_dump_json_location(buffer, parser, &cast->do_keyword_loc);
+            } else {
+                pm_buffer_append_string(buffer, "null", 4);
+            }
+
             // Dump the closing_loc field
             pm_buffer_append_byte(buffer, ',');
             pm_buffer_append_string(buffer, "\"closing_loc\":", 14);
@@ -8511,6 +8541,15 @@ pm_dump_json(pm_buffer_t *buffer, const pm_parser_t *parser, const pm_node_t *no
             pm_buffer_append_string(buffer, "\"keyword_loc\":", 14);
             pm_dump_json_location(buffer, parser, &cast->keyword_loc);
 
+            // Dump the do_keyword_loc field
+            pm_buffer_append_byte(buffer, ',');
+            pm_buffer_append_string(buffer, "\"do_keyword_loc\":", 17);
+            if (cast->do_keyword_loc.start != NULL) {
+                pm_dump_json_location(buffer, parser, &cast->do_keyword_loc);
+            } else {
+                pm_buffer_append_string(buffer, "null", 4);
+            }
+
             // Dump the closing_loc field
             pm_buffer_append_byte(buffer, ',');
             pm_buffer_append_string(buffer, "\"closing_loc\":", 14);

data/src/options.c

@@ -84,6 +84,11 @@ pm_options_version_set(pm_options_t *options, const char *version, size_t length
         }
 
         if (strncmp(version, "3.4", 3) == 0) {
+            options->version = PM_OPTIONS_VERSION_CRUBY_3_4;
+            return true;
+        }
+
+        if (strncmp(version, "3.5", 3) == 0) {
             options->version = PM_OPTIONS_VERSION_LATEST;
             return true;
         }
@@ -98,6 +103,11 @@ pm_options_version_set(pm_options_t *options, const char *version, size_t length
         }
 
         if (strncmp(version, "3.4.", 4) == 0 && is_number(version + 4, length - 4)) {
+            options->version = PM_OPTIONS_VERSION_CRUBY_3_4;
+            return true;
+        }
+
+        if (strncmp(version, "3.5.", 4) == 0 && is_number(version + 4, length - 4)) {
             options->version = PM_OPTIONS_VERSION_LATEST;
             return true;
         }
@@ -129,6 +139,14 @@ pm_options_partial_script_set(pm_options_t *options, bool partial_script) {
     options->partial_script = partial_script;
 }
 
+/**
+ * Set the freeze option on the given options struct.
+ */
+PRISM_EXPORTED_FUNCTION void
+pm_options_freeze_set(pm_options_t *options, bool freeze) {
+    options->freeze = freeze;
+}
+
 // For some reason, GCC analyzer thinks we're leaking allocated scopes and
 // locals here, even though we definitely aren't. This is a false positive.
 // Ideally we wouldn't need to suppress this.
@@ -163,6 +181,7 @@ PRISM_EXPORTED_FUNCTION bool
 pm_options_scope_init(pm_options_scope_t *scope, size_t locals_count) {
     scope->locals_count = locals_count;
     scope->locals = xcalloc(locals_count, sizeof(pm_string_t));
+    scope->forwarding = PM_OPTIONS_SCOPE_FORWARDING_NONE;
     return scope->locals != NULL;
 }
 
@@ -174,6 +193,14 @@ pm_options_scope_local_get(const pm_options_scope_t *scope, size_t index) {
     return &scope->locals[index];
 }
 
+/**
+ * Set the forwarding option on the given scope struct.
+ */
+PRISM_EXPORTED_FUNCTION void
+pm_options_scope_forwarding_set(pm_options_scope_t *scope, uint8_t forwarding) {
+    scope->forwarding = forwarding;
+}
+
 /**
  * Free the internal memory associated with the options.
  */
@@ -264,6 +291,7 @@ pm_options_read(pm_options_t *options, const char *data) {
     options->encoding_locked = ((uint8_t) *data++) > 0;
     options->main_script = ((uint8_t) *data++) > 0;
     options->partial_script = ((uint8_t) *data++) > 0;
+    options->freeze = ((uint8_t) *data++) > 0;
 
     uint32_t scopes_count = pm_options_read_u32(data);
     data += 4;
@@ -281,6 +309,9 @@ pm_options_read(pm_options_t *options, const char *data) {
                 return;
             }
 
+            uint8_t forwarding = (uint8_t) *data++;
+            pm_options_scope_forwarding_set(&options->scopes[scope_index], forwarding);
+
             for (size_t local_index = 0; local_index < locals_count; local_index++) {
                 uint32_t local_length = pm_options_read_u32(data);
                 data += 4;

data/src/prettyprint.c

@@ -6950,6 +6950,20 @@ prettyprint_node(pm_buffer_t *output_buffer, const pm_parser_t *parser, const pm
             prettyprint_location(output_buffer, parser, &node->location);
             pm_buffer_append_string(output_buffer, ")\n", 2);
 
+            // ParenthesesNodeFlags
+            {
+                pm_buffer_concat(output_buffer, prefix_buffer);
+                pm_buffer_append_string(output_buffer, "+-- ParenthesesNodeFlags:", 25);
+                bool found = false;
+                if (cast->base.flags & PM_PARENTHESES_NODE_FLAGS_MULTIPLE_STATEMENTS) {
+                    if (found) pm_buffer_append_byte(output_buffer, ',');
+                    pm_buffer_append_string(output_buffer, " multiple_statements", 20);
+                    found = true;
+                }
+                if (!found) pm_buffer_append_string(output_buffer, " nil", 4);
+                pm_buffer_append_byte(output_buffer, '\n');
+            }
+
             // body
             {
                 pm_buffer_concat(output_buffer, prefix_buffer);
@@ -7676,6 +7690,22 @@ prettyprint_node(pm_buffer_t *output_buffer, const pm_parser_t *parser, const pm
                 }
             }
 
+            // then_keyword_loc
+            {
+                pm_buffer_concat(output_buffer, prefix_buffer);
+                pm_buffer_append_string(output_buffer, "+-- then_keyword_loc:", 21);
+                pm_location_t *location = &cast->then_keyword_loc;
+                if (location->start == NULL) {
+                    pm_buffer_append_string(output_buffer, " nil\n", 5);
+                } else {
+                    pm_buffer_append_byte(output_buffer, ' ');
+                    prettyprint_location(output_buffer, parser, location);
+                    pm_buffer_append_string(output_buffer, " = \"", 4);
+                    pm_buffer_append_source(output_buffer, location->start, (size_t) (location->end - location->start), PM_BUFFER_ESCAPING_RUBY);
+                    pm_buffer_append_string(output_buffer, "\"\n", 2);
+                }
+            }
+
             // statements
             {
                 pm_buffer_concat(output_buffer, prefix_buffer);
@@ -8521,6 +8551,22 @@ prettyprint_node(pm_buffer_t *output_buffer, const pm_parser_t *parser, const pm
                 pm_buffer_append_string(output_buffer, "\"\n", 2);
             }
 
+            // do_keyword_loc
+            {
+                pm_buffer_concat(output_buffer, prefix_buffer);
+                pm_buffer_append_string(output_buffer, "+-- do_keyword_loc:", 19);
+                pm_location_t *location = &cast->do_keyword_loc;
+                if (location->start == NULL) {
+                    pm_buffer_append_string(output_buffer, " nil\n", 5);
+                } else {
+                    pm_buffer_append_byte(output_buffer, ' ');
+                    prettyprint_location(output_buffer, parser, location);
+                    pm_buffer_append_string(output_buffer, " = \"", 4);
+                    pm_buffer_append_source(output_buffer, location->start, (size_t) (location->end - location->start), PM_BUFFER_ESCAPING_RUBY);
+                    pm_buffer_append_string(output_buffer, "\"\n", 2);
+                }
+            }
+
             // closing_loc
             {
                 pm_buffer_concat(output_buffer, prefix_buffer);
@@ -8672,6 +8718,22 @@ prettyprint_node(pm_buffer_t *output_buffer, const pm_parser_t *parser, const pm
                 pm_buffer_append_string(output_buffer, "\"\n", 2);
             }
 
+            // do_keyword_loc
+            {
+                pm_buffer_concat(output_buffer, prefix_buffer);
+                pm_buffer_append_string(output_buffer, "+-- do_keyword_loc:", 19);
+                pm_location_t *location = &cast->do_keyword_loc;
+                if (location->start == NULL) {
+                    pm_buffer_append_string(output_buffer, " nil\n", 5);
+                } else {
+                    pm_buffer_append_byte(output_buffer, ' ');
+                    prettyprint_location(output_buffer, parser, location);
+                    pm_buffer_append_string(output_buffer, " = \"", 4);
+                    pm_buffer_append_source(output_buffer, location->start, (size_t) (location->end - location->start), PM_BUFFER_ESCAPING_RUBY);
+                    pm_buffer_append_string(output_buffer, "\"\n", 2);
+                }
+            }
+
             // closing_loc
             {
                 pm_buffer_concat(output_buffer, prefix_buffer);