rbhex-core 1.0.0

data/lib/rbhex/core/include/listbindings.rb

@@ -0,0 +1,74 @@
+# ----------------------------------------------------------------------------- #
+#         File: listbindings.rb
+#  Description: bindings for multi-row widgets such as listbox, table, textview
+#       Author: rkumar http://github.com/rkumar/rbcurse/
+#         Date: 2011-12-11 - 12:58
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: 2013-03-25 01:53
+# ----------------------------------------------------------------------------- #
+#
+module RubyCurses
+  #
+  #  bindings for multi-row widgets such as listbox, table, textview
+  #
+  module ListBindings
+    extend self
+    def bindings
+    $log.debug "XXX:  INSIDE LISTBINDING FOR #{self.class} "
+      bind_key(Ncurses::KEY_LEFT, 'cursor backward'){ cursor_backward } if respond_to? :cursor_backward
+      bind_key(Ncurses::KEY_RIGHT, 'cursor_forward'){ cursor_forward } if respond_to? :cursor_forward
+      # very irritating when user pressed up arrow, commented off 2012-01-4  can be made optional
+      bind_key(Ncurses::KEY_UP, 'previous row'){ ret = up;  } #get_window.ungetch(KEY_BTAB) if ret == :NO_PREVIOUS_ROW }
+      # the next was irritating if user wanted to add a row ! 2011-10-10
+      #bind_key(Ncurses::KEY_DOWN){ ret = down ; get_window.ungetch(KEY_TAB) if ret == :NO_NEXT_ROW }
+      bind_key(Ncurses::KEY_DOWN, 'next row'){ ret = down ; }
+
+      # this allows us to set on a component basis, or global basis
+      # Motivation was mainly for textarea which needs emacs keys
+      kmap = @key_map || $key_map || :both
+      if kmap == :emacs || kmap == :both
+        bind_key(?\C-v, 'scroll forward'){ scroll_forward }
+        # clashes with M-v for toggle one key selection, i guess you can set it as you like
+        bind_key(?\M-v, 'scroll backward'){ scroll_backward }
+        bind_key(?\C-s, 'ask search'){ ask_search() }
+        bind_key(?\C-n, 'next row'){ next_row() }
+        bind_key(?\C-p, 'previous row'){ previous_row() }
+        bind_key(?\M->, 'goto bottom'){ goto_bottom() }
+        bind_key(?\M-<, 'goto top'){ goto_top() }
+        bind_key([?\C-x, ?>], :scroll_right)
+        bind_key([?\C-x, ?<], :scroll_left)
+      end
+      if kmap == :vim || kmap == :both
+        # some of these will not have effect in textarea such as j k, gg and G, search
+        bind_key(?j, 'next row'){ next_row() }
+        bind_key(?k, 'previous row'){ previous_row() }
+        ## added 2013-03-04 - 17:52
+        bind_key(?w, 'forward_word'){ forward_word }
+        bind_key(?b, 'backward_word'){ backward_word }
+        bind_key(?\C-d, 'scroll forward'){ scroll_forward() }
+        bind_key(?\C-b, 'scroll backward'){ scroll_backward() }
+        bind_key([?g,?g], 'goto start'){ goto_start } # mapping double keys like vim
+        bind_key(?G, 'goto end'){ goto_bottom() }
+        bind_key([?',?'], 'goto last position'){ goto_last_position } # vim , goto last row position (not column)
+
+        bind_key(?/, :ask_search)
+        bind_key(?n, :find_more)
+        bind_key(?h, 'cursor backward'){ cursor_backward }  if respond_to? :cursor_backward
+        bind_key(?l, 'cursor forward'){ cursor_forward } if respond_to? :cursor_forward
+      end
+      bind_key(?\C-a, 'start of line'){ cursor_bol } if respond_to? :cursor_bol
+      bind_key(?\C-e, 'end of line'){ cursor_eol } if respond_to? :cursor_eol
+      bind_key(?\M-l, :scroll_right)
+      bind_key(?\M-h, :scroll_left)
+
+      # save as and edit_external are only in textview and textarea
+      # save_as can be given to list's also and tables
+      # put them someplace so the code can be shared.
+      bind_key([?\C-x, ?\C-s], :saveas)
+      bind_key([?\C-x, ?e], :edit_external)
+
+      # textview also uses space for scroll_forward
+    end # def
+  end
+end
+include RubyCurses::ListBindings

data/lib/rbhex/core/include/listcellrenderer.rb

@@ -0,0 +1,140 @@
+require 'rbhex/core/widgets/rwidget'
+module RubyCurses
+
+  ##
+  #  2010-09-27 11:06 : i have modified this quite a bit, to calculate some stuff
+  #  once in the init, to reduce work in repaint
+  # 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
+  # NOTE: this class is being extended by many other classes. Careful while making
+  # sweeping changes.
+  class ListCellRenderer
+    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
+    # NOTE: please call super() if you override this
+    def init_vars  #:nodoc:
+      # omg, some classes won't have justify !!
+      #@justify ||= (@parent.justify || :left)
+      unless @justify
+        if @parent.respond_to? :justify
+          @justify ||= (@parent.justify || :left)
+        else
+          @justify ||= :left
+        end
+      end
+      @format = @justify.to_sym == :right ? "%*s" : "%-*s"
+      @display_length ||= 10
+      # create color pairs once for this 2010-09-26 20:53
+    end
+    # creates pairs of colors at start
+    # since often classes are overriding init_vars, so not gettin created
+    def create_color_pairs
+      @color_pair = get_color $datacolor
+      @pairs = Hash.new(@color_pair)
+      @attrs = Hash.new(Ncurses::A_NORMAL)
+      color_pair = get_color $selectedcolor, @parent.selected_color, @parent.selected_bgcolor
+      @pairs[:normal] = @color_pair
+      @pairs[:selected] = color_pair
+      @pairs[:focussed] = @pairs[:normal]
+      @attrs[:selected] = $row_selected_attr
+      @attrs[:focussed] = $row_focussed_attr
+
+    end
+    def getvalue
+      @text
+    end
+    ##
+    # sets @color_pair and @attr
+    def select_colors focussed, selected
+      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 || $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]
+        @attr       = @attrs[:selected]
+      elsif focussed
+        @color_pair = @pairs[:focussed]
+        @attr       = @attrs[:focussed]
+      end
+    end
+
+    ##
+    #  paint a list box cell
+    #
+    #  @param [Buffer] window or buffer object used for printing
+    #  @param [Fixnum] row
+    #  @param [Fixnum] column
+    #  @param [Fixnum] actual index into data, some lists may have actual data elsewhere and
+    #                  display data separate. e.g. rfe_renderer (directory listing)
+    #  @param [String] text to print in cell
+    #  @param [Boolean, cell focussed, not focussed
+    #  @param [Boolean] cell selected or not
+    def repaint graphic, r=@row,c=@col, row_index=-1,value=@text, focussed=false, selected=false
+
+      select_colors focussed, selected
+      # if listboxes width is reduced, display_len remains the same
+      # XXX FIXME parent may not be the list but a container like rfe !!
+      # maybe caller should update at start of repain loop.
+      #@display_length = @parent.width - 2 - @parent.left_margin
+
+      value=value.to_s
+      if !@display_length.nil?
+        if value.length > @display_length
+          value = value[0..@display_length-1]
+        end
+        # added 2010-09-27 11:05 TO UNCOMMENT AND TEST IT OUT
+        if @justify == :center
+          value = value.center(@display_length)
+        end
+      end
+      len = @display_length || value.length
+      #$log.debug " XXX @display_length: #{@display_length}, #{value.length}, L:#{len}, pw:#{@parent.width} ::attr:: #{@attr} "
+      graphic.printstring r, c, @format % [len, value], @color_pair, @attr
+    end # repaint
+
+    # @deprecated
+    # only for older code that may have extended this.
+    def prepare_default_colors focussed, selected
+        @color_pair = get_color $datacolor
+        @attr = @row_attr || Ncurses::A_NORMAL
+
+
+        ## 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
+        case focussed
+        when :SOFT_FOCUS
+          @attr |= Ncurses::A_BOLD
+        when true
+          @attr |= Ncurses::A_REVERSE
+        when false
+        end
+        #if focussed
+          #@attr |= Ncurses::A_REVERSE
+        #end
+    end
+  end # class
+
+end # module

data/lib/rbhex/core/include/listeditable.rb

@@ -0,0 +1,317 @@
+# Some methods for manipulating lists
+# Different components may bind different keys to these
+# Currently will be called by TextArea and the editable version
+# of TextView (vieditable).
+#
+require 'rbhex/core/include/rinputdataevent'
+module ListEditable
+
+    def remove_all
+      @list = []
+      set_modified  # added 2009-02-13 22:28 so repaints
+    end
+    # current behav is a mix of vim's D and C-k from alpine, i don;t know how i screwed it up like this
+    # Should be:
+    # 1. do not take cursor back by 1 (this is vims D behavior)
+    # 2. retain EOL, we need to evaluate at undo
+    # 3. if nothing coming in delete buffer then join next line here
+    # 4. if line is blank, it will go to delete line (i think).
+    # Earlier, a C-k at pos 0 would blank the line and not delete it (copied from alpine).
+    # The next C-k would delete. emacs deletes if C-k at pos 0.
+    def delete_eol
+      return -1 unless @editable
+      pos = @curpos -1 # retain from 0 till prev char
+      @delete_buffer = @buffer[@curpos..-1]
+      # currently eol is there in delete_buff often. Should i maintain it ? 2010-03-08 18:29 UNDO
+      #@delete_buffer.chomp! # new 2010-03-08 18:29 UNDO - this worked but hope does not have othe impact
+
+      # if pos is 0, pos-1 becomes -1, end of line!
+      @list[@current_index] = pos == -1 ? "" : @buffer[0..pos]
+      $log.debug "delete EOL :pos=#{pos}, #{@delete_buffer}: row: #{@list[@current_index]}:"
+      @buffer = @list[@current_index]
+      if @delete_buffer == ""
+        $log.debug " TA: DELETE going to join next "
+        join_next_line # pull next line in
+      end
+      oldcur = @curpos
+      #x cursor_backward if @curpos > 0 #  this was vims behavior -- knoecked off
+      #fire_handler :CHANGE, self  # 2008-12-09 14:56
+      fire_handler :CHANGE, InputDataEvent.new(oldcur,oldcur+@delete_buffer.length, self, :DELETE, @current_index, @delete_buffer)     #  2008-12-24 18:34
+      set_modified
+      return @delete_buffer
+    end
+    def join_next_line
+      # return if last line  TODO
+      buff = @list.delete_at(@current_index + 1)
+      if buff
+        $log.debug " TA: DELETE inside to join next #{buff}  "
+        fire_handler :CHANGE, InputDataEvent.new(0,0+buff.length, self, :DELETE_LINE, @current_index+1, buff)
+        @buffer << buff
+      end
+    end
+  # deletes given line or current
+  # now fires DELETE_LINE so no guessing by undo manager
+  def delete_line line=@current_index
+    return -1 unless @editable
+    if !$multiplier || $multiplier == 0
+      @delete_buffer = @list.delete_at line
+    else
+      @delete_buffer = @list.slice!(line, $multiplier)
+    end
+    @curpos ||= 0 # rlist has no such var
+    $multiplier = 0
+    add_to_kill_ring @delete_buffer
+    @buffer = @list[@current_index]
+    if @buffer.nil?
+      up
+      setrowcol @row + 1, nil # @form.col
+    end
+    # warning: delete buffer can now be an array
+    fire_handler :CHANGE, InputDataEvent.new(@curpos,@curpos+@delete_buffer.length, self, :DELETE_LINE, line, @delete_buffer)     #  2008-12-24 18:34
+    set_modified
+    @widget_scrolled = true
+    @repaint_required = true
+  end
+    def delete_curr_char num=($multiplier == 0 ? 1 : $multiplier)
+      return -1 unless @editable
+      delete_at @curpos, num # changed so only one event, and one undo
+      set_modified
+      $multiplier = 0
+    end
+    #
+    # 2010-03-08 23:30 does not seem to be working well when backspacing at first char of line
+    # FIXME should work as a unit, so one undo and one fire_handler, at least if on one line.
+    def delete_prev_char num=($multiplier == 0 ? 1 : $multiplier)
+      return -1 if !@editable
+      num.times do
+        if @curpos <= 0
+          join_to_prev_line
+          return
+        end
+        @curpos -= 1 if @curpos > 0
+        delete_at
+        set_modified
+        addcol -1
+      end
+      $multiplier = 0
+    end
+    # open a new line and add chars to it.
+    # FIXME does not fire handler, thus won't undo
+    def append_row lineno=@current_index, chars=""
+        $log.debug "append row sapce:#{chars}."
+      @list.insert lineno+1, chars
+    end
+    ##
+    # delete character/s on current line
+    def delete_at index=@curpos, howmany=1
+      return -1 if !@editable
+      $log.debug "delete_at (characters) : #{@current_index} #{@buffer} #{index}"
+      char = @buffer.slice!(@curpos,howmany)  # changed added ,1 and take char for event
+      # if no newline at end of this then bring up prev character/s till maxlen
+      # NO WE DON'T DO THIS ANYLONGER 2008-12-26 21:09 lets see
+=begin
+      if @buffer[-1,1]!="\r"
+        @buffer[-1]=" " if @buffer[-1,1]=="\n"
+        if !next_line.nil? and next_line.length > 0
+          move_chars_up
+        end
+      end
+=end
+      set_modified true
+      fire_handler :CHANGE, InputDataEvent.new(@curpos,@curpos+howmany, self, :DELETE, @current_index, char)     #  2008-12-24 18:34
+    end
+    def undo_handler(uh)
+      @undo_handler = uh
+    end
+    ## THIS ONE SHOULD BE IN TEXTVIEW ALSO
+    # saves current or n lines into kill ring, appending to earlier contents
+    # Use yank (paste) or yank-pop to retrieve
+    def kill_ring_save
+      pointer = @current_index
+      list = []
+      repeatm {
+        line =  @list[pointer]
+        list << line unless line.nil?
+        pointer += 1
+      }
+      add_to_kill_ring list
+    end
+    ## THIS ONE SHOULD BE IN TEXTVIEW ALSO
+    # add given line or lines to kill_ring
+    def add_to_kill_ring list
+      # directly referenceing kill_ring.  We need to OO it a bit, so we can change internals w'o breaking all.
+      # FIXME
+      if $append_next_kill
+        # user requested this kill to be appened to last kill, so it can be yanked as one
+        #$kill_ring.last << list
+        last = $kill_ring.pop
+        $log.debug "YANK: addto : last= #{last} , list= #{list} "
+        case list
+        when Array
+          #list.insert 0, last
+          list.insert 0, *last # 2011-10-10 changed as it was wrong in textarea
+          $kill_ring << list
+        when String
+          $kill_ring << [last, list]
+        end
+      else
+        $kill_ring << list
+      end
+      $kill_ring_pointer = $kill_ring.size
+      $append_next_kill = false
+      $log.debug "YANK: kill_ring: #{$kill_ring} "
+    end
+
+    # pastes recent (last) entry of kill_ring.
+    # This can be one or more lines. Please note that for us vimmer's yank means copy
+    # but for emacsers it seems to mean paste. Aargh!!
+    # earlier it was not +1, it was pasting before not after
+    def yank where=@current_index+1
+      return -1 if !@editable
+      return if $kill_ring.empty?
+      row = $kill_ring.last
+      $log.debug "YANK: row #{row} "
+      index = where
+      case row
+      when Array
+        #index = @current_index
+        row.each{ |r|
+          @list.insert index, r.dup
+          index += 1
+        }
+        $kill_last_pop_size = row.size
+      when String
+        #@list[@current_index].insert row.dup
+        #@list.insert @current_index, row.dup
+        @list.insert index, row.dup
+        $kill_last_pop_size = 1
+      else
+        raise "textarea yank got uncertain datatype from kill_ring  #{row.class} "
+      end
+      $kill_ring_pointer = $kill_ring.size - 1
+      $kill_ring_index = @current_index # pops will replace data in this row, never an insert
+      @repaint_required = true
+      @widget_scrolled  = true
+      # XXX not firing anything here, so i can't undo. yet, i don't know whether a yank will
+      # be followed by a yank-pop, in which case it will not be undone.
+      # object row can be string or array - time to use INSERT_LINE so we are clear
+      # row.length can be array's size or string length - beware
+      fire_handler :CHANGE, InputDataEvent.new(0,row.length, self, :INSERT_LINE, @current_index, row)
+      return 0 # don't want a UNHANDLED or NO_BLOCK going back
+    end
+
+    # paste previous entries from kill ring
+    # I am not totally clear on this, not being an emacs user. but seems you have to do C-y
+    # once (yank) before you can do a yank pop.
+    def yank_pop
+      return -1 if !@editable
+      return if $kill_ring.empty?
+      mapped_key = @current_key # we are mapped to this
+      # checking that user has done a yank on this row. We only replace on the given row, never
+      # insert. But what if user edited after yank, Sheesh ! XXX
+      if $kill_ring_index != @current_index
+        Ncurses.beep
+        return # error message required that user must yank first
+      end
+      # the real reason i put this into a loop is so that i can properly undo the
+      # action later if required. I only need to store the final selection.
+      # This also ensures the user doesn't wander off in between and come back.
+      row = nil
+      while true
+        # remove lines from last replace, then insert
+        index = @current_index
+        $kill_last_pop_size.times {
+          del = @list.delete_at index
+        }
+        row = $kill_ring[$kill_ring_pointer-$multiplier]
+        $multiplier = 0
+        index = @current_index
+        case row
+        when Array
+          row.each{ |r|
+            @list.insert index, r.dup
+            index += 1
+          }
+          $kill_last_pop_size = row.size
+        when String
+          @list.insert index, row.dup
+          $kill_last_pop_size = 1
+        else
+          raise "textarea yank_pop got uncertain datatype from kill_ring  #{row.class} "
+        end
+
+        $kill_ring_pointer -= 1
+        if $kill_ring_pointer < 0
+          # should be size, but that'll give an error. need to find a way!
+          $kill_ring_pointer = $kill_ring.size - 1
+        end
+        @repaint_required = true
+        @widget_scrolled  = true
+        my_win = @form || @parent_component.form # 2010-02-12 12:51
+        my_win.repaint
+        ch = @graphic.getchar
+        if ch != mapped_key
+          @graphic.ungetch ch # seems to work fine
+          return ch # XXX to be picked up by handle_key loop and processed
+        end
+      end
+      # object row can be string or array - time to use INSERT_LINE so we are clear
+      # row.length can be array's size or string length - beware
+      fire_handler :CHANGE, InputDataEvent.new(0,row.length, self, :INSERT_LINE, @current_index, row)
+      return 0
+    end
+    def append_next_kill
+      $append_next_kill = true
+    end
+    # deletes count words on current line
+    # Does not at this point go beyond the line
+    def delete_word
+      return -1 unless @editable
+      $multiplier = 1 if !$multiplier || $multiplier == 0
+      line = @current_index
+      pos = @curpos
+      @delete_buffer = ""
+      # currently only look in current line
+      $multiplier.times {
+        found = @buffer.index(/[[:punct:][:space:]]/, pos)
+        break if !found
+        $log.debug " delete_word: pos #{pos} found #{found} buff: #{@buffer} "
+        @delete_buffer << @buffer.slice!(pos..found)
+      }
+      return if @delete_buffer == ""
+      $log.debug " delete_word: delbuff #{@delete_buffer} "
+      add_to_kill_ring @delete_buffer
+      fire_handler :CHANGE, InputDataEvent.new(@curpos,@curpos+@delete_buffer.length, self, :DELETE, line, @delete_buffer)     #  2008-12-24 18:34
+      set_modified
+    end
+    ##
+    # deletes forward till the occurence of a character
+    # it gets the char from the user
+    # Should we pass in the character (and accept it as a separate func) ???
+    def delete_forward
+      return -1 unless @editable
+      ch = @graphic.getchar
+      return if ch < 0 || ch > 255
+      char = ch.chr
+      $multiplier = 1 if !$multiplier || $multiplier == 0
+      line = @current_index
+      pos = @curpos
+      tmpbuf = ""
+      # currently only look in current line
+      $multiplier.times {
+        found = @buffer.index(char, pos)
+        break if !found
+        #$log.debug " delete_forward: pos #{pos} found #{found} buff: #{@buffer} "
+        # ideally do this in one shot outside loop, but its okay here for now
+        tmpbuf << @buffer.slice!(pos..found)
+      }
+      return if tmpbuf == ""
+      @delete_buffer = tmpbuf
+      $log.debug " delete_forward: delbuff #{@delete_buffer} "
+      add_to_kill_ring @delete_buffer
+      fire_handler :CHANGE, InputDataEvent.new(@curpos,@curpos+@delete_buffer.length, self, :DELETE, line, @delete_buffer)     #  2008-12-24 18:34
+      set_modified
+      $multiplier = 0
+    end
+
+end # end module