rbcurse-core 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,3 +1,11 @@
+**2012-01-  **
+## 0.0.4 rbcurse-core
+   * added RESIZE event to form, so resizing app components is possible
+	 when window/terminal is resized
+	 * changes to ncurses setting as a result of above (wtimeout commented off)
+	 * Moving help system to Form
+	 * minor addition of define_prefix_command to Form - experimental
+
 **2012-01-04**
 ## 0.0.3 rbcurse-core
    * ActionManager added to widgets so actions can be 

data/README.md

@@ -1,5 +1,7 @@
 # rbcurse-core
 
+** Working on 1.9.3 **
+
 Contains core widgets and infrastructure of rbcurse ncurses toolkit. rbcurse helps to easily build
 ncurses application for text terminals.
 
@@ -37,6 +39,12 @@ Core intends to be :
 
    * simple, maintainable code
 
+## Testing Status
+
+   * Working on 1.9.3-p392  (environment is zsh 5.0.x, tmux, TERM=screen-256color, OSX ML)
+
+## Other 
+
 I shall be standardizing core over the next one or two minor versions. I shall also be simplifying code as much as possible to make it maintainable and more bug-free.
 
 Method names in some classes may change, and one or two widget names will change. rbasiclistbox will become listbox while the old listbox that has moved to extras will become something like editlistbox. Similarly the old table will become edittable in extras, whereas tabularwidget will becoming table in core.
@@ -58,16 +66,25 @@ the core a bit more. The code lies on github.
 
    `gem install rbcurse`             # the core, extra and experimental stuff
 
-## See also
+## Examples
 
-* rbcurse - <http://github.com/rkumar/rbcurse/>
+   Some examples have dependencies.
+
+   * dbdemo requires sqlite3 gem (and sqlite).
+   * testlistbox require ri documentation 
+      `rvm docs generate-ri`
+     I have improved this demo and released it as the gem 'ribhu' (ri browser).
+
+## See also
 
 * rbcurse-extras - <http://github.com/rkumar/rbcurse-extras/>
 
 * rbcurse-experimental - <http://github.com/rkumar/rbcurse-experimental/>
 
+* rbcurse - <http://github.com/rkumar/rbcurse/>
+
 ## License
 
   Same as ruby license.
 
-  (c) copyright rkumar, 2008-2011.
+  (c) copyright rkumar, 2008-2013.

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/examples/abasiclist.rb

@@ -119,13 +119,39 @@ App.new do
     res ||= "Error in command [#{cmd}] [#{name}] "
     textdialog( res, :title => cmd ) if res
   end
+  # handle resizing, sadly I am not sure flow and stack can do a resize, i am sure the xperimental one can.
+  def resize
+    lb1 = @form.by_name["lb1"]
+    lb2 = @form.by_name["lb2"]
+    maxc = Ncurses.COLS
+    maxr = Ncurses.LINES
+    lb1.height = maxr-2
+    lb2.height = maxr-2
+    lb1.width = ((lb1.width_pc * maxc) / 100).floor
+    lb2.width = ((lb2.width_pc * maxc) / 100).floor
+    lb2.col   = lb1.col + lb1.width
+    lab = @form.by_name["lab"]
+    lab.row = maxr-1
+  end
 
   colors = Ncurses.COLORS
   back = :blue
   back = 234 if colors >= 256
   header = app_header "rbcurse #{Rbcurse::VERSION}", :text_center => "Basic List Demo", :text_right =>"New Improved!", :color => :white, :bgcolor => back #, :attr => :bold 
   message "Press F10 to escape from here"
-  install_help_text my_help_text
+  #install_help_text my_help_text
+  @form.help_manager.help_text = my_help_text
+
+  @form.define_prefix_command :csmap, :scope => self
+  #@form.define_key(:csmap, "r", 'refresh') { refresh }
+  @form.define_key(:csmap, "r", 'refresh', :refresh )
+  @form.define_key(:csmap, "s", 'specification') { specification }
+  @form.bind_key ?\C-s, :csmap
+  #pm = PrefixCommand.new :csmap, self do |p|
+    #p.key("r", 'refresh', :refresh )
+    #p.key("s", 'specification'){ specification }
+  #end
+  #@form.bind_key(?\C-x){ pm.call }
 
   alist = File.open("data/brew.txt",'r').readlines
   list2 = File.open("data/gemlist.txt",'r').readlines
@@ -141,8 +167,9 @@ App.new do
     end
   
  
-  label({:text => "F1 Help, F10 Quit. : for menu. Press F4 and F5 to test popup, space or enter to select", :row => Ncurses.LINES-1, :col => 0})
+  label({:text => "F1 Help, F10 Quit. : for menu. Press F4 and F5 to test popup, space or enter to select", :row => Ncurses.LINES-1, :col => 0, :name => 'lab'})
 
+  @form.bind(:RESIZE) { resize() }
   @form.bind_key(FFI::NCurses::KEY_F4) { row = lb.current_index+lb.row; col=lb.col+lb.current_value.length+1;  ret = popuplist(%w[ andy berlioz strauss tchaiko matz beethoven], :row => row, :col => col, :title => "Names", :bgcolor => :blue, :color => :white) ; alert "got #{ret} "}
 
   @form.bind_key(FFI::NCurses::KEY_F5) {  list = %x[ls].split("\n");ret = popuplist(list, :title => "Files"); alert "Got #{ret} #{list[ret]} " }

data/examples/alpmenu.rb

@@ -8,24 +8,24 @@ require 'rbcurse/core/util/app'
     stack :margin_top => 10, :margin_left => 15 do
       #w = "Messages".length + 1
       w = 60
-      menulink :text => "&View Todo", :width => w, :description => "View TODO in sqlite"  do |s|
+      menulink :text => "&View Dirs", :width => w, :description => "View Dirs in tree"  do |s|
         message "Pressed #{s.text} "
         load './dirtree.rb'
         #require './viewtodo'; todo = ViewTodo::TodoApp.new; todo.run
       end
       blank
-      menulink :text => "&Edit Todo", :width => w, :description => "Edit TODO in CSV"  do |s|
+      menulink :text => "&Tabular", :width => w, :description => "Tabula Rasa"  do |s|
         message "Pressed #{s.text} "
         load './tabular.rb'
         #require './testtodo'; todo = TestTodo::TodoApp.new; todo.run
       end
       blank
-      menulink :text => "&Messages", :width => w, :description => "View messages in current folder"  do |s|
+      menulink :text => "&Messages", :width => w, :description => "View Tasks"  do |s|
         message "Pressed #{s.text} "
         load './tasks.rb'
       end
       blank
-      menulink :text => "&Compose", :width => w, :description => "Compose a mail"  do |s|
+      menulink :text => "&Database", :width => w, :description => "Database Demo"  do |s|
         message "Pressed #{s.getvalue} "
         load './dbdemo.rb'
       end

data/examples/dbdemo.rb

@@ -161,6 +161,7 @@ App.new do
         alert "Can't find a .db or .sqlite file"
       end
   end
+  @form.help_manager.help_text = help_text()
   # TODO accelerators and 
   # getting a handle for later use
   mb = menubar do

data/examples/dirtree.rb

@@ -21,6 +21,7 @@ App.new do
   end
   header = app_header "rbcurse #{Rbcurse::VERSION}", :text_center => "Yet Another Dir Lister", :text_right =>"Directory Lister" , :color => :white, :bgcolor => :black #, :attr =>  Ncurses::A_BLINK
   message "Press Enter to expand/collapse, <space> to view in lister. <F1> Help"
+  @form.help_manager.help_text = help_text()
 
   pwd = Dir.getwd
   entries = _directories pwd

data/examples/tabular.rb

@@ -1,6 +1,7 @@
 require 'rbcurse/core/util/app'
 
 App.new do 
+  # TODO: combine this with widget menu
   def app_menu
       menu = PromptMenu.new self do
         item :e, :edit
@@ -107,18 +108,30 @@ def _edit h, row, title
     row[i] = f.text
   }
   row
+end
+def resize
+  tab = @form.by_name["tab"]
+  cols = Ncurses.COLS
+  rows = Ncurses.LINES
+  tab.width_pc ||= (1.0*tab.width / $orig_cols)
+  tab.height_pc ||= (1.0*tab.height / $orig_rows)
+  tab.height = (tab.height_pc * rows).floor
+  tab.width = (tab.width_pc * cols).floor
 end
   header = app_header "rbcurse #{Rbcurse::VERSION}", :text_center => "Tabular Demo", :text_right =>"Fat-free !", 
       :color => :black, :bgcolor => :green #, :attr => :bold 
   message "Press F10 to exit, F1 for help, : for menu"
+  @form.help_manager.help_text = help_text()
+  $orig_cols = Ncurses.COLS
+  $orig_rows = Ncurses.LINES
 
   h = %w[ Id Title Priority Status]
   file = "data/table.txt"
   lines = File.open(file,'r').readlines 
   arr = []
   lines.each { |l| arr << l.split("|") }
-  flow :margin_top => 1, :height => FFI::NCurses.LINES-3 do
-    tw = tabular_widget :print_footer => true
+  flow :margin_top => 1, :height => FFI::NCurses.LINES-2 do
+    tw = tabular_widget :print_footer => true, :name => "tab"
     tw.columns = h
     tw.column_align 0, :right
     tw.set_content arr
@@ -129,4 +142,5 @@ end
   end # stack
   status_line :row => FFI::NCurses.LINES-1
   @form.bind_key(?:, 'menu') {  app_menu }
+  @form.bind(:RESIZE) {  resize }
 end # app

data/examples/tasks.rb

@@ -23,15 +23,25 @@ class CellRenderer
   end
 end
 App.new do 
+def resize
+  tab = @form.by_name["tasklist"]
+  cols = Ncurses.COLS
+  rows = Ncurses.LINES
+  tab.width_pc ||= (1.0*tab.width / $orig_cols)
+  tab.height_pc ||= (1.0*tab.height / $orig_rows)
+  tab.height = (tab.height_pc * rows).floor
+  tab.width = (tab.width_pc * cols).floor
+  #$log.debug "XXX:  RESIZE h w #{tab.height} , #{tab.width} "
+end
   @default_prefix = " "
   header = app_header "rbcurse #{Rbcurse::VERSION}", :text_center => "Task List", :text_right =>"New Improved!"
 
-  message "Press F10 or qq to escape from here"
+  message "Press F10 or qq to quit "
 
   file = "data/todo.txt"
   alist = File.open(file,'r').readlines if File.exists? file
   #flow :margin_top => 1, :item_width => 50 , :height => FFI::NCurses.LINES-2 do
-  stack :margin_top => 1, :width => :expand, :height => FFI::NCurses.LINES-4 do
+  #stack :margin_top => 1, :width => :expand, :height => FFI::NCurses.LINES-4 do
 
     #task = field :label => "    Task:", :display_length => 50, :maxlen => 80, :bgcolor => :cyan, :color => :black
     #pri = field :label => "Priority:", :display_length => 1, :maxlen => 1, :type => :integer, 
@@ -39,7 +49,7 @@ App.new do
     #pri.overwrite_mode = true
     # u,se voerwrite mode for this TODO and catch exception
 
-    lb = listbox :list => alist.sort, :title => "[ todos ]", :height_pc => 100, :name => "tasklist"
+    lb = listbox :list => alist.sort, :title => "[ todos ]", :name => "tasklist", :row => 1, :height => Ncurses.LINES-4, :width => Ncurses.COLS-1
     lb.should_show_focus = false
     lb.cell_renderer CellRenderer.new
     lb.bind_key(?d, "Delete Row"){ 
@@ -132,8 +142,9 @@ App.new do
         lb.list(lb.list.sort)
       end
     }
-  end # stack
+  #end # stack
   s = status_line
+  @form.bind(:RESIZE) {  resize }
 
     keyarray = [
       ["F1" , "Help"], ["F10" , "Exit"], 

data/examples/term2.rb

@@ -26,7 +26,8 @@ require 'rbcurse/core/widgets/scrollbar'
 App.new do 
   header = app_header "rbcurse #{Rbcurse::VERSION}", :text_center => "Tabular Demo", :text_right =>"New Improved!", :color => :black, :bgcolor => :white, :attr => :bold 
   message "F10 quit, F1 Help, ? Bindings"
-  install_help_text my_help_text
+  #install_help_text my_help_text
+  @form.help_manager.help_text = my_help_text
 
   flow :width => FFI::NCurses.COLS , :height => FFI::NCurses.LINES-2 do
     stack :margin_top => 1, :width_pc => 20 do

data/examples/testkeypress.rb

@@ -49,7 +49,7 @@ if $0 == __FILE__
       @form.repaint
       @window.wrefresh
       Ncurses::Panel.update_panels
-      while((ch = @window.getchar()) != 999 )
+      while((ch = @window.getchar()) != 0 )
         str = keycode_tos ch
         $log.debug  "#{ch} got (#{str})"
         texta << "#{ch} got (#{str})"

data/examples/testlistbox.rb

@@ -1,3 +1,10 @@
+# NOTE: If the listbox is empty, that could mean that you have not generated
+#  ri documentation for this version of ruby. You can do so by doing:
+#    rvm docs generate-ri 
+#    or 
+#    rvm docs generate
+#  (This assumes you are using rvm)
+#
 # 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.

data/lib/rbcurse.rb

@@ -4,5 +4,5 @@ require 'rbcurse/core/system/window'
 require 'rbcurse/core/widgets/rwidget'
 require 'rbcurse/core/util/rdialogs'
 class Rbcurse
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

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

@@ -116,5 +116,99 @@ module RubyCurses
       return ret
     end
   end # utils
+  class PrefixCommand
+    attr_accessor :object
+    def initialize _symbol, calling, config={}, &block
+      @object = calling
+      @symbol = _symbol
+      @descriptions = {}
+      define_prefix_command _symbol
+      yield self if block_given?
+    end
+    def define_prefix_command _name, config={}
+      $rb_prefix_map ||= {}
+      #h = {}
+      #@map = h
+      _name = _name.to_sym unless _name.is_a? Symbol
+      # TODO it may already exist, so retrieve it
+      $rb_prefix_map[_name] ||= {}
+      @map = $rb_prefix_map[_name]
+      # create a variable by name _name
+      # create a method by same name to use
+      @object.instance_eval %{
+        def #{_name.to_s} *args
+           h = $rb_prefix_map["#{_name}".to_sym]
+           raise "No prefix_map named #{_name}, #{$rb_prefix_map.keys} " unless h
+           ch = @window.getchar
+           if ch
+              res =  h[ch]
+              if res.is_a? Proc
+                res.call
+              else
+                 send(res) if res
+              end
+           else
+              0
+           end
+        end
+      }
+      return _name
+    end
+    def call
+      h = @map
+      ch = @object.window.getch # dicey.
+        $log.debug "XXX:  CALLED #{ch} "
+      if ch
+        if ch == KEY_F1
+          text =  ["Options are: "]
+          h.keys.each { |e| c = keycode_tos(e); text << " #{c} #{@descriptions[e]} " }
+          textdialog text, :title => " #{@symbol} key bindings "
+          return
+        end
+        res =  h[ch]
+        if res.is_a? Proc
+          res.call
+        elsif res.is_a? Symbol
+          @object.send(res) if res
+        else
+          Ncurses.beep
+          @object.window.ungetch(ch)
+
+          :UNHANDLED
+        end
+      else
+        raise "got nothing"
+      end
+    end
+
+    # define a key within a prefix key map such as C-x
+    # Now that i am moving this from global, how will describe bindings get hold of the bindings
+    # and descriptions
+    def define_key _keycode, *args, &blk
+      _symbol = @symbol
+      h = $rb_prefix_map[_symbol]
+      raise ArgumentError, "No such keymap #{_symbol} defined. Use define_prefix_command." unless h
+      _keycode = _keycode[0].getbyte(0) if _keycode[0].class == String
+      arg = args.shift
+      if arg.is_a? String
+        desc = arg
+        arg = args.shift
+      elsif arg.is_a? Symbol
+        # its a symbol
+        desc = arg.to_s
+      elsif arg.nil?
+        desc = "unknown"
+      else
+        raise ArgumentError, "Don't know how to handle #{arg.class} in PrefixManager"
+      end
+      @descriptions[_keycode] = desc
+
+      if !block_given?
+        blk = arg
+      end
+      h[_keycode] = blk
+    end
+    alias :key :define_key
+  end
 end # module RubyC
 include RubyCurses::Utils

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

@@ -4,7 +4,7 @@
 #       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
+#  Last update: 2013-03-04 17:52
 # ----------------------------------------------------------------------------- #
 #
 module RubyCurses
@@ -42,6 +42,8 @@ module RubyCurses
         # 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(?\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

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

@@ -455,7 +455,9 @@ module ListScrollable
       return unless buff
       pos = @curpos || 0 # list does not have curpos
       $multiplier.times {
-        found = buff.index(/[[:punct:][:space:]]/, pos)
+        #found = buff.index(/[[:punct:][:space:]]+/, pos)
+        # 2013-03-04 - 17:35 modified so it skips spaces and puncts
+        found = buff.index(/[[:punct:][:space:]]\w/, pos)
         if !found
           # if not found, we've lost a counter
           if line+1 < @list.length

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

@@ -34,7 +34,7 @@ module ViEditable
     bind_key( [?y, ?y] , :kill_ring_save ) 
     bind_key( ?p, :yank ) # paste after this line
     bind_key( ?P ) { yank(@current_index - 1) } # should be before this line
-    bind_key(?\w, :forward_word)
+    bind_key(?w, :forward_word)
     bind_key(?f, :forward_char)
     bind_key(?\M-y, :yank_pop)
     bind_key(?\M-w, :kill_ring_save)
@@ -61,7 +61,7 @@ module ViEditable
     #bind_key( ?P ) { yank(@current_index - 1) } # should be before this line
     # seems -1 was pasting 2 lines before
     bind_key( ?P ) { yank(@current_index - 0) } # should be before this line
-    bind_key(?\w, :forward_word)
+    bind_key(?w, :forward_word)
     bind_key(?\M-y, :yank_pop)
     bind_key(?\C-y, :yank)
     bind_key(?\M-w, :kill_ring_save)

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

@@ -100,6 +100,11 @@ module VER
     # I am disableing this 2011-12-20 since it does not work with combinations
     # such as gg. Any routine that does a getch will just immediatelt return an ERR.
     #Ncurses::nodelay(stdscr.pointer, bf = true)
+
+    # added these 2 so we can do resizing based on original and current size when terminal resized
+    #  2012-01-8 
+    $orig_cols = FFI::NCurses.COLS
+    $orig_rows = FFI::NCurses.LINES
   end
 
   # this should happen only in outermost program that started ncurses

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

@@ -83,7 +83,8 @@ module VER
       #  2011-12-20 half-delay crashes system as does cbreak
       #This causes us to be unable to process gg qq since getch won't wait.
       #Ncurses::nodelay(@window, bf = true)
-      Ncurses::wtimeout(@window, $ncurses_timeout || 500) # will wait a second on wgetch so we can get gg and qq
+      # wtimeout was causing RESIZE sigwinch to only happen after pressing a key
+      #Ncurses::wtimeout(@window, $ncurses_timeout || 500) # will wait a second on wgetch so we can get gg and qq
       @stack = []
       @name ||="#{self}"
       @modified = true
@@ -247,19 +248,20 @@ module VER
     #  is 0
     def print_empty_line
       return unless visible?
-      w = width == 0? Ncurses.COLS : width
+      w = getmaxx == 0? Ncurses.COLS : getmaxx
       printw(' ' * w)
     end
 
     # NOTE: many of these methods using width will not work since root windows width 
     #  is 0
     def print_line(string)
-      w = width == 0? Ncurses.COLS : width
+      w = getmaxx == 0? Ncurses.COLS : getmaxx
       print(string.ljust(w))
     end
 
     # returns the actual width in case you've used a root window
     # which returns a 0 for wid and ht
+    # NOTE: this does not work when resize , use getmaxx instead
     #
     def actual_width
       width == 0? Ncurses.COLS : width
@@ -334,6 +336,15 @@ module VER
     def getch
       #c = @window.getch
       c = FFI::NCurses.wgetch(@window)
+      # the only reason i am doing this is so ESC can be returned if no key is pressed
+      # after that, not sure how this effects everything. most likely I should just
+      # go back to using a wtimeout, and not worry about resize requiring a keystroke
+      if c == 27
+        Ncurses::wtimeout(@window, $ncurses_timeout || 500) # will wait a second on wgetch so we can get gg and qq
+      else
+        Ncurses::nowtimeout(@window, true)
+      end
+      c
       # 2011-12-20 - i am trying setting a timer on wgetch, see timeout
       #c = FFI::NCurses.getch # this will keep waiting, nodelay won't be used on it, since 
       # we've put nodelay on window
@@ -662,7 +673,8 @@ module VER
     #
     def printstring_formatted_right(r,c,content, color, att = Ncurses::A_NORMAL)
       clean = content.gsub /#\[[^\]]*\]/,''  # clean out all markup
-      c = actual_width() - clean.length
+      #c = actual_width() - clean.length # actual width not working if resize
+      c = getmaxx() - clean.length
       printstring_formatted(r,c,content, color, att )
     end
 

data/lib/rbcurse/core/util/app.rb

@@ -383,7 +383,8 @@ module RubyCurses
     # Actually, this is naive, you would want to pass some values in like current data value
     # or lines ??
     # Also may want command completion, or help so all commands can be displayed
-    def get_command_from_user choices=["quit","help"]
+    # NOTE: This is gonna change very soon - 2012-01-8 
+    def get_command_from_user choices=["quit","help", "suspend", "shell_output"]
       @_command_history ||= Array.new
       str = rb_gets("Cmd: ", choices) { |q| q.default = @_previous_command; q.history = @_command_history }
               @_command_history << str unless @_command_history.include? str
@@ -966,10 +967,15 @@ module RubyCurses
           # this is a very rudimentary default command executer, it does not 
           # allow tab completion. App should use M-x with names of commands
           # as in appgmail
+          # NOTE: This is gonna change very soon - 2012-01-8 
           @form.bind_key(?:, 'prompt') { 
             str = get_command_from_user
           }
 
+          # this M-x stuff has to be moved out so it can be used by all. One should be able
+          # to add_commands properly to this, and to C-x. I am thinking how to go about this,
+          # and what function M-x actually serves.
+
           @form.bind_key(?\M-x, 'M-x commands'){
             # TODO previous command to be default
             opts = get_all_commands()
@@ -1008,7 +1014,7 @@ module RubyCurses
               end
             end
           }
-          @form.bind_key(KEY_F1, 'help'){ display_app_help }
+          #@form.bind_key(KEY_F1, 'help'){ display_app_help } # NOT REQUIRED NOW 2012-01-7 since form does it
           @form.bind_key([?q,?q], 'quit' ){ throw :close } if $log.debug?
 
           #@message = Variable.new

data/lib/rbcurse/core/util/basestack.rb

@@ -322,7 +322,6 @@ module RubyCurses
     end
     # module level
     private
-    private
     def _add s
       if @active.empty?
         $log.debug "XXX:  ADDING TO components #{s} "
@@ -337,7 +336,6 @@ module RubyCurses
     end
 
     # module level
-    private
     public
     def stack config={}, &block
       _stack :stack, config, &block
@@ -383,7 +381,8 @@ module RubyCurses
         @ctr -= 1
     end
     # module level
-    private
+    #private
+    public
     # given an widget, return the item, so we can change weight or some other config
     def item_for widget
       each do |e|

data/lib/rbcurse/core/util/rdialogs.rb

@@ -445,8 +445,14 @@ def longest_in_list list  #:nodoc:
   end    
   longest
 end    
+# would like to deprecate this and use 
+# @form.help_manager.help_text = text
 def install_help_text text
   @_help_text = text
+  if @form
+    hm = @form.help_manager
+    hm.help_text = text
+  end
 end
 # this routine prints help_text for an application
 # If help_text has been set using install_help_text
@@ -455,7 +461,25 @@ end
 # user may use <next> to see general help.
 #
 # earlier in app.rb
-def display_app_help
+def display_app_help form=@form
+  if form
+    hm = form.help_manager
+    if !hm.help_text 
+      arr = nil
+      # these 2 only made sense from app.rb and should be removed, too implicit
+      if respond_to? :help_text
+        arr = help_text
+      elsif @_help_text
+        arr = @_help_text
+      end
+      hm.help_text(arr) if arr
+    end
+    form.help_manager.display_help
+  else
+    raise "Form needed by display_app_help. Use form.help_manager instead"
+  end
+end
+def ORIGdisplay_app_help
   filename = File.dirname(__FILE__) + "/../docs/index.txt"
   # defarr contains default help
   if File.exists?(filename)
@@ -467,13 +491,14 @@ def display_app_help
     arr << "     --- General help ---          "
     arr << "    F10         -  exit application "
     arr << "    Alt-x       -  select commands  "
-    arr << "    :           -  select commands  "
+    arr << "    : (or M-:)  -  select commands  "
+    arr << "    ? (or M-?)  -  current widget key bindings  "
     arr << "    "
     defarr = arr
   end
   defhelp = true
   if respond_to? :help_text
-    arr = help_text
+    arr = help_text()
     defhelp = false
   elsif @_help_text
     arr = @_help_text

data/lib/rbcurse/core/util/widgetshortcuts.rb

@@ -264,18 +264,19 @@ module RubyCurses
       return w
     end
     alias :table :tabular_widget
+    # NOTE UNTESTED
     def vimsplit config={}, &block
       require 'rbcurse/extras/widgets/rvimsplit'
       #TODO check these
       events = [:PROPERTY_CHANGE, :LEAVE, :ENTER ]
       block_event = nil
       config[:height] ||= 10
-      _position(w)
       # if no width given, expand to flows width
       #config.delete :title
       useform = nil
 
       w = VimSplit.new useform, config # NO BLOCK GIVEN
+      _position(w)
       if block_given?
         #@current_object << w
         #instance_eval &block if block_given?

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

@@ -28,6 +28,7 @@ module RubyCurses
 
     def initialize form, text1, config={}, &block
 
+      @name = "header"
       @text1 = text1
       # setting default first or else Widget will place its BW default
       @color, @bgcolor = ColorMap.get_colors_for_pair $bottomcolor
@@ -82,18 +83,17 @@ module RubyCurses
     end
     def print_center(htext, r = 0, c = 0)
       win = @window
-      len = win.width
-      len = Ncurses.COLS-0 if len == 0
+      len = win.getmaxx
+      len = Ncurses.COLS-0 if len == 0 || len > Ncurses.COLS
       #
       #@form.window.printstring r, c, "%-*s" % [len, htext], @color_pair, @attr
       win.printstring r, ((len-htext.length)/2).floor, htext, @color_pair, @attr
     end
     def print_top_right(htext)
-    $log.debug " def print_top_right(#{htext})"
       hlen = htext.length
-      len = Ncurses.COLS-0
-      len = @window.width
-      len = Ncurses.COLS-0 if len == 0
+      len = @window.getmaxx # width was not changing when resize happens
+      len = Ncurses.COLS-0 if len == 0 || len > Ncurses.COLS
+      $log.debug " def print_top_right(#{htext}) #{len} #{Ncurses.COLS} "
       @form.window.printstring 0, len-hlen, htext, @color_pair, @attr
     end
     ##

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

@@ -23,9 +23,11 @@ module RubyCurses
     dsl_accessor :footer_color_pair
     # set the color of the mnemonic, overriding the defaults
     dsl_accessor :footer_mnemonic_color_pair
+    #attr_accessor :row_relative # lets only advertise this when we've tested it out
 
     def initialize form, key_labels, config={}, &block
 
+      @name = "dock"
       case key_labels
       when Hash
         raise "KeyLabelPrinter: KeyLabels cannot be a hash, Array of key labels required. Perhaps you did not pass labels"
@@ -40,9 +42,19 @@ module RubyCurses
       @key_hash[@mode] = key_labels
       @editable = false
       @focusable = false
-      @cols ||= Ncurses.COLS-1
-      @row ||= Ncurses.LINES-2
+      unless @row
+        @row_relative = -2
+        @row = Ncurses.LINES + @row_relative
+      end
       @col ||= 0
+      # if negativ row passed we store as relative to bottom, so we can maintain that.
+      if @row < 0
+        @row_relative = @row
+        @row = Ncurses.LINES - @row
+      else
+        @row_relative = (Ncurses.LINES - @row) * -1
+      end
+      @cols ||= Ncurses.COLS-1
       @repaint_required = true
       @footer_color_pair ||= $bottomcolor
       @footer_mnemonic_color_pair ||= $reversecolor #2
@@ -71,6 +83,10 @@ module RubyCurses
     def repaint
       return unless @repaint_required
       r,c = rowcol
+      # this should only happen if there's a change in window
+      if @row_relative
+        @row = Ncurses.LINES+@row_relative
+      end
       arr = key_labels()
       print_key_labels(arr, mode=@mode)
       @repaint_required = false
@@ -85,7 +101,7 @@ module RubyCurses
     def print_key_labels(arr = key_labels(), mode=@mode)
       #return if !@show_key_labels # XXX
       @win ||= @form.window
-      $log.debug "XXX: PKL #{arr.length}, #{arr}"
+      #$log.debug "XXX: PKL #{arr.length}, #{arr}"
       @padding = @cols / (arr.length/2)
       posx = 0
       even = []

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

@@ -375,11 +375,13 @@ module RubyCurses
         end
         case keycode
         when String
+          # single assignment
           keycode = keycode.getbyte(0) #if keycode.class==String ##    1.9 2009-10-05 19:40 
           #$log.debug " #{name} Widg String called bind_key BIND #{keycode}, #{keycode_tos(keycode)}  "
-          $log.debug " assigning #{keycode}  " if $log.debug? 
+          #$log.debug " assigning #{keycode}  " if $log.debug? 
           @key_handler[keycode] = blk
         when Array
+          # double assignment
           # for starters lets try with 2 keys only
           raise "A one key array will not work. Pass without array" if keycode.size == 1
           a0 = keycode[0]
@@ -387,7 +389,7 @@ module RubyCurses
           a1 = keycode[1]
           a1 = keycode[1].getbyte(0) if keycode[1].class == String
           @key_handler[a0] ||= OrderedHash.new
-          $log.debug " assigning #{keycode} , A0 #{a0} , A1 #{a1} " if $log.debug? 
+          #$log.debug " assigning #{keycode} , A0 #{a0} , A1 #{a1} " if $log.debug? 
           @key_handler[a0][a1] = blk
           #$log.debug " XX assigning #{keycode} to  key_handler " if $log.debug? 
         else
@@ -398,6 +400,85 @@ module RubyCurses
         @key_args[keycode] = args
 
       end
+
+      def define_prefix_command _name, config={} #_mapvar=nil, _prompt=nil
+        $rb_prefix_map ||= {}
+        _name = _name.to_sym unless _name.is_a? Symbol
+        $rb_prefix_map[_name] ||= {}
+        scope = config[:scope] || self
+        $rb_prefix_map[_name][:scope] = scope
+
+
+        # create a variable by name _name
+        # create a method by same name to use
+        # Don;t let this happen more than once
+      instance_eval %{
+        def #{_name.to_s} *args
+           #$log.debug "XXX:  came inside #{_name} "
+           h = $rb_prefix_map["#{_name}".to_sym]
+           raise "No prefix_map named #{_name}, #{$rb_prefix_map.keys} " unless h
+           ch = @window.getchar
+           if ch
+            if ch == KEY_F1
+              text =  ["Options are: "]
+              h.keys.each { |e| c = keycode_tos(e); text << c + " " + @descriptions[e]  }
+              textdialog text, :title => "#{_name} key bindings"
+              return
+            end
+              res =  h[ch]
+              if res.is_a? Proc
+                res.call
+              elsif res.is_a? Symbol
+                 scope = h[:scope]
+                 scope.send(res)
+              elsif res.nil?
+                Ncurses.beep
+                 return :UNHANDLED
+              end
+           else
+                 #@window.ungetch(ch)
+                 :UNHANDLED
+           end
+        end
+      }
+        return _name
+      end
+
+    def define_key _symbol, _keycode, *args, &blk
+      #_symbol = @symbol
+      h = $rb_prefix_map[_symbol]
+      raise ArgumentError, "No such keymap #{_symbol} defined. Use define_prefix_command." unless h
+      _keycode = _keycode[0].getbyte(0) if _keycode[0].class == String
+      arg = args.shift
+      if arg.is_a? String
+        desc = arg
+        arg = args.shift
+      elsif arg.is_a? Symbol
+        # its a symbol
+        desc = arg.to_s
+      elsif arg.nil?
+        desc = "unknown"
+      else
+        raise ArgumentError, "Don't know how to handle #{arg.class} in PrefixManager"
+      end
+      @descriptions ||= []
+      @descriptions[_keycode] = desc
+
+      if !block_given?
+        blk = arg
+      end
+      h[_keycode] = blk
+    end
+      # define a key within a prefix key map such as C-x
+      def OLDdefine_key _symbol, _keycode, _method=nil, &blk
+        h = $rb_prefix_map[_symbol]
+        raise ArgumentError, "No such keymap #{_symbol} defined. Use define_prefix_command." unless h
+        _keycode = _keycode[0].getbyte(0) if _keycode[0].class == String
+        if !block_given?
+          blk = _method
+        end
+        h[_keycode] = blk
+      end
       # Display key bindings for current widget and form in dialog
       def print_key_bindings *args
         f  = get_current_field
@@ -455,20 +536,27 @@ module RubyCurses
       def _process_key keycode, object, window
         return :UNHANDLED if @key_handler.nil?
         blk = @key_handler[keycode]
+        $log.debug "XXX:  _process key keycode #{keycode} #{blk.class}, #{self.class} "
         return :UNHANDLED if blk.nil?
-        if blk.is_a? OrderedHash
+        if blk.is_a? OrderedHash 
           #Ncurses::nodelay(window.get_window, bf = false)
           # if you set nodelay in ncurses.rb then this will not
           # wait for second key press, so you then must either make it blocking
           # here, or set a wtimeout here.
+          #
+          # This is since i have removed timeout globally since resize was happeing
+          # after a keypress. maybe we can revert to timeout and not worry about resize so much
+          Ncurses::wtimeout(window.get_window, $ncurses_timeout || 500) # will wait a second on wgetch so we can get gg and qq
           ch = window.getch
+          Ncurses::nowtimeout(window.get_window, true)
           #Ncurses::nodelay(window.get_window, bf = true)
 
           $log.debug " process_key: got #{keycode} , #{ch} "
-          if ch < 0 || ch > 255
+          # next line ignores function keys etc. C-x F1, thus commented 255 2012-01-11 
+          if ch < 0 #|| ch > 255
             return nil
           end
-          yn = ch.chr
+          #yn = ch.chr
           blk1 = blk[ch]
           # FIXME we are only returning the second key, what if form
           # has mapped first and second combo. We should unget keycode and ch. 2011-12-23 
@@ -480,8 +568,9 @@ module RubyCurses
         end
         #$log.debug "called process_key #{object}, kc: #{keycode}, args  #{@key_args[keycode]}"
         if blk.is_a? Symbol
-          $log.debug "SYMBOL " if $log.debug? 
+          #$log.debug "SYMBOL #{blk.to_s}  " if $log.debug? 
           if respond_to? blk
+          #$log.debug "SYMBOL calling #{blk.to_s}  " if $log.debug? 
             return send(blk, *@key_args[keycode])
           else
             alert "This ( #{self.class} ) does not respond to #{blk.to_s} "
@@ -593,8 +682,8 @@ module RubyCurses
       # Need to inform listeners - done 2010-02-25 23:09 
       # Can throw a FieldValidationException or PropertyVetoException
     def fire_property_change text, oldvalue, newvalue
-      #$log.debug " FPC #{self}: #{text} #{oldvalue}, #{newvalue}"
       return if oldvalue.nil? || @_object_created.nil? # added 2010-09-16 so if called by methods it is still effective
+      $log.debug " FPC #{self}: #{text} #{oldvalue}, #{newvalue}"
       if @pce.nil?
         @pce = PropertyChangeEvent.new(self, text, oldvalue, newvalue)
       else
@@ -1208,7 +1297,7 @@ module RubyCurses
       @modified = false
       @focusable = true
       @navigation_policy ||= :CYCLICAL
-      @_events = [:ENTER, :LEAVE]
+      @_events = [:ENTER, :LEAVE, :RESIZE]
       instance_eval &block if block_given?
       ## I need some counter so a widget knows it has been panned and can send a correct
       ##+ cursor coordinate to system.
@@ -1232,6 +1321,8 @@ module RubyCurses
 
       # what kind of key-bindings do you want, :vim or :emacs
       $key_map ||= :vim ## :emacs or :vim, keys to be defined accordingly. TODO
+
+      bind_key(KEY_F1, 'help') { hm = help_manager(); hm.display_help }
     end
     ##
     # set this menubar as the form's menu bar.
@@ -1746,10 +1837,14 @@ module RubyCurses
           cols = Ncurses.COLS
           x = Ncurses.stdscr.getmaxy
           y = Ncurses.stdscr.getmaxx
-          $log.debug " form RESIZE HK #{ch} #{self}, #{@name}, #{ch}  "
-          alert "SIGWINCH WE NEED TO RECALC AND REPAINT resize #{lines}, #{cols}: #{x}, #{y} "
+          $log.debug " form RESIZE HK #{ch} #{self}, #{@name}, #{ch}, x #{x} y #{y}  "
+          #alert "SIGWINCH WE NEED TO RECALC AND REPAINT resize #{lines}, #{cols}: #{x}, #{y} "
           Ncurses.endwin
           @window.wrefresh
+          @widgets.each { |e| e.repaint_all(true) } # trying out
+          ## added RESIZE on 2012-01-5 
+          ## stuff that relies on last line such as statusline dock etc will need to be redrawn.
+          fire_handler :RESIZE, self 
         else
           field =  get_current_field
           if $log.debug?
@@ -1825,6 +1920,7 @@ module RubyCurses
   # place given widget below given one, or last added one
   # Does not check for availability or overlap
   def place_below me, other=nil
+    $log.warn "WARN deprecated form place_below"
     w = widgets
     if other.nil?
       other = w[-1]
@@ -1844,6 +1940,7 @@ module RubyCurses
   # return location to place next widget (below)
   # Does not check for availability or overlap
   def next_position
+    $log.warn "WARN  deprecated form next_position"
     w = widgets.last
     if w.height.nil? || w.height == 0
       h = 1
@@ -1854,9 +1951,79 @@ module RubyCurses
     col = w.col
     return row, col
   end
+  #
+  # returns in instance of help_manager with which one may install help_text and call help.
+  # user apps will only supply help_text, form would already have mapped F1 to help.
+  def help_manager
+    @help_manager ||= HelpManager.new self
+  end
 
     ## ADD HERE FORM
   end
+
+
+  class HelpManager
+    def initialize form, config={}, &block
+      @form = form
+       #super
+       #instance_eval &block if block_given?
+    end
+    def help_text text=nil
+      if text
+        @help_text = text
+      end
+      return @help_text
+    end
+    def help_text=(text); help_text(text); end
+    def display_help
+      filename = File.dirname(__FILE__) + "/../docs/index.txt"
+      # defarr contains default help
+      if File.exists?(filename)
+        defarr = File.open(filename,'r').readlines
+      else
+        arr = []
+        arr << "    NO HELP SPECIFIED FOR APP "
+        arr << "    "
+        arr << "     --- General help ---          "
+        arr << "    F10         -  exit application "
+        arr << "    Alt-x       -  select commands  "
+        arr << "    : (or M-:)  -  select commands  "
+        arr << "    ? (or M-?)  -  current widget key bindings  "
+        arr << "    "
+        defarr = arr
+      end
+      defhelp = true
+      if @help_text
+        defhelp = false
+        arr = @help_text
+      else
+        arr = defarr
+      end
+      case arr
+      when String
+        arr = arr.split("\n")
+      when Array
+      end
+      #w = arr.max_by(&:length).length
+      h = FFI::NCurses.LINES - 4
+      w = FFI::NCurses.COLS - 10
+
+      require 'rbcurse/core/util/viewer'
+      RubyCurses::Viewer.view(arr, :layout => [2, 4, h, w],:close_key => KEY_F10, :title => "[ Help ]", :print_footer => true) do |t|
+        # you may configure textview further here.
+        #t.suppress_borders true
+        #t.color = :black
+        #t.bgcolor = :white
+        # or
+        #t.attr = :reverse
+
+        # help was provided, so default help is provided in second buffer
+        unless defhelp
+          t.add_content defarr, :title => ' General Help '
+        end
+      end
+    end
+  end # class
   ## Created and sent to all listeners whenever a property is changed
   # @see fire_property_change
   # @see fire_handler 

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

@@ -7,8 +7,10 @@ module RubyCurses
   #  at the bottom, typically above the dock (3rd line from last).
   #
   class StatusLine < Widget
+    #attr_accessor :row_relative # lets only advertise this when we've tested it out
 
     def initialize form, config={}, &block
+      @row_relative = -3
       if form.window.height == 0
         @row = Ncurses.LINES-3 # fix, what about smaller windows, use window dimensions and watch out for 0,0
       else
@@ -16,7 +18,15 @@ module RubyCurses
       end
        # in root windows FIXME
       @col = 0
+      @name = "sl"
       super
+      # if negativ row passed we store as relative to bottom, so we can maintain that.
+      if @row < 0
+        @row_relative = @row
+        @row = Ncurses.LINES - @row
+      else
+        @row_relative = (Ncurses.LINES - @row) * -1
+      end
       @focusable = false
       @editable  = false
       @command = nil
@@ -47,8 +57,12 @@ module RubyCurses
     #   rather whenever form.repaint is called.
     def repaint
       @color_pair ||= get_color($datacolor, @color, @bgcolor) 
-      len = @form.window.width
-      len = Ncurses.COLS if len == 0
+      len = @form.window.getmaxx # width does not change upon resizing so useless, fix or do something
+      len = Ncurses.COLS if len == 0 || len > Ncurses.COLS
+      # this should only happen if there's a change in window
+      if @row_relative
+        @row = Ncurses.LINES+@row_relative
+      end
 
       # first print dashes through
       @form.window.printstring @row, @col, "%s" % "-" * len, @color_pair, Ncurses::A_REVERSE
@@ -80,6 +94,7 @@ module RubyCurses
       else
         t = Time.now
         tt = t.strftime "%F %H:%M:%S"
+        r = Ncurses.LINES
         ftext = "#[fg=green,bg=blue] %-20s" % [tt] # print a default
         @form.window.printstring_formatted_right @row, nil, ftext, $datacolor, Ncurses::A_REVERSE
       end

data/rbcurse-core.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rbcurse-core"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rahul Kumar"]
-  s.date = "2012-01-05"
+  s.date = "2013-03-05"
   s.description = "Ruby curses/ncurses widgets for easy application development on text terminals (ruby 1.9, 1.8)"
   s.email = "sentinel1879@gmail.com"
   s.extra_rdoc_files = [
@@ -119,7 +119,7 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/rkumar/rbcurse-core"
   s.require_paths = ["lib"]
   s.rubyforge_project = "rbcurse"
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.25"
   s.summary = "Ruby Ncurses Toolkit core infrastructure and widgets"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbcurse-core
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-05 00:00:00.000000000 Z
+date: 2013-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-ncurses
-  requirement: &70102876538580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70102876538580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description: Ruby curses/ncurses widgets for easy application development on text
   terminals (ruby 1.9, 1.8)
 email: sentinel1879@gmail.com
@@ -149,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rbcurse
-rubygems_version: 1.8.10
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Ruby Ncurses Toolkit core infrastructure and widgets