rbcurse 1.1.5 → 1.2.0.pre

data/lib/rbcurse/listscrollable.rb

@@ -11,6 +11,8 @@ module ListScrollable
   attr_reader :search_found_ix, :find_offset, :find_offset1
   attr_accessor :show_caret # 2010-01-23 23:06 our own fake insertion point
   def previous_row num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
+    #return :UNHANDLED if @current_index == 0 # EVIL
+    return false if @current_index == 0 
     @oldrow = @current_index
     # NOTE that putting a multiplier inside, prevents an event from being triggered for each row's
     # on leave and on enter
@@ -22,8 +24,13 @@ module ListScrollable
   end
   alias :up :previous_row
   def next_row num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
-    @oldrow = @current_index
     rc = row_count
+    # returning unhandled was clever .. when user hits down arrow on last row the focus goes to
+    # next field. however, in long lists when user scrolls the sudden jumping to next is very annoying.
+    # In combos, if focus was on last row, the combo closed which is not accceptable.
+    #return :UNHANDLED if @current_index == rc-1 # EVIL !!!
+    return false if @current_index == rc-1 
+    @oldrow = @current_index
     @current_index += 1*num if @current_index < rc
     bounds_check
     $multiplier = 0
@@ -72,10 +79,10 @@ module ListScrollable
   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 and rc>0 # not gt rowcount
-    @toprow = rc-h-1 if rc > h and @toprow > rc - h - 1 # toprow shows full page if possible
+    @current_index = rc-1 if @current_index >= rc && rc>0 # not gt rowcount
+    @toprow = rc-h-1 if rc > h && @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
@@ -83,9 +90,9 @@ module ListScrollable
       # 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
@@ -98,23 +105,23 @@ module ListScrollable
     r,c = rowcol
     @rows_panned ||= 0
     
-    #win_row=@form.window.top
-    win_row=@win_top # 2010-02-11 15:12 RFED16
     win_row = 0 # 2010-02-07 21:44 now ext offset added by widget
-    #win_row = 0 # new approach, we have it 
-    #win_col=@form.window.left
-    # added 1 ?? in copywin too 2010-02-11 18:51  RFED16 this results in extra in normal situations.
+
+    # when the toprow is set externally then cursor can be mispositioned since 
+    # bounds_check has not been called
+    if @current_index < @toprow
+      # cursor is outside table
+      @current_index = @toprow # ??? only if toprow 2010-10-19 12:56 
+    end
+
     row = win_row + r + (@current_index-@toprow) + @rows_panned 
-    $log.debug " #{@name} LIST set_form_row #{row} = ci #{@current_index} + r #{r} + winrow: #{win_row} - tr:#{@toprow} #{@toprow} + rowsp #{@rows_panned} "
-    $log.debug "  - LIST set_form_row row_offset: #{@row_offset} + r #{r} + ci - topr + rowsp: #{@rows_panned}. c= #{c}  "
+    #$log.debug " #{@name} set_form_row #{row} = ci #{@current_index} + r #{r} + winrow: #{win_row} - tr:#{@toprow} #{@toprow} + rowsp #{@rows_panned} "
+    # row should not be < r or greater than r+height TODO FIXME
 
-    ## 2009-12-28 23:05 TRYING OUT but i really can't do this everywhere. BUFFERED
-    ## this needs to percolate up a heirarchy.
-    ## 2010-01-05 21:09 changed c to nil, since c is not cursor col pos but where printing starts, i think
-    #@form.setrowcol row, nil
-    #setformrowcol row, nil
+   
+    
     setrowcol row, nil
-    show_caret_func
+    #show_caret_func
   end
   ## In many situations like placing a textarea or textview inside a splitpane 
   ##+ or scrollpane there have been issues getting the cursor at the right point, 
@@ -186,54 +193,17 @@ module ListScrollable
   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.getbyte(0)
-        scroll_forward
-      when 32
-        scroll_forward
-      when ?\C-p.getbyte(0)
-        scroll_backward
-      when ?0.getbyte(0)
-        #goto_start
-        goto_top
-      when ?9.getbyte(0)
-        #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.getbyte(0)..?Z.getbyte(0), ?a.getbyte(0)..?z.getbyte(0)
-        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
+  # If we are only checking first char, then why chomp ?
+  # Please note that this is used now by tree, and list can have non-strings, so use to_s
   def next_match char
     data = get_content
     row = focussed_index + 1
     row.upto(data.length-1) do |ix|
-      val = data[ix].chomp rescue return  # 2010-01-05 15:28 crashed on trueclass
+      #val = data[ix].chomp rescue return  # 2010-01-05 15:28 crashed on trueclass
+      val = data[ix].to_s rescue return  # 2010-01-05 15:28 crashed on trueclass
       #if val[0,1] == char #and val != currval
       if val[0,1].casecmp(char) == 0 #AND VAL != CURRval
         return ix
@@ -241,7 +211,8 @@ module ListScrollable
     end
     row = focussed_index - 1
     0.upto(row) do |ix|
-      val = data[ix].chomp
+      #val = data[ix].chomp
+      val = data[ix].to_s
       #if val[0,1] == char #and val != currval
       if val[0,1].casecmp(char) == 0 #and val != currval
         return ix
@@ -253,8 +224,10 @@ module ListScrollable
   # sets the selection to the next row starting with char
   def set_selection_for_char char
     @oldrow = @current_index
+    @last_regex = "^#{char}"
     ix = next_match char
     @current_index = ix if ix && ix != -1
+    @search_found_ix = @current_index
     bounds_check
     return ix
   end
@@ -269,25 +242,6 @@ module ListScrollable
     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
     def install_keys
 =begin
       @KEY_ASK_FIND_FORWARD ||= ?\M-f.getbyte(0)
@@ -328,7 +282,8 @@ module ListScrollable
     # find forwards
     # Using this to start a search or continue search
     def _find_next regex=@last_regex, start = @search_found_ix 
-      raise "No previous search" if regex.nil?
+      #raise "No previous search" if regex.nil?
+      warn "No previous search" and return if regex.nil?
       #$log.debug " _find_next #{@search_found_ix} : #{@current_index}"
       fend = @list.size-1
       if start != fend
@@ -337,7 +292,7 @@ module ListScrollable
       @search_start_ix = start
       regex = Regexp.new(regex, Regexp::IGNORECASE) if @search_case
       start.upto(fend) do |ix| 
-        row = @list[ix]
+        row = @list[ix].to_s
         m=row.match(regex)
         if !m.nil?
           @find_offset = m.offset(0)[0]
@@ -351,7 +306,7 @@ module ListScrollable
       start = 0
       if @search_wrap
         start.upto(fend) do |ix| 
-          row = @list[ix]
+          row = @list[ix].to_s
           m=row.match(regex)
           if !m.nil?
             @find_offset = m.offset(0)[0]
@@ -364,6 +319,10 @@ module ListScrollable
       return nil
     end
     def find_next
+      unless @last_regex
+        alert("No previous search. Search first.")
+        return
+      end
         ix = _find_next
         regex = @last_regex 
         if ix.nil?
@@ -375,6 +334,10 @@ module ListScrollable
         end
     end
     def find_prev
+      unless @last_regex
+        alert("No previous search. Search first.")
+        return
+      end
         ix = _find_prev
         regex = @last_regex 
         if ix.nil?
@@ -389,7 +352,8 @@ module ListScrollable
     # find backwards
     # Using this to start a search or continue search
     def _find_prev regex=@last_regex, start = @search_found_ix 
-      raise "No previous search" if regex.nil?
+      #raise "No previous search" if regex.nil?
+      warn "No previous search" and return if regex.nil?
       #$log.debug " _find_prev #{@search_found_ix} : #{@current_index}"
       if start != 0
       start -= 1 unless start == 0
@@ -397,7 +361,7 @@ module ListScrollable
       @search_start_ix = start
       regex = Regexp.new(regex, Regexp::IGNORECASE) if @search_case
       start.downto(0) do |ix| 
-        row = @list[ix]
+        row = @list[ix].to_s
         m=row.match(regex)
         if !m.nil?
           @find_offset = m.offset(0)[0]
@@ -411,7 +375,7 @@ module ListScrollable
       start = @list.size-1
       if @search_wrap
         start.downto(fend) do |ix| 
-          row = @list[ix]
+          row = @list[ix].to_s
           m=row.match(regex)
           if !m.nil?
             @find_offset = m.offset(0)[0]
@@ -425,18 +389,25 @@ module ListScrollable
     end
     ##
     # goes to start of next word (or n words) - vi's w
+    # NOTE: will not work if the list has different data from what is displayed
+    # Nothing i can do about it.
+    # Also does not work as expected if consecutive spaces FIXME
     #
     def forward_word
-      $multiplier = 1 if !$multiplier or $multiplier == 0
+      $multiplier = 1 if !$multiplier || $multiplier == 0
       line = @current_index
-      buff = @list[line]
+      buff = @list[line].to_s
       pos = @curpos
       $multiplier.times {
         found = buff.index(/[[:punct:][:space:]]/, pos)
         if !found
           # if not found, we've lost a counter
-          line += 1 # unless eof
-          buff = @list[line]
+          if line+1 < @list.length
+            line += 1
+          else
+            return
+          end
+          buff = @list[line].to_s
           pos = 0
         else
           pos = found + 1
@@ -445,7 +416,7 @@ module ListScrollable
       }
       @current_index = line
       @curpos = pos
-      @buffer = @list[@current_index]
+      @buffer = @list[@current_index].to_s
       set_form_row
       set_form_col pos
       @repaint_required = true
@@ -465,7 +436,7 @@ module ListScrollable
       $log.debug " forward_char char:#{char}:"
       $multiplier = 1 if !$multiplier or $multiplier == 0
       line = @current_index
-      buff = @list[line]
+      buff = @list[line].to_s
       pos = @curpos
       $multiplier.times {
         found = false
@@ -473,7 +444,7 @@ module ListScrollable
           found = buff.index(char, pos)
           if !found
             line += 1 # unless eof
-            buff = @list[line]
+            buff = @list[line].to_s
             pos = 0
           else
             pos = found + 1
@@ -484,11 +455,38 @@ module ListScrollable
       }
       @current_index = line
       @curpos = pos
-      @buffer = @list[@current_index]
+      @buffer = @list[@current_index].to_s
       set_form_row
       set_form_col pos
       @repaint_required = true
     end
+    # takes a block, this way anyone extending this class can just pass a block to do his job
+    # This modifies the string
+    def sanitize content  #:nodoc:
+      if content.is_a? String
+        content.chomp!
+        content.gsub!(/\t/, '  ') # don't display tab
+        content.gsub!(/[^[:print:]]/, '')  # don't display non print characters
+      else
+        content
+      end
+    end
+    # returns only the visible portion of string taking into account display length
+    # and horizontal scrolling. MODIFIES STRING
+    def truncate content  #:nodoc:
+      maxlen = @maxlen || @width-2
+      if !content.nil? 
+        if content.length > maxlen # only show maxlen
+          @longest_line = content.length if content.length > @longest_line
+          #content = content[@pcol..@pcol+maxlen-1] 
+          content.replace content[@pcol..@pcol+maxlen-1] 
+        else
+          # can this be avoided if pcol is 0 XXX
+          content.replace content[@pcol..-1] if @pcol > 0
+        end
+      end
+      content
+    end
      
 
 end

data/lib/rbcurse/listselectable.rb

@@ -4,54 +4,92 @@ module RubyCurses
   module ListSelectable
 
     ## modified on 2009-02-13 23:41 to return model if no param passed
+    # sets or returns a list selection model
+    # Also listbox listens to it for selections, so it can tell those
+    # who are interested 2010-09-21 16:02  
     def list_selection_model(*lsm)
       if lsm.empty?
         @list_selection_model 
       else
         @list_selection_model = lsm[0]
+        # the listbox is listening to selection events on the
+        # selection model and will inform any listeners of the same.
+        @list_selection_model.bind :LIST_SELECTION_EVENT do |ev|
+          fire_handler :LIST_SELECTION_EVENT, ev
+        end
       end
       #@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
+    def is_selected? row
       @list_selection_model.is_selected_index row
     end
+    # this is the old name, should be deprecated
+    alias :is_row_selected :is_selected?
 
     def add_row_selection_interval ix0, ix1
       $log.debug " def add_row_selection_interval #{ix0}, ix1"
       # if row_selection_allowed
       @list_selection_model.add_selection_interval ix0, ix1
+      @repaint_required = true
     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}"
+      if is_selected? row
+        #$log.debug " deleting row #{row}"
         remove_row_selection_interval(row, row)
       else
-        $log.debug " adding row #{row}"
+        #$log.debug " adding row #{row}"
         add_row_selection_interval(row, row) 
       end
+      @repaint_required = true 
     end
 
     def clear_selection
       @list_selection_model.clear_selection
+      @repaint_required = true
     end
+    # why is this commented off XXX could it override listscrollable
     def selected_item
     #  @list[@current_index]
     end
+    # returns selected indices
+    # TODO : if array passed, set those as selected indices
     def selected_rows
       @list_selection_model.get_selected_rows
     end
     def selected_row_count
       selected_rows.size
     end
+    # returns index of first selected row (lowest index)
+    # TODO: if param passed set that as selected_index
     def selected_row
       @list_selection_model.get_min_selection_index
     end
+    alias :selected_index :selected_row
+
+    # returns value of first selected row (lowest index)
+    def selected_value
+      #@list[@current_index].to_s # old behavior since curr row was in reverse
+      return nil if selected_row().nil?
+      @list[selected_row()].to_s
+    end
+    # returns an array of selected values
+    # or yields values to given block
+    def selected_values &block
+      ar = []
+      selected_rows().each do |i|
+        val = @list[i]
+        if block_given?
+          yield val
+        else
+          ar << val
+        end
+      end
+      return ar unless block_given?
+    end
+
     def do_next_selection
       return if selected_rows().length == 0 
       row = selected_rows().sort.find { |i| i > @current_index }
@@ -66,10 +104,25 @@ module RubyCurses
       @current_index = row
       @repaint_required = true # fire list_select XXX
     end
+    # NOTE: I HAD removed this and put in listbox, but its required by rtable also
+    # create a default list selection model and set it
+    # NOTE: I am now checking if one is not already created, since
+    # a second creation would wipe out any listeners on it.
+    # @see ListSelectable 
+    # @see DefaultListSelectionModel
+    def create_default_list_selection_model
+      if @list_selection_model.nil?
+        list_selection_model DefaultListSelectionModel.new(self)
+      end
+    end
     alias :selected_index :selected_row
     attr_accessor :row_selection_allowed
     attr_accessor :column_selection_allowed
   end
+  # class containing information relating to selections on a list
+  #  2010-09-21 19:46 NOTE: Earlier source contained the model object, now it returns the parent
+  #  You may do source.list_data_model() to get the model
+  #  Typical operations on source would get selected_value(s), or selected_index
   class ListSelectionEvent
     attr_accessor :firstrow, :lastrow, :source, :type
     def initialize firstrow, lastrow, source, type