ncumbra 0.1.1 → 0.1.2

data/examples/ex1.rb

@@ -70,18 +70,17 @@ begin
     when FFI::NCurses::KEY_UP
     when FFI::NCurses::KEY_DOWN
     end
-    #FIXME after scrolling, pointer is showing wrong file here
     statusline(win, "Pressed #{ch} on     ", 70)
     win.wrefresh
   end
 
 rescue Object => e
-  @window.destroy if @window
+  win.destroy if win
   FFI::NCurses.endwin
   puts e
   puts e.backtrace.join("\n")
 ensure
-  @window.destroy if @window
+  win.destroy if win
   FFI::NCurses.endwin
   puts 
 end

data/examples/ex3.rb

@@ -84,18 +84,17 @@ begin
       message_label.text = "UNToggle button was pressed"
     end
     # we need this since we have done away with dsl_property
-    message_label.repaint_required = true
+    #message_label.repaint_required = true
   end
   form.add_widget togglebutton 
 
-  check = Checkbox.new text: "No Frames", value: true, row: row+1, col: col, mnemonic: "N"
+  check =  Checkbox.new text: "No Frames", value: true,  row: row+1, col: col, mnemonic: "N"
   check1 = Checkbox.new text: "Use https", value: false, row: row+2, col: col, mnemonic: "U"
   row += 2
   form.add_widget check, check1
   [ check, check1 ].each do |cb|
     cb.command do 
       message_label.text = "#{cb.text} is now #{cb.value}"
-      message_label.repaint_required = true
     end
   end
 

data/examples/ex4.rb

@@ -66,7 +66,6 @@ begin
         #lb.border false
         box.title = "Untoggled"
       end
-      box.repaint_required = true
     end
     # bind the most common event for a listbox which is ENTER_ROW
     lb.command do |ix|
@@ -105,7 +104,7 @@ begin
     end
     # bind to another event of listbox
     lb.bind_event(:LEAVE_ROW) { |ix| statusline(win, "LEFT ROW #{ix.first}", 50) }
-    lb.bind_event(:LIST_SELECTION_EVENT) { |w| alert("You selected row #{w.selected_index || "none"} ") }
+    lb.bind_event(:SELECT_ROW) { |w| alert("You selected row #{w.selected_index || "none"} ") }
     form.add_widget box, lb
     form.add_widget tb
     form.add_widget ab

data/examples/ex5.rb

@@ -62,10 +62,11 @@ begin
       else
         box.justify = :left
       end
-      box.repaint_required  = true
+      #box.repaint_required  = true
     end
-    lb.bind_event(:CURSOR_MOVE) {|arr|
-      col_offset , current_index, curpos,  pcol = arr
+    #lb.bind_event(:CURSOR_MOVE) {|arr|
+    lb.bind_event(:CURSOR_MOVE) {|lb|
+      col_offset , current_index, curpos,  pcol = lb.col_offset, lb.current_index, lb.curpos, lb.panned_cols
       blen = lb.current_row().size
       statusline(win, "offset: #{col_offset} , curpos: #{curpos} , currind: #{current_index} , pcol #{pcol}, len:#{blen}.....", 20)
     }

data/examples/exbox.rb

@@ -104,7 +104,7 @@ begin
     end
     # bind to another event of listbox
     lb.bind_event(:LEAVE_ROW) { |ix| statusline(win, "LEFT ROW #{ix.first}", 50) }
-    lb.bind_event(:LIST_SELECTION_EVENT) { |w| alert("You selected row #{w.selected_index || "none"} ") }
+    lb.bind_event(:SELECT_ROW) { |w| alert("You selected row #{w.selected_index || "none"} ") }
     form.add_widget lb, lb2
     form.add_widget tb
     form.add_widget ab

data/examples/extab3.rb

@@ -5,7 +5,7 @@
 #       Author: j kepler  http://github.com/mare-imbrium/umbra/
 #         Date: 2018-05-11
 #      License: MIT
-#  Last update: 2018-05-23 08:34
+#  Last update: 2018-06-01 12:26
 # ----------------------------------------------------------------------------- #
 #  extab3.rb  Copyright (C) 2018 j kepler
 require 'umbra'
@@ -127,7 +127,6 @@ def _filter_table(lb, columns, fields)
   $log.debug "  ibv:  #{bind_vars.join ', '} "
   alist = @db.execute( sql, bind_vars)
   if alist #and !alist.empty?
-    #lb.list = alist   ## results in error, FIXME
     lb.data = alist
   else
     #alert "No rows returned. Check your query"

data/lib/umbra.rb

@@ -65,6 +65,7 @@ module Umbra
   end
 
   ## create a logger instance given a path, return the logger
+  ## NOTE: Ideally would like to set $log here to this, but what if user creates multiple.
   def create_logger path, config={}
     require 'logger'
     _path   = File.open(path, File::WRONLY|File::TRUNC|File::CREAT) 
@@ -86,6 +87,7 @@ module Umbra
     while true
       catch :close do
         while( ch = win.getkey) != 999
+          next if ch == -1      ## should we put this here ???
           begin
             if ch == curses::KEY_CTRL_Q
               stopping = true 

data/lib/umbra/box.rb

@@ -4,7 +4,7 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-04-07
 #      License: MIT
-#  Last update: 2018-05-22 14:44
+#  Last update: 2018-05-27 16:14
 # ----------------------------------------------------------------------------- #
 #  box.rb  Copyright (C) 2018 j kepler
 module Umbra
@@ -33,7 +33,7 @@ module Umbra
       #@int_width  = @width  - 2
       @int_width  = self.width  - 2
       @hlines = []
-      @vlines = []
+      #@vlines = []   # UNUSED. TODO ???
     end
     def repaint
       return unless @visible
@@ -44,9 +44,10 @@ module Umbra
       end
       # what about asking for painting of widgets
     end
-    # should we take in an array and apportion them 
-    # since we are keeping a row in between as divider, need to adjust heights.
-    # Depending on how many components
+
+    ## 
+    ## Add a variable list of components to a box, which are stacked horizontally by the box.
+    ## @param comma separated list of widgets
     def add *w
       @widgets = w
       num = w.size
@@ -65,8 +66,14 @@ module Umbra
       # FIXME there will be one additional hline in the end.
       w[-1].height -= (num-1)
     end
-    # this is best used for widgets that can be resized.
-    # Prefer not to use for buttons since the looks gets messed (inconsistency betwewn button and highlight).
+    alias :stack :add
+
+
+    ##
+    ##  Horizontally place an array of widgets 
+    ## @param comma separated list of widgets
+    ## NOTE:  this is best used for widgets that can be resized.
+    # Prefer not to use for buttons since the looks gets messed (inconsistency between button and highlight).
     # Therefore now, button calculates its own width which means that this program cannot determine what the width is
     # and thus cannot center it.
     def flow *w
@@ -90,7 +97,11 @@ module Umbra
       # we added 1 to the scol each time, so decrement
       w[-1].width -= (num-1)
     end
-    # use if only one widget will expand into this box
+
+
+    ## Fill out a single widget into the entire box leaving an inset of 1.
+    ## @param [Widget]
+    # NOTE: use if only one widget will expand into this box
     def fill w
       # should have been nice if I could add widget to form, but then order might get wrong
       w.row = self.row + 1
@@ -111,6 +122,10 @@ module Umbra
       end
       @widget = w
     end
+
+    ## paint a horizontal line, as a separator between widgets
+    ## param [Integer] row - row
+    ## param [Integer] col - column
     def hline row, col
       return if row >= self.row + self.height
       $log.debug "  hline: #{row} ... #{@row}   #{@height}  "
@@ -118,7 +133,6 @@ module Umbra
     end
 
     # print a title over the box on zeroth row
-    # TODO right or  left or center align
     private def print_title stitle
       return unless stitle
       stitle = "| #{stitle} |"

data/lib/umbra/button.rb

@@ -5,39 +5,43 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-03-16 
 #      License: MIT
-#  Last update: 2018-04-07 23:07
+#  Last update: 2018-06-01 12:37
 # ----------------------------------------------------------------------------- #
 #  button.rb  Copyright (C) 2012-2018 j kepler
-#  == TODO 
+#  == Todo 
 #  - mnemonics with highlighting
 #  - default button
 require 'umbra/widget'
 #  ----------------
 module Umbra
+
+
   class Button < Widget 
     attr_accessor :surround_chars   # characters to use to surround the button, def is square brackets
+
     # char to be underlined, and bound to Alt-char
     attr_accessor :mnemonic
+
+
     def initialize config={}, &block
       @focusable = true
       @editable = false
       @highlight_attr = REVERSE
-      # hotkey denotes we should bind the key itself not alt-key (for menulinks)
-      #@hotkey = config.delete(:hotkey)  2018-03-22 - 
-      # 2018-03-18 - FORM_ATTACHED deprecated to keep things simple
+      
       register_events([:PRESS])
-      @default_chars = ['> ', ' <'] # a default button is painted differently
+      @default_chars = ['> ', ' <'] # a default button is painted differently. UNUSED. ???
       super
 
-
       @surround_chars ||= ['[ ', ' ]'] 
       @col_offset = @surround_chars[0].length 
       @text_offset = 0      # used to determine where underline should fall TODO ???
       map_keys
     end
+
+
     ##
     # set button based on Action
-    # 2018-03-22 - is this still used ?
+    # 2018-03-22 - is this still used ? XXX
     # This allows action objects to be used in multiple places such as buttons, menus, popups etc.
     def action a
       text a.name
@@ -91,16 +95,11 @@ module Umbra
         @repaint_required = false
     end
 
-    ## command of button (invoked on press, hotkey, space)
-    # added args 2008-12-20 19:22 
-    def command *args, &block
-      bind_event :PRESS, *args, &block
-    end
     ## fires PRESS event of button
     def fire
-      #$log.debug "firing PRESS #{text}"
       fire_handler :PRESS, ActionEvent.new(self, :PRESS, text)
     end
+
     # for campatibility with all buttons, will apply to radio buttons mostly
     def selected?; false; end
 

data/lib/umbra/checkbox.rb

@@ -4,7 +4,7 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-04-01 - 16:08
 #      License: MIT
-#  Last update: 2018-05-14 14:34
+#  Last update: 2018-05-28 12:06
 # ----------------------------------------------------------------------------- #
 #  checkbox.rb  Copyright (C) 2012-2018 j kepler
 module Umbra
@@ -12,8 +12,8 @@ module Umbra
   # A checkbox, may be selected or unselected
   #
   class Checkbox < ToggleButton 
-    attr_property :align_right    # the button will be on the right 2008-12-09 23:41 
-    # if a variable has been defined, off and on value will be set in it (default 0,1)
+    attr_property :align_right    # the button will be on the right of the text
+
     def initialize config={}, &block
       @surround_chars = ['[', ']']    # 2008-12-23 23:16 added space in Button so overriding
       super

data/lib/umbra/eventhandler.rb

@@ -73,11 +73,10 @@ module Umbra
               raise pve
             rescue => ex
               ## some don't have name
-              # FIXME this should be displayed somewhere. It just goes into log file quietly.
               $log.error "======= Error ERROR in block event #{self}:  #{event}"
               $log.error ex
               $log.error(ex.backtrace.join("\n")) 
-              alert ex.to_s    # added 2018-04-08 - 08:55 so it shows up
+              alert ex.to_s
               FFI::NCurses.beep    # doesn't do anything, maybe switched off in preferences
             end
           end
@@ -112,8 +111,8 @@ module Umbra
         else
           @pce.set( self, text, oldvalue, newvalue)
         end
-        fire_handler :PROPERTY_CHANGE, @pce
         @repaint_required = true 
+        fire_handler :PROPERTY_CHANGE, @pce
       end
 
   ## Created and sent to all listeners whenever a property is changed

data/lib/umbra/field.rb

@@ -4,7 +4,7 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-03
 #      License: MIT
-#  Last update: 2018-05-17 12:20
+#  Last update: 2018-05-26 11:21
 # ----------------------------------------------------------------------------- #
 #  field.rb  Copyright (C) 2012-2018 j kepler
 #
@@ -37,7 +37,7 @@ class InputDataEvent # {{{
   end
 end # }}}
   # Text edit field
-#  TODO :
+#  Todo :
   # NOTE: +width+ is the length of the display whereas +maxlen+ is the maximum size that the value 
   # can take. Thus, +maxlen+ can exceed +width+. Currently, +maxlen+ defaults to +width+ which 
   # defaults to 20.
@@ -45,7 +45,11 @@ end # }}}
   # == Example
   #     f = Field.new  text: "Some value", row: 10, col: 2
   #
-  # Field introduces an event :CHANGE which is fired for each character deleted or inserted
+# Field introduces an event :CHANGE which is fired for each character deleted or inserted.
+##
+# ## Use the :CHANGED event handler for custom validations and throw a +FieldValidationException+ if 
+# ##  the validation fails. This is called in the +on_leave+. You may pass a block to the +command+ method
+## for the same functionality.
   #  
   module Umbra
   class Field < Widget 
@@ -82,10 +86,10 @@ end # }}}
     attr_accessor :overwrite_mode              # true or false INSERT OVERWRITE MODE
 
     # column on which field printed, usually the same as +col+ unless +label+ used.
-    # Required by +History+ to popup field history.
+    # Required by +History+ to popup field history. UNUSED.
     attr_reader :field_col                     # column on which field is printed
                                                # required due to labels. Is updated after printing
-    #                                          # so can be nil if accessed early 2011-12-8 
+    #                                          # so can be nil if accessed early 
 
     def initialize config={}, &block
       @buffer = String.new
@@ -262,15 +266,12 @@ end # }}}
   
 
     public
-  ## Note that some older widgets like Field repaint every time the form.repaint
-  ##+ is called, whether updated or not. I can't remember why this is, but
-  ##+ currently I've not implemented events with these widgets. 2010-01-03 15:00 
 
   def repaint
-    return unless @repaint_required  # 2010-11-20 13:13 its writing over a window i think TESTING
+    return unless @repaint_required
     $log.debug("repaint FIELD: #{name}, r:#{row} c:#{col},wid:#{width},maxlen: #{@maxlen},pcol:#{@pcol},  #{focusable} st: #{@state} ")
     @width = 1 if width == 0
-    printval = getvalue_for_paint().to_s # added 2009-01-06 23:27 
+    printval = getvalue_for_paint().to_s
     printval = mask()*printval.length unless @mask.nil?
     if !printval.nil? 
       if printval.length > width # only show maxlen
@@ -329,8 +330,10 @@ end # }}}
     return if @delete_buffer.nil?
     #oldvalue = @buffer
     @buffer.insert @curpos, @delete_buffer 
-    fire_handler :CHANGE, InputDataEvent.new(@curpos,@curpos+@delete_buffer.length, self, :INSERT, 0, @delete_buffer)     # 2010-09-11 13:01 
+    fire_handler :CHANGE, InputDataEvent.new(@curpos,@curpos+@delete_buffer.length, self, :INSERT, 0, @delete_buffer)     
   end
+
+
   ## 
   # position cursor at start of field
   def cursor_home
@@ -435,7 +438,7 @@ end # }}}
       addcol -1 if adjust # move visual cursor back
       @modified = true
     end
-    # upon leaving a field
+    # Upon leaving a field
     # returns false if value not valid as per values or valid_regex
     # 2008-12-22 12:40 if null_allowed, don't validate, but do fire_handlers
     def on_leave
@@ -457,8 +460,13 @@ end # }}}
         if !in_range?(val)
           raise FieldValidationException, "Field not matching range #{@valid_range}, above #{@above} or below #{@below}  "
         end
+        
+        ## 2018-05-24 - seems we were not calling the :CHANGED listeners at all.
+        fire_handler :CHANGED, self
+
       end
       # here is where we should set the forms modified to true - 2009-01
+      ## 2018-05-26 - what is the point of this ? 
       if modified?
         @modified = true
       end
@@ -488,6 +496,7 @@ end # }}}
     end
     ##
     # overriding widget, check for value change
+    # 2018-05-26 - WHAT IS THE POINT of setting @modified if we have a different logic here
     def modified?
       getvalue() != @original_value
     end
@@ -495,6 +504,8 @@ end # }}}
     def text
       getvalue
     end
+
+    ## set default value of field
     def text=(val)
       return unless val # added 2010-11-17 20:11, dup will fail on nil
       # will bomb on integer or float etc !!

data/lib/umbra/form.rb

@@ -41,6 +41,7 @@ class Form
     @active_index = nil
     @row = @col = 0                    # 2018-03-07 - umbra
     @focusables = []                   # focusable components
+    register_events(:RESIZE)
     instance_eval &block if block_given?
     @name ||= ""                       # for debugging 
 
@@ -48,6 +49,8 @@ class Form
     #$error_message ||= Variable.new ""
 
     map_keys unless @keys_mapped
+    $log ||= create_logger '/dev/null'    ## FIXME temporarily adding here. If user has not 
+                                          ##  specified a logger, create a quiet one.
   end
   ##
   # Add given widget to widget list and returns self
@@ -59,6 +62,7 @@ class Form
       next if @widgets.include? w
       # NOTE: if form created with nil window (messagebox), then this would have to happen later
       w.graphic = @window if @window # 2018-03-19 - prevent widget from needing to call form back
+      $log.warn "Window is nil in form.add_widget" unless @window
       w._form = self    # 2018-04-20 - so that update_focusables can be called.
       @widgets << w
     end
@@ -72,12 +76,15 @@ class Form
     @widgets.delete widget
     @focusables.delete widget
   end
+
+
   # maintain a list of focusable objects so form can traverse between them easily.
   def update_focusables
     #$log.debug "1 inside update_focusables #{@focusables.count} "
     @focusables = @widgets.select { |w| w.focusable }
     #$log.debug "2  inside update_focusables #{@focusables.count} "
   end
+
   # Decide layout of objects. User has to call this after creating components
   # More may come here.
   def pack
@@ -117,7 +124,7 @@ class Form
   ## This ensures that whenever a widget is given focus, the on_leave of the previous widget 
   ##   is called, and the on_enter of this field is called.
   ## 2018-05-18 - rewrite of select_field which did not call on_leave
-  def focussed_widget fld
+  def select_widget fld
 
     return nil unless fld   ## no focusable
 
@@ -147,7 +154,7 @@ class Form
     repaint # 2018-03-21 - handle_key calls repaint, is this for cases not involving keypress ?
     @window.refresh
   end
-  alias :select_field :focussed_widget
+  alias :select_field :select_widget
 
 
   # form repaint,calls repaint on each widget which will repaint it only if it has been modified since last call.
@@ -175,29 +182,26 @@ class Form
     end
     @window.wrefresh
   end
+
+
+
   # @return [Widget, nil] current field, nil if no focusable field
   ## NOTE 2018-05-17 - this is called by form in the very beginning when no field is actually focussed
   ##   but active_index has been set to 0, so the on_enter has not been executed, but the handle_key
   ##   is invoked.
   def get_current_field
-=begin
-    #select_next_field if @active_index == -1
-    return nil if @active_index.nil?   # for forms that have no focusable field 2009-01-08 12:22 
-    @focusables[@active_index]
-=end
-
 
     ##  rewrite on 2018-05-18 - so that on_enter is called for first field
     if @_focussed_widget.nil?             ## when form handle_key first called
-      focussed_widget @focusables.first
+      select_widget @focusables.first
     end
     return @_focussed_widget
 
   end
   alias :current_widget :get_current_field
+
+
   # take focus to first focusable field
-  # we shoud not send to select_next. have a separate method to avoid bugs.
-  # but check current_field, in case called from anotehr field TODO FIXME
   def select_first_field
     select_field 0
   end
@@ -213,31 +217,6 @@ class Form
 
 
 
-  ##
-  # puts focus on the given field/widget index
-  # @param index of field in @widgets (or can be a Widget too)
-  # XXX if called externally will not run a on_leave of previous field
-  def OLDselect_field ix0
-    if ix0.is_a? Widget
-      ix0 = @focusables.index(ix0)
-    end
-    return if @focusables.nil? or @focusables.empty?
-    $log.debug "inside select_field :  #{ix0} ai #{@active_index}" 
-    f = @focusables[ix0]
-    return if !f.focusable
-    if f.focusable
-      @active_index = ix0
-      @row, @col = f.rowcol
-      on_enter f
-      # the wmove will be overwritten by repaint later, better to set row col
-      _setrowcol @row, @col # 2018-03-21 - maybe this should be set after the repaint
-
-      repaint # 2018-03-21 - handle_key calls repaint, is this for cases not involving keypress ?
-      @window.refresh
-    else
-      $log.debug "inside select field ENABLED FALSE :   act #{@active_index} ix0 #{ix0}" 
-    end
-  end
 
   # put focus on next field
   # will cycle by default, unless navigation policy not :CYCLICAL
@@ -251,30 +230,10 @@ class Form
     end
     index = index ? index+1 : 0
     index = 0 if index >= @focusables.length # CYCLICAL 2018-03-11 - 
-    focussed_widget @focusables[index]
-=begin
-    return :UNHANDLED if @focusables.nil? || @focusables.empty?
-    if @active_index.nil?  || @active_index == -1 # needs to be tested out A LOT
-      @active_index = 0     
-    end
-    f = @focusables[@active_index]
-    # we need to call on_leave of this field or else state will never change back to normal
-    on_leave f
-    #index = @focusables.index(f)
-    index = @active_index
-    index = index ? index+1 : 0
-    #f = @focusables[index]
-    index = 0 if index >= @focusables.length # CYCLICAL 2018-03-11 - 
-    f = @focusables[index]
-    if f
-      select_field f 
-      return 0
-    end
-    #
-    $log.debug "inside sele nxt field : NO NEXT  #{@active_index} WL:#{@widgets.length}" 
-    return :NO_NEXT_FIELD
-=end
+    select_widget @focusables[index]
   end
+
+
   ##
   # put focus on previous field
   # will cycle by default, unless navigation policy not :CYCLICAL
@@ -291,27 +250,7 @@ class Form
     end
     index -= 1
     index = @focusables.length-1 if index < 0 # CYCLICAL 2018-03-11 - 
-    focussed_widget @focusables[index]
-=begin
-    return :UNHANDLED if @focusables.nil? or @focusables.empty?
-    #$log.debug "insdie sele prev field :  #{@active_index} WL:#{@widgets.length}" 
-    if @active_index.nil?
-      @active_index = @focusables.length 
-    end
-
-    f = @focusables[@active_index]
-    on_leave f
-    index = @active_index
-    index -= 1
-    index = @focusables.length-1 if index < 0 # CYCLICAL 2018-03-11 - 
-    f = @focusables[index]
-    if f
-      select_field f
-      return
-    end
-
-    return :NO_PREV_FIELD
-=end
+    select_widget @focusables[index]
   end
 
   private
@@ -366,37 +305,8 @@ class Form
     f.on_enter if f.respond_to? :on_enter
   end
 
-  def OLD_process_key keycode, object, window
-    return :UNHANDLED if @_key_map.nil?
-    blk = @_key_map[keycode]
-    $log.debug "XXX:  _process key keycode #{keycode} #{blk.class}, #{self.class} "
-    return :UNHANDLED if blk.nil?
-
-    if blk.is_a? Symbol
-      if respond_to? blk
-        return send(blk, *@_key_args[keycode])
-      else
-        ## 2013-03-05 - 19:50 why the hell is there an alert here, nowhere else
-        alert "This ( #{self.class} ) does not respond to #{blk.to_s} [PROCESS-KEY]"
-        # added 2013-03-05 - 19:50 so called can know
-        return :UNHANDLED 
-      end
-    else
-      $log.debug "rwidget BLOCK called _process_key " if $log.debug? 
-      return blk.call object,  *@_key_args[keycode]
-    end
-  end # }}}
 
   public
-  # e.g. process_key ch, self {{{
-  # returns UNHANDLED if no block for it
-  # after form handles basic keys, it gives unhandled key to current field, if current field returns
-  # unhandled, then it checks this map.
-  # Please update widget with any changes here. 
-
-  def OLDprocess_key keycode, object # already there in keymappinghandler
-    return _process_key keycode, object, @window
-  end # }}}
 
   #
   # NOTE: These mappings will only trigger if the current field