rkumar-rbcurse 0.1.0

data/lib/rbcurse/defaultlistselectionmodel.rb

@@ -0,0 +1,49 @@
+module RubyCurses
+  class DefaultListSelectionModel
+    include EventHandler
+    attr_accessor :selection_mode
+    attr_reader :anchor_selection_index
+    attr_reader :lead_selection_index
+    def initialize
+      @selected_indices=[]
+      @anchor_selection_index = -1
+      @lead_selection_index = -1
+      @selection_mode = :MULTIPLE
+    end
+
+    def clear_selection
+      @selected_indices=[]
+    end
+    def is_selected_index ix
+      @selected_indices.include? ix
+    end
+    def get_max_selection_index
+      @selected_indices[-1]
+    end
+    def get_min_selection_index
+      @selected_indices[0]
+    end
+    def get_selected_rows
+      @selected_indices
+    end
+    ## TODO should go in sorted, and no dupes
+    def add_selection_interval ix0, ix1
+      if @selection_mode != :MULTIPLE
+        clear_selection
+      end
+      @anchor_selection_index = ix0
+      @lead_selection_index = ix1
+      ix0.upto(ix1) {|i| @selected_indices  << i unless @selected_indices.include? i }
+    end
+    def remove_selection_interval ix0, ix1
+      @anchor_selection_index = ix0
+      @lead_selection_index = ix1
+      @selected_indices.delete_if {|x| x >= ix0 and x <= ix1}
+    end
+    def insert_index_interval ix0, len
+      @anchor_selection_index = ix0
+      @lead_selection_index = ix0+len
+      add_selection_interval @anchor_selection_index, @lead_selection_index
+    end
+  end # class DefaultListSelectionModel
+end

data/lib/rbcurse/keylabelprinter.rb

@@ -0,0 +1,143 @@
+require 'rbcurse/rwidget'
+include Ncurses
+include RubyCurses
+module RubyCurses
+  class KeyLabelPrinter < Widget
+    attr_reader :key_labels
+    dsl_property :mode
+
+    def initialize form, key_labels, config={}, &block
+
+      super form, config, &block
+      @mode ||= :normal
+      #@key_labels = key_labels
+      @key_hash = {}
+      @key_hash[@mode] = key_labels
+      @editable = false
+      @focusable = false
+      @cols ||= Ncurses.COLS-1
+      @row ||= Ncurses.LINES-3
+      @col ||= 0
+      @repaint_required = true
+      @footer_color_pair ||= $bottomcolor
+      @footer_mnemonic_color_pair ||= $reversecolor #2
+    end
+    def key_labels mode=@mode
+      @key_hash[mode]
+    end
+    # returns the keys as printed. these may or may not help
+    # in validation depedign on what you passed as zeroth index
+    def get_current_keys
+      a = []
+      @key_hash[@mode].each do |arr|
+        a << arr[0] unless arr.nil?
+      end
+      return a
+    end
+    def getvalue
+      @key_hash
+    end
+    def set_key_labels _key_labels, mode=:normal
+      @key_hash[mode] = _key_labels
+    end
+
+    ##
+    # XXX need to move wrapping etc up and done once. 
+    def repaint
+      return unless @repaint_required
+      r,c = rowcol
+      print_key_labels(arr = key_labels(), mode=@mode)
+      @repaint_required = false
+    end
+    def append_key_label key, label, mode=@mode
+      @key_labels << [key, label] if !@key_labels.include? [key, label]
+      @repaint_required = true
+    end
+    def print_key_labels(arr = key_labels(), mode=@mode)
+      #return if !@show_key_labels # XXX
+      @win ||= @form.window
+      @padding = @cols / (arr.length/2)
+      posx = 0
+      even = []
+      odd = []
+      arr.each_index { |i|
+        if i % 2 == 0
+          #arr[i+1] = ['',''] if arr[i+1].nil?
+          nextarr = arr[i+1] || ['', '']
+          keyw = [arr[i][0].length, nextarr[0].length].max
+          labelw = [arr[i][1].length, nextarr[1].length].max
+
+          even << [ sprintf("%*s", keyw,  arr[i][0]), sprintf("%-*s", labelw,  arr[i][1]) ]
+          odd << [ sprintf("%*s", keyw,  nextarr[0]), sprintf("%-*s", labelw,  nextarr[1]) ]
+          #$log.debug("loop even: #{even.inspect}")
+        else
+        end
+      }
+      #$log.debug("even: #{even.inspect}")
+      #$log.debug("odd : #{odd.inspect}")
+      #posy = @barrow-1
+      posy = @row
+      print_key_labels_row(posy, posx, even)
+      posy = @row+1
+      print_key_labels_row(posy, posx, odd)
+      #@win.wrefresh   # needed else secod row not shown after askchoice XXX
+    end
+    def print_key_labels_row(posy, posx, arr)
+      # FIXME: this logic of padding needs to take into account
+      # width of window
+      padding = 8
+      padding = 4 if arr.length > 5
+      padding = 2 if arr.length > 7
+      padding = 0 if arr.length > 9
+      #padding = @padding # XXX 2008-11-13 23:01 
+      my_form_win = @win
+      @win.printstring(posy,0, "%-*s" % [@cols," "], @footer_color_pair, @attr)
+      arr.each do |kl|
+        key = kl[0]
+        lab = kl[1]
+        if key !="" # don't print that white blank space for fillers
+          color_pair= @footer_mnemonic_color_pair # $reversecolor #2
+          x = posx +  (key.length - key.strip.length)
+          my_form_win.attron(Ncurses.COLOR_PAIR(color_pair))
+          my_form_win.mvprintw(posy, x, "%s" % kl[0].strip );
+          my_form_win.attroff(Ncurses.COLOR_PAIR(color_pair))
+        end
+        color_pair=@footer_color_pair
+        posx = posx + kl[0].length 
+        my_form_win.attron(Ncurses.COLOR_PAIR(color_pair))
+
+        #lab = sprintf(" %s %*s" , kl[1], padding, " ");
+        lab = sprintf(" %s %s" , kl[1], " "*padding);
+        my_form_win.mvprintw(posy, posx, lab)
+        my_form_win.attroff(Ncurses.COLOR_PAIR(color_pair))
+        posx = posx +  lab.length
+      end
+    end
+    ##
+    # updates existing label with a new one.
+    # @return true if updated, else false
+    def update_application_key_label(display_code, new_display_code, text)
+      @repaint_required = true
+      labels = key_labels()
+      labels.each_index do |ix|
+        lab = labels[ix]
+        if lab[0] == display_code
+          labels[ix] = [new_display_code , text]
+          $log.debug("updated #{labels[ix]}")
+          return true
+        end
+      end
+      return false
+    end
+    ##
+    # inserts an application label at given index
+    # to add the key, use create_datakeys to add bindings
+    # remember to call restore_application_key_labels after updating/inserting
+    def insert_application_key_label(index, display_code, text)
+      @repaint_required = true
+      labels = key_labels()
+      labels.insert(index, [display_code , text] )
+    end
+    # ADD HERE KEYLABEL
+  end
+end

data/lib/rbcurse/listcellrenderer.rb

@@ -0,0 +1,99 @@
+require 'rubygems'
+require 'ncurses'
+require 'logger'
+require 'rbcurse/rwidget'
+module RubyCurses
+
+  ## 
+  # This is a basic list cell renderer that will render the to_s value of anything.
+  # Using alignment one can use for numbers too.
+  # However, for booleans it will print true and false. If editing, you may want checkboxes
+  class ListCellRenderer
+    #include DSL
+    #include EventHandler
+    include RubyCurses::ConfigSetup
+    include RubyCurses::Utils
+    dsl_accessor :justify     # :right, :left, :center  # added 2008-12-22 19:02 
+    dsl_accessor :display_length     #  please give this to ensure the we only print this much
+    dsl_accessor :height    # if you want a multiline label.
+    dsl_accessor :text    # text of label
+    dsl_accessor :color, :bgcolor
+    dsl_accessor :row, :col
+    dsl_accessor :parent    #usuall the table to get colors and other default info
+
+    def initialize text="", config={}, &block
+      @text = text
+      @editable = false
+      @focusable = false
+      config_setup config # @config.each_pair { |k,v| variable_set(k,v) }
+      instance_eval &block if block_given?
+      init_vars
+    end
+    def init_vars
+      @justify ||= :left
+      @display_length ||= 10
+    end
+    def getvalue
+      @text
+    end
+    ##
+    # sets @color_pair and @attr
+    def prepare_default_colors focussed, selected
+        @color_pair = get_color $datacolor
+        #acolor =get_color $datacolor, @color || @parent.color, @bgcolor || @parent.bgcolor #unless @parent.nil?
+        @attr = @row_attr || Ncurses::A_NORMAL
+        ##@row_attr = Ncurses::A_NORMAL # added 2009-02-04 18:35 since overriding in rfe
+
+
+        ## determine bg and fg and attr
+        if selected
+          @attr = Ncurses::A_BOLD if selected
+          @color_pair =get_color $selectedcolor, @parent.selected_color, @parent.selected_bgcolor unless @parent.nil?
+        end
+        if focussed 
+          @attr |= Ncurses::A_REVERSE
+        end
+    end
+
+    ##
+    # 
+    def repaint graphic, r=@row,c=@col, row_index=-1,value=@text, focussed=false, selected=false
+        #$log.debug "label :#{@text}, #{value}, #{r}, #{c} col= #{@color}, #{@bgcolor} acolor= #{acolor} j:#{@justify} dlL: #{@display_length} "
+
+      prepare_default_colors focussed, selected
+
+        lablist = []
+        value=value.to_s # ??
+        if @height && @height > 1
+          lablist = wrap_text(value, @display_length).split("\n")
+        else
+          # ensure we do not exceed
+          if !@display_length.nil?
+            if value.length > @display_length
+              value = value[0..@display_length-1]
+            end
+          end
+          lablist << value
+        end
+        len = @display_length || value.length
+        _height = @height || 1
+        str = @justify.to_sym == :right ? "%*s" : "%-*s"  # added 2008-12-22 19:05 
+        # loop added for labels that are wrapped.
+        # clear separately since value can change in status like labels
+        #len -= @left_margin
+        0.upto(_height-1) { |i| 
+          graphic.printstring r+i, c, ( " " * len) , @color_pair,@attr
+        }
+        lablist.each_with_index do |_value, ix|
+          break if ix >= _height
+          if @justify.to_sym == :center
+            padding = (@display_length - _value.length)/2
+            _value = " "*padding + _value + " "*padding # so its cleared if we change it midway
+          end
+          graphic.printstring r, c, str % [len, _value], @color_pair,@attr
+          r += 1
+        end
+    end
+  # ADD HERE 
+  end
+end

data/lib/rbcurse/listkeys.rb

@@ -0,0 +1,33 @@
+module RubyCurses
+  module ListKeys
+    ## Note: keeping variables gives the false feeling that one can change the var anytime.
+    # That was possible earlier, but now that i am binding the key at construction time
+    # any changes to the vars after construction won't have an effect.
+    def install_list_keys
+      @KEY_ROW_SELECTOR ||= ?\C-x
+      @KEY_GOTO_TOP ||= ?\M-0
+      @KEY_GOTO_BOTTOM ||= ?\M-9
+      @KEY_ASK_FIND_FORWARD ||= ?\M-f
+      @KEY_ASK_FIND_BACKWARD ||= ?\M-F
+      @KEY_FIND_NEXT ||= ?\M-g
+      @KEY_FIND_PREV ||= ?\M-G
+      @KEY_SCROLL_FORWARD ||= ?\C-n
+      @KEY_SCROLL_BACKWARD ||= ?\C-p
+
+      @KEY_CLEAR_SELECTION ||= ?\M-e
+      @KEY_PREV_SELECTION ||= ?\M-"
+      @KEY_NEXT_SELECTION ||= ?\M-'
+
+=begin
+      bind_key(@KEY_ROW_SELECTOR)  { toggle_row_selection }
+      bind_key(@KEY_GOTO_TOP)      { goto_top }
+      bind_key(@KEY_GOTO_BOTTOM)   { goto_bottom }
+      bind_key(@KEY_CLEAR_SELECTION) { clear_selection }
+      bind_key(@KEY_ASK_FIND_FORWARD) { ask_search_forward }
+      bind_key(@KEY_ASK_FIND_BACKWARD) { ask_search_backward }
+      bind_key(@KEY_FIND_NEXT) { find_next }
+      bind_key(@KEY_FIND_PREV) { find_prev }
+=end
+    end
+  end
+end

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