rbcurse 0.1.0

data/lib/rbcurse/listscrollable.rb

@@ -0,0 +1,216 @@
+# Provides the ability to scroll content, typically an array
+# widget that includes may override on_enter_row and on_leave_row
+# Caller should have
+#   row_count()
+#   scrollatrow() typically @height - 2 (unless a header row, then -3)
+#   @current_index (row of current index, starting with 0 usually)
+#   @toprow : set to 0 for starters, top row to be displayed
+#   @pcol (used for horiz scrolling, starts at 0)
+#
+module ListScrollable
+  def previous_row
+    @oldrow = @current_index
+    @current_index -= 1 if @current_index > 0
+    bounds_check
+  end
+  alias :up :previous_row
+  def next_row
+    @oldrow = @current_index
+    rc = row_count
+    @current_index += 1 if @current_index < rc
+    bounds_check
+  end
+  alias :down :next_row
+  def goto_bottom
+    @oldrow = @current_index
+    rc = row_count
+    @current_index = rc -1
+    bounds_check
+  end
+  alias :goto_end :goto_bottom
+  def goto_top
+    @oldrow = @current_index
+    @current_index = 0
+    bounds_check
+  end
+  alias :goto_start :goto_top
+  def scroll_backward
+    @oldrow = @current_index
+    h = scrollatrow()
+    @current_index -= h 
+    bounds_check
+  end
+  def scroll_forward
+    @oldrow = @current_index
+    h = scrollatrow()
+    rc = row_count
+    # more rows than box
+    if h < rc
+      @toprow += h+1 #if @current_index+h < rc
+      @current_index = @toprow
+    else
+      # fewer rows than box
+      @current_index = rc -1
+    end
+    #@current_index += h+1 #if @current_index+h < rc
+    bounds_check
+  end
+
+  ##
+  # please set oldrow before calling this. Store current_index as oldrow before changing. NOTE
+  def bounds_check
+    h = scrollatrow()
+    rc = row_count
+    $log.debug " PRE CURR:#{@current_index}, TR: #{@toprow} RC: #{rc} H:#{h}"
+    @current_index = 0 if @current_index < 0  # not lt 0
+    @current_index = rc-1 if @current_index >= rc # not gt rowcount
+    @toprow = rc-h-1 if rc > h and @toprow > rc - h - 1 # toprow shows full page if possible
+    # curr has gone below table,  move toprow forward
+    if @current_index - @toprow > h
+      @toprow = @current_index - h
+    elsif @current_index < @toprow
+      # curr has gone above table,  move toprow up
+      @toprow = @current_index
+    end
+    #$log.debug " POST CURR:#{@current_index}, TR: #{@toprow} RC: #{rc} H:#{h}"
+    if @oldrow != @current_index
+      $log.debug "going to call on leave and on enter"
+      on_leave_row @oldrow if respond_to? :on_leave_row     # to be defined by widget that has included this
+      on_enter_row @current_index   if respond_to? :on_enter_row  # to be defined by widget that has included this
+    end
+    set_form_row
+    @repaint_required = true
+  end
+  # the cursor should be appropriately positioned
+  def set_form_row
+    r,c = rowcol
+    @form.row = r + (@current_index-@toprow) 
+  end
+  def right
+    @hscrollcols ||= @cols/2
+    @pcol += @hscrollcols if @pcol + @hscrollcols < @padcols
+    #   window_erase @win XXX
+  end
+  def left
+    @hscrollcols ||= @cols/2
+    @pcol -= @hscrollcols if @pcol > 0
+    @pcol = 0 if @pcol < 0
+  end
+  # not that saving content_rows is buggy since we add rows.
+  ##
+  # caution, this now uses winrow not prow
+  ## for user to know which row is being focussed on
+  def focussed_index
+    @current_index # 2009-01-07 14:35 
+  end
+  # only to be used in single selection cases as focussed item FIXME.
+  # best not to use, as can be implementation dep, use current_index
+  def selected_item
+    get_content()[focussed_index()]
+  end
+  #alias :current_index :focussed_index
+  alias :selected_index :focussed_index
+  def OLDscrollable_handle_key ch
+    begin
+      ###pre_key # 2009-01-07 13:23 
+      case ch
+      when ?\C-n
+        scroll_forward
+      when 32
+        scroll_forward
+      when ?\C-p
+        scroll_backward
+      when ?0
+        #goto_start
+        goto_top
+      when ?9
+        #goto_end
+        goto_bottom
+      when KEY_UP
+        #select_prev_row
+        #up
+        $log.debug " GOT KEY UP NEW SCROLL"
+        previous_row
+      when KEY_LEFT
+      when KEY_RIGHT
+      when KEY_DOWN
+        #down
+        $log.debug " GOT KEY DOWN NEW SCROLL"
+        next_row
+      when KEY_ENTER, 10, 13
+        if respond_to? :fire
+          fire
+        end
+      when ?A..?Z, ?a..?z
+        ret = set_selection_for_char ch.chr
+      else
+        return :UNHANDLED #if ret == -1
+      end
+    ensure
+      #post_key
+    end
+  end # handle_k listb
+  ## 2008-12-18 18:03 
+  # finds the next match for the char pressed
+  # returning the index
+  def next_match char
+    data = get_content
+    row = focussed_index + 1
+    row.upto(data.length-1) do |ix|
+      val = data[ix].chomp
+      #if val[0,1] == char #and val != currval
+      if val[0,1].casecmp(char) == 0 #AND VAL != CURRval
+        return ix
+      end
+    end
+    row = focussed_index - 1
+    0.upto(row) do |ix|
+      val = data[ix].chomp
+      #if val[0,1] == char #and val != currval
+      if val[0,1].casecmp(char) == 0 #and val != currval
+        return ix
+      end
+    end
+    return -1
+  end
+  ## 2008-12-18 18:03 
+  # sets the selection to the next row starting with char
+  def set_selection_for_char char
+    @oldrow = @current_index
+    ix = next_match char
+    @current_index = ix if ix != -1
+    bounds_check
+    return ix
+  end
+
+  ##
+  # ensures that the given row is focussed
+  # new version of older one that was not perfect.
+  # 2009-01-17 13:25 
+  def set_focus_on arow
+    @oldrow = @current_index
+    @current_index = arow
+    bounds_check if @oldrow != @current_index
+  end
+  ##
+  # 2008-12-18 18:05 
+  # set focus on given index
+  def OLDset_focus_on arow
+    return if arow > row_count()-1 or arow < 0
+    @oldrow = @current_index
+    total = row_count()
+    @current_index = arow
+    sar = scrollatrow + 1
+    @toprow = (@current_index / sar) * sar
+
+    $log.debug "1 set_focus #{total}, sar #{sar}, toprow #{@toprow}, current_index #{@current_index}"
+    if total - @toprow < sar
+      @toprow = (total - sar) 
+    end
+    $log.debug "2 set_focus #{total}, sar #{sar}, toprow #{@toprow}, current_index #{@current_index}"
+    set_form_row # 2009-01-17 12:44 
+    @repaint_required = true
+    #bounds_check
+  end
+
+end

data/lib/rbcurse/listselectable.rb

@@ -0,0 +1,67 @@
+# this is a companion file to defaultlistselectionmodel
+# if you use that, include this to get all the methods to use it
+module RubyCurses
+  module ListSelectable
+
+    def list_selection_model lsm
+      @list_selection_model = lsm
+      #@list_selection_model.selection_mode = @selection_mode || :MULTIPLE
+    end
+    def create_default_list_selection_model
+      list_selection_model DefaultListSelectionModel.new
+    end
+    def is_row_selected row
+      @list_selection_model.is_selected_index row
+    end
+
+    def add_row_selection_interval ix0, ix1
+      # if row_selection_allowed
+      @list_selection_model.add_selection_interval ix0, ix1
+    end
+    def remove_row_selection_interval ix0, ix1
+      @list_selection_model.remove_selection_interval ix0, ix1
+    end
+    def toggle_row_selection row=@current_index
+      if is_row_selected row
+        $log.debug " deleting row #{row}"
+        remove_row_selection_interval(row, row)
+      else
+        $log.debug " adding row #{row}"
+        add_row_selection_interval(row, row) 
+      end
+    end
+
+    def clear_selection
+      @list_selection_model.clear_selection
+    end
+    def selected_item
+    #  @list[@current_index]
+    end
+    def selected_rows
+      @list_selection_model.get_selected_rows
+    end
+    def selected_row_count
+      selected_rows.size
+    end
+    def selected_row
+      @list_selection_model.get_min_selection_index
+    end
+    def do_next_selection
+      return if selected_rows().length == 0 
+      row = selected_rows().sort.find { |i| i > @current_index }
+      row ||= @current_index
+      @current_index = row
+      @repaint_required = true # fire list_select XXX
+    end
+    def do_prev_selection
+      return if selected_rows().length == 0 
+      row = selected_rows().sort{|a,b| b <=> a}.find { |i| i < @current_index }
+      row ||= @current_index
+      @current_index = row
+      @repaint_required = true # fire list_select XXX
+    end
+    alias :selected_index :selected_row
+    attr_accessor :row_selection_allowed
+    attr_accessor :column_selection_allowed
+  end
+end

data/lib/rbcurse/mapper.rb

@@ -0,0 +1,108 @@
+require 'rbcurse/orderedhash'
+class Mapper
+  attr_reader :keymap
+  attr_reader :view
+  attr_accessor :mode
+  attr_reader :keys
+  def initialize handler
+    #@handler = handler
+    @view = handler       # caller program
+    @keys = {}
+    @mode = nil  # used when defining
+    @pendingkeys = nil
+    @prevkey = nil   # in case of a key sequence such as C-x C-c, will have C-x
+    @arg = nil # regex matched this key.
+  end
+  def let mode, &block
+    h = OrderedHash.new
+    @keys[mode] = h
+    @mode = mode
+    instance_eval(&block)
+    $log.debug("KEYS: #{@keys[mode].inspect}")
+  end
+  def map(*args, &block)
+    if block_given?
+      # We check for cases like C-x C-c etc. Only 2 levels.
+      #args = arg.split(/ +/)
+      if args.length == 2
+        @keys[@mode][args[0]] ||= OrderedHash.new
+        @keys[@mode][args[0]][args[1]]=block
+      else
+        # single key or control key
+        @keys[@mode][args[0]]=block
+      end
+    else
+       #no block, last arg shold be a symbol
+       symb = args.pop
+       raise "If block not passed, last arg should be a method symbol" if !symb.is_a? Symbol
+       if args.length == 2
+         @keys[@mode][args[0]] ||= OrderedHash.new
+         @keys[@mode][args[0]][args[1]]=symb
+       else
+         # single key or control key
+         @keys[@mode][args[0]]=symb
+       end
+    end
+  end
+
+  ## manages key pressing
+  # takes care of multiple key combos too
+  def press key
+    $log.debug("press Got: #{key}")
+    # for a double key combination such as C-x C-c this has the set of pending keys to check against
+    if @pendingkeys != nil
+      blk = @pendingkeys[key]
+    else
+      # this is the regular single key mode
+      #blk = @keys[@view.mode][key]
+      blk = match(key)
+    end
+    # this means this key expects more keys to follow such as C-x could
+    if blk.is_a? OrderedHash
+      @pendingkeys = blk
+      @prevkey = key
+      return
+    end
+    if blk.nil? # this should go up XXX
+      if !@pendingkeys.nil?
+        # this error message to be modified if using numeric keys -- need to convert to char
+        view.info("%p not valid in %p. Try: #{@pendingkeys.keys.join(', ')}" % [key, @prevkey]) # XXX
+      else
+        view.info("%p not valid in %p. " % [key, @view.mode]) 
+      end
+      return
+    end
+    # call the block or symbol - our user defined key mappings use symbols
+    if blk.is_a? Symbol
+      @view.send(blk)
+    else
+      blk.call
+    end
+    @prevkey = nil
+    @pendingkeys = nil
+  end
+  def match key
+#       $log.debug "MATCH #key "
+      #blk = @keys[@view.mode][key]
+    @keys[@view.mode].each_pair do |k,v|
+#     $log.debug "LOOP #{k.class}, #{k}, #{v} "
+      case k.class.to_s
+      when "String"
+        return v if k == key
+      when "Fixnum" # for keyboard2
+     $log.debug "FIXNUM LOOP #{k.class}, #{k}, #{v} "
+        return v if k == key
+      when "Regexp"
+#       $log.debug "REGEX #key , #k, #{k.match(key)}"
+        key = key.chr if key.is_a? Fixnum
+        if !k.match(key).nil?
+          @arg = key
+          return v 
+        end
+      else
+        $log.error "MATCH: Unhandled class #{k.class} "
+      end
+    end
+    return nil
+  end
+end

data/lib/rbcurse/orderedhash.rb

@@ -0,0 +1,77 @@
+## Insert order preserving hash
+# Thanks to Bill Kelly, posted on http://www.ruby-forum.com/topic/166075
+#
+class OrderedHash
+  include Enumerable
+
+  def initialize(*args, &block)
+    @h = Hash.new(*args, &block)
+    @ordered_keys = []
+  end
+
+  def []=(key, val)
+    @ordered_keys << key unless @h.has_key? key
+    @h[key] = val
+  end
+
+  def each
+    @ordered_keys.each {|k| yield(k, @h[k])}
+  end
+  alias :each_pair :each
+
+  def each_value
+    @ordered_keys.each {|k| yield(@h[k])}
+  end
+
+  def each_key
+    @ordered_keys.each {|k| yield k}
+  end
+
+  def keys
+    @ordered_keys
+  end
+
+  def values
+    @ordered_keys.map {|k| @h[k]}
+  end
+
+  def clear
+    @ordered_keys.clear
+    @h.clear
+  end
+
+  def delete(k, &block)
+    @ordered_keys.delete k
+    @h.delete(k, &block)
+  end
+
+  def reject!
+    del = []
+    each_pair {|k,v| del << k if yield k,v}
+    del.each {|k| delete k}
+    del.empty? ? nil : self
+  end
+
+  def delete_if(&block)
+    reject!(&block)
+    self
+  end
+  ## added since the normal hash will give it in unordered. so debugging sucks
+  def inspect
+    out = []
+    each do | k,v |
+      out << " #{k} => #{v} "
+    end
+    res = %Q[  { #{out.join(",\n ")} } ]
+  end
+
+  %w(merge!).each do |name|
+    define_method(name) do |*args|
+      raise NotImplementedError, "#{name} not implemented"
+    end
+  end
+
+  def method_missing(*args)
+    @h.send(*args)
+  end
+end

data/lib/rbcurse/rcombo.rb

@@ -0,0 +1,243 @@
+=begin
+  * Name: combo box
+  * Description: 
+  * Author: rkumar
+  
+  --------
+  * Date:  2008-12-16 22:03 
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+=end
+require 'rubygems'
+require 'ncurses'
+require 'logger'
+require 'rbcurse'
+require 'rbcurse/rlistbox'
+
+include Ncurses
+include RubyCurses
+module RubyCurses
+  META_KEY = 128
+  extend self
+
+  # TODO : 
+  # i no longer use values, i now use "list" or better "list_data_model"
+  # try to make it so values gets converted to list.
+  class ComboBox < Field
+    include RubyCurses::EventHandler
+    dsl_accessor :list_config
+    dsl_accessor :insert_policy # NO_INSERT, INSERT_AT_TOP, INSERT_AT_BOTTOM, INSERT_AT_CURRENT
+    # INSERT_AFTER_CURRENT, INSERT_BEFORE_CURRENT,INSERT_ALPHABETICALLY
+
+    attr_accessor :current_index
+    # the symbol you want to use for combos
+    attr_accessor :COMBO_SYMBOL
+    attr_accessor :show_symbol # show that funny symbol after a combo to signify its a combo
+
+    def initialize form, config={}, &block
+      super
+      @current_index ||= 0
+      # added if  check since it was overriding set_buffer in creation. 2009-01-18 00:03 
+      set_buffer @list[@current_index].dup if @buffer.nil? or @buffer.empty?
+      init_vars
+    end
+    def init_vars
+      super
+      @show_symbol ||= true
+      @COMBO_SYMBOL ||= Ncurses::ACS_GEQUAL
+      bind_key(KEY_UP) { previous_row }
+      bind_key(KEY_DOWN) { next_row }
+    end
+    def selected_item
+      @list[@current_index]
+    end
+    def selected_index
+      @current_index
+    end
+
+    ##
+    # convert given list to datamodel
+    def list alist=nil
+      return @list if alist.nil?
+      @list = RubyCurses::ListDataModel.new(alist)
+    end
+    ##
+    # set given datamodel
+    def list_data_model ldm
+      raise "Expecting list_data_model" unless ldm.is_a? RubyCurses::ListDataModel
+      @list = ldm
+    end
+    ##
+    # combo edit box key handling
+    # removed UP and DOWN and bound it, so it can be unbound
+    def handle_key(ch)
+      @current_index ||= 0
+      # added 2009-01-18 22:44 no point moving horiz or passing up to Field if not edit
+      if !@editable
+        if ch == KEY_LEFT or ch == KEY_RIGHT
+          return :UNHANDLED
+        end
+      end
+      case ch
+      #when KEY_UP  # show previous value
+      #  previous_row
+      #when KEY_DOWN  # show previous value
+      #  next_row
+      when KEY_DOWN+ RubyCurses::META_KEY # alt down
+        popup  # pop up the popup
+      else
+        super
+      end
+    end
+    def previous_row
+      @current_index -= 1 if @current_index > 0
+      set_buffer @list[@current_index].dup
+      set_modified(true)  ## ??? not required
+      fire_handler :ENTER_ROW, self
+      @list.on_enter_row self
+    end
+    def next_row
+      @current_index += 1 if @current_index < @list.length()-1
+      set_buffer @list[@current_index].dup
+      set_modified(true)  ## ??? not required
+      fire_handler :ENTER_ROW, self
+      @list.on_enter_row self
+    end
+    ##
+    # calls a popup list
+    # TODO: should not be positioned so that it goes off edge
+    # user's customizations of list should be passed in
+    # The dup of listconfig is due to a tricky feature/bug.
+    # I try to keep the config hash and instance variables in synch. So
+    # this config hash is sent to popuplist which updates its row col and
+    # next time we pop up the popup row and col are zero.
+    #
+    # 
+    # added dup in PRESS since editing edit field mods this
+    # on pressing ENTER, value set back and current_index updated
+    def popup
+      listconfig = (@list_config && @list_config.dup) || {}
+      dm = @list
+      # current item in edit box will be focussed when list pops up
+      #$log.debug "XXX POPUP: #{dm.selected_index} = #{@current_index}, value #{@buffer}"
+      # we are having some problms when using this in a list. it retains earlier value
+      _index = dm.index @buffer
+      dm.selected_index = _index #  @current_index
+      poprow = @row+0 # one row below the edit box
+      popcol = @col
+      dlength = @display_length
+      f = self
+      @popup = RubyCurses::PopupList.new do
+        row  poprow
+        col  popcol
+        width dlength
+        list_data_model dm
+        list_selection_mode 'single'
+        relative_to f
+        list_config listconfig
+        bind(:PRESS) do |index|
+          f.set_buffer dm[index].dup
+          f.set_modified(true) if f.current_index != index
+          f.current_index = index
+        end
+      end
+    end
+
+    # Field putc advances cursor when it gives a char so we override this
+    def putc c
+      if c >= 0 and c <= 127
+        ret = putch c.chr
+        if ret == 0
+          addcol 1 if @editable
+          set_modified 
+        end
+      end
+      return -1 # always ??? XXX 
+    end
+    ##
+    # field does not give char to non-editable fields so we override
+    def putch char
+      @current_index ||= 0
+      if @editable 
+        super
+        return 0
+      else
+        match = next_match(char)
+        set_buffer match unless match.nil?
+        fire_handler :ENTER_ROW, self
+      end
+      @modified = true
+      fire_handler :CHANGE, self    # 2008-12-09 14:51  ???
+      0
+    end
+    ##
+    # the sets the next match in the edit field
+    def next_match char
+      start = @current_index
+      start.upto(@list.length-1) do |ix|
+        if @list[ix][0,1].casecmp(char) == 0
+          return @list[ix] unless @list[ix] == @buffer
+        end
+        @current_index += 1
+      end
+      ## could not find, start from zero
+      @current_index = 0
+      start = [@list.length()-1, start].min
+      0.upto(start) do |ix|
+        if @list[ix][0,1].casecmp(char) == 0
+          return @list[ix] unless @list[ix] == @buffer
+        end
+        @current_index += 1
+      end
+      @current_index = [@list.length()-1, @current_index].min
+      return nil
+    end
+    ##
+    # on leaving the listbox, update the combo/datamodel.
+    # we are using methods of the datamodel. Updating our list will have
+    # no effect on the list, and wont trigger events.
+    # Do not override.
+    def on_leave
+      if !@list.include? @buffer and !@buffer.strip.empty?
+        _insert_policy = @insert_policy || :INSERT_AT_BOTTOM
+        case _insert_policy
+        when :INSERT_AT_BOTTOM, :INSERT_AT_END
+          @list.append  @buffer
+        when :INSERT_AT_TOP
+          @list.insert(0, @buffer)
+        when :INSERT_AFTER_CURRENT
+          @current_index += 1
+          @list.insert(@current_index, @buffer)
+
+        when :INSERT_BEFORE_CURRENT
+          #_index = @current_index-1 if @current_index>0
+          _index = @current_index
+          @list.insert(_index, @buffer)
+        when :INSERT_AT_CURRENT
+          @list[@current_index]=@buffer
+        when :NO_INSERT
+          ; # take a break
+        end
+      end
+      fire_handler :LEAVE, self
+    end
+
+    def repaint
+      super
+      c = @col + @display_length
+     # @form.window.mvwvline( @row, c, ACS_VLINE, 1)
+      if @show_symbol # 2009-01-11 18:47 
+        # i have changed c +1 to c, since we have no right to print beyond display_length
+        @form.window.mvwaddch @row, c, @COMBO_SYMBOL # Ncurses::ACS_GEQUAL
+      end
+     # @form.window.mvwvline( @row, c+2, ACS_VLINE, 1)
+     # @form.window.mvwaddch @row, c+2, Ncurses::ACS_S1
+     # @form.window.mvwaddch @row, c+3, Ncurses::ACS_S9
+     # @form.window.mvwaddch @row, c+4, Ncurses::ACS_LRCORNER
+     # @form.window.mvwhline( @row, c+5, ACS_HLINE, 2)
+    end
+
+  end # class ComboBox
+
+end # module