rubysl-irb 1.0.2 → 2.0.3

data/lib/irb/ruby-token.rb

@@ -1,14 +1,14 @@
 #
-#   irb/ruby-token.rb - ruby tokens 
-#   	$Release Version: 0.9.5$
-#   	$Revision: 11708 $
-#   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
+#   irb/ruby-token.rb - ruby tokens
+#   	$Release Version: 0.9.6$
+#   	$Revision$
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 # --
 #
-#   
 #
+#
+# :stopdoc:
 module RubyToken
   EXPR_BEG = :EXPR_BEG
   EXPR_MID = :EXPR_MID
@@ -18,20 +18,13 @@ module RubyToken
   EXPR_DOT = :EXPR_DOT
   EXPR_CLASS = :EXPR_CLASS
 
-  # for ruby 1.4X
-  if !defined?(Symbol)
-    Symbol = Integer
-  end
-  
   class Token
     def initialize(seek, line_no, char_no)
       @seek = seek
       @line_no = line_no
       @char_no = char_no
     end
-    attr :seek
-    attr :line_no
-    attr :char_no
+    attr :seek, :line_no, :char_no
   end
 
   class TkNode < Token
@@ -58,7 +51,7 @@ module RubyToken
   end
 
   class TkOp < Token
-    attr :name, true
+    attr_accessor :name
   end
 
   class TkOPASGN < TkOp
@@ -87,7 +80,7 @@ module RubyToken
       if (tk = TkReading2Token[token]).nil?
 	IRB.fail TkReading2TokenNoKey, token
       end
-      tk = Token(tk[0], value) 
+      tk = Token(tk[0], value)
       if tk.kind_of?(TkOp)
 	tk.name = token
       end
@@ -96,8 +89,8 @@ module RubyToken
       if (tk = TkSymbol2Token[token]).nil?
 	IRB.fail TkSymbol2TokenNoKey, token
       end
-      return Token(tk[0], value) 
-    else 
+      return Token(tk[0], value)
+    else
       if (token.ancestors & [TkId, TkVal, TkOPASGN, TkUnknownChar]).empty?
 	token.new(@prev_seek, @prev_line_no, @prev_char_no)
       else
@@ -197,7 +190,7 @@ module RubyToken
     [:TkASSOC,      TkOp,   "=>"],
     [:TkQUESTION,   TkOp,   "?"],	 #?
     [:TkCOLON,      TkOp,   ":"],        #:
-    
+
     [:TkfLPAREN],         # func( #
     [:TkfLBRACK],         # func[ #
     [:TkfLBRACE],         # func{ #
@@ -253,7 +246,7 @@ module RubyToken
       IRB.fail AlreadyDefinedToken, token_n
     end
     token_c = eval("class #{token_n} < #{super_token}; end; #{token_n}")
-    
+
     if reading
       if TkReading2Token[reading]
 	IRB.fail TkReading2TokenDuplicateError, token_n, reading
@@ -271,3 +264,4 @@ module RubyToken
     def_token(*defs)
   end
 end
+# :startdoc:

data/lib/irb/slex.rb

@@ -1,21 +1,21 @@
 #
-#   irb/slex.rb - symple lex analizer
-#   	$Release Version: 0.9.5$
-#   	$Revision: 11708 $
-#   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
+#   irb/slex.rb - simple lex analyzer
+#   	$Release Version: 0.9.6$
+#   	$Revision$
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 # --
 #
-#   
+#
 #
 
 require "e2mmap"
 require "irb/notifier"
 
+# :stopdoc:
 module IRB
   class SLex
-    @RCS_ID='-$Id: slex.rb 11708 2007-02-12 23:01:19Z shyouhei $-'
+    @RCS_ID='-$Id$-'
 
     extend Exception2MessageMapper
     def_exception :ErrNodeNothing, "node nothing"
@@ -25,20 +25,20 @@ module IRB
     D_WARN = DOUT::def_notifier(1, "Warn: ")
     D_DEBUG = DOUT::def_notifier(2, "Debug: ")
     D_DETAIL = DOUT::def_notifier(4, "Detail: ")
-    
+
     DOUT.level = Notifier::D_NOMSG
 
     def initialize
       @head = Node.new("")
     end
-    
+
     def def_rule(token, preproc = nil, postproc = nil, &block)
       D_DETAIL.pp token
 
       postproc = block if block_given?
-      node = create(token, preproc, postproc)
+      create(token, preproc, postproc)
     end
-    
+
     def def_rules(*tokens, &block)
       if block_given?
 	p = block
@@ -47,18 +47,18 @@ module IRB
 	def_rule(token, nil, p)
       end
     end
-    
+
     def preproc(token, proc)
       node = search(token)
       node.preproc=proc
     end
-    
-    #$BMW%A%'%C%/(B? 
+
+    #$BMW%A%'%C%/(B?
     def postproc(token)
       node = search(token, proc)
       node.postproc=proc
     end
-    
+
     def search(token)
       @head.search(token.split(//))
     end
@@ -66,7 +66,7 @@ module IRB
     def create(token, preproc = nil, postproc = nil)
       @head.create_subnode(token.split(//), preproc, postproc)
     end
-    
+
     def match(token)
       case token
       when Array
@@ -76,17 +76,17 @@ module IRB
 	return @head.match_io(token)
       end
       ret = @head.match(token)
-      D_DETAIL.exec_if{D_DEATIL.printf "match end: %s:%s\n", ret, token.inspect}
+      D_DETAIL.exec_if{D_DETAIL.printf "match end: %s:%s\n", ret, token.inspect}
       ret
     end
-    
+
     def inspect
       format("<SLex: @head = %s>", @head.inspect)
     end
 
     #----------------------------------------------------------------------
     #
-    #   class Node - 
+    #   class Node -
     #
     #----------------------------------------------------------------------
     class Node
@@ -100,7 +100,7 @@ module IRB
 
       attr_accessor :preproc
       attr_accessor :postproc
-      
+
       def search(chrs, opt = nil)
 	return self if chrs.empty?
 	ch = chrs.shift
@@ -115,7 +115,7 @@ module IRB
 	  end
 	end
       end
-      
+
       def create_subnode(chrs, preproc = nil, postproc = nil)
 	if chrs.empty?
 	  if @postproc
@@ -128,7 +128,7 @@ module IRB
 	  end
 	  return self
 	end
-	
+
 	ch = chrs.shift
 	if node = @Tree[ch]
 	  if chrs.empty?
@@ -162,7 +162,7 @@ module IRB
       # chrs: String
       #       character array
       #       io must have getc()/ungetc(); and ungetc() must be
-      #       able to be called arbitrary number of times. 
+      #       able to be called arbitrary number of times.
       #
       def match(chrs, op = "")
 	D_DETAIL.print "match>: ", chrs, "op:", op, "\n"
@@ -244,8 +244,7 @@ module IRB
     end
   end
 end
-
-SLex=IRB::SLex
+# :startdoc:
 
 if $0 == __FILE__
   #    Tracer.on
@@ -257,14 +256,14 @@ if $0 == __FILE__
     print "1: ", tr.inspect, "\n"
     tr.def_rule("==") {print "==\n"}
     print "2: ", tr.inspect, "\n"
-    
+
     print "case 1:\n"
     print tr.match("="), "\n"
     print "case 2:\n"
     print tr.match("=="), "\n"
     print "case 3:\n"
     print tr.match("=>"), "\n"
-    
+
   when "2"
     tr = SLex.new
     print "0: ", tr.inspect, "\n"
@@ -272,7 +271,7 @@ if $0 == __FILE__
     print "1: ", tr.inspect, "\n"
     tr.def_rule("==", proc{false}) {print "==\n"}
     print "2: ", tr.inspect, "\n"
-    
+
     print "case 1:\n"
     print tr.match("="), "\n"
     print "case 2:\n"

data/lib/irb/src_encoding.rb

@@ -0,0 +1,4 @@
+# DO NOT WRITE ANY MAGIC COMMENT HERE.
+def default_src_encoding
+  return __ENCODING__
+end

data/lib/irb/version.rb

@@ -1,16 +1,15 @@
 #
 #   irb/version.rb - irb version definition file
-#   	$Release Version: 0.9.5$
-#   	$Revision: 11708 $
-#   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
+#   	$Release Version: 0.9.6$
+#   	$Revision$
 #   	by Keiju ISHITSUKA(keiju@ishitsuka.com)
 #
 # --
 #
-#   
+#
 #
 
-module IRB
-  @RELEASE_VERSION = "0.9.5"
-  @LAST_UPDATE_DATE = "05/04/13"
+module IRB # :nodoc:
+  @RELEASE_VERSION = "0.9.6"
+  @LAST_UPDATE_DATE = "09/06/30"
 end

data/lib/irb/workspace.rb

@@ -1,17 +1,18 @@
 #
-#   irb/workspace-binding.rb - 
-#   	$Release Version: 0.9.5$
-#   	$Revision: 11708 $
-#   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
+#   irb/workspace-binding.rb -
+#   	$Release Version: 0.9.6$
+#   	$Revision$
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 # --
 #
-#   
 #
-module IRB
+#
+module IRB # :nodoc:
   class WorkSpace
-    # create new workspace. set self to main if specified, otherwise
+    # Creates a new workspace.
+    #
+    # set self to main if specified, otherwise
     # inherit main from TOPLEVEL_BINDING.
     def initialize(*main)
       if main[0].kind_of?(Binding)
@@ -22,7 +23,7 @@ module IRB
 	case IRB.conf[:CONTEXT_MODE]
 	when 0	# binding in proc on TOPLEVEL_BINDING
 	  @binding = eval("proc{binding}.call",
-		      TOPLEVEL_BINDING, 
+		      TOPLEVEL_BINDING,
 		      __FILE__,
 		      __LINE__)
 	when 1	# binding in loaded file
@@ -38,8 +39,8 @@ EOF
 	when 2	# binding in loaded file(thread use)
 	  unless defined? BINDING_QUEUE
 	    require "thread"
-	    
-	    IRB.const_set("BINDING_QUEUE", SizedQueue.new(1))
+
+	    IRB.const_set(:BINDING_QUEUE, SizedQueue.new(1))
 	    Thread.abort_on_exception = true
 	    Thread.start do
 	      eval "require \"irb/ws-for-case-2\"", TOPLEVEL_BINDING, __FILE__, __LINE__
@@ -49,8 +50,8 @@ EOF
 	  @binding = BINDING_QUEUE.pop
 
 	when 3	# binging in function on TOPLEVEL_BINDING(default)
-	  @binding = eval("def irb_binding; binding; end; irb_binding",
-		      TOPLEVEL_BINDING, 
+	  @binding = eval("def irb_binding; private; binding; end; irb_binding",
+		      TOPLEVEL_BINDING,
 		      __FILE__,
 		      __LINE__ - 3)
 	end
@@ -64,7 +65,7 @@ EOF
 	when Module
 	  @binding = eval("IRB.conf[:__MAIN__].module_eval('binding', __FILE__, __LINE__)", @binding, __FILE__, __LINE__)
 	else
-	  begin 
+	  begin
 	    @binding = eval("IRB.conf[:__MAIN__].instance_eval('binding', __FILE__, __LINE__)", @binding, __FILE__, __LINE__)
 	  rescue TypeError
 	    IRB.fail CantChangeBinding, @main.inspect
@@ -74,13 +75,17 @@ EOF
       eval("_=nil", @binding)
     end
 
+    # The Binding of this workspace
     attr_reader :binding
+    # The top-level workspace of this context, also available as
+    # <code>IRB.conf[:__MAIN__]</code>
     attr_reader :main
 
+    # Evaluate the given +statements+ within the  context of this workspace.
     def evaluate(context, statements, file = __FILE__, line = __LINE__)
       eval(statements, @binding, file, line)
     end
-  
+
     # error message manipulator
     def filter_backtrace(bt)
       case IRB.conf[:CONTEXT_MODE]
@@ -94,9 +99,11 @@ EOF
 	end
       when 2
 	return nil if bt =~ /irb\/.*\.rb/
+	return nil if bt =~ /irb\.rb/
       when 3
 	return nil if bt =~ /irb\/.*\.rb/
-	bt.sub!(/:\s*in `irb_binding'/){""} 
+	return nil if bt =~ /irb\.rb/
+	bt = bt.sub(/:\s*in `irb_binding'/, '')
       end
       bt
     end

data/lib/irb/ws-for-case-2.rb

@@ -1,15 +1,14 @@
 #
-#   irb/ws-for-case-2.rb - 
-#   	$Release Version: 0.9.5$
-#   	$Revision: 11708 $
-#   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
+#   irb/ws-for-case-2.rb -
+#   	$Release Version: 0.9.6$
+#   	$Revision$
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 # --
 #
-#   
+#
 #
 
 while true
-  IRB::BINDING_QUEUE.push b = binding
+  IRB::BINDING_QUEUE.push _ = binding
 end

data/lib/irb/xmp.rb

@@ -1,21 +1,57 @@
 #
 #   xmp.rb - irb version of gotoken xmp
 #   	$Release Version: 0.9$
-#   	$Revision: 11708 $
-#   	$Date: 2007-02-12 15:01:19 -0800 (Mon, 12 Feb 2007) $
+#   	$Revision$
 #   	by Keiju ISHITSUKA(Nippon Rational Inc.)
 #
 # --
 #
-#   
+#
 #
 
 require "irb"
 require "irb/frame"
 
+# An example printer for irb.
+#
+# It's much like the standard library PrettyPrint, that shows the value of each
+# expression as it runs.
+#
+# In order to use this library, you must first require it:
+#
+#     require 'irb/xmp'
+#
+# Now, you can take advantage of the Object#xmp convenience method.
+#
+#     xmp <<END
+#       foo = "bar"
+#       baz = 42
+#     END
+#     #=> foo = "bar"
+#       #==>"bar"
+#     #=> baz = 42
+#       #==>42
+#
+# You can also create an XMP object, with an optional binding to print
+# expressions in the given binding:
+#
+#     ctx = binding
+#     x = XMP.new ctx
+#     x.puts
+#     #=> today = "a good day"
+#       #==>"a good day"
+#     ctx.eval 'today # is what?'
+#     #=> "a good day"
 class XMP
-  @RCS_ID='-$Id: xmp.rb 11708 2007-02-12 23:01:19Z shyouhei $-'
+  @RCS_ID='-$Id$-'
 
+  # Creates a new XMP object.
+  #
+  # The top-level binding or, optional +bind+ parameter will be used when
+  # creating the workspace. See WorkSpace.new for more information.
+  #
+  # This uses the +:XMP+ prompt mode, see IRB@Customizing+the+IRB+Prompt for
+  # full detail.
   def initialize(bind = nil)
     IRB.init_config(nil)
     #IRB.parse_opts
@@ -33,6 +69,17 @@ class XMP
     IRB.conf[:MAIN_CONTEXT] = @irb.context
   end
 
+  # Evaluates the given +exps+, for example:
+  #
+  #   require 'irb/xmp'
+  #   x = XMP.new
+  #
+  #   x.puts '{:a => 1, :b => 2, :c => 3}'
+  #   #=> {:a => 1, :b => 2, :c => 3}
+  #     # ==>{:a=>1, :b=>2, :c=>3}
+  #   x.puts 'foo = "bar"'
+  #   # => foo = "bar"
+  #     # ==>"bar"
   def puts(exps)
     @io.puts exps
 
@@ -52,16 +99,22 @@ class XMP
     end
   end
 
+  # A custom InputMethod class used by XMP for evaluating string io.
   class StringInputMethod < IRB::InputMethod
+    # Creates a new StringInputMethod object
     def initialize
       super
       @exps = []
     end
 
+    # Whether there are any expressions left in this printer.
     def eof?
       @exps.empty?
     end
 
+    # Reads the next expression from this printer.
+    #
+    # See IO#gets for more information.
     def gets
       while l = @exps.shift
 	next if /^\s+$/ =~ l
@@ -72,12 +125,46 @@ class XMP
       l
     end
 
+    # Concatenates all expressions in this printer, separated by newlines.
+    #
+    # An Encoding::CompatibilityError is raised of the given +exps+'s encoding
+    # doesn't match the previous expression evaluated.
     def puts(exps)
+      if @encoding and exps.encoding != @encoding
+	enc = Encoding.compatible?(@exps.join("\n"), exps)
+	if enc.nil?
+	  raise Encoding::CompatibilityError, "Encoding in which the passed expression is encoded is not compatible to the preceding's one"
+	else
+	  @encoding = enc
+	end
+      else
+	@encoding = exps.encoding
+      end
       @exps.concat exps.split(/\n/)
     end
+
+    # Returns the encoding of last expression printed by #puts.
+    attr_reader :encoding
   end
 end
 
+# A convenience method that's only available when the you require the IRB::XMP standard library.
+#
+# Creates a new XMP object, using the given expressions as the +exps+
+# parameter, and optional binding as +bind+ or uses the top-level binding. Then
+# evaluates the given expressions using the +:XMP+ prompt mode.
+#
+# For example:
+#
+#   require 'irb/xmp'
+#   ctx = binding
+#   xmp 'foo = "bar"', ctx
+#   #=> foo = "bar"
+#     #==>"bar"
+#   ctx.eval 'foo'
+#   #=> "bar"
+#
+# See XMP.new for more information.
 def xmp(exps, bind = nil)
   bind = IRB::Frame.top(1) unless bind
   xmp = XMP.new(bind)