rbcurse 1.4.0 → 1.4.1.pre2

data/lib/rbcurse/extras/viewer.rb

@@ -84,6 +84,8 @@ module RubyCurses
           v_form.repaint
         end
       rescue => err
+          $log.error " VIEWER ERROR #{err} "
+          $log.debug(err.backtrace.join("\n"))
         alert err.to_s
       ensure
         v_window.destroy if !v_window.nil?

data/lib/rbcurse/io.rb

@@ -620,14 +620,30 @@ module Io
   # This allows us to define different menus for different objects on the screen, and not have to map 
   # all kinds of control keys for operations, and have the user remember them. Only one key invokes the menu
   # and the rest are ordinary characters.
+  # 
+  #  == Example
+  #    menu = PromptMenu.new self do
+  #      item :s, :goto_start
+  #      item :b, :goto_bottom
+  #      item :r, :scroll_backward
+  #      item :l, :scroll_forward
+  #      submenu :m, "submenu" do
+  #        item :p, :goto_last_position
+  #        item :r, :scroll_backward
+  #        item :l, :scroll_forward
+  #      end
+  #    end
+  #    menu.display @form.window, $error_message_row, $error_message_col, $datacolor #, menu
+
   class PromptMenu
     include Io
     attr_reader :text
     attr_reader :options
-    def initialize caller,  text="Choose:"
+    def initialize caller,  text="Choose:", &block
       @caller = caller
       @text = text
       @options = []
+      instance_eval &block if block_given?
     end
     def add *menuitem
       item = nil
@@ -636,11 +652,19 @@ module Io
         item = menuitem.first
         @options << item
       else
-        item = CMenuItem.new(*menuitem.flatten)
+        case menuitem.size
+        when 4
+          item = CMenuItem.new(*menuitem.flatten)
+        when 2
+          # if user only sends key and symbol
+          menuitem[3] = menuitem[1]
+          item = CMenuItem.new(*menuitem.flatten)
+        end
         @options << item
       end
       return item
     end
+    alias :item :add
     def create_mitem *args
       item = CMenuItem.new(*args.flatten)
     end
@@ -659,14 +683,107 @@ module Io
         end
       }
     end
+    # 
+    # To allow a more rubyesque way of defining menus and submenus
+    def submenu key, label, &block
+      item = CMenuItem.new(key, label)
+      @options << item
+      item.action = PromptMenu.new @caller, label, &block
+    end
+    #
+    # Display prompt_menu in columns using commandwindow
+    # This is an improved way of showing the "most" like menu. The earlier
+    # format would only print in one row.
+    #
+    def display_columns config={}
+      prompt = config[:prompt] || "Choose: "
+      require 'rbcurse/rcommandwindow'
+      layout = { :height => 5, :width => Ncurses.COLS-1, :top => Ncurses.LINES-6, :left => 0 }
+      rc = CommandWindow.new nil, :layout => layout, :box => true, :title => config[:title] || "Menu"
+      w = rc.window
+      r = 4
+      c = 1
+      color = $datacolor
+      begin
+        menu = @options
+        $log.debug " DISP MENU "
+        ret = 0
+        len = 80
+        while true
+          h = {}
+          valid = []
+          labels = []
+          menu.each{ |item|
+            hk = item.hotkey.to_s
+            labels << "%c. %s " % [ hk, item.label ]
+            h[hk] = item
+            valid << hk
+          }
+          #$log.debug " valid are #{valid} "
+          color = $datacolor
+          #print_this(win, str, color, r, c)
+          rc.display_menu labels, :indexing => :custom
+          ch=w.getchar()
+          rc.clear
+          #$log.debug " got ch #{ch} "
+          next if ch < 0 or ch > 255
+          if ch == 3 || ch == ?\C-g.getbyte(0)
+            clear_this w, r, c, color, len
+            print_this(w, "Aborted.", color, r,c)
+            break
+          end
+          ch = ch.chr
+          index = valid.index ch
+          if index.nil?
+            clear_this w, r, c, color, len
+            print_this(w, "Not valid. Valid are #{valid}. C-c/C-g to abort.", color, r,c)
+            sleep 1
+            next
+          end
+          #$log.debug " index is #{index} "
+          item = h[ch]
+          desc = item.desc
+          #desc ||= "Could not find desc for #{ch} "
+          desc ||= ""
+          clear_this w, r, c, color, len
+          print_this(w, desc, color, r,c)
+          action = item.action
+          case action
+            #when Array
+          when PromptMenu
+            # submenu
+            menu = action.options
+            title = rc.title
+            rc.title title +" => " + action.text # set title of window to submenu
+          when Proc
+            ret = action.call
+            break
+          when Symbol
+            ret = @caller.send(action)
+            break
+          else 
+            $log.debug " Unidentified flying class #{action.class} "
+            break
+          end
+        end # while
+      ensure
+        rc.destroy
+        rc = nil
+      end
+    end
+    alias :display_new :display_columns
+
     # Display the top level menu and accept user input
     # Calls actions or symbols upon selection, or traverses submenus
     # @return retvalue of last call or send, or 0
     # @param win window
     # @param r, c row and col to display on
     # @param color text color (use $datacolor if in doubt)
-    # @param menu array of CMenuItem structs
+    # @see display_new - it presents in a much better manner
+    # and is not restricted to one row. Avoid this.
     def display win, r, c, color
+      # FIXME use a oneline window, user should not have to give all this crap.
+      # What about panning if we can;t fit, should we use horiz list to show ?
       menu = @options
       $log.debug " DISP MENU "
       ret = 0

data/lib/rbcurse/listcellrenderer.rb

@@ -66,7 +66,8 @@ module RubyCurses
       create_color_pairs unless @pairs
       raise ArgumentError, "pairs hash is null. Changes have happened in listcellrenderer" unless @pairs
       @color_pair = @pairs[:normal]
-      @attr = $row_attr
+      #@attr = $row_attr
+      @attr = @row_attr || $row_attr # changed 2011-10-15 since we seem to be ignoring row_attr changes
       # give precedence to a selected row
       if selected
         @color_pair = @pairs[:selected]

data/lib/rbcurse/listkeys.rb

@@ -5,7 +5,7 @@ module RubyCurses
     # any changes to the vars after construction won't have an effect.
     def install_list_keys
       #@KEY_ROW_SELECTOR ||= ?\C-x.getbyte(0)  # need to changed from C-x since used for actions # changed 2011 dts  
-      @KEY_ROW_SELECTOR ||= 0  # need to changed from C-x since used for actions
+      @KEY_ROW_SELECTOR ||= 32  # need to changed from C-x since used for actions
       @KEY_BLOCK_SELECTOR ||= ?\M-x.getbyte(0)  # need to change since M-x used for commands
       @KEY_GOTO_TOP ||= ?\M-0.getbyte(0)
       @KEY_GOTO_BOTTOM ||= ?\M-9.getbyte(0)

data/lib/rbcurse/listscrollable.rb

@@ -64,8 +64,11 @@ module ListScrollable
     m = $multiplier == 0? 1 : $multiplier
     # more rows than box
     if h * m < rc
-      @toprow += h+1 #if @current_index+h < rc
-      @current_index = @toprow
+      # next 2 lines were preventing widget_scrolled from being set to true,
+      # so i've modified it slightly as per scroll_down 2011-11-1 
+      #@toprow += h+1 #if @current_index+h < rc
+      #@current_index = @toprow
+      @current_index += h+1
     else
       # fewer rows than box
       @current_index = rc -1
@@ -79,6 +82,7 @@ module ListScrollable
   def bounds_check
     h = scrollatrow()
     rc = row_count
+    @old_toprow = @toprow
 
     @current_index = 0 if @current_index < 0  # not lt 0
     @current_index = rc-1 if @current_index >= rc && rc>0 # not gt rowcount
@@ -91,14 +95,19 @@ module ListScrollable
       @toprow = @current_index
     end
  
+    @row_changed = false
     if @oldrow != @current_index
-
       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
+      set_form_row
+      @row_changed = true
+    end
+    #set_form_row # 2011-10-13 
+
+    if @old_toprow != @toprow # only if scrolling has happened should we repaint
+      @repaint_required = true #if @old_toprow != @toprow # only if scrolling has happened should we repaint
+      @widget_scrolled = true
     end
-    set_form_row
-    #set_form_col 0 # added 2009-02-15 23:33  # this works for lists but we don't want this in TextArea's
-    @repaint_required = true
   end
   # the cursor should be appropriately positioned
   def set_form_row
@@ -160,6 +169,7 @@ module ListScrollable
   def scroll_right
     $log.debug " inside scroll_right "
     hscrollcols = $multiplier > 0 ? $multiplier : @width/2
+    #hscrollcols = $multiplier > 0 ? $multiplier : 1 # for testing out 
     $log.debug " scroll_right  mult:#{$multiplier} , hscrollcols  #{hscrollcols}, pcol #{@pcol} w: #{@width} ll:#{@longest_line} "
     #blen = @buffer.rstrip.length
     blen = @longest_line
@@ -469,7 +479,9 @@ module ListScrollable
     def sanitize content  #:nodoc:
       if content.is_a? String
         content.chomp!
-        content.gsub!(/\t/, '  ') # don't display tab
+        content.replace(content.encode("ASCII-8BIT", :invalid => :replace, :undef => :replace, :replace => "?"))
+        content.gsub!(/[\t\r\n]/, '  ') # don't display tab, newline
+        content.gsub!(/\n/, '  ') # don't display tab, newline
         content.gsub!(/[^[:print:]]/, '')  # don't display non print characters
       else
         content
@@ -494,6 +506,59 @@ module ListScrollable
       end
       content
     end
+    #
+    # Is the given index in the visible area
+    # UNTESTED XXX
+    def is_visible? index
+      #(0..scrollatrow()).include? index - @toprow
+      j = index - @toprow
+      j >= 0 && j <= scrollatrow()
+    end
+    # offset in widget like 0..scrollatrow
+    # NOTE can return nil, if user scrolls forward or backward
+    # @private
+    def _convert_index_to_visible_row index=@current_index
+      pos = index - @toprow
+      return nil if pos < 0 || pos > scrollatrow()
+      return pos
+    end
+    # actual position to write on window
+    # NOTE can return nil, if user scrolls forward or backward
+    def _convert_index_to_printable_row index=@current_index
+      r,c = rowcol
+      pos = _convert_index_to_visible_row(index)
+      return nil unless pos
+      pos = r + pos
+      return pos
+    end
+
+    # highlights the focussed (current) and unfocussed (oldrow)
+    #  NOTE: when multiselecting ... it will remove selection
+    #  so be careful when calling.
+    def highlight_focussed_row type, r=nil, c=nil, acolor=nil
+      return unless @should_show_focus
+      case type
+      when :FOCUSSED
+        ix = @current_index
+        return if is_row_selected ix
+        r = _convert_index_to_printable_row() unless r
+        attrib = @focussed_attrib || 'bold'
+
+      when :UNFOCUSSED
+        return if @oldrow.nil? || @oldrow == @current_index
+        ix = @oldrow
+        return if is_row_selected ix
+        r = _convert_index_to_printable_row(@oldrow) unless r
+        return unless r # row is not longer visible
+        attrib = @attr
+      end
+      unless c
+        _r, c = rowcol
+      end
+      acolor ||= get_color $datacolor
+      att = get_attrib(attrib) #if @focussed_attrib
+      @graphic.mvchgat(y=r, x=c, @width-@internal_width, att , acolor , nil)
+    end
      
 
 end

data/lib/rbcurse/rbasiclistbox.rb

@@ -69,6 +69,7 @@ module RubyCurses
     # index of selected rows, if multiple selection asked for
     attr_reader :selected_indices
 
+    dsl_accessor :should_show_focus
 
     # basic listbox constructor
     #
@@ -78,7 +79,7 @@ module RubyCurses
       @sanitization_required = true # cleanup control and non print chars
       @truncation_required = true
       @suppress_borders = false #to_print_borders = 1
-      @row_selected_symbol = ''
+      #@row_selected_symbol = '' # thi sprevents default value from being set
       @row = 0
       @col = 0
       # data of listbox this is not an array, its a pointer to the  listdatamodel
@@ -89,6 +90,7 @@ module RubyCurses
       @selected_indices = []
       @selected_index = nil
       @row_offset = @col_offset = 1
+      @should_show_focus = true # Here's its on since the cellrenderer will show it on repaint
       super
       @_events.push(*[:ENTER_ROW, :LEAVE_ROW, :LIST_SELECTION_EVENT, :PRESS])
       @selection_mode ||= :multiple # default is multiple, anything else given becomes single
@@ -96,11 +98,9 @@ module RubyCurses
       @win_left = 0
       @win_top = 0
 
-      # next 2 lines carry a redundancy
-      #select_default_values   
-      # when the combo box has a certain row in focus, the popup should have the same row in focus
-
       init_vars
+      @internal_width = 2
+      @internal_width = 0 if @suppress_borders
 
       if @list && !@selected_index.nil?  # XXX
         set_focus_on @selected_index # the new version
@@ -110,12 +110,14 @@ module RubyCurses
     # and when list data changed, so only put relevant resets here.
     def init_vars
       @repaint_required = true
+      @widget_scrolled = true  # 2011-10-15 
       @toprow = @pcol = 0
       if @show_selector
         @row_selected_symbol ||= '>'
         @row_unselected_symbol ||= ' '
         @left_margin ||= @row_selected_symbol.length
       end
+      @row_selected_symbol ||= ''
       #@left_margin ||= 0
       @one_key_selection = false if @one_key_selection.nil?
       @row_offset = @col_offset = 0 if @suppress_borders
@@ -186,8 +188,10 @@ module RubyCurses
       clear_selection
     
       @repaint_required = true
+      @widget_scrolled = true  # 2011-10-15 
       @list
     end
+    def list_data_model; @list; end
     # conv method to insert data, trying to keep names same across along with Tabular, TextView,
     # TextArea and listbox. Don;t use this till i am certain.
     def data=(val)
@@ -237,7 +241,6 @@ module RubyCurses
     ### START FOR scrollable ###
     def get_content
       @list 
-      #@list_variable && @list_variable.value || @list 
     end
     def get_window #:nodoc:
       @graphic 
@@ -383,6 +386,13 @@ module RubyCurses
       true
     end
     def on_enter_row arow
+      # copied from resultsettextview, can this not be in one place like listscrollable ? FIXME
+      if @should_show_focus
+        highlight_focussed_row :FOCUSSED
+        unless @oldrow == @selected_index
+          highlight_focussed_row :UNFOCUSSED
+        end
+      end
       fire_handler :ENTER_ROW, self
       @repaint_required = true
     end
@@ -398,7 +408,7 @@ module RubyCurses
       end
     end
     def create_default_cell_renderer
-      return ListCellRenderer.new "", {"color"=>@color, "bgcolor"=>@bgcolor, "parent" => self, "display_length"=> @width-2-@left_margin}
+      return ListCellRenderer.new "", {"color"=>@color, "bgcolor"=>@bgcolor, "parent" => self, "display_length"=> @width-@internal_width-@left_margin}
       #return BasicListCellRenderer.new "", {"color"=>@color, "bgcolor"=>@bgcolor, "parent" => self, "display_length"=> @width-2-@left_margin}
     end
     ##
@@ -408,18 +418,30 @@ module RubyCurses
     # a section of it.
     def repaint #:nodoc:
       return unless @repaint_required
+      #
+      # TRYING OUT dangerous 2011-10-15 
+      @repaint_required = false
+      @repaint_required = true if @widget_scrolled || @pcol != @old_pcol || @record_changed || @property_changed
+
+      unless @repaint_required
+        unhighlight_row @old_selected_index
+        highlight_selected_row
+      end
+      return unless @repaint_required
+      $log.debug "BASICLIST REPAINT WILL HAPPEN #{current_index} "
       # not sure where to put this, once for all or repeat 2010-02-17 23:07 RFED16
       my_win = @form ? @form.window : @target_window
       @graphic = my_win unless @graphic
       raise " #{@name} neither form, nor target window given LB paint " unless my_win
       raise " #{@name} NO GRAPHIC set as yet                 LB paint " unless @graphic
+      raise "width or height not given w:#{@width} , h:#{@height} " if @width.nil? || @height.nil?
       @win_left = my_win.left
       @win_top = my_win.top
       @left_margin ||= @row_selected_symbol.length
       # we are making sure display len does not exceed width XXX hope this does not wreak havoc elsewhere
-      _dl = [@display_length || 100, @width-2].min # 2011-09-17 RK overwriting when we move grabbar in vimsplit
+      _dl = [@display_length || 100, @width-@internal_width-@left_margin].min # 2011-09-17 RK overwriting when we move grabbar in vimsplit
 
-      $log.debug "basicrlistbox repaint  #{@name} graphic #{@graphic}"
+      $log.debug "basiclistbox repaint  #{@name} graphic #{@graphic}"
       #$log.debug "XXX repaint to_print #{@to_print_borders} "
       print_borders unless @suppress_borders # do this once only, unless everything changes
       #maxlen = @maxlen || @width-2
@@ -463,12 +485,40 @@ module RubyCurses
             renderer.repaint @graphic, r+hh, c+@left_margin, crow, content, focus_type, selected
           else
             # clear rows
-            @graphic.printstring r+hh, c, " " * (@width-2), acolor,@attr
+            @graphic.printstring r+hh, c, " " * (@width-@internal_width), acolor,@attr
           end
         end
       end # rc == 0
-      #@table_changed = false
       @repaint_required = false
+      # 2011-10-13 
+      @widget_scrolled = false
+      @record_changed = false
+      @property_changed = false
+      @old_pcol = @pcol
+    end
+    def highlight_selected_row r=nil, c=nil, acolor=nil
+      return unless @selected_index # no selection
+      r = _convert_index_to_printable_row(@selected_index) unless r
+      return unless r # not on screen
+      unless c
+        _r, c = rowcol
+      end
+      acolor ||= get_color $datacolor, @selected_color, @selected_bgcolor
+      att = FFI::NCurses::A_REVERSE
+      att = get_attrib(@selected_attrib) if @selected_attrib
+      @graphic.mvchgat(y=r, x=c, @width-@internal_width-@left_margin, att , acolor , nil)
+    end
+    def unhighlight_row index,  r=nil, c=nil, acolor=nil
+      return unless index # no selection
+      r = _convert_index_to_printable_row(index) unless r
+      return unless r # not on screen
+      unless c
+        _r, c = rowcol
+      end
+      acolor ||= get_color $datacolor
+      att = FFI::NCurses::A_NORMAL
+      att = get_attrib(@normal_attrib) if @normal_attrib
+      @graphic.mvchgat(y=r, x=c, @width-@internal_width-@left_margin, att , acolor , nil)
     end
     # the idea here is to allow users who subclass Listbox to easily override parts of the cumbersome repaint
     # method. This assumes your List has some data, but you print a lot more. Now you don't need to
@@ -498,7 +548,8 @@ module RubyCurses
     # 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
+      maxlen = @maxlen || @width-@internal_width
+      maxlen = @width-@internal_width if maxlen > @width-@internal_width
       if maxlen == 0 # (otherwise it becoems -1 below)
         content.replace ""
         return
@@ -523,6 +574,7 @@ module RubyCurses
         @current_index = 0
         set_form_row
       end
+      @widget_scrolled = true  # 2011-10-15 
       @repaint_required = true
     end