rbcurse 1.1.5 → 1.2.0.pre

data/lib/rbcurse/extras/viewer.rb

@@ -0,0 +1,106 @@
+require 'rbcurse/rtextview'
+require 'fileutils'
+
+# NOTE: experimental, not yet firmed up
+# If you use in application, please copy to some application folder in case i change this.
+# TODO: add vi_keys here
+# SUGGESTIONS WELCOME.
+# @since 1.2.0
+module RubyCurses
+  # a data viewer for viewing some text or filecontents
+  # view filename, :close_key => KEY_RETURN
+  # send data in an array
+  # view Array, :close_key => KEY_RETURN, :layout => [0,0,23,80]
+  class Viewer
+    # @param filename as string or content as array
+    # @yield textview object for further configuration before display
+    # NOTE: i am experimentally yielding textview object so i could supress borders
+    # just for kicks, but on can also bind_keys or events if one wanted.
+    def self.view what, config={} #:yield: textview
+      case what
+      when String # we have a path
+        content = _get_contents(what)
+      when Array
+        content = what
+      else
+        raise ArgumentError, "Expecting Filename or Contents (array), but got #{what.class} "
+      end
+      wt = 0 # top margin
+      wl = 0 # left margin
+      wh = Ncurses.LINES-wt # height, goes to bottom of screen
+      ww = Ncurses.COLS-wl  # width, goes to right end
+      wt, wl, wh, ww = config[:layout] if config.has_key? :layout
+
+      fp = config[:title] || ""
+      pf = config.fetch(:print_footer, true)
+      ta = config.fetch(:title_attrib, 'bold')
+      fa = config.fetch(:footer_attrib, 'bold')
+
+      layout = { :height => wh, :width => ww, :top => wt, :left => wl } 
+      v_window = VER::Window.new(layout)
+      v_form = RubyCurses::Form.new v_window
+      textview = TextView.new v_form do
+        name   "Viewer" 
+        row  0
+        col  0
+        width ww
+        height wh-2
+        title fp
+        title_attrib ta
+        print_footer pf
+        footer_attrib fa
+      end
+      textview.set_content content #, :WRAP_WORD
+      
+      # yielding textview so you may further configure or bind keys or events
+      yield textview if block_given? # tentative
+      v_form.repaint
+      v_window.wrefresh
+      Ncurses::Panel.update_panels
+      begin
+        while((ch = v_window.getchar()) != ?\C-q.getbyte(0) )
+          break if ch == config[:close_key]
+          # if you've asked for RETURN then i also check for 10 and 13
+          break if (ch == 10 || ch == 13) && config[:close_key] == KEY_RETURN
+          v_form.handle_key ch
+          v_form.repaint
+        end
+      ensure
+        v_window.destroy if !v_window.nil?
+      end
+    end
+    private
+    def self._get_contents fp
+      return nil unless File.readable? fp 
+      return Dir.new(fp).entries if File.directory? fp
+      case File.extname(fp)
+      when '.tgz','.gz'
+        cmd = "tar -ztvf #{fp}"
+        content = %x[#{cmd}]
+      when '.zip'
+        cmd = "unzip -l #{fp}"
+        content = %x[#{cmd}]
+      else
+        content = File.open(fp,"r").readlines
+      end
+    end
+  end  # class
+end # module
+if __FILE__ == $PROGRAM_NAME
+require 'rbcurse/app'
+
+App.new do 
+  header = app_header "rbcurse 1.2.0", :text_center => "Viewer Demo", :text_right =>"New Improved!", :color => :black, :bgcolor => :white, :attr => :bold 
+  message "Press F1 to exit from here"
+
+    RubyCurses::Viewer.view(ARGV[0] || $0, :close_key => KEY_RETURN, :title => "Enter to close") do |t|
+      # you may configure textview further here.
+      #t.suppress_borders true
+      #t.color = :black
+      #t.bgcolor = :white
+      # or
+      #t.attr = :reverse
+    end
+
+end # app
+end

data/lib/rbcurse/io.rb

@@ -8,6 +8,18 @@
 #    * rbgetstr (and those it calls)
 #    * display_cmenu and create_mitem
 #*******************************************************#
+##
+# added RK 2010-11-02 18:11 so can be used in widgets too
+# maybe can be removed from app, if accessible there too.
+require 'forwardable'
+require 'rbcurse/extras/bottomline'
+#$terminal = RubyCurses::Bottomline.new
+#$terminal.name = "$terminal io.rb"
+#module Kernel
+  #extend Forwardable
+  #def_delegators :$terminal, :agree, :ask, :choose, :say
+#end
+#$tt.window = @window; $tt.message_row = @message_row # <<-- TODO somewhere
 module Io
 
   # from which line to print in footer_win
@@ -20,6 +32,8 @@ module Io
 # complex version of get_string that allows for trappng of control character
 # such as C-c and C-h and TAB for completion
 # validints contains int codes not chars.
+  # NOTE: change. C-g was help key in alpine but abort key in emacs. C-c sometimes
+  # crashes app, so i am using C-g as abort. Help on M-h
   # TODO We should put a field there, make it visible and mv it to after the prompt
   # and handle all editing events on it.
   # @return status_code, string (0 if okay, 7 if help asked for, -1 for abort
@@ -43,71 +57,73 @@ module Io
     #x mylabels += labels if !labels.nil?
     begin
       Ncurses.echo();
-    #x print_key_labels( 0, 0, mylabels)
-    #curpos = 0
-    curpos = str.length
-    prevchar = 0
-    entries = nil
-    #win.mvwgetnstr(LINEONE-3,askstr.length,yn,maxlen)
-    while true
-      #ch=win.mvwgetch(r, len) # get to right of prompt - WHY  NOT WORKING ??? 
-      ch=win.getchar()
-      $log.debug " rbgetstr got ch:#{ch}, str:#{str}. "
-      case ch
-      when 3 # -1 # C-c
-        return -1, nil
-      when 10, 13
-        break
-      when ?\C-h.getbyte(0), ?\C-?.getbyte(0), 127 # delete previous character/backspace
-        len -= 1 if len > prompt.length
-        curpos -= 1 if curpos > 0
-        str.slice!(curpos)
-        clear_this win, r, c, color, len+maxlen+1
-        #print_this(win, prompt+str, color, r, c)
-      when 330 # delete character on cursor
-        #len -= 1 if len > prompt.length
-        #curpos -= 1 if curpos > 0
-        str.slice!(curpos) #rescue next
-        clear_this win, r, c, color, len+maxlen+1
-      when ?\C-g.getbyte(0)
-        #x print_footer_help(helptext)
-        helptext = config[:helptext] || "No help provided"
-        print_help(win, r, c, color, helptext)
-        return 7, nil
-      when KEY_LEFT
-        curpos -= 1 if curpos > 0
-        len -= 1 if len > prompt.length
-        win.wmove r, c+len # since getchar is not going back on del and bs
-        next
-      when KEY_RIGHT
-        if curpos < str.length
-          curpos += 1 #if curpos < str.length
-          len += 1 
+      #x print_key_labels( 0, 0, mylabels)
+      #curpos = 0
+      curpos = str.length
+      prevchar = 0
+      entries = nil
+      #win.mvwgetnstr(LINEONE-3,askstr.length,yn,maxlen)
+      while true
+        #ch=win.mvwgetch(r, len) # get to right of prompt - WHY  NOT WORKING ??? 
+        ch=win.getchar()
+        $log.debug " rbgetstr got ch:#{ch}, str:#{str}. "
+        case ch
+        when 3 # -1 # C-c
+          return -1, nil
+        when ?\C-g.getbyte(0)                              # ABORT
+          return -1, nil
+        when 10, 13 # hits ENTER
+          break
+        when ?\C-h.getbyte(0), ?\C-?.getbyte(0), KEY_BSPACE # delete previous character/backspace
+          len -= 1 if len > prompt.length
+          curpos -= 1 if curpos > 0
+          str.slice!(curpos)
+          clear_this win, r, c, color, len+maxlen+1
+          #print_this(win, prompt+str, color, r, c)
+        when 330 # delete character on cursor
+          #len -= 1 if len > prompt.length
+          #curpos -= 1 if curpos > 0
+          str.slice!(curpos) #rescue next
+          clear_this win, r, c, color, len+maxlen+1
+        when ?\M-h.getbyte(0) #                            HELP KEY
+          #x print_footer_help(helptext)
+          helptext = config[:helptext] || "No help provided"
+          print_help(win, r, c, color, helptext)
+          return 7, nil
+        when KEY_LEFT
+          curpos -= 1 if curpos > 0
+          len -= 1 if len > prompt.length
           win.wmove r, c+len # since getchar is not going back on del and bs
-        end
-        next
-      when ?\M-i.getbyte(0) 
-        ins_mode = !ins_mode
-        next
-      when 9 # TAB
-        if config
-          if prevchar == 9
-            if !entries.nil? and !entries.empty?
-              str = entries.delete_at(0)
+          next
+        when KEY_RIGHT
+          if curpos < str.length
+            curpos += 1 #if curpos < str.length
+            len += 1 
+            win.wmove r, c+len # since getchar is not going back on del and bs
+          end
+          next
+        when ?\M-i.getbyte(0) 
+          ins_mode = !ins_mode
+          next
+        when KEY_TAB # TAB
+          if config
+            if prevchar == 9
+              if !entries.nil? and !entries.empty?
+                str = entries.delete_at(0)
+              end
+            else
+              tabc = config[:tab_completion] unless tabc
+              next unless tabc
+              entries = tabc.call(str)
+              $log.debug " tab got #{entries} "
+              str = entries.delete_at(0) unless entries.nil? or entries.empty?
             end
-          else
-            tabc = config[:tab_completion] unless tabc
-            next unless tabc
-            entries = tabc.call(str)
-            $log.debug " tab got #{entries} "
-            str = entries.delete_at(0) unless entries.nil? or entries.empty?
           end
-        end
-      else
-        #if validints.include?ch
+        else
+          #if validints.include?ch
           #print_status("Found in validints")
           #return ch, nil
-        #else
+          #else
           if ch < 0 || ch > 255
             Ncurses.beep
             next
@@ -117,23 +133,23 @@ module Io
             Ncurses.beep
             next
           end
-        # we need to trap KEY_LEFT and RIGHT and what of UP for history ?
-        #end
-        #str << ch.chr
+          # we need to trap KEY_LEFT and RIGHT and what of UP for history ?
+          #end
+          #str << ch.chr
           if ins_mode
             str[curpos] = ch.chr
           else
             str.insert(curpos, ch.chr)
           end
           len += 1
-        curpos += 1
-        break if str.length > maxlen
+          curpos += 1
+          break if str.length > maxlen
+        end
+        print_this(win, prompt+str, color, r, c)
+        win.wmove r, c+len # more for arrow keys, curpos may not be end
+        prevchar = ch
       end
-      print_this(win, prompt+str, color, r, c)
-      win.wmove r, c+len # more for arrow keys, curpos may not be end
-      prevchar = ch
-    end
-    str = default if str == ""
+      str = default if str == ""
     ensure
       Ncurses.noecho();
       #x restore_application_key_labels # must be done after using print_key_labels
@@ -290,14 +306,14 @@ module Io
     # prints given text to window, in color at x and y coordinates
     # @param [Window] window to write to
     # @param [String] text to print
-    # @param [int] color such as $datacolor or $promptcolor
-    # @param [int] x 
-    # @param [int] y 
+    # @param [int] color pair such as $datacolor or $promptcolor
+    # @param [int] x  row
+    # @param [int] y  col
     # @see Window#printstring
     # Consider using Window#printstring
   def print_this(win, text, color, x, y)
-    if(win == nil)
-      raise "win nil in printthis"
+    if !win
+      raise "win nil in print_this"
     end
     #$log.debug " printthis #{win} , #{text} , #{x} , #{y} "
     color=Ncurses.COLOR_PAIR(color);
@@ -550,6 +566,17 @@ module Io
     return yn == 'y' 
   end
 
+  #
+  # warn user: currently flashes and places error in log file
+  # experimental, may change interface later
+  # it does not say anything on screen
+  # @param [String] text of error/warning to put in log
+  # @since 1.1.5
+  def warn string
+    $log.warn string
+    Ncurses.beep
+  end
+
   #def add_item hotkey, label, desc,action
   #
   ## A *simple* way of creating menus that will appear in a single row.
@@ -589,12 +616,36 @@ module Io
       @text = text
       @options = []
     end
-    def add menuitem
-      @options << menuitem
+    def add *menuitem
+      item = nil
+      case menuitem.first
+      when CMenuItem
+        item = menuitem.first
+        @options << item
+      else
+        item = CMenuItem.new(*menuitem.flatten)
+        @options << item
+      end
+      return item
     end
     def create_mitem *args
       item = CMenuItem.new(*args.flatten)
     end
+    # create the whole thing using a MenuTree which has minimal information.
+    # It uses a hotkey and a code only. We are supposed to resolve the display text
+    # and actual proc from the caller using this code.
+    def menu_tree mt, pm = self
+      mt.each_pair { |ch, code| 
+        if code.is_a? RubyCurses::MenuTree
+          item = pm.add(ch, code.value, "") 
+          current = PromptMenu.new @caller, code.value
+          item.action = current
+          menu_tree code, current
+        else
+          item = pm.add(ch, code.to_s, "", code) 
+        end
+      }
+    end
     # Display the top level menu and accept user input
     # Calls actions or symbols upon selection, or traverses submenus
     # @return retvalue of last call or send, or 0
@@ -611,9 +662,10 @@ module Io
         h = {}
         valid = []
         menu.each{ |item|
-          str << "(%c) %s " % [ item.hotkey, item.label ]
-          h[item.hotkey] = item
-          valid << item.hotkey
+          hk = item.hotkey.to_s
+          str << "(%c) %s " % [ hk, item.label ]
+          h[hk] = item
+          valid << hk
         }
         #$log.debug " valid are #{valid} "
         color = $datacolor
@@ -621,6 +673,11 @@ module Io
         ch=win.getchar()
         #$log.debug " got ch #{ch} "
         next if ch < 0 or ch > 255
+        if ch == 3 || ch == ?\C-g.getbyte(0)
+          clear_this win, r, c, color, str.length
+          print_this(win, "Aborted.", color, r,c)
+          break
+        end
         ch = ch.chr
         index = valid.index ch
         if index.nil?

data/lib/rbcurse/keylabelprinter.rb

@@ -116,11 +116,14 @@ module RubyCurses
     ##
     # updates existing label with a new one.
     # @return true if updated, else false
+    # @example update "C-x", "C-x", "Disable"
     def update_application_key_label(display_code, new_display_code, text)
       @repaint_required = true
       labels = key_labels()
+      raise "labels are nil !!!" unless labels
       labels.each_index do |ix|
         lab = labels[ix]
+        next if lab.nil?
         if lab[0] == display_code
           labels[ix] = [new_display_code , text]
           $log.debug("updated #{labels[ix]}")
@@ -129,6 +132,7 @@ module RubyCurses
       end
       return false
     end
+    alias :update :update_application_key_label
     ##
     # inserts an application label at given index
     # to add the key, use create_datakeys to add bindings

data/lib/rbcurse/listcellrenderer.rb

@@ -1,16 +1,15 @@
-require 'rubygems'
-require 'ncurses'
-require 'logger'
 require 'rbcurse/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 DSL
-    #include EventHandler
     include RubyCurses::ConfigSetup
     include RubyCurses::Utils
     dsl_accessor :justify     # :right, :left, :center  # added 2008-12-22 19:02 
@@ -29,20 +28,93 @@ module RubyCurses
       instance_eval &block if block_given?
       init_vars
     end
-    def init_vars
-      @justify ||= :left
+    # 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
+      # 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
+      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
-        #acolor =get_color $datacolor, @color || @parent.color, @bgcolor || @parent.bgcolor #unless @parent.nil?
         @attr = @row_attr || Ncurses::A_NORMAL
-        ##@row_attr = Ncurses::A_NORMAL # added 2009-02-04 18:35 since overriding in rfe
 
 
         ## determine bg and fg and attr
@@ -50,57 +122,17 @@ module RubyCurses
           @attr = Ncurses::A_BOLD if selected
           @color_pair =get_color $selectedcolor, @parent.selected_color, @parent.selected_bgcolor unless @parent.nil?
         end
-        if focussed 
+        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
 
-    ##
-    # 
-    def repaint graphic, r=@row,c=@col, row_index=-1,value=@text, focussed=false, selected=false
-        #$log.debug "label :#{@text}, #{value}, #{r}, #{c} col= #{@color}, #{@bgcolor} acolor= #{acolor} j:#{@justify} dlL: #{@display_length} "
-
-      prepare_default_colors focussed, selected
-
-        lablist = []
-        value=value.to_s # ??
-        if @height && @height > 1
-          lablist = wrap_text(value, @display_length).split("\n")
-        else
-          # ensure we do not exceed
-          if !@display_length.nil?
-            if value.length > @display_length
-              value = value[0..@display_length-1]
-            end
-          end
-          lablist << value
-        end
-        len = @display_length || value.length
-        _height = @height || 1
-        str = @justify.to_sym == :right ? "%*s" : "%-*s"  # added 2008-12-22 19:05 
-        # loop added for labels that are wrapped.
-        # clear separately since value can change in status like labels
-        #len -= @left_margin
-        0.upto(_height-1) { |i| 
-          graphic.printstring r+i, c, ( " " * len) , @color_pair,@attr
-        }
-        lablist.each_with_index do |_value, ix|
-          break if ix >= _height
-          if @justify.to_sym == :center
-            padding = (@display_length - _value.length)/2
-            _value = " "*padding + _value + " "*padding # so its cleared if we change it midway
-          end
-          graphic.printstring r, c, str % [len, _value], @color_pair,@attr
-          r += 1
-        end
-=begin
-        if @parent.search_found_ix == row_index
-          if !@parent.find_offset.nil?
-            graphic.mvchgat(y=r, x=@parent.find_offset, @parent.find_offset1, Ncurses::A_NORMAL, $reversecolor, nil)
-          end
-        end
-=end
-    end
-  # ADD HERE 
-  end
-end
+end # module