datadog-ruby_core_source 3.3.6 → 3.4.1

data/lib/datadog/ruby_core_source/{ruby-3.4.0-preview1 → ruby-3.5.0-preview1}/prism/defines.h

@@ -23,8 +23,20 @@
  * some platforms they aren't included unless this is already defined.
  */
 #define __STDC_FORMAT_MACROS
+// Include sys/types.h before inttypes.h to work around issue with
+// certain versions of GCC and newlib which causes omission of PRIx64
+#include <sys/types.h>
 #include <inttypes.h>
 
+/**
+ * When we are parsing using recursive descent, we want to protect against
+ * malicious payloads that could attempt to crash our parser. We do this by
+ * specifying a maximum depth to which we are allowed to recurse.
+ */
+#ifndef PRISM_DEPTH_MAXIMUM
+    #define PRISM_DEPTH_MAXIMUM 10000
+#endif
+
 /**
  * By default, we compile with -fvisibility=hidden. When this is enabled, we
  * need to mark certain functions as being publically-visible. This macro does
@@ -119,14 +131,24 @@
 #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.
+ * If PRISM_HAS_NO_FILESYSTEM is defined, then we want to exclude all filesystem
+ * related code from the library. All filesystem related code should be guarded
+ * by PRISM_HAS_FILESYSTEM.
  */
-#ifdef _WIN32
-#   include <float.h>
-#   undef isinf
-#   define isinf(x) (sizeof(x) == sizeof(float) ? !_finitef(x) : !_finite(x))
+#ifndef PRISM_HAS_NO_FILESYSTEM
+#   define PRISM_HAS_FILESYSTEM
+#endif
+
+/**
+ * isinf on POSIX systems it accepts a float, a double, or a long double.
+ * But mingw didn't provide an isinf macro, only an isinf function that only
+ * accepts floats, so we need to use _finite instead.
+ */
+#ifdef __MINGW64__
+    #include <float.h>
+    #define PRISM_ISINF(x) (!_finite(x))
+#else
+    #define PRISM_ISINF(x) isinf(x)
 #endif
 
 /**
@@ -203,4 +225,36 @@
     #define PRISM_ENCODING_EXCLUDE_FULL
 #endif
 
+/**
+ * Support PRISM_LIKELY and PRISM_UNLIKELY to help the compiler optimize its
+ * branch predication.
+ */
+#if defined(__GNUC__) || defined(__clang__)
+    /** The compiler should predicate that this branch will be taken. */
+    #define PRISM_LIKELY(x) __builtin_expect(!!(x), 1)
+
+    /** The compiler should predicate that this branch will not be taken. */
+    #define PRISM_UNLIKELY(x) __builtin_expect(!!(x), 0)
+#else
+    /** Void because this platform does not support branch prediction hints. */
+    #define PRISM_LIKELY(x)   (x)
+
+    /** Void because this platform does not support branch prediction hints. */
+    #define PRISM_UNLIKELY(x) (x)
+#endif
+
+/**
+ * We use -Wimplicit-fallthrough to guard potentially unintended fall-through between cases of a switch.
+ * Use PRISM_FALLTHROUGH to explicitly annotate cases where the fallthrough is intentional.
+ */
+#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L // C23 or later
+    #define PRISM_FALLTHROUGH [[fallthrough]];
+#elif defined(__GNUC__) || defined(__clang__)
+    #define PRISM_FALLTHROUGH __attribute__((fallthrough));
+#elif defined(_MSC_VER)
+    #define PRISM_FALLTHROUGH __fallthrough;
+#else
+    #define PRISM_FALLTHROUGH
+#endif
+
 #endif

data/lib/datadog/ruby_core_source/{ruby-3.4.0-preview1 → ruby-3.5.0-preview1}/prism/diagnostic.h

@@ -1,10 +1,10 @@
-/******************************************************************************/
+/*----------------------------------------------------------------------------*/
 /* This file is generated by the templates/template.rb script and should not  */
 /* be modified manually. See                                                  */
 /* templates/include/prism/diagnostic.h.erb                                   */
 /* if you are looking to modify the                                           */
 /* template                                                                   */
-/******************************************************************************/
+/*----------------------------------------------------------------------------*/
 
 /**
  * @file diagnostic.h
@@ -44,7 +44,6 @@ typedef enum {
     PM_ERR_ARGUMENT_FORMAL_GLOBAL,
     PM_ERR_ARGUMENT_FORMAL_IVAR,
     PM_ERR_ARGUMENT_FORWARDING_UNBOUND,
-    PM_ERR_ARGUMENT_IN,
     PM_ERR_ARGUMENT_NO_FORWARDING_AMPERSAND,
     PM_ERR_ARGUMENT_NO_FORWARDING_ELLIPSES,
     PM_ERR_ARGUMENT_NO_FORWARDING_STAR,
@@ -110,8 +109,10 @@ typedef enum {
     PM_ERR_ESCAPE_INVALID_META_REPEAT,
     PM_ERR_ESCAPE_INVALID_UNICODE,
     PM_ERR_ESCAPE_INVALID_UNICODE_CM_FLAGS,
+    PM_ERR_ESCAPE_INVALID_UNICODE_LIST,
     PM_ERR_ESCAPE_INVALID_UNICODE_LITERAL,
     PM_ERR_ESCAPE_INVALID_UNICODE_LONG,
+    PM_ERR_ESCAPE_INVALID_UNICODE_SHORT,
     PM_ERR_ESCAPE_INVALID_UNICODE_TERM,
     PM_ERR_EXPECT_ARGUMENT,
     PM_ERR_EXPECT_EOL_AFTER_STATEMENT,
@@ -126,6 +127,7 @@ typedef enum {
     PM_ERR_EXPECT_EXPRESSION_AFTER_SPLAT,
     PM_ERR_EXPECT_EXPRESSION_AFTER_SPLAT_HASH,
     PM_ERR_EXPECT_EXPRESSION_AFTER_STAR,
+    PM_ERR_EXPECT_FOR_DELIMITER,
     PM_ERR_EXPECT_IDENT_REQ_PARAMETER,
     PM_ERR_EXPECT_IN_DELIMITER,
     PM_ERR_EXPECT_LPAREN_REQ_PARAMETER,
@@ -134,6 +136,7 @@ typedef enum {
     PM_ERR_EXPECT_RPAREN,
     PM_ERR_EXPECT_RPAREN_AFTER_MULTI,
     PM_ERR_EXPECT_RPAREN_REQ_PARAMETER,
+    PM_ERR_EXPECT_SINGLETON_CLASS_DELIMITER,
     PM_ERR_EXPECT_STRING_CONTENT,
     PM_ERR_EXPECT_WHEN_DELIMITER,
     PM_ERR_EXPRESSION_BARE_HASH,
@@ -143,6 +146,7 @@ typedef enum {
     PM_ERR_EXPRESSION_NOT_WRITABLE_FILE,
     PM_ERR_EXPRESSION_NOT_WRITABLE_LINE,
     PM_ERR_EXPRESSION_NOT_WRITABLE_NIL,
+    PM_ERR_EXPRESSION_NOT_WRITABLE_NUMBERED,
     PM_ERR_EXPRESSION_NOT_WRITABLE_SELF,
     PM_ERR_EXPRESSION_NOT_WRITABLE_TRUE,
     PM_ERR_FLOAT_PARSE,
@@ -166,6 +170,7 @@ typedef enum {
     PM_ERR_INSTANCE_VARIABLE_BARE,
     PM_ERR_INVALID_BLOCK_EXIT,
     PM_ERR_INVALID_CHARACTER,
+    PM_ERR_INVALID_COMMA,
     PM_ERR_INVALID_ENCODING_MAGIC_COMMENT,
     PM_ERR_INVALID_ESCAPE_CHARACTER,
     PM_ERR_INVALID_FLOAT_EXPONENT,
@@ -182,6 +187,7 @@ typedef enum {
     PM_ERR_INVALID_NUMBER_UNDERSCORE_INNER,
     PM_ERR_INVALID_NUMBER_UNDERSCORE_TRAILING,
     PM_ERR_INVALID_PERCENT,
+    PM_ERR_INVALID_PERCENT_EOF,
     PM_ERR_INVALID_PRINTABLE_CHARACTER,
     PM_ERR_INVALID_RETRY_AFTER_ELSE,
     PM_ERR_INVALID_RETRY_AFTER_ENSURE,
@@ -210,12 +216,15 @@ typedef enum {
     PM_ERR_MODULE_TERM,
     PM_ERR_MULTI_ASSIGN_MULTI_SPLATS,
     PM_ERR_MULTI_ASSIGN_UNEXPECTED_REST,
+    PM_ERR_NESTING_TOO_DEEP,
     PM_ERR_NO_LOCAL_VARIABLE,
+    PM_ERR_NON_ASSOCIATIVE_OPERATOR,
     PM_ERR_NOT_EXPRESSION,
     PM_ERR_NUMBER_LITERAL_UNDERSCORE,
+    PM_ERR_NUMBERED_PARAMETER_INNER_BLOCK,
     PM_ERR_NUMBERED_PARAMETER_IT,
     PM_ERR_NUMBERED_PARAMETER_ORDINARY,
-    PM_ERR_NUMBERED_PARAMETER_OUTER_SCOPE,
+    PM_ERR_NUMBERED_PARAMETER_OUTER_BLOCK,
     PM_ERR_OPERATOR_MULTI_ASSIGN,
     PM_ERR_OPERATOR_WRITE_ARGUMENTS,
     PM_ERR_OPERATOR_WRITE_BLOCK,
@@ -232,8 +241,9 @@ typedef enum {
     PM_ERR_PARAMETER_SPLAT_MULTI,
     PM_ERR_PARAMETER_STAR,
     PM_ERR_PARAMETER_UNEXPECTED_FWD,
-    PM_ERR_PARAMETER_WILD_LOOSE_COMMA,
     PM_ERR_PARAMETER_UNEXPECTED_NO_KW,
+    PM_ERR_PARAMETER_WILD_LOOSE_COMMA,
+    PM_ERR_PATTERN_ARRAY_MULTIPLE_RESTS,
     PM_ERR_PATTERN_CAPTURE_DUPLICATE,
     PM_ERR_PATTERN_EXPRESSION_AFTER_BRACKET,
     PM_ERR_PATTERN_EXPRESSION_AFTER_COMMA,
@@ -245,6 +255,7 @@ typedef enum {
     PM_ERR_PATTERN_EXPRESSION_AFTER_PIPE,
     PM_ERR_PATTERN_EXPRESSION_AFTER_RANGE,
     PM_ERR_PATTERN_EXPRESSION_AFTER_REST,
+    PM_ERR_PATTERN_FIND_MISSING_INNER,
     PM_ERR_PATTERN_HASH_IMPLICIT,
     PM_ERR_PATTERN_HASH_KEY,
     PM_ERR_PATTERN_HASH_KEY_DUPLICATE,
@@ -262,6 +273,7 @@ typedef enum {
     PM_ERR_REGEXP_INCOMPAT_CHAR_ENCODING,
     PM_ERR_REGEXP_INVALID_UNICODE_RANGE,
     PM_ERR_REGEXP_NON_ESCAPED_MBC,
+    PM_ERR_REGEXP_PARSE_ERROR,
     PM_ERR_REGEXP_TERM,
     PM_ERR_REGEXP_UNKNOWN_OPTIONS,
     PM_ERR_REGEXP_UTF8_CHAR_NON_UTF8_REGEXP,
@@ -286,11 +298,15 @@ typedef enum {
     PM_ERR_TERNARY_COLON,
     PM_ERR_TERNARY_EXPRESSION_FALSE,
     PM_ERR_TERNARY_EXPRESSION_TRUE,
+    PM_ERR_UNARY_DISALLOWED,
     PM_ERR_UNARY_RECEIVER,
     PM_ERR_UNDEF_ARGUMENT,
     PM_ERR_UNEXPECTED_BLOCK_ARGUMENT,
     PM_ERR_UNEXPECTED_INDEX_BLOCK,
     PM_ERR_UNEXPECTED_INDEX_KEYWORDS,
+    PM_ERR_UNEXPECTED_LABEL,
+    PM_ERR_UNEXPECTED_MULTI_WRITE,
+    PM_ERR_UNEXPECTED_RANGE_OPERATOR,
     PM_ERR_UNEXPECTED_SAFE_NAVIGATION,
     PM_ERR_UNEXPECTED_TOKEN_CLOSE_CONTEXT,
     PM_ERR_UNEXPECTED_TOKEN_IGNORE,
@@ -303,6 +319,7 @@ typedef enum {
     PM_ERR_XSTRING_TERM,
 
     // These are the warning diagnostics.
+    PM_WARN_AMBIGUOUS_BINARY_OPERATOR,
     PM_WARN_AMBIGUOUS_FIRST_ARGUMENT_MINUS,
     PM_WARN_AMBIGUOUS_FIRST_ARGUMENT_PLUS,
     PM_WARN_AMBIGUOUS_PREFIX_AMPERSAND,
@@ -318,10 +335,11 @@ typedef enum {
     PM_WARN_DUPLICATED_WHEN_CLAUSE,
     PM_WARN_FLOAT_OUT_OF_RANGE,
     PM_WARN_IGNORED_FROZEN_STRING_LITERAL,
+    PM_WARN_INDENTATION_MISMATCH,
     PM_WARN_INTEGER_IN_FLIP_FLOP,
     PM_WARN_INVALID_CHARACTER,
+    PM_WARN_INVALID_MAGIC_COMMENT_VALUE,
     PM_WARN_INVALID_NUMBERED_REFERENCE,
-    PM_WARN_INVALID_SHAREABLE_CONSTANT_VALUE,
     PM_WARN_KEYWORD_EOL,
     PM_WARN_LITERAL_IN_CONDITION_DEFAULT,
     PM_WARN_LITERAL_IN_CONDITION_VERBOSE,

data/lib/datadog/ruby_core_source/{ruby-3.4.0-preview1 → ruby-3.5.0-preview1}/prism/extension.h

@@ -1,19 +1,19 @@
 #ifndef PRISM_EXT_NODE_H
 #define PRISM_EXT_NODE_H
 
-#define EXPECTED_PRISM_VERSION "0.29.0"
+#define EXPECTED_PRISM_VERSION "1.4.0"
 
 #include <ruby.h>
 #include <ruby/encoding.h>
 #include "prism.h"
 
-VALUE pm_source_new(const pm_parser_t *parser, rb_encoding *encoding);
-VALUE pm_token_new(const pm_parser_t *parser, const pm_token_t *token, rb_encoding *encoding, VALUE source);
-VALUE pm_ast_new(const pm_parser_t *parser, const pm_node_t *node, rb_encoding *encoding, VALUE source);
+VALUE pm_source_new(const pm_parser_t *parser, rb_encoding *encoding, bool freeze);
+VALUE pm_token_new(const pm_parser_t *parser, const pm_token_t *token, rb_encoding *encoding, VALUE source, bool freeze);
+VALUE pm_ast_new(const pm_parser_t *parser, const pm_node_t *node, rb_encoding *encoding, VALUE source, bool freeze);
 VALUE pm_integer_new(const pm_integer_t *integer);
 
 void Init_prism_api_node(void);
 void Init_prism_pack(void);
-PRISM_EXPORTED_FUNCTION void Init_prism(void);
+RUBY_FUNC_EXPORTED void Init_prism(void);
 
 #endif

data/lib/datadog/ruby_core_source/{ruby-3.4.0-preview1 → ruby-3.5.0-preview1}/prism/node.h

@@ -56,27 +56,6 @@ void pm_node_list_free(pm_node_list_t *list);
  */
 PRISM_EXPORTED_FUNCTION void pm_node_destroy(pm_parser_t *parser, struct pm_node *node);
 
-/**
- * This struct stores the information gathered by the pm_node_memsize function.
- * It contains both the memory footprint and additionally metadata about the
- * shape of the tree.
- */
-typedef struct {
-    /** The total memory footprint of the node and all of its children. */
-    size_t memsize;
-
-    /** The number of children the node has. */
-    size_t node_count;
-} pm_memsize_t;
-
-/**
- * Calculates the memory footprint of a given node.
- *
- * @param node The node to calculate the memory footprint of.
- * @param memsize The memory footprint of the node and all of its children.
- */
-PRISM_EXPORTED_FUNCTION void pm_node_memsize(pm_node_t *node, pm_memsize_t *memsize);
-
 /**
  * Returns a string representation of the given node type.
  *

data/lib/datadog/ruby_core_source/{ruby-3.4.0-preview1 → ruby-3.5.0-preview1}/prism/options.h

@@ -7,6 +7,7 @@
 #define PRISM_OPTIONS_H
 
 #include "prism/defines.h"
+#include "prism/util/pm_char.h"
 #include "prism/util/pm_string.h"
 
 #include <stdbool.h>
@@ -38,8 +39,43 @@ typedef struct pm_options_scope {
 
     /** The names of the locals in the scope. */
     pm_string_t *locals;
+
+    /** Flags for the set of forwarding parameters in this scope. */
+    uint8_t forwarding;
 } pm_options_scope_t;
 
+/** The default value for parameters. */
+static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_NONE = 0x0;
+
+/** When the scope is fowarding with the * parameter. */
+static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_POSITIONALS = 0x1;
+
+/** When the scope is fowarding with the ** parameter. */
+static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_KEYWORDS = 0x2;
+
+/** When the scope is fowarding with the & parameter. */
+static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_BLOCK = 0x4;
+
+/** When the scope is fowarding with the ... parameter. */
+static const uint8_t PM_OPTIONS_SCOPE_FORWARDING_ALL = 0x8;
+
+// Forward declaration needed by the callback typedef.
+struct pm_options;
+
+/**
+ * The callback called when additional switches are found in a shebang comment
+ * that need to be processed by the runtime.
+ *
+ * @param options The options struct that may be updated by this callback.
+ *   Certain fields will be checked for changes, specifically encoding,
+ *   command_line, and frozen_string_literal.
+ * @param source The source of the shebang comment.
+ * @param length The length of the source.
+ * @param shebang_callback_data Any additional data that should be passed along
+ *   to the callback.
+ */
+typedef void (*pm_options_shebang_callback_t)(struct pm_options *options, const uint8_t *source, size_t length, void *shebang_callback_data);
+
 /**
  * The version of Ruby syntax that we should be parsing with. This is used to
  * allow consumers to specify which behavior they want in case they need to
@@ -50,13 +86,28 @@ typedef enum {
     PM_OPTIONS_VERSION_LATEST = 0,
 
     /** The vendored version of prism in CRuby 3.3.x. */
-    PM_OPTIONS_VERSION_CRUBY_3_3 = 1
+    PM_OPTIONS_VERSION_CRUBY_3_3 = 1,
+
+    /** The vendored version of prism in CRuby 3.4.x. */
+    PM_OPTIONS_VERSION_CRUBY_3_4 = 2
 } pm_options_version_t;
 
 /**
  * The options that can be passed to the parser.
  */
-typedef struct {
+typedef struct pm_options {
+    /**
+     * The callback to call when additional switches are found in a shebang
+     * comment.
+     */
+    pm_options_shebang_callback_t shebang_callback;
+
+    /**
+     * Any additional data that should be passed along to the shebang callback
+     * if one was set.
+     */
+    void *shebang_callback_data;
+
     /** The name of the file that is currently being parsed. */
     pm_string_t filepath;
 
@@ -103,6 +154,37 @@ typedef struct {
     *  - PM_OPTIONS_FROZEN_STRING_LITERAL_UNSET
     */
     int8_t frozen_string_literal;
+
+    /**
+     * Whether or not the encoding magic comments should be respected. This is a
+     * niche use-case where you want to parse a file with a specific encoding
+     * but ignore any encoding magic comments at the top of the file.
+     */
+    bool encoding_locked;
+
+    /**
+     * When the file being parsed is the main script, the shebang will be
+     * considered for command-line flags (or for implicit -x). The caller needs
+     * to pass this information to the parser so that it can behave correctly.
+     */
+    bool main_script;
+
+    /**
+     * When the file being parsed is considered a "partial" script, jumps will
+     * not be marked as errors if they are not contained within loops/blocks.
+     * This is used in the case that you're parsing a script that you know will
+     * be embedded inside another script later, but you do not have that context
+     * yet. For example, when parsing an ERB template that will be evaluated
+     * inside another script.
+     */
+    bool partial_script;
+
+    /**
+     * Whether or not the parser should freeze the nodes that it creates. This
+     * makes it possible to have a deeply frozen AST that is safe to share
+     * between concurrency primitives.
+     */
+    bool freeze;
 } pm_options_t;
 
 /**
@@ -142,6 +224,16 @@ static const uint8_t PM_OPTIONS_COMMAND_LINE_P = 0x10;
  */
 static const uint8_t PM_OPTIONS_COMMAND_LINE_X = 0x20;
 
+/**
+ * Set the shebang callback option on the given options struct.
+ *
+ * @param options The options struct to set the shebang callback on.
+ * @param shebang_callback The shebang callback to set.
+ * @param shebang_callback_data Any additional data that should be passed along
+ *   to the callback.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_shebang_callback_set(pm_options_t *options, pm_options_shebang_callback_t shebang_callback, void *shebang_callback_data);
+
 /**
  * Set the filepath option on the given options struct.
  *
@@ -166,6 +258,14 @@ PRISM_EXPORTED_FUNCTION void pm_options_line_set(pm_options_t *options, int32_t
  */
 PRISM_EXPORTED_FUNCTION void pm_options_encoding_set(pm_options_t *options, const char *encoding);
 
+/**
+ * Set the encoding_locked option on the given options struct.
+ *
+ * @param options The options struct to set the encoding_locked value on.
+ * @param encoding_locked The encoding_locked value to set.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_encoding_locked_set(pm_options_t *options, bool encoding_locked);
+
 /**
  * Set the frozen string literal option on the given options struct.
  *
@@ -194,6 +294,30 @@ PRISM_EXPORTED_FUNCTION void pm_options_command_line_set(pm_options_t *options,
  */
 PRISM_EXPORTED_FUNCTION bool pm_options_version_set(pm_options_t *options, const char *version, size_t length);
 
+/**
+ * Set the main script option on the given options struct.
+ *
+ * @param options The options struct to set the main script value on.
+ * @param main_script The main script value to set.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_main_script_set(pm_options_t *options, bool main_script);
+
+/**
+ * Set the partial script option on the given options struct.
+ *
+ * @param options The options struct to set the partial script value on.
+ * @param partial_script The partial script value to set.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_partial_script_set(pm_options_t *options, bool partial_script);
+
+/**
+ * Set the freeze option on the given options struct.
+ *
+ * @param options The options struct to set the freeze value on.
+ * @param freeze The freeze value to set.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_freeze_set(pm_options_t *options, bool freeze);
+
 /**
  * Allocate and zero out the scopes array on the given options struct.
  *
@@ -231,6 +355,14 @@ PRISM_EXPORTED_FUNCTION bool pm_options_scope_init(pm_options_scope_t *scope, si
  */
 PRISM_EXPORTED_FUNCTION const pm_string_t * pm_options_scope_local_get(const pm_options_scope_t *scope, size_t index);
 
+/**
+ * Set the forwarding option on the given scope struct.
+ *
+ * @param scope The scope struct to set the forwarding on.
+ * @param forwarding The forwarding value to set.
+ */
+PRISM_EXPORTED_FUNCTION void pm_options_scope_forwarding_set(pm_options_scope_t *scope, uint8_t forwarding);
+
 /**
  * Free the internal memory associated with the options.
  *
@@ -261,6 +393,10 @@ PRISM_EXPORTED_FUNCTION void pm_options_free(pm_options_t *options);
  * | `1`     | -l command line option     |
  * | `1`     | -a command line option     |
  * | `1`     | the version                |
+ * | `1`     | encoding locked            |
+ * | `1`     | main script                |
+ * | `1`     | partial script             |
+ * | `1`     | freeze                     |
  * | `4`     | the number of scopes       |
  * | ...     | the scopes                 |
  *
@@ -276,6 +412,7 @@ PRISM_EXPORTED_FUNCTION void pm_options_free(pm_options_t *options);
  * | # bytes | field                      |
  * | ------- | -------------------------- |
  * | `4`     | the number of locals       |
+ * | `1`     | the forwarding flags       |
  * | ...     | the locals                 |
  *
  * Each local is laid out as follows:
@@ -293,8 +430,8 @@ PRISM_EXPORTED_FUNCTION void pm_options_free(pm_options_t *options);
  * * The encoding can have a length of 0, in which case we'll use the default
  *   encoding (UTF-8). If it's not 0, it should correspond to a name of an
  *   encoding that can be passed to `Encoding.find` in Ruby.
- * * The frozen string literal and suppress warnings fields are booleans, so
- *   their values should be either 0 or 1.
+ * * The frozen string literal, encoding locked, main script, and partial script
+ *   fields are booleans, so their values should be either 0 or 1.
  * * The number of scopes can be 0.
  *
  * @param options The options struct to deserialize into.