rbcurse 1.1.5 → 1.2.0.pre

data/lib/rbcurse/extras/masterdetail.rb

@@ -0,0 +1,164 @@
+require 'rbcurse/rvimsplit'
+require 'forwardable'
+# A convenience class that implements a 3 way Master Detail like form
+# as in some email clients. See appemail.rb for usage.
+# You may use this class or extend it. It takes care of expanding,
+# increasing etc the 3 splits.
+# This class is not fully tested beyond appemail.rb, and can change
+# quite a bit. Users may want to copy this to prevent from major changes
+# that could take place.
+class MasterDetail < Widget
+  dsl_property :weight
+  attr_reader :vim # the vimsplit for any further configuration such as min_weight etc
+  extend Forwardable
+  def_delegators :@vim, :on_enter, :on_leave, :handle_key, :current_component
+  def initialize form, config={}, &block
+    @focusable = true
+    @height = Ncurses.LINES-2
+    @weight = 0.25
+    super
+    _create_vimsplit
+    init_vars
+  end
+  def init_vars  #:nodoc:
+    @first_time = true
+    @repaint_required = true
+  end
+  def repaint
+    if @first_time
+      @first_time = nil
+      [@vim, @left, @right1, @right2].each { |e|  
+        e.set_buffering(:target_window => @target_window || @form.window, :form => @form)
+      }
+    end
+    @vim.repaint
+  end
+  # set the single component on the left side/pane, typically a +Listbox+.
+  # If an array is passed, the Listbox created is returned for further
+  # manipulation.
+  # @param [Widget] component to set on left
+  # @return [Widget] component added
+  def set_left_component comp, weight=nil
+    @left = @vim.add comp, :FIRST, weight
+    _add_component comp
+    @left
+  end
+  # set the first component on the right side/pane, typically a +Listbox+.
+  # @param [Widget] component to set on right
+  # @return [Widget] component added
+  def set_right_top_component comp, weight=0.5
+    @added_top = true
+    @right1 = @vim.add comp, :SECOND, weight
+    _add_component comp
+    @right1
+  end
+  # set the second component on the right side/pane, typically a
+  # +TextView+
+  # @param [Widget] component to set on right
+  # @return [Widget] component added
+  def set_right_bottom_component comp, weight=nil
+    raise "Please add top component first!" unless @added_top
+    # what if user gives in wrong order !!
+    @gb = @vim.add :divider, :SECOND, 0
+    @right2 = @vim.add comp, :SECOND, weight
+    @gb.next(@right2)
+    _add_component comp
+    @right2
+  end
+  def focus comp
+    case comp
+    when :left
+      @vim.goto_component @left
+    when :top_right
+      @vim.goto_component @right1
+    when :bottom_right
+      @vim.goto_component @right2
+    else
+      @vim.goto_component comp
+    end
+  end
+  private
+  # does nothing at present
+  def _add_component comp  #:nodoc:
+  end
+  # creates a Vimplit containing 3 panes. Sets events in order to
+  # increase and decrease panes/windows.
+  def _create_vimsplit  #:nodoc:
+    @vim = VimSplit.new nil, :row => @row, :col => @col, :width => @width, :height => @height, :weight => @weight, :orientation => :VERTICAL, :suppress_borders => true do |s|
+      s.parent_component = self
+      #s.target_window = @form.window
+      #s.add @left, :FIRST
+      #s.add @right1, :SECOND
+      #s.add @right2, :SECOND
+      s.bind :COMPONENT_RESIZE_EVENT do |e|
+        #alert "got a resize event #{e.type}  "
+        case e.type
+        when :INCREASE
+          case e.source
+          when @right2
+            increase_body
+          when @right1
+            increase_headers
+          when @left
+
+          end
+        when :DECREASE
+          case e.source
+          when @right2
+            increase_headers
+          when @right1
+            increase_body
+          when @left
+            @left.width -= 1
+            @right2.col -=1
+            @right1.col -=1
+            @right1.width +=1
+            @right2.width +=1
+            @right2.repaint_required  true
+            @right1.repaint_required  true
+            @left.repaint_required  true
+          end
+        when :EXPAND
+          case e.source
+          when @right2
+            h = 3
+            @right2.row(@right1.row + h)
+            oldh = @right1.height
+            @right1.height = h
+            @right1.current_index = 0
+            @right2.height += (oldh - h)
+            @right2.repaint_required  true
+            @right1.repaint_required  true
+          when @right1
+            h = 3
+            @right2.row(@right2.row + (@right2.height - 3))
+            oldh = @right2.height
+            @right2.height = h
+            #@right1.current_index = 0
+            @right1.height += (oldh - h)
+            @right2.repaint_required  true
+            @right1.repaint_required  true
+          end
+        end
+      end # bind
+    end
+  end # def
+  # increase the top right pane and reduces lower one
+  # TODO: to take into account multiplier
+  def increase_headers  #:nodoc:
+    @right2.row @right2.row()+1
+    @right1.height +=1
+    @right2.height -=1
+    @right2.repaint_required  true
+    @right1.repaint_required  true
+  end
+  # decrease the top right pane and increase lower one
+  # TODO: to take into account multiplier
+  def increase_body  #:nodoc:
+    @right2.row @right2.row()-1
+    @right1.height -=1
+    @right2.height +=1
+    @right2.repaint_required  true
+    @right1.repaint_required  true
+  end
+end # class

data/lib/rbcurse/extras/menutree.rb

@@ -0,0 +1,63 @@
+module RubyCurses
+  # Create a simple tree-ish structure.
+  # Each node is not a tree, only submenus are trees
+  # Others contain a hash with menu character and code
+  # Typically the code is not a method symbol, it is to be 
+  # used to decode a description or method symbol from anoterh hash
+  # @usage
+  #    menu = MenuTree.new "Main", { c: :goprev, d: :gonext, e: :gonext, s: :submenu }
+  #    menu.submenu :s, "submenu", {a: :next1, b: :next2, f: :next3 }
+  #    puts menu.hash
+  #    puts "each ..."
+  #    menu.each { |e|  puts e }
+  #    menu.each_pair { |e, v|  puts "#{e} #{v}" }
+  #    puts " -- :c -- "
+  #    puts menu[:c]
+  #    puts " -- :s -- "
+  #    puts menu[:s].children
+  class MenuTree
+    attr_reader :value
+    def initialize value, hash = {}
+      @value = [value, hash]
+    end
+    def << kv
+      @value[1][kv[0]] = kv[1]
+    end
+    def hash
+      @value[1]
+    end
+    alias :children :hash
+    def push hsh
+      hash().merge hsh
+    end
+    def [](x)
+      hash()[x]
+    end
+    def []=(x,y)
+      hash()[x] = y
+    end
+    def submenu key, value, hash = {}
+      m = MenuTree.new value, hash
+      #hash()[key] = [value, hash]
+      hash()[key] = m
+    end
+    def each
+      hash().keys.each { |e| yield e }
+    end
+    def each_pair
+      hash().each_pair { |name, val| yield name, val  }
+    end
+  end
+end
+if __FILE__ == $PROGRAM_NAME
+  menu = RubyCurses::MenuTree.new "Main", { c: :goprev, d: :gonext, e: :gonext, s: :submenu }
+  menu.submenu :s, "submenu", {a: :next1, b: :next2, f: :next3 }
+  puts menu.hash
+  puts "each ..."
+  menu.each { |e|  puts e }
+  menu.each_pair { |e, v|  puts "#{e} #{v}" }
+  puts " -- :c -- "
+  puts menu[:c]
+  puts " -- :s -- "
+  puts menu[:s].children
+end

data/lib/rbcurse/extras/rlink.rb

@@ -0,0 +1,27 @@
+require 'rbcurse'
+##
+module RubyCurses
+  class Link < Button
+    dsl_property :description
+
+
+    def initialize form, config={}, &block
+      super
+      @text_offset = 0
+      # haha we've never done this, pin the cursor up on 0,0
+      @col_offset = -1 
+      if @mnemonic
+        form.bind_key(@mnemonic.downcase, self){ self.fire }
+      end
+      @display_length = config[:width]
+    end
+    def fire
+      super
+      self.focus
+    end
+    def getvalue_for_paint
+      getvalue()
+    end
+    ##
+  end # class
+end # module

data/lib/rbcurse/extras/rmenulink.rb

@@ -0,0 +1,21 @@
+require 'rbcurse/extras/rlink'
+##
+module RubyCurses
+  class MenuLink < Link
+    dsl_property :description
+
+    def initialize form, config={}, &block
+      super
+      @col_offset = -1 * @col
+      @row_offset = -1 * @row
+    end
+    # added for some standardization 2010-09-07 20:28 
+    # alias :text :getvalue # NEXT VERSION
+    # change existing text to label
+
+    def getvalue_for_paint
+      "%s      %-12s   -    %-s" % [ @mnemonic , getvalue(), @description ]
+    end
+    ##
+  end # class
+end # module

data/lib/rbcurse/extras/scrollbar.rb

@@ -0,0 +1,134 @@
+require 'rbcurse/app'
+include Ncurses
+include RubyCurses
+
+# This paints a vertical white bar given row and col, and length. It also calculates and prints
+# a small bar over this based on relaetd objects list.length and current_index.
+# Typically, after setup one would keep updating only current_index from the repaint method
+# of caller or in the traversal event. This would look best if the listbox also has a reverse video border, or none.
+# @example
+#     lb = list_box ....
+#     sb = Scrollbar.new @form, :row => lb.row, :col => lb.col, :length => lb.height, :list_length => lb.row_count, :current_index => 0
+#      .... later as user traverses
+#      sb.current_index = lb.current_index
+#     sb = Scrollbar.new @form, :parent => list
+#
+# At a later stage, we will integrate this with lists and tables, so it will happen automatically.
+#
+# @since 1.2.0    UNTESTED
+module RubyCurses
+  class Scrollbar < Widget
+    # row to start, same as listbox, required.
+    dsl_property :row
+    # column to start, same as listbox, required.
+    dsl_property :col
+    # how many rows is this (should be same as listboxes height, required.
+    dsl_property :length
+    # vertical or horizontal currently only VERTICAL
+    dsl_property :orientation
+    # initialize based on parent's values
+    dsl_property :parent
+    # which row is focussed, current_index of listbox, required.
+    dsl_property :current_index
+    # how many total rows of data does the list have, same as @list.length, required.
+    dsl_property :list_length
+
+    # TODO: if parent passed, we shold bind to ON_ENTER and get current_index, so no extra work is required.
+
+    def initialize form, config={}, &block
+
+      # setting default first or else Widget will place its BW default
+      #@color, @bgcolor = ColorMap.get_colors_for_pair $bottomcolor
+      super
+      @color_pair = get_color $datacolor, @color, @bgcolor
+      @scroll_pair = get_color $bottomcolor, :green, :white
+      @window = form.window
+      @editable = false
+      @focusable = false
+      @repaint_required = true
+      @orientation = :V
+      if @parent
+        @parent.bind :ENTER_ROW do |p|
+          # parent must implement row_count, and have a @current_index
+          raise StandardError, "Parent must implement row_count" unless p.respond_to? :row_count
+          self.current_index = p.current_index
+          @repaint_required = true  #requred otherwise at end when same value sent, prop handler
+          # will not be fired (due to optimization).
+        end
+      end
+    end
+
+    ##
+    # repaint the scrollbar
+    # Taking the data from parent as late as possible in case parent resized, or 
+    # moved around by a container.
+    def repaint
+      if @parent
+        @row = @parent.row+1
+        @col = @parent.col + @parent.width - 1
+        @length = @parent.height - 2
+        @list_length = @parent.row_count 
+        @current_index ||= @parent.current_index
+        @border_attrib ||= @parent.border_attrib
+      end
+      raise ArgumentError, "current_index must be provided" unless @current_index
+      raise ArgumentError, "list_length must be provided" unless @list_length
+      my_win = @form ? @form.window : @target_window
+      @graphic = my_win unless @graphic
+      return unless @repaint_required
+
+      # first print a right side vertical line
+      #bc = $bottomcolor  # dark blue
+      bc = $datacolor
+      bordercolor = @border_color || bc
+      borderatt = @border_attrib || Ncurses::A_REVERSE
+
+
+      @graphic.attron(Ncurses.COLOR_PAIR(bordercolor) | borderatt)
+      $log.debug " XXX SCROLL #{@row} #{@col} #{@length} "
+      @graphic.mvvline(@row+0, @col, 1, @length-0)
+      @graphic.attroff(Ncurses.COLOR_PAIR(bordercolor) | borderatt)
+
+      # now calculate and paint the scrollbar
+      pht = @length
+      listlen = @list_length * 1.0
+      @current_index = 0 if @current_index < 0
+      @current_index = listlen-1 if @current_index >= listlen
+      sclen = (pht/listlen)* @length
+      scloc = (@current_index/listlen)* @length
+      scloc = (@length - sclen) if scloc > @length - sclen # don't exceed end
+      if @current_index == @list_length - 1
+        scloc = @length - sclen + 1
+      end
+      @graphic.attron(Ncurses.COLOR_PAIR(@scroll_pair) | borderatt)
+      r = @row + scloc
+      c = @col + 0
+      @graphic.mvvline(r, c, 1, sclen)
+      @graphic.attroff(Ncurses.COLOR_PAIR(@scroll_pair) | borderatt)
+      @repaint_required = false
+    end
+    ##
+    ##
+    # ADD HERE 
+  end
+end
+if __FILE__ == $PROGRAM_NAME
+  App.new do
+    r = 5
+    len = 20
+    list = []
+    0.upto(100) { |v| list << "#{v} scrollable data" }
+    lb = list_box "A list", :list => list
+    #sb = Scrollbar.new @form, :row => r, :col => 20, :length => len, :list_length => 50, :current_index => 0
+    rb = Scrollbar.new @form, :parent => lb
+    #hline :width => 20, :row => len+r
+    #keypress do |ch|
+      #case ch
+      #when :down
+        #sb.current_index += 1
+      #when :up
+        #sb.current_index -= 1
+      #end
+    #end
+  end
+end

data/lib/rbcurse/extras/stdscrwindow.rb

@@ -0,0 +1,247 @@
+require 'ver/ncurses'
+module RubyCurses
+  #
+  # an attempt to make a window based on stdscr for bottom line printing so the entire 
+  # application can have one pointer, regardless of whether through App
+  # or otherwise. This still provides the full getchar operation, copied from
+  # Window class which is the main purpose of this. So as to provide ask, agree and say.
+  #
+  # We should be able to pass this window to bottomline and have one global bottomline
+  # created once (by window class ?)
+  #
+  class StdscrWindow 
+    attr_reader :width, :height, :top, :left
+
+    def initialize
+
+      @window = Ncurses.stdscr
+      $error_message_row ||= Ncurses.LINES-1
+      $error_message_col ||= 1
+      init_vars
+
+
+    end
+    def init_vars
+      Ncurses::keypad(@window, true)
+      @stack = []
+    end
+    ##
+
+    # Ncurses
+
+    def method_missing(meth, *args)
+      @window.send(meth, *args)
+    end
+
+    def print(string, width = width)
+      return unless visible?
+      @window.waddnstr(string.to_s, width)
+    end
+
+    def print_yx(string, y = 0, x = 0)
+      @window.mvwaddnstr(y, x, string, width)
+    end
+
+    def print_empty_line
+      return unless visible?
+      @window.printw(' ' * width)
+    end
+
+    def print_line(string)
+      print(string.ljust(width))
+    end
+
+    def puts(*strings)
+      print(strings.join("\n") << "\n")
+    end
+
+    def refresh
+      @window.refresh
+    end
+
+
+    def color=(color)
+      @color = color
+      @window.color_set(color, nil)
+    end
+
+    def highlight_line(color, y, x, max)
+      @window.mvchgat(y, x, max, Ncurses::A_NORMAL, color, nil)
+    end
+
+    def ungetch(ch)
+      Ncurses.ungetch(ch)
+    end
+
+    def getch
+      c = @window.getch
+      #if c == Ncurses::KEY_RESIZE
+    rescue Interrupt => ex
+      3 # is C-c
+    end
+
+    # returns control, alt, alt+ctrl, alt+control+shift, F1 .. etc
+    # ALT combinations also send a 27 before the actual key
+    # Please test with above combinations before using on your terminal
+    # added by rkumar 2008-12-12 23:07 
+    def getchar 
+      while 1 
+        ch = getch
+        #$log.debug "window getchar() GOT: #{ch}" if ch != -1
+        if ch == -1
+          # the returns escape 27 if no key followed it, so its SLOW if you want only esc
+          if @stack.first == 27
+            #$log.debug " -1 stack sizze #{@stack.size}: #{@stack.inspect}, ch #{ch}"
+            case @stack.size
+            when 1
+              @stack.clear
+              return 27
+            when 2 # basically a ALT-O, this will be really slow since it waits for -1
+              ch = 128 + @stack.last
+              @stack.clear
+              return ch
+            when 3
+              $log.debug " SHOULD NOT COME HERE getchar()"
+            end
+          end
+          @stack.clear
+          next
+        end
+        # this is the ALT combination
+        if @stack.first == 27
+          # experimental. 2 escapes in quick succession to make exit faster
+          if ch == 27
+            @stack.clear
+            return ch
+          end
+          # possible F1..F3 on xterm-color
+          if ch == 79 or ch == 91
+            #$log.debug " got 27, #{ch}, waiting for one more"
+            @stack << ch
+            next
+          end
+          #$log.debug "stack SIZE  #{@stack.size}, #{@stack.inspect}, ch: #{ch}"
+          if @stack == [27,79]
+            # xterm-color
+            case ch
+            when 80
+              ch = KEY_F1
+            when 81
+              ch = KEY_F2
+            when 82
+              ch = KEY_F3
+            when 83
+              ch = KEY_F4
+            end
+            @stack.clear
+            return ch
+          elsif @stack == [27, 91]
+            if ch == 90
+              @stack.clear
+              return KEY_BTAB # backtab
+            end
+          end
+          # the usual Meta combos. (alt)
+          ch = 128 + ch
+          @stack.clear
+          return ch
+        end
+        # append a 27 to stack, actually one can use a flag too
+        if ch == 27
+          @stack << 27
+          next
+        end
+        return ch
+      end
+    end
+
+    def clear
+      # return unless visible?
+      move 0, 0
+      puts *Array.new(height){ ' ' * (width - 1) }
+    end
+
+
+    def visible?
+      @visible
+    end
+    ## 
+    # added by rk 2008-11-29 19:01 
+    # I usually use this, not the others ones here
+    # @param  r - row
+    # @param  c - col
+    # @param string - text to print
+    # @param color - color pair
+    # @ 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)
+
+      #$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'
+        att = Ncurses::A_BOLD
+      when 'blink'
+        att = Ncurses::A_BLINK    # unlikely to work
+      when 'reverse'
+        att = Ncurses::A_REVERSE    
+      end
+
+      attron(Ncurses.COLOR_PAIR(color) | att)
+      # we should not print beyond window coordinates
+      # trying out on 2009-01-03 19:29 
+      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 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.
+    #  2010-09-13 00:22 WE should not use these any longer.
+    #  Application should create a label and map a Variable named
+    #  $errormessage to it. We should only update the Variable
+    def print_error_message text=$error_message
+      r = $error_message_row || Ncurses.LINES-1
+      c = $error_message_col || (Ncurses.COLS-text.length)/2 
+
+      $log.debug "got ERROR MESSAGE #{text} row #{r} "
+      clear_error r, $datacolor
+      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
+      r = $status_message_row || Ncurses.LINES-1
+      clear_error r, $datacolor
+      # print it in centre
+      printstring r, (Ncurses.COLS-text.length)/2, text, color = $promptcolor
+    end
+    # 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
+      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
+    ##
+    def get_window; @window; end
+    def to_s; @name || self; end
+  end
+end