ncumbra 0.1.0

data/lib/umbra/radiobutton.rb

@@ -0,0 +1,71 @@
+# ----------------------------------------------------------------------------- #
+#         File: radiobutton.rb
+#  Description: a member of a group of buttons, only one can be selected at a time.
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2018-04-02 - 10:37
+#      License: MIT
+#  Last update: 2018-04-03 14:22
+# ----------------------------------------------------------------------------- #
+#  radiobutton.rb  Copyright (C) 2012-2018 j kepler
+
+module Umbra
+  ##
+  # A selectable button that has a text value. It is based on a Variable that
+  # is shared by other radio buttons. Only one is selected at a time, unlike checkbox
+  # +text+ is the value to display, which can include an ampersand for a hotkey
+  # +value+ is the value returned if selected, which usually is similar to text (or a short word)
+  # +width+ is helpful if placing the brackets to right of text, used to align round brackets
+  #   By default, radio buttons place the button on the left of the text.
+  #
+  # Typically, the variable's update_command is passed a block to execute whenever any of the 
+  # radiobuttons of this group is fired.
+
+  class RadioButton < ToggleButton
+    attr_accessor :align_right    # the button will be on the right 
+    attr_accessor :button_group   # group that this button belongs to.
+
+    def initialize config={}, &block
+      @surround_chars = ['(', ')'] if @surround_chars.nil?
+      super
+      $log.warn "XXX: FIXME Please set 'value' for radiobutton. If not sure, try setting it to the same value as 'text'" unless @value
+      @value ||= @text
+    end
+
+    # all radio buttons will return the value of the selected value, not the offered value
+    def getvalue
+      @button_group.value
+    end
+
+    def getvalue_for_paint
+      buttontext = getvalue() == @value ? "o" : " "
+      $log.debug "called get_value_for paint for buttong #{@value} :#{buttontext} "
+      dtext = @width.nil? ? text : "%-*s" % [@width, text]
+      if @align_right
+        @text_offset = 0
+        @col_offset = dtext.length + @surround_chars[0].length + 1
+        return "#{dtext} " + @surround_chars[0] + buttontext + @surround_chars[1] 
+      else
+        pretext = @surround_chars[0] + buttontext + @surround_chars[1] 
+        @text_offset = pretext.length + 1
+        @col_offset = @surround_chars[0].length
+        return pretext + " #{dtext}"
+      end
+    end
+
+    def toggle
+      fire
+    end
+
+    ##
+    # If user has pressed on this then set the group to this button.
+    def checked tf
+
+      if @button_group.value == value
+        @button_group.value = ""
+      else
+        @button_group.value = value
+      end
+    end
+
+  end # class radio 
+end # module

data/lib/umbra/textbox.rb

@@ -0,0 +1,417 @@
+# ----------------------------------------------------------------------------- #
+#         File: textbox.rb
+#  Description: a multiline text view
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2018-03-24 - 12:39
+#      License: MIT
+#  Last update: 2018-04-20 12:58
+# ----------------------------------------------------------------------------- #
+#  textbox.rb  Copyright (C) 2012-2018 j kepler
+##  TODO -----------------------------------
+#  improve the object sent when row change or cursor movement 
+#
+#
+#  ----------------------------------------
+## CHANGELOG
+#
+#  ----------------------------------------
+require 'umbra/widget'
+module Umbra
+class Textbox < Widget 
+  attr_reader   :list                 # list containing data 
+  attr_accessor :file_name            # filename passed in for reading
+  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 :cursor              # position of cursor in line ??
+=begin
+  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 >)
+=end
+
+  def initialize config={}, &block
+    @focusable          = false              # will only be set true if data is set
+    @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      = 0                  # presently no selection. Actually 0 is Ctrl-Space.
+    @highlight_attr     = FFI::NCurses::A_BOLD
+    @to_print_border    = false
+    @row_offset         = 0
+    @col_offset         = 0
+    @pcol               = 0
+    @curpos             = 0                  # current cursor position in buffer (NOT screen/window/field)
+=begin
+
+    @selected_color_pair = CP_RED 
+    @selected_attr = REVERSE
+    @selected_mark    = 'x' # row selected character
+    @unselected_mark  = ' ' # row unselected character (usually blank)
+    @current_mark     = '>' # row current character (default is >)
+=end
+    register_events([:ENTER_ROW, :LEAVE_ROW, :CURSOR_MOVE]) # 
+    super
+
+    map_keys
+    # internal width and height
+    @repaint_required = true
+  end
+  def _calculate_dimensions
+    @int_width = @width
+    @int_height = @height      # used here only
+    @scroll_lines ||= @int_height/2  # fix these to be perhaps half and one of ht
+    @page_lines = @int_height
+    @calculate_dimensions = 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.
+  def list=(alist)
+    if !alist or alist.size == 0
+      self.focusable=(false)
+    else
+      self.focusable=(true)
+    end
+    @list = alist
+    @repaint_required = true
+    @pstart = @current_index = 0
+    @selected_index = nil
+    @focusable = true         # too late since form is not rechecking its array
+  end
+  def file_name=(fp)
+    raise "File #{fp} not readable"  unless File.readable? fp 
+    return Dir.new(fp).entries if File.directory? fp
+    case File.extname(fp)
+    when '.tgz','.gz'
+      cmd = "tar -ztvf #{fp}"
+      content = %x[#{cmd}]
+    when '.zip'
+      cmd = "unzip -l #{fp}"
+      content = %x[#{cmd}]
+    when '.jar', '.gem'
+      cmd = "tar -tvf #{fp}"
+      content = %x[#{cmd}]
+    when '.png', '.out','.jpg', '.gif','.pdf'
+      content = "File #{fp} not displayable"
+    when '.sqlite'
+      cmd = "sqlite3 #{fp} 'select name from sqlite_master;'"
+      content = %x[#{cmd}]
+    else
+      #content = File.open(fp,"r").readlines # this keeps newlines which mess with output
+      content = File.open(fp,"r").read.split("\n")
+    end
+    self.list = content
+    raise "list not set" unless @list
+
+  end
+
+  def repaint 
+    _calculate_dimensions unless @calculate_dimensions
+    return unless @repaint_required
+    return unless @list
+    win = @graphic
+    r,c = @row, @col 
+    _attr = @attr || NORMAL
+    _color = @color_pair || CP_WHITE
+    #_bordercolor = @border_color_pair || CP_BLUE
+    rowpos = 1
+    coffset = 0
+    #width = win.width-1
+    width = @width
+    files = @list
+    
+    #ht = win.height-2
+    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
+      colr = CP_WHITE # white on bg -1
+      mark = @unselected_mark
+      if y == hl
+        attr = @highlight_attr #FFI::NCurses::A_REVERSE
+        mark = @current_mark
+        rowpos = ctr
+      else
+        attr = FFI::NCurses::A_NORMAL
+      end
+      if y == @selected_index
+        colr = @selected_color_pair
+        attr = @selected_attr
+        mark = @selected_mark
+      end
+      #ff = "#{mark} #{f}"
+      ff = f
+      if ff
+        if ff.size > width
+          #ff = ff[0...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, colr )
+      win.printstring(ctr + r, coffset+c, ff, colr, attr)
+      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 = rowpos 
+    #@col_offset = coffset # this way form can pick it up XXX can't override it like this
+    @repaint_required = false
+  end
+
+  def getvalue
+    @list
+  end
+
+  # ensure text has been passed or action
+  def getvalue_for_paint
+    raise
+    ret = getvalue
+    #@text_offset = @surround_chars[0].length
+    #@surround_chars[0] + ret + @surround_chars[1]
+  end
+
+
+  def map_keys
+    return if @keys_mapped
+    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 }
+    @keys_mapped = true
+  end
+
+  # listbox key handling
+  def handle_key ch
+    return :UNHANDLED unless @list
+    #   save old positions so we know movement has happened
+    old_current_index = @current_index
+    old_pcol = @pcol
+    old_col_offset = @col_offset
+
+    begin
+      case ch
+      when @selection_key
+        @repaint_required = true  
+        if @selected_index == @current_index 
+          @selected_index = nil
+        else
+          @selected_index = @current_index 
+        end
+      else
+        ret = super
+        return ret
+      end
+    ensure
+      @current_index = 0 if @current_index < 0
+      @current_index = @list.size-1 if @current_index >= @list.size
+      @repaint_required = true  if @current_index != old_current_index
+      if @current_index != old_current_index or @pcol != old_pcol or @col_offset != old_col_offset
+        if @current_index != old_current_index 
+          on_leave_row old_current_index
+          on_enter_row @current_index
+          #fire_handler(:CHANGE_ROW, [old_current_index, @current_index, ch ])     # 2018-03-26 - improve this
+        end
+        @repaint_required = true 
+        fire_handler(:CURSOR_MOVE, [@col_offset, @current_index, @curpos, @pcol, ch ])     # 2018-03-25 - improve this
+      end
+    end
+  end
+  # advance col_offset (where cursor will be displayed on screen)
+  # @param [Integer] advance by n (can be negative or positive)
+  # @return -1 if cannot advance
+  private def add_col_offset num
+    x = @col_offset + num
+    return -1 if x < 0
+    return -1 if x > @int_width 
+    # is it a problem that i am directly changing col_offset ??? XXX
+    @col_offset += num 
+  end
+  # returns current row
+  def current_row
+    @list[@current_index]
+  end
+
+  # move cursor forward one character, called with KEY_RIGHT action.
+  def cursor_forward
+    blen = current_row().size-1
+    if @curpos < blen
+      if add_col_offset(1)==-1  # go forward if you can, else scroll
+        #@pcol += 1 if @pcol < @width 
+        @pcol += 1 if @pcol < blen
+      end
+      @curpos += 1
+    end
+  end
+  def cursor_backward
+
+    if @col_offset > 0
+      @curpos -= 1
+      add_col_offset -1
+    else
+      # cur is on the first col, then scroll left
+      if @pcol > 0
+        @pcol -= 1
+        @curpos -= 1
+      else
+        # do nothing
+      end
+    end
+  end
+  # position cursor at start of field
+  def cursor_home
+    @curpos = 0
+    @pcol = 0
+    set_col_offset 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 < @int_width
+      set_col_offset blen # just after the last character
+      @pcol = 0
+    else
+      @pcol = blen-@int_width
+      set_col_offset blen
+    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
+  # go to start of file (first line)
+  def goto_start
+    @current_index = 0
+    @pcol = @curpos = 0
+    set_col_offset 0
+  end
+  # go to end of file (last line)
+  def goto_end
+    @current_index = @list.size-1
+  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
+  # sets the visual cursor on the window at correct place
+  # NOTE be careful of curpos - pcol being less than 0
+  # @param [Integer] position in data on the line
+  private def set_col_offset x=@curpos
+    @curpos = x || 0 # NOTE we set the index of cursor here - WHY TWO THINGS ??? XXX
+    #return -1 if x < 0
+    #return -1 if x > @width
+    if x >= @int_width
+      x = @int_width
+      @col_offset = @int_width 
+      return
+    end
+    @col_offset = x 
+    @col_offset = @int_width if @col_offset > @int_width
+    return
+  end
+  def cursor_up
+    @current_index -= 1
+  end
+  # go to next row
+  def cursor_down
+    @current_index += 1
+  end
+  def on_enter
+    super
+    return unless @list
+    on_enter_row @current_index
+  end
+  def on_leave
+    super
+    on_leave_row @current_index
+  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, [old_current_index, @current_index, ch ])     # 2018-03-26 - improve this
+    fire_handler(:ENTER_ROW, [@current_index])     # 2018-03-26 - improve this
+    # if cursor ahead of blen then fix it
+    blen = current_row().size-1
+    if @curpos > blen
+      @col_offset = blen - @pcol 
+      @curpos = blen
+      if @pcol > blen
+        @pcol = blen - @int_width
+        @pcol = 0 if @pcol < 0
+        @col_offset = blen - @pcol 
+      end
+    end
+    @col_offset = 0 if @col_offset < 0
+  end
+  ## border {{{
+  private def print_border row, col, height, width, color, att=FFI::NCurses::A_NORMAL
+    raise
+    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/togglebutton.rb

@@ -0,0 +1,140 @@
+require 'umbra/button'
+##
+# ----------------------------------------------------------------------------- #
+#         File: togglebutton.rb
+#  Description: a button that has two states, on and off
+#       Author: j kepler  http://github.com/mare-imbrium/umbra/
+#         Date: 2018-03-17 - 22:50
+#      License: MIT
+#  Last update: 2018-04-07 23:08
+# ----------------------------------------------------------------------------- #
+#  togglebutton.rb Copyright (C) 2012-2018 j kepler
+#
+#
+module Umbra
+  ##
+  # an event fired when an item that can be selected is toggled/selected
+  class ItemEvent  # {{{
+    # http://java.sun.com/javase/6/docs/api/java/awt/event/ItemEvent.html
+    attr_reader :state   # :SELECTED :DESELECTED
+    attr_reader :item   # the item pressed such as toggle button
+    attr_reader :item_selectable   # item originating event such as list or collection
+    attr_reader :item_first   # if from a list
+    attr_reader :item_last   # 
+    attr_reader :param_string   #  for debugging etc
+=begin
+    def initialize item, item_selectable, state, item_first=-1, item_last=-1, paramstring=nil
+      @item, @item_selectable, @state, @item_first, @item_last =
+        item, item_selectable, state, item_first, item_last 
+      @param_string = "Item event fired: #{item}, #{state}"
+    end
+=end
+    # i think only one is needed per object, so create once only
+    def initialize item, item_selectable
+      @item, @item_selectable =
+        item, item_selectable
+    end
+    def set state, item_first=-1, item_last=-1, param_string=nil
+      @state, @item_first, @item_last, @param_string =
+        state, item_first, item_last, param_string 
+      @param_string = "Item event fired: #{item}, #{state}" if param_string.nil?
+    end
+  end # }}}
+# A button that may be switched off an on. 
+# Extended by RadioButton and checkbox.
+# WARNING, pls do not override +text+ otherwise checkboxes etc will stop functioning.
+# TODO: add editable here nd prevent toggling if not so.
+class ToggleButton < Button 
+  # text for on value and off value
+  attr_accessor :onvalue, :offvalue
+  # boolean, which value to use currently, onvalue or offvalue
+  attr_accessor :value
+  # characters to use for surround, array, default square brackets
+  attr_accessor :surround_chars 
+  # 2018-04-02 - removing variable
+  #attr_accessor :variable    # value linked to this variable which is a boolean
+  # background to use when selected, if not set then default
+  # 2018-04-02 - unused so commenting off. color_pair is not used here or in checkbox
+  #attr_accessor :selected_bgcolor
+  #attr_accessor :selected_color 
+  attr_accessor :selected_color_pair
+
+  def initialize config={}, &block
+    super
+
+    #@value ||= (@variable.nil? ? false : @variable.get_value(@name)==true)
+    # TODO may need to do this when this is added to button_group 
+  end
+  def getvalue
+    @value ? @onvalue : @offvalue
+  end
+
+  # WARNING, pls do not override +text+ otherwise checkboxes etc will stop functioning.
+
+  # added for some standardization 2010-09-07 20:28 
+  # alias :text :getvalue # NEXT VERSION
+  # change existing text to label
+  ##
+  # is the button on or off
+  # added 2008-12-09 19:05 
+  def checked?
+    @value
+  end
+  alias :selected? :checked?
+
+  def getvalue_for_paint
+    # when the width is set externally then the surround chars sit outside the width
+    #unless @width
+      if @onvalue && @offvalue
+        @width = [ @onvalue.length, @offvalue.length ].max 
+      end
+    #end
+    buttontext = getvalue().center(@width)
+    @text_offset = @surround_chars[0].length
+    @surround_chars[0] + buttontext + @surround_chars[1]
+  end
+
+  # toggle button handle key
+  # @param [int] key received
+  #
+  def handle_key ch
+    if ch == 32
+      toggle
+      @repaint_required = true # need to change the label
+    else
+      super
+    end
+  end
+
+  ##
+  # toggle the button value
+  def toggle
+    fire
+  end
+
+  # called on :PRESS event
+  # caller should check state of itemevent passed to block
+  # NOTE i have not brought ItemEvent in here.
+  def fire
+    checked(!@value)
+    @item_event = ItemEvent.new self, self if @item_event.nil?
+    @item_event.set(@value ? :SELECTED : :DESELECTED)
+    fire_handler :PRESS, @item_event # should the event itself be ITEM_EVENT
+  end
+  ##
+  # set the value to true or false
+  # user may programmatically want to check or uncheck
+  def checked tf
+    @value = tf
+=begin
+    if @variable
+      if @value 
+        @variable.set_value((@onvalue || 1), @name)
+      else
+        @variable.set_value((@offvalue || 0), @name)
+      end
+    end
+=end
+  end
+end # class 
+end # module

data/lib/umbra/version.rb

@@ -0,0 +1,3 @@
+module Umbra
+  VERSION = "0.1.0"
+end