Put child iseq methods on iseq

Author: kddnewton

lib/syntax_tree/compiler.rb

@@ -225,14 +225,17 @@ def visit_CHAR(node)
     end
 
     def visit_END(node)
-      name = "block in #{iseq.name}"
       once_iseq =
-        with_instruction_sequence(:block, name, node) do
+        with_child_iseq(iseq.block_child_iseq(node.location)) do
           postexe_iseq =
-            with_instruction_sequence(:block, name, node) do
+            with_child_iseq(iseq.block_child_iseq(node.location)) do
+              iseq.event(:RUBY_EVENT_B_CALL)
+
               *statements, last_statement = node.statements.body
               visit_all(statements)
               with_last_statement { visit(last_statement) }
+
+              iseq.event(:RUBY_EVENT_B_RETURN)
               iseq.leave
             end
 
@@ -422,7 +425,7 @@ def visit_binary(node)
     end
 
     def visit_block(node)
-      with_instruction_sequence(:block, "block in #{iseq.name}", node) do
+      with_child_iseq(iseq.block_child_iseq(node.location)) do
         iseq.event(:RUBY_EVENT_B_CALL)
         visit(node.block_var)
         visit(node.bodystmt)
@@ -606,7 +609,7 @@ def visit_case(node)
     def visit_class(node)
       name = node.constant.constant.value.to_sym
       class_iseq =
-        with_instruction_sequence(:class, "<class:#{name}>", node) do
+        with_child_iseq(iseq.class_child_iseq(name, node.location)) do
           iseq.event(:RUBY_EVENT_CLASS)
           visit(node.bodystmt)
           iseq.event(:RUBY_EVENT_END)
@@ -673,7 +676,7 @@ def visit_const_path_ref(node)
 
     def visit_def(node)
       method_iseq =
-        with_instruction_sequence(:method, node.name.value, node) do
+        with_child_iseq(iseq.method_child_iseq(node.name.value, node.location)) do
           visit(node.params) if node.params
           iseq.event(:RUBY_EVENT_CALL)
           visit(node.bodystmt)
@@ -788,11 +791,7 @@ def visit_for(node)
       iseq.local_table.plain(name)
 
       block_iseq =
-        with_instruction_sequence(
-          :block,
-          "block in #{iseq.name}",
-          node.statements
-        ) do
+        with_child_iseq(iseq.block_child_iseq(node.statements.location)) do
           iseq.argument_options[:lead_num] ||= 0
           iseq.argument_options[:lead_num] += 1
           iseq.argument_options[:ambiguous_param0] = true
@@ -896,7 +895,7 @@ def visit_label(node)
 
     def visit_lambda(node)
       lambda_iseq =
-        with_instruction_sequence(:block, "block in #{iseq.name}", node) do
+        with_child_iseq(iseq.block_child_iseq(node.location)) do
           iseq.event(:RUBY_EVENT_B_CALL)
           visit(node.params)
           visit(node.statements)
@@ -947,7 +946,7 @@ def visit_mlhs(node)
     def visit_module(node)
       name = node.constant.constant.value.to_sym
       module_iseq =
-        with_instruction_sequence(:class, "<module:#{name}>", node) do
+        with_child_iseq(iseq.module_child_iseq(name, node.location)) do
           iseq.event(:RUBY_EVENT_CLASS)
           visit(node.bodystmt)
           iseq.event(:RUBY_EVENT_END)
@@ -1168,7 +1167,18 @@ def visit_program(node)
         end
       end
 
-      with_instruction_sequence(:top, "<compiled>", node) do
+      top_iseq =
+        YARV::InstructionSequence.new(
+          :top,
+          "<compiled>",
+          nil,
+          node.location,
+          frozen_string_literal: frozen_string_literal,
+          operands_unification: operands_unification,
+          specialized_instruction: specialized_instruction
+        )
+
+      with_child_iseq(top_iseq) do
         visit_all(preexes)
 
         if statements.empty?
@@ -1231,7 +1241,7 @@ def visit_sclass(node)
       iseq.putnil
 
       singleton_iseq =
-        with_instruction_sequence(:class, "singleton class", node) do
+        with_child_iseq(iseq.singleton_class_child_iseq(node.location)) do
           iseq.event(:RUBY_EVENT_CLASS)
           visit(node.bodystmt)
           iseq.event(:RUBY_EVENT_END)
@@ -1702,24 +1712,13 @@ def visit_string_parts(node)
     # on the compiler. When we descend into a node that has its own
     # instruction sequence, this method can be called to temporarily set the
     # new value of the instruction sequence, yield, and then set it back.
-    def with_instruction_sequence(type, name, node)
+    def with_child_iseq(child_iseq)
       parent_iseq = iseq
 
       begin
-        iseq =
-          YARV::InstructionSequence.new(
-            type,
-            name,
-            parent_iseq,
-            node.location,
-            frozen_string_literal: frozen_string_literal,
-            operands_unification: operands_unification,
-            specialized_instruction: specialized_instruction
-          )
-
-        @iseq = iseq
+        @iseq = child_iseq
         yield
-        iseq
+        child_iseq
       ensure
         @iseq = parent_iseq
       end

lib/syntax_tree/yarv.rb

@@ -210,14 +210,6 @@ def length
         end
       end
 
-      def each_child
-        insns.each do |insn|
-          insn[1..].each do |operand|
-            yield operand if operand.is_a?(InstructionSequence)
-          end
-        end
-      end
-
       def eval
         compiled = to_a
 
@@ -253,6 +245,44 @@ def to_a
         ]
       end
 
+      ##########################################################################
+      # Child instruction sequence methods
+      ##########################################################################
+
+      def child_iseq(type, name, location)
+        InstructionSequence.new(
+          type,
+          name,
+          self,
+          location,
+          frozen_string_literal: frozen_string_literal,
+          operands_unification: operands_unification,
+          specialized_instruction: specialized_instruction
+        )
+      end
+
+      def block_child_iseq(location)
+        current = self
+        current = current.parent_iseq while current.type == :block
+        child_iseq(:block, "block in #{current.name}", location)
+      end
+
+      def class_child_iseq(name, location)
+        child_iseq(:class, "<class:#{name}>", location)
+      end
+
+      def method_child_iseq(name, location)
+        child_iseq(:method, name, location)
+      end
+
+      def module_child_iseq(name, location)
+        child_iseq(:class, "<module:#{name}>", location)
+      end
+
+      def singleton_class_child_iseq(location)
+        child_iseq(:class, "singleton class", location)
+      end
+
       ##########################################################################
       # Instruction push methods
       ##########################################################################

test/compiler_test.rb

@@ -6,6 +6,9 @@
 module SyntaxTree
   class CompilerTest < Minitest::Test
     CASES = [
+      # Hooks
+      "BEGIN { a = 1 }",
+      "a = 1; END { a = 1 }; a",
       # Various literals placed on the stack
       "true",
       "false",