binding_of_caller 0.4.0 → 0.8.0

data/ext/binding_of_caller/binding_of_caller.c

@@ -1,15 +1,32 @@
 /* (c) 2011 John Mair (banisterfiend), MIT license */
 
 #include <ruby.h>
-
-#include <ruby/io.h>
-#include <ruby/re.h>
 #include "vm_core.h"
-#include "gc.h"
+#include "rubys_gc.h"
 
 typedef enum { false, true } bool;
 
-const int max_frame_errors = 4;
+static VALUE
+string2sym(const char * string)
+{
+  return ID2SYM(rb_intern(string));
+}
+
+static inline const rb_data_type_t *
+threadptr_data_type(void)
+{
+  static const rb_data_type_t *thread_data_type;
+  if (!thread_data_type) {
+    VALUE current_thread = rb_thread_current();
+    thread_data_type = RTYPEDDATA_TYPE(current_thread);
+  }
+  return thread_data_type;
+}
+
+#define ruby_thread_data_type *threadptr_data_type()
+#define ruby_threadptr_data_type *threadptr_data_type()
+
+#define ruby_current_thread ((rb_thread_t *)RTYPEDDATA_DATA(rb_thread_current()))
 
 static size_t
 binding_memsize(const void *ptr)
@@ -37,7 +54,11 @@ binding_mark(void *ptr)
   if (ptr) {
     bind = ptr;
     RUBY_MARK_UNLESS_NULL(bind->env);
+
+#ifdef RUBY_192
     RUBY_MARK_UNLESS_NULL(bind->filename);
+#endif
+
   }
   RUBY_MARK_LEAVE("binding");
 }
@@ -58,32 +79,52 @@ binding_alloc(VALUE klass)
   return obj;
 }
 
-static bool valid_frame_p(rb_control_frame_t * cfp, rb_control_frame_t * limit_cfp) {
-  if (cfp > limit_cfp)
-    rb_raise(rb_eRuntimeError, "Invalid frame, gone beyond end of stack!");
+static bool ifunc_p(rb_control_frame_t * cfp) {
+  return (cfp->flag & VM_FRAME_MAGIC_MASK) == VM_FRAME_MAGIC_IFUNC;
+}
 
-  return cfp->iseq && !NIL_P(cfp->self);
+static bool valid_frame_p(rb_control_frame_t * cfp, rb_control_frame_t * limit_cfp) {
+  return cfp->iseq && !ifunc_p(cfp) && !NIL_P(cfp->self);
 }
 
 static rb_control_frame_t * find_valid_frame(rb_control_frame_t * cfp, rb_control_frame_t * limit_cfp) {
-  int error_count = 0;
-
-  while (error_count <= max_frame_errors) {
+  while (cfp < limit_cfp) {
     cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
 
+    if (cfp >= limit_cfp)
+      return NULL;
+
     if (valid_frame_p(cfp, limit_cfp))
       return cfp;
-    else
-      error_count += 1;
   }
 
-  // never reached
-  return 0;
+  // beyond end of stack
+  return NULL;
+}
+
+static VALUE
+frametype_name(VALUE flag)
+{
+  switch (flag & VM_FRAME_MAGIC_MASK) {
+  case VM_FRAME_MAGIC_METHOD: return string2sym("method");
+  case VM_FRAME_MAGIC_BLOCK:  return string2sym("block");
+  case VM_FRAME_MAGIC_CLASS:  return string2sym("class");
+  case VM_FRAME_MAGIC_TOP:    return string2sym("top");
+  case VM_FRAME_MAGIC_CFUNC:  return string2sym("cfunc");
+  case VM_FRAME_MAGIC_PROC:   return string2sym("proc");
+  case VM_FRAME_MAGIC_IFUNC:  return string2sym("ifunc");
+  case VM_FRAME_MAGIC_EVAL:   return string2sym("eval");
+  case VM_FRAME_MAGIC_LAMBDA: return string2sym("lambda");
+  default:
+    rb_raise(rb_eRuntimeError, "Unknown frame type! got flag: %d", FIX2INT(flag));
+  }
 }
 
 static VALUE binding_of_caller(VALUE self, VALUE rb_level)
 {
-  rb_thread_t *th = GET_THREAD();
+  rb_thread_t *th;
+  GetThreadPtr(rb_thread_current(), th);
+
   rb_control_frame_t *cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(th->cfp);
   rb_control_frame_t *limit_cfp = (void *)(th->stack + th->stack_size);
   int level = FIX2INT(rb_level);
@@ -92,6 +133,9 @@ static VALUE binding_of_caller(VALUE self, VALUE rb_level)
   for (int i = 0; i < level; i++) {
     cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
 
+    if (cfp >= limit_cfp)
+      rb_raise(rb_eRuntimeError, "Invalid frame, gone beyond end of stack!");
+
     // skip invalid frames
     if (!valid_frame_p(cfp, limit_cfp))
       cfp = find_valid_frame(cfp, limit_cfp);
@@ -100,23 +144,82 @@ static VALUE binding_of_caller(VALUE self, VALUE rb_level)
   VALUE bindval = binding_alloc(rb_cBinding);
   rb_binding_t *bind;
 
-  if (cfp == 0) {
+  if (cfp == 0)
     rb_raise(rb_eRuntimeError, "Can't create Binding Object on top of Fiber.");
-  }
 
   GetBindingPtr(bindval, bind);
+
   bind->env = rb_vm_make_env_object(th, cfp);
   bind->filename = cfp->iseq->filename;
   bind->line_no = rb_vm_get_sourceline(cfp);
+  
+  rb_iv_set(bindval, "@frame_type", frametype_name(cfp->flag));
+  rb_iv_set(bindval, "@frame_description", cfp->iseq->name);
+
   return bindval;
 }
 
+static VALUE
+frame_type(VALUE self)
+{
+  return rb_iv_get(self, "@frame_type");
+}
+
+static VALUE
+frame_description(VALUE self)
+{
+  return rb_iv_get(self, "@frame_description");
+}
+
+static VALUE frame_count(VALUE self)
+{
+  rb_thread_t *th;
+  GetThreadPtr(rb_thread_current(), th);
+
+  rb_control_frame_t *cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(th->cfp);
+  rb_control_frame_t *limit_cfp = (void *)(th->stack + th->stack_size);
+
+  int i = 1;
+  while (cfp < limit_cfp) {
+    cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
+
+    if (cfp >= limit_cfp)
+      return INT2FIX(i);
+
+    // skip invalid frames
+    if (!valid_frame_p(cfp, limit_cfp))
+      cfp = find_valid_frame(cfp, limit_cfp);
+
+    if (!cfp)
+      break;
+
+    i++;
+  }
+
+  return INT2FIX(i);
+}
+
+static VALUE
+callers(VALUE self)
+{
+  VALUE ary = rb_ary_new();
+
+  for (int i = 0; i < FIX2INT(frame_count(self)); i++)
+    rb_ary_push(ary, binding_of_caller(self, INT2FIX(i)));
+
+  return ary;
+}
+
 void
 Init_binding_of_caller()
 {
   VALUE mBindingOfCaller = rb_define_module("BindingOfCaller");
 
   rb_define_method(mBindingOfCaller, "of_caller", binding_of_caller, 1);
+  rb_define_method(mBindingOfCaller, "frame_count", frame_count, 0);
+  rb_define_method(mBindingOfCaller, "frame_type", frame_type, 0);
+  rb_define_method(mBindingOfCaller, "frame_description", frame_description, 0);
+  rb_define_method(mBindingOfCaller, "callers", callers, 0);
   rb_include_module(rb_cBinding, mBindingOfCaller);
 }
 

data/ext/binding_of_caller/extconf.rb

@@ -1,14 +1,28 @@
-require 'mkmf'
-
-$CFLAGS += " -O0"
-$CFLAGS += " -std=c99"
+def fake_makefile
+  File.open(File.join(File.dirname(__FILE__), "Makefile"), "w") do |f|
+    f.puts %[install:\n\techo "Nada."]
+  end
+end
 
-case RUBY_VERSION
-when /1.9.2/
-  $CFLAGS += " -I./ruby_headers/192/"
-when /1.9.3/
-  puts "hit 193"
-  $CFLAGS += " -I./ruby_headers/193/"
+def mri_1_9?
+  defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" &&
+    RUBY_VERSION =~ /^1\.9/
 end
 
-create_makefile('binding_of_caller')
+if mri_1_9?
+  require 'mkmf'
+
+  $CFLAGS += " -O0"
+  $CFLAGS += " -std=c99"
+
+  case RUBY_VERSION
+  when /1.9.2/
+    $CFLAGS += " -I./ruby_headers/192/ -DRUBY_192"
+  when /1.9.3/
+    $CFLAGS += " -I./ruby_headers/193/ -DRUBY_193"
+  end
+
+  create_makefile('binding_of_caller')
+else
+  fake_makefile
+end

data/ext/binding_of_caller/ruby_headers/192/version.h

@@ -1,13 +1,5 @@
 #define RUBY_VERSION "1.9.2"
-<<<<<<< HEAD
-<<<<<<< HEAD
-#define RUBY_PATCHLEVEL 34
-=======
-#define RUBY_PATCHLEVEL 27
->>>>>>> 7f5d559... merges r29155 from trunk into ruby_1_9_2. fixes #3777, #3772 and #3722.
-=======
 #define RUBY_PATCHLEVEL 30
->>>>>>> 13fdd22... merges r29188 from trunk into ruby_1_9_2.
 #define RUBY_VERSION_MAJOR 1
 #define RUBY_VERSION_MINOR 9
 #define RUBY_VERSION_TEENY 1

data/lib/binding_of_caller/jruby_interpreted.rb

@@ -0,0 +1,123 @@
+module BindingOfCaller
+  class JRubyBindingHolder
+    java_import org.jruby.RubyBinding
+
+    def initialize(binding)
+      @binding = binding
+    end
+
+    def eval(code, file = nil, line = nil)
+      b = JRuby.dereference(RubyBinding.new(JRuby.runtime, Binding, @binding))
+      if (file == nil)
+        Kernel.eval code, b
+      else
+        Kernel.eval code, b, file, line
+      end
+    end
+
+    def frame_type
+      case
+        when block?
+          :block
+        when eval?
+          :eval
+        when top?
+          :top
+        else
+          :method
+      end
+    end
+
+    def frame_description
+      "#{block_desc}#{method_desc}"
+    end
+
+    private
+
+    def block?
+      @binding.getDynamicScope().getStaticScope().isBlockScope()
+    end
+
+    def eval?
+      @binding.getFrame().getKlazz().nil? && @binding.getLine() != 0
+    end
+
+    def top?
+      @binding.getFrame().getKlazz().nil? && @binding.getLine() == 0
+    end
+
+    def block_desc
+      if frame_type == :block
+        "block in "
+      end
+    end
+
+    def method_desc
+      @binding.getFrame().getName() || "<main>"
+    end
+  end
+
+  module BindingExtensions
+    def of_caller(index = 1)
+      index += 1 # always omit this frame
+      JRuby.runtime.current_context.binding_of_caller(index)
+    end
+
+    def callers
+      ary = []
+      n = 2
+      while binding = of_caller(n)
+        ary << binding
+        n += 1
+      end
+      ary
+    end
+
+    def frame_count
+      callers.count - 1
+    end
+
+    def frame_type
+      nil
+    end
+
+    def frame_description
+      nil
+    end
+  end
+end
+
+
+class org::jruby::runtime::ThreadContext
+  java_import org.jruby.runtime.Binding
+  java_import org.jruby.RubyInstanceConfig::CompileMode
+
+  field_accessor :frameStack, :frameIndex,
+                 :scopeStack, :scopeIndex,
+                 :backtrace, :backtraceIndex
+
+  def binding_of_caller(index)
+    unless JRuby.runtime.instance_config.compile_mode == CompileMode::OFF
+      raise RuntimeError, "caller binding only supported in interpreter"
+    end
+
+    index += 1 # always omit this frame
+
+    return nil if index > frameIndex
+
+    frame = frameStack[frameIndex - index]
+
+    return binding_of_caller(index - 1) if index > scopeIndex
+
+    scope = scopeStack[scopeIndex - index]
+    element = backtrace[backtraceIndex - index]
+
+    binding = Binding.new(frame, scope.static_scope.module, scope, element.clone)
+
+    BindingOfCaller::JRubyBindingHolder.new(binding)
+  end
+end
+
+class ::Binding
+  include BindingOfCaller::BindingExtensions
+end

data/lib/binding_of_caller/mri2.rb

@@ -0,0 +1,63 @@
+require 'debug_inspector'
+
+module BindingOfCaller
+  module BindingExtensions
+    # Retrieve the binding of the nth caller of the current frame.
+    # @return [Binding]
+    def of_caller(n)
+      c = callers.drop(1)
+      if n > (c.size - 1)
+        raise "No such frame, gone beyond end of stack!"
+      else
+        c[n]
+      end
+    end
+
+    # Return bindings for all caller frames.
+    # @return [Array<Binding>]
+    def callers
+      ary = []
+
+      RubyVM::DebugInspector.open do |dc|
+        locs = dc.backtrace_locations
+
+        locs.size.times do |i|
+          b = dc.frame_binding(i)
+          if b
+            b.instance_variable_set(:@iseq, dc.frame_iseq(i))
+            ary << b
+          end
+        end
+      end
+
+      ary.drop(1)
+    end
+
+    # Number of parent frames available at the point of call.
+    # @return [Fixnum]
+    def frame_count
+      callers.size - 1
+    end
+
+    # The type of the frame.
+    # @return [Symbol]
+    def frame_type
+      return nil if !@iseq
+      
+      # apparently the 9th element of the iseq array holds the frame type
+      # ...not sure how reliable this is.
+      @frame_type ||= @iseq.to_a[9]
+    end
+
+    # The description of the frame.
+    # @return [String]
+    def frame_description
+      return nil if !@iseq
+      @frame_description ||= @iseq.label
+    end
+  end
+end
+
+class ::Binding
+  include BindingOfCaller::BindingExtensions
+end

data/lib/binding_of_caller/rubinius.rb

@@ -0,0 +1,67 @@
+module BindingOfCaller
+  module BindingExtensions
+
+    # Retrieve the binding of the nth caller of the current frame.
+    # @return [Binding]
+    def of_caller(n)
+      location = Rubinius::VM.backtrace(1 + n, true).first
+
+      raise RuntimeError, "Invalid frame, gone beyond end of stack!" if location.nil?
+
+      setup_binding_from_location(location)
+    end
+
+    # The description of the frame.
+    # @return [String]
+    def frame_description
+      @frame_description
+    end
+
+    # Return bindings for all caller frames.
+    # @return [Array<Binding>]
+    def callers
+      Rubinius::VM.backtrace(1, true).map &(method(:setup_binding_from_location).
+                                            to_proc)
+    end
+
+    # Number of parent frames available at the point of call.
+    # @return [Fixnum]
+    def frame_count
+      Rubinius::VM.backtrace(1).count
+    end
+
+    # The type of the frame.
+    # @return [Symbol]
+    def frame_type
+      if compiled_code.for_module_body?
+        :class
+      elsif compiled_code.for_eval?
+        :eval
+      elsif compiled_code.is_block?
+        :block
+      else
+        :method
+      end
+    end
+
+    protected
+
+    def setup_binding_from_location(location)
+      binding = Binding.setup location.variables,
+                              location.variables.method,
+                              location.constant_scope,
+                              location.variables.self,
+                              location
+
+      binding.instance_variable_set :@frame_description,
+                                   location.describe.gsub("{ } in", "block in")
+
+      binding
+    end
+  end
+end
+
+class ::Binding
+  include BindingOfCaller::BindingExtensions
+  extend BindingOfCaller::BindingExtensions
+end

data/lib/binding_of_caller/version.rb

@@ -1,3 +1,3 @@
-module BindingOfCaller
-  VERSION = "0.4.0"
-end
+module BindingOfCaller
+  VERSION = "0.8.0"
+end

data/lib/binding_of_caller.rb

@@ -0,0 +1,14 @@
+dlext = RbConfig::CONFIG['DLEXT']
+
+mri_2 = defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" &&
+    RUBY_VERSION =~ /^2/
+
+if mri_2
+  require 'binding_of_caller/mri2'
+elsif defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby"
+  require "binding_of_caller.#{dlext}"
+elsif defined?(Rubinius)
+  require 'binding_of_caller/rubinius'
+elsif defined?(JRuby)
+  require 'binding_of_caller/jruby_interpreted'
+end

data/test/test_binding_of_caller.rb

@@ -0,0 +1,161 @@
+unless Object.const_defined? :BindingOfCaller
+  $:.unshift File.expand_path '../../lib', __FILE__
+  require 'binding_of_caller'
+  require 'binding_of_caller/version'
+end
+
+class Module
+  public :remove_const
+end
+
+puts "Testing binding_of_caller version #{BindingOfCaller::VERSION}..."
+puts "Ruby version: #{RUBY_VERSION}"
+
+describe BindingOfCaller do
+  describe "of_caller" do
+    it "should fetch immediate caller's binding when 0 is passed" do
+      o = Object.new
+      def o.a
+        var = 1
+        binding.of_caller(0).eval('var')
+      end
+
+      o. a.should == 1
+    end
+
+    it "should fetch parent of caller's binding when 1 is passed" do
+      o = Object.new
+      def o.a
+        var = 1
+        b
+      end
+
+      def o.b
+        binding.of_caller(1).eval('var')
+      end
+
+      o.a.should == 1
+    end
+
+    it "should modify locals in parent of caller's binding" do
+      o = Object.new
+      def o.a
+        var = 1
+        b
+        var
+      end
+
+      def o.b
+        binding.of_caller(1).eval('var = 20')
+      end
+
+      o.a.should == 20
+    end
+
+    it "should raise an exception when retrieving an out of band binding" do
+      o = Object.new
+      def o.a
+        binding.of_caller(100)
+      end
+
+      lambda { o.a }.should.raise RuntimeError
+    end
+  end
+
+  describe "callers" do
+    before do
+      @o = Object.new
+    end
+
+    it 'should return the first non-internal binding when using callers.first' do
+      def @o.meth
+        x = :a_local
+        [binding.callers.first, binding.of_caller(0)]
+      end
+
+      b1, b2 = @o.meth
+      b1.eval("x").should == :a_local
+      b2.eval("x").should == :a_local
+    end
+  end
+
+  describe "frame_count" do
+    it 'frame_count should equal callers.count' do
+      binding.frame_count.should == binding.callers.count
+    end
+  end
+
+  describe "frame_descripton" do
+    it 'can be called on ordinary binding without raising' do
+      lambda { binding.frame_description }.should.not.raise 
+    end
+
+    it 'describes a block frame' do
+      binding.of_caller(0).frame_description.should =~ /block/
+    end
+
+    it 'describes a method frame' do
+      o = Object.new
+      def o.horsey_malone
+        binding.of_caller(0).frame_description.should =~ /horsey_malone/
+      end
+      o.horsey_malone
+    end
+
+    it 'describes a class frame' do
+      class HorseyMalone
+        binding.of_caller(0).frame_description.should =~ /class/i
+      end
+      Object.remove_const(:HorseyMalone)
+    end
+  end
+
+  describe "frame_type" do
+    it 'can be called on ordinary binding without raising' do
+      lambda { binding.frame_type }.should.not.raise 
+    end
+
+    describe "when inside a class definition" do
+      before do
+        class HorseyMalone
+          @binding = binding.of_caller(0)
+          def self.binding; @binding; end
+        end
+        @binding = HorseyMalone.binding
+      end
+
+      it 'returns :class' do
+        @binding.frame_type.should == :class
+      end
+    end
+
+    describe "when evaluated" do
+      before { @binding = eval("binding.of_caller(0)") }
+
+      it 'returns :eval' do
+        @binding.frame_type.should == :eval
+      end
+    end
+
+    describe "when inside a block" do
+      before { @binding = proc { binding.of_caller(0) }.call }
+
+      it 'returns :block' do
+        @binding.frame_type.should == :block
+      end
+    end
+
+    describe "when inside an instance method" do
+      before do
+        o = Object.new
+        def o.a; binding.of_caller(0); end
+        @binding = o.a;
+      end
+
+      it 'returns :method' do
+        @binding.frame_type.should == :method
+      end
+    end
+  end
+end
+