rbcurse 1.1.5 → 1.2.0.pre

data/lib/rbcurse/extras/divider.rb

@@ -0,0 +1,310 @@
+require 'rbcurse/app'
+include Ncurses
+include RubyCurses
+
+# TODO : We can consider making it independent of objects, or allow for a margin so it does not write
+# over the object. Then it will be always visible.
+# TODO: if lists and tables, can without borders actually adjust then putting this independent
+# would make even more sense, since it won't eat an extra line.
+#
+# @example
+#     lb = list_box ....
+#     rb = Divider.new @form, :parent => lb, :side => :right
+#
+# At a later stage, we will integrate this with lists and tables, so it will happen automatically.
+#
+# @since 1.2.0
+module RubyCurses
+  class DragEvent < Struct.new(:source, :type); end
+
+  # This is a horizontal or vertical bar (like a scrollbar), at present attached to a
+  # widget that is focusable, and allows user to press arrow keys.
+  # It highlights on focus, the caller can expand and contract components in a container
+  # or even screen, based on arrow movements. This allows for a visual resizing of components.
+  # @example
+  #     lb = list_box ....
+  #     rb = Divider.new @form, :parent => lb, :side => :right
+  #
+  # NOTE: since this can be deactivated, containers need to check focusable before passing
+  # focus in
+  #  2010-10-07 23:56 made focusable false by default. Add divider to
+  #  FocusManager when creating, so F3 can be used to set focusable
+  #  See rvimsplit.rb for example
+
+  class Divider < Widget
+    # row to start, same as listbox, required.
+    dsl_property :row
+    # column to start, same as listbox, required.
+    dsl_property :col
+    # how many rows is this (should be same as listboxes height, required.
+    dsl_property :length
+    # vertical or horizontal currently only VERTICAL
+    dsl_property :side
+    # initialize based on parent's values
+    dsl_property :parent
+    # which row is focussed, current_index of listbox, required.
+    # how many total rows of data does the list have, same as @list.length, required.
+    dsl_accessor :next
+
+    # TODO: if parent passed, we shold bind to ON_ENTER and get current_index, so no extra work is required.
+
+    def initialize form, config={}, &block
+
+      # setting default first or else Widget will place its BW default
+      #@color, @bgcolor = ColorMap.get_colors_for_pair $bottomcolor
+      super
+      @height = 1
+      @color_pair = get_color $datacolor, @color, @bgcolor
+      @scroll_pair = get_color $bottomcolor, :green, :white
+      #@window = form.window
+      @editable = false
+      # you can set to true upon creation, or use F3 on vimsplit to
+      # toggle focusable
+      @focusable = false
+      @repaint_required = true
+      @_events.push(:DRAG_EVENT)
+      map_keys
+      unless @parent
+        raise ArgumentError, "row col and length should be provided" if !@row || !@col || !@length
+      end
+      #if @parent
+        #@parent.bind :ENTER_ROW do |p|
+          ## parent must implement row_count, and have a @current_index
+          #raise StandardError, "Parent must implement row_count" unless p.respond_to? :row_count
+          #self.current_index = p.current_index
+          #@repaint_required = true  #requred otherwise at end when same value sent, prop handler
+          ## will not be fired (due to optimization).
+        #end
+      #end
+    end
+    def map_keys
+      if !defined? $deactivate_dividers
+        $deactivate_dividers = false
+      end
+      # deactivate only this bar
+      bind_key(?f) {@focusable=false; }
+      # deactivate all bars, i've had nuff!
+      bind_key(?F) {deactivate_all(true)}
+    end
+
+    ##
+    # repaint the scrollbar
+    # Taking the data from parent as late as possible in case parent resized, or 
+    # moved around by a container.
+    # NOTE: sometimes if this is inside another object, the divider repaints but then
+    # is wiped out when that objects print_border is called. So such an obkect (e.g.
+    # vimsplit) should call repaint after its has done its own repaint. that does mean
+    # the repaint happens twice during movement
+    def repaint
+      woffset = 2
+      coffset = 1
+      if @parent
+        woffset = 0 if @parent.suppress_borders
+        @border_attrib ||= @parent.border_attrib
+        case @side
+        when :right
+          @row = @parent.row+1
+          @col = @parent.col + @parent.width - 0
+          @length = @parent.height - woffset
+        when :left
+          @row = @parent.row+1
+          @col = @parent.col+0 #+ @parent.width - 1
+          @length = @parent.height - woffset
+        when :top
+          @row = @parent.row+0
+          @col = @parent.col + @parent.col_offset #+ @parent.width - 1
+          @length = @parent.width - woffset
+        when :bottom
+          @row = @parent.row+@parent.height-0 #1
+          @col = @parent.col+@parent.col_offset #+ @parent.width - 1
+          @length = @parent.width - woffset
+        end
+      else
+        # row, col and length should be passed
+      end
+      my_win = @form ? @form.window : @target_window
+      @graphic = my_win unless @graphic
+      raise "graphic is nil in divider, perhaps form was nil when creating" unless @graphic
+      return unless @repaint_required
+
+      # first print a right side vertical line
+      #bc = $bottomcolor  # dark blue
+      bc = $datacolor
+      bordercolor = @border_color || bc
+      borderatt = @border_attrib || Ncurses::A_REVERSE
+      if @focussed 
+        bordercolor = $promptcolor || bordercolor
+      end
+
+      borderatt = convert_attrib_to_sym(borderatt) if borderatt.is_a? Symbol
+
+      @graphic.attron(Ncurses.COLOR_PAIR(bordercolor) | borderatt)
+      $log.debug " XXX DIVIDER #{@row} #{@col} #{@length} "
+      case @side
+      when :right, :left
+        @graphic.mvvline(@row, @col, 1, @length)
+      when :top, :bottom
+        @graphic.mvhline(@row, @col, 1, @length)
+      end
+      @graphic.attroff(Ncurses.COLOR_PAIR(bordercolor) | borderatt)
+      _paint_marker
+      #alert "divider repaint at #{row} #{col} "
+
+      @repaint_required = false
+    end
+    def convert_attrib_to_sym attr
+      case attr
+      when 'reverse'
+        Ncurses::A_REVERSE
+      when 'bold'
+        Ncurses::A_BOLD
+      when 'normal'
+        Ncurses::A_NORMAL
+      when 'blink'
+        Ncurses::A_BLINK
+      when 'underline'
+        Ncurses::A_UNDERLINE
+      else
+        Ncurses::A_REVERSE
+      end
+    end
+    # deactivate all dividers
+    # The application has to provide a key or button to activate all
+    # or just this one.
+    def deactivate_all  tf=true
+      $deactivate_dividers = tf
+      @focusable = !tf
+    end
+    def handle_key ch
+      # all dividers have been deactivated
+      if $deactivate_dividers || !@focusable
+        @focusable = false
+        return :UNHANDLED
+      end
+      case @side
+      when :right, :left
+        case ch
+        when KEY_RIGHT
+          fire_handler :DRAG_EVENT, DragEvent.new(self, ch)
+        when KEY_LEFT
+          fire_handler :DRAG_EVENT, DragEvent.new(self, ch)
+        else
+          ret = process_key ch, self
+          return ret if ret == :UNHANDLED
+        end
+        set_form_col
+      when :top, :bottom
+        case ch
+        when KEY_UP
+          fire_handler :DRAG_EVENT, DragEvent.new(self, ch)
+        when KEY_DOWN
+          fire_handler :DRAG_EVENT, DragEvent.new(self, ch)
+        else
+          ret = process_key ch, self
+          return ret if ret == :UNHANDLED
+        end
+        set_form_col
+      else
+      end
+      @repaint_required = true
+      return 0
+    end
+    def on_enter
+      if $deactivate_dividers || !@focusable
+        @focusable = false
+        return :UNHANDLED
+      end
+      # since it is over border of component, we need to repaint
+      @focussed = true
+      @repaint_required = true
+      repaint
+    end
+    def on_leave
+      @focussed = false
+      @repaint_required = true
+      repaint
+      # TODO: we should review this since its not over the parent any longer
+      if @parent
+        # since it is over border of component, we need to clear
+        @parent.repaint_required 
+        # if we don't paint now, parent paints over other possible dividers
+        @parent.repaint
+      end
+    end
+    def set_form_row
+      return unless @focusable
+      r,c = rowcol
+      setrowcol r, c
+    end
+    # set the cursor on first point of bar
+    def set_form_col
+      return unless @focusable
+      # need to set it to first point, otherwise it could be off the widget
+      r,c = rowcol
+      setrowcol r, c
+    end
+    # is this a vertical divider
+    def v?
+      @side == :top || @side == :bottom
+    end
+    # is this a horizontal divider
+    def h?
+      @side == :right || @side == :left
+    end
+    private
+    def _paint_marker  #:nodoc:
+      r,c = rowcol
+      if @focussed
+        @graphic.mvwaddch r,c, Ncurses::ACS_DIAMOND
+        if v?
+          @graphic.mvwaddch r,c+1, Ncurses::ACS_UARROW
+          @graphic.mvwaddch r,c+2, Ncurses::ACS_DARROW
+        else
+          @graphic.mvwaddch r+1,c, Ncurses::ACS_LARROW
+          @graphic.mvwaddch r+2,c, Ncurses::ACS_RARROW
+        end
+      else
+        #@graphic.mvwaddch r,c, Ncurses::ACS_CKBOARD
+      end
+    end
+    ##
+    ##
+    # ADD HERE 
+    end # class
+end # module
+if __FILE__ == $PROGRAM_NAME
+  App.new do
+    r = 5
+    len = 20
+    list = []
+    0.upto(100) { |v| list << "#{v} scrollable data" }
+    lb = list_box "A list", :list => list, :row => 2, :col => 2
+    #sb = Scrollbar.new @form, :row => r, :col => 20, :length => len, :list_length => 50, :current_index => 0
+    rb = Divider.new @form, :parent => lb, :side => :right
+    rb.bind :DRAG_EVENT do |e|
+      message "got an event #{e.type} "
+      case e.type
+      when KEY_RIGHT
+        lb.width += 1
+      when KEY_LEFT
+        lb.width -= 1
+      end
+      lb.repaint_required
+    end
+    rb1 = Divider.new @form, :parent => lb, :side => :bottom
+    rb.focusable(true)
+    rb1.focusable(true)
+    rb1.bind :DRAG_EVENT do |e|
+      message " 2 got an event #{e.type} "
+    end
+    #hline :width => 20, :row => len+r
+    #keypress do |ch|
+      #case ch
+      #when :down
+        #sb.current_index += 1
+      #when :up
+        #sb.current_index -= 1
+      #end
+    #end
+  end
+end

data/lib/rbcurse/extras/focusmanager.rb

@@ -0,0 +1,31 @@
+# Allow some objects to take focus when a certain key is pressed.
+# This is for objects like scrollbars and grabbars. We don't want these always
+# getting focus, only sometimes when we want to resize panes.
+# This will not only be included by Form but by containers such as Vimsplit
+# or MasterDetail.
+# Usage: the idea is that when you create grabbars, you would add them to the FocusManager
+# Thus they would remain non-focusable on creation. When hte user presses (say F3) then
+# make_focusable is called, or toggle_focusable. Now user can press TAB and access
+# these bars. When he is done he can toggle again.
+# TODO: we might add a Circular class here so user can traverse only these objects
+module RubyCurses
+  module FocusManager
+    extend self
+    attr_reader :focusables
+    # add a component to this list so it can be made focusable later
+    def add component
+      @focusables ||= []
+      @focusables << component
+      self
+    end
+    def make_focusable bool=true
+      @focusing = bool
+      @focusables.each { |e| e.focusable(bool) }
+    end
+    def toggle_focusable
+      return unless @focusables
+      alert "FocusManager Making #{@focusables.length} objects #{!@focusing} "
+      make_focusable !@focusing
+    end
+  end
+end

data/lib/rbcurse/extras/listselectable.rb

@@ -0,0 +1,222 @@
+# File created: 2010-10-29 14:09 
+# Author      : rkumar
+#
+# this is a new, simpler version of listselectable
+# the original gets into models and has complicated operation as well
+# as difficult to remember method names. This attempts to be a simple plugin.
+# Currently being used by rbasiclistbox and now tabularwidget.
+# TODO: of course we need to fire events so user can do something.
+module RubyCurses
+  module NewListSelectable
+
+    # @group selection related
+
+    # change selection of current row on pressing space bar
+    # If mode is multiple, then other selections are cleared and this is added
+    # @example
+    #     bind_key(32) { toggle_row_selection }
+    # current_index is not account for header_adjustment
+    # if current row is selected in mulitple we should deselect ?? FIXME
+    def toggle_row_selection crow=@current_index-@_header_adjustment
+      @last_clicked = crow
+      @repaint_required = true
+      case @selection_mode 
+      when :multiple
+        if @selected_indices.include? crow
+          @selected_indices.delete crow
+        else
+          #clear_selection
+          #@selected_indices[0] = crow 
+          @selected_indices << crow
+        end
+      else
+        if @selected_index == crow 
+          @selected_index = nil
+        else
+          @selected_index = crow 
+        end
+      end
+    end
+    #
+    # Only for multiple mode.
+    # add an item to selection, if selection mode is multiple
+    # if item already selected, it is deselected, else selected
+    # typically bound to Ctrl-Space
+    # @example
+    #     bind_key(0) { add_to_selection }
+    def add_to_selection crow=@current_index-@_header_adjustment
+      @last_clicked ||= crow
+      min = [@last_clicked, crow].min
+      max = [@last_clicked, crow].max
+      case @selection_mode 
+      when :multiple
+        if @selected_indices.include? crow
+          # delete from last_clicked until this one in any direction
+          min.upto(max){ |i| @selected_indices.delete i }
+        else
+          # add to selection from last_clicked until this one in any direction
+          min.upto(max){ |i| @selected_indices << i unless @selected_indices.include?(i) }
+        end
+      else
+      end
+      @repaint_required = true
+    end
+    # clears selected indices, typically called when multiple select
+    # Key binding is application specific
+    def clear_selection
+      @selected_indices = []
+      @selected_index = nil
+      @repaint_required = true
+    end
+    def is_row_selected crow=@current_index-@_header_adjustment
+      case @selection_mode 
+      when :multiple
+        @selected_indices.include? crow
+      else
+        crow == @selected_index
+      end
+    end
+    alias :is_selected? is_row_selected
+    # FIXME add adjustment and test
+    def goto_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
+    # FIXME add adjustment and test
+    def goto_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
+    # add the following range to selected items, unless already present
+    # should only be used if multiple selection interval
+    def add_selection_interval ix0, ix1
+      return if @selection_mode != :multiple
+      @anchor_selection_index = ix0
+      @lead_selection_index = ix1
+      ix0.upto(ix1) {|i| @selected_indices  << i unless @selected_indices.include? i }
+      #lse = ListSelectionEvent.new(ix0, ix1, @parent, :INSERT)
+      #fire_handler :LIST_SELECTION_EVENT, lse
+      #$log.debug " DLSM firing LIST_SELECTION EVENT #{lse}"
+    end
+    alias :add_row_selection_interval :add_selection_interval
+    def remove_selection_interval ix0, ix1
+      @anchor_selection_index = ix0
+      @lead_selection_index = ix1
+      @selected_indices.delete_if {|x| x >= ix0 and x <= ix1}
+      #lse = ListSelectionEvent.new(ix0, ix1, @parent, :DELETE)
+      #fire_handler :LIST_SELECTION_EVENT, lse
+    end
+    alias :remove_row_selection_interval :remove_selection_interval
+    # convenience method to select next len rows
+    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
+    # select all rows, you may specify starting row.
+    # if header row, then 1 else should be 0. Actually we should have a way to determine
+    # this, and the default should be zero.
+    def select_all start_row=0
+      @repaint_required = true
+      # don't select header row - need to make sure this works for all cases. we may 
+      # need a variable instead of hardoded value
+      add_row_selection_interval start_row, row_count()
+    end
+    def invert_selection start_row=1
+      start_row.upto(row_count()){|i| invert_row_selection i }
+    end
+     
+    def invert_row_selection row=@current_index-@_header_adjustment
+      @repaint_required = true
+      if is_selected? row
+        remove_row_selection_interval(row, row)
+      else
+        add_row_selection_interval(row, row) 
+      end
+    end
+    # selects all rows with the values given, leaving existing selections
+    # intact. Typically used after accepting search criteria, and getting a list of values
+    # to select (such as file names). Will not work with tables (array or array)
+    def select_values values
+      return unless values
+      values.each do |val|
+        row = @list.index val
+        add_row_selection_interval row, row unless row.nil?
+      end
+    end
+    # unselects all rows with the values given, leaving all other rows intact
+    # You can map "-" to ask_select and call this from there.
+    #   bind_key(?+, :ask_select) # --> calls select_values
+    #   bind_key(?-, :ask_unselect)
+    def unselect_values values
+      return unless values
+      values.each do |val|
+        row = @list.index val
+        remove_row_selection_interval row, row unless row.nil?
+      end
+    end
+    # please override this, this is just very basic and default
+    # Please implement get_matching_indices(String).
+    def ask_select prompt="Enter selection pattern: "
+      ret = ask(prompt, String) {|q| yield q if block_given? }
+      return if ret.nil? || ret ==  ""
+      indices = get_matching_indices ret
+      return if indices.nil? || indices.empty?
+      indices.each { |e|
+        # will not work if single select !! FIXME
+        add_row_selection_interval e,e
+      }
+      @repaint_required = true
+    end
+    def get_matching_indices pattern
+      alert "please implement this method get_matching_indices in your class "
+      return []
+    end # mod
+    # Applications may call this or just copy and modify
+    def list_bindings
+      # what about users wanting 32 and ENTER to also go to next row automatically
+      # should make that optional, TODO
+      bind_key(32) { toggle_row_selection }
+      bind_key(0) { add_to_selection }
+      bind_key(?+, :ask_select) # --> calls select_values
+      bind_key(?-, :ask_unselect)
+      bind_key(?a, :select_all)
+      bind_key(?*, :invert_selection)
+      bind_key(?u, :clear_selection)
+    end
+    def list_init_vars
+      @selected_indices = []
+      @selected_index = nil
+      #@row_selected_symbol = ''
+      if @show_selector
+        @row_selected_symbol ||= '*'
+        @row_unselected_symbol ||= ' '
+        @left_margin ||= @row_selected_symbol.length
+      end
+    end
+    # paint the selector. Called from repaint, prior to printing data row
+    # remember to set left_margin at top of repaint method as:
+    #    @left_margin ||= @row_selected_symbol.length
+    def paint_selector crow, r, c, acolor, attrib
+      selected = is_row_selected crow
+      selection_symbol = ''
+      if @show_selector
+        if selected
+          selection_symbol = @row_selected_symbol
+        else
+          selection_symbol =  @row_unselected_symbol
+        end
+        @graphic.printstring r, c, selection_symbol, acolor,attrib
+      end
+    end
+    def selected_rows
+      @selected_indices
+    end
+  end # mod
+end # mod