better_caller 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tim Morgan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,69 @@
+= better_caller
+
+Author:: Tim Morgan
+Date:: Dec 23, 2009
+License:: Released under the same terms as Ruby.
+
+== Introduction by example
+
+Actions speak louder than words. Gone are the days of this old suckageness:
+
+ caller #=> ["test.rb:8:in `foo'", "test.rb:16:in `<main>'"]
+
+With better_caller, you get this new hotness:
+
+ require 'better_caller'
+ better_caller #=> [["test.rb", 8, :foo, #<Binding:0x000001010cae50>], ["test.rb", 16, :"<main>", #<Binding:0x000001010caef8>]]
+
+There are a couple of things you may notice. First of all, the okay-that's-nice
+thing: String parsing is a thing of the past. You get the file, line, and method
+as separate elements. This happens <b>at the Ruby interpreter level</b>.
+
+Now, the holy-shit-that's-awesome feature: <b>You get Bindings, all the way up
+the stack.</b> Yes, that's right, you can do this:
+
+  eval "local_variables", better_caller.first.last #=> [ :var1, :var2, :foo ]
+
+You also get this stuff in exception, mondo excellent for debugging:
+
+  $!.better_backtrace # now you can figure out what your local variables were at the time of the exception!
+
+== This is horribly slow, right? You're using some +set_trace_func+ magic that's going to make my Ruby 1,000,000% slower, right?
+
+No. better_caller is a C function that uses the internal Ruby memory structures
+to build its output. Absolutely no +set_trace_func+ and no speed hit.
+
+== Super ominous alpha warning
+
+better_caller is extremely, hyperbolically alpha right now. Here are some known
+obstacles currently preventing it from blowing minds:
+
+* <b>It only works with a very specific version of Ruby (in particular,
+  1.9.1p376).</b> This is because it uses some private Ruby C functions to work
+  its magic, so it keeps a copy of some header files that you're not really
+  supposed to be using.
+* <b>It causes "invalid dfp" crashes sometimes.</b> Every so often, for reasons
+  I _really_ wish I understood, the Ruby interpreter will come down in a ball of
+  fire after regurgitating "invalid dfp" to your console. DFP's and CFP's are
+  still pretty much witch-voodoo to me so I'm having a very hard time debugging
+  this problem.
+
+Despite that, it does work sometimes, and when it does, I think it rocks. If you
+do too, please do me the honor of contributing to this project, _especially_ if
+you're one of the three people on the planet that understand the workings of
+Ruby frame pointers. That would be swell.
+
+=== Additional to-do items
+
+* Comments
+* Specs
+
+== Release History
+
+<b>0.0.1</b> (Dec 23, 2009)
+
+* First public release.
+
+== Copyright
+
+See LICENSE for copyright information.

data/ext/better_caller.c

@@ -0,0 +1,148 @@
+#include "ruby.h"
+#include "vm_core.h"
+
+#define ENV_IN_HEAP_P(th, env)  \
+  (!((th)->stack < (env) && (env) < ((th)->stack + (th)->stack_size)))
+
+static VALUE binding_from_cfp(rb_thread_t *th, rb_control_frame_t *cfp) {
+	if (cfp == 0) return Qnil;
+	
+	VALUE *penvptr = GC_GUARDED_PTR_REF(*(cfp->dfp));
+	rb_control_frame_t *pcfp = VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_FINISH ? RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp) : cfp;
+	if (!ENV_IN_HEAP_P(th, penvptr)) {
+		while (pcfp->dfp != penvptr) {
+			pcfp++;
+			if (pcfp->dfp == 0) return Qnil;
+		}
+	}
+	
+	VALUE bindval = rb_binding_new();
+	rb_binding_t *bind;
+	
+	GetBindingPtr(bindval, bind);
+	bind->env = rb_vm_make_env_object(th, cfp);
+	return bindval;
+}
+
+static VALUE backtrace_each(rb_thread_t *th, const rb_control_frame_t *limit_cfp, const rb_control_frame_t *cfp, const char *file, int line_no, VALUE ary) {
+	VALUE elem, locals;
+	int i;
+
+	while (cfp > limit_cfp) {
+		elem = 0;
+		locals = 0;
+		if (cfp->iseq != 0) {
+			if (cfp->pc != 0) {
+				rb_iseq_t *iseq = cfp->iseq;
+
+				elem = rb_ary_new();
+				rb_ary_push(elem, iseq->filename);
+				rb_ary_push(elem, INT2FIX(rb_vm_get_sourceline(cfp)));
+				rb_ary_push(elem, rb_str_intern(iseq->name));
+				rb_ary_push(elem, binding_from_cfp(th, cfp));
+				rb_ary_push(ary, elem);
+			}
+		}
+		else if (RUBYVM_CFUNC_FRAME_P(cfp)) {
+			elem = rb_ary_new();
+			rb_ary_push(elem, rb_str_new2(file));
+			rb_ary_push(elem, INT2FIX(line_no));
+			rb_ary_push(elem, ID2SYM(cfp->method_id));
+			rb_ary_push(elem, Qnil);
+			rb_ary_push(ary, elem);
+		}
+		cfp = RUBY_VM_NEXT_CONTROL_FRAME(cfp);
+	}
+	return rb_ary_reverse(ary);
+}
+
+static inline VALUE backtrace(rb_thread_t *th, int lev) {
+	VALUE ary;
+	const rb_control_frame_t *cfp = th->cfp;
+	const rb_control_frame_t *top_of_cfp = (void *)(th->stack + th->stack_size);
+	top_of_cfp -= 2;
+
+	if (lev < 0) ary = rb_ary_new();
+	else {
+		while (lev-- >= 0) {
+			cfp++;
+			if (cfp >= top_of_cfp) return Qnil;
+		}
+		ary = rb_ary_new();
+	}
+
+	ary = backtrace_each(th, RUBY_VM_NEXT_CONTROL_FRAME(cfp), top_of_cfp, RSTRING_PTR(th->vm->progname), 0, ary);
+	return ary;
+}
+
+static VALUE better_caller(int argc, VALUE *argv) {
+	VALUE level;
+	int lev;
+
+	rb_scan_args(argc, argv, "01", &level);
+
+	if (NIL_P(level)) lev = 1;
+	else lev = NUM2INT(level);
+	if (lev < 0) rb_raise(rb_eArgError, "negative level (%d)", lev);
+
+	return backtrace(GET_THREAD(), lev);
+}
+
+// static VALUE thread_bindings(VALUE self) {
+// 	VALUE bindings = rb_iv_get(self, "@bindings");
+// 	if (bindings == Qnil) return Qnil;
+// 	return rb_ary_subseq(bindings, 0, RARRAY_LEN(bindings) - 1);
+// }
+// 
+static VALUE exception_better_backtrace(VALUE self) {
+	return rb_iv_get(self, "@better_backtrace");
+}
+// 
+static void process_event(rb_event_flag_t event, VALUE data, VALUE self, ID id, VALUE klass) {
+// 	VALUE thread = rb_thread_current();
+// 	VALUE subarray;
+// 	
+// 	VALUE bindings = rb_iv_get(thread, "@bindings");
+// 	if (bindings == Qnil) {
+// 		bindings = rb_ary_new();
+// 		rb_iv_set(thread, "@bindings", bindings);
+// 	}
+// 	
+ 	switch (event) {
+// 		// case RUBY_EVENT_LINE:
+// 		// 	if (RARRAY_LEN(bindings) == 0) rb_ary_push(bindings, rb_binding_new());
+// 		// 	break;
+// 			
+// 		case RUBY_EVENT_CLASS:
+// 		case RUBY_EVENT_CALL:
+// 		case RUBY_EVENT_C_CALL:
+// 			subarray = rb_ary_new();
+// 			rb_ary_push(subarray, rb_str_new2(rb_sourcefile()));
+// 			rb_ary_push(subarray, id ? ID2SYM(id) : Qnil);
+// 			rb_ary_push(subarray, rb_binding_new());
+// 			rb_ary_push(bindings, subarray);
+// 			break;
+// 		
+// 		case RUBY_EVENT_END:
+// 		case RUBY_EVENT_RETURN:
+// 		case RUBY_EVENT_C_RETURN:
+// 			rb_ary_pop(bindings);
+// 			break;
+// 		
+ 		case RUBY_EVENT_RAISE:
+			rb_iv_set(rb_gv_get("$!"), "@better_backtrace", better_caller(0, 0));
+// 			rb_iv_set(rb_gv_get("$!"), "@bindings", bindings);
+// 			rb_ary_pop(bindings);
+ 			break;
+	}
+}
+
+void Init_better_caller() {
+	rb_define_method(rb_eException, "better_backtrace", exception_better_backtrace, 0);
+	// rb_define_method(rb_cThread, "bindings", thread_bindings, 0);
+	rb_define_global_function("better_caller", better_caller, -1);
+	// int events = RUBY_EVENT_CLASS|RUBY_EVENT_CALL|RUBY_EVENT_C_CALL|RUBY_EVENT_END|RUBY_EVENT_RETURN|RUBY_EVENT_C_RETURN|RUBY_EVENT_RAISE;
+	// rb_add_event_hook(process_event, events, Qnil);
+	// rb_add_event_hook(process_event, RUBY_EVENT_ALL, Qnil);
+	rb_add_event_hook(process_event, RUBY_EVENT_RAISE, Qnil);
+}

data/ext/debug.h

@@ -0,0 +1,36 @@
+/**********************************************************************
+
+  debug.h - YARV Debug function interface
+
+  $Author: ko1 $
+  created at: 04/08/25 02:33:49 JST
+
+  Copyright (C) 2004-2007 Koichi Sasada
+
+**********************************************************************/
+
+#ifndef RUBY_DEBUG_H
+#define RUBY_DEBUG_H
+
+#include "ruby/ruby.h"
+#include "node.h"
+
+#define dpv(h,v) ruby_debug_print_value(-1, 0, h, v)
+#define dp(v)    ruby_debug_print_value(-1, 0, "", v)
+#define dpi(i)   ruby_debug_print_id(-1, 0, "", i)
+#define dpn(n)   ruby_debug_print_node(-1, 0, "", n)
+
+#define bp()     ruby_debug_breakpoint()
+
+VALUE ruby_debug_print_value(int level, int debug_level, const char *header, VALUE v);
+ID    ruby_debug_print_id(int level, int debug_level, const char *header, ID id);
+NODE *ruby_debug_print_node(int level, int debug_level, const char *header, const NODE *node);
+int   ruby_debug_print_indent(int level, int debug_level, int indent_level);
+void  ruby_debug_breakpoint(void);
+void  ruby_debug_gc_check_func(void);
+
+#ifdef RUBY_DEBUG_ENV
+void ruby_set_debug_option(const char *str);
+#endif
+
+#endif /* RUBY_DEBUG_H */

data/ext/dln.h

@@ -0,0 +1,41 @@
+/**********************************************************************
+
+  dln.h -
+
+  $Author: nobu $
+  created at: Wed Jan 19 16:53:09 JST 1994
+
+  Copyright (C) 1993-2007 Yukihiro Matsumoto
+
+**********************************************************************/
+
+#ifndef DLN_H
+#define DLN_H
+
+#ifdef __cplusplus
+# ifndef  HAVE_PROTOTYPES
+#  define HAVE_PROTOTYPES 1
+# endif
+# ifndef  HAVE_STDARG_PROTOTYPES
+#  define HAVE_STDARG_PROTOTYPES 1
+# endif
+#endif
+
+#undef _
+#ifdef HAVE_PROTOTYPES
+# define _(args) args
+#else
+# define _(args) ()
+#endif
+
+DEPRECATED(char *dln_find_exe(const char*,const char*));
+DEPRECATED(char *dln_find_file(const char*,const char*));
+char *dln_find_exe_r(const char*,const char*,char*,int);
+char *dln_find_file_r(const char*,const char*,char*,int);
+
+#ifdef USE_DLN_A_OUT
+extern char *dln_argv0;
+#endif
+
+void *dln_load(const char*);
+#endif

data/ext/encdb.h

@@ -0,0 +1,147 @@
+ENC_DEFINE("ASCII-8BIT");
+ENC_DEFINE("Big5");
+ENC_DEFINE("CP949");
+ENC_DEFINE("Emacs-Mule");
+ENC_DEFINE("EUC-JP");
+ENC_DEFINE("EUC-KR");
+ENC_DEFINE("EUC-TW");
+ENC_DEFINE("GB18030");
+ENC_DEFINE("GBK");
+ENC_DEFINE("ISO-8859-1");
+ENC_DEFINE("ISO-8859-2");
+ENC_DEFINE("ISO-8859-3");
+ENC_DEFINE("ISO-8859-4");
+ENC_DEFINE("ISO-8859-5");
+ENC_DEFINE("ISO-8859-6");
+ENC_DEFINE("ISO-8859-7");
+ENC_DEFINE("ISO-8859-8");
+ENC_DEFINE("ISO-8859-9");
+ENC_DEFINE("ISO-8859-10");
+ENC_DEFINE("ISO-8859-11");
+ENC_DEFINE("ISO-8859-13");
+ENC_DEFINE("ISO-8859-14");
+ENC_DEFINE("ISO-8859-15");
+ENC_DEFINE("ISO-8859-16");
+ENC_DEFINE("KOI8-R");
+ENC_DEFINE("KOI8-U");
+ENC_DEFINE("Shift_JIS");
+ENC_DEFINE("US-ASCII");
+ENC_DEFINE("UTF-8");
+ENC_DEFINE("UTF-16BE");
+ENC_DEFINE("UTF-16LE");
+ENC_DEFINE("UTF-32BE");
+ENC_DEFINE("UTF-32LE");
+ENC_DEFINE("Windows-1251");
+ENC_ALIAS("BINARY", "ASCII-8BIT");
+ENC_REPLICATE("IBM437", "ASCII-8BIT");
+ENC_ALIAS("CP437", "IBM437");
+ENC_REPLICATE("IBM737", "ASCII-8BIT");
+ENC_ALIAS("CP737", "IBM737");
+ENC_REPLICATE("IBM775", "ASCII-8BIT");
+ENC_ALIAS("CP775", "IBM775");
+ENC_REPLICATE("CP850", "ASCII-8BIT");
+ENC_ALIAS("IBM850", "CP850");
+ENC_REPLICATE("IBM852", "ASCII-8BIT");
+ENC_REPLICATE("CP852", "IBM852");
+ENC_REPLICATE("IBM855", "ASCII-8BIT");
+ENC_REPLICATE("CP855", "IBM855");
+ENC_REPLICATE("IBM857", "ASCII-8BIT");
+ENC_ALIAS("CP857", "IBM857");
+ENC_REPLICATE("IBM860", "ASCII-8BIT");
+ENC_ALIAS("CP860", "IBM860");
+ENC_REPLICATE("IBM861", "ASCII-8BIT");
+ENC_ALIAS("CP861", "IBM861");
+ENC_REPLICATE("IBM862", "ASCII-8BIT");
+ENC_ALIAS("CP862", "IBM862");
+ENC_REPLICATE("IBM863", "ASCII-8BIT");
+ENC_ALIAS("CP863", "IBM863");
+ENC_REPLICATE("IBM864", "ASCII-8BIT");
+ENC_ALIAS("CP864", "IBM864");
+ENC_REPLICATE("IBM865", "ASCII-8BIT");
+ENC_ALIAS("CP865", "IBM865");
+ENC_REPLICATE("IBM866", "ASCII-8BIT");
+ENC_ALIAS("CP866", "IBM866");
+ENC_REPLICATE("IBM869", "ASCII-8BIT");
+ENC_ALIAS("CP869", "IBM869");
+ENC_REPLICATE("Windows-1258", "ASCII-8BIT");
+ENC_ALIAS("CP1258", "Windows-1258");
+ENC_REPLICATE("GB1988", "ASCII-8BIT");
+ENC_REPLICATE("macCentEuro", "ASCII-8BIT");
+ENC_REPLICATE("macCroatian", "ASCII-8BIT");
+ENC_REPLICATE("macCyrillic", "ASCII-8BIT");
+ENC_REPLICATE("macGreek", "ASCII-8BIT");
+ENC_REPLICATE("macIceland", "ASCII-8BIT");
+ENC_REPLICATE("macRoman", "ASCII-8BIT");
+ENC_REPLICATE("macRomania", "ASCII-8BIT");
+ENC_REPLICATE("macThai", "ASCII-8BIT");
+ENC_REPLICATE("macTurkish", "ASCII-8BIT");
+ENC_REPLICATE("macUkraine", "ASCII-8BIT");
+ENC_ALIAS("CP950", "BIG5");
+ENC_REPLICATE("stateless-ISO-2022-JP", "Emacs-Mule");
+ENC_ALIAS("eucJP", "EUC-JP") /* UI-OSF Application Platform Profile for Japanese Environment Version 1.1 */;
+ENC_REPLICATE("eucJP-ms", "EUC-JP") /* TOG/JVC CDE/Motif Technical WG */;
+ENC_ALIAS("euc-jp-ms", "eucJP-ms");
+ENC_REPLICATE("CP51932", "EUC-JP");
+ENC_ALIAS("eucKR", "EUC-KR");
+ENC_ALIAS("eucTW", "EUC-TW");
+ENC_ALIAS("EUC-CN", "GB2312");
+ENC_ALIAS("eucCN", "GB2312");
+ENC_REPLICATE("GB12345", "GB2312");
+ENC_ALIAS("CP936", "GBK");
+ENC_DUMMY("ISO-2022-JP");
+ENC_ALIAS("ISO2022-JP", "ISO-2022-JP");
+ENC_REPLICATE("ISO-2022-JP-2", "ISO-2022-JP");
+ENC_ALIAS("ISO2022-JP2", "ISO-2022-JP-2");
+ENC_ALIAS("ISO8859-1", "ISO-8859-1");
+ENC_REPLICATE("Windows-1252", "ISO-8859-1");
+ENC_ALIAS("CP1252", "Windows-1252");
+ENC_ALIAS("ISO8859-2", "ISO-8859-2");
+ENC_REPLICATE("Windows-1250", "ISO-8859-2");
+ENC_ALIAS("CP1250", "Windows-1250");
+ENC_ALIAS("ISO8859-3", "ISO-8859-3");
+ENC_ALIAS("ISO8859-4", "ISO-8859-4");
+ENC_ALIAS("ISO8859-5", "ISO-8859-5");
+ENC_ALIAS("ISO8859-6", "ISO-8859-6");
+ENC_REPLICATE("Windows-1256", "ISO-8859-6");
+ENC_ALIAS("CP1256", "Windows-1256");
+ENC_ALIAS("ISO8859-7", "ISO-8859-7");
+ENC_REPLICATE("Windows-1253", "ISO-8859-7");
+ENC_ALIAS("CP1253", "Windows-1253");
+ENC_ALIAS("ISO8859-8", "ISO-8859-8");
+ENC_REPLICATE("Windows-1255", "ISO-8859-8");
+ENC_ALIAS("CP1255", "Windows-1255");
+ENC_ALIAS("ISO8859-9", "ISO-8859-9");
+ENC_REPLICATE("Windows-1254", "ISO-8859-9");
+ENC_ALIAS("CP1254", "Windows-1254");
+ENC_ALIAS("ISO8859-10", "ISO-8859-10");
+ENC_ALIAS("ISO8859-11", "ISO-8859-11");
+ENC_REPLICATE("TIS-620", "ISO-8859-11");
+ENC_REPLICATE("Windows-874", "ISO-8859-11");
+ENC_ALIAS("CP874", "Windows-874");
+ENC_ALIAS("ISO8859-13", "ISO-8859-13");
+ENC_REPLICATE("Windows-1257", "ISO-8859-13");
+ENC_ALIAS("CP1257", "Windows-1257");
+ENC_ALIAS("ISO8859-14", "ISO-8859-14");
+ENC_ALIAS("ISO8859-15", "ISO-8859-15");
+ENC_ALIAS("ISO8859-16", "ISO-8859-16");
+ENC_ALIAS("CP878", "KOI8-R");
+ENC_ALIAS("SJIS", "Shift_JIS");
+ENC_REPLICATE("Windows-31J", "Shift_JIS");
+ENC_ALIAS("CP932", "Windows-31J");
+ENC_ALIAS("csWindows31J", "Windows-31J") /* IANA.  IE6 don't accept Windows-31J but csWindows31J. */;
+ENC_REPLICATE("MacJapanese", "Shift_JIS");
+ENC_ALIAS("MacJapan", "MacJapanese");
+ENC_ALIAS("ASCII", "US-ASCII");
+ENC_ALIAS("ANSI_X3.4-1968", "US-ASCII");
+ENC_ALIAS("646", "US-ASCII");
+ENC_DUMMY("UTF-7");
+ENC_ALIAS("CP65000", "UTF-7");
+ENC_ALIAS("CP65001", "UTF-8");
+ENC_REPLICATE("UTF8-MAC", "UTF-8");
+ENC_ALIAS("UTF-8-MAC", "UTF8-MAC");
+ENC_ALIAS("UCS-2BE", "UTF-16BE");
+ENC_ALIAS("UCS-4BE", "UTF-32BE");
+ENC_ALIAS("UCS-4LE", "UTF-32LE");
+ENC_ALIAS("CP1251", "Windows-1251");
+
+#define ENCODING_COUNT 83