ncumbra 0.1.0

data/lib/umbra/labeledfield.rb

@@ -0,0 +1,97 @@
+# ----------------------------------------------------------------------------- #
+#         File: labeledfield.rb
+#  Description: 
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2018-04-12 - 23:35
+#      License: MIT
+#  Last update: 2018-04-21 23:58
+# ----------------------------------------------------------------------------- #
+#  labeledfield.rb Copyright (C) 2018 j kepler
+require 'umbra/field'
+module Umbra
+  # TODO should be able to add a mnemonic here for the label since the association exists
+  # TODO we should consider creating a Label, so user can have more control. Or allow user
+  #   to supply a Label i/o a String ???
+  #
+  #   NOTE: If using LabeledField in a messagebox, pls specify messagebox width explicitly
+  #   since the width here is the field width, and messagebox has no way of knowing that we are
+  #   placing a label too. 
+
+  # Other options:
+  #   This could contain a Labal and a Field and extend Widget. Actually, it could be LabeledWidget
+  #     so that any other widget is sent in and associated with a a label.
+  #
+  class LabeledField < Field
+    # This stores a +String+ and prints it before the +Field+. 
+    # This label is gauranteed to print to the left of the Field.
+    # This label prints on +lrow+ and +lcol+ if supplied, else it will print on the left of the field
+    # at +col+ minus the width of the label. 
+    #
+    # It is initialized exactly like a Field, with the addition of label (and optionally label_color_pair,
+    #   label_attr, and lcol, lrow)
+    # 
+    attr_accessor :label              # label of field, just a String  
+    # if lrow and lcol are specified then label is printed exactly at that spot.
+    # If they are omitted, then label is printed on left of field. Omit the lcol if you want
+    #   the fields to be aligned, one under another, with the labels right-aligned.
+    attr_accessor :lrow, :lcol        # coordinates of the label
+    attr_accessor :label_color_pair   # label of field  color_pair
+    attr_accessor :label_attr         # label of field  attribute
+    attr_accessor :label_highlight_color_pair   # label of field  high color_pair
+    attr_accessor :label_highlight_attr         # label of field  high attribute
+    attr_accessor :mnemonic         # mnemonic of field which shows up on label
+    attr_accessor :related_widget         #  to keep sync with label
+    def initialize config={}, &block
+      @related_widget = self
+      super
+    end
+
+    def repaint
+      return unless @repaint_required
+      _lrow = @lrow || @row
+      # the next was nice, but in some cases this goes out of screen. and the container
+      # only sets row and col for whatever is added, it does not know that lcol has to be 
+      # taken into account
+      _lcol = @lcol || (@col - @label.length  - 2)
+      if _lcol < 1
+        @lcol = @col
+        @col = @lcol + @label.length + 2
+        _lcol = @lcol
+      end
+
+=begin
+      # This actually uses the col of the field, and pushes field ahead. We need to get the above to work.
+      unless @lcol
+        @lcol = @col
+        @col = @lcol + @label.length + 2
+      end
+      _lcol = @lcol
+=end
+      lcolor = @label_color_pair || CP_BLACK
+      lattr = @label_attr || NORMAL
+
+      # this gives the effect of `pine` (aka alpine)  email client, of highlighting the label
+      #   when the field is in focus.
+      if @state == :HIGHLIGHTED
+        lcolor = @label_highlight_color_pair || lcolor
+        lattr = @label_highlight_attr || lattr
+      end
+
+      $log.debug "  repaint labeledfield lrow: #{_lrow} lcol #{_lcol} "
+      # print the label
+      @graphic.printstring _lrow, _lcol, @label, lcolor, lattr
+      # print the mnemonic
+      if @mnemonic
+        index = label.index(@mnemonic) || label.index(@mnemonic.swapcase)
+        if index
+          y = _lcol + index
+          x = _lrow
+          @graphic.mvchgat(x, y, max=1, FFI::NCurses::A_BOLD|UNDERLINE, FFI::NCurses.COLOR_PAIR(lcolor || 1), nil)
+        end
+      end
+
+      # print the field
+      super
+    end
+  end
+end # module

data/lib/umbra/listbox.rb

@@ -0,0 +1,384 @@
+require 'umbra/widget'
+# ----------------------------------------------------------------------------- #
+#         File: listbox.rb
+#  Description: list widget that displays a list of items
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2018-03-19 
+#      License: MIT
+#  Last update: 2018-04-20 12:35
+# ----------------------------------------------------------------------------- #
+#  listbox.rb  Copyright (C) 2012-2018 j kepler
+#  == TODO 
+#  currently only do single selection, we may do multiple at a later date.
+#  insert/delete a row ??
+#  ----------------
+module Umbra
+class Listbox < Widget 
+  attr_reader   :list                        # list containing data 
+  #
+  # index of focussed row, starting 0, index into the list supplied
+  attr_reader   :current_index
+
+  attr_accessor :selection_key               # key used to select a row
+  attr_accessor :selected_index              # row selected, may change to plural
+  attr_accessor :selected_color_pair         # row selected color_pair
+  attr_accessor :selected_attr               # row selected color_pair
+  attr_accessor :selected_mark               # row selected character
+  attr_accessor :unselected_mark             # row unselected character (usually blank)
+  attr_accessor :current_mark                # row current character (default is >)
+
+
+  def initialize config={}, &block
+    @focusable          = false
+    @editable           = false
+    @pstart             = 0                  # which row does printing start from
+    @current_index      = 0                  # index of row on which cursor is
+    @selected_index     = nil                # index of row selected
+    @selection_key      = ?s.getbyte(0)      # 's' used to select/deselect
+    @selected_color_pair = CP_RED 
+    @selected_attr      = REVERSE
+    @row_offset         = 0
+    @selected_mark      = 'x'                # row selected character
+    @unselected_mark    = ' '                # row unselected character (usually blank)
+    @current_mark       = '>'                # row current character (default is >)
+    register_events([:LEAVE_ROW, :ENTER_ROW, :LIST_SELECTION_EVENT])
+    super
+
+    map_keys
+    @pcol               = 0
+    @repaint_required   = true
+  end
+  # set list of data to be displayed.
+  # NOTE this can be called again and again, so we need to take care of change in size of data
+  # as well as things like current_index and selected_index or indices.
+  # clear the listbox is list is smaller or empty FIXME
+  def list=(alist)
+    if !alist or alist.size == 0
+      $log.debug "  setting focusable to false in listbox "
+      self.focusable=(false)
+      # should we return here
+    else
+      $log.debug "  setting focusable to true in listbox #{alist.count} "
+      self.focusable=(true)
+    end
+    @list               = alist
+    @repaint_required   = true
+    @pstart = @current_index = 0
+    @selected_index     = nil
+    @pcol               = 0
+    fire_handler(:CHANGED, alist)
+  end
+  # Calculate dimensions as late as possible, since we can have some other container such as a box,
+  # determine the dimensions after creation.
+  private def _calc_dimensions
+    raise "Dimensions not supplied to listbox" if @row.nil? or @col.nil? or @width.nil? or @height.nil?
+    @_calc_dimensions = true
+    @int_width  = @width                     # internal width NOT USED ELSEWHERE
+    @int_height = @height                    # internal height  USED HERE ONLy REDUNDANT FIXME
+    @scroll_lines ||= @int_height/2
+    @page_lines = @int_height
+  end
+  # Each row can be in one of the following states:
+  #  1. HIGHLIGHTED: cursor is on the row, and the list is focussed (user is in it)
+  #  2. CURRENT    : cursor was on this row, now user has exited the list
+  #  3. SELECTED   : user has selected this row (this can also have above two states actually)
+  #  4. NORMAL     : All other rows: not selected, not under cursor
+  # returns color, attrib and left marker for given row
+  # @param index of row in the list
+  # @param state of row in the list (see above states)
+  def _format_color index, state
+    arr = case state
+    when :SELECTED
+      [@selected_color_pair, @selected_attr]
+    when :HIGHLIGHTED
+      [@highlight_color_pair || CP_WHITE, @highlight_attr || REVERSE]
+    when :CURRENT
+      [@color_pair, @attr]
+    when :NORMAL
+      #@alt_color_pair ||= create_color_pair(COLOR_BLUE, COLOR_WHITE)
+      _color = CP_CYAN
+      _color = CP_WHITE if index % 2 == 0
+      #_color = @alt_color_pair if index % 2 == 0
+      [@color_pair || _color, @attr || NORMAL]
+    end
+    return arr
+  end
+  # do the actual printing of the row, depending on index and state
+  # This method starts with underscore since it is only required to be overriden
+  # if an object has special printing needs.
+  def _print_row(win, row, col, str, index, state)
+    arr = _format_color index, state
+    win.printstring(row, col, str, arr[0], arr[1])
+  end
+  def _format_mark index, state
+      mark = case state
+             when :SELECTED
+               @selected_mark
+             when :HIGHLIGHTED, :CURRENT
+               @current_mark
+             else
+               @unselected_mark
+             end
+  end
+
+  def repaint 
+    _calc_dimensions unless @_calc_dimensions
+
+    return unless @repaint_required
+    win                 = @graphic
+    r,c                 = @row, @col 
+    _attr               = @attr || NORMAL
+    _color              = @color_pair || CP_WHITE
+    curpos              = 1
+    coffset             = 0
+    width               = @width
+    #files               = @list
+    files               = getvalue 
+    
+    ht                  = @height
+    cur                 = @current_index
+    st                  = pstart = @pstart           # previous start
+    pend = pstart + ht -1                            # previous end
+    if cur > pend
+      st = (cur -ht) + 1 
+    elsif cur < pstart
+      st = cur
+    end
+    $log.debug "LISTBOX: cur = #{cur} st = #{st} pstart = #{pstart} pend = #{pend} listsize = #{@list.size} "
+    hl = cur
+    y = 0
+    ctr = 0
+    filler = " "*(width)
+    files.each_with_index {|_f, y| 
+      next if y < st
+      f = _format_value(_f)
+      
+      # determine state of this row: NORMAL CURRENT HIGHLIGHTED SELECTED {{{
+      _st = :NORMAL
+      if y == hl # current row, row on which cursor is or was
+        # highlight only if object is focussed, otherwise just show mark
+        if @state == :HIGHLIGHTED
+          _st = :HIGHLIGHTED
+        else
+          # cursor was on this row, but now user has tabbed out
+          _st = :CURRENT
+        end
+        curpos          = ctr
+      end
+      if y == @selected_index
+        _st = :SELECTED
+      end # }}}
+      #colr, attr, mark = _format_color y, _st
+
+      mark = _format_mark(y, _st)
+=begin
+      mark = case _st
+             when :SELECTED
+               @selected_mark
+             when :HIGHLIGHTED, :CURRENT
+               @current_mark
+             else
+               @unselected_mark
+             end
+=end
+               
+      ff = "#{mark} #{f}"
+      # truncate string to width, and handle panning {{{
+      if ff
+        if ff.size > width
+          # pcol can be greater than width then we get null
+          if @pcol < ff.size
+            ff = ff[@pcol..@pcol+width-1] 
+          else
+            ff = ""
+          end
+        else
+          if @pcol < ff.size
+            ff = ff[@pcol..-1]
+          else
+            ff = ""
+          end
+        end
+      end # }}}
+      ff = "" unless ff
+
+      win.printstring(ctr + r, coffset+c, filler, _color )     # print filler
+      #win.printstring(ctr + r, coffset+c, ff, colr, attr)
+      _print_row(win, ctr + r, coffset+c, ff, y, _st)
+      ctr += 1 
+      @pstart = st
+      break if ctr >= ht 
+    }
+    ## if counter < ht then we need to clear the rest in case there was data earlier {{{
+    if ctr < ht
+      while ctr < ht
+        win.printstring(ctr + r, coffset+c, filler, _color )
+        ctr += 1
+      end
+    end # }}}
+    @row_offset = curpos #+ border_offset
+    @col_offset = coffset
+    @repaint_required = false
+  end
+
+  def getvalue
+    @list
+  end
+
+  # 
+  # how to convert the line of the array to a simple String.
+  # This is only required to be overridden if the list passed in is not an array of Strings.
+  # @param the current row which could be a string or array or whatever was passed in in +list=()+.
+  # @return [String] string to print. A String must be returned.
+  def _format_value line
+    line
+  end
+  #alias :_format_value :getvalue_for_paint
+
+
+  def map_keys
+    bind_keys([?k,FFI::NCurses::KEY_UP], "Up")         { cursor_up }
+    bind_keys([?j,FFI::NCurses::KEY_DOWN], "Down")     { cursor_down }
+    bind_keys([?l,FFI::NCurses::KEY_RIGHT], "Right")   { cursor_forward }
+    bind_keys([?h,FFI::NCurses::KEY_LEFT], "Left")     { cursor_backward }
+    bind_key(?g, 'goto_start')                         { goto_start }
+    bind_key(?G, 'goto_end')                           { goto_end }
+    bind_key(FFI::NCurses::KEY_CTRL_A, 'cursor_home')  { cursor_home }
+    bind_key(FFI::NCurses::KEY_CTRL_E, 'cursor_end')   { cursor_end }
+    bind_key(FFI::NCurses::KEY_CTRL_F, 'page_forward') { page_forward }
+    bind_key(32, 'page_forward')                       { page_forward }
+    bind_key(FFI::NCurses::KEY_CTRL_B, 'page_backward'){ page_backward }
+    bind_key(FFI::NCurses::KEY_CTRL_U, 'scroll_up')    { scroll_up }
+    bind_key(FFI::NCurses::KEY_CTRL_D, 'scroll_down')  { scroll_down }
+    return if @keys_mapped
+  end
+
+  def on_enter
+    super
+    on_enter_row @current_index
+    # basically I need to only highlight the current index, not repaint all OPTIMIZE 
+    touch ; repaint
+  end
+  def on_leave
+    super
+    on_leave_row @current_index
+    # basically I need to only unhighlight the current index, not repaint all OPTIMIZE 
+    touch ; repaint
+  end
+  # called when object leaves a row and when object is exited.
+  def on_leave_row index
+    fire_handler(:LEAVE_ROW, [index])     # 2018-03-26 - improve this
+  end
+  # called whenever a row entered.
+  # Call when object entered, also. 
+  def on_enter_row index
+    fire_handler(:ENTER_ROW, [@current_index])     # 2018-03-26 - improve this
+  end
+  def cursor_up
+    @current_index -= 1
+  end
+  # go to next row
+  def cursor_down
+    @current_index += 1
+  end
+    # position cursor at start of field
+    def cursor_home
+      @curpos  = 0  # UNUSED RIGHT NOW
+      @pcol    = 0
+    end
+    # goto end of line. 
+    # This should be consistent with moving the cursor to the end of the row with right arrow
+    def cursor_end
+      blen = current_row().length
+      if blen < @width
+        @pcol = 0
+      else
+        @pcol = blen-@width+2  # 2 is due to mark and space
+      end
+      @curpos = blen # this is position in array where editing or motion is to happen regardless of what you see
+      # regardless of pcol (panning)
+    end
+    # returns current row as String
+    # 2018-04-11 - NOTE this may not be a String so we convert it to string before returning
+    # @return [String] row the cursor/user is on
+    def current_row
+      s = @list[@current_index]
+      _format_value s
+    end
+    def cursor_forward
+      blen = current_row().size-1
+      @pcol += 1 if @pcol < blen
+    end
+    def cursor_backward
+      @pcol -= 1 if @pcol > 0
+    end
+    # go to start of file (first line)
+    def goto_start
+      @current_index = 0
+      @pcol = @curpos = 0
+    end
+    # go to end of file (last line)
+    def goto_end
+      @current_index = @list.size-1
+      @pcol = @curpos = 0
+    end
+    def scroll_down
+      @current_index += @scroll_lines
+    end
+    def scroll_up
+      @current_index -= @scroll_lines
+    end
+    def page_backward
+      @current_index -= @page_lines
+    end
+    def page_forward
+      @current_index += @page_lines
+    end
+  # listbox key handling
+  def handle_key ch
+    old_current_index = @current_index
+    old_pcol = @pcol
+    case ch
+    when @selection_key
+      @repaint_required = true  
+      if @selected_index == @current_index 
+        @selected_index = nil
+      else
+        @selected_index = @current_index 
+      end
+      fire_handler :LIST_SELECTION_EVENT, self   # use selected_index to know which one
+    else
+      ret = super
+      return ret
+    end
+  ensure
+    @current_index = 0 if @current_index < 0
+    @current_index = @list.size-1 if @current_index >= @list.size
+    if @current_index != old_current_index
+      on_leave_row old_current_index
+      on_enter_row @current_index
+      @repaint_required = true  
+    end
+    @repaint_required = true if old_pcol != @pcol
+  end
+
+  def command *args, &block
+    bind_event :ENTER_ROW, *args, &block
+  end
+  def print_border row, col, height, width, color, att=FFI::NCurses::A_NORMAL
+    raise "deprecated"
+    pointer = @graphic.pointer
+    FFI::NCurses.wattron(pointer, FFI::NCurses.COLOR_PAIR(color) | att)
+    FFI::NCurses.mvwaddch pointer, row, col, FFI::NCurses::ACS_ULCORNER
+    FFI::NCurses.mvwhline( pointer, row, col+1, FFI::NCurses::ACS_HLINE, width-2)
+    FFI::NCurses.mvwaddch pointer, row, col+width-1, FFI::NCurses::ACS_URCORNER
+    FFI::NCurses.mvwvline( pointer, row+1, col, FFI::NCurses::ACS_VLINE, height-2)
+
+    FFI::NCurses.mvwaddch pointer, row+height-1, col, FFI::NCurses::ACS_LLCORNER
+    FFI::NCurses.mvwhline(pointer, row+height-1, col+1, FFI::NCurses::ACS_HLINE, width-2)
+    FFI::NCurses.mvwaddch pointer, row+height-1, col+width-1, FFI::NCurses::ACS_LRCORNER
+    FFI::NCurses.mvwvline( pointer, row+1, col+width-1, FFI::NCurses::ACS_VLINE, height-2)
+    FFI::NCurses.wattroff(pointer, FFI::NCurses.COLOR_PAIR(color) | att)
+  end
+end 
+end # module

data/lib/umbra/menu.rb

@@ -0,0 +1,93 @@
+# ----------------------------------------------------------------------------- #
+#         File: menu.rb
+#  Description: a popup menu like mc/midnight commander 
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2018-03-13
+#      License: MIT
+#  Last update: 2018-04-16 15:20
+# ----------------------------------------------------------------------------- #
+#  menu.rb  Copyright (C) 2012-2018 j kepler
+
+# a midnight commander like mc_menu
+# Pass a hash of key and label.
+# menu will only accept keys or arrow keys or C-c Esc to cancel
+# returns nil if C-c or Esc pressed.
+# Otherwise returns character pressed.
+# == TODO 
+# depends on our window class which is minimal.
+# [ ] cursor should show on the row that is highlighted
+# [ ] Can we remove that dependency so this is independent
+# Currently, we paint window each time user pressed up or down, but we can just repaint the attribute
+# [ ] width of array items not checked. We could do that or have user pass it in.
+# [ ] we are not scrolling if user sends in a large number of items. we should cap it to 10 or 20
+# == CHANGELOG
+#
+require 'umbra/window'
+module Umbra
+  class Menu
+
+    def initialize title, hash, config={}
+
+      @list = hash.values
+      @keys = hash.keys.collect { |x| x.to_s }
+      @hash = hash
+      bkgd = config[:bkgd] || FFI::NCurses.COLOR_PAIR(14) | BOLD
+      @attr = BOLD
+      @color_pair = config[:color_pair] || 14
+      ht = @list.size+2
+      wid = config[:width] || 40
+      top = (FFI::NCurses.LINES - ht)/2
+      left = (FFI::NCurses.COLS - wid)/2
+      @window = Window.new(ht, wid, top, left)
+      @window.wbkgd(bkgd)
+      @window.box
+      @window.title(title)
+      @current = 0
+      print_items @hash
+    end
+    def print_items hash
+      ix = 0
+      hash.each_pair {|k, val|
+        attr = @attr
+        attr = REVERSE if ix == @current
+        @window.printstring(ix+1 , 2, "#{k}    #{val}", @color_pair, attr )
+        ix += 1
+      }
+      @window.refresh
+    end
+    def getkey
+      ch = 0
+      char = nil
+      begin
+        while (ch = @window.getkey) != FFI::NCurses::KEY_CTRL_C
+          break if ch == 27 # ESC
+          tmpchar = FFI::NCurses.keyname(ch) rescue '?'
+          if @keys.include? tmpchar
+            $log.debug "  menu #{tmpchar.class}:#{tmpchar} "
+            char = ch.chr
+            $log.debug "  menu #{ch.class}:#{char} "
+            #char = tmpchar
+            break
+          end
+          case ch
+          when FFI::NCurses::KEY_DOWN
+            @current += 1
+          when FFI::NCurses::KEY_UP
+            @current -= 1
+          when FFI::NCurses::KEY_RETURN
+            char = @keys[@current]
+            break
+          end
+          @current = 0 if @current < 0
+          @current = @list.size-1 if @current >= @list.size
+          print_items @hash
+
+          # trap arrow keys here
+        end
+      ensure
+        @window.destroy
+      end
+      return char
+    end
+  end
+end # module