rbcurse 1.4.1 → 1.5.0.pre1

data/lib/rbcurse/rprogress.rb

@@ -1,118 +0,0 @@
-#require 'ncurses'
-require 'logger'
-require 'rbcurse'
-
-#include Ncurses # FFI 2011-09-8 
-include RubyCurses
-module RubyCurses
-  extend self
-  ##
-  # TODO user may want to print a label on progress: like not started or complete.
-  class Progress < Widget
-    dsl_property :width     #  please give this to ensure the we only print this much
-    dsl_property :fraction  #  how much to cover
-    dsl_property :char      #  what char to use for filling, default space
-    dsl_property :text      #  text to put over bar
-    dsl_accessor :style     # :old or nil/anything else
-    dsl_accessor :surround_chars     # "[]"
-
-    def initialize form, config={}, &block
-
-      @row = config.fetch("row",-1) 
-      @col = config.fetch("col",-1) 
-      @bgcolor = config.fetch("bgcolor", $def_bg_color)
-      @color = config.fetch("color", $def_fg_color)
-      @name = config.fetch("name", "pbar")
-      @editable = false
-      @focusable = false
-      super
-      @surround_chars ||= "[]" # for :old style
-      @repaint_required = true
-    end
-    def getvalue
-      @fraction || 0.0
-    end
-
-    ##
-    # 
-    def repaint
-      return unless @repaint_required
-      $log.debug " XXXX PBAR inside repaint #{@color} , #{@fraction} "
-      r,c = rowcol
-      #value = getvalue_for_paint
-      acolor = get_color @bgcolor
-      bcolor = get_color @color
-      @graphic = @form.window if @graphic.nil? ## HACK messagebox givig this in repaint, 423 not working ??
-      len = 0
-      w2 = @width - 6 #2 account for brackets and printing of percentage
-      if @fraction
-        @fraction = 1.0 if @fraction > 1.0
-        @fraction = 0 if @fraction < 0
-        if @fraction > 0
-          len = @fraction * @width
-        end
-      end
-      if @style == :old
-        ftext=""
-        char = @char || "="
-        if @fraction && @fraction >= 0
-          len = @fraction * (w2) 
-          ftext << sprintf("%3d%s",(@fraction * 100).to_i, "%")
-        end
-        incomplete = w2 - len
-        complete = len
-        # I am printing 2 times since sometimes the ending bracket gets printed one position less
-        str = @surround_chars[0] + " "*w2 + @surround_chars[1] + ftext
-        @graphic.printstring r, c, str , acolor,@attr
-        str = char*complete 
-        str[-1] = ">" if char == "=" && complete > 2
-        @graphic.printstring r, c+1, str , acolor,@attr
-      else
-
-        char = @char || " "
-        # first print the background horizonal bar
-        @graphic.printstring r, c, " " * @width , acolor,@attr
-
-        # if the user has passed a percentage we need to print that in @color
-        if @fraction
-          #bcolor = get_color @color
-          #@fraction = 1.0 if @fraction > 1.0
-          #@fraction = 0 if @fraction < 0
-          #if @fraction > 0
-          #len = @fraction * @width
-          #char = @char || " "
-
-          # if text is to printed over the bar
-          if @text
-            textcolor = get_color $datacolor, 'black'
-            txt = @text
-            txt = @text[0..@width] if @text.length > @width
-            textattr = 'bold'
-            # write the text in a color that contrasts with the background
-            # typically black
-            @graphic.printstring r, c, txt , textcolor, textattr if @text
-
-            # now write the text again, in a color that contrasts with the progress
-            # bar color that is expanding. However, the text must be padded to len and truncated 
-            # to len as well. it must be exactly len in size.
-            txt = sprintf("%-*s", len, txt)
-            if len > 0
-              if len < txt.length
-                txt = txt[0..len]
-              end
-              textcolor = get_color $datacolor, 'white', @color
-              @graphic.printstring r, c, txt , textcolor, textattr if @text
-            end
-          else
-            # no text was given just print a horizontal bar
-            @graphic.printstring r, c, char * len , bcolor, 'reverse'
-          end
-        end # frac > 0
-      end # fraction
-    end # style
-    @repaint_required = false
-  end
-  def repaint_old
-  end
-  # ADD HERE progress
-end

data/lib/rbcurse/rscrollform.rb

@@ -1,418 +0,0 @@
-=begin
-  * Name: ScrollForm - a form that can take more than the screen and focus only on what's visible
-  *  This class originated in TabbedPane for the top button form which only scrolls
-  *  horizontally and uses objects that have a ht of 1. Here we have to deal with
-  * large objects and vertical scrolling.
-  * Description: 
-  * Author: rkumar
-  
-  --------
-  * Date: 2010-03-16 11:32 
-  * License:
-    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
-
-
-NOTE: 
-    There are going to be tricky cases we have to deal with such as objects that start in the viewable
-area but finish outside, or vice versa.
-
-    What if we wish some static text to be displayed at top or bottom of ScrollForm
-=end
-require 'logger'
-require 'rbcurse'
-
-#include Ncurses # FFI 2011-09-8 
-include RubyCurses
-module RubyCurses
-  extend self
-  class ScrollForm < RubyCurses::Form
-    # the pad prints from this col to window
-    attr_accessor :pmincol # advance / scroll columns
-    # the pad prints from this row to window, usually 0
-    attr_accessor :pminrow # advance / scroll rows (vertically)
-    #attr_accessor :display_w # width of screen display NOW METHODS
-    #attr_accessor :display_h # ht of screen display
-    attr_accessor :row_offset, :col_offset
-    attr_accessor :scroll_unit # by how much should be scroll
-    attr_reader :orig_top, :orig_left
-    attr_reader :window
-    attr_accessor :name
-    attr_reader :cols_panned, :rows_panned
-    def initialize win, &block
-      @target_window = win
-      super
-      @pminrow = @pmincol = 0
-      @row_offset = @col_offset = 0
-      @scroll_unit = 3
-      @cols_panned = @rows_panned = 0
-      @repaint_all = true
-
-      # take display dimensions from window. It is safe to override immediately after form creation
-      @display_h = win.height
-      @display_w = win.width
-      if @display_h == 0
-        @display_h = (Ncurses.LINES - win.top - 2)
-      else
-        @display_h = win.height - 2
-      end
-      if @display_w == 0
-        @display_w = (Ncurses.COLS - win.left - 2) 
-      else
-        # copywin fails unless u use rootwindow, so what gives in this case
-        @display_w = win.width - 2
-      end
-      
-      init_vars
-    end
-    def init_vars
-      # maybe we should use C-x combinations rather than these keys which might be used
-      #  by other widgets, apps
-      bind_key(?\M-h, :scroll_left)
-      bind_key(?\M-l, :scroll_right)
-      bind_key(?\M-n, :scroll_down)
-      bind_key(?\M-p, :scroll_up)
-    end
-    def should_print_border flag=true
-      @print_border_flag = flag
-      @row_offset = @col_offset = 1
-    end
-    # This is how we set size of pad and where it prints on screen
-    # This is all that's needed after constructor.
-    # @param [Fixnum] t top (row on screen to print pad on)
-    # @param [Fixnum] l left (col on screen to print)
-    # @param [Fixnum] h height (how many lines in Pad, usually more that screens actual height)
-    # @param [Fixnum] w width (how many cols in Pad, often more than screens width)
-    #
-    def set_pad_dimensions(t, l, h, w )
-      @pad_h = h
-      @pad_w = w
-      @top = @orig_top = t
-      @left = @orig_left = l
-      create_pad
-    end
-    # old program tabbed pane uses this. fix
-    # @deprecated use set_pad_dimensions
-    def set_layout h,w,t,l
-      set_pad_dimensions t,l,h,w
-    end
-    def display_h(*val)
-      if val.empty?
-        return @display_h
-      else
-        #raise ArgumentError "display_h should be ... " if val[0] ...
-        oldvalue = @display_h
-        @display_h = val[0]
-        $log.debug "XXX:given display_h to #{@display_h} "
-        @display_h = [@display_h, @target_window.height - 2].min unless @target_window.height == 0
-        $log.debug "XXX:set display_h to #{@display_h} "
-        #fire_property_handler(:display_h, oldvalue, @display_h)
-      end
-      self
-    end
-    #
-    # By default we are determining these 2 values based on window's dims.
-    # However, if you use a widget that is smaller than the window, then
-    # you will want to overwrite these values. 
-    def display_w(*val)
-      if val.empty?
-        return @display_w
-      else
-        #raise ArgumentError "display_h should be ... " if val[0] ...
-        oldvalue = @display_w
-        @display_w = val[0]
-        @display_w = [@display_w, @target_window.width - 2].min unless @target_window.width == 0
-        $log.debug "XXX:set display_w to #{@display_w} "
-        #fire_property_handler(:display_h, oldvalue, @display_h)
-      end
-      self
-    end
-    ## 
-    # create a pad to work on. 
-    # XXX We reuse window, which is already the main window
-    # So if we try creating pad later, then old external window is used.
-    # However, many methods in superclass operate on window so we needed to overwrite. What do i do ?
-    #private
-    def create_pad
-      #raise "Pad already created" if @pad
-      return @pad if @pad
-      r = @top
-      c = @left
-      layout = { :height => @pad_h, :width => @pad_w, :top => r, :left => c } 
-      @window = VER::Pad.create_with_layout(layout)
-  
-      @window.name = "Pad::ScrollPad" # 2010-02-02 20:01 
-      @name = "Form::ScrollForm"
-      @pad = @window
-      return @window
-    end
-    public
-    def scroll_right
-      s = @scroll_unit + $multiplier
-      $log.debug " scroll_right #{s} m: #{$multiplier} "
-      $multiplier = 0
-      return false if !validate_scroll_col(@pmincol + s)
-      @pmincol += s # some check is required or we'll crash
-      @cols_panned -= s
-      $log.debug " handled ch M-l in ScrollForm"
-      @window.modified = true
-      return 0
-    end
-    ## 
-    # validate fails once unit + mult > 1. Then it won't go further
-    # unit should be one by default.
-    def scroll_left
-      s = @scroll_unit + $multiplier
-      $log.debug " scroll_left #{s} m: #{$multiplier} "
-      $multiplier = 0
-      #return false if !validate_scroll_col(@pmincol - s)
-      if !validate_scroll_col(@pmincol - s)
-        @pmincol = 0
-        @cols_panned  = 0 
-      else
-        @pmincol -= s # some check is required or we'll crash
-        @cols_panned += s
-      end
-      @window.modified = true
-      return 0
-    end
-    def scroll_down
-      s = @scroll_unit + $multiplier; $multiplier = 0
-      return false if !validate_scroll_row(@pminrow + s)
-      @pminrow += s # some check is required or we'll crash
-      @rows_panned -= s
-      @window.modified = true
-      #@repaint_all = true
-      return 0
-    end
-    def scroll_up
-      s = @scroll_unit + $multiplier; $multiplier = 0
-      $log.debug " scroll_up #{s} "
-      #return false if !validate_scroll_row(@pminrow - s)
-      if !validate_scroll_row(@pminrow - s)
-        @pminrow = 0
-        @rows_panned = 0
-        $log.debug " !valid #{@pminrow} "
-      else
-        @pminrow -= s # some check is required or we'll crash
-        @rows_panned += s
-        $log.debug " valid #{@pminrow} "
-      end
-      @window.modified = true
-      #@repaint_all = true
-      return 0
-    end
-    # print a border on the main window, just for kicks
-    def print_border
-      $log.debug " SCROLL print_border ..."
-      #@window.print_border_only(@top-@rows_panned, @left+@cols_panned, @display_h, @display_w, $datacolor)
-      @target_window.print_border_only(@top, @left, @display_h, @display_w+1, $datacolor)
-    end
-    def print_footer
-      footer = "Lines %d-%d (%d)  Cols %d-%d (%d) " % [ @pminrow, @pminrow + @display_h, @orig_top + @pad_h, @pmincol, @pmincol + @display_w, @orig_left + @pad_w ] 
-      @target_window.printstring(@top +@display_h, @left + 3, footer, $datacolor)
-    end
-    # XXX what if we want a static area at bottom ?
-    # maybe we should rename targetwindow to window
-    #  and window to pad
-    #  super may need target window
-    def repaint
-      print_border if @repaint_all and @print_border_flag
-      print_footer if @print_border_flag
-      $log.debug " scrollForm repaint calling parent #{@row} #{@col}+ #{@cols_panned} #{@col_offset} "
-      super
-      prefresh
-      if @print_border_flag
-        _print_more_data_marker true
-        _print_more_columns_marker true
-      end
-      #$log.debug " @target_window.wmove #{@row+@rows_panned+@row_offset}, #{@col+@cols_panned+@col_offset}  "
-      @target_window.wmove @row+@rows_panned+@row_offset, @col+@cols_panned+@col_offset
-      @window.modified = false
-      @repaint_all = false
-    end
-    ## refresh pad onto window
-    # I am now copying onto main window, else prefresh has funny effects
-    def prefresh
-      ## reduce so we don't go off in top+h and top+w
-      $log.debug "  start ret = @buttonpad.prefresh( #{@pminrow} , #{@pmincol} , #{@top} , #{@left} , top + #{@display_h} left + #{@display_w} ) "
-      if @pminrow + @display_h > @orig_top + @pad_h
-        $log.debug " if #{@pminrow} + #{@display_h} > #{@orig_top} +#{@pad_h} "
-        $log.debug " ERROR 1 "
-        #return -1
-      end
-      if @pmincol + @display_w > @orig_left + @pad_w
-      $log.debug " if #{@pmincol} + #{@display_w} > #{@orig_left} +#{@pad_w} "
-        $log.debug " ERROR 2 "
-        return -1
-      end
-      # actually if there is a change in the screen, we may still need to allow update
-      # but ensure that size does not exceed
-      if @top + @display_h > @orig_top + @pad_h
-      $log.debug " if #{@top} + #{@display_h} > #{@orig_top} +#{@pad_h} "
-        $log.debug " ERROR 3 "
-        return -1
-      end
-      if @left + @display_w > @orig_left + @pad_w
-      $log.debug " if #{@left} + #{@display_w} > #{@orig_left} +#{@pad_w} "
-        $log.debug " ERROR 4 "
-        return -1
-      end
-      # maybe we should use copywin to copy onto @target_window
-      $log.debug "   ret = @window.prefresh( #{@pminrow} , #{@pmincol} , #{@top} , #{@left} , #{@top} + #{@display_h}, #{@left} + #{@display_w} ) "
-      omit = 0
-      # this works but if want to avoid copying border
-      #ret = @window.prefresh(@pminrow, @pmincol, @top+@row_offset, @left+@col_offset, @top + @display_h - @row_offset , @left + @display_w - @col_offset)
-      #
-      $log.debug "ret = @window.copywin( #{@pminrow} , #{@pmincol} , #{@top+@row_offset} , #{@left+@col_offset} , #{@top} + #{@display_h} - #{@row_offset} , #{@left} + #{@display_w} - #{@col_offset} ,  0)"
-      ## Haha , we are back to the old notorious copywin which has given mankind
-      # so much grief that it should be removed in the next round of creation.
-      ret = @window.copywin(@target_window.get_window, @pminrow, @pmincol, @top+@row_offset, @left+@col_offset, 
-            @top + @display_h - @row_offset , @left + @display_w - @col_offset,  0)
-
-      $log.debug " copywin ret = #{ret} "
-    end
-    private
-    def validate_scroll_row minrow
-       return false if minrow < 0
-      if minrow + @display_h > @orig_top + @pad_h
-        $log.debug " if #{minrow} + #{@display_h} > #{@orig_top} +#{@pad_h} "
-        $log.debug " ERROR 1 "
-        return false
-      end
-      return true
-    end
-    def validate_scroll_col mincol
-      return false if mincol < 0
-      if mincol + @display_w > @orig_left + @pad_w
-      $log.debug " if #{mincol} + #{@display_w} > #{@orig_left} +#{@pad_w} "
-        $log.debug " ERROR 2 "
-        return false
-      end
-      return true
-    end
-    # when tabbing through buttons, we need to account for all that panning/scrolling goin' on
-    # this is typically called by putchar or putc in editable components like field.
-    # XXX DELETE THIS IS SUPPOSE
-    def OLDsetrowcol r, c
-      $log.debug " SCROLL setrowcol #{r},  #{c} + #{@cols_panned}"
-      # aha ! here's where i can check whether the cursor is falling off the viewable area
-      cc = nil
-      rr = nil
-      if c
-        cc = c #+ @cols_panned
-        if c+@cols_panned < @orig_left
-          # this essentially means this widget (button) is not in view, its off to the left
-          $log.debug " setrowcol OVERRIDE #{c} #{@cols_panned} < #{@orig_left} "
-          $log.debug " aborting settrow col for now"
-          return
-        end
-        if c+@cols_panned > @orig_left + @display_w
-          # this essentially means this button is not in view, its off to the right
-          $log.debug " setrowcol OVERRIDE #{c} #{@cols_panned} > #{@orig_left} + #{@display_w} "
-          $log.debug " aborting settrow col for now"
-          return
-        end
-      end
-      if r
-        rr = r+@rows_panned
-      end
-      super rr, cc
-    end
-    public
-    def add_widget w
-      super
-      $log.debug " inside add_widget #{w.name}  pad w #{@pad_w} #{w.col}, #{@pad_h}  "
-      if w.col >= @pad_w
-        @pad_w += 10 # XXX currently just a guess value, we need length and maybe some extra
-        @window.wresize(@pad_h, @pad_w) if @pad
-      end
-      if w.row >= @pad_h
-        @pad_h += 10 # XXX currently just a guess value, we need length and maybe some extra
-        $log.debug " SCROLL add_widget ..."
-        @window.wresize(@pad_h, @pad_w) if @pad
-      end
-    end
-    ## Is a component visible, typically used to prevent traversal into the field
-    # @returns [true, false] false if components has scrolled off
-    def visible? component
-      r, c = component.rowcol
-      return false if c+@cols_panned < @orig_left
-      return false if c+@cols_panned > @orig_left + @display_w
-      # XXX TODO for rows UNTESTED for rows
-      return false if r + @rows_panned < @orig_top
-      return false if r + @rows_panned > @orig_top + @display_h - 2
-
-      return true
-    end
-    # returns index of first visible component. Currently using column index
-    # I am doing this for horizontal scrolling presently
-    # @return [index, -1] -1 if none visible, else index/offset
-    def first_visible_component_index
-      @widgets.each_with_index do |w, ix|
-        return ix if visible?(w) and focusable?(w)
-      end
-      return -1
-    end
-    def last_visible_component_index
-      ret = -1
-      @widgets.each_with_index do |w, ix|
-        ret = ix if visible?(w) and focusable?(w)
-      end
-      return ret
-    end
-    def req_first_field
-      index = first_visible_component_index
-      ret = select_field(index)
-      return ret
-    end
-    def req_last_field
-      select_field(last_visible_component_index)
-    end
-    def focusable?(w)
-      w.focusable and visible?(w)
-    end
-
-    # XXX needs to be called from repaint and print_border
-    # @param [boolean] should marker be printed or not
-    def _print_more_data_marker tf
-      tf = false
-      # the bottom marker meaning there's more data below
-      if @pminrow + @display_h < @pad_h
-        tf = true
-      end
-      marker = tf ?  Ncurses::ACS_CKBOARD : Ncurses::ACS_VLINE
-      h = @display_h; w = @display_w
-      r = @orig_top
-      c = @orig_left
-      $log.debug " more data #{r+h-1}, #{c+w-1} : row #{r} h #{h} w #{w} col #{c} "
-      @target_window.mvwaddch r+h-1, c+w-0, marker
-      # the top marker to show that there is data above
-      marker = @pminrow > 0 ?  Ncurses::ACS_CKBOARD : Ncurses::ACS_VLINE
-      @target_window.mvwaddch r+1, c+w-0, marker
-    end
-
-    # XXX needs to be called from repaint and print_border
-    # @param [boolean] should marker be printed or not
-    def _print_more_columns_marker tf
-      tf = false
-      if @pmincol + @display_w < @pad_w
-        tf = true
-      end
-      marker = tf ?  Ncurses::ACS_CKBOARD : Ncurses::ACS_HLINE
-      h = @display_h; w = @display_w
-      r = @orig_top
-      c = @orig_left
-      @target_window.mvwaddch r+h, c+w-2, marker
-      #
-      # show if columns to left or not
-      marker = @pmincol > 0 ?  Ncurses::ACS_CKBOARD : Ncurses::ACS_HLINE
-      @target_window.mvwaddch r+h, c+1, marker
-    end                                                                                                            
-  end # class ScrollF
-
-  # the return of the prodigals
-  # The Expanding Heart
-  # The coming together of all those who were
-
-
-end # module