binding_of_caller 0.2.0 → 0.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gemtest +0 -0
- data/.gitignore +7 -0
- data/.yardopts +1 -0
- data/LICENSE +25 -0
- data/README.md +38 -8
- data/Rakefile +59 -46
- data/examples/example.rb +41 -0
- data/ext/binding_of_caller/binding_of_caller.c +133 -37
- data/ext/binding_of_caller/extconf.rb +2 -3
- data/lib/binding_of_caller/version.rb +2 -2
- data/lib/binding_of_caller.bundle +0 -0
- data/lib/binding_of_caller.rb +77 -17
- data/lib/tester.rb +15 -0
- data/test/test.rb +85 -6
- metadata +47 -45
- data/ext/binding_of_caller/compat.h +0 -57
data/.gemtest
ADDED
|
File without changes
|
data/.gitignore
ADDED
data/.yardopts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
--markup markdown
|
data/LICENSE
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
License
|
|
2
|
+
-------
|
|
3
|
+
|
|
4
|
+
(The MIT License)
|
|
5
|
+
|
|
6
|
+
Copyright (c) 2011 John Mair (banisterfiend)
|
|
7
|
+
|
|
8
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
9
|
+
a copy of this software and associated documentation files (the
|
|
10
|
+
'Software'), to deal in the Software without restriction, including
|
|
11
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
12
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
13
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
14
|
+
the following conditions:
|
|
15
|
+
|
|
16
|
+
The above copyright notice and this permission notice shall be
|
|
17
|
+
included in all copies or substantial portions of the Software.
|
|
18
|
+
|
|
19
|
+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
20
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
21
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
22
|
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
23
|
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
24
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
25
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
CHANGED
|
@@ -3,25 +3,55 @@ binding_of_caller
|
|
|
3
3
|
|
|
4
4
|
(C) John Mair (banisterfiend) 2011
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
_Retrieve the binding of a method's caller in MRI 1.9.2_
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
The `binding_of_caller` gem provides the `Binding#of_caller` method.
|
|
9
|
+
|
|
10
|
+
Using `binding_of_caller` we can grab bindings from higher up the call
|
|
11
|
+
stack and evaluate code in that context. Allows access to bindings arbitrarily far up the
|
|
12
|
+
call stack, not limited to just the immediate caller.
|
|
13
|
+
|
|
14
|
+
**Recommended for use only in debugging situations. Do not use this in production apps.**
|
|
15
|
+
|
|
16
|
+
**Only works in MRI Ruby 1.9.2 and 1.9.3**
|
|
9
17
|
|
|
10
18
|
* Install the [gem](https://rubygems.org/gems/binding_of_caller): `gem install binding_of_caller`
|
|
11
|
-
* Read the [documentation](http://rdoc.info/github/banister/binding_of_caller/master/file/README.markdown)
|
|
12
19
|
* See the [source code](http://github.com/banister/binding_of_caller)
|
|
13
20
|
|
|
14
|
-
Example:
|
|
21
|
+
Example: Modifying a local inside the caller of a caller
|
|
15
22
|
--------
|
|
16
23
|
|
|
17
|
-
|
|
24
|
+
```ruby
|
|
25
|
+
def a
|
|
26
|
+
var = 10
|
|
27
|
+
b
|
|
28
|
+
puts var
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
def b
|
|
32
|
+
c
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def c
|
|
36
|
+
binding.of_caller(2).eval('var = :hello')
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
a()
|
|
40
|
+
|
|
41
|
+
# OUTPUT
|
|
42
|
+
# => hello
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Spinoff project
|
|
46
|
+
-------
|
|
18
47
|
|
|
19
|
-
|
|
48
|
+
This project is a spinoff from the [Pry REPL project.](http://pry.github.com)
|
|
20
49
|
|
|
21
50
|
Features and limitations
|
|
22
51
|
-------------------------
|
|
23
52
|
|
|
24
|
-
|
|
53
|
+
* Only works with MRI 1.9.2 and 1.9.3
|
|
54
|
+
* Does not work in 1.8.7, but there is a well known (continuation-based) hack to get a `Binding#of_caller` there.
|
|
25
55
|
|
|
26
56
|
Contact
|
|
27
57
|
-------
|
|
@@ -32,7 +62,7 @@ Problems or questions contact me at [github](http://github.com/banister)
|
|
|
32
62
|
License
|
|
33
63
|
-------
|
|
34
64
|
|
|
35
|
-
(The MIT License)
|
|
65
|
+
(The MIT License)
|
|
36
66
|
|
|
37
67
|
Copyright (c) 2011 (John Mair)
|
|
38
68
|
|
data/Rakefile
CHANGED
|
@@ -1,97 +1,110 @@
|
|
|
1
1
|
dlext = Config::CONFIG['DLEXT']
|
|
2
2
|
direc = File.dirname(__FILE__)
|
|
3
3
|
|
|
4
|
+
$:.unshift 'lib'
|
|
5
|
+
|
|
4
6
|
PROJECT_NAME = "binding_of_caller"
|
|
5
7
|
|
|
6
8
|
require 'rake/clean'
|
|
7
|
-
require '
|
|
8
|
-
|
|
9
|
+
require 'rubygems/package_task'
|
|
10
|
+
|
|
11
|
+
require "#{PROJECT_NAME}/version"
|
|
9
12
|
|
|
10
13
|
CLOBBER.include("**/*.#{dlext}", "**/*~", "**/*#*", "**/*.log", "**/*.o")
|
|
11
14
|
CLEAN.include("ext/**/*.#{dlext}", "ext/**/*.log", "ext/**/*.o",
|
|
12
15
|
"ext/**/*~", "ext/**/*#*", "ext/**/*.obj", "**/*#*", "**/*#*.*",
|
|
13
|
-
"ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake")
|
|
16
|
+
"ext/**/*.def", "ext/**/*.pdb", "**/*_flymake*.*", "**/*_flymake", "**/*.rbc")
|
|
14
17
|
|
|
15
18
|
def apply_spec_defaults(s)
|
|
16
19
|
s.name = PROJECT_NAME
|
|
17
|
-
s.summary = "
|
|
20
|
+
s.summary = "Retrieve the binding of a method's caller. Can also retrieve bindings even further up the stack. Currently only works for MRI 1.9.2+"
|
|
18
21
|
s.version = BindingOfCaller::VERSION
|
|
19
22
|
s.date = Time.now.strftime '%Y-%m-%d'
|
|
20
23
|
s.author = "John Mair (banisterfiend)"
|
|
21
24
|
s.email = 'jrmair@gmail.com'
|
|
22
25
|
s.description = s.summary
|
|
23
26
|
s.require_path = 'lib'
|
|
24
|
-
s.add_development_dependency("bacon","
|
|
25
|
-
s.homepage = "http://
|
|
27
|
+
s.add_development_dependency("bacon","~>1.1")
|
|
28
|
+
s.homepage = "http://github.com/banister/binding_of_caller"
|
|
26
29
|
s.has_rdoc = 'yard'
|
|
27
|
-
s.files =
|
|
28
|
-
|
|
30
|
+
s.files = `git ls-files`.split("\n")
|
|
31
|
+
s.test_files = `git ls-files -- test/*`.split("\n")
|
|
29
32
|
end
|
|
30
33
|
|
|
31
|
-
desc "
|
|
34
|
+
desc "Run tests"
|
|
32
35
|
task :test do
|
|
33
|
-
sh "bacon -
|
|
36
|
+
sh "bacon -Itest -rubygems test.rb -q"
|
|
34
37
|
end
|
|
35
38
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
apply_spec_defaults(s)
|
|
40
|
-
s.platform = "i386-#{v}"
|
|
41
|
-
s.files += FileList["lib/**/*.#{dlext}"].to_a
|
|
42
|
-
end
|
|
43
|
-
|
|
44
|
-
Rake::GemPackageTask.new(spec) do |pkg|
|
|
45
|
-
pkg.need_zip = false
|
|
46
|
-
pkg.need_tar = false
|
|
47
|
-
end
|
|
48
|
-
end
|
|
39
|
+
task :pry do
|
|
40
|
+
puts "loading binding_of_caller into pry"
|
|
41
|
+
sh "pry -r ./lib/binding_of_caller"
|
|
49
42
|
end
|
|
50
43
|
|
|
44
|
+
desc "generate gemspec"
|
|
45
|
+
task :gemspec => "ruby:gemspec"
|
|
46
|
+
|
|
51
47
|
namespace :ruby do
|
|
52
48
|
spec = Gem::Specification.new do |s|
|
|
53
|
-
apply_spec_defaults(s)
|
|
49
|
+
apply_spec_defaults(s)
|
|
54
50
|
s.platform = Gem::Platform::RUBY
|
|
55
51
|
s.extensions = ["ext/#{PROJECT_NAME}/extconf.rb"]
|
|
56
52
|
end
|
|
57
|
-
|
|
58
|
-
|
|
53
|
+
|
|
54
|
+
Gem::PackageTask.new(spec) do |pkg|
|
|
59
55
|
pkg.need_zip = false
|
|
60
56
|
pkg.need_tar = false
|
|
61
57
|
end
|
|
58
|
+
|
|
59
|
+
desc "Generate gemspec file"
|
|
60
|
+
task :gemspec do
|
|
61
|
+
File.open("#{spec.name}.gemspec", "w") do |f|
|
|
62
|
+
f << spec.to_ruby
|
|
63
|
+
end
|
|
64
|
+
end
|
|
62
65
|
end
|
|
63
66
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
task :compile => directories do
|
|
69
|
-
build_for = proc do |pik_ver, ver|
|
|
70
|
-
sh %{ \
|
|
71
|
-
c:\\devkit\\devkitvars.bat && \
|
|
72
|
-
pik #{pik_ver} && \
|
|
73
|
-
ruby extconf.rb && \
|
|
74
|
-
make clean && \
|
|
75
|
-
make && \
|
|
76
|
-
cp *.so #{direc}/lib/#{ver} \
|
|
77
|
-
}
|
|
67
|
+
namespace :rbx do
|
|
68
|
+
spec = Gem::Specification.new do |s|
|
|
69
|
+
apply_spec_defaults(s)
|
|
70
|
+
s.platform = Gem::Platform.new(["universal", "rubinius"])
|
|
78
71
|
end
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
72
|
+
|
|
73
|
+
Gem::PackageTask.new(spec) do |pkg|
|
|
74
|
+
pkg.need_zip = false
|
|
75
|
+
pkg.need_tar = false
|
|
83
76
|
end
|
|
84
77
|
end
|
|
85
78
|
|
|
79
|
+
desc "build the binaries"
|
|
80
|
+
task :compile do
|
|
81
|
+
chdir "./ext/#{PROJECT_NAME}/" do
|
|
82
|
+
sh "ruby extconf.rb"
|
|
83
|
+
sh "make clean"
|
|
84
|
+
sh "make"
|
|
85
|
+
sh "cp *.#{dlext} ../../lib/"
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
desc "reinstall gem"
|
|
90
|
+
task :reinstall => :gems do
|
|
91
|
+
sh "gem uninstall binding_of_caller" rescue nil
|
|
92
|
+
sh "gem install #{direc}/pkg/#{PROJECT_NAME}-#{BindingOfCaller::VERSION}.gem"
|
|
93
|
+
end
|
|
94
|
+
|
|
86
95
|
desc "build all platform gems at once"
|
|
87
|
-
task :gems => [:clean, :rmgems, "
|
|
96
|
+
task :gems => [:clean, :rmgems, "ruby:gem", "rbx:gem"]
|
|
97
|
+
|
|
98
|
+
task :gem => [:gems]
|
|
99
|
+
|
|
100
|
+
task :rbxgem => "rbx:gem"
|
|
88
101
|
|
|
89
102
|
desc "remove all platform gems"
|
|
90
103
|
task :rmgems => ["ruby:clobber_package"]
|
|
91
104
|
|
|
92
105
|
desc "build and push latest gems"
|
|
93
106
|
task :pushgems => :gems do
|
|
94
|
-
chdir("
|
|
107
|
+
chdir("./pkg") do
|
|
95
108
|
Dir["*.gem"].each do |gemfile|
|
|
96
109
|
sh "gem push #{gemfile}"
|
|
97
110
|
end
|
data/examples/example.rb
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
unless Object.const_defined? :BindingOfCaller
|
|
2
|
+
$:.unshift File.expand_path '../../lib', __FILE__
|
|
3
|
+
require 'binding_of_caller'
|
|
4
|
+
require 'binding_of_caller/version'
|
|
5
|
+
end
|
|
6
|
+
|
|
7
|
+
outer = 10
|
|
8
|
+
|
|
9
|
+
class Z
|
|
10
|
+
def z
|
|
11
|
+
u = 10
|
|
12
|
+
A.new.a
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
class A
|
|
17
|
+
def a
|
|
18
|
+
y = 10
|
|
19
|
+
B.new.b
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
class B
|
|
24
|
+
def b
|
|
25
|
+
x = 10
|
|
26
|
+
puts binding.of_caller(0).eval('local_variables')
|
|
27
|
+
puts binding.of_caller(1).eval('local_variables')
|
|
28
|
+
puts binding.of_caller(2).eval('local_variables')
|
|
29
|
+
puts binding.of_caller(3).eval('local_variables')
|
|
30
|
+
puts binding.of_caller(400).eval('local_variables')
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
Z.new.z
|
|
35
|
+
|
|
36
|
+
# output:
|
|
37
|
+
# => x
|
|
38
|
+
# => y
|
|
39
|
+
# => u
|
|
40
|
+
# => outer
|
|
41
|
+
# Exception
|
|
@@ -1,22 +1,31 @@
|
|
|
1
1
|
/* (c) 2011 John Mair (banisterfiend), MIT license */
|
|
2
2
|
|
|
3
3
|
#include <ruby.h>
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
4
|
+
#include "vm_core.h"
|
|
5
|
+
#include "gc.h"
|
|
6
|
+
|
|
7
|
+
typedef enum { false, true } bool;
|
|
8
|
+
|
|
9
|
+
static VALUE
|
|
10
|
+
string2sym(const char * string)
|
|
11
|
+
{
|
|
12
|
+
return ID2SYM(rb_intern(string));
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
static inline const rb_data_type_t *
|
|
16
|
+
threadptr_data_type(void)
|
|
17
|
+
{
|
|
18
|
+
static const rb_data_type_t *thread_data_type;
|
|
19
|
+
if (!thread_data_type) {
|
|
20
|
+
VALUE current_thread = rb_thread_current();
|
|
21
|
+
thread_data_type = RTYPEDDATA_TYPE(current_thread);
|
|
22
|
+
}
|
|
23
|
+
return thread_data_type;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
#define ruby_thread_data_type *threadptr_data_type()
|
|
27
|
+
|
|
28
|
+
#define ruby_current_thread ((rb_thread_t *)RTYPEDDATA_DATA(rb_thread_current()))
|
|
20
29
|
|
|
21
30
|
static size_t
|
|
22
31
|
binding_memsize(const void *ptr)
|
|
@@ -44,7 +53,11 @@ binding_mark(void *ptr)
|
|
|
44
53
|
if (ptr) {
|
|
45
54
|
bind = ptr;
|
|
46
55
|
RUBY_MARK_UNLESS_NULL(bind->env);
|
|
56
|
+
|
|
57
|
+
#ifdef RUBY_192
|
|
47
58
|
RUBY_MARK_UNLESS_NULL(bind->filename);
|
|
59
|
+
#endif
|
|
60
|
+
|
|
48
61
|
}
|
|
49
62
|
RUBY_MARK_LEAVE("binding");
|
|
50
63
|
}
|
|
@@ -65,60 +78,143 @@ binding_alloc(VALUE klass)
|
|
|
65
78
|
return obj;
|
|
66
79
|
}
|
|
67
80
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
static bool valid_frame_p(rb_control_frame_t * cfp) {
|
|
81
|
+
static bool valid_frame_p(rb_control_frame_t * cfp, rb_control_frame_t * limit_cfp) {
|
|
71
82
|
return cfp->iseq && !NIL_P(cfp->self);
|
|
72
83
|
}
|
|
73
84
|
|
|
74
|
-
static rb_control_frame_t * find_valid_frame(rb_control_frame_t * cfp) {
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
while (error_count <= 4) {
|
|
85
|
+
static rb_control_frame_t * find_valid_frame(rb_control_frame_t * cfp, rb_control_frame_t * limit_cfp) {
|
|
86
|
+
while (cfp < limit_cfp) {
|
|
78
87
|
cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
|
|
79
88
|
|
|
80
|
-
if (
|
|
89
|
+
if (cfp >= limit_cfp)
|
|
90
|
+
return NULL;
|
|
91
|
+
|
|
92
|
+
if (valid_frame_p(cfp, limit_cfp))
|
|
81
93
|
return cfp;
|
|
82
|
-
else
|
|
83
|
-
error_count += 1;
|
|
84
94
|
}
|
|
85
95
|
|
|
86
|
-
|
|
96
|
+
// beyond end of stack
|
|
97
|
+
return NULL;
|
|
98
|
+
}
|
|
87
99
|
|
|
88
|
-
|
|
89
|
-
|
|
100
|
+
static VALUE
|
|
101
|
+
frametype_name(VALUE flag)
|
|
102
|
+
{
|
|
103
|
+
switch (flag & VM_FRAME_MAGIC_MASK) {
|
|
104
|
+
case VM_FRAME_MAGIC_METHOD: return string2sym("method");
|
|
105
|
+
case VM_FRAME_MAGIC_BLOCK: return string2sym("block");
|
|
106
|
+
case VM_FRAME_MAGIC_CLASS: return string2sym("class");
|
|
107
|
+
case VM_FRAME_MAGIC_TOP: return string2sym("top");
|
|
108
|
+
case VM_FRAME_MAGIC_FINISH: return string2sym("finish");
|
|
109
|
+
case VM_FRAME_MAGIC_CFUNC: return string2sym("cfunc");
|
|
110
|
+
case VM_FRAME_MAGIC_PROC: return string2sym("proc");
|
|
111
|
+
case VM_FRAME_MAGIC_IFUNC: return string2sym("ifunc");
|
|
112
|
+
case VM_FRAME_MAGIC_EVAL: return string2sym("eval");
|
|
113
|
+
case VM_FRAME_MAGIC_LAMBDA: return string2sym("lambda");
|
|
114
|
+
default:
|
|
115
|
+
rb_raise(rb_eRuntimeError, "Unknown frame type! got flag: %d", FIX2INT(flag));
|
|
116
|
+
}
|
|
90
117
|
}
|
|
91
118
|
|
|
92
119
|
static VALUE binding_of_caller(VALUE self, VALUE rb_level)
|
|
93
120
|
{
|
|
94
|
-
rb_thread_t *th
|
|
121
|
+
rb_thread_t *th;
|
|
122
|
+
GetThreadPtr(rb_thread_current(), th);
|
|
123
|
+
|
|
95
124
|
rb_control_frame_t *cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(th->cfp);
|
|
125
|
+
rb_control_frame_t *limit_cfp = (void *)(th->stack + th->stack_size);
|
|
96
126
|
int level = FIX2INT(rb_level);
|
|
97
127
|
|
|
98
|
-
|
|
128
|
+
// attempt to locate the nth parent control frame
|
|
129
|
+
for (int i = 0; i < level; i++) {
|
|
99
130
|
cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
|
|
100
131
|
|
|
101
|
-
|
|
102
|
-
|
|
132
|
+
if (cfp >= limit_cfp)
|
|
133
|
+
rb_raise(rb_eRuntimeError, "Invalid frame, gone beyond end of stack!");
|
|
134
|
+
|
|
135
|
+
// skip invalid frames
|
|
136
|
+
if (!valid_frame_p(cfp, limit_cfp))
|
|
137
|
+
cfp = find_valid_frame(cfp, limit_cfp);
|
|
138
|
+
}
|
|
103
139
|
|
|
104
140
|
VALUE bindval = binding_alloc(rb_cBinding);
|
|
105
141
|
rb_binding_t *bind;
|
|
106
142
|
|
|
107
|
-
if (cfp == 0)
|
|
143
|
+
if (cfp == 0)
|
|
108
144
|
rb_raise(rb_eRuntimeError, "Can't create Binding Object on top of Fiber.");
|
|
109
|
-
}
|
|
110
145
|
|
|
111
146
|
GetBindingPtr(bindval, bind);
|
|
112
147
|
bind->env = rb_vm_make_env_object(th, cfp);
|
|
113
148
|
bind->filename = cfp->iseq->filename;
|
|
114
149
|
bind->line_no = rb_vm_get_sourceline(cfp);
|
|
150
|
+
|
|
151
|
+
rb_iv_set(bindval, "@frame_type", frametype_name(cfp->flag));
|
|
152
|
+
rb_iv_set(bindval, "@frame_description", cfp->iseq->name);
|
|
153
|
+
|
|
115
154
|
return bindval;
|
|
116
155
|
}
|
|
117
156
|
|
|
157
|
+
static VALUE
|
|
158
|
+
frame_type(VALUE self)
|
|
159
|
+
{
|
|
160
|
+
return rb_iv_get(self, "@frame_type");
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
static VALUE
|
|
164
|
+
frame_description(VALUE self)
|
|
165
|
+
{
|
|
166
|
+
return rb_iv_get(self, "@frame_description");
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
static VALUE frame_count(VALUE self)
|
|
170
|
+
{
|
|
171
|
+
rb_thread_t *th;
|
|
172
|
+
GetThreadPtr(rb_thread_current(), th);
|
|
173
|
+
|
|
174
|
+
rb_control_frame_t *cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(th->cfp);
|
|
175
|
+
rb_control_frame_t *limit_cfp = (void *)(th->stack + th->stack_size);
|
|
176
|
+
|
|
177
|
+
int i = 1;
|
|
178
|
+
while (cfp < limit_cfp) {
|
|
179
|
+
cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
|
|
180
|
+
|
|
181
|
+
if (cfp >= limit_cfp)
|
|
182
|
+
return INT2FIX(i);
|
|
183
|
+
|
|
184
|
+
// skip invalid frames
|
|
185
|
+
if (!valid_frame_p(cfp, limit_cfp))
|
|
186
|
+
cfp = find_valid_frame(cfp, limit_cfp);
|
|
187
|
+
|
|
188
|
+
if (!cfp)
|
|
189
|
+
break;
|
|
190
|
+
|
|
191
|
+
i++;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
return INT2FIX(i);
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
static VALUE
|
|
198
|
+
callers(VALUE self)
|
|
199
|
+
{
|
|
200
|
+
VALUE ary = rb_ary_new();
|
|
201
|
+
|
|
202
|
+
for (int i = 0; i < FIX2INT(frame_count(self)); i++)
|
|
203
|
+
rb_ary_push(ary, binding_of_caller(self, INT2FIX(i)));
|
|
204
|
+
|
|
205
|
+
return ary;
|
|
206
|
+
}
|
|
207
|
+
|
|
118
208
|
void
|
|
119
209
|
Init_binding_of_caller()
|
|
120
210
|
{
|
|
121
|
-
|
|
122
|
-
|
|
211
|
+
VALUE mBindingOfCaller = rb_define_module("BindingOfCaller");
|
|
212
|
+
|
|
213
|
+
rb_define_method(mBindingOfCaller, "of_caller", binding_of_caller, 1);
|
|
214
|
+
rb_define_method(mBindingOfCaller, "frame_count", frame_count, 0);
|
|
215
|
+
rb_define_method(mBindingOfCaller, "frame_type", frame_type, 0);
|
|
216
|
+
rb_define_method(mBindingOfCaller, "frame_description", frame_description, 0);
|
|
217
|
+
rb_define_method(mBindingOfCaller, "callers", callers, 0);
|
|
218
|
+
rb_include_module(rb_cBinding, mBindingOfCaller);
|
|
123
219
|
}
|
|
124
220
|
|
|
@@ -5,10 +5,9 @@ $CFLAGS += " -std=c99"
|
|
|
5
5
|
|
|
6
6
|
case RUBY_VERSION
|
|
7
7
|
when /1.9.2/
|
|
8
|
-
$CFLAGS += " -I./ruby_headers/192/"
|
|
8
|
+
$CFLAGS += " -I./ruby_headers/192/ -DRUBY_192"
|
|
9
9
|
when /1.9.3/
|
|
10
|
-
|
|
11
|
-
$CFLAGS += " -I./ruby_headers/193/"
|
|
10
|
+
$CFLAGS += " -I./ruby_headers/193/ -DRUBY_193"
|
|
12
11
|
end
|
|
13
12
|
|
|
14
13
|
create_makefile('binding_of_caller')
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
module BindingOfCaller
|
|
2
|
-
VERSION = "0.
|
|
3
|
-
end
|
|
2
|
+
VERSION = "0.6.3"
|
|
3
|
+
end
|
|
Binary file
|
data/lib/binding_of_caller.rb
CHANGED
|
@@ -1,22 +1,82 @@
|
|
|
1
|
-
|
|
2
|
-
# (C) John Mair (banisterfiend); MIT license
|
|
1
|
+
dlext = Config::CONFIG['DLEXT']
|
|
3
2
|
|
|
4
|
-
|
|
3
|
+
if RUBY_ENGINE && RUBY_ENGINE == "ruby"
|
|
4
|
+
require "binding_of_caller.#{dlext}"
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
elsif defined?(Rubinius)
|
|
7
|
+
module BindingOfCaller
|
|
8
|
+
module BindingExtensions
|
|
7
9
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
10
|
+
def of_caller(n)
|
|
11
|
+
bt = Rubinius::VM.backtrace(1 + n, true).first
|
|
12
|
+
|
|
13
|
+
b = Binding.setup(
|
|
14
|
+
bt.variables,
|
|
15
|
+
bt.variables.method,
|
|
16
|
+
bt.static_scope,
|
|
17
|
+
bt.variables.self,
|
|
18
|
+
bt
|
|
19
|
+
)
|
|
20
|
+
|
|
21
|
+
b.instance_variable_set(:@frame_description, bt.describe)
|
|
22
|
+
|
|
23
|
+
b
|
|
24
|
+
rescue
|
|
25
|
+
raise RuntimeError, "Invalid frame, gone beyond end of stack!"
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
def frame_description
|
|
29
|
+
@frame_description
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
def callers
|
|
33
|
+
ary = []
|
|
34
|
+
n = 0
|
|
35
|
+
loop {
|
|
36
|
+
begin
|
|
37
|
+
ary << Binding.of_caller(n)
|
|
38
|
+
rescue
|
|
39
|
+
break
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
n += 1
|
|
43
|
+
}
|
|
19
44
|
|
|
20
|
-
|
|
21
|
-
end
|
|
45
|
+
ary
|
|
46
|
+
end
|
|
22
47
|
|
|
48
|
+
def frame_count
|
|
49
|
+
ary = []
|
|
50
|
+
n = 1
|
|
51
|
+
loop {
|
|
52
|
+
begin
|
|
53
|
+
Binding.of_caller(n)
|
|
54
|
+
rescue
|
|
55
|
+
break
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
n += 1
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
n
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
def frame_type
|
|
65
|
+
case self.variables.method.metadata.to_a.first.to_s
|
|
66
|
+
when /block/
|
|
67
|
+
:block
|
|
68
|
+
when /eval/
|
|
69
|
+
:eval
|
|
70
|
+
else
|
|
71
|
+
:method
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
end
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
class ::Binding
|
|
79
|
+
include BindingOfCaller::BindingExtensions
|
|
80
|
+
extend BindingOfCaller::BindingExtensions
|
|
81
|
+
end
|
|
82
|
+
end
|
data/lib/tester.rb
ADDED
data/test/test.rb
CHANGED
|
@@ -1,12 +1,91 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
require '
|
|
4
|
-
require
|
|
5
|
-
|
|
1
|
+
unless Object.const_defined? :BindingOfCaller
|
|
2
|
+
$:.unshift File.expand_path '../../lib', __FILE__
|
|
3
|
+
require 'binding_of_caller'
|
|
4
|
+
require 'binding_of_caller/version'
|
|
5
|
+
end
|
|
6
6
|
|
|
7
|
-
puts "Testing binding_of_caller version #{BindingOfCaller::VERSION}..."
|
|
7
|
+
puts "Testing binding_of_caller version #{BindingOfCaller::VERSION}..."
|
|
8
8
|
puts "Ruby version: #{RUBY_VERSION}"
|
|
9
9
|
|
|
10
10
|
describe BindingOfCaller do
|
|
11
|
+
describe "of_caller" do
|
|
12
|
+
it "should fetch immediate caller's binding when 0 is passed" do
|
|
13
|
+
o = Object.new
|
|
14
|
+
def o.a
|
|
15
|
+
var = 1
|
|
16
|
+
binding.of_caller(0).eval('var')
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
o. a.should == 1
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
it "should fetch parent of caller's binding when 1 is passed" do
|
|
23
|
+
o = Object.new
|
|
24
|
+
def o.a
|
|
25
|
+
var = 1
|
|
26
|
+
b
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
def o.b
|
|
30
|
+
binding.of_caller(1).eval('var')
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
o.a.should == 1
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
it "should modify locals in parent of caller's binding" do
|
|
37
|
+
o = Object.new
|
|
38
|
+
def o.a
|
|
39
|
+
var = 1
|
|
40
|
+
b
|
|
41
|
+
var
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def o.b
|
|
45
|
+
binding.of_caller(1).eval('var = 20')
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
o.a.should == 20
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
it "should raise an exception when retrieving an out of band binding" do
|
|
52
|
+
o = Object.new
|
|
53
|
+
def o.a
|
|
54
|
+
binding.of_caller(100)
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
lambda { o.a }.should.raise RuntimeError
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
describe "frame_count" do
|
|
62
|
+
it 'frame_count should equal callers.count' do
|
|
63
|
+
binding.frame_count.should == binding.callers.count
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
describe "frame_type" do
|
|
68
|
+
it 'should return the correct frame types' do
|
|
69
|
+
o = Object.new
|
|
70
|
+
|
|
71
|
+
# method frame
|
|
72
|
+
def o.a
|
|
73
|
+
b
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
# method frame
|
|
77
|
+
def o.b
|
|
78
|
+
# block frame
|
|
79
|
+
proc do
|
|
80
|
+
binding.callers
|
|
81
|
+
end.call
|
|
82
|
+
end
|
|
83
|
+
caller_bindings = o.a
|
|
84
|
+
caller_bindings[0].frame_type.should == :block
|
|
85
|
+
caller_bindings[1].frame_type.should == :method
|
|
86
|
+
caller_bindings[2].frame_type.should == :method
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
end
|
|
11
90
|
end
|
|
12
91
|
|
metadata
CHANGED
|
@@ -1,39 +1,45 @@
|
|
|
1
|
-
--- !ruby/object:Gem::Specification
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: binding_of_caller
|
|
3
|
-
version: !ruby/object:Gem::Version
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.6.3
|
|
4
5
|
prerelease:
|
|
5
|
-
version: 0.2.0
|
|
6
6
|
platform: ruby
|
|
7
|
-
authors:
|
|
7
|
+
authors:
|
|
8
8
|
- John Mair (banisterfiend)
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
- !ruby/object:Gem::Dependency
|
|
12
|
+
date: 2012-02-29 00:00:00.000000000 Z
|
|
13
|
+
dependencies:
|
|
14
|
+
- !ruby/object:Gem::Dependency
|
|
16
15
|
name: bacon
|
|
17
|
-
|
|
18
|
-
requirement: &id001 !ruby/object:Gem::Requirement
|
|
16
|
+
requirement: &70210333909540 !ruby/object:Gem::Requirement
|
|
19
17
|
none: false
|
|
20
|
-
requirements:
|
|
21
|
-
- -
|
|
22
|
-
- !ruby/object:Gem::Version
|
|
23
|
-
version: 1.1
|
|
18
|
+
requirements:
|
|
19
|
+
- - ~>
|
|
20
|
+
- !ruby/object:Gem::Version
|
|
21
|
+
version: '1.1'
|
|
24
22
|
type: :development
|
|
25
|
-
|
|
26
|
-
|
|
23
|
+
prerelease: false
|
|
24
|
+
version_requirements: *70210333909540
|
|
25
|
+
description: Retrieve the binding of a method's caller. Can also retrieve bindings
|
|
26
|
+
even further up the stack. Currently only works for MRI 1.9.2+
|
|
27
27
|
email: jrmair@gmail.com
|
|
28
28
|
executables: []
|
|
29
|
-
|
|
30
|
-
extensions:
|
|
29
|
+
extensions:
|
|
31
30
|
- ext/binding_of_caller/extconf.rb
|
|
32
31
|
extra_rdoc_files: []
|
|
33
|
-
|
|
34
|
-
|
|
32
|
+
files:
|
|
33
|
+
- .gemtest
|
|
34
|
+
- .gitignore
|
|
35
|
+
- .yardopts
|
|
36
|
+
- HISTORY
|
|
37
|
+
- LICENSE
|
|
38
|
+
- README.md
|
|
39
|
+
- Rakefile
|
|
40
|
+
- examples/example.rb
|
|
41
|
+
- ext/binding_of_caller/binding_of_caller.c
|
|
35
42
|
- ext/binding_of_caller/extconf.rb
|
|
36
|
-
- ext/binding_of_caller/compat.h
|
|
37
43
|
- ext/binding_of_caller/ruby_headers/192/debug.h
|
|
38
44
|
- ext/binding_of_caller/ruby_headers/192/dln.h
|
|
39
45
|
- ext/binding_of_caller/ruby_headers/192/eval_intern.h
|
|
@@ -82,39 +88,35 @@ files:
|
|
|
82
88
|
- ext/binding_of_caller/ruby_headers/193/vm_exec.h
|
|
83
89
|
- ext/binding_of_caller/ruby_headers/193/vm_insnhelper.h
|
|
84
90
|
- ext/binding_of_caller/ruby_headers/193/vm_opts.h
|
|
85
|
-
-
|
|
86
|
-
- lib/binding_of_caller/version.rb
|
|
91
|
+
- lib/binding_of_caller.bundle
|
|
87
92
|
- lib/binding_of_caller.rb
|
|
93
|
+
- lib/binding_of_caller/version.rb
|
|
94
|
+
- lib/tester.rb
|
|
88
95
|
- test/test.rb
|
|
89
|
-
|
|
90
|
-
- README.md
|
|
91
|
-
- Rakefile
|
|
92
|
-
homepage: http://banisterfiend.wordpress.com
|
|
96
|
+
homepage: http://github.com/banister/binding_of_caller
|
|
93
97
|
licenses: []
|
|
94
|
-
|
|
95
98
|
post_install_message:
|
|
96
99
|
rdoc_options: []
|
|
97
|
-
|
|
98
|
-
require_paths:
|
|
100
|
+
require_paths:
|
|
99
101
|
- lib
|
|
100
|
-
required_ruby_version: !ruby/object:Gem::Requirement
|
|
102
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
101
103
|
none: false
|
|
102
|
-
requirements:
|
|
103
|
-
- -
|
|
104
|
-
- !ruby/object:Gem::Version
|
|
105
|
-
version:
|
|
106
|
-
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
104
|
+
requirements:
|
|
105
|
+
- - ! '>='
|
|
106
|
+
- !ruby/object:Gem::Version
|
|
107
|
+
version: '0'
|
|
108
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
107
109
|
none: false
|
|
108
|
-
requirements:
|
|
109
|
-
- -
|
|
110
|
-
- !ruby/object:Gem::Version
|
|
111
|
-
version:
|
|
110
|
+
requirements:
|
|
111
|
+
- - ! '>='
|
|
112
|
+
- !ruby/object:Gem::Version
|
|
113
|
+
version: '0'
|
|
112
114
|
requirements: []
|
|
113
|
-
|
|
114
115
|
rubyforge_project:
|
|
115
|
-
rubygems_version: 1.8.
|
|
116
|
+
rubygems_version: 1.8.16
|
|
116
117
|
signing_key:
|
|
117
118
|
specification_version: 3
|
|
118
|
-
summary:
|
|
119
|
-
|
|
120
|
-
|
|
119
|
+
summary: Retrieve the binding of a method's caller. Can also retrieve bindings even
|
|
120
|
+
further up the stack. Currently only works for MRI 1.9.2+
|
|
121
|
+
test_files:
|
|
122
|
+
- test/test.rb
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
/* contains basic macros to facilitate ruby 1.8 and ruby 1.9 compatibility */
|
|
2
|
-
|
|
3
|
-
#ifndef GUARD_COMPAT_H
|
|
4
|
-
#define GUARD_COMPAT_H
|
|
5
|
-
|
|
6
|
-
#include <ruby.h>
|
|
7
|
-
|
|
8
|
-
/* test for 1.9 */
|
|
9
|
-
#if !defined(RUBY_19) && defined(ROBJECT_EMBED_LEN_MAX)
|
|
10
|
-
# define RUBY_19
|
|
11
|
-
#endif
|
|
12
|
-
|
|
13
|
-
/* macros for backwards compatibility with 1.8 */
|
|
14
|
-
#ifndef RUBY_19
|
|
15
|
-
# define RCLASS_M_TBL(c) (RCLASS(c)->m_tbl)
|
|
16
|
-
# define RCLASS_SUPER(c) (RCLASS(c)->super)
|
|
17
|
-
# define RCLASS_IV_TBL(c) (RCLASS(c)->iv_tbl)
|
|
18
|
-
# define OBJ_UNTRUSTED OBJ_TAINTED
|
|
19
|
-
# include "st.h"
|
|
20
|
-
#endif
|
|
21
|
-
|
|
22
|
-
#ifdef RUBY_19
|
|
23
|
-
inline static VALUE
|
|
24
|
-
class_alloc(VALUE flags, VALUE klass)
|
|
25
|
-
{
|
|
26
|
-
rb_classext_t *ext = ALLOC(rb_classext_t);
|
|
27
|
-
NEWOBJ(obj, struct RClass);
|
|
28
|
-
OBJSETUP(obj, klass, flags);
|
|
29
|
-
obj->ptr = ext;
|
|
30
|
-
RCLASS_IV_TBL(obj) = 0;
|
|
31
|
-
RCLASS_M_TBL(obj) = 0;
|
|
32
|
-
RCLASS_SUPER(obj) = 0;
|
|
33
|
-
RCLASS_IV_INDEX_TBL(obj) = 0;
|
|
34
|
-
return (VALUE)obj;
|
|
35
|
-
}
|
|
36
|
-
#endif
|
|
37
|
-
|
|
38
|
-
inline static VALUE
|
|
39
|
-
create_class(VALUE flags, VALUE klass)
|
|
40
|
-
{
|
|
41
|
-
#ifdef RUBY_19
|
|
42
|
-
VALUE new_klass = class_alloc(flags, klass);
|
|
43
|
-
#else
|
|
44
|
-
NEWOBJ(new_klass, struct RClass);
|
|
45
|
-
OBJSETUP(new_klass, klass, flags);
|
|
46
|
-
#endif
|
|
47
|
-
|
|
48
|
-
return (VALUE)new_klass;
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
# define FALSE 0
|
|
52
|
-
# define TRUE 1
|
|
53
|
-
|
|
54
|
-
/* a useful macro. cannot use ordinary CLASS_OF as it does not return an lvalue */
|
|
55
|
-
#define KLASS_OF(c) (RBASIC(c)->klass)
|
|
56
|
-
|
|
57
|
-
#endif
|