rbhex-core 1.0.0

data/lib/rbhex/core/widgets/scrollbar.rb

@@ -0,0 +1,143 @@
+require 'rbhex/core/util/app'
+#include Ncurses # FFI 2011-09-8
+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
+      #$log.debug "SCROLLBAR COLOR cp #{@color_pair} sp #{@scroll_pair} " if $log.debug?
+      @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
+        # in some cases, on leaving a listbox or other component redraws itself to reduce
+        # selected or highlighted object, so the scrollbar gets overwritten. We need to repaint it.
+        @parent.bind :LEAVE do |p|
+          @repaint_required = true
+        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
+      #$log.debug "SCROLL bordercolor #{bordercolor} , #{borderatt} " if $log.debug?
+
+
+      @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
+      sclen = 1 if sclen < 1 # sometimes 0.7 for large lists 100 items 2011-10-1
+      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 + 0 # earlier 1, but removed since sclen min 1 2011-10-1
+      end
+      @graphic.attron(Ncurses.COLOR_PAIR(@scroll_pair) | borderatt)
+      r = @row + scloc
+      c = @col + 0
+      #$log.debug " XXX SCROLLBAR #{r} #{c} #{sclen} "
+      @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/rbhex/core/widgets/statusline.rb

@@ -0,0 +1,113 @@
+require 'rbhex'
+
+module RubyCurses
+
+  #
+  # A vim-like application status bar that can display time and various other statuses
+  #  at the bottom, typically above the dock (3rd line from last).
+  #
+  class StatusLine < Widget
+    #attr_accessor :row_relative # lets only advertise this when we've tested it out
+
+    def initialize form, config={}, &block
+      @row_relative = -3
+      if form.window.height == 0
+        @row = Ncurses.LINES-3 # fix, what about smaller windows, use window dimensions and watch out for 0,0
+      else
+        @row = form.window.height-3 # fix, what about smaller windows, use window dimensions and watch out for 0,0
+      end
+       # in root windows FIXME
+      @col = 0
+      @name = "sl"
+      super
+      # if negativ row passed we store as relative to bottom, so we can maintain that.
+      if @row < 0
+        @row_relative = @row
+        @row = Ncurses.LINES - @row
+      else
+        @row_relative = (Ncurses.LINES - @row) * -1
+      end
+      @focusable = false
+      @editable  = false
+      @command = nil
+      @repaint_required = true
+      bind(:PROPERTY_CHANGE) {  |e| @color_pair = nil ; }
+    end
+    #
+    # command that returns a string that populates the status line (left aligned)
+    # @see :right
+    # See dbdemo.rb
+    # e.g.
+    #   @l.command { "%-20s [DB: %-s | %-s ]" % [ Time.now, $current_db || "None", $current_table || "----"] }
+    #
+    def command *args, &blk
+      @command = blk
+      @args = args
+    end
+    alias :left :command
+
+    #
+    # Procudure for text to be right aligned in statusline
+    def right *args, &blk
+      @right_text = blk
+      @right_args = args
+    end
+
+    # NOTE: I have not put a check of repaint_required, so this will print on each key-stroke OR
+    #   rather whenever form.repaint is called.
+    def repaint
+      @color_pair ||= get_color($datacolor, @color, @bgcolor)
+      len = @form.window.getmaxx # width does not change upon resizing so useless, fix or do something
+      len = Ncurses.COLS if len == 0 || len > Ncurses.COLS
+      # this should only happen if there's a change in window
+      if @row_relative
+        @row = Ncurses.LINES+@row_relative
+      end
+
+      # first print dashes through
+      @form.window.printstring @row, @col, "%s" % "-" * len, @color_pair, Ncurses::A_REVERSE
+
+      # now call the block to get current values
+      if @command
+        ftext = @command.call(self, @args)
+      else
+        status = $status_message ? $status_message.value : ""
+        #ftext = " %-20s | %s" % [Time.now, status] # should we print a default value just in case user doesn't
+        ftext = status # should we print a default value just in case user doesn't
+      end
+      # 2013-03-25 - 11:52 replaced $datacolor with @color_pair - how could this have been ?
+      # what if user wants to change attrib ?
+      if ftext =~ /#\[/
+        # hopefully color_pair does not clash with formatting
+        @form.window.printstring_formatted @row, @col, ftext, @color_pair, Ncurses::A_REVERSE
+      else
+        @form.window.printstring @row, @col, ftext, @color_pair, Ncurses::A_REVERSE
+      end
+
+      if @right_text
+        ftext = @right_text.call(self, @right_args)
+        if ftext =~ /#\[/
+          # hopefully color_pair does not clash with formatting
+          @form.window.printstring_formatted_right @row, nil, ftext, @color_pair, Ncurses::A_REVERSE
+        else
+          c = len - ftext.length
+          @form.window.printstring @row, c, ftext, @color_pair, Ncurses::A_REVERSE
+        end
+      else
+        t = Time.now
+        tt = t.strftime "%F %H:%M:%S"
+        #r = Ncurses.LINES
+        # somehow the bg defined here affects the bg in left text, if left does not define
+        # a bg. The bgcolor defined of statusline is ignored in left or overriden by this
+        #ftext = "#[fg=white,bg=blue] %-20s#[/end]" % [tt] # print a default
+        @form.window.printstring_formatted_right @row, nil, tt, @color_pair, Ncurses::A_REVERSE
+      end
+
+      @repaint_required = false
+    end
+    def handle_keys ch
+      return :UNHANDLED
+    end
+
+  end # class
+end # module

data/lib/rbhex/core/widgets/tabular.rb

@@ -0,0 +1,264 @@
+#!/usr/bin/env ruby -w
+=begin
+  * Name          : A Quick take on tabular data. Readonly.
+  * Description   : To show tabular data inside a control, rather than going by the huge
+                    Table object, I want to create a simple, minimal table data generator.
+                    This will be thrown into a TextView for the user to navigate, select
+                    etc.
+                    I would use this applications where the tabular data is fairly fixed
+                    not where i want the user to select columns, move them, expand etc.
+  *               :
+  * Author        : rkumar
+  * Date          : 
+  * License       :
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+=end
+
+#
+# A simple tabular data generator. Given table data in arrays and a column heading row in arrays, it 
+# quickely generates tabular data. It only takes left and right alignment of columns into account.
+#   You may specify individual column widths. Else it will take the widths of the column names you supply 
+# in the startup array. You are encouraged to supply column widths.
+#   If no columns are specified, and no widths are given, it take the widths of the first row 
+# as a model to determine column widths. 
+#
+module RubyCurses
+
+  class Tabular
+    GUESSCOLUMNS = 20
+
+  def yield_or_eval &block
+    return unless block
+    if block.arity > 0
+      yield self
+    else
+      self.instance_eval(&block)
+    end
+  end
+    # stores column info internally
+    class ColumnInfo < Struct.new(:name, :w, :align)
+    end
+    # an array of column titles
+    attr_reader :columns
+    # boolean, does user want lines numbered
+    attr_accessor :numbering
+    # x is the + character used a field delim in separators
+    # y is the field delim used in data rows, default is pipe or bar
+    attr_accessor :x, :y
+
+    # takes first optional argument as array of column names
+    # second optional argument as array of data arrays
+    # @yield self
+    #
+    def initialize cols=nil, *args, &block
+      @chash = {}
+      @cw = {}
+      @calign = {}
+      @separ = @columns = @numbering =  nil
+      @y = '|'
+      @x = '+'
+      self.columns = cols if cols
+      if !args.empty?
+        #puts "ARGS after shift #{args} "
+        if !args.empty?
+          self.data = args
+        end
+      end
+      yield_or_eval(&block) if block_given?
+    end
+    #
+    # set columns names 
+    # @param [Array<String>] column names, preferably padded out to width for column
+    def columns=(array)
+      $log.debug "tabular got columns #{array.count} #{array.inspect} " if $log
+      @columns = array
+      @columns.each_with_index { |c,i| 
+        @chash[i] = ColumnInfo.new(c, c.to_s.length) 
+        @cw[i] ||= c.to_s.length
+        #@calign[i] ||= :left # 2011-09-27 prevent setting later on
+      }
+    end
+    alias :headings= :columns=
+    #
+    # set data as an array of arrays
+    # @param [Array<Array>] data as array of arrays
+    def data=(list)
+      #puts "got data: #{list.size} " if !$log
+      #puts list if !$log
+      @list = list
+    end
+
+    # add a row of data 
+    # @param [Array] an array containing entries for each column
+    def add array
+      $log.debug "tabular got add  #{array.count} #{array.inspect} " if $log
+      @list ||= []
+      @list << array
+    end
+    alias :<< :add
+    alias :add_row :add
+
+    # set width of a given column
+    # @param [Number] column offset, starting 0
+    # @param [Number] width
+    def column_width colindex, width
+      @cw[colindex] ||= width
+      if @chash[colindex].nil?
+        @chash[colindex] = ColumnInfo.new("", width) 
+      else
+        @chash[colindex].w = width
+      end
+      @chash
+    end
+
+    # set alignment of given column offset
+    # @param [Number] column offset, starting 0
+    # @param [Symbol] :left, :right
+    def align_column colindex, lrc
+      raise ArgumentError, "wrong alignment value sent" if ![:right, :left, :center].include? lrc
+      @calign[colindex] ||= lrc
+      if @chash[colindex].nil?
+        @chash[colindex] = ColumnInfo.new("", nil, lrc)
+      else
+        @chash[colindex].align = lrc
+      end
+      @chash
+    end
+
+    # 
+    # Now returns an array with formatted data
+    # @return [Array<String>] array of formatted data
+    def render
+      buffer = []
+      _guess_col_widths
+      rows = @list.size.to_s.length
+      @rows = rows
+      _prepare_format
+      
+      str = ""
+      if @numbering
+        str = " "*(rows+1)+@y
+      end
+      str <<  @fmstr % @columns
+      buffer << str
+      #puts "-" * str.length
+      buffer << separator
+      if @list
+        if @numbering
+          @fmstr = "%#{rows}d "+ @y + @fmstr
+        end
+        #@list.each { |e| puts e.join(@y) }
+        count = 0
+        @list.each_with_index { |r,i|  
+          value = convert_value_to_text r, count
+          buffer << value
+          count += 1
+        }
+      end
+      buffer
+    end
+    def convert_value_to_text r, count
+      if r == :separator
+        return separator
+      end
+      if @numbering
+        r.insert 0, count+1
+      end
+      return @fmstr % r;  
+    end
+    # use this for printing out on terminal
+    # @example
+    #     puts t.to_s
+    def to_s
+      render().join "\n"
+    end
+    def add_separator
+      @list << :separator
+    end
+    def separator
+      return @separ if @separ
+      str = ""
+      if @numbering
+        str = "-"*(@rows+1)+@x
+      end
+      @cw.each_pair { |k,v| str << "-" * (v+1) + @x }
+      @separ = str.chop
+    end
+    private
+    def _guess_col_widths  #:nodoc:
+      @list.each_with_index { |r, i| 
+        break if i > GUESSCOLUMNS
+        next if r == :separator
+        r.each_with_index { |c, j|
+          x = c.to_s.length
+          if @cw[j].nil?
+            @cw[j] = x
+          else
+            @cw[j] = x if x > @cw[j]
+          end
+        }
+      }
+    end
+    def _prepare_format  #:nodoc:
+      @fmtstr = nil
+      fmt = []
+      @cw.each_with_index { |c, i| 
+        w = @cw[i]
+        case @calign[i]
+        when :right
+          fmt << "%#{w}s "
+        else
+          fmt << "%-#{w}s "
+        end
+      }
+      @fmstr = fmt.join(@y)
+      #puts "format: #{@fmstr} " # 2011-12-09 23:09:57
+    end
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  include RubyCurses
+  $log = nil
+  t = Tabular.new(['a', 'b'], [1, 2], [3, 4])
+  puts t.to_s
+  puts 
+  t = Tabular.new([" Name ", " Number ", "  Email    "])
+  t.add %w{ rahul 32 r@ruby.org }
+  t << %w{ _why 133 j@gnu.org }
+  t << %w{ Jane 1331 jane@gnu.org }
+  t.column_width 1, 10
+  t.align_column 1, :right
+  puts t.to_s
+  puts
+
+  s = Tabular.new do |b|
+    b.columns = %w{ country continent text }
+    b << ["india","asia","a warm country" ] 
+    b << ["japan","asia","a cool country" ] 
+    b << ["russia","europe","a hot country" ] 
+    b.column_width 2, 30
+  end
+  puts s.to_s
+  puts
+  puts "::::"
+  puts
+  s = Tabular.new do |b|
+    b.columns = %w{ place continent text }
+    b << ["india","asia","a warm country" ] 
+    b << ["japan","asia","a cool country" ] 
+    b << ["russia","europe","a hot country" ] 
+    b << ["sydney","australia","a dry country" ] 
+    b << ["canberra","australia","a dry country" ] 
+    b << ["ross island","antarctica","a dry country" ] 
+    b << ["mount terror","antarctica","a windy country" ] 
+    b << ["mt erebus","antarctica","a cold place" ] 
+    b << ["siberia","russia","an icy city" ] 
+    b << ["new york","USA","a fun place" ] 
+    b.column_width 0, 12
+    b.column_width 1, 12
+    b.numbering = true
+  end
+  puts s.to_s
+end