ncumbra 0.1.0 → 0.1.1

data/lib/umbra/textbox.rb

@@ -4,26 +4,21 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-03-24 - 12:39
 #      License: MIT
-#  Last update: 2018-04-20 12:58
+#  Last update: 2018-05-10 11:06
 # ----------------------------------------------------------------------------- #
 #  textbox.rb  Copyright (C) 2012-2018 j kepler
 ##  TODO -----------------------------------
 #  improve the object sent when row change or cursor movement 
-#
+## 2018-05-08 - extend Multiline
 #
 #  ----------------------------------------
 ## CHANGELOG
 #
 #  ----------------------------------------
-require 'umbra/widget'
+require 'umbra/multiline'
 module Umbra
-class Textbox < Widget 
-  attr_reader   :list                 # list containing data 
+class Textbox < Multiline 
   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
@@ -32,55 +27,18 @@ class Textbox < Widget
 =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]) # 
+    #register_events([:ENTER_ROW, :LEAVE_ROW, :CURSOR_MOVE]) # 
+    register_events([: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.
+  # set list of data to be displayed from filename.  {{{
   # 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
@@ -106,126 +64,28 @@ class Textbox < Widget
     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
+  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]
+  # returns current row
+  def current_row
+    @list[@current_index]
   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
+  ## textbox key handling  
+  ## Textbox varies from multiline in that it fires a cursor_move event whrease the parent 
+  ##  fires a cursor_move event which is mostly used for testing out
   def handle_key ch
+    begin 
+      ret = super
+      return ret
+    ensure
+      if @repaint_required
+        fire_handler(:CURSOR_MOVE, [@col_offset, @current_index, @curpos, @pcol, ch ])     # 2018-03-25 - improve this
+      end
+    end
+  end
+  def OLDhandle_key ch # {{{
     return :UNHANDLED unless @list
     #   save old positions so we know movement has happened
     old_current_index = @current_index
@@ -233,18 +93,8 @@ class Textbox < Widget
     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
@@ -253,30 +103,25 @@ class Textbox < Widget
         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)
+  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
+  private def OLDadd_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
+  def OLDcursor_forward
     blen = current_row().size-1
     if @curpos < blen
       if add_col_offset(1)==-1  # go forward if you can, else scroll
@@ -286,7 +131,7 @@ class Textbox < Widget
       @curpos += 1
     end
   end
-  def cursor_backward
+  def OLDcursor_backward
 
     if @col_offset > 0
       @curpos -= 1
@@ -302,14 +147,14 @@ class Textbox < Widget
     end
   end
   # position cursor at start of field
-  def cursor_home
+  def OLDcursor_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
+  def OLDcursor_end
     blen = current_row().length
     if blen < @int_width
       set_col_offset blen # just after the last character
@@ -322,31 +167,19 @@ class Textbox < Widget
     # regardless of pcol (panning)
   end
   # go to start of file (first line)
-  def goto_start
+  def OLDgoto_start
     @current_index = 0
     @pcol = @curpos = 0
     set_col_offset 0
   end
   # go to end of file (last line)
-  def goto_end
+  def OLDgoto_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
+  private def OLD_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
@@ -359,29 +192,9 @@ class Textbox < Widget
     @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
+  def OLD_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
@@ -396,7 +209,7 @@ class Textbox < Widget
       end
     end
     @col_offset = 0 if @col_offset < 0
-  end
+  end # }}}
   ## border {{{
   private def print_border row, col, height, width, color, att=FFI::NCurses::A_NORMAL
     raise

data/lib/umbra/togglebutton.rb

@@ -6,7 +6,7 @@ require 'umbra/button'
 #       Author: j kepler  http://github.com/mare-imbrium/umbra/
 #         Date: 2018-03-17 - 22:50
 #      License: MIT
-#  Last update: 2018-04-07 23:08
+#  Last update: 2018-05-14 14:35
 # ----------------------------------------------------------------------------- #
 #  togglebutton.rb Copyright (C) 2012-2018 j kepler
 #
@@ -50,14 +50,12 @@ class ToggleButton < Button
   # 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 
+  attr_property :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
+  attr_property :selected_color_pair
 
   def initialize config={}, &block
     super

data/lib/umbra/version.rb

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

data/lib/umbra/widget.rb

@@ -3,10 +3,39 @@
 # extend this, if it wants to be repainted or wants focus. Otherwise.
 # form will be unaware of it.
 # 2018-03-08 - 
-#require 'umbra/form'    # for EventHandler !!!
+
 require 'umbra/eventhandler'         # for register_events and fire_handler etc
 require 'umbra/keymappinghandler'    # for bind_key and process_key
 
+class Module # {{{
+
+  def attr_property(*symbols)
+    symbols.each { |sym|
+      class_eval %{
+        def #{sym}=(val)
+          oldvalue = @#{sym}
+          newvalue = val
+          if @_object_created.nil?
+             @#{sym} = newvalue
+          end
+          # return(self) if oldvalue.nil? || @_object_created.nil?
+          return(self) if @_object_created.nil?
+
+          if oldvalue != newvalue
+            begin
+              fire_property_change("#{sym}", oldvalue, newvalue)
+              @#{sym} = newvalue
+            rescue PropertyVetoException
+              $log.warn "PropertyVetoException for #{sym}:" + oldvalue.to_s + "->  "+ newvalue.to_s
+            end
+          end # oldvalue !=
+          self
+        end # def
+    attr_reader sym
+      }
+    }
+  end # def
+end # module }}}
 module Umbra
 class FieldValidationException < RuntimeError
 end
@@ -14,27 +43,29 @@ class Widget
     include EventHandler
     include KeyMappingHandler
   # common interface for text related to a field, label, textview, button etc
-  attr_accessor :text, :width, :height
+  attr_property :text
+  attr_property   :width, :height   ## FIXME this won't trigger repaint or property !!!
 
   # foreground and background colors when focussed. Currently used with buttons and field
   # Form checks and repaints on entry if these are set.
-  attr_accessor :highlight_color_pair
-  attr_accessor :highlight_attr
+  attr_property :highlight_color_pair
+  attr_property :highlight_attr
 
   # NOTE: 2018-03-04 - user will have to call repaint_required if he changes color or coordinates.
-  attr_accessor  :row, :col                   # location of object
+  attr_accessor  :col                   # location of object
+  attr_writer    :row                   # location of object
   #attr_writer :color, :bgcolor               # normal foreground and background 2018-03-08 - now color_pair
   # moved to a method which calculates color 2011-11-12 
-  attr_accessor  :color_pair                  # instead of colors give just color_pair
-  attr_accessor  :attr                        # attribute bold, normal, reverse
+  attr_property  :color_pair                  # instead of colors give just color_pair
+  attr_property  :attr                        # attribute bold, normal, reverse
   attr_accessor  :name                        # name to refr to or recall object by_name
   attr_accessor :curpos                       # cursor position inside object - column, not row.
-  attr_reader  :config                        # can be used for popping user objects too
+  attr_reader  :config                        # can be used for popping user objects too. NOTE unused
   #attr_accessor  :form                       # made accessor 2008-11-27 22:32 so menu can set
   attr_accessor  :graphic                     # window which should be set by form when adding 2018-03-19
   attr_accessor :state                        # normal, selected, highlighted
   attr_reader  :row_offset, :col_offset       # where should the cursor be placed to start with
-  attr_accessor  :visible                     # boolean     # 2008-12-09 11:29 
+  attr_property  :visible                     # boolean     # 2008-12-09 11:29 
   # if changing focusable property of a field after form creation, you may need to call
   # pack again, or atl east update_focusables
   attr_reader   :focusable                   # boolean     can this get focus # 2018-03-21 - 23:13 
@@ -104,7 +135,7 @@ class Widget
   #alias :modified :set_modified
 
   # triggered whenever a widget is entered.
-  # TODO should we not fix cursor at this point ?
+  # NOTE should we not fix cursor at this point (on_enter) ?
   def on_enter
     @state = :HIGHLIGHTED    # duplicating since often these are inside containers
     @focussed = true
@@ -126,7 +157,7 @@ class Widget
   # row and col is where a widget starts. offsets usually take into account borders.
   # the offsets typically are where the cursor should be positioned inside, upon on_enter.
   def rowcol
-    return @row+@row_offset, @col+@col_offset
+    return self.row+@row_offset, self.col+@col_offset
   end
   ## return the value of the widget.
   def getvalue
@@ -144,12 +175,13 @@ class Widget
     r,c = rowcol
     $log.debug("widget repaint : r:#{r} c:#{c} col:#{@color_pair}" )
     value = getvalue_for_paint
-    len = @width || value.length
+    len = self.width || value.length
     acolor = @color_pair 
     @graphic.printstring r, c, "%-*s" % [len, value], acolor, attr()
   end
 
   def destroy
+    raise "what is this dong here still SHOULD Not be CALLED"
     $log.debug "DESTROY : widget #{@name} "
     panel = @window.panel
     Ncurses::Panel.del_panel(panel.pointer) if !panel.nil?   
@@ -186,10 +218,13 @@ class Widget
   # is the entire widget to be repainted including things like borders and titles
   # earlier took a default of true, now must be explicit. Perhaps, not used currently.
   def repaint_all(tf)
+    # NOTE NOT USED
+    raise " not used repaint all"
     @repaint_all = tf
     @repaint_required = tf
   end
   # shortcut for users to indicate that a widget should be redrawn since some property has been changed.
+  # Now that I have created attr_property this may not be needed
   def touch
     @repaint_required = true
   end
@@ -210,10 +245,34 @@ class Widget
     @_form = aform
   end
   def focusable=(bool)
-    $log.debug "  inside focusable= with #{bool} "
+    #$log.debug "  inside focusable= with #{bool} "
     @focusable = bool
     @_form.update_focusables if @_form
   end
+
+  ## TODO maybe check for decimal between 0 and 1 which will be percentage of width
+  def width
+    return nil unless @width    ## this is required otherwise checking for nil will fail
+    if @width < 0
+      return ( FFI::NCurses.COLS + @width ) - self.col + 1
+      #return ( FFI::NCurses.COLS + @width ) #- self.col + 1
+    end
+    @width
+  end
+  def height
+    return nil unless @height
+    if @height < 0
+      return ((FFI::NCurses.LINES + @height) - self.row) + 1
+      #return (FFI::NCurses.LINES + @height) 
+    end
+    @height
+  end
+  def row
+    if @row < 0
+      return FFI::NCurses.LINES + @row
+    end
+    @row
+  end
   #
   ## ADD HERE WIDGET
 end #  

data/lib/umbra/window.rb

@@ -1,22 +1,35 @@
 require 'ffi-ncurses'
 require 'ffi-ncurses/widechars'
 
+## NOTE: conflict between KEY_RESIZE and wtimeout or halfdelay.
+##  Setting a timeout or delay allows an application to respond to updates without a keypress,
+##   such as continuous updates.
+##   However, this means that KEY_RESIZE will not work unless a key is pressed.
+## If resizing is important, then caller may set $ncurses_timeout to -1.
+
+
+
+
 module Umbra
 
-  # attribute constants, use them to specify an attrib for a widget or window.
-  BOLD = FFI::NCurses::A_BOLD
-  REVERSE = FFI::NCurses::A_REVERSE
-  UNDERLINE = FFI::NCurses::A_UNDERLINE
-  NORMAL = FFI::NCurses::A_NORMAL
-
-  # color constants, use these when creating a color
-  COLOR_BLACK = FFI::NCurses::BLACK
-  COLOR_WHITE = FFI::NCurses::WHITE
-  COLOR_BLUE = FFI::NCurses::BLUE
-  COLOR_RED = FFI::NCurses::RED
-  COLOR_GREEN = FFI::NCurses::GREEN
-  COLOR_CYAN = FFI::NCurses::CYAN
-  COLOR_MAGENTA = FFI::NCurses::MAGENTA
+  ## attribute constants, use them to specify an attrib for a widget or window.
+  BOLD                  = FFI::NCurses::A_BOLD
+  REVERSE               = FFI::NCurses::A_REVERSE
+  UNDERLINE             = FFI::NCurses::A_UNDERLINE
+  NORMAL                = FFI::NCurses::A_NORMAL
+
+  ## color constants, use these when creating a color
+  COLOR_BLACK           = FFI::NCurses::BLACK
+  COLOR_WHITE           = FFI::NCurses::WHITE
+  COLOR_BLUE            = FFI::NCurses::BLUE
+  COLOR_RED             = FFI::NCurses::RED
+  COLOR_GREEN           = FFI::NCurses::GREEN
+  COLOR_CYAN            = FFI::NCurses::CYAN
+  COLOR_MAGENTA         = FFI::NCurses::MAGENTA
+
+  ## key constants
+  KEY_ENTER             = 13  ## FFI::NCurses::KEY_ENTER is 343 ???
+  KEY_RETURN            = 10  ## already defined by ffi
 
   # Initialize ncurses before any program.
   # Reduce the value of $ncurses_timeout if you want a quicker response to Escape keys or continuous updates.
@@ -125,6 +138,19 @@ module Umbra
       return @pointer
     end
 
+    ## create a window and return window, or yield window to block
+    def self.create h=0, w=0, top=0, left=0
+      win = Window.new h, w, top, left
+      return win unless block_given?
+
+      begin
+        yield win
+      ensure
+        win.destroy
+      end
+
+    end
+
     # print string at x, y coordinates. replace this with the original one below
     # @deprecated
     def printstr(str, x=0,y=0)
@@ -253,18 +279,36 @@ module Umbra
     end # }}}
     # make a box around the window. Just a wrapper
     def box
+      @box = true
       FFI::NCurses.box(@pointer, 0, 0)
     end
-    # print a centered title on top of window
+    # Print a centered title on top of window.
+    # NOTE : the string is not stored, so it can be overwritten.
     # This should be called after box, or else box will erase the title
     # @param str [String] title to print
     # @param color [Integer] color_pair 
     # @param att [Integer] attribute constant
     def title str, color=0, att=BOLD
+      ## save so we can repaint if required
+      @title_data = [str, color, att]
       strl = str.length
       col = (@width - strl)/2
       printstring(0,col, str, color, att)
     end
 
+    ## repaints windows objects like title and box.
+    ## To be called from form on pressing redraw, and SIGWINCH
+    def repaint
+      curses.wclear(@pointer)
+      if @box
+        self.box
+      end
+      if @title_data
+        str, color, att = @title_data
+        self.title str, color, att
+      end
+    end
+
+
   end # window 
 end # module