rbcurse 0.1.3 → 1.1.1

data/lib/rbcurse/scrollable.rb

@@ -221,18 +221,18 @@ module Scrollable
       begin
         pre_key
         case ch
-        when ?\C-n
+        when ?\C-n.getbyte(0)
           scroll_forward
         when 32
           scroll_forward
-        when ?\C-p
+        when ?\C-p.getbyte(0)
           scroll_backward
-        when ?0
+        when ?0.getbyte(0)
           goto_start
-        when ?9
+        when ?9.getbyte(0)
           goto_end
-        when ?[
-        when ?[
+        when ?[.getbyte(0)
+        when ?[.getbyte(0)
         when KEY_UP
           #select_prev_row
           up
@@ -245,7 +245,7 @@ module Scrollable
           if respond_to? :fire
             fire
           end
-        when ?A..?Z, ?a..?z
+        when ?A.getbyte(0)..?Z.getbyte(0), ?a.getbyte(0)..?z.getbyte(0)
           ret = set_selection_for_char ch.chr
         else
           return :UNHANDLED #if ret == -1

data/lib/rbcurse/selectable.rb

@@ -71,17 +71,17 @@ module Selectable
   def selectable_handle_key ch
     begin
       case ch
-      when ?;, 32  # x no more selecting since we now jump to row matching char 2008-12-18 13:13 
+      when ?;.getbyte(0), 32  # x no more selecting since we now jump to row matching char 2008-12-18 13:13 
         return if is_popup and @select_mode == 'single' # not allowing select this way since there will be a difference 
         # between pressing ENTER and space. Enter is trapped by Listbox!
         do_select
-      when ?'
+      when ?'.getbyte(0)
         $log.debug "insdie next selection"
         do_next_selection if @select_mode == 'multiple'
-      when ?"
+      when ?".getbyte(0)
         $log.debug "insdie prev selection"
         do_prev_selection if @select_mode == 'multiple'
-      when ?\C-e
+      when ?\C-e.getbyte(0)
         do_clear_selection if @select_mode == 'multiple'
       else
         return :UNHANDLED

data/lib/rbcurse/table/tablecellrenderer.rb

@@ -77,6 +77,9 @@ module RubyCurses
             padding = 0 if padding < 0
             _value = " "*padding + _value + " "*padding # so its cleared if we change it midway
           end
+          # XXX  2009-10-05 23:01 since the len can vary when scrolling
+          # right justification for numbers suffers.
+          # perhaps one should use display_length and then truncate using len
           graphic.printstring r, c, str % [len, _value], acolor,_attr
           r += 1
         end

data/lib/rbcurse/undomanager.rb

@@ -0,0 +1,181 @@
+=begin
+  * Name: UndoManager
+  * Description: Manages undo of text components
+  * Author: rkumar (arunachalesha)
+
+ISSUES 
+
+This is a very simple, undo facility. This could change in the near future.
+
+Todo:
+We need to handle block updates - several undo ops to be done together.
+
+  
+  --------
+  * Date:  2010-03-07 19:42 
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+=end
+
+# 
+#  
+module RubyCurses
+  #
+  # AbstractUndo has the basic workings of the undo redo facility.
+  # It leaves the actual undo and redo to the implementing source object. However,
+  # it does the work of storing edits, and passing the correct edit to the implementor
+  # when the source object calls for an undo or redo operation. It thus manages the edit (undo) queue.
+  #
+  class AbstractUndo
+    # initialize the source object which will issue undo requests
+    def initialize _source
+      source(_source) #if _source
+      @pointer = 0
+      @actions = []
+      $log.debug " INSIDE UNDO CONSTR "
+    end
+    def source(_source)
+      $log.debug " calling source= "
+      raise "Cannot pass a nil source" unless _source
+      @source = _source
+      # currently this is very hardcode again. we need to see this in the light of other objects
+      #@source.bind(:CHANGE){|eve| add_edit(eve) }
+      # a little roundabout but done for getting things up fast
+      @source.undo_handler(self)
+      $log.debug " I am listening to change events on #{@source.name} "
+    end
+    # this is called whenever an undoable edit has happened.
+    # Currently, it is linked above in the bind statement. We've attached this 
+    # method as a listener to the source.
+    def add_edit event
+      # this debug is very specific. it should be removed later. We do not know about the object
+      $log.debug " UNDO GOT #{event}: #{event.type}, (#{event.text}), rej: #{@reject_update}  "
+      return if @reject_update
+      if @pointer < @actions.length
+        $log.debug " removing some actions since #{@pointer} < #{@actions.length} "
+        @actions.slice!(@pointer..-1)
+        $log.debug " removed actions since #{@pointer} , #{@actions.length} "
+      end
+      @actions << event
+      @pointer = @actions.length
+    end
+    # this has to be bound in source component
+    # typically bind C-_ to undo()
+    # this method figures out the correct undo object to be sent
+    # to the implementor
+    def undo
+      $log.debug " got UNDO call #{@pointer}, sz:#{@actions.size}  "
+      return if @pointer == 0
+      @reject_update = true
+      @pointer -=1 #if @pointer > 0
+      @source.repaint_required true
+      @reject_update = false
+      edit = @actions[@pointer]
+      perform_undo edit
+    end
+    # this has to be bound in source
+    # typically bind C-r to redo()
+    # this method figures out the correct redo object to be sent
+    # to the implementor
+    def redo
+      $log.debug "UNDO GOT REDO call #{@pointer}, #{@actions.size}  "
+      return if @pointer >= @actions.size
+      @reject_update = true
+      edit = @actions[@pointer]
+      perform_redo edit
+      @source.repaint_required true
+      @pointer +=1 #if @pointer > 0
+      @reject_update = false
+    end
+    def perform_redo edit
+      raise "You must implement this for your undoable component "
+    end
+    def perform_undo edit
+      raise "You must implement this for your undoable component "
+      # to be implemented
+    end
+    #def to_s
+      #inspect
+    #end
+    #def inspect
+      ### now that textarea.to_s prints content we shouldn pass it here.
+      ##"#{@type.to_s}, #{@source}, ind0:#{@index0}, ind1:#{@index1}, row:#{@row}, text:#{@text}"
+      #"#{@type.to_s}, ind0:#{@index0}, ind1:#{@index1}, row:#{@row}, text:#{@text}"
+    #end
+  end
+    ## An implementation of AbstractUndo for textarea.
+    # Very basic.
+  class SimpleUndo < AbstractUndo
+    def initialize _source
+      super
+    end
+    def source(_source)
+      super
+      _source.bind(:CHANGE){|eve| add_edit(eve) }
+    end
+    def perform_undo act
+      row = act.row
+      col = act.index0
+      $log.debug " processing #{act} "
+      case act.type
+      when :INSERT
+        howmany = act.index1 - col
+        @source.list[row].slice!(col,howmany)
+      when :DELETE
+        $log.debug " UNDO processing DELETE #{col}, (#{act.text})  "
+        @source.list[row].insert(col, act.text.chomp)
+      when :DELETE_LINE
+        $log.debug " UNDO inside delete-line #{row} "
+        #@source.list.insert(row, act.text) # insert a blank line, since one was deleted
+        case act.text
+        when Array
+          index = row
+          act.text.each_with_index{|r,i| @source.list.insert index+i, r}
+        when String
+          @source.list.insert row, act.text
+        end
+      when :INSERT_LINE
+        $log.debug " UNDO inside insert-line #{row} "
+        case act.text
+        when Array
+          act.text.size.times { @source.list.delete_at row }
+        when String
+          @source.list.delete_at row
+        end
+      else
+        $log.warn "unhandled change type #{act.type} "
+      end
+      @source.repaint_required true
+      @reject_update = false
+    end
+    # this has to be bound in source
+    def perform_redo act
+      row = act.row
+      col = act.index0
+      $log.debug " REDO processing #{act} "
+      case act.type
+      when :INSERT
+        @source.list[row].insert(col, act.text)
+      when :DELETE
+        row = act.row
+        col = act.index0
+        howmany = act.index1 - col
+        @source.list[row].slice!(col,howmany)
+      when :DELETE_LINE
+        #$log.debug " UNDO redo got deleteline #{row} "
+        @source.list.delete_at row
+      when :INSERT_LINE
+        case act.text
+        when Array
+          index = row
+          act.text.each_with_index{|r,i| @source.list.insert index+i, r}
+        when String
+          @source.list.insert row, act.text
+        end
+      else
+        $log.warn "unhandled change type #{act.type} "
+      end
+    end
+  end
+end # module

data/lib/rbcurse/vieditable.rb

@@ -0,0 +1,100 @@
+#**************************************************************
+# Author: rkumar (arunachalesha)
+# Date: 2010-03-11 22:18 
+# Provides the caller ability to do some edit operations
+# on list widgets using either keys (vim largely)
+# or a menu. made originally for textview and multitextview
+#
+#**************************************************************
+    #hscrollcols = $multiplier > 0 ? $multiplier : @width/2
+  #def previous_row num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
+require 'rbcurse/listeditable'
+module ViEditable
+  include ListEditable
+
+  #def ViEditable.vieditable_init
+  def vieditable_init
+    $log.debug " inside vieditable_init "
+    @editable = true
+    bind_key( ?C, :edit_line)
+    bind_key( ?o, :insert_line)
+    bind_key( ?O) { insert_line(@current_index-1) } 
+    bind_key( ?D, :delete_eol)
+    bind_key( [?d, ?$], :delete_eol)
+    bind_key( [?d, ?d] , :delete_line ) 
+    bind_key( [?d, ?w], :delete_word )
+    bind_key( [?d, ?t], :delete_till )
+    bind_key( [?d, ?f], :delete_forward )
+    bind_key( ?\C-_ ) { @undo_handler.undo if @undo_handler }
+    bind_key( ?u ) { @undo_handler.undo if @undo_handler }
+    bind_key( ?\C-r ) { @undo_handler.redo if @undo_handler }
+    bind_key( ?x, :delete_curr_char )
+    bind_key( ?X, :delete_prev_char )
+    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(?f, :forward_char)
+
+  end
+
+  ##
+  # edit current or given line
+  def edit_line lineno=@current_index
+    line = @list[lineno]
+    prompt = "Edit: "
+    maxlen = 80
+    config={}; 
+    config[:default] = line
+    ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+    $log.debug " rbgetstr returned #{ret} , #{str} "
+    return if ret != 0
+    @list[lineno].replace(str)
+    @repaint_required = true
+  end
+  ##
+  # insert a line 
+  def insert_line lineno=@current_index
+    prompt = "Insert: "
+    maxlen = 80
+    #config={}; 
+    #config[:default] = line
+    #ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+    ret, str = input_string prompt
+    #ret, str = rbgetstr(@form.window, @row+@height-1, @col+1, prompt, maxlen, config)
+    $log.debug " rbgetstr returned #{ret} , #{str} "
+    return if ret != 0
+    @list.insert lineno, str
+    @repaint_required = true
+  end
+  ##
+  # common method to edit given string
+  # @param [String] string to edit/modify
+  # @param [String] prompt to display before string
+  # @param [int] max length of input
+  # @return [0, -1] return value 0 if okay, -1 if error
+  #
+  def edit_string string, prompt="Edit: ", maxlen=80
+    config={}; 
+    config[:default] = string
+    ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+    #return str if ret == 0
+    #return ""
+  end
+  ##
+  # common method to input a blank string
+  # @param [String] prompt to display before string
+  # @param [int] max length of input
+  # @return [0, -1] return value 0 if okay, -1 if error
+  def input_string prompt="Insert: ", maxlen=80
+    ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+    #return str if ret == 0
+    #return ""
+  end
+  def edit_chars
+
+  end
+  def edit_word
+
+  end
+end # module

data/lib/ver/window.rb

@@ -1,17 +1,12 @@
 require 'ver/ncurses'
 module VER
-  # Responsibilities:
-  # * Interface to Ncurses::WINDOW and Ncurses::Panel
-  # * behave IO like: (print puts write read readline)
-  # * hide and show itself
-
-  # There's a very strange bug when i tried subclassing this, as Ncurses seems
-  # to overwrite WINDOW::new, which will not return the Window instance we
-  # want. So we have to wrap instead of subclass.
-  class Window # < Ncurses::WINDOW
+  class Window 
     attr_reader :width, :height, :top, :left
     attr_accessor :layout
-    attr_reader   :panel   # XXX reader requires so he can del it in end
+    attr_reader   :panel   # reader requires so he can del it in end
+    attr_reader   :window_type   # window or pad to distinguish 2009-11-02 23:11 
+    attr_accessor :name  # more for debugging log files. 2010-02-02 19:58 
+    attr_accessor :modified # has it been modified and may need a refresh
 
     def initialize(layout)
       @visible = true
@@ -19,24 +14,48 @@ module VER
 
       @window = Ncurses::WINDOW.new(height, width, top, left)
       @panel = Ncurses::Panel.new_panel(@window)
+      init_vars
       ## eeks XXX next line will wreak havoc when multiple windows opened like a mb or popup
-      $error_message_row = $status_message_row = Ncurses.LINES-1
+      #$error_message_row = $status_message_row = Ncurses.LINES-1
+      $error_message_row ||= Ncurses.LINES-1
+      $error_message_col ||= 1
+
 
+    end
+    def init_vars
+      @window_type = :WINDOW
       Ncurses::keypad(@window, true)
       @stack = []
+      @name ||="#{self}"
+      @modified = true
+      $catch_alt_digits ||= false # is this where is should put globals ? 2010-03-14 14:00 XXX
     end
+    ##
+    # this is an alternative constructor
     def self.root_window(layout = { :height => 0, :width => 0, :top => 0, :left => 0 })
       #VER::start_ncurses
       @layout = layout
       @window = Window.new(@layout)
+      @window.name = "Window::ROOTW"
       @window.wrefresh
       Ncurses::Panel.update_panels
       return @window
     end
+    # 2009-10-13 12:24 
+    # not used as yet
+    # this is an alternative constructor
+    # created if you don't want to create a hash first
+    def self.create_window(h=0, w=0, t=0, l=0)
+      layout = { :height => h, :width => w, :top => t, :left => l }
+      @window = Window.new(layout)
+      return @window
+    end
 
     def resize_with(layout)
+      $log.debug " DARN ! This awready duz a resize!! if h or w or even top or left changed!!! XXX"
       reset_layout(layout)
       @window.wresize(height, width)
+      # this is dicey since we often change top and left in pads only for panning !! XXX
       @window.mvwin(top, left)
     end
 
@@ -130,6 +149,10 @@ module VER
       @window.mvchgat(y, x, max, Ncurses::A_NORMAL, color, nil)
     end
 
+    def ungetch(ch)
+      Ncurses.ungetch(ch)
+    end
+
     def getch
       @window.getch
     rescue Interrupt => ex
@@ -276,6 +299,7 @@ module VER
       # @panel = @window.panel if @window
       #Ncurses::Panel.del_panel(@panel) if !@panel.nil?   
       #@window.delwin if !@window.nil?
+      $log.debug "win destroy"
 
       #@panel = @window.panel if @window
       Ncurses::Panel.del_panel(@panel) if !@panel.nil?   
@@ -291,10 +315,17 @@ module VER
     # @ param att - ncurses attribute: normal, bold, reverse, blink,
     # underline
     def printstring(r,c,string, color, att = Ncurses::A_NORMAL)
+        prv_printstring(r,c,string, color, att )
+    end
+
+    ## name changed from printstring to prv_prinstring
+    def prv_printstring(r,c,string, color, att = Ncurses::A_NORMAL)
 
-      ## XXX check if row is exceeding height and don't print
-      att = Ncurses::A_NORMAL if att.nil?
+      #$log.debug " #{@name} inside window printstring r #{r} c #{c} #{string} "
+      att = Ncurses::A_NORMAL if att.nil? 
       case att.to_s.downcase
+      when 'normal'
+        att = Ncurses::A_NORMAL
       when 'underline'
         att = Ncurses::A_UNDERLINE
       when 'bold'
@@ -311,17 +342,22 @@ module VER
       width = Ncurses.COLS
       # the next line won't ensure we don't write outside some bounds like table
       #string = string[0..(width-c)] if c + string.length > width
-      #$log.debug "PRINT #{string.length}, #{Ncurses.COLS}, #{c} "
+      #$log.debug "PRINT len:#{string.length}, #{Ncurses.COLS}, #{r}, #{c} w: #{@window} "
       mvprintw(r, c, "%s", string);
       attroff(Ncurses.COLOR_PAIR(color) | att)
     end
     # added by rk 2008-11-29 19:01 
+    # Since these methods write directly to window they are not advised
+    # since clearing previous message we don't know how much to clear.
+    # Best to map error_message to a label.
     def print_error_message text=$error_message
       r = $error_message_row || Ncurses.LINES-1
-      $log.debug "got ERROR MEASSAGE #{text} row #{r} "
+      c = $error_message_col || (Ncurses.COLS-text.length)/2 
+
+      $log.debug "got ERROR MESSAGE #{text} row #{r} "
       clear_error r, $datacolor
-      # print it in centre
-      printstring r, (Ncurses.COLS-text.length)/2, text, color = $promptcolor
+      printstring r, c, text, color = $promptcolor
+      $error_message_clear_pending = true
     end
     # added by rk 2008-11-29 19:01 
     def print_status_message text=$status_message
@@ -330,10 +366,19 @@ module VER
       # print it in centre
       printstring r, (Ncurses.COLS-text.length)/2, text, color = $promptcolor
     end
-    # added by rk 2008-11-29 19:01 
+    # Clear error message printed
+    # I am not only clearing if something was printed. This is since
+    # certain small forms like TabbedForm top form throw an error on printstring.
+    # 
     def clear_error r = $error_message_row, color = $datacolor
-      printstring(r, 0, "%-*s" % [Ncurses.COLS," "], color)
+      return unless $error_message_clear_pending
+      c = $error_message_col || (Ncurses.COLS-text.length)/2 
+      sz = $error_message_size || Ncurses.COLS
+      printstring(r, c, "%-*s" % [sz, " "], color)
+      $error_message_clear_pending = false
     end
+    ##
+    # CAUTION : FOR MESSAGEBOXES ONLY !!!! XXX
     def print_border_mb row, col, height, width, color, attr
       mvwaddch row, col, ACS_ULCORNER
       mvwhline( row, col+1, ACS_HLINE, width-6)
@@ -345,15 +390,35 @@ module VER
       mvwaddch row+height-3, col+width-5, Ncurses::ACS_LRCORNER
       mvwvline( row+1, col+width-5, ACS_VLINE, height-4)
     end
+    ##
+    # prints a border around a widget, CLEARING the area.
+    #  If calling with a pad, you would typically use 0,0, h-1, w-1.
     def print_border row, col, height, width, color, att=Ncurses::A_NORMAL
       att ||= Ncurses::A_NORMAL
 
+      $log.debug " inside window print_border r #{row} c #{col} h #{height} w #{width} "
+
+      # 2009-11-02 00:45 made att nil for blanking out
+      # FIXME - in tabbedpanes this clears one previous line ??? XXX when using a textarea/view
+      # when using a pad this calls pads printstring which again reduces top and left !!! 2010-01-26 23:53 
       (row+1).upto(row+height-1) do |r|
-        printstring( r, col+1," "*(width-2) , color, att)
+        #printstring( r, col+1," "*(width-2) , $datacolor, nil)
+        prv_printstring( r, col+1," "*(width-2) , $datacolor, nil)
       end
-      attron(Ncurses.COLOR_PAIR(color) | att)
+      prv_print_border_only row, col, height, width, color, att
+    end
+    def print_border_only row, col, height, width, color, att=Ncurses::A_NORMAL
+      prv_print_border_only row, col, height, width, color, att
+    end
 
 
+      ## print just the border, no cleanup
+      #+ Earlier, we would clean up. Now in some cases, i'd like
+      #+ to print border over what's been done. 
+    # XXX this reduces 1 from width but not height !!! FIXME 
+    def prv_print_border_only row, col, height, width, color, att=Ncurses::A_NORMAL
+      att ||= Ncurses::A_NORMAL
+      attron(Ncurses.COLOR_PAIR(color) | att)
       mvwaddch row, col, ACS_ULCORNER
       mvwhline( row, col+1, ACS_HLINE, width-2)
       mvwaddch row, col+width-1, Ncurses::ACS_URCORNER
@@ -365,5 +430,390 @@ module VER
       mvwvline( row+1, col+width-1, ACS_VLINE, height-1)
       attroff(Ncurses.COLOR_PAIR(color) | att)
     end
+  # added RK 2009-10-08 23:57 for tabbedpanes
+  # THIS IS EXPERIMENTAL - 
+    # Acco to most sources, derwin and subwin are not thoroughly tested, avoid usage
+    # subwin moving and resizing not functioning.
+    def derwin(layout)
+      $log.debug " #{self} EXP: returning a subwin in derwin"
+      v = VER::SubWindow.new(self, layout)
+      $log.debug " #{self} EXP: returning a subwin in derwin: #{v} "
+      return v
+    end
+    def _subwin(layout)
+      t = @layout[:top]
+      l = @layout[:left]
+      layout[:top] = layout[:top] + t
+      layout[:left] = layout[:left] + l
+      $log.debug " #{self} EXP: returning a subwin in derwin. Adding #{t} and #{l} "
+      v = VER::SubWindow.new(self, layout)
+      $log.debug " #{self} EXP: returning a subwin in derwin: #{v} "
+      return v
+    end
+    def get_window; @window; end
+    def to_s; @name || self; end
+    # use in place of mvwhline if your widget could be using a pad or window
+    def rb_mvwhline row, col, char, width
+      mvwhline row, col, char, width
+    end
+    # use in place of mvwvline if your widget could be using a pad or window
+    def rb_mvwvline row, col, char, width
+      mvwvline row, col, char, width
+    end
+    # use in place of mvaddch if your widget could be using a pad or window
+    def rb_mvaddch row, col, char
+      mvaddch row, col, char
+    end
+  end
+  ##
+  # added RK 2009-10-08 23:57 for tabbedpanes
+  # THIS IS EXPERIMENTAL - 
+  # I have not called super in the initializer so any methods you try on subwin
+  # that exist in the superclass which use @window will bomb
+  # @since 0.1.3
+  class SubWindow  < VER::Window
+    attr_reader :width, :height, :top, :left
+    attr_accessor :layout
+    attr_reader   :panel   # XXX reader requires so he can del it in end
+    attr_reader   :subwin   # 
+    attr_reader   :parent   # 
+
+    def initialize(parent, layout)
+      @visible = true
+      reset_layout(layout)
+
+      @parent = parent
+      #@subwin = @parent.get_window().derwin(@height, @width, @top, @left)
+      @subwin = @parent.get_window().subwin(@height, @width, @top, @left)
+      $log.debug "SUBWIN init #{@height} #{@width} #{@top} #{@left} "
+      #$log.debug "SUBWIN init #{@subwin.getbegx} #{@subwin.getbegy} #{@top} #{@left} "
+      @panel = Ncurses::Panel.new_panel(@subwin)
+
+      @window = @subwin # makes more mthods available
+      init_vars
+
+    end
+    # no need really now 
+    def reset_layout layout
+      @layout = layout # 2010-02-13 22:23 
+      @height = layout[:height]
+      @width = layout[:width]
+      @top = layout[:top]
+      @left = layout[:left]
+    end
+    def _destroy
+      # typically the ensure block should have this
+      # or should window do it for all subwins, or would we want to wait that long ?
+      $log.debug "subwin destroy"
+
+      Ncurses::Panel.del_panel(@panel) if !@panel.nil?   
+      @window.delwin if !@window.nil?
+    end
   end
+  
+  ##
+  # Pad
+  # This is EXPERIMENTAL
+  # A pad cannot be used interchangeable since some application functions such as wrefresh
+  # are illegal. Cannot expect the application to take care.
+  # Internally we can make it easier. Mostly a pad is used to map to one portion of the screen.
+  # So we allow that to be defined once. Then only start row and col of pad change.
+  # Maybe we should check pad coordinates so no errors
+  # Also check screen coordinates (if we know)
+  # We need padheight and padwidth only to ensure we don't keep recreating.
+  # Howevre, when comp's height increases, then decreases, pad height remains larger
+  # but we keep printing an extra row in copywin. so Pad needs to maintain comp height
+  # and padheight.
+  # @since 0.1.3
+  class Pad  < VER::Window
+    # top and left correspond to screen's top and left wich will mostly be fixed
+    attr_accessor :top, :left
+    # start row and col correspond to pad's top and left which will change if scrolling
+    attr_accessor :pminrow, :pmincol
+    # screen's height and width, now it reflects components height and width
+    attr_accessor :sheight, :swidth
+    attr_reader :otherwin
+    # dimensions the pad was created with, used so we don't keep recreating pad, only if increase.
+    attr_reader :padheight, :padwidth
+    #attr_accessor :name  # more for debugging log files. 2010-02-02 19:58 
+    def initialize(height, width)
+      @visible = true
+      # do we set height and width ?? XXX
+      @window = Ncurses.newpad(height, width)
+      @padheight = height
+      @padwidth = width
+      @height = height
+      @width = width
+      @sheight = height
+      @swidth = width
+      init_vars
+    end
+    def init_vars
+      super
+      @top ||= 0; @left ||= 0
+      @pmincol ||= 0 # pad will print from this col
+      @pminrow ||= 0 # pad will print from this row
+      @window_type = :PAD
+      @name ||="#{self}"
+      $log.debug "        PAD constructor #{self} , #{@window} "
+    end
+    #
+    # @param layout is a hash (@see Window.initialize)
+    def self.create_with_layout(layout)
+      @window = Pad.new(layout[:height], layout[:width])
+      @window.reset_layout(layout)
+      return @window
+    end
+    ##
+    # increases the pad size, since the widget may have been resized
+    # checks that one of ht or width has been increased
+    # destroys earlier pad and returns new one
+    # Updates sheight and swidth even if reduced so copywin works fine.
+    # @param [Fixnum] height to resize to
+    # @param [Fixnum] width to resize to
+    # @return [Pad]
+    #  2009-10-29 23:18 
+    def resize(ht = 0, w = 0)
+      # update sheight and swidth even if reduced, so that pad doesn't overwrite.
+      @sheight = ht if ht > 0
+      @swidth = w if w > 0
+      return if ht < @padheight and w < @padwidth
+      @padheight = ht if ht > @padheight
+      @padwidth = w if w > @padwidth
+      destroy
+      $log.debug " L502 resize, creating newpad with #{@padheight} and #{@padwidth} "
+      @window = Ncurses.newpad(@padheight, @padwidth)
+      $log.debug " L502 resize created #{@window} "
+      return @window
+    end
+    ## used if pad and window are same size only
+    # creates a similar sized window
+    # assumes window is backed by this pad
+    # @param object of Window class
+    def self.create_for_window(win)
+      # get coordinates for win
+      @otherwin = win
+      smaxx = win.getmaxx()
+      smaxy = win.getmaxy()
+      top = win.getminx()
+      left = win.getminy()
+      sheight = win.height
+      swidth = win.width
+      # make pad based on size of window
+      window = Pad.create_with_layout(layout = { :height => sheight, :width => swidth, :top => top, :left => sleft })
+      window.sheight = sheight
+      window.swidth = swidth
+      return window
+
+    end
+    # top and left correspond to screen's top and left wich will mostly be fixed.
+    # In cases where the component may float around, as in Splitpanes second component
+    # this would be set using component's row and col.
+    def set_screen_row_col top, left=-1
+      @top = top
+      @left = left unless left < 0
+    end
+    alias :set_screen_pad_left :set_screen_row_col
+
+    ## added user setting screens max row and col (e.g splitpanes first component)
+    def set_screen_max_row_col mr, mc
+        $log.debug "#{@name} set_screen_max_row_col #{mr},#{mc}. earlier #{@screen_maxrow}, #{@screen_maxcol}  "
+      # added || check on 2010-01-09 18:39 since crashing if mr > sh + top ..
+      # I removed the check, since it results in a blank area on screen since the 
+      # widget has not expanded itself. Without the check it will  crash on copywin so you
+      # should increase widget size or disallow  calling this in this situation.
+      if mr > (@sheight + @top -1 -@pminrow)
+        $log.warn " ->>> ** set_screen_max_row_col #{mr} > #{@sheight} + #{@top} -1 - #{@pminrow} ** "
+        $log.warn " ->>> can result in error in copy_win or in some rows not displaying"
+        return # some situations actually require this ...
+      end unless mr.nil?
+      @screen_maxrow = mr unless mr.nil? # || mr > (@sheight + @top -1 -@pminrow)
+      @screen_maxcol = mc unless mc.nil?
+    end
+    # start row and col correspond to pad's top and left which will change if scrolling
+    # However, if we use this as a backing store for subwindows it could remain the same
+    def set_pad_top_left top, left=-1
+      $log.debug "#{@name} inside set_pad_top_left to #{top} #{left} earlier #{@pminrow}, #{@pmincol}"
+      @pminrow = top unless top < 0
+      @pmincol = left unless left < 0
+    end
+    # return screen max row which will be used for writing to window
+    # XXX what if user sets/overrides sheight
+    def smaxrow
+      #$log.debug "    ... niside smaxrow #{@sheight} + #{@top} -1 "
+      #@sheight + @top -1 
+      $log.debug "smr: #{@screen_maxrow}   ... niside smaxrow #{@sheight} + #{@top} -1 - #{@pminrow}"
+      @screen_maxrow || @sheight + @top -1 -@pminrow
+    end
+    ##
+    # return screen max col which will be used for writing to window
+    def smaxcol
+      #$log.debug "    ... niside smaxcol #{@swidth} + #{@left} -1 "
+      #@swidth + @left -1
+#      $log.debug "    ... niside smaxcol #{@swidth} + #{@left} -1 - #{@pmincol} "
+      @screen_maxcol || @swidth + @left -1 - @pmincol
+    end
+    ##
+    # specify the window or subwin that the pad is writing to
+    # 2010-02-20 22:45 - actually since there are pad methods smaxrow used on otherwin
+    # therefor it can only be a Pad !! NOTE
+    def set_backing_window win
+      @otherwin = win
+      # XX should we  extract the coordinates and use for printing ??
+      # or for setting maxrow and maxcol
+    end
+    # trying to make things as easy as possible
+    # returns -1 if error in prefresh
+    def wrefresh
+      $log.debug " inside pad's wrefresh #{@window}. minr,minc,top,left,smaxr,c: #{@pminrow}, #{@pmincol}, #{@top} #{@left} #{smaxrow()} #{smaxcol()} self: #{self.name} "
+
+      # caution, prefresh uses maxrow and maxcol not height and width
+      # so we have to add top and less one since we are zero based
+      ret = @window.prefresh(@pminrow, @pmincol, @top, @left, smaxrow(), smaxcol())
+      $log.warn " WREFRESH returns -1 ERROR - width or height must be exceeding " if ret == -1
+      @modified = false
+      return ret
+    end
+    ##
+    # copy the window to the pad (assumes we are writing onto win and keeping
+    # pad as backup
+    # also assuming only one win so, window not passed as param
+    # @return return value of copywin which should be 0 (-1 is ERR)
+    def copy_pad_to_win
+      # check that we don't exceed other windows height/maxrow
+      smr = smaxrow()
+      # SHIT, this means the otherwin has to be a Pad, cannot be a window
+      osw = @otherwin.width
+      osh = @otherwin.height
+      osh = @height if osh == 0 # root window has 0
+      osw = @width if osw == 0 # root window has 0
+      osmr = @otherwin.smaxrow() rescue osh # TRYING for windows
+      osmc = @otherwin.smaxcol() rescue osw
+      if smr >= osmr
+         $log.debug " adjusted smr from #{smr} to #{osmr} -1 causing issues in viewfooter"
+        smr = osmr-1 # XXX causing issues in viewport, wont print footer with this
+      end
+      if smr > @sheight + @top -1 -@pminrow # 2010-01-17 13:27 
+         smr = @sheight + @top -1 -@pminrow 
+         $log.debug " adjusted smr to #{smr} to prevent crash "
+      end
+      smc = smaxcol()
+      $log.debug " SMC original = #{smc} "
+      if smc >= osmc
+        smc = osmc-1
+        smc = @width # XXX ??? THIS WAS WORKING< but throwing error in viewport case
+        smc = [osmc-1, @width].min # yet another hack
+        $log.debug " SMC o-1 #{osmc-1} wdth #{@width}, smc #{smc}  "
+      end
+      ### XXX commented out since it doesn't let a comp print fully if widget expanded (splitpane)
+      #smc = osw -1 if smc >= osw; # added 2009-11-02 17:01 for tabbedpanes
+
+      # dang, this is coming up a lot. 2010-01-16 20:34 
+      # the second scrollpane was one row too large in testsplit3a.rb
+      if smr - @top > @padheight
+         $log.debug " fixing smr to padheight  2010-01-16 20:35 HOPE THIS DOESNT BREAK ANYTHING"
+         smr = @padheight
+      end
+      @pminrow = 0 if @pminrow < 0
+      @pmincol = 0 if @pmincol < 0
+      $log.debug " COPYING #{self.name} to #{@otherwin.name} "
+      $log.debug " calling copy pad #{@pminrow} #{@pmincol}, #{@top} #{@left}, #{smr} #{smc} self #{self.name} "
+      $log.debug "  calling copy pad H: #{@height} W: #{@width}, PH #{@padheight} PW #{@padwidth} WIN:#{@window} "
+#      $log.debug "  -otherwin target copy pad #{@otherwin.pminrow} #{@otherwin.pmincol}, #{@otherwin.top} #{@otherwin.left}, #{osmr} #{osmc} OTHERWIN:#{@otherwin.name} "
+      ret="-"
+      #if ret == -1
+#x XXX        $log.debug "  #{ret} otherwin copy pad #{@otherwin.pminrow} #{@otherwin.pmincol}, #{@otherwin.top} #{@otherwin.left}, #{osmr} #{osmc} "
+        $log.debug "  #{ret} otherwin copy pad H: #{osh} W: #{osw}"
+        if @top >= osh
+          $log.debug "  #{ret} ERROR top exceeds other ht #{@top}   H: #{osh} "
+        end
+        if @left >= osw
+          $log.debug "  #{ret} ERROR left exceeds other wt #{@left}   W: #{osw} "
+        end
+        if smr >= osh
+          $log.debug "  #{ret} ERROR smrow exceeds other ht #{smr}   H: #{osh} "
+          smr = osh() -1 # testing 2010-01-31 21:47  , again 2010-02-05 20:22 
+        end
+        if smc >= osw
+          $log.debug "  #{ret} ERROR smcol exceeds other wt #{smc}   W: #{osw} "
+        end
+        if smc - @left > @padwidth
+          $log.debug "  #{ret} ERROR smcol - left  exceeds padwidth   #{smc}- #{@left}   PW: #{@padwidth} "
+        end
+        if smr - @top > @padheight
+          $log.debug "  #{ret} ERROR smr  - top  exceeds padheight   #{smr}- #{@top}   PH: #{@padheight} "
+        end
+      ret = @window.copywin(@otherwin.get_window,@pminrow,@pmincol, @top, @left, smr, smc, 0)
+      $log.debug " copywin ret #{ret} "
+        # 2010-01-11 19:42 one more cause of -1 coming is that padheight (actual height which never
+        # changes unless pad increases) or padwidth is smaller than area being printed. Solution: increase 
+        # buffer by increasing widgets w or h. smc - left should not exceed padwidth. smr-top should not
+        # exceed padheight
+      #end
+      @modified = false
+      return ret
+    end
+    def copy_win_to_pad
+      smr = smaxrow()
+      if smr >= @window.smaxrow()
+        smr = @window.smaxrow()-1
+      end
+      $log.debug " copy_win_to_pad #{@otherwin.name}, #{@window.name}, pminr:#{@pminrow} pminc:#{@pmincol} top:#{@top} left:#{@left} smr:#{smr} "
+      ret = @otherwin.copywin(@window.get_window,@pminrow,@pmincol, @top, @left, smr, smaxcol(), 1)
+      @modified = false
+      return ret
+    end
+    ## 
+    #Used to overwrite the pad onto the screen window
+    # A window should have been specified as window to back (@see set_backing_window) or (@see create_with_window)
+    def overwrite_window
+      return @window.overwrite(@otherwin.get_window)
+    end
+
+    ## 
+    #  convenience method so that pad can use printstring but remove screen's row and col
+    #  The absolute row and col will be taken into consideration when printing on screen.
+    #  
+    # @param [Fixnum] row row to print on
+    # @param [Fixnum] col column to print on
+    # @param [String] value to print
+    # @param [Fixnum] color - color combination
+    # @param [Fixnum, nil] attrib defaults to NORMAL
+
+    # Pls remove the raise once the program is working, extra line can slow things down
+    # Keep it on when testing.
+    # If the raise is thrown, it means your object could be positioned higher than it should be,
+    # or at some point you have increased top, without increasing the objects row.
+    def printstring(row,col,value,color,attrib=Ncurses::A_NORMAL)
+      #$log.debug " pad printstring #{row} - #{@top} , #{col} - #{@left} "
+      raise "printstring row < top, pls correct code #{row} #{@top}, #{col} #{@left} " if row < @top or col < @left
+      #$log.warn "printstring row < top, pls correct code #{row} #{@top} " if row < @top
+      super(row - @top, col - @left, value, color, attrib)
+    end # printstring
+    #  convenience method so that pad can use print_border but remove screen's row and col
+    #  Please note that this requires that buffer have latest top and left.
+    def print_border row, col, height, width, color, att=Ncurses::A_NORMAL
+      $log.debug " pad printborder #{row} - #{@top} , #{col} - #{@left}, #{height} , #{width}  "
+      raise "print_border: row < top, pls correct code #{row} #{@top},  #{col} #{@left} " if row < @top or col < @left
+      #$log.warn   "print_border: row < top, pls correct code #{row} #{@top} " if row < @top
+      super(row - @top, col - @left, height, width,  color, att)
+    end
+    def print_border_only row, col, height, width, color, att=Ncurses::A_NORMAL
+      $log.debug " pad printborder_only #{row} - #{@top} , #{col} - #{@left}, #{height} , #{width}  "
+      raise "print_border row < top, pls correct code #{row} #{@top},  #{col} #{@left} " if row < @top or col < @left
+      super(row - @top, col - @left, height, width,  color, att)
+    end
+    # use in place of mvwhline if your widget could be using a pad or window
+    def rb_mvwhline row, col, char, width
+      super(row-@top, col-@left, char, width)
+    end
+    # use in place of mvwvline if your widget could be using a pad or window
+    def rb_mvwvline row, col, char, width
+      super(row-@top, col-@left, char, width)
+    end
+    # use in place of mvaddch if your widget could be using a pad or window
+    def rb_mvaddch row, col, char
+      super(row-@top, col-@left, char)
+    end
+  end # class Pad
 end