prism 0.30.0 → 1.0.0

data/include/prism/defines.h

@@ -118,6 +118,15 @@
 #   endif
 #endif
 
+/**
+ * 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.
+ */
+#ifndef PRISM_HAS_NO_FILESYSTEM
+#   define PRISM_HAS_FILESYSTEM
+#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

data/include/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
@@ -110,8 +110,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,
@@ -237,6 +239,7 @@ typedef enum {
     PM_ERR_PARAMETER_UNEXPECTED_FWD,
     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,
@@ -248,6 +251,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,
@@ -290,11 +294,14 @@ 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_MULTI_WRITE,
+    PM_ERR_UNEXPECTED_RANGE_OPERATOR,
     PM_ERR_UNEXPECTED_SAFE_NAVIGATION,
     PM_ERR_UNEXPECTED_TOKEN_CLOSE_CONTEXT,
     PM_ERR_UNEXPECTED_TOKEN_IGNORE,
@@ -323,10 +330,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/include/prism/options.h

@@ -40,6 +40,23 @@ typedef struct pm_options_scope {
     pm_string_t *locals;
 } pm_options_scope_t;
 
+// 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
@@ -56,7 +73,19 @@ typedef enum {
 /**
  * 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 +132,13 @@ 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;
 } pm_options_t;
 
 /**
@@ -142,6 +178,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 +212,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.
  *

data/include/prism/parser.h

@@ -364,6 +364,9 @@ typedef enum {
     /** a rescue statement within a lambda expression */
     PM_CONTEXT_LAMBDA_RESCUE,
 
+    /** the predicate clause of a loop statement */
+    PM_CONTEXT_LOOP_PREDICATE,
+
     /** the top level context */
     PM_CONTEXT_MAIN,
 
@@ -505,9 +508,9 @@ typedef struct {
 /** The type of shareable constant value that can be set. */
 typedef uint8_t pm_shareable_constant_value_t;
 static const pm_shareable_constant_value_t PM_SCOPE_SHAREABLE_CONSTANT_NONE = 0x0;
-static const pm_shareable_constant_value_t PM_SCOPE_SHAREABLE_CONSTANT_LITERAL = 0x1;
-static const pm_shareable_constant_value_t PM_SCOPE_SHAREABLE_CONSTANT_EXPERIMENTAL_EVERYTHING = 0x2;
-static const pm_shareable_constant_value_t PM_SCOPE_SHAREABLE_CONSTANT_EXPERIMENTAL_COPY = 0x4;
+static const pm_shareable_constant_value_t PM_SCOPE_SHAREABLE_CONSTANT_LITERAL = PM_SHAREABLE_CONSTANT_NODE_FLAGS_LITERAL;
+static const pm_shareable_constant_value_t PM_SCOPE_SHAREABLE_CONSTANT_EXPERIMENTAL_EVERYTHING = PM_SHAREABLE_CONSTANT_NODE_FLAGS_EXPERIMENTAL_EVERYTHING;
+static const pm_shareable_constant_value_t PM_SCOPE_SHAREABLE_CONSTANT_EXPERIMENTAL_COPY = PM_SHAREABLE_CONSTANT_NODE_FLAGS_EXPERIMENTAL_COPY;
 
 /**
  * This tracks an individual local variable in a certain lexical context, as
@@ -622,6 +625,13 @@ typedef uint32_t pm_state_stack_t;
  * it's considering.
  */
 struct pm_parser {
+    /**
+     * The next node identifier that will be assigned. This is a unique
+     * identifier used to track nodes such that the syntax tree can be dropped
+     * but the node can be found through another parse.
+     */
+    uint32_t node_id;
+
     /** The current state of the lexer. */
     pm_lex_state_t lex_state;
 
@@ -857,6 +867,14 @@ struct pm_parser {
     /** Whether or not we're currently recovering from a syntax error. */
     bool recovering;
 
+    /**
+     * This is very specialized behavior for when you want to parse in a context
+     * that does not respect encoding comments. Its main use case is translating
+     * into the whitequark/parser AST which re-encodes source files in UTF-8
+     * before they are parsed and ignores encoding comments.
+     */
+    bool encoding_locked;
+
     /**
      * Whether or not the encoding has been changed by a magic comment. We use
      * this to provide a fast path for the lexer instead of going through the
@@ -884,6 +902,12 @@ struct pm_parser {
      * characters.
      */
     bool current_regular_expression_ascii_only;
+
+    /**
+     * By default, Ruby always warns about mismatched indentation. This can be
+     * toggled with a magic comment.
+     */
+    bool warn_mismatched_indentation;
 };
 
 #endif

data/include/prism/regexp.h

@@ -32,11 +32,12 @@ typedef void (*pm_regexp_error_callback_t)(const uint8_t *start, const uint8_t *
  * @param parser The parser that is currently being used.
  * @param source The source code to parse.
  * @param size The size of the source code.
+ * @param extended_mode Whether to parse the regular expression in extended mode.
  * @param name_callback The optional callback to call when a named capture group is found.
  * @param name_data The optional data to pass to the name callback.
  * @param error_callback The callback to call when a parse error is found.
  * @param error_data The data to pass to the error callback.
  */
-PRISM_EXPORTED_FUNCTION void pm_regexp_parse(pm_parser_t *parser, const uint8_t *source, size_t size, pm_regexp_name_callback_t name_callback, void *name_data, pm_regexp_error_callback_t error_callback, void *error_data);
+PRISM_EXPORTED_FUNCTION void pm_regexp_parse(pm_parser_t *parser, const uint8_t *source, size_t size, bool extended_mode, pm_regexp_name_callback_t name_callback, void *name_data, pm_regexp_error_callback_t error_callback, void *error_data);
 
 #endif

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.

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>

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 30
+#define PRISM_VERSION_MINOR 0
 
 /**
  * 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.30.0"
+#define PRISM_VERSION "1.0.0"
 
 #endif

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
 

data/lib/prism/dispatcher.rb

@@ -22,7 +22,8 @@ module Prism
   #       end
   #     end
   #
-  #     dispatcher = Dispatcher.new
+  #     listener = OctalListener.new
+  #     dispatcher = Prism::Dispatcher.new
   #     dispatcher.register(listener, :on_integer_node_enter)
   #
   # Then, you can walk any number of trees and dispatch events to the listeners: