sender 1.0.1 → 1.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
-=== 1.0.1 2010-06-22
+=== 1.0.0 2010-06-22
 
 Initial release
+
+=== 1.0.1 2010-06-22
+
+Minor detail changes
+
+=== 1.1 2010-06-23
+
+Added Kernel.backtrace
+Added Kernel.backtrace_includes?

data/Makefile

@@ -41,7 +41,7 @@ sitearchdir = $(sitelibdir)/$(sitearch)
 vendorlibdir = $(vendordir)/$(ruby_version)
 vendorarchdir = $(vendorlibdir)/$(sitearch)
 
-CC = /Developer/usr/bin/clang
+CC = gcc
 CXX = g++
 LIBRUBY = $(LIBRUBY_SO)
 LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a
@@ -52,7 +52,7 @@ COUTFLAG = -o
 
 RUBY_EXTCONF_H = 
 cflags   = $(optflags) $(debugflags) $(warnflags)
-optflags = -O2
+optflags = 
 debugflags = -g
 warnflags = -Wall -Wno-parentheses
 CFLAGS   =  -fno-common  $(cflags)  -fno-common -pipe -fno-common 

data/Manifest.txt

@@ -4,14 +4,41 @@ Makefile
 Manifest.txt
 README.rdoc
 Rakefile
+ext/sender/RPSender_internal.c
+ext/sender/RPSender_internal.h
 ext/sender/RubySourceSupport.c
 ext/sender/RubySourceSupport.h
+ext/sender/debug.h
+ext/sender/dln.h
+ext/sender/encdb.h
+ext/sender/eval_intern.h
 ext/sender/extconf.rb
+ext/sender/gc.h
+ext/sender/id.h
+ext/sender/iseq.h
 ext/sender/main.c
+ext/sender/node.h
+ext/sender/parse.h
 ext/sender/rb_Global.c
 ext/sender/rb_Global.h
 ext/sender/rb_Global_internal.h
+ext/sender/rb_Kernel.c
+ext/sender/rb_Kernel.h
+ext/sender/regenc.h
+ext/sender/regint.h
+ext/sender/regparse.h
+ext/sender/revision.h
+ext/sender/thread_pthread.h
+ext/sender/thread_win32.h
+ext/sender/transcode_data.h
+ext/sender/transdb.h
+ext/sender/version.h
+ext/sender/vm_core.h
+ext/sender/vm_exec.h
+ext/sender/vm_insnhelper.h
+ext/sender/vm_opts.h
 lib/sender.rb
 lib/sender/sender.bundle
 mkmf.log
+sender.gemspec
 test/test_sender.rb

data/README.rdoc

@@ -1,40 +1,90 @@
 Sender:
 
 == DESCRIPTION:
+http://rubygems.org/gems/sender
 
 	Adds __sender__ and __caller__ to the built-in __callee__ and __method__ functions.
+	
+	Adds object-oriented backtrace, which returns :object and :method for each stack frame,
+	and which permits queries regarding backtrace contents.
+	
+	* __sender__
+	* __caller__
+	* backtrace
+	* backtrace( frames_to_trace_backward )
+	* backtrace_includes?( Class )
+	* backtrace_includes?( class_instance )
+	* backtrace_includes?( :symbol )
+	* backtrace_includes?( Class, class_instance, :symbol, ... )
 
-== SYNOPSIS:
+== INSTALL:
 
-	Example:
+	* sudo gem install sender
 
-		require 'sender'
+== EXAMPLE:
 
-		class SenderTest
-			def sender_test
-				puts( 'Caller was: ' + __caller__.to_s )
-				puts( 'Sender was: ' + __sender__.to_s )
-			end
-		end
+	require 'sender'
 
-		class Test
-			def run_tests
-				test = SenderTest.new
-				test.sender_test
-			end
-		end
+	require '../sender/lib/sender/sender'
 
-		test = Test.new
-		test.run_tests
-	
-	Outputs:
-	
-		Caller was: sender_test
-		Sender was: #<SenderTest:0x0000010103ee88>
+	require 'pp'
 
-== INSTALL:
+	class Test
 
-	* sudo gem install sender
+	  def test
+	    self.another_test
+	  end
+
+	  def another_test
+	    test2 = Test2.new
+	    test2.and_another_test_in_another_object
+	  end
+
+	end
+
+	class Test2
+
+	  def and_another_test_in_another_object
+	    puts 'Sender was: ' + __sender__.pretty_inspect.to_s
+	    puts 'Caller was: ' + __caller__.to_s
+	    pp Kernel.backtrace    
+	    pp Kernel.backtrace( 2 )
+	    puts 'These should be true:'
+	    pp Kernel.backtrace_includes?( :another_test )
+	    pp Kernel.backtrace_includes?( Test )
+	    pp Kernel.backtrace_includes?( $test )
+	    pp Kernel.backtrace_includes?( :another_test, Test, $test )
+	    puts 'These should be false:'
+	    pp Kernel.backtrace_includes?( :non_existing_function )
+	    pp Kernel.backtrace_includes?( Test2 )
+	    pp Kernel.backtrace_includes?( self )
+	    pp Kernel.backtrace_includes?( :non_existing_function, Test2, self )
+	  end
+
+	end
+
+	$test = Test.new
+	$test.test
+	
+== EXAMPLE's OUTPUT:
+	
+	Sender was: #<Test:0x0000010101ef18>
+	Caller was: and_another_test_in_another_object
+	[{:object=>#<Test:0x0000010101ef18>, :method=>:another_test},
+	 {:object=>#<Test:0x0000010101ef18>, :method=>:test},
+	 {:object=>main}]
+	[{:object=>#<Test:0x0000010101ef18>, :method=>:another_test},
+	 {:object=>#<Test:0x0000010101ef18>, :method=>:test}]
+	These should be true:
+	true
+	true
+	true
+	true
+	These should be false:
+	false
+	false
+	false
+	false
 
 == LICENSE:
 

data/Rakefile

@@ -11,6 +11,8 @@ Hoe.spec 'sender' do
   self.spec_extras			= { :extensions => ["ext/sender/extconf.rb"] }
   self.extra_dev_deps << ['rake-compiler', '>= 0']  
 
+  self.version="1.1.0"
+
   Rake::ExtensionTask.new( 'sender', spec ) do |ext|
     ext.lib_dir = File.join('lib', 'sender')
   end
@@ -20,6 +22,6 @@ Rake::Task[:test].prerequisites << :compile
 
 task :cultivate do
   system "touch Manifest.txt; rake check_manifest | grep -v \"(in \" | patch"
-  system "rake debug_gem | grep -v \"(in \" > `basename \\`pwd\\``.gemspec"
+  system "rake debug_gem | grep -v \"(in \" > sender.gemspec"
 end
 

data/ext/sender/RPSender_internal.c

@@ -0,0 +1,64 @@
+
+#include "RPSender_internal.h"
+#include "RubySourceSupport.h"
+
+/*************************
+ *  framePriorToCurrent  *
+ ************************/
+
+rb_control_frame_t* RPRuby_internal_framePriorTo( rb_control_frame_t* control_frame )	{
+	
+	rb_thread_t*			c_thread				= GET_THREAD();
+	rb_control_frame_t*		prior_control_frame		= NULL;
+	//	get the current frame pointer
+	if ( control_frame == NULL )	{
+		control_frame	= c_thread->cfp;
+	}
+	
+    if ( ( prior_control_frame = rb_vm_get_ruby_level_next_cfp( c_thread, control_frame ) ) != 0) {
+		
+		prior_control_frame = RUBY_VM_PREVIOUS_CONTROL_FRAME( prior_control_frame );
+
+    }
+	else {
+		prior_control_frame = NULL;
+	}
+	
+	//	if we have a nil object we've passed main, we're done
+	if ( prior_control_frame->self == Qnil )	{
+		return NULL;
+	}
+
+	return prior_control_frame;
+	
+}
+
+/**********************************
+ *  backtraceHashForControlFrame  *
+ *********************************/
+
+VALUE RPSender_internal_backtraceHashForControlFrame( rb_control_frame_t* c_control_frame )	{
+
+	//	create new hash for this frame
+	VALUE	rb_frame_hash		=	rb_hash_new();
+	
+	//	get object and set in hash
+	VALUE	rb_object_for_frame	=	c_control_frame->self;
+	//	if we get nil we're done with our backtrace
+	rb_hash_aset(	rb_frame_hash,
+					ID2SYM( rb_intern( "object" ) ),
+					rb_object_for_frame );
+	
+	//	get method and set in hash
+	ID		c_frame_function_id	=	frame_func_id( c_control_frame );
+	//	main has no method name
+	if ( c_frame_function_id != 0)	{
+		VALUE	rb_method_for_frame	=	ID2SYM( c_frame_function_id );
+		rb_hash_aset(	rb_frame_hash,
+						ID2SYM( rb_intern( "method" ) ),
+						rb_method_for_frame );
+		
+	}
+	
+	return rb_frame_hash;
+}

data/ext/sender/RPSender_internal.h

@@ -0,0 +1,10 @@
+#ifndef RP_SENDER_INTERNAL
+	#define RP_SENDER_INTERNAL
+
+	#include "ruby.h"
+	#include "eval_intern.h"
+
+	rb_control_frame_t* RPRuby_internal_framePriorTo( rb_control_frame_t* control_frame );
+	VALUE RPSender_internal_backtraceHashForControlFrame( rb_control_frame_t* c_control_frame );
+
+#endif

data/ext/sender/RubySourceSupport.c

@@ -1,8 +1,6 @@
 
 #include "RubySourceSupport.h"
 
-#include "vm_exec.h"
-
 //	Taken from eval.c in Ruby source
 //	No header, so easiest way to integrate was to copy the code and make my own header.
 //	Previously declared static; otherwise unchanged
@@ -14,6 +12,7 @@ ID frame_func_id( rb_control_frame_t *cfp )
 		return cfp->method_id;
     }
     while (iseq) {
+		
 		if (RUBY_VM_IFUNC_P(iseq)) {
 			return rb_intern("<ifunc>");
 		}
@@ -38,3 +37,4 @@ ID rb_frame_caller(void)
     }
     return frame_func_id(prev_cfp);
 }
+

data/ext/sender/RubySourceSupport.h

@@ -1,9 +1,9 @@
-#ifndef RP_SENDER_CALLER_RUBY_SOURCE_SUPPORT
-	#define RP_SENDER_CALLER_RUBY_SOURCE_SUPPORT
-
-	#include <ruby.h>
+#ifndef RP_SENDER_RUBY_SOURCE_SUPPORT
+	#define RP_SENDER_RUBY_SOURCE_SUPPORT
 
+	#include "ruby.h"
 	#include "eval_intern.h"
+	#include "vm_core.h"
 
 	ID frame_func_id( rb_control_frame_t *cfp );
 	ID rb_frame_caller(void);

data/ext/sender/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/sender/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/sender/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