rbcurse 1.5.2 → 1.5.3

data/lib/rbcurse/deprecated/rviewport.rb

@@ -1,204 +0,0 @@
-=begin
-  * Name: Viewport
-  * $Id$
-  * Description: a viewport thru which you see an underlying form or widget. Scrolling
-    the viewport reveals new sections of the underlying object.
-  * Author: rkumar arunachala
-TODO 
-  * file created  2009-10-27 18:05 
-Major change 2010-02-11 23:32 
-  * removed buffering, was totally unnecessary
-  * FIXME avoid repaint and handle_keys totally, let scrollpane talk to child.
-    Do we really need this ?
-    If we do strip it down to its major function - nothign extraneous. Currently its a huge layer in between.
-  --------
-  * License:
-    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
-
-=end
-#require 'rubygems'
-#require 'ncurses'
-require 'logger'
-require 'rbcurse'
-require 'rbcurse/core/include/rchangeevent'
-
-#include Ncurses # FFI 2011-09-8 
-include RubyCurses
-module RubyCurses
-  extend self
-
-  ##
-  # A viewport or porthole throgh which one can see portions of underlying object
-  # such as textarea, table or a form, usually the underlying data is larger
-  # than what can be displayed and thus must be seen through a viewport.
-  # TODO - 
-  
-  class Viewport < Widget
-    # row and col also present int widget
-    dsl_accessor :child  # component that is being viewed
-    attr_accessor :cascade_changes
-    #attr_reader :top_margin, :left_margin
-
-    def initialize form, config={}, &block
-      @focusable = false
-      @editable = false
-      #@top_margin = @left_margin = 1 # 2010-02-06 23:27  reduce in scrollpane
-      @row = 1 # 1 # 0 2010-02-06 22:46 so we don't write on scrollpanes border
-      @col = 1 # 1 #  0 2010-02-06 22:47 
-      super
-      #@row_offset = @col_offset = 1
-      #@orig_col = @col
-      init_vars
-      @_events.push :STATE_CHANGE
-    end
-    def init_vars
-      #@curpos = @pcol = @toprow = @current_index = 0
-      should_create_buffer = true
-      @border_width = 2
-    end
-    # set the component to be viewed
-    def set_view ch
-      @child = ch
-    end
-    def set_view_size h,w
-      # calling the property shoudl uniformally trigger fire_property_change
-      $log.debug " setting viewport to h #{h} , w #{w} "
-      height(h)
-      width(w)
-      fire_state_changed
-      #fire_handler :PROPERTY_CHANGE, self # XXX should it be an event STATE_CHANGE with details
-    end
-    ##
-    # Set the row and col of the child, that the viewport starts displaying.
-    # Used to initialize the view, and later if scrolling.
-    # Initially would be set to 0,0. 
-    #
-    def set_view_position r,c
-      return false if r < 0 or c < 0
-      # 2010-02-04 19:29 TRYING -2 for borders
-      $log.debug " set_view if #{r} +1+ #{@height} - #{@border_width} )} >=#{@child.height} "
-      # 2010-02-12 15:33 XXX made > into >= and added +1 since -1 in set_buffering
-      # testscrollp was crashing out when child height exceeded
-      if r+ (@height+1-@border_width) >= @child.height
-      # basically r + (:bottom - :screen_top) < @child.height
-      #if r+ (@height) >= @child.height
-        $log.debug " set_view_position : trying to exceed ht #{r} + #{@height} > #{@child.height}  returned false"
-        return false
-      end
-      # testscrollp was printing junk on right end. Why the 1? 
-      if c+ (@width+1-@border_width) >=@child.width
-      #if c+ (@width) >=@child.width
-        $log.debug " set_view_position : trying to exceed width #{c} + #{@width} . returned false"
-        return false
-      end
-      $log.debug " VP row #{@row} col #{@col}, now will be #{r} , #{c} "
-      row(r) # commnting off 2010-02-06 22:47 
-      col(c) # commnting off 2010-02-06 22:47 
-      # next call sets pminrow and pmincol 
-      $log.debug " VP setting child buffer pmin to #{r} #{c} "
-      @child.get_buffer().set_pad_top_left(r, c)
-      # replaced this on 2010-02-26 11:49 HOPE IT WORKS XXX
-      #@child.fire_property_change("row", r, r) # XXX quick dirty, this should happen
-      @child.repaint_required(true)
-      @repaint_required = true
-      #fire_handler :PROPERTY_CHANGE, self
-      fire_state_changed
-      return true
-    end
-    # instead of using row and col to increment, try using this, since this is what's actually incremented.
-    def get_pad_top_left
-        p = @child.get_buffer()
-        return p.pminrow, p.pmincol
-    end
-    def repaint # viewport
-      return unless @repaint_required
-      # should call child's repaint onto pad
-      # then this should return clipped pad
-       $log.debug "VP calling child #{@child.name}  repaint"
-     #x  @graphic.wclear # required otherwise bottom of scrollpane had old rows still repeated. 2010-01-17 22:51 
-      @child.repaint_all
-      @child.repaint
-      paint
-    end
-    def getvalue
-      # TODO ???
-    end
-    ## most likely should just return an unhandled and not try being intelligent
-    # should viewport handle keys or should parent do so directly to child
-    def handle_key ch
-      # if this gets key it should just hand it to child
-      if @child != nil
-        ret = @child.handle_key ch
-        # 2010-01-19 19:26 commenting off repaint to see.
-        return :UNHANDLED if ret == :UNHANDLED
-        # moved below return so only if table handles
-        @repaint_required=true # added 2009-12-27 22:25 BUFFERED WHY ??
-      else
-        return :UNHANDLED
-      end
-      return 0
-      #$log.debug "TV after loop : curpos #{@curpos} blen: #{@buffer.length}"
-    end
-    def paint
-      @repaint_required = false
-      @repaint_all = false
-    end
-    # set height
-    # a container must pass down changes in size to it's children
-    #+ 2010-02-04 18:06 - i am not sure about this. When viewport is set then it passes down 
-    #+ changes to child which user did not intend. Maybe in splitpane it is okay but other cases?
-    #+ Perhaps its okay if scrollpane gets larger than child, not otherwise.
-    # added 2010-01-16 23:55 
-      def height(*val)
-          return @height if val.empty?
-          oldvalue = @height || 0
-          super
-          @height = val[0]
-          return if @child == nil
-          delta = @height - oldvalue
-          return if delta == 0
-          @repaint_required = true
-          if @child.height.nil?
-             @child.height = @height
-             $log.warn " viewport setting child #{@child.name} to default h of #{@height} -- child is usually larger. "
-          else
-              if @cascade_changes
-                  $log.debug "warn!! viewport adding #{delta} to child ht #{child.height} "
-                  @child.height += delta
-              end
-          end
-      end
-    # set width
-    # a container must pass down changes in size to it's children
-    # added 2010-01-16 23:55 
-      def width(*val)
-          return @width if val.empty?
-          oldvalue = @width || 0
-          super
-          @width = val[0]
-          return if @child == nil
-          delta = @width - oldvalue
-          return if delta == 0
-          @repaint_required = true
-          # another safeguard if user did not enter. usesomething sensible 2010-01-17 15:23 
-          if @child.width.nil?
-             @child.width = @width
-             $log.warn " viewport setting child #{@child.name} to default w of #{@width}. Usually child is larger. "
-          else
-              ## sometime we are needless increasing. this happens when we set viewport and
-              ##+ child has been set. Or may do only if scrollpane is getting larger than child
-              ##+ largely a situation with splitpanes.
-              if @cascade_changes
-                  $log.debug "warn!! viewport adding #{delta} to child wt #{child.width} "
-                  @child.width += delta
-              end
-          end
-      end
-      # should this be in widget ?
-      # inform listeners that state has changed
-      def fire_state_changed
-        @sce = ChangeEvent.new(self) if @sce.nil?
-        fire_handler :STATE_CHANGE, @sce
-      end
-  end # class viewport
-end # module

data/lib/rbcurse/deprecated/widgets/mapper.rb

@@ -1,130 +0,0 @@
-## this class allows us to do multiple key mappings such as emacs
-# See the example keytest.rb
-# However, integrating this into our library seems a little difficult now
-# since each widget handles keys and often there are heirachies of widgets.
-# However, this being a terminal app, mouseless, we really need to make it key-friendly.
-require 'rbcurse/core/include/orderedhash'
-class Mapper
-  attr_reader :keymap
-  attr_reader :view
-  attr_accessor :mode
-  attr_reader :keys
-  def initialize handler
-    #@handler = handler
-    @view = handler       # caller program
-    @keys = {}
-    @mode = nil  # used when defining
-    @pendingkeys = nil
-    @prevkey = nil   # in case of a key sequence such as C-x C-c, will have C-x
-    @arg = nil # regex matched this key.
-  end
-  def let mode, &block
-    h = OrderedHash.new
-    @keys[mode] = h
-    @mode = mode
-    instance_eval(&block)
-    $log.debug("KEYS: #{@keys[mode].inspect}")
-  end
-
-  ## mapping keys to blocks or symbols
-  # 2010-02-23 19:17 added check for string, so no required to use getbyte everywhere, esp for existing app
-  # However, this means that we can't map an actual string, which we may want to for commands
-  # which cuold be passed outside keys, or as aliases.
-  def map(*args, &block)
-    if block_given?
-
-      # We check for cases like C-x C-c etc. Only 2 levels.
-      #args = arg.split(/ +/)
-      arg0 = args[0]
-      arg0 = args[0].getbyte(0) if args[0].class.to_s == 'String'
-      if args.length == 2
-        arg1 = args[1]
-        arg1 = args[1].getbyte(0) if args[1].class.to_s == 'String'
-        $log.debug "  KEY2 #{args[0]} , #{args[0].class},  #{args[1]} , #{args[1].class} "
-        @keys[@mode][arg0] ||= OrderedHash.new
-        @keys[@mode][arg0][arg1]=block
-      else
-        # single key or control key
-        $log.debug "  KEY #{args[0]} , #{args[0].class} "
-        @keys[@mode][arg0]=block
-      end
-    else
-       #no block, last arg shold be a symbol
-       symb = args.pop
-       raise "If block not passed, last arg should be a method symbol" if !symb.is_a? Symbol
-       arg0 = args[0]
-       arg0 = args[0].getbyte(0) if args[0].class.to_s == 'String'
-       if args.length == 2
-         arg1 = args[1]
-         arg1 = args[1].getbyte(0) if args[1].class.to_s == 'String'
-         @keys[@mode][arg0] ||= OrderedHash.new
-         @keys[@mode][arg0][arg1]=symb
-       else
-         # single key or control key
-         @keys[@mode][arg0]=symb
-       end
-    end
-  end
-
-  ## manages key pressing
-  # takes care of multiple key combos too
-  def press key
-    #$log.debug("press Got: #{key}")
-    # for a double key combination such as C-x C-c this has the set of pending keys to check against
-    if @pendingkeys != nil
-      blk = @pendingkeys[key]
-    else
-      # this is the regular single key mode
-      #blk = @keys[@view.mode][key]
-      blk = match(key)
-    end
-    # this means this key expects more keys to follow such as C-x could
-    if blk.is_a? OrderedHash
-      @pendingkeys = blk
-      @prevkey = key
-      return
-    end
-    if blk.nil? # this should go up XXX
-      if !@pendingkeys.nil?
-        # this error message to be modified if using numeric keys -- need to convert to char
-        view.info("%p not valid in %p. Try: #{@pendingkeys.keys.join(', ')}" % [key, @prevkey]) # XXX
-      else
-        view.info("%p not valid in %p. " % [key, @view.mode]) 
-      end
-      return
-    end
-    # call the block or symbol - our user defined key mappings use symbols
-    if blk.is_a? Symbol
-      @view.send(blk)
-    else
-      blk.call
-    end
-    @prevkey = nil
-    @pendingkeys = nil
-  end
-  def match key
-       #$log.debug "MATCH #{key} "
-      #blk = @keys[@view.mode][key]
-    @keys[@view.mode].each_pair do |k,v|
-     #$log.debug "LOOP #{k.class}, #{k}, #{v} "
-      case k.class.to_s
-      when "String"
-        return v if k == key
-      when "Fixnum" # for keyboard2
-     #$log.debug "FIXNUM LOOP #{k.class}, #{k}, #{v} "
-        return v if k == key
-      when "Regexp"
-#       $log.debug "REGEX #key , #k, #{k.match(key)}"
-        key1 = key.chr if key.is_a? Fixnum
-        if !k.match(key1).nil?
-          @arg = key1
-          return v 
-        end
-      else
-        $log.error "MATCH: Unhandled class #{k.class} "
-      end
-    end
-       $log.debug "MATCH #{key} ret nil "
-    return nil
-  end
-end

data/lib/rbcurse/deprecated/widgets/rmessagebox.rb

@@ -1,348 +0,0 @@
-=begin
-  * Name: rmessagebox: creates messageboxes
-  * Description   
-  * Author: rkumar (arunachalesha)
-  * Date: 2008-11-19 12:49 
-  * License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
-  * file separated on 2009-01-13 22:39 
-
-=end
-require 'rbcurse/core/widgets/rwidget'
-require 'rbcurse/extras/widgets/rlistbox'
-
-module RubyCurses
-  ##
-  # dimensions of window should be derived on content
-  #
-  class MessageBox
-    include RubyCurses::Utils
-    dsl_accessor :title
-    dsl_accessor :message
-    dsl_accessor :type               # :ok, :ok_cancel :yes_no :yes_no_cancel :custom
-    dsl_accessor :default_button     # TODO - currently first
-    dsl_accessor :layout
-    dsl_accessor :buttons           # used if type :custom
-    dsl_accessor :underlines           # offsets of each button to underline
-    attr_reader :config
-    attr_reader :selected_index     # button index selected by user
-    attr_reader :window     # required for keyboard
-    dsl_accessor :list_selection_mode  # true or false allow multiple selection
-    dsl_accessor :list  # 2009-01-05 23:59 
-    dsl_accessor :button_type      # ok, ok_cancel, yes_no
-    dsl_accessor :default_value     # 
-    dsl_accessor :default_values     # #  2009-01-06 00:05 after removing meth missing 
-    dsl_accessor :height, :width, :top, :left  #  2009-01-06 00:05 after removing meth missing
-
-    dsl_accessor :message_height
-
-
-    def initialize form=nil, aconfig={}, &block
-      @form = form
-      @config = aconfig
-      @buttons = []
-      #@keys = {}
-      @bcol = 5
-      @selected_index = -1
-      @config.each_pair { |k,v| instance_variable_set("@#{k}",v) }
-      instance_eval &block if block_given?
-      if @layout.nil? 
-        case @type.to_s
-        when "input"
-          layout(10,60, 10, 20) 
-        when "list"
-          height = [5, @list.length].min 
-          layout(10+height, 60, 5, 20)
-        when "field_list"
-          height = @field_list.length
-          layout(10+height, 60, 5, 20)
-        when "override"
-          $log.debug " override: #{@height},#{@width}, #{@top}, #{@left} "
-          layout(@height,@width, @top, @left) 
-          $log.debug " override: #{@layout.inspect}"
-        else
-          height = @form && @form.widgets.length ## quick fix. FIXME
-          height ||= 0
-          layout(10+height,60, 10, 20) 
-        end
-      end
-      @window = VER::Window.new(@layout)
-      if @form.nil?
-        @form = RubyCurses::Form.new @window
-      else
-        @form.window = @window
-      end
-      acolor = get_color $reversecolor # this implicitly uses color and bgcolor fooling me often
-      $log.debug " MESSAGE BOX #{@bgcolor} , #{@color} , #{acolor}"
-      @window.bkgd(Ncurses.COLOR_PAIR(acolor));
-      @window.wrefresh
-      @panel = @window.panel
-      Ncurses::Panel.update_panels
-      process_field_list
-      print_borders
-      print_title
-      print_message unless @message.nil?
-      print_input
-      create_buttons
-      @form.repaint
-      @window.wrefresh
-      handle_keys
-    end
-    ##
-    # takes care of a field list sent in
-    def process_field_list
-      return if @field_list.nil? or @field_list.length == 0
-      @field_list.each do |f|
-        f.set_form @form
-      end
-    end
-    def default_button offset0
-      @selected_index = offset0
-    end
-    ##
-    # value entered by user if type = input
-    def input_value
-      return @input.buffer if !@input.nil?
-      return @listbox.getvalue if !@listbox.nil?
-    end
-    def create_buttons
-      case @button_type.to_s.downcase
-      when "ok"
-        make_buttons ["&OK"]
-      when "ok_cancel" #, "input", "list", "field_list"
-        make_buttons %w[&OK &Cancel]
-        # experience 2009-02-22 12:52 trapping y and n - hopefully wont cause an edit problem
-        @form.bind_key(?o){ press(?\M-o) }   # called method takes care of getbyte 1.9
-        @form.bind_key(?c){ press(?\M-c) }   # called method takes care of getbyte 1.9
-      when "yes_no"
-        make_buttons %w[&Yes &No]
-        # experience 2009-02-22 12:52 trapping y and n - hopefully wont cause an edit problem
-        @form.bind_key(?y){ press(?\M-y) }   # called method takes care of getbyte 1.9
-        @form.bind_key(?n){ press(?\M-n) }   # called method takes care of getbyte 1.9
-      when "yes_no_cancel"
-        make_buttons ["&Yes", "&No", "&Cancel"]
-      when "custom"
-        raise "Blank list of buttons passed to custom" if @buttons.nil? or @buttons.size == 0
-        make_buttons @buttons
-      else
-        $log.debug "No type passed for creating messagebox. Using default (OK)"
-        make_buttons ["&OK"]
-      end
-    end
-    def make_buttons names
-      total = names.inject(0) {|total, item| total + item.length + 4}
-      bcol = center_column total
-
-      brow = @layout[:height]-3
-      button_ct=0
-      names.each_with_index do |bname, ix|
-        text = bname
-        #underline = @underlines[ix] if !@underlines.nil?
-
-        button = Button.new @form do
-          text text
-          name bname
-          row brow
-          col bcol
-          #underline underline
-          highlight_background $datacolor 
-          color $reversecolor
-          bgcolor $reversecolor
-        end
-        index = button_ct
-        button.command { |form| @selected_index = index; @stop = true; $log.debug "Pressed Button #{bname}";}
-        button_ct += 1
-        bcol += text.length+6
-      end
-    end
-    ## message box
-    def stopping?
-      @stop
-    end
-    def handle_keys
-      begin
-        while((ch = @window.getchar()) != 999 )
-          case ch
-          when -1
-            next
-          else
-            press ch
-            break if @stop
-          end
-        end
-      ensure
-        destroy  
-      end
-      return @selected_index
-    end
-    def press ch
-      ch = ch.getbyte(0) if ch.class==String ## 1.9
-        case ch
-        when -1
-          return
-        when KEY_F1, 27, ?\C-q.getbyte(0)   
-          @selected_index = -1
-          @stop = true
-          return
-        when KEY_ENTER, 10, 13
-          field =  @form.get_current_field
-          if field.respond_to? :fire
-            field.fire
-          end
-          #$log.debug "popup ENTER : #{@selected_index} "
-          #$log.debug "popup ENTER :  #{field.name}" if !field.nil?
-          @stop = true
-          return
-        when KEY_TAB
-          @form.select_next_field
-        when KEY_BTAB
-          @form.select_prev_field
-        else
-          # fields must return unhandled else we will miss hotkeys. 
-          # On messageboxes, often if no edit field, then O and C are hot.
-          field =  @form.get_current_field
-          handled = field.handle_key ch
-
-          if handled == :UNHANDLED
-            ret = @form.process_key ch, self ## trying out trigger button
-          end
-        end
-        @form.repaint
-        Ncurses::Panel.update_panels();
-        Ncurses.doupdate();
-        @window.wrefresh
-    end
-    def print_borders
-      width = @layout[:width]
-      height = @layout[:height]
-      @window.print_border_mb 1,2, height, width, $normalcolor, FFI::NCurses::A_REVERSE
-=begin
-      start = 2
-      hline = "+%s+" % [ "-"*(width-((start+1)*2)) ]
-      hline2 = "|%s|" % [ " "*(width-((start+1)*2)) ]
-      @window.printstring(row=1, col=start, hline, color=$reversecolor)
-      (start).upto(height-2) do |row|
-        @window.printstring row, col=start, hline2, color=$normalcolor, A_REVERSE
-      end
-      @window.printstring(height-2, col=start, hline, color=$reversecolor)
-=end
-    end
-    def print_title title=@title
-      width = @layout[:width]
-      title = " "+title+" "
-      @window.printstring(row=1,col=(width-title.length)/2,title, color=$normalcolor)
-    end
-    def center_column textlen
-      width = @layout[:width]
-      return (width-textlen)/2
-    end
-    def print_message message=@message, row=nil
-      @message_row = @message_col = 2
-      display_length = @layout[:width]-8
-        $log.debug " print_message: dl:#{display_length} "
-      # XXX this needs to go up and decide height of window
-      if @message_height.nil?
-        @message_height = (message.length/display_length)+2
-        #$log.debug " print_message: mh:#{@message_height}, ml: #{message.length}"
-      end
-      @message_height ||= 1
-      width = @layout[:width]
-      return if message.nil?
-      case @type.to_s
-      when "input" 
-        row=(@layout[:height]/3) if row.nil?
-        @message_col = 4
-      when "list" 
-        row=3
-        @message_col = 4 
-      else
-        row=(@layout[:height]/3) if row.nil?
-        @message_col = (width-message.length)/2
-        @message_col = 4 if @message.is_a? Array
-        @message_col = 4 if @message_col < 4 # this was often disappearing 2010-10-17 13:00 
-        #$log.debug "XX ALERT col #{@message_col} w: #{width} len: #{message.length} "
-      end
-      @message_row = row
-      # added 2009-11-05 14:53 to fix erasure of border
-      display_length -= @message_col
-      # 2008-12-30 19:45 experimenting with label so we can get justify and wrapping.
-      # 2011-09-20 trying to take care of when user changes color and bgcolor while calling.
-      clr = @color || :black
-      bgclr = @bgcolor || :white
-      message_label = RubyCurses::Label.new @form, {'text' => message, "name"=>"message_label","row" => row, "col" => @message_col, "display_length" => display_length,  "height" => @message_height, 'bgcolor' => bgclr , 'color' => clr}
-
-    end
-    def print_input
-      #return if @type.to_s != "input"
-      @message_height ||= 0
-      @message_row ||= 2
-      @message_col ||= 2
-      r = @message_row + @message_height + 1
-      c = @message_col
-      disp_len = @layout[:width]-8
-      defaultvalue = @default_value || ""
-      input_config = @config["input_config"] || {} # see test1.rb for usage example
-      case @type.to_s 
-      when "input"
-        @input = RubyCurses::Field.new @form, input_config do
-          name   "input" 
-          row  r 
-          col  c 
-          display_length disp_len
-          set_buffer defaultvalue
-        end
-      when "list"
-        list = @list
-        selection_mode = @list_selection_mode 
-        default_values = @default_values
-        $log.debug " value of select_mode #{selection_mode}"
-        @listbox = RubyCurses::Listbox.new @form do
-          name   "input" 
-          row  r 
-          col  c 
-
-          color 'black'
-          bgcolor 'white'
-          # now listcellrenderer only uses BOLD for selected, with a white bgcolor
-          # so here it won't show up on white bg
-          selected_color 'red'
-          selected_bgcolor 'black'
-          # just added 2010-10-14 21:24 
-          border_attrib :reverse
-          width 30
-          height 6
-          list  list
-          # ?? display_length  30
-          #set_buffer defaultvalue
-          selection_mode selection_mode
-          default_values default_values
-          is_popup false
-        end
-      end
-    end
-    def configure(*val , &block)
-      case val.size
-      when 1
-        return @config[val[0]]
-      when 2
-        @config[val[0]] = val[1]
-        instance_variable_set("@#{val[0]}", val[1]) 
-      end
-      instance_eval &block if block_given?
-    end
-    def cget param
-      @config[param]
-    end
-
-    def layout(height=0, width=0, top=0, left=0)
-      @layout = { :height => height, :width => width, :top => top, :left => left } 
-    end
-    def destroy
-      $log.debug "DESTROY : messagebox"
-      panel = @window.panel
-      #Ncurses::Panel.del_panel(panel) if !panel.nil?   
-      panel.del_panel if !panel.nil?
-      @window.delwin if !@window.nil?
-      Ncurses::Panel.update_panels # 2011-10-1 so window below doesn't have a black rectangle
-    end
-  end
-end