rbcurse 1.1.5 → 1.2.0.pre

data/lib/rbcurse/rtextview.rb

@@ -46,10 +46,16 @@ module RubyCurses
     # painting the footer does slow down cursor painting slightly if one is moving cursor fast
     dsl_accessor :print_footer
     dsl_accessor :suppress_borders # added 2010-02-10 20:05 values true or false
+    attr_reader :current_index
+    dsl_accessor :border_attrib, :border_color # 
+    dsl_accessor :sanitization_required
 
     def initialize form = nil, config={}, &block
       @focusable = true
       @editable = false
+      @sanitization_required = true
+      @suppress_borders = false
+      @row_offset = @col_offset = 1 
       @row = 0
       @col = 0
       @show_focus = false  # don't highlight row under focus
@@ -57,19 +63,20 @@ module RubyCurses
       super
       # ideally this should have been 2 to take care of borders, but that would break
       # too much stuff !
-      @row_offset = @col_offset = 1 
-      #@scrollatrow = @height-2
-      @content_rows = @list.length
       @win = @graphic
 
-      install_keys
+      @_events.push :CHANGE # thru vieditable
+      @_events << :PRESS # new, in case we want to use this for lists and allow ENTER
+      @_events << :ENTER_ROW # new, should be there in listscrollable ??
+      install_keys # do something about this nonsense FIXME
       init_vars
+      map_keys
     end
-    def init_vars
+    def init_vars #:nodoc:
       @curpos = @pcol = @toprow = @current_index = 0
       @repaint_all=true 
+      @repaint_required=true 
       ## 2010-02-10 20:20 RFED16 taking care if no border requested
-      @suppress_borders ||= false
       @row_offset = @col_offset = 0 if @suppress_borders == true
       # added 2010-02-11 15:11 RFED16 so we don't need a form.
       @win_left = 0
@@ -79,20 +86,27 @@ module RubyCurses
       # currently i scroll right only if  current line is longer than display width, i should use 
       # longest line on screen.
       @longest_line = 0 # the longest line printed on this page, used to determine if scrolling shd work
+      @internal_width = 2
+      @internal_width = 0 if @suppress_borders
 
+    end
+    def map_keys
       bind_key([?g,?g]){ goto_start } # mapping double keys like vim
       bind_key([?',?']){ goto_last_position } # vim , goto last row position (not column)
       bind_key(?/, :ask_search)
       bind_key(?n, :find_more)
       bind_key([?\C-x, ?>], :scroll_right)
       bind_key([?\C-x, ?<], :scroll_left)
-      bind_key(?r) { getstr("Enter a word") }
+      bind_key([?\C-x, ?\C-s], :saveas)
+      bind_key(?r) { getstr("Enter a word: ") }
       bind_key(?m, :disp_menu)
     end
     ## 
     # send in a list
     # e.g.         set_content File.open("README.txt","r").readlines
     # set wrap at time of passing :WRAP_NONE :WRAP_WORD
+    # XXX if we widen the textview later, as in a vimsplit that data
+    # will still be wrapped at this width !!
     def set_content list, wrap = :WRAP_NONE
       @wrap_policy = wrap
       if list.is_a? String
@@ -112,27 +126,36 @@ module RubyCurses
       else
         raise "set_content expects Array not #{list.class}"
       end
+      init_vars
+    end
+    def remove_all
+      @list = []
+      init_vars
+      @repaint_required = true
     end
     ## display this row on top
-    def top_row(*val)
+    def top_row(*val) #:nodoc:
       if val.empty?
         @toprow
       else
         @toprow = val[0] || 0
-        #@prow = val[0] || 0
       end
       @repaint_required = true
     end
     ## ---- for listscrollable ---- ##
-    def scrollatrow
-      @height - 3 # trying out 2009-10-31 15:22 XXX since we seem to be printing one more line
+    def scrollatrow #:nodoc:
+      if @suppress_borders
+        @height - 1  # should be 2 FIXME but erasing lower line. see appemail
+      else
+        @height - 3 
+      end
     end
     def row_count
       @list.length
     end
     ##
     # returns row of first match of given regex (or nil if not found)
-    def find_first_match regex
+    def find_first_match regex #:nodoc:
       @list.each_with_index do |row, ix|
         return ix if !row.match(regex).nil?
       end
@@ -140,31 +163,44 @@ module RubyCurses
     end
     ## returns the position where cursor was to be positioned by default
     # It may no longer work like that. 
-    def rowcol
+    def rowcol #:nodoc:
       return @row+@row_offset, @col+@col_offset
     end
-    def wrap_text(txt, col = @maxlen)
-      col ||= @width-2
-      $log.debug "inside wrap text for :#{txt}"
+    def wrap_text(txt, col = @maxlen) #:nodoc:
+      col ||= @width-@internal_width
+      #$log.debug "inside wrap text for :#{txt}"
       txt.gsub(/(.{1,#{col}})( +|$\n?)|(.{1,#{col}})/,
                "\\1\\3\n") 
     end
     ## print a border
     ## Note that print_border clears the area too, so should be used sparingly.
-    def print_borders
+    def print_borders #:nodoc:
+      raise "textview needs width" unless @width
+      raise "textview needs height" unless @height
+
       $log.debug " #{@name} print_borders,  #{@graphic.name} "
-      color = $datacolor
-      @graphic.print_border @row, @col, @height-1, @width, color #, Ncurses::A_REVERSE
+      
+      bordercolor = @border_color || $datacolor
+      borderatt = @border_attrib || Ncurses::A_NORMAL
+      @graphic.print_border @row, @col, @height-1, @width, bordercolor, borderatt
       print_title
     end
-    def print_title
-      $log.debug " print_title #{@row}, #{@col}, #{@width}  "
-      @graphic.printstring( @row, @col+(@width-@title.length)/2, @title, $datacolor, @title_attrib) unless @title.nil?
+    def print_title #:nodoc:
+      return unless @title
+      raise "textview needs width" unless @width
+      @color_pair ||= get_color($datacolor) # should we not use this ??? XXX
+      #$log.debug " print_title #{@row}, #{@col}, #{@width}  "
+      # check title.length and truncate if exceeds width
+      _title = @title
+      if @title.length > @width - 2
+        _title = @title[0..@width-2]
+      end
+      @graphic.printstring( @row, @col+(@width-_title.length)/2, _title, $datacolor, @title_attrib) unless @title.nil?
     end
-    def print_foot
+    def print_foot #:nodoc:
       @footer_attrib ||= Ncurses::A_REVERSE
       footer = "R: #{@current_index+1}, C: #{@curpos+@pcol}, #{@list.length} lines  "
-      $log.debug " print_foot calling printstring with #{@row} + #{@height} -1, #{@col}+2"
+      #$log.debug " print_foot calling printstring with #{@row} + #{@height} -1, #{@col}+2"
       @graphic.printstring( @row + @height -1 , @col+2, footer, $datacolor, @footer_attrib) 
       @repaint_footer_required = false # 2010-01-23 22:55 
     end
@@ -172,11 +208,11 @@ module RubyCurses
     def get_content
       @list
     end
-    def get_window
+    def get_window #:nodoc:
       @graphic
     end
-    ### FOR scrollable ###
-    def repaint # textview
+
+    def repaint # textview :nodoc:
       if @screen_buffer.nil?
         safe_create_buffer
         @screen_buffer.name = "Pad::TV_PAD_#{@name}" unless @screen_buffer.nil?
@@ -186,14 +222,18 @@ module RubyCurses
       #return unless @repaint_required # 2010-02-12 19:08  TRYING - won't let footer print for col move
       paint if @repaint_required
     #  raise "TV 175 graphic nil " unless @graphic
-      print_foot if @print_footer && @repaint_footer_required
+      print_foot if @print_footer && !@suppress_borders && @repaint_footer_required
       buffer_to_window
     end
     def getvalue
       @list
     end
+    def current_value
+      @list[@current_index]
+    end
     # textview
-    def handle_key ch
+    def handle_key ch #:nodoc:
+      $log.debug " textview got ch #{ch} "
       @buffer = @list[@current_index]
       if @buffer.nil? and row_count == 0
         @list << "\r"
@@ -228,7 +268,7 @@ module RubyCurses
         cursor_backward
       when KEY_RIGHT, ?l.getbyte(0)
         cursor_forward
-      when KEY_BACKSPACE, 127, 330
+      when KEY_BACKSPACE, KEY_BSPACE, KEY_DELETE
         cursor_backward
       when ?\C-a.getbyte(0) #, ?0.getbyte(0)
         # take care of data that exceeds maxlen by scrolling and placing cursor at start
@@ -246,6 +286,9 @@ module RubyCurses
         ask_search
       when @KEY_FIND_MORE
         find_more
+      when 10, 13, KEY_ENTER
+        #fire_handler :PRESS, self
+        fire_action_event
       when ?0.getbyte(0)..?9.getbyte(0)
         # FIXME the assumption here was that if numbers are being entered then a 0 is a number
         # not a beg-of-line command.
@@ -289,13 +332,13 @@ module RubyCurses
       return 0 # added 2010-01-12 22:17 else down arrow was going into next field
     end
     # newly added to check curpos when moving up or down
-    def check_curpos
+    def check_curpos #:nodoc:
       @buffer = @list[@current_index]
       # if the cursor is ahead of data in this row then move it back
       if @pcol+@curpos > @buffer.length
         addcol((@pcol+@buffer.length-@curpos)+1)
         @curpos = @buffer.length 
-        maxlen = (@maxlen || @width-2)
+        maxlen = (@maxlen || @width-@internal_width)
 
         # even this row is gt maxlen, i.e., scrolled right
         if @curpos > maxlen
@@ -309,11 +352,11 @@ module RubyCurses
       end
     end
     # set cursor on correct column tview
-    def set_form_col col1=@curpos
+    def set_form_col col1=@curpos #:nodoc:
       @cols_panned ||= 0
       @pad_offset ||= 0 # added 2010-02-11 21:54 since padded widgets get an offset.
       @curpos = col1
-      maxlen = @maxlen || @width-2
+      maxlen = @maxlen || @width-@internal_width
       #@curpos = maxlen if @curpos > maxlen
       if @curpos > maxlen
         @pcol = @curpos - maxlen
@@ -330,8 +373,8 @@ module RubyCurses
       setrowcol nil, col2
       @repaint_footer_required = true
     end
-    def cursor_forward
-      maxlen = @maxlen || @width-2
+    def cursor_forward #:nodoc:
+      maxlen = @maxlen || @width-@internal_width
       repeatm { 
       if @curpos < @width and @curpos < maxlen-1 # else it will do out of box
         @curpos += 1
@@ -344,16 +387,16 @@ module RubyCurses
       #@repaint_required = true
       @repaint_footer_required = true # 2010-01-23 22:41 
     end
-    def addcol num
+    def addcol num #:nodoc:
       #@repaint_required = true
       @repaint_footer_required = true # 2010-01-23 22:41 
       if @form
         @form.addcol num
       else
-        @parent_component.form.addcol num
+        @parent_component.form && @parent_component.form.addcol(num)
       end
     end
-    def addrowcol row,col
+    def addrowcol row,col #:nodoc:
       #@repaint_required = true
       @repaint_footer_required = true # 2010-01-23 22:41 
       if @form
@@ -362,7 +405,7 @@ module RubyCurses
         @parent_component.form.addrowcol num
       end
     end
-    def cursor_backward
+    def cursor_backward  #:nodoc:
       repeatm { 
       if @curpos > 0
         @curpos -= 1
@@ -376,10 +419,12 @@ module RubyCurses
       @repaint_footer_required = true # 2010-01-23 22:41 
     end
     # gives offset of next line, does not move
-    def next_line
+    # @deprecated
+    def next_line  #:nodoc:
       @list[@current_index+1]
     end
-    def do_relative_row num
+    # @deprecated
+    def do_relative_row num  #:nodoc:
       yield @list[@current_index+num] 
     end
 
@@ -387,8 +432,8 @@ module RubyCurses
     ##+ a window is resized, and destroyed, then this was never called again, so the 
     ##+ border would not be seen in splitpane unless the width coincided exactly with
     ##+ what is calculated in divider_location.
-    def paint
-      # not sure where to put this, once for all or repeat 2010-02-11 15:06 RFED16
+    def paint  #:nodoc:
+    
       my_win = nil
       if @form
         my_win = @form.window
@@ -396,39 +441,34 @@ module RubyCurses
         my_win = @target_window
       end
       @graphic = my_win unless @graphic
-      #$log.warn "neither form not target window given!!! TV paint 368" unless my_win
-      #raise " #{@name} neither form, nor target window given TV paint " unless my_win
-      #raise " #{@name} NO GRAPHIC set as yet                 TV paint " unless @graphic
       @win_left = my_win.left
       @win_top = my_win.top
 
       print_borders if (@suppress_borders == false && @repaint_all) # do this once only, unless everything changes
       rc = row_count
-      maxlen = @maxlen || @width-2
-      $log.debug " #{@name} textview repaint width is #{@width}, height is #{@height} , maxlen #{maxlen}/ #{@maxlen}, #{@graphic.name} roff #{@row_offset} coff #{@col_offset}" 
+      maxlen = @maxlen || @width-@internal_width
+      #$log.debug " #{@name} textview repaint width is #{@width}, height is #{@height} , maxlen #{maxlen}/ #{@maxlen}, #{@graphic.name} roff #{@row_offset} coff #{@col_offset}" 
       tm = get_content
       tr = @toprow
       acolor = get_color $datacolor
       h = scrollatrow() 
       r,c = rowcol
-      @longest_line = @width #maxlen
+      @longest_line = @width-@internal_width #maxlen
       0.upto(h) do |hh|
         crow = tr+hh
         if crow < rc
             #focussed = @current_index == crow ? true : false 
             #selected = is_row_selected crow
-            content = tm[crow].chomp
-            content.gsub!(/\t/, '  ') # don't display tab
-            content.gsub!(/[^[:print:]]/, '')  # don't display non print characters
-            if !content.nil? 
-              if content.length > maxlen # only show maxlen
-                @longest_line = content.length if content.length > @longest_line
-                content = content[@pcol..@pcol+maxlen-1] 
-              else
-                content = content[@pcol..-1]
-              end
-            end
-            @graphic.printstring  r+hh, c, "%-*s" % [@width-2,content], acolor, @attr
+            content = tm[crow]
+            # next call modified string. you may wanna dup the string.
+            # rlistbox does
+            # scrolling fails if you do not dup, since content gets truncated
+            content = content.dup
+            sanitize content if @sanitization_required
+            truncate content
+            @graphic.printstring  r+hh, c, "%-*s" % [@width-@internal_width,content], acolor, @attr
+
+            # highlighting search results.
             if @search_found_ix == tr+hh
               if !@find_offset.nil?
                 # handle exceed bounds, and if scrolling
@@ -440,24 +480,53 @@ module RubyCurses
 
         else
           # clear rows
-          @graphic.printstring r+hh, c, " " * (@width-2), acolor,@attr
+          @graphic.printstring r+hh, c, " " * (@width-@internal_width), acolor,@attr
         end
       end
-      show_caret_func
-      @table_changed = false
+      #show_caret_func
+      #@table_changed = false
       @repaint_required = false
-      @repaint_footer_required = true # 2010-01-23 22:41 
+      @repaint_footer_required = true
       @buffer_modified = true # required by form to call buffer_to_screen
-      @repaint_all = false # added 2010-01-08 18:56 for redrawing everything
+      @repaint_all = false 
 
       # 2010-02-10 22:08 RFED16
     end
+    # takes a block, this way anyone extending this class can just pass a block to do his job
+    # This modifies the string
+    def sanitize content  #:nodoc:
+      if content.is_a? String
+        content.chomp!
+        content.gsub!(/\t/, '  ') # don't display tab
+        content.gsub!(/[^[:print:]]/, '')  # don't display non print characters
+      else
+        content
+      end
+    end
+    # returns only the visible portion of string taking into account display length
+    # and horizontal scrolling. MODIFIES STRING
+    def truncate content  #:nodoc:
+      _maxlen = @maxlen || @width-@internal_width
+      _maxlen = @width-@internal_width if _maxlen > @width-@internal_width # take care of decrease in width
+      if !content.nil? 
+        if content.length > _maxlen # only show maxlen
+          @longest_line = content.length if content.length > @longest_line
+          #content = content[@pcol..@pcol+maxlen-1] 
+          content.replace(content[@pcol..@pcol+_maxlen-1] || "")
+        else
+          if @pcol > 0
+              content.replace(content[@pcol..-1]  || "")
+          end
+        end
+      end
+      content
+    end
     ## this is just a test of prompting user for a string
     #+ as an alternative to the dialog.
-    def getstr prompt, maxlen=10
+    def getstr prompt, maxlen=10  #:nodoc:
       tabc = Proc.new {|str| Dir.glob(str +"*") }
       config={}; config[:tab_completion] = tabc
-      config[:default] = "defaulT"
+      config[:default] = "default"
       $log.debug " inside getstr before call "
       ret, str = rbgetstr(@form.window, @row+@height-1, @col+1, prompt, maxlen, config)
       $log.debug " rbgetstr returned #{ret} , #{str} "
@@ -465,7 +534,19 @@ module RubyCurses
       return str
     end
     # this is just a test of the simple "most" menu
-    def disp_menu
+    # How can application add to this, or override
+    def disp_menu  #:nodoc:
+      require 'rbcurse/extras/menutree'
+      # we need to put this into data-structure so that i can be manipulated by calling apps
+      # This should not be at the widget level, too many types of menus. It should be at the app
+      # level only if the user wants his app to use this kind of menu.
+
+      @menu = RubyCurses::MenuTree.new "Main", { s: :goto_start, r: :scroll_right, l: :scroll_left, m: :submenu }
+      @menu.submenu :m, "submenu", {s: :noignorecase, t: :goto_last_position, f: :next3 }
+      menu = PromptMenu.new self 
+      menu.menu_tree @menu
+
+=begin
       menu = PromptMenu.new self 
       menu.add( menu.create_mitem( 's', "Goto start ", "Going to start", Proc.new { goto_start} ))
       menu.add(menu.create_mitem( 'r', "scroll right", "I have scrolled ", :scroll_right ))
@@ -478,6 +559,7 @@ module RubyCurses
       menu.add(item)
       # how do i know what's available. the application or window should know where to place
       #menu.display @form.window, 23, 1, $datacolor #, menu
+=end
       menu.display @form.window, $error_message_row, $error_message_col, $datacolor #, menu
     end
     ##
@@ -488,6 +570,77 @@ module RubyCurses
       extend Object.const_get("#{includename}")
       send("#{requirename}_init") #if respond_to? "#{includename}_init"
     end
+    # on pressing ENTER we send user some info, the calling program
+    # would bind :PRESS
+    #--
+    # FIXME we can create this once and reuse
+    #++
+    def fire_action_event
+      require 'rbcurse/ractionevent'
+      aev = TextActionEvent.new self, :PRESS, current_value(), @current_index, @curpos
+      fire_handler :PRESS, aev
+    end
+    # called by listscrollable, used by scrollbar ENTER_ROW
+    def on_enter_row arow
+      fire_handler :ENTER_ROW, self
+      @repaint_required = true
+    end
+    # added 2010-09-30 18:48 so standard with other components, esp on enter 
+    def on_enter
+      if @list.nil? || @list.size == 0
+        Ncurses.beep
+        return :UNHANDLED
+      end
+      on_enter_row @current_index
+      set_form_row 
+      @repaint_required = true
+      super
+      true
+    end
+    def pipe_file
+      # TODO ask process name from user
+      output = pipe_output 'munpack', @list
+      if output && !output.empty?
+        set_content output
+      end
+    end
+    # returns array of lines after running command on string passed
+    # TODO: need to close pipe other's we'll have a process lying
+    # around forever.
+    def pipe_output (pipeto, str)
+      case str
+      when String
+        #str = str.split "\n"
+        # okay
+      when Array
+        str = str.join "\n"
+      end
+      #pipeto = '/usr/sbin/sendmail -t'
+      #pipeto = %q{mail -s "my title" rahul}
+      if pipeto != nil  # i was taking pipeto from a hash, so checking
+        proc = IO.popen(pipeto, "w+")
+        proc.puts str
+        proc.close_write
+        proc.readlines
+      end
+    end
+    def saveas name=nil, config={}
+      unless name
+        name = @graphic.ask "File to save as: "
+        return if name.nil? || name == ""
+      end
+      exists = File.exists? name
+      if exists # need to prompt
+        return unless @graphic.agree("Overwrite existing file? ", true)
+      end
+      l = getvalue
+      File.open(name, "w"){ |f|
+        l.each { |line| f.puts line }
+        #l.each { |line| f.write line.gsub(/\r/,"\n") }
+      }
+      @graphic.say "#{name} written."
+    end
+
 
   end # class textview