ncumbra 0.1.0 → 0.1.1

data/lib/umbra/form.rb

@@ -10,6 +10,11 @@ require 'umbra/keymappinghandler'    # for bind_key and process_key
 # has bound the key via +bind_key+.    
 # NOTE : 2018-03-08 - now using @focusables instead of @widgets in traversal.
 #        active_index is now index into focusables.
+##  Events: RESIZE (allows listener to reposition objects that have variable widths or heights)
+## NOTE: active_index: 2018-05-17 - is being set to 0 even though no field is active. Thus, first time 
+#    on_enter does not fire. It should only be set after a field is focused and its on_enter has succeeded.
+#
+
 module Umbra
 class Form 
   # array of widgets, and those that can be traversed
@@ -69,9 +74,9 @@ class Form
   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} "
+    #$log.debug "1 inside update_focusables #{@focusables.count} "
     @focusables = @widgets.select { |w| w.focusable }
-    $log.debug "2  inside update_focusables #{@focusables.count} "
+    #$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.
@@ -108,6 +113,42 @@ class Form
     self
   end
 
+  ## set focussed widget to given fld.
+  ## 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
+
+    return nil unless fld   ## no focusable
+
+    if fld.is_a? Integer
+      fld = @focusables[fld]
+    end
+
+    return unless fld.focusable
+
+    ## leave existing widget if there was one
+    fw =  @_focussed_widget
+    return if fw == fld
+
+    if fw
+      on_leave fw
+    end
+
+
+    ## enter given widget
+    on_enter fld
+    @_focussed_widget = fld
+    ix = @focusables.index fld
+    @active_index = ix
+
+    @row, @col = fld.rowcol
+    _setrowcol @row, @col 
+    repaint # 2018-03-21 - handle_key calls repaint, is this for cases not involving keypress ?
+    @window.refresh
+  end
+  alias :select_field :focussed_widget
+
 
   # form repaint,calls repaint on each widget which will repaint it only if it has been modified since last call.
   # called after each keypress and on select_field.
@@ -122,6 +163,7 @@ class Form
         f.graphic = @window unless f.graphic   # messageboxes may not have a window till very late
         f.repaint 
         f.repaint_required = false
+        f.instance_variable_set(:@_object_created, true)   ## after this property_change handlers will fire
       end
     end
 
@@ -134,10 +176,23 @@ class Form
     @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
+    end
+    return @_focussed_widget
+
   end
   alias :current_widget :get_current_field
   # take focus to first focusable field
@@ -162,7 +217,7 @@ 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 select_field ix0
+  def OLDselect_field ix0
     if ix0.is_a? Widget
       ix0 = @focusables.index(ix0)
     end
@@ -183,41 +238,27 @@ class Form
       $log.debug "inside select field ENABLED FALSE :   act #{@active_index} ix0 #{ix0}" 
     end
   end
-  ##
-  # run validate_field on a field, usually whatevers current
-  # before transferring control
-  # We should try to automate this so developer does not have to remember to call it.
-  # # @param field object
-  # @return [0, -1] for success or failure
-  # NOTE : catches exception and sets $error_message, check if -1
-  def validate_field f=@focusables[@active_index]
-    begin
-      on_leave f
-    rescue => err
-      $log.error "form: validate_field caught EXCEPTION #{err}"
-      $log.error(err.backtrace.join("\n")) 
-      #        $error_message = "#{err}" # changed 2010  
-      #$error_message.value = "#{err}" # 2018-03-18 - commented off since no Variable any longer
-      FFI::NCurses.beep
-      return -1
-    end
-    return 0
-  end
+
   # put focus on next field
   # will cycle by default, unless navigation policy not :CYCLICAL
   # in which case returns :NO_NEXT_FIELD.
-  # FIXME: in the beginning it comes in as -1 and does an on_leave of last field
   # 2018-03-07 - UMBRA: let us force user to run validation when he does next field
   def select_next_field
     return :UNHANDLED if @focusables.nil? || @focusables.empty?
-    #$log.debug "insdie sele nxt field :  #{@active_index} WL:#{@widgets.length}" 
+    index = nil
+    if @_focussed_widget
+       index = @focusables.index @_focussed_widget
+    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
-      # what is this silly hack for still here 2014-04-24 - 13:04  DELETE FIXME
-      @active_index = -1 
-      @active_index = 0     # 2018-03-08 - NOT_SURE
+      @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 TODO
+    # 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
@@ -232,6 +273,7 @@ class Form
     #
     $log.debug "inside sele nxt field : NO NEXT  #{@active_index} WL:#{@widgets.length}" 
     return :NO_NEXT_FIELD
+=end
   end
   ##
   # put focus on previous field
@@ -240,6 +282,17 @@ class Form
   # @return [nil, :NO_PREV_FIELD] nil if cyclical and it finds a field
   #  if not cyclical, and no more fields then :NO_PREV_FIELD
   def select_prev_field
+    return :UNHANDLED if @focusables.nil? or @focusables.empty?
+    index = nil
+    if @_focussed_widget
+       index = @focusables.index @_focussed_widget
+       else
+       index = @focusables.length 
+    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?
@@ -258,6 +311,7 @@ class Form
     end
 
     return :NO_PREV_FIELD
+=end
   end
 
   private
@@ -312,7 +366,7 @@ class Form
     f.on_enter if f.respond_to? :on_enter
   end
 
-  def _process_key keycode, object, window
+  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} "
@@ -338,9 +392,9 @@ class Form
   # 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. TODO: match regexes as in mapper
+  # Please update widget with any changes here. 
 
-  def process_key keycode, object
+  def OLDprocess_key keycode, object # already there in keymappinghandler
     return _process_key keycode, object, @window
   end # }}}
 
@@ -355,7 +409,6 @@ class Form
     @keys_mapped = true
   end
 
-=begin
   # repaint all # {{{
   # this forces a repaint of all visible widgets and has been added for the case of overlapping
   # windows, since a black rectangle is often left when a window is destroyed. This is internally
@@ -364,20 +417,21 @@ class Form
   # the window itself may need recreating ? 2014-08-18 - 21:03 
   def repaint_all_widgets
     $log.debug "  REPAINT ALL in FORM called "
-    raise "it has come to repaint_all"
+    #raise "it has come to repaint_all"
     @widgets.each do |w|
       next if w.visible == false
       #next if w.class.to_s == "Canis::MenuBar"
       $log.debug "   ---- REPAINT ALL #{w.name} "
-      #w.repaint_required true
-      w.repaint_all true
+      w.repaint_required = true
+      #w.repaint_all true
       w.repaint
     end
     $log.debug "  REPAINT ALL in FORM complete "
     #  place cursor on current_widget 
     _setpos
   end # }}}
-=end
+
+
   ## forms handle keys {{{
   # mainly traps tab and backtab to navigate between widgets.
   # I know some widgets will want to use tab, e.g edit boxes for entering a tab
@@ -392,42 +446,52 @@ class Form
     when -1
       #repaint # only for continuous updates, and will need to use wtimeout and not nodelay in getch
       return
-=begin
-    when 1000, 12
+    when 1000, 18  # what if someone has trapped this.
       # NOTE this works if widgets cover entire screen like text areas and lists but not in 
       #  dialogs where there is blank space. only widgets are painted.
-      # testing out 12 is C-l
+      # testing out 12 is C-l, 18 is C-r
       $log.debug " form REFRESH_ALL repaint_all HK #{ch} #{self}, #{@name} "
+      FFI::NCurses.endwin
+      @window.wrefresh    ## endwin must be followed by refresh
+      @window.repaint
       repaint_all_widgets
-      return
+      @window.wrefresh
+      return 0
     when FFI::NCurses::KEY_RESIZE  # SIGWINCH # UNTESTED XXX
+      ## NOTE: this works but boxes are not resized since hardcoded height and width were given.
+      ## 2018-05-13 - only if a layout is used, can a recalc happen.
       # note that in windows that have dialogs or text painted on window such as title or 
       #  box, the clear call will clear it out. these are not redrawn.
-      lines = FFI::NCurses.LINES
-      cols = FFI::NCurses.COLS
-      x = FFI::NCurses.stdscr.getmaxy
-      y = FFI::NCurses.stdscr.getmaxx
-      $log.debug " form RESIZE HK #{ch} #{self}, #{@name}, #{ch}, x #{x} y #{y}  lines #{lines} , cols: #{cols} "
-      #alert "SIGWINCH WE NEED TO RECALC AND REPAINT resize #{lines}, #{cols}: #{x}, #{y} "
-
+      
       # next line may be causing flicker, can we do without.
       FFI::NCurses.endwin
       @window.wrefresh
       @window.wclear
-      if @layout_manager
-        @layout_manager.do_layout
-        # we need to redo statusline and others that layout ignores
-      else
-        @widgets.each { |e| e.repaint_all(true) } # trying out
-      end
+      lines = FFI::NCurses.LINES
+      cols = FFI::NCurses.COLS
+      #x = FFI::NCurses.stdscr.getmaxy
+      x = @window.getmaxy
+      #y = FFI::NCurses.stdscr.getmaxx
+      y = @window.getmaxx
+      @window.wresize(x,y)
+      $log.debug " form RESIZE SIGWINCH HK #{ch} #{self}, #{@name}, #{ch}, x #{x} y #{y}  lines #{lines} , cols: #{cols} "
+      #alert "SIGWINCH WE NEED TO RECALC AND REPAINT resize #{lines}, #{cols}: #{x}, #{y} "
+
+      repaint_all_widgets
+      #if @layout_manager
+        #@layout_manager.do_layout
+        ## we need to redo statusline and others that layout ignores
+      #else
+      #end
       ## added RESIZE on 2012-01-5 
       ## stuff that relies on last line such as statusline dock etc will need to be redrawn.
       fire_handler :RESIZE, self 
-=end
+      @window.wrefresh
     else
       field =  get_current_field
       handled = :UNHANDLED 
       handled = field.handle_key ch unless field.nil? # no field focussable
+      ## next line "field" can print entire content of a list or table if to_s is large
       $log.debug "handled inside Form #{ch} from #{field} got #{handled}  "
       # some widgets like textarea and list handle up and down
       if handled == :UNHANDLED or handled == -1 or field.nil?

data/lib/umbra/keymappinghandler.rb

@@ -4,7 +4,7 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-04-05 - 08:34
 #      License: MIT
-#  Last update: 2018-04-17 08:59
+#  Last update: 2018-04-22 23:01
 # ----------------------------------------------------------------------------- #
 #  keymappinghandler.rb  Copyright (C) 2018 j kepler
 
@@ -74,7 +74,7 @@ module Umbra
     def _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} "
+      #$log.debug "XXX:  _process key keycode #{keycode} #{blk.class}, #{self.class} "
       return :UNHANDLED if blk.nil?
 
       if blk.is_a? Symbol
@@ -82,12 +82,12 @@ module Umbra
           return send(blk, *@_key_args[keycode])
         else
           ## 2013-03-05 - 19:50 why the hell is there an alert here, nowhere else
-          $log.error "This ( #{self.class} ) does not respond to #{blk.to_s} [PROCESS-KEY]"
+          $log.error "This ( #{self.class} ) does not respond to #{blk.to_s} [PROCESS-KEY]" if $log
           # added 2013-03-05 - 19:50 so called can know
           return :UNHANDLED 
         end
       else
-        $log.debug "rwidget BLOCK called _process_key " if $log.debug? 
+        #$log.debug "rwidget BLOCK called _process_key " if $log.debug? 
         return blk.call object,  *@_key_args[keycode]
       end
     end

data/lib/umbra/label.rb

@@ -5,7 +5,7 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-03-08 - 14:04
 #      License: MIT
-#  Last update: 2018-04-21 23:55
+#  Last update: 2018-05-22 23:36
 # ----------------------------------------------------------------------------- #
 #  label.rb  Copyright (C) 2018- j kepler
 #
@@ -16,7 +16,7 @@ module Umbra
 class Label < Widget 
 
   # justify required a display length, esp if center.
-  attr_accessor   :justify        #:right, :left, :center
+  attr_property   :justify        #:right, :left, :center
   attr_accessor   :mnemonic       # alt-key that passes focus to related field 
   attr_accessor   :related_widget # field related to this label. See +mnemonic+.
 
@@ -45,7 +45,9 @@ class Label < Widget
   def repaint
     return unless @repaint_required
     raise "Label row or col is nil #{@row} , #{@col}, #{@text} " if @row.nil? || @col.nil?
-    r,c = rowcol
+    #r,c = rowcol
+    r = self.row
+    c = self.col
     $log.debug "label repaint #{r} #{c} #{@text} "
 
     # value often nil so putting blank, but usually some application error
@@ -55,29 +57,40 @@ class Label < Widget
       value = value.join " "
     end
     # ensure we do not exceed
-    if @width
-      if value.length > @width
-        value = value[0..@width-1]
-      end
-    end
-    len = @width || value.length
+    # ## TODO do this in the format commented on 2018-05-22 - 
+    _width = self.width
+    #if _width
+      #if value.length > _width
+        #value = value[0.._width-1]
+      #end
+    #end
+    len = _width || value.length
     acolor = @color_pair  || 0
-    str = @justify.to_sym == :right ? "%*s" : "%-*s"  # added 2008-12-22 19:05 
+    #str = @justify.to_sym == :right ? "%*s" : "%-*s"  # added 2008-12-22 19:05 
+    str = @justify.to_sym == :right ? "%#{len}.#{len}s" : "%-#{len}.#{len}s"  # added 2008-12-22 19:05 
 
-    #@graphic ||= @form.window
     # clear the area
     @graphic.printstring r, c, " " * len , acolor, @attr
     if @justify.to_sym == :center
-      padding = (@width - value.length)/2
+      padding = (_width - value.length)/2
       value = " "*padding + value + " "*padding # so its cleared if we change it midway
     end
-    @graphic.printstring r, c, str % [len, value], acolor, @attr
+    ## move this into paint_label or something so we can override.
+    # try a block which was passed earlier which gets a string TODO
+    #@graphic.printstring r, c, str % [value], acolor, @attr
+    print_label @graphic, r, c, str , value, acolor, @attr
     if @mnemonic
       ulindex = value.index(@mnemonic) || value.index(@mnemonic.swapcase)
       @graphic.mvchgat(y=r, x=c+ulindex, max=1, BOLD|UNDERLINE, acolor, nil)
     end
     @repaint_required = false
   end
+
+  ## The mwthod that finally prints the label text.
+  ## Override this to do any customised printing such as multiple colors.
+  def print_label(win, row, col, format, value, _color, _attr)
+    win.printstring row, col, format % [value], _color, _attr
+  end
   # Added 2011-10-22 to prevent some naive components from putting focus here.
   def on_enter
     raise "Cannot enter Label"
@@ -86,10 +99,11 @@ class Label < Widget
     raise "Cannot leave Label"
   end
   # overriding so that label is redrawn, since this is the main property that is used.
-  def text=(_text)
-    @text = _text
-    self.touch
-  end
+  ## 2018-05-21 - we are now using attr_property so not required
+  #def text=(_text)
+    #@text = _text
+    #self.touch
+  #end
   # ADD HERE LABEL
 end # }}}
 end # module

data/lib/umbra/labeledfield.rb

@@ -4,12 +4,11 @@
 #       Author: j kepler  http://github.com/mare-imbrium/canis/
 #         Date: 2018-04-12 - 23:35
 #      License: MIT
-#  Last update: 2018-04-21 23:58
+#  Last update: 2018-05-14 14:34
 # ----------------------------------------------------------------------------- #
 #  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 ???
   #
@@ -30,15 +29,15 @@ module Umbra
     # 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  
+    attr_property :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_property :lrow, :lcol        # coordinates of the label
+    attr_property :label_color_pair   # label of field  color_pair
+    attr_property :label_attr         # label of field  attribute
+    attr_property :label_highlight_color_pair   # label of field  high color_pair
+    attr_property :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