window_blessing 0.0.1

data/lib/window_blessing/xterm_input.rb

@@ -0,0 +1,40 @@
+
+module WindowBlessing
+class XtermInput
+  attr_reader :event_parser
+
+  def initialize
+    @event_parser = XtermEventParser.new
+  end
+
+  def read_events
+    events = []
+    if raw = read_pending_input
+      parsed = event_parser.parse(raw)
+      if parsed
+        new_events = parsed.events
+        events += new_events
+        new_events.length
+      else
+        events << {:type => :event_parser_failure, :raw => raw, :failure_info => event_parser.parser_failure_info}
+      end
+    end
+    events
+  end
+
+  private
+  def read_pending_input
+    read = nil
+    begin
+      while c = STDIN.read_nonblock(1000)
+        read = read ? read + c : c
+      end
+    rescue Errno::EAGAIN  # nothing was ready to be read
+    rescue Errno::EINTR
+    rescue EOFError
+    end
+    read
+  end
+
+end
+end

data/lib/window_blessing/xterm_log.rb

@@ -0,0 +1,7 @@
+module WindowBlessing
+class XtermLog
+  def self.log(str)
+    File.open("xterm.log","a+") {|f| f.puts str}
+  end
+end
+end

data/lib/window_blessing/xterm_output.rb

@@ -0,0 +1,213 @@
+# ref: http://invisible-island.net/xterm/ctlseqs/ctlseqs.html
+# ref: http://www.vt100.net/docs/vt102-ug/chapter5.html
+
+module WindowBlessing
+
+class XtermOutput
+  module SetColor
+    def change_fg(fg)
+      set_fg(fg) if fg!=@current_fg
+      @current_fg = fg
+    end
+
+    def change_bg(bg)
+      set_bg(bg) if bg!=@current_bg
+      @current_bg = bg
+    end
+
+    def set_fg(fg)
+      out "\x1b[38;5;#{fg}m"
+    end
+
+    def set_bg(bg)
+      out "\x1b[48;5;#{bg}m"
+    end
+
+    attr_reader :current_fg, :current_bg
+
+    def set_color(fg, bg=nil)
+      set_fg(fg) if fg
+      set_bg(bg) if bg
+    end
+
+    # fg and bg are r-g-b arrays: [0..255, 0..255, 0..255]
+    # This is not supported by iTerm2: http://code.google.com/p/iterm2/issues/detail?id=218
+    # konsole supports it: https://github.com/robertknight/konsole/blob/master/user-doc/README.moreColors
+    def set_color_24bit(fg, bg=nil)
+      out "\x1b[38;2;#{fg.join(';')}m" if fg
+      out "\x1b[48;2;#{bg.join(';')}m" if bg
+    end
+
+    def reset_color
+      @current_fg = 7
+      @current_bg = 0
+      out "\x1b[0m"
+    end
+
+    def out_color(txt, fg, bg)
+      set_color(fg, bg)
+      out txt
+      reset_color
+    end
+
+    def set_bold; out "\x1b[1m" end
+    def set_underline; out "\x1b[4m" end
+  end
+  include SetColor
+
+  module SetState
+    def show_cursor; out "\e[?25h"; end
+    def hide_cursor; out "\e[?25l"; end
+
+    def enable_mouse; out "\e[?1003h"; end
+    def disable_mouse; out "\e[?1003l"; end
+
+    def enable_focus_events; out "\e[?1004h" end
+    def disable_focus_events; out "\e[?1004l" end
+
+    def enable_utf8; out "\e%G" end
+    def disable_utf8; out "\e%@" end
+
+    def enable_alternate_screen
+      out "\e7"
+      out "\e[?47h"
+    end
+
+    def disable_alternate_screen
+      out "\e[?47l"
+      out "\e8"
+    end
+
+    # TODO: find out what stty raw -echo sends to xterm
+    # INTERNAL NOTE: out "\e[12h" # should turn off echo according to doc, but didn't work
+    # http://stackoverflow.com/questions/174933/how-to-get-a-single-character-without-pressing-enter
+    def echo_off; system "stty raw -echo"; end
+
+    # INTERNAL NOTE: out "\e[12l" # should turn echo back on
+    def echo_on; system "stty -raw echo"; end
+
+=begin
+raw may set the following:
+00830         option(x + "-icrnl", ""); /* map CR to NL on input */
+00831         option(x + "-ixon", "");  /* enable start/stop output control */
+00832         option(x + "-opost", ""); /* perform output processing */
+00833         option(x + "-onlcr", ""); /* Map NL to CR-NL on output */
+00834         option(x + "-isig", "");  /* enable signals */
+00835         option(x + "-icanon", "");/* canonical input (erase and kill enabled) */
+00836         option(x + "-iexten", "");/* enable extended functions */
+00837         option(x + "-echo", "");  /* enable echoing of input characters */
+
+=end
+
+    # This seems to work - or at least it does SOMETHING
+    # def insert_mode; out "\e[4m"; end
+    # def replace_mode; out "\e[4l"; end
+
+  end
+  include SetState
+
+  attr_accessor :xterm_state
+
+  def initialize(xterm_state)
+    @xterm_state = xterm_state
+  end
+
+  # cursor 0, 0 is the upper left hand corner
+  # cursor point(0, 0) is also accepted
+  def cursor(loc_or_x, y=nil)
+    loc = y ? point(loc_or_x,y) : loc_or_x
+    out "\e[#{loc.y+1};#{loc.x+1}H"
+  end
+
+  # raw screen output
+  def out(str)
+    $stdout.print str
+    str
+  end
+
+  def out_at(loc, str)
+    cursor(loc)
+    out str
+  end
+
+  def out_at_with_color(loc, str, fg, bg)
+    return unless str.length > 0
+    cursor loc
+
+    change_fg fg[0]
+    change_bg bg[0]
+
+    current_attrs = [current_fg, current_bg]
+
+    next_output_pos = 0
+    pos = 0
+
+    fg.zip(bg).each do |attrs|
+      if current_attrs!=attrs
+        out str[next_output_pos..pos-1]
+        change_fg attrs[0]
+        change_bg attrs[1]
+        current_attrs = attrs
+        next_output_pos = pos
+      end
+      pos += 1
+    end
+    out str[next_output_pos..-1]
+  end
+
+  def draw_buffer(loc, buffer)
+    loc = loc.clone
+    reset_color
+    buffer.each_line do |line,fg,bg|
+      out_at_with_color loc, line, fg, bg
+      loc.y += 1
+    end
+  end
+
+  # convert all \n to \n\r
+  def puts(s=nil)
+    width = xterm_state.size.x
+    lines = "#{s}\n".split("\n").collect do |line|
+      line + " " * (width - (line.length % width))
+    end
+    out lines.flatten.join "\n"
+  end
+
+  def clear; out "\e[2J"; end
+
+
+  # INTERNAL NOTE: xterm returns 3 numbers: ?, height, width
+  # Xterm sends back response as an escape sequence. XtermEventParser knows how to capture and interpret the result.
+  def request_xterm_size; out "\e[18t"; end
+
+  # INTERNAL NOTE: xterm returns 3 numbers: ?, height, width
+  # This returns the entire screen size in pixels - not just the pixel-size of the x-term
+  def request_display_pixel_size; out "\e[14t"; end
+
+  def request_cursor_position; out "\e[?6n"; end
+
+  def request_state_update
+    request_xterm_size
+    request_display_pixel_size
+  end
+
+  def enable_resize_events
+    Signal.trap "SIGWINCH" do
+      request_xterm_size
+    end
+  end
+
+  def disable_resize_events
+    Signal.trap "SIGWINCH", "DEFAULT"
+  end
+
+  def reset_all
+    disable_focus_events
+    disable_mouse
+    disable_resize_events
+    reset_color
+    show_cursor
+    echo_on
+  end
+end
+end

data/lib/window_blessing/xterm_screen.rb

@@ -0,0 +1,109 @@
+module WindowBlessing
+class XtermScreen
+  include GuiGeo
+  include GuiGeo::Tools
+
+  attr_accessor :input, :output, :event_manager, :state, :event_queue
+
+  def initialize
+    @event_manager = EventManager.new(self)
+    @state = XtermState.new @event_manager
+    @input = XtermInput.new
+    @output = XtermOutput.new(@state)
+    @running = true
+    @pending_events = []
+    @event_queue = EventQueue.new
+
+    @event_manager.add_handler :key_press do |event|
+      quit if event[:key]==:control_q
+    end
+  end
+
+  def inspect
+    "<#{self.class}:#{object_id}>"
+  end
+
+  def quit; @running = false; end
+  def running?; @running; end
+
+  def queue_event(e); event_queue << e end
+  def queued_events?; !event_queue.empty? end
+
+  def queue_pending_xterm_events
+    event_queue << input.read_events
+  end
+
+  def wait_for_events(max=100)
+    count = max
+    while !queued_events? && count > 0
+      queue_pending_xterm_events
+      count -= 1
+      sleep 0.01
+    end
+    raise "no events!" unless queued_events?
+  end
+
+  def process_queued_events
+    event_manager.handle_events event_queue.pop_all
+  end
+
+  def process_events
+    queue_pending_xterm_events
+    queue_event :type => :tick
+    process_queued_events
+  end
+
+  def event_loop
+    while running?
+      process_events
+      sleep 1/60.0
+    end
+  end
+
+  def initialize_screen
+    output.request_state_update
+    wait_for_events
+    process_events
+  end
+
+  # run xterm raw-session
+  # options
+  #
+  def start(options={})
+    in_xterm_state(options) do
+      initialize_screen
+      yield self
+      event_loop
+    end
+  end
+
+
+  # options
+  #   :mouse => true
+  #   :no_cursor => true
+  #   :alternate_screen => true
+  #   :full => true (enables all above features)
+  #   :utf8
+  def in_xterm_state(options = {})
+    output.echo_off
+    output.enable_alternate_screen  if options[:full] || options[:alternate_screen]
+    output.enable_mouse             if options[:full] || options[:mouse]
+    output.hide_cursor              if options[:full] || options[:no_cursor]
+    output.enable_utf8              if options[:utf8]
+    output.enable_focus_events
+    output.enable_resize_events
+    output.clear
+
+    yield self
+  ensure
+    output.reset_all
+    output.disable_utf8             if options[:utf8]
+    if options[:full] || options[:alternate_screen]
+      output.reset_color
+      output.clear
+      output.disable_alternate_screen
+    end
+  end
+
+end
+end

data/lib/window_blessing/xterm_state.rb

@@ -0,0 +1,27 @@
+module WindowBlessing
+class XtermState
+  attr_accessor :state
+
+  def initialize(event_manager)
+    @state = {:size => point(-1,-1)}
+
+    event_manager.add_handler :xterm_state do |event|
+      state_type = event[:state_type]
+      old_state = state[state_type]
+      new_state = event[:state]
+      state[state_type] = new_state
+      if old_state!=new_state
+        case state_type
+        when :size
+          event_manager.handle_event :type => :resize, :old_size => old_state, :size => new_state, :raw => event[:raw]
+        else
+          event_manager.handle_event :type => :state_change, :state_type => state_type, :old_state => old_state, :state => new_state, :raw => event[:raw]
+        end
+
+      end
+    end
+  end
+
+  def size; state[:size] end
+end
+end

data/spec/buffer_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+module WindowBlessing
+describe "Buffer" do
+  include Tools
+
+  def test_frame(options={})
+    buffer(point(4,4), {:contents => %w{1234 2345 3456 4567}}.merge(options))
+  end
+
+  it "blank fb" do
+    buffer(point(4,4)).to_s.should == "    \n    \n    \n    "
+  end
+
+  it "string init" do
+    buffer(point(4,4),:contents => ["hi","there"]).to_s.should == "hi  \nther\n    \n    "
+    buffer(point(4,4),:contents => "hi\nthere").to_s.should == "hi  \nther\n    \n    "
+    buffer(point(4,4),:contents => "hi\n\t\0here").to_s.should == "hi  \n??he\n    \n    "
+  end
+
+  it "inspect" do
+    buffer(point 4,4).inspect.class.should == String
+  end
+
+  it "invalid init" do
+    expect { buffer(point(4,4),:contents => 1) }.to raise_error
+  end
+
+  it "subbuffer" do
+    test_frame.subbuffer(rect(1,1,2,2)).to_s.should == "34\n45"
+  end
+
+  it "array init" do
+    test_frame.to_s.should == "1234\n2345\n3456\n4567"
+  end
+
+  it "crop" do
+    (f=buffer(point 4,4)).cropped(rect(1,1,2,2)) do
+      f.crop_area.should == rect(1,1,2,2)
+      f.cropped?.should == true
+    end
+  end
+
+  it "fill" do
+    fb = buffer(point(4,4))
+    fb.fill :string => "-"
+    fb.to_s.should == "----\n----\n----\n----"
+  end
+
+  it "cropped fill" do
+    (f=test_frame).cropped(rect(1,1,2,1)) do
+      f.fill :string => '-'
+    end.to_s.should == "1234\n2--5\n3456\n4567"
+  end
+
+  it "draw_rect" do
+    (f=buffer(point(4,4))).to_s.should == "    \n    \n    \n    "
+    f.draw_rect(rect(1,0,2,2),:string => "-")
+    f.to_s.should == " -- \n -- \n    \n    "
+  end
+
+  it "clear" do
+    fb = buffer(point 2,2).fill(:string => '-')
+    fb.to_s.should == "--\n--"
+    fb.clear
+    fb.to_s.should == "  \n  "
+  end
+
+  it "draw_buffer" do
+    f1 = test_frame
+    f2 = buffer(point(2,2), :contents => "ab\nbc")
+    f1.draw_buffer(point(1,1),f2)
+    f1.to_s.should == "1234\n2ab5\n3bc6\n4567"
+  end
+
+  it "cropped draw_buffer" do
+    f1 = test_frame
+    f2 = buffer(point(2,2), :contents => "ab\nbc")
+    f1.cropped(rect(1,1,2,1)) do
+      f1.draw_buffer(point(1,1),f2)
+    end.to_s.should == "1234\n2ab5\n3456\n4567"
+  end
+
+  it "fill only overwrites what is provided" do
+    f0 = test_frame :bg => 9, :fg => 8
+
+    f1 = f0.clone
+    f1.to_s.should == "1234\n2345\n3456\n4567"
+    f1.fg_buffer.should == [[8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8]]
+    f1.bg_buffer.should == [[9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9]]
+
+    f1.fill :string => "!"
+    f1.to_s.should == "!!!!\n!!!!\n!!!!\n!!!!"
+    f1.fg_buffer.should == [[8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8]]
+    f1.bg_buffer.should == [[9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9]]
+
+    f1 = f0.clone
+    f1.fill :bg => 0
+    f1.to_s.should == "1234\n2345\n3456\n4567"
+    f1.fg_buffer.should == [[8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8]]
+    f1.bg_buffer.should == [[0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0]]
+
+    f1 = f0.clone
+    f1.fill :fg => 0
+    f1.to_s.should == "1234\n2345\n3456\n4567"
+    f1.fg_buffer.should == [[0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0]]
+    f1.bg_buffer.should == [[9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9]]
+  end
+
+  it "cropped fill only overwrites what is provided" do
+    f0 = test_frame :bg => 9, :fg => 8
+
+    f1 = f0.clone
+    f1.to_s.should == "1234\n2345\n3456\n4567"
+    f1.fg_buffer.should == [[8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8]]
+    f1.bg_buffer.should == [[9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9]]
+
+    f1.cropped(rect(1,1,2,2)) {f1.fill :string => "!"}
+    f1.to_s.should == "1234\n2!!5\n3!!6\n4567"
+    f1.fg_buffer.should == [[8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8]]
+    f1.bg_buffer.should == [[9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9]]
+
+    f1 = f0.clone
+    f1.cropped(rect(1,1,2,2)) {f1.fill :bg => 0}
+    f1.to_s.should == "1234\n2345\n3456\n4567"
+    f1.fg_buffer.should == [[8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8], [8, 8, 8, 8]]
+    f1.bg_buffer.should == [[9, 9, 9, 9], [9, 0, 0, 9], [9, 0, 0, 9], [9, 9, 9, 9]]
+
+    f1 = f0.clone
+    f1.cropped(rect(1,1,2,2)) {f1.fill :fg => 0}
+    f1.to_s.should == "1234\n2345\n3456\n4567"
+    f1.fg_buffer.should == [[8, 8, 8, 8], [8, 0, 0, 8], [8, 0, 0, 8], [8, 8, 8, 8]]
+    f1.bg_buffer.should == [[9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9], [9, 9, 9, 9]]
+  end
+
+  it "dirty" do
+    f1 = test_frame
+    f1.dirty?.should == false
+    f1.dirty rect(1,2,3,4)
+    f1.dirty?.should == true
+
+    f1.dirty_area.should == rect(1,2,3,2)
+
+    s = f1.dirty_subbuffer
+    s.to_s.should == "456\n567"
+
+    f1.clean
+    f1.dirty?.should == false
+  end
+
+  it "on_dirty" do
+    f1 = test_frame
+
+    is_now_dirty = false
+    f1.on_dirty do
+      is_now_dirty = true
+    end
+    is_now_dirty.should == false
+    f1.dirty
+    is_now_dirty.should == true
+  end
+
+  it "color buffers" do
+    f1 = test_frame
+
+    f1.fg_buffer.should == [[7, 7, 7, 7], [7, 7, 7, 7], [7, 7, 7, 7], [7, 7, 7, 7]]
+    f1.bg_buffer.should == [[0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0], [0, 0, 0, 0]]
+  end
+end
+end