rbcurse-core 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1,3 +1,10 @@
+**2011-12-13**
+## 0.0.2 rbcurse-core
+Mostly refactoring of multi-row components
+
+## 0.0.1 rbcurse-core
+Added help system, and printing of key bindings
+
 **2011-12-05**
 ## 0.0.0 rbcurse-core
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/examples/dbdemo.rb

@@ -86,7 +86,7 @@ def view_sql stmt
 end
 
 App.new do 
-  header = app_header "rbcurse #{Rbcurse::VERSION}", :text_center => "Database Demo", :text_right =>"enabled"
+  #header = app_header "rbcurse #{Rbcurse::VERSION}", :text_center => "Database Demo", :text_right =>"enabled"
   form = @form
   mylabel = "a field"
   $catch_alt_digits = true # use M-1..9 in textarea
@@ -126,8 +126,14 @@ App.new do
       :        -   Command mode
       Alt-z    -   Commands in TextArea
       
-                DB BROWSER KEYS
+                Sql Entry Area
+      C-x e        Edit in $EDITOR or vi
+      M-?          To see other key-bindings
+      F4           Execute SQL (there should be only one sql).
 
+
+                Result Set  (this is not present in this demo any longer - moved
+                to rbcurse-extras)
       ,            Prev row (mnemonic <)
       .            Next row (mnemonic >)
       <            First row

data/examples/testlistbox.rb

@@ -1,3 +1,6 @@
+# WARNING : IF THIS PROGRAM HANGS check the ri command 
+# Maybe your version of ri has different options and is going interactive.
+# ruby 1.9.3's ri requires a -l option or else if becomes interactive.
 # this program tests out a listbox
 # This is written in the old style where we start and end ncurses and initiate a 
 # getch loop. It gives more control.
@@ -90,7 +93,7 @@ if $0 == __FILE__
       h = FFI::NCurses.LINES-3
       file = "./data/ports.txt"
       #mylist = File.open(file,'r').readlines 
-      mylist = `ri -f bs`.split("\n")
+      mylist = `ri -l `.split("\n")
       w = 25
       #0.upto(100) { |v| mylist << "#{v} scrollable data" }
       #

data/lib/rbcurse/core/include/bordertitle.rb

@@ -5,15 +5,18 @@ module BorderTitle
     dsl_accessor :border_attrib, :border_color
     dsl_accessor :title                       #set this on top
     dsl_accessor :title_attrib                #bold, reverse, normal
-    dsl_accessor :border_attrib, :border_color # 
 
     def bordertitle_init
+      @_bordertitle_init_called = true
       @row_offset = @col_offset = 0 if @suppress_borders 
-      @internal_width = 1 if @suppress_borders
+      @internal_width = 1 if @suppress_borders # the other programs have zero not 1 NOTE
     end
     # why the dash does it reduce height by one.
     def print_borders
+      bordertitle_init unless @_bordertitle_init_called
       raise ArgumentError, "Graphic not set" unless @graphic
+      raise "#{self} needs width" unless @width
+      raise "#{self} needs height" unless @height
       width = @width
       height = @height-1
       window = @graphic
@@ -26,6 +29,7 @@ module BorderTitle
       print_title
     end
     def print_title
+      bordertitle_init unless @_bordertitle_init_called
       return unless @title
       raise "#{self} needs width" unless @width
       @color_pair ||= get_color($datacolor) # should we not use this ??? XXX 
@@ -39,3 +43,4 @@ module BorderTitle
     end
 
 end
+include BorderTitle

data/lib/rbcurse/core/include/chunk.rb

@@ -148,7 +148,7 @@ module Chunks
         when String
 
           ## create the chunk
-          $log.debug "XXX:  CHUNK     using on #{p}  : #{@color_pair} , #{@attrib} "
+          #$log.debug "XXX:  CHUNK     using on #{p}  : #{@color_pair} , #{@attrib} " # 2011-12-10 12:38:51
 
           #chunk =  [color_pair, p, attrib] 
           chunk = Chunk.new @color_pair, p, @attrib

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

@@ -0,0 +1,70 @@
+# ----------------------------------------------------------------------------- #
+#         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: 2011-12-11 - 12:59
+# ----------------------------------------------------------------------------- #
+#
+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
+      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() }
+        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/rbcurse/core/include/listscrollable.rb

@@ -84,6 +84,7 @@ module ListScrollable
     rc = row_count
     @old_toprow = @toprow
 
+    @_header_adjustment ||= 0
     @current_index = 0 if @current_index < 0  # not lt 0
     @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
@@ -92,7 +93,11 @@ module ListScrollable
       @toprow = @current_index - h
     elsif @current_index < @toprow
       # curr has gone above table,  move toprow up
-      @toprow = @current_index
+      # sometimes current row gets hidden below header line
+      @toprow = @current_index - (@_header_adjustment ||0)
+      # prev line can make top row -1, however, if we are going back, lets 
+      # put it at start of page, so first or second row is not hidden
+      @toprow = 0 if @toprow < h
     end
  
     @row_changed = false
@@ -248,7 +253,8 @@ module ListScrollable
   # 2009-01-17 13:25 
   def set_focus_on arow
     @oldrow = @current_index
-    arow += @_header_adjustment if @_header_adjustment # for tables 2011-11-30 
+    # the next line fixed cursor positioning, but when wraparound then it messed up
+    # matching line would get hidden
     @current_index = arow
     bounds_check if @oldrow != @current_index
   end
@@ -283,18 +289,10 @@ module ListScrollable
       @search_direction_prev =  mb.widget("0").value
       @search_case = mb.widget("1").value
       @search_wrap = mb.widget("2").value
-      #
-      #-----
-      #options = ["Search backwards", "case insensitive", "Wrap around"]
-      #sel,regex,hash =  get_string_with_options("Enter regex to search", 20, @last_regex||"", "checkboxes"=>options, "checkbox_defaults"=>[@search_direction_prev,@search_case,@search_wrap])
-      #return if sel != 0
-      #@search_direction_prev =  hash[options[0]]
-      #@search_case = hash[options[1]]
-      #@search_wrap = hash[options[2]]
       if @search_direction_prev == true
-        ix = _find_prev regex, @current_index
+        ix = _find_prev regex, @current_index - (@_header_adjustment || 0), true
       else
-        ix = _find_next regex, @current_index
+        ix = _find_next regex, @current_index - (@_header_adjustment || 0), true
       end
       if ix.nil?
         alert("No matching data for: #{regex}")
@@ -314,13 +312,16 @@ module ListScrollable
     end
     # find forwards
     # Using this to start a search or continue search
-    def _find_next regex=@last_regex, start = @search_found_ix 
+    def _find_next regex=@last_regex, start = @search_found_ix, first_time = false
       #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}"
+      extra = 1 # first time search on current line, next time skip current line or else we get stuck.
+      extra = 0 if first_time
+      start ||= 0
       fend = @list.size-1
       if start != fend
-        start += 1 unless start == fend
+        start += extra unless start == fend # used to be +=1 so we don't get stuck in same row
         @last_regex = regex
         @search_start_ix = start
         regex = Regexp.new(regex, Regexp::IGNORECASE) if @search_case
@@ -334,6 +335,7 @@ module ListScrollable
           if !m.nil?
             @find_offset = m.offset(0)[0]
             @find_offset1 = m.offset(0)[1]
+            ix += (@_header_adjustment || 0)
             @search_found_ix = ix
             return ix 
           end
@@ -348,6 +350,7 @@ module ListScrollable
           if !m.nil?
             @find_offset = m.offset(0)[0]
             @find_offset1 = m.offset(0)[1]
+            ix += (@_header_adjustment || 0)
             @search_found_ix = ix
             return ix 
           end
@@ -403,6 +406,7 @@ module ListScrollable
         if !m.nil?
           @find_offset = m.offset(0)[0]
           @find_offset1 = m.offset(0)[1]
+          ix += (@_header_adjustment || 0)
           @search_found_ix = ix
           return ix 
         end
@@ -416,7 +420,8 @@ module ListScrollable
           m=row.match(regex)
           if !m.nil?
             @find_offset = m.offset(0)[0]
-          @find_offset1 = m.offset(0)[1]
+            @find_offset1 = m.offset(0)[1]
+            ix += (@_header_adjustment || 0)
             @search_found_ix = ix
             return ix 
           end

data/lib/rbcurse/core/include/listselectable.rb

@@ -206,7 +206,7 @@ module RubyCurses
     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 selection') { toggle_row_selection }
+      bind_key($row_selector || 32, 'toggle selection') { toggle_row_selection }
       bind_key(0, 'range select') { add_to_selection }
       bind_key(?+, :ask_select) # --> calls select_values
       bind_key(?-, :ask_unselect) # please implement FIXME TODO

data/lib/rbcurse/core/system/window.rb

@@ -69,6 +69,8 @@ module VER
       $error_message_row ||= Ncurses.LINES-1
       $error_message_col ||= 1 # ask (bottomline) uses 0 as default so you can have mismatch. XXX
       $status_message ||= RubyCurses::Variable.new # in case not an App
+
+      $key_map ||= :vim
       init_vars
 
 
@@ -288,7 +290,7 @@ module VER
         attrib ||= defattr
 
         cc, bg = ColorMap.get_colors_for_pair color
-        $log.debug "XXX: CHUNK window #{text}, cp #{color} ,  attrib #{attrib}. #{cc}, #{bg} "
+        #$log.debug "XXX: CHUNK window #{text}, cp #{color} ,  attrib #{attrib}. #{cc}, #{bg} " 
         color_set(color,nil) if color
         wattron(attrib) if attrib
         print(text)
@@ -607,7 +609,7 @@ module VER
       if content.is_a? String
         printstring(r,c,content, color, att)
       elsif content.is_a? Chunks::ChunkLine
-        $log.debug "XXX: using chunkline"
+        #$log.debug "XXX: using chunkline" # 2011-12-10 12:40:13
         wmove r, c
         a = get_attrib att
         show_colored_chunks content, color, a

data/lib/rbcurse/core/widgets/applicationheader.rb

@@ -4,7 +4,8 @@
 #               NOTE: on some terminal such as xterm-256color spaces do not print
 #               so you will see black or empty spaces between text.
 #               This does not happen on screen and xterm-color.
-#       Author: rkumar http://github.com/rkumar/rbcurse/
+#               I've done some roundabout stuff to circumvent that.
+#       Author: rkumar http://github.com/rkumar/rbcurse-core/
 #         Date: 
 #      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
 #  Last update: 2011-11-16 - 00:07

data/lib/rbcurse/core/widgets/rlist.rb

@@ -16,6 +16,7 @@ CHANGES
 =end
 require 'rbcurse'
 require 'rbcurse/core/include/listcellrenderer'
+require 'rbcurse/core/include/bordertitle'
 #require 'rbcurse/extras/include/listkeys'
 require 'forwardable'
 
@@ -42,12 +43,12 @@ module RubyCurses
     include NewListSelectable                           # added 2011-10-8 
     extend Forwardable
     #dsl_accessor :height # << widget already has this
-    dsl_accessor :title
-    dsl_property :title_attrib   # bold, reverse, normal
+    #dsl_accessor :title
+    #dsl_property :title_attrib   # bold, reverse, normal
 #   dsl_accessor :list    # the array of data to be sent by user
     attr_reader :toprow
     #dsl_accessor :default_values  # array of default values
-    dsl_accessor :is_popup       # if it is in a popup and single select, selection closes
+    #dsl_accessor :is_popup       # if it is in a popup and single select, selection closes
     attr_accessor :current_index
     dsl_accessor :selection_mode
     dsl_accessor :selected_color, :selected_bgcolor, :selected_attr
@@ -60,13 +61,12 @@ module RubyCurses
     # please set these in he constructor block. Settin them later will have no effect
     # since i would have bound them to actions
     attr_accessor :one_key_selection # will pressing a single key select or not
-    dsl_accessor :border_attrib, :border_color # 
     # set to true if data could have newlines, tabs, and other stuff, def true
     dsl_accessor :sanitization_required
     # set to true if cell-renderer data can exceed width of listbox, default true
     # if you are absolutely sure that data is constant width, set to false.
     dsl_accessor :truncation_required
-    dsl_accessor :suppress_borders #to_print_borders
+    #dsl_accessor :suppress_borders #to_print_borders
     dsl_accessor :justify # will be picked up by renderer
     # index of selected row
     attr_accessor :selected_index
@@ -107,7 +107,8 @@ module RubyCurses
 
       init_vars
       @internal_width = 2
-      @internal_width = 0 if @suppress_borders
+      #@internal_width = 0 if @suppress_borders # NOTE it is 1 in bordertitle
+      bordertitle_init
 
       if @list && !@selected_index.nil?  # XXX
         set_focus_on @selected_index # the new version
@@ -132,21 +133,12 @@ module RubyCurses
     end
     def map_keys
       return if @keys_mapped
+      require 'rbcurse/core/include/listbindings'
+      bindings()
       bind_key(?f, 'next row starting with char'){ ask_selection_for_char() }
-      bind_key(?\M-v, 'toggle one_key_selection'){ @one_key_selection = false }
-      bind_key(?j, 'next row'){ next_row() }
-      bind_key(?k, 'previous row'){ previous_row() }
-      bind_key(?\C-d, 'scroll forward'){ scroll_forward() }
-      bind_key(?\C-b, 'scroll backward'){ scroll_backward() }
-      bind_key(?G, 'goto end'){ goto_bottom() }
-      bind_key([?g,?g], 'goto top'){ goto_top() }
-      bind_key([?',?'], 'goto last position'){ goto_last_position() }
-      bind_key(?/, 'ask search'){ ask_search() }
-      bind_key(?n, 'find next'){ find_more() }
-      bind_key(32){ toggle_row_selection() }
-      bind_key(10, 'fire action event'){ fire_action_event }
+      bind_key(?\M-v, 'toggle one_key_selection'){ @one_key_selection = !@one_key_selection }
       bind_key(13, 'fire action event'){ fire_action_event }
-      list_bindings
+      list_bindings # listselectable
       @keys_mapped = true
 
     end
@@ -242,24 +234,6 @@ module RubyCurses
     alias :current_row :current_value
     alias :text :current_value  # thanks to shoes, not sure how this will impact since widget has text.
 
-    def print_borders #:nodoc:
-      width = @width
-      height = @height-1 # 2010-01-04 15:30 BUFFERED HEIGHT
-      window = @graphic  # 2010-01-04 12:37 BUFFERED
-      startcol = @col 
-      startrow = @row 
-      #@color_pair = get_color($datacolor)
-      bordercolor = @border_color || $datacolor
-      borderatt = @border_attrib || Ncurses::A_NORMAL
-
-      window.print_border startrow, startcol, height, width, bordercolor, borderatt
-      print_title
-    end
-    def print_title #:nodoc:
-      @color_pair ||= get_color($datacolor)
-      # TODO check title.length and truncate if exceeds width
-      @graphic.printstring( @row, @col+(@width-@title.length)/2, @title, @color_pair, @title_attrib) unless @title.nil?
-    end
     ### START FOR scrollable ###
     def get_content
       @list 
@@ -278,59 +252,41 @@ module RubyCurses
       #map_keys unless @keys_mapped
       @current_index ||= 0
       @toprow ||= 0
-      h = scrollatrow()
-      rc = row_count
-      $log.debug " basiclistbox got ch #{ch}"
+      #h = scrollatrow()
+      #rc = row_count
+      #$log.debug " basiclistbox got ch #{ch}"
       #$log.debug " when kps #{@KEY_PREV_SELECTION}  "
       case ch
-      when KEY_UP  # show previous value
-        return previous_row
-      when KEY_DOWN  # show previous value
-        return next_row
-      when 32
-        return if is_popup and @selection_mode == 'single' # not allowing select this way since there will be a difference 
-        toggle_row_selection @current_index #, @current_index
-        @repaint_required = true
-      when 0 # c-space
-        add_to_selection
-      when @KEY_NEXT_SELECTION # ?'
-        $log.debug "insdie next selection"
-        @oldrow = @current_index
-        do_next_selection 
-        bounds_check
-      when @KEY_PREV_SELECTION # ?"
-        @oldrow = @current_index
-        $log.debug "insdie prev selection"
-        do_prev_selection 
-        bounds_check
-      when @KEY_CLEAR_SELECTION
-        clear_selection 
-        @repaint_required = true
+      #when 32
+        #return if is_popup and @selection_mode == 'single' # not allowing select this way since there will be a difference 
+        #toggle_row_selection @current_index #, @current_index
+        #@repaint_required = true
+      #when 0 # c-space
+        #add_to_selection
+      #when @KEY_NEXT_SELECTION # ?'
+        #$log.debug "insdie next selection"
+        #@oldrow = @current_index
+        #do_next_selection 
+        #bounds_check
+      #when @KEY_PREV_SELECTION # ?"
+        #@oldrow = @current_index
+        #$log.debug "insdie prev selection"
+        #do_prev_selection 
+        #bounds_check
+      #when @KEY_CLEAR_SELECTION
+        #clear_selection 
+        #@repaint_required = true
       when 27, ?\C-c.getbyte(0)
-        #editing_canceled @current_index if @cell_editing_allowed
-        #cancel_block # block NW XXX don't think its required. 2011-09-9  FFI
         $multiplier = 0
-      when @KEY_ASK_FIND_FORWARD
-      # ask_search_forward
-      when @KEY_ASK_FIND_BACKWARD
-      # ask_search_backward
-      when @KEY_FIND_NEXT
-      # find_next
-      when @KEY_FIND_PREV
-      # find_prev
-      when @KEY_ASK_FIND
-        ask_search
-      when @KEY_FIND_MORE
-        find_more
       when @KEY_BLOCK_SELECTOR
         mark_block #selection
       #when ?\C-u.getbyte(0)
         # multiplier. Series is 4 16 64
         # TESTING @multiplier = (@multiplier == 0 ? 4 : @multiplier *= 4)
       #  return 0
-      when ?\C-c.getbyte(0)
-        @multiplier = 0
-        return 0
+      #when ?\C-c.getbyte(0)
+        #@multiplier = 0
+        #return 0
       else
         # this has to be fixed, if compo does not handle key it has to continue into next part FIXME
         ret = :UNHANDLED # changed on 2009-01-27 13:14 not going into unhandled, tab not released