rbcurse 1.4.0 → 1.4.1.pre2

data/examples/testtodo.rb

@@ -1,8 +1,4 @@
-#$LOAD_PATH << "/Users/rahul/work/projects/rbcurse/"
-require 'rubygems'
-#require 'ncurses' # FFI
 require 'logger'
-#require 'ver/keyboard'
 require 'rbcurse'
 require 'rbcurse/rcombo'
 require 'rbcurse/rtable'
@@ -115,7 +111,7 @@ module TestTodo
       d = @data
       require 'csv'
       #CSV.open('todocsv.csv', 'w') do |writer|     
-      CSV.open("todocsv.csv", "w") do |writer|
+      CSV.open("data/todocsv.csv", "w") do |writer|
         #writer << [nil, nil]                  
         d.each do |row|
           #parced_cells = CSV.generate_rows(row, row.size, buf)

data/examples/testwsshortcuts.rb

@@ -0,0 +1,64 @@
+# this is a test program, tests out tabbed panes. type F1 to exit
+#
+require 'rbcurse'
+require 'rbcurse/common/widgetshortcuts'
+
+include RubyCurses
+
+class SetupMessagebox
+  include RubyCurses::WidgetShortcuts
+  def initialize config={}, &block
+    @window = VER::Window.root_window
+    @form = Form.new @window
+  end
+  def run
+    _create_form
+    @form.repaint
+    @window.wrefresh
+    while ((ch = @window.getchar()) != 999)
+      break if ch == ?\C-q.getbyte(0)
+      @form.handle_key ch
+      @window.wrefresh
+    end
+  end
+  def _create_form
+    widget_shortcuts_init
+    stack :margin_top => 2, :margin_left => 3, :width => 50 , :color => :cyan, :bgcolor => :black do
+      label :text => " Details ", :color => :blue, :attr => :reverse, :width => :expand, :justify => :center
+      blank
+      field :text => "john", :attr => :reverse, :label => "%15s" % ["Name: "]
+      field :label => "%15s" % ["Address: "], :width => 15, :attr => :reverse
+      check :text => "Using version control", :value => true, :onvalue => "yes", :offvalue => "no"
+      check :text => "Upgraded to Lion", :value => false, :onvalue => "yes", :offvalue => "no"
+      blank
+      radio :text => "Linux", :value => "LIN", :group => :os
+      radio :text => "OSX", :value => "OSX", :group => :os
+      radio :text => "Window", :value => "Win", :group => :os
+      flow :margin_top => 2, :margin_left => 4, :item_width => 15  do
+        button :text => "Ok"
+        button :text => "Cancel"
+        button :text => "Apply"
+      end
+    end
+  end
+
+end
+if $0 == __FILE__
+  # Initialize curses
+  begin
+    # XXX update with new color and kb
+    VER::start_ncurses  # this is initializing colors via ColorMap.setup
+    $log = Logger.new((File.join(ENV["LOGDIR"] || "./" ,"rbc13.log")))
+    $log.level = Logger::DEBUG
+    tp = SetupMessagebox.new()
+    buttonindex = tp.run
+    $log.debug "XXX:  MESSAGEBOX retirned #{buttonindex} "
+  rescue => ex
+  ensure
+    VER::stop_ncurses
+    p ex if ex
+    p(ex.backtrace.join("\n")) if ex
+    $log.debug( ex) if ex
+    $log.debug(ex.backtrace.join("\n")) if ex
+  end
+end

data/examples/testwsshortcuts2.rb

@@ -0,0 +1,126 @@
+# this is a test program, tests out tabbed panes. type F1 to exit
+#
+require 'rbcurse'
+require 'rbcurse/common/widgetshortcuts'
+
+include RubyCurses
+include RubyCurses::Utils
+
+class SetupMessagebox
+  include RubyCurses::WidgetShortcuts
+  def initialize config={}, &block
+    @window = VER::Window.root_window
+    @form = Form.new @window
+  end
+  def run
+    _create_form
+    @form.repaint
+    @window.wrefresh
+    catch(:close) do
+    while ((ch = @window.getchar()) != 999)
+      break if ch == ?\C-q.getbyte(0)
+      @form.handle_key ch
+      @window.wrefresh
+    end
+    end # catch
+  end
+  def _create_form
+    widget_shortcuts_init
+    stack :margin_top => 1, :width => :expand do
+      label :text => " Details ", :color => :cyan, :attr => :reverse, :width => :expand, :justify => :center
+      flow :margin_top => 1, :margin_left => 4, :item_width => 50   do
+        stack :margin_top => 0, :margin_left => 3, :width => 50 , :color => :cyan, :bgcolor => :black do
+          box do
+            field :text => "steve", :attr => :reverse, :label => "%15s" % ["Name: "]
+            field :label => "%15s" % ["Address: "], :width => 15, :attr => :reverse
+            blank
+            check :text => "Using version control", :value => true, :onvalue => "yes", :offvalue => "no" do |eve|
+              unless eve.item.value 
+                alert "NO VC! We need to talk"
+              end
+            end
+            check :text => "Upgraded to Lion", :value => false, :onvalue => "yes", :offvalue => "no" do |eve|
+              unless eve.item.value
+                alert "You goin back to Snow Leopard?"
+              end
+            end
+          end # box
+        end
+        stack :margin_top => 0, :margin_left => 3, :width => 50 , :color => :cyan, :bgcolor => :black do
+          box :title => "OS Maintenance", :margin_left => 2 do
+            radio :text => "Linux", :value => "LIN", :group => :os
+            radio :text => "OSX", :value => "OSX", :group => :os
+            radio :text => "Window", :value => "Win", :group => :os
+            blank
+          flow  :item_width => 15 do
+            button :text => "Install" do 
+              # you can avoid this by giving the radio buttons your own Variable (see test2.rb)
+              choice = @variables[:os].value
+              case choice
+              when ""
+                alert "Select an OS"
+              when "OSX", "LIN"
+                alert "Good choice"
+              else
+                alert "Pfft !"
+              end
+            end
+            button :text => "Uninstall"
+            button :text => "Delete"
+          end
+          end # box
+        end
+      end # flow
+      #button :text => "Execute"
+      text = ["      #[reverse]Unix Philosophy #[end]  ", 
+        "#[fg=green, underline]Eric Raymond#[end] in his book, #[fg=green, underline]The Art of Unix Programming#[end] summarized the Unix philosophy.",
+      "  ",
+        "Rule of #[fg=yellow]Modularity#[end]: Write simple parts connected by clean interfaces.",
+        "Rule of #[fg=blue]Clarity#[end]: #[bold]Clarity#[end] is better than cleverness.",
+        "Rule of #[fg=red]Separation#[end]: Separate #[bold]policy#[end] from mechanism; separate interfaces from engines.",
+          "Rule of #[fg=green]Simplicity#[end]: Design for #[bold]simplicity;#[end] add complexity only where you must.",
+        "Rule of #[fg=magenta]Parsimony#[end]: Write a big program only when it is clear by demonstration that nothing else will do.",
+        "Rule of #[fg=cyan]Representation#[end]: Fold knowledge into #[bold]data#[end] so program logic can be stupid and robust"]
+        text << "For more check: #[underline]http://en.wikipedia.org/wiki/Unix_philosophy#Eric_Raymond#[end]"
+        formatted = []
+        #text.each { |line| formatted << @window.convert_to_chunk(line) }
+
+      #textview :text => formatted
+        #textview do |t| t.formatted_text(text, :tmux) end
+        t = textview :title => 'tmux format'
+        t.formatted_text(text, :tmux)
+        t1 = textview :title => 'ansi formatted document'
+        text = File.open("data/color.2","r").readlines
+        t1.formatted_text(text, :ansi)
+
+      flow do
+        #box do
+          button :text => "  Ok  " do  alert "Pressed okay"  end
+          button :text => "Cancel" do  confirm "Quit?" ; throw :close;  end
+          button :text => "Apply "
+        #end
+      end
+
+    end
+
+  end
+end
+if $0 == __FILE__
+  # Initialize curses
+  begin
+    # XXX update with new color and kb
+    VER::start_ncurses  # this is initializing colors via ColorMap.setup
+    $log = Logger.new((File.join(ENV["LOGDIR"] || "./" ,"rbc13.log")))
+    $log.level = Logger::DEBUG
+    tp = SetupMessagebox.new()
+    buttonindex = tp.run
+    $log.debug "XXX:  MESSAGEBOX retirned #{buttonindex} "
+  rescue => ex
+  ensure
+    VER::stop_ncurses
+    p ex if ex
+    p(ex.backtrace.join("\n")) if ex
+    $log.debug( ex) if ex
+    $log.debug(ex.backtrace.join("\n")) if ex
+  end
+end

data/examples/viewtodo.rb

@@ -1,6 +1,3 @@
-$LOAD_PATH << "/Users/rahul/work/projects/rbcurse/"
-require 'rubygems'
-#require 'ncurses' # FFI
 require 'logger'
 require 'rbcurse'
 require 'rbcurse/rcombo'
@@ -143,7 +140,7 @@ module ViewTodo
     File.open("todo.csv", "w") { |f| YAML.dump( d, f )}
     buf =''
     require 'csv'
-    CSV.open('todocsv.csv', 'w') do |writer|     
+    CSV.open('data/todocsv.csv', 'w') do |writer|     
       #writer << [nil, nil]                  
       d.each do |row|
         #parced_cells = CSV.generate_rows(row, row.size, buf)

data/lib/rbcurse.rb

@@ -4,5 +4,5 @@ require 'ver/window'
 require 'rbcurse/rwidget'
 require 'rbcurse/rdialogs'
 class Rbcurse
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
 end

data/lib/rbcurse/app.rb

@@ -18,7 +18,7 @@ $tt.name = "$tt"
 require 'forwardable'
 module Kernel
   extend Forwardable
-  def_delegators :$tt, :ask, :say, :agree, :choose, :numbered_menu, :display_text, :display_text_interactive, :display_list, :say_with_pause, :hide_bottomline
+  def_delegators :$tt, :ask, :say, :agree, :choose, :numbered_menu, :display_text, :display_text_interactive, :display_list, :say_with_pause, :hide_bottomline, :say_with_wait
 end
 include RubyCurses
 include RubyCurses::Utils
@@ -77,7 +77,7 @@ module RubyCurses
     attr_reader :window
     attr_writer :quit_key
     # the row on which to prompt user for any inputs
-    attr_accessor :prompt_row
+    #attr_accessor :prompt_row # 2011-10-17 14:06:22
 
     extend Forwardable
     def_delegators :$tt, :ask, :say, :agree, :choose, :numbered_menu, :display_text, :display_text_interactive, :display_list
@@ -93,7 +93,7 @@ module RubyCurses
       @variables = {}
       # if we are creating child objects then we will not use outer form. this object will manage
       @current_object = [] 
-      @_system_commands = %w{ bind_global bind_component }
+      @_system_commands = %w{ bind_global bind_component field_help_text }
 
       init_vars
       $log.debug "XXX APP CONFIG: #{@config}  " if $log.debug? 
@@ -107,8 +107,8 @@ module RubyCurses
         init_ncurses
       end
       $lastline = Ncurses.LINES - 1
-      @message_row = Ncurses.LINES-1
-      @prompt_row = @message_row # hope to use for ask etc
+      #@message_row = Ncurses.LINES-1
+      #@prompt_row = @message_row # hope to use for ask etc # 2011-10-17 14:06:27
       unless $log
         path = File.join(ENV["LOGDIR"] || "./" ,"rbc13.log")
         file   = File.open(path, File::WRONLY|File::TRUNC|File::CREAT) 
@@ -117,15 +117,10 @@ module RubyCurses
         colors = Ncurses.COLORS
         $log.debug "START #{colors} colors  --------- #{$0} win: #{@window} "
       end
-=begin
-# trying without 2011-10-8 
-        require 'rbcurse/extras/stdscrwindow'
-        awin = StdscrWindow.new
-        $tt.window = awin; $tt.message_row = @message_row
-=end
     end
     def logger; return $log; end
     def close
+      raw_message_destroy
       $log.debug " INSIDE CLOSE, #{@stop_ncurses_on_close} "
       @window.destroy if !@window.nil?
       $log.debug " INSIDE CLOSE, #{@stop_ncurses_on_close} "
@@ -145,13 +140,18 @@ module RubyCurses
       @form.repaint
       @window.wrefresh
       Ncurses::Panel.update_panels
+      @break_key = ?\C-q.getbyte(0)
       while((ch = @window.getchar()) != @quit_key )
-        str = keycode_tos ch
-        @keyblock.call(str.gsub(/-/, "_").to_sym) if @keyblock
-        $log.debug  "#{ch} got (#{str})"
+        break if ch == @break_key
+
+        if @keyblock
+          str = keycode_tos ch
+          @keyblock.call(str.gsub(/-/, "_").to_sym) # not used ever
+        end
+
         yield ch if block # <<<----
         @form.handle_key ch
-        @form.repaint
+        #@form.repaint # was this duplicate ?? handle calls repaint not needed
         @window.wrefresh
       end
     end
@@ -185,46 +185,41 @@ module RubyCurses
     # a label so it can be printed.
     def message text
       $status_message.value = text # trying out 2011-10-9 
-      @message.value = text
+      #@message.value = text # 2011-10-17 14:07:01
     end
+    # @deprecated please use {#status_line} instead of a message label
     def message_row row
       raise "Please use create_message_label first as message_label is no longer default behaviour" unless @message_label
       @message_label.row = row 
     end
     # during a process, when you wish to update status, since ordinarily the thread is busy
     # and form does not get control back, so the window won't refresh.
-    # NOTE: use this only if +message+ is not working
-    # XXX Not sure if this is working after move to ffi-ncurses, check the demos
+    # This will only update on keystroke since it uses statusline
+    # @deprecated please use {#status_line} instead of a message label
     def message_immediate text
+      $log.warn "DEPRECATED, use message(), or say_with_pause, or say"
       $status_message.value = text # trying out 2011-10-9 user needs to use in statusline command
-      message text
-      if @message_label
-        @message_label.repaint
-        @window.refresh
-      end
+      # 2011-10-17 knocking off label, should be printed on status_line
     end
-    # NOTE XXX using stdscr results in the screen going black if a dialog
-    # or other window is popped up, this was great but has not worked out.
-    # print directly onto stdscr so that form or window does not require repainting
-    # and cursor not messed. however, once form paints then this will be overwritten
-    # so at end of printing raw_messages, use message() for final status.
     # Usage: application is inside a long processing loop and wishes to print ongoing status
-    # (similar to message_immediate) but faster and less involved
-    # @deprecated since it uses stdscr. Use say_with_pause or use rdialogs status_window, see test2.rb
-    def raw_message text
-      $log.warn "WARNING: don't use this method as it uses stdscr. Use rdialogs statuswindow."
-      row = @message_label ? @message_label.row : Ncurses.LINES-1
-      # experimentally trying stdscr instead of label
-      scr = FFI::NCurses.stdscr
-      text = "%-80s" % text
-      Ncurses.mvprintw row ,0, text
-      #@_stext ||= ""
-      #@_stext <<  text
-      ## appending is quite a pain, maybe we should make it separate.
-      #stext = "%-80s" % @_stext
-      #Ncurses.mvprintw row ,0, stext[-80..-1]
-      #scr.refresh() # NW w FFI XXX
-      #FFI::NCurses.refresh
+    # NOTE: if you use this, you must use raw_message_destroy at some stage, after processing
+    # or on_leave of object.
+    # @deprecated Use say_with_pause or use rdialogs status_window, see test2.rb
+    def raw_message text, config={}, &blk
+      $raw_window ||= one_line_window last_line(), config, &blk
+      width = $raw_window.width == 0 ? FFI::NCurses.COLS : $raw_window.width
+      text = "%-*s" % [width, text]
+      
+      $raw_window.attron(Ncurses.COLOR_PAIR($normalcolor) )
+      $raw_window.printstring 0,0,text, $normalcolor #, 'normal' if @title
+      $raw_window.wrefresh
+     
+    end
+    def raw_message_destroy
+      if $raw_window
+        $raw_window.destroy
+        $raw_window = nil
+      end
     end
     # shows a simple progress bar on last row, using stdscr
     # @param [Float, Array<Fixnum,Fixnum>] percentage, or part/total
@@ -331,11 +326,12 @@ module RubyCurses
     end
     # bind a key to a method at global (form) level
     # Note that individual component may be overriding this.
+    # FIXME: why are we using rawmessage and then getchar when ask would suffice
     def bind_global
       opts = get_all_commands
       cmd = ask("Select a command (TAB for choices) : ", opts)
       if cmd.nil? || cmd == ""
-        raw_message "Aborted."
+        say_with_pause "Aborted."
         return
       end
       key = []
@@ -343,16 +339,18 @@ module RubyCurses
       raw_message "Enter one or 2 keys. Finish with ENTER. Enter first key:"
       #raw_message "Enter first key:"
       ch = @window.getchar()
+      raw_message_destroy
       if [KEY_ENTER, 10, 13, ?\C-g.getbyte(0)].include? ch
-        raw_message "Aborted."
+        say_with_pause "Aborted."
         return
       end
       key << ch
       str << keycode_tos(ch)
       raw_message "Enter second key or hit return:"
       ch = @window.getchar()
+      raw_message_destroy
       if ch == 3 || ch == ?\C-g.getbyte(0)
-        raw_message "Aborted."
+        say_with_pause "Aborted."
         return
       end
       if ch == 10 || ch == KEY_ENTER || ch == 13
@@ -361,19 +359,31 @@ module RubyCurses
         str << keycode_tos(ch)
       end
       if !key.empty?
-        raw_message "Binding #{cmd} to #{str} "
+        say_with_pause "Binding #{cmd} to #{str} "
         key = key[0] if key.size == 1
         #@form.bind_key(key, cmd.to_sym) # not finding it, getting called by that comp
         @form.bind_key(key){ send(cmd.to_sym) }
       end
       #message "Bound #{str} to #{cmd} "
+      raw_message_destroy
     end
     def bind_component
+      say_with_pause "Todo. <press>"
       # the idea here is to get the current component
       # and bind some keys to some methods.
       # however, how do we divine the methods we can map to
       # and also in some cases the components itself has multiple components
     end
+    # displays help_text associated with field. 2011-10-15 
+    def field_help_text
+      f = @form.get_current_field
+      if f.respond_to?('help_text')
+        h = f.help_text
+        alert "#{h}"
+      else
+        alert "Could not get field #{f} or does not respond to helptext"
+      end
+    end
     # prompts user for a command. we need to get this back to the calling app
     # or have some block stuff TODO
     # Actually, this is naive, you would want to pass some values in like current data value
@@ -412,7 +422,7 @@ module RubyCurses
           if cmd == "close"
             throw :close # other seg faults in del_panel window.destroy executes 2x
           else
-            send cmd, *cmdline
+            res = send cmd, *cmdline
           end
         else
           alert "#{self.class} does not respond to #{cmd} "
@@ -613,8 +623,18 @@ module RubyCurses
       end
       return w
     end
-    def textview *args, &block
-      require 'rbcurse/rtextview'
+    # similar definitions for textview and resultsettextview
+    # NOTE This is not allowing me to send blocks,
+    # so do not use for containers
+    {
+      'rbcurse/rtextview' => 'TextView',
+      'rbcurse/experimental/resultsettextview' => 'ResultsetTextView',
+      'rbcurse/rcontainer' => 'Container',
+      'rbcurse/extras/rcontainer2' => 'Container2',
+    }.each_pair {|k,p|
+      eval(
+           "def #{p.downcase} *args, &block
+              require \"#{k}\"
       config = {}
       # TODO confirm events many more
       events = [ :PRESS, :LEAVE, :ENTER ]
@@ -624,15 +644,17 @@ module RubyCurses
       _position(config)
       # if no width given, expand to flows width
       config[:width] ||= @stack.last.width if @stack.last
-      raise "height needed for textview" if !config.has_key? :height
+      raise \"height needed for #{p.downcase}\" if !config.has_key? :height
       useform = nil
       useform = @form if @current_object.empty?
-      w = TextView.new useform, config
+      w = #{p}.new useform, config
       if block
         w.bind(block_event, &block)
       end
       return w
-    end
+           end"
+           )
+    }
     # progress bar
     def progress *args, &block
       require 'rbcurse/rprogress'
@@ -1012,10 +1034,8 @@ module RubyCurses
       s = Stack.new(mt, mr, w)
       @app_row += mt
       mr += @stack.last.margin if @stack.last
-      #@stack << mr
       @stack << s
-      #instance_eval &block if block_given?
-              yield_or_eval &block if block_given? # modified 2010-11-17 20:36 
+      yield_or_eval &block if block_given?
       @stack.pop
       @instack = false if @stack.empty?
       @app_row = 0 if @stack.empty?
@@ -1034,8 +1054,7 @@ module RubyCurses
       col += config[:margin] || 0
       @flowstack << col
       @flowcol = col
-      #instance_eval &block if block_given?
-      yield_or_eval &block if block_given? # modified 2010-11-17 20:36 
+      yield_or_eval &block if block_given? 
       @flowstack.pop
       @inflow = false if @flowstack.empty?
     end
@@ -1059,6 +1078,8 @@ module RubyCurses
       longest
     end    
     # returns longest item
+    # rows = list.max_by(&:length)
+    #
     def longest_in_list2 list  #:nodoc:
       longest = list.inject(list[0]) do |memo,word|
         memo.length >= word.length ? memo : word
@@ -1073,10 +1094,11 @@ module RubyCurses
     end
     # Now i am not creating this unless user wants it. Pls avoid it.
     # Use either say_with_pause, or put $status_message in command of statusline
-    # @deprecated
+    # @deprecated please use {#status_line} instead of a message label
     def create_message_label row=Ncurses.LINES-1
       @message_label = RubyCurses::Label.new @form, {:text_variable => @message, :name=>"message_label",:row => row, :col => 0, :display_length => Ncurses.COLS,  :height => 1, :color => :white}
     end
+
     def run &block
       begin
 
@@ -1106,7 +1128,7 @@ module RubyCurses
             @_command_history ||= Array.new
             # previous command should be in opts, otherwise it is not in this context
             cmd = ask("Command: ", opts){ |q| q.default = @_previous_command; q.history = @_command_history }
-            if cmd == ""
+            if cmd.nil? || cmd == ""
             else
               @_command_history << cmd unless @_command_history.include? cmd
               cmdline = cmd.split
@@ -1122,11 +1144,11 @@ module RubyCurses
               end
               if respond_to?(cmd, true)
                 @_previous_command = cmd
-                raw_message "calling #{cmd} "
+                #raw_message "calling #{cmd} "
                 begin
                   send cmd, *cmdline
                 rescue => exc
-                  $log.debug "ERR EXC: send throwing an exception now. Duh. IMAP keeps crashing haha !! #{exc}  " if $log.debug? 
+                  $log.error "ERR EXC: send throwing an exception now. Duh. IMAP keeps crashing haha !! #{exc}  " if $log.debug? 
                   if exc
                     $log.debug( exc) 
                     $log.debug(exc.backtrace.join("\n")) 
@@ -1141,11 +1163,11 @@ module RubyCurses
           @form.bind_key(KEY_F1){ display_app_help }
           @form.bind_key([?q,?q]){ throw :close } if $log.debug?
 
-          @message = Variable.new
-          @message.value = ""
+          #@message = Variable.new
+          #@message.value = ""
           $status_message ||= Variable.new # remember there are multiple levels of apps
           $status_message.value = ""
-          $error_message.update_command { @message.set_value($error_message.value) }
+          #$error_message.update_command { @message.set_value($error_message.value) }
           if block
             begin
               #yield(self, @window, @form)
@@ -1220,10 +1242,11 @@ module RubyCurses
         end
       elsif @instack
         # most likely you won't have row and col. should we check or just go ahead
+        # what if he has put it 2011-10-19 as in a container
         col = @stack.last.margin
-        config[:row] = @app_row
-        config[:col] = col
-        @app_row += config[:height] || 1
+        config[:row] ||= @app_row 
+        config[:col] ||= col
+        @app_row += config[:height] || 1 #unless config[:no_advance]
         # TODO need to allow stack to have its spacing, but we don't have an object as yet.
       end
     end