rawline 0.2.0

data/lib/rawline/history_buffer.rb

@@ -0,0 +1,130 @@
+#!/usr/local/bin/ruby -w
+
+#
+#	history_buffer.rb
+#
+# Created by Fabio Cevasco on 2008-03-01.
+# Copyright (c) 2008 Fabio Cevasco. All rights reserved.
+#
+# This is Free Software.  See LICENSE for details.
+#
+#
+#
+module RawLine
+
+	# 
+	# The HistoryBuffer class is used to hold the editor and line histories, as well
+	# as word completion matches.
+	#
+	class HistoryBuffer < Array
+
+		attr_reader :position, :size
+		attr_accessor :duplicates, :exclude, :cycle
+
+		undef <<
+
+		#
+		# Create an instance of RawLine::HistoryBuffer. 
+		# This method takes an optional block used to override the 
+		# following instance attributes:
+		# * <tt>@duplicates</tt> - whether or not duplicate items will be stored in the
+		# buffer.
+		# * <tt>@exclude</tt> - a Proc object defining exclusion rules to prevent items
+		# from being added to the buffer.
+		# * <tt>@cycle</tt> - Whether or not the buffer is cyclic.
+		#
+		def initialize(size)
+			@duplicates = true
+			@exclude = lambda { nil }
+			@cycle = false
+			yield self if block_given?
+			@size = size
+			@position = nil
+		end
+
+		#
+		# Resize the buffer, resetting <tt>@position</tt> to nil.
+		#
+		def resize(new_size)
+			if new_size < @size
+				@size-new_size.times { pop }
+			end
+			@size = new_size
+			@position = nil 
+		end
+		
+		# 
+		# Clear the content of the buffer and reset <tt>@position</tt> to nil.
+		#
+		def empty
+			@position = nil 
+			clear
+		end
+
+		# 
+		# Retrieve the element at <tt>@position</tt>.
+		#
+		def get
+			return nil unless length > 0
+			@position = length-1 unless @position
+			at @position
+		end
+
+		# 
+		# Return true if <tt>@position</tt> is at the end of the buffer.
+		#
+		def end?
+			@position == length-1
+		end
+
+		# 
+		# Return true if <tt>@position</tt> is at the start of the buffer.
+		#
+		def start?
+			@position == 0
+		end
+
+		#
+		# Decrement <tt>@position</tt>.
+		#
+		def back
+			return nil unless length > 0
+			case @position
+			when nil: @position = length-1
+			when 0: @position = length-1 if @cycle
+			else @position -= 1
+			end
+		end
+
+		#
+		# Increment <tt>@position</tt>.
+		#
+		def forward
+			return nil unless length > 0
+			case @position
+			when nil: @position = length-1
+			when length-1: @position = 0 if @cycle
+			else @position += 1
+			end
+		end
+
+		# 
+		# Add a new item to the buffer.
+		#
+		def <<(item)
+			delete(item) unless @duplicates
+			unless @exclude.call(item)
+				# Remove the oldest element if size is exceeded
+				if @size <= length
+					reverse!.pop 
+					reverse!
+				end
+				# Add the new item and reset the position
+				push(item)
+				@position = nil 
+			end
+		end
+
+	end
+
+end

data/lib/rawline/line.rb

@@ -0,0 +1,158 @@
+#!/usr/local/bin/ruby -w
+
+#
+#	line.rb
+#
+# Created by Fabio Cevasco on 2008-03-01.
+# Copyright (c) 2008 Fabio Cevasco. All rights reserved.
+#
+# This is Free Software.  See LICENSE for details.
+#
+
+module RawLine
+	
+	# 
+	# The Line class is used to represent the current line being processed and edited
+	# by RawLine::Editor. It keeps track of the characters typed, the cursor position, 
+	# the current word and maintains an internal history to allow undos and redos.
+	#
+	class Line
+
+		attr_accessor :text, :position, :history, :prompt, :history_size, :word_separator
+		attr_reader :offset
+
+		include HighLine::SystemExtensions
+
+		# 
+		# Create an instance of RawLine::Line.
+		# This method takes an optional block used to override the 
+		# following instance attributes:
+		# * <tt>@text</tt> - the line text.
+		# * <tt>@history_size</tt> - the size of the line history buffer.
+		# * <tt>@position</tt> - the current cursor position within the line.
+		# * <tt>@prompt</tt> - a prompt to prepend to the line text.
+		#
+		def initialize(history_size)
+			@text = ""
+			@history_size = history_size
+			@position = 0
+			@prompt = ""
+			@word_separator = ' '
+			yield self if block_given?
+			@words = []
+			@history = RawLine::HistoryBuffer.new(@history_size)
+			@history << "" # Add empty line for complete undo...
+			@offset = @prompt.length
+		end
+
+		# 
+		# Return the maximum line length. By default, it corresponds to the terminal's 
+		# width minus the length of the line prompt.
+		#
+		def max_length
+			terminal_size[0]-@offset
+		end
+
+		# 
+		# Return information about the current word, as a Hash composed by the following
+		# elements:
+		# * <tt>:start</tt>: The position in the line corresponding to the word start
+		# * <tt>:end</tt>: The position in the line corresponding to the word end
+		# * <tt>:text</tt>: The word text.
+		def word
+			last = @text.index(@word_separator, @position)
+			first = @text.rindex(@word_separator, @position)
+			# Trim word separators and handle EOL and BOL
+			if first: first +=1 
+			else first = bol
+			end
+			if last: last -=1 
+			else last = eol+1 unless last
+			end
+			# Swap if overlapping
+			last, first = first, last if last < first
+			text = @text[first..last]
+			# Repeat the search if within word separator
+			if text.match @word_separator then
+				last = first
+				first = @text.rindex(@word_separator, first)
+			 	if first then first+=1
+				else first =	bol 
+				end
+				text = @text[first..last]
+			end
+			{:start => first, :end => last, :text => text}
+		end
+
+		# 
+		# Return the position corresponding to the beginning of the line.
+		#
+		def bol
+		 0	
+		end
+
+		# 
+		# Return true if the cursor is at the beginning of the line.
+		#
+		def bol?
+			@position<=bol
+		end
+		
+		# 
+		# Return the position corresponding to the end of the line.
+		#
+		def eol
+			@text.length-1
+		end
+
+		# 
+		# Return true if the cursor is at the end of the line.
+		#
+		def eol?
+			@position>=eol
+		end
+
+		# 
+		# Decrement the line position by <tt>offset</tt>
+		#
+		def left(offset=1)
+			@position = (@position-offset <= 0) ? 0 : @position-offset
+		end
+
+		# 
+		# Increment the line position by <tt>offset</tt>
+		#
+		def right(offset=1)
+			@position = (@position+offset >= max_length) ? max_length : @position+offset
+		end
+
+		# 
+		# Add a character (expressed as a character code) to the line text.
+		#
+		def <<(char)
+			@text << char.chr
+		end
+
+		#
+		# Access the line text at <tt>@index</tt>
+		#
+		def [](index)
+			@text[index]
+		end
+
+		#
+		#  Modify the character(s) in the line text at <tt>@index</tt>
+		#
+		def []=(index, chars)
+			@text[index] = chars
+		end
+
+		#
+		# Return the length of the line text.
+		#
+		def length
+			@text.length
+		end
+
+	end
+end

data/lib/rawline/terminal/vt220_terminal.rb

@@ -0,0 +1,66 @@
+#!/usr/local/bin/ruby -w
+
+#
+#	vt220_terminal.rb
+#
+# Created by Fabio Cevasco on 2008-03-01.
+# Copyright (c) 2008 Fabio Cevasco. All rights reserved.
+#
+# This is Free Software.  See LICENSE for details.
+#
+
+module RawLine
+	
+	# 
+	# This class is used to define all the most common character codes and
+	# escape sequences used on *nix systems.
+	#
+	class VT220Terminal < Terminal
+
+		def initialize
+			super
+			@escape_codes = [?\e]
+			@keys.merge!(
+				{
+					:up_arrow => [?\e, ?[, ?A],
+					:down_arrow => [?\e, ?[, ?B],
+					:right_arrow => [?\e, ?[, ?C],
+					:left_arrow => [?\e, ?[, ?D],
+					:insert => [?\e, ?[, ?2, ?~],
+					:delete => [?\e, ?[, ?3, ?~],
+					:backspace => [?\C-?],
+					:enter => [?\n],
+
+					:ctrl_alt_a => [?\e, ?\C-a],
+					:ctrl_alt_b => [?\e, ?\C-b],
+					:ctrl_alt_c => [?\e, ?\C-c],
+					:ctrl_alt_d => [?\e, ?\C-d],
+					:ctrl_alt_e => [?\e, ?\C-e],
+					:ctrl_alt_f => [?\e, ?\C-f],
+					:ctrl_alt_g => [?\e, ?\C-g],
+					:ctrl_alt_h => [?\e, ?\C-h],
+					:ctrl_alt_i => [?\e, ?\C-i],
+					:ctrl_alt_j => [?\e, ?\C-j],
+					:ctrl_alt_k => [?\e, ?\C-k],
+					:ctrl_alt_l => [?\e, ?\C-l],
+					:ctrl_alt_m => [?\e, ?\C-m],
+					:ctrl_alt_n => [?\e, ?\C-n],
+					:ctrl_alt_o => [?\e, ?\C-o],
+					:ctrl_alt_p => [?\e, ?\C-p],
+					:ctrl_alt_q => [?\e, ?\C-q],
+					:ctrl_alt_r => [?\e, ?\C-r],
+					:ctrl_alt_s => [?\e, ?\C-s],
+					:ctrl_alt_t => [?\e, ?\C-t],
+					:ctrl_alt_u => [?\e, ?\C-u],
+					:ctrl_alt_v => [?\e, ?\C-v],
+					:ctrl_alt_w => [?\e, ?\C-w],
+					:ctrl_alt_x => [?\e, ?\C-x],
+					:ctrl_alt_y => [?\e, ?\C-y],
+					:ctrl_alt_z => [?\e, ?\C-z]			
+				})
+		end
+
+	end
+
+
+end

data/lib/rawline/terminal/windows_terminal.rb

@@ -0,0 +1,66 @@
+#!/usr/local/bin/ruby -w
+
+#
+#	windows_terminal.rb
+#
+# Created by Fabio Cevasco on 2008-03-01.
+# Copyright (c) 2008 Fabio Cevasco. All rights reserved.
+#
+# This is Free Software.  See LICENSE for details.
+#
+
+module RawLine
+	
+	# 
+	# This class is used to define all the most common character codes and
+	# escape sequences used on Windows systems.
+	#
+	class WindowsTerminal < Terminal
+
+		def initialize
+			super
+			@escape_codes = [0, 27, 224]
+			@keys.merge!(
+				{
+					:left_arrow => [224, 75],
+					:right_arrow => [224, 77],
+					:up_arrow => [224, 72],
+					:down_arrow => [224, 80],
+					:insert => [224, 82],
+					:delete => [224, 83],
+					:backspace => [8],
+					:enter => [13],
+					
+					:ctrl_alt_a => [0, 30],
+					:ctrl_alt_b => [0, 48],
+					:ctrl_alt_c => [0, 46],
+					:ctrl_alt_d => [0, 32],
+					:ctrl_alt_e => [0, 63],
+					:ctrl_alt_f => [0, 33],
+					:ctrl_alt_g => [0, 34],
+					:ctrl_alt_h => [0, 35],
+					:ctrl_alt_i => [0, 23],
+					:ctrl_alt_j => [0, 36],
+					:ctrl_alt_k => [0, 37],
+					:ctrl_alt_l => [0, 26],
+					:ctrl_alt_m => [0, 32],
+					:ctrl_alt_n => [0, 31],
+					:ctrl_alt_o => [0, 24],
+					:ctrl_alt_p => [0, 25],
+					:ctrl_alt_q => [0, 16],
+					:ctrl_alt_r => [0, 19],
+					:ctrl_alt_s => [0, 31],
+					:ctrl_alt_t => [0, 20],
+					:ctrl_alt_u => [0, 22],
+					:ctrl_alt_v => [0, 47],
+					:ctrl_alt_w => [0, 17],
+					:ctrl_alt_x => [0, 45],
+					:ctrl_alt_y => [0, 21],
+					:ctrl_alt_z => [0, 44]
+				})
+		end
+
+	end
+
+
+end

data/lib/rawline/terminal.rb

@@ -0,0 +1,87 @@
+#!/usr/local/bin/ruby -w
+
+#
+#	terminal.rb
+#
+# Created by Fabio Cevasco on 2008-03-01.
+# Copyright (c) 2008 Fabio Cevasco. All rights reserved.
+#
+# This is Free Software.  See LICENSE for details.
+#
+#
+#
+module RawLine
+	
+	# 
+	# The Terminal class defines character codes and code sequences which can be
+	# bound to actions by editors.
+	# An OS-dependent subclass of RawLine::Terminal is automatically instantiated by
+	# RawLine::Editor.
+	#
+	class Terminal
+
+		include HighLine::SystemExtensions
+
+		attr_accessor :escape_codes
+		attr_reader :keys, :escape_sequences
+
+		# 
+		# Create an instance of RawLine::Terminal.
+		#
+		def initialize
+			@keys = 
+				{
+				:tab => [?\t],
+				:return => [?\r],
+				:newline => [?\n],
+				:escape => [?\e],
+
+				:ctrl_a => [?\C-a],
+				:ctrl_b => [?\C-b],
+				:ctrl_c => [?\C-c],
+				:ctrl_d => [?\C-d],
+				:ctrl_e => [?\C-e],
+				:ctrl_f => [?\C-f],
+				:ctrl_g => [?\C-g],
+				:ctrl_h => [?\C-h],
+				:ctrl_i => [?\C-i],
+				:ctrl_j => [?\C-j],
+				:ctrl_k => [?\C-k],
+				:ctrl_l => [?\C-l],
+				:ctrl_m => [?\C-m],
+				:ctrl_n => [?\C-n],
+				:ctrl_o => [?\C-o],
+				:ctrl_p => [?\C-p],
+				:ctrl_q => [?\C-q],
+				:ctrl_r => [?\C-r],
+				:ctrl_s => [?\C-s],
+				:ctrl_t => [?\C-t],
+				:ctrl_u => [?\C-u],
+				:ctrl_v => [?\C-v],
+				:ctrl_w => [?\C-w],
+				:ctrl_x => [?\C-x],
+				:ctrl_y => [?\C-y],
+				:ctrl_z => [?\C-z]
+				}
+			@escape_codes = []
+			@escape_sequences = []
+			update
+		end
+
+		#
+		# Update the terminal escape sequences. This method is called automatically
+		# by RawLine::Editor#bind().
+		#
+		def update
+			@keys.each_value do |k|
+				l = k.length
+				if  l > 1 then
+					@escape_sequences << k unless @escape_sequences.include? k
+				end
+			end
+		end
+
+	end
+
+
+end

data/lib/rawline.rb

@@ -0,0 +1,32 @@
+#!/usr/local/bin/ruby -w
+
+#
+#	RawLine.rb
+#
+# Created by Fabio Cevasco on 2008-03-01.
+# Copyright (c) 2008 Fabio Cevasco. All rights reserved.
+#
+# This is Free Software.  See LICENSE for details.
+#
+
+module RawLine
+	HOME = File.dirname(File.expand_path(__FILE__))
+	class BindingException < Exception; end
+	begin
+		WIN32CONSOLE = require "win32console" if PLATFORM.match(/win32/i)
+		ANSI = true
+	rescue
+		ANSI = false
+	end
+end
+
+require "rubygems"
+require "highline"
+require "#{RawLine::HOME}/RawLine/terminal"
+require "#{RawLine::HOME}/RawLine/terminal/windows_terminal"
+require "#{RawLine::HOME}/RawLine/terminal/vt220_terminal"
+require "#{RawLine::HOME}/RawLine/history_buffer"
+require "#{RawLine::HOME}/RawLine/line"
+require "#{RawLine::HOME}/RawLine/editor"
+
+

data/test/test_all.rb

@@ -0,0 +1,9 @@
+#!/usr/local/bin/ruby -w
+
+module RawLine
+	TEST_HOME = File.dirname(File.expand_path(__FILE__))+'/..' unless const_defined?(:TEST_HOME)
+end
+
+require "test_history_buffer"
+require "test_line"
+require "test_editor"

data/test/test_editor.rb

@@ -0,0 +1,169 @@
+#!/usr/local/bin/ruby -w
+
+module RawLine
+	TEST_HOME = File.dirname(File.expand_path(__FILE__))+'/..' unless const_defined?(:TEST_HOME)
+end
+
+require 'highline/system_extensions'
+
+module HighLine::SystemExtensions
+  # Override Windows' character reading so it's not tied to STDIN.
+  def get_character( input = STDIN )
+		input.getc
+  end
+end
+
+require 'stringio'
+require "#{RawLine::TEST_HOME}/lib/RawLine"
+
+describe RawLine::Editor do
+
+	before :each do
+		@output = StringIO.new
+		@input = StringIO.new
+		@editor = RawLine::Editor.new(@input, @output)
+	end
+
+	it "reads raw characters from @input" do
+		@input << "test #1"
+		@input.rewind
+	 	@editor.read
+		@editor.line.text.should == "test #1"
+		@output.string.should == "test #1"
+	end
+
+	it "can bind keys to code blocks" do
+		@editor.bind(:ctrl_w) { @editor.write "test #2a" }
+		@editor.bind(?\C-q) { "test #2b" }
+		@editor.bind(21) { "test #2c" }
+		@editor.bind([22]) { "test #2d" }
+		@editor.terminal.escape_codes = [] # remove any existing escape codes
+		lambda {@editor.bind({:test => [?\e, ?t, ?e, ?s, ?t]}) { "test #2e" }}.should raise_error(RawLine::BindingException)
+		@editor.terminal.escape_codes << ?\e
+		lambda {@editor.bind({:test => "\etest"}) { "test #2e" }}.should_not raise_error(RawLine::BindingException)
+		lambda {@editor.bind("\etest2") { "test #2f" }}.should_not raise_error(RawLine::BindingException)
+		@input << ?\C-w.chr
+		@input.rewind
+	 	@editor.read
+		@editor.line.text.should == "test #2a"
+		@editor.char = [?\C-q]
+		@editor.press_key.should == "test #2b"
+		@editor.char = [?\C-u]
+		@editor.press_key.should == "test #2c"
+		@editor.char = [?\C-v]
+		@editor.press_key.should == "test #2d"
+		@editor.char = [?\e, ?t, ?e, ?s, ?t]
+		@editor.press_key.should == "test #2e"
+		@editor.char = [?\e, ?t, ?e, ?s, ?t, ?2]
+		@editor.press_key.should == "test #2f"
+	end
+
+	it "keeps track of the cursor position" do
+		@input << "test #4"
+		@input.rewind
+		@editor.read
+		@editor.line.position.should == 7
+		3.times { @editor.move_left }
+		@editor.line.position.should == 4
+		2.times { @editor.move_right }
+		@editor.line.position.should == 6
+	end
+
+	it "can delete characters" do
+		@input << "test #5"
+		@input.rewind
+		@editor.read
+		3.times { @editor.move_left }
+		4.times { @editor.delete_left_character }
+		3.times { @editor.delete_character }
+		@editor.line.text.should == ""
+		@editor.line.position.should == 0
+	end
+
+	it "can clear the whole line" do
+		@input << "test #5"
+		@input.rewind
+		@editor.read
+		@editor.clear_line
+		@editor.line.text.should == ""
+		@editor.line.position.should == 0
+	end
+
+	it "supports undo and redo" do
+		@input << "test #6"
+		@input.rewind
+		@editor.read
+		3.times { @editor.delete_left_character }
+		2.times { @editor.undo }
+		@editor.line.text.should == "test #"
+		2.times { @editor.redo }
+		@editor.line.text.should == "test"
+	end
+
+	it "supports history" do
+		@input << "test #7a"
+		@input.rewind
+		@editor.read
+		@editor.newline
+		@input << "test #7b"
+		@input.pos = 8
+		@editor.read
+		@editor.newline
+		@input << "test #7c"
+		@input.pos = 16
+		@editor.read
+		@editor.newline
+		@input << "test #7d"
+		@input.pos = 24
+		@editor.read
+		@editor.newline
+		@editor.history_back
+		@editor.line.text.should == "test #7c"
+		10.times { @editor.history_back }
+		@editor.line.text.should == "test #7a"
+		2.times { @editor.history_forward }
+		@editor.line.text.should == "test #7c"
+	end
+
+	it "can overwrite lines" do
+		@input << "test #8a"
+		@input.rewind
+		@editor.read
+		@editor.overwrite_line("test #8b", 2)
+		@editor.line.text.should == "test #8b"
+		@editor.line.position.should == 2
+	end
+
+	it "can complete words" do
+		@editor.completion_append_string = "\t"
+		@editor.bind(:tab) { @editor.complete }
+		@editor.completion_proc = lambda do |word|
+	  	if word
+ 				['select', 'update', 'delete', 'debug', 'destroy'].find_all	{ |e| e.match(/^#{Regexp.escape(word)}/) }
+			end
+		end
+		@input << "test #9 de" << ?\t.chr << ?\t.chr
+		@input.rewind
+		@editor.read
+		@editor.line.text.should == "test #9 delete\t"
+	end
+
+	it "supports INSERT and REPLACE modes" do
+		@input << "test 0" 
+		@editor.terminal.keys[:left_arrow].each { |k| @input << k.chr }
+		@input << "#1"
+		@input.rewind
+		@editor.read
+		@editor.line.text.should == "test #10"
+		@editor.toggle_mode
+		@input << "test 0" 
+		@editor.terminal.keys[:left_arrow].each { |k| @input << k.chr }
+		@input << "#1"
+		@input.pos = 10
+		@editor.read
+		@editor.line.text.should == "test #1"
+	end
+	
+
+end
+