canis 0.0.4

data/lib/canis/core/include/layouts/abstractlayout.rb

@@ -0,0 +1,213 @@
+# ----------------------------------------------------------------------------- #
+#         File: abstractlayout.rb
+#  Description: An abstract class for other concrete layouts to subclass
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2014-05-09 - 17:15
+#      License: MIT
+#  Last update: 2014-05-09 20:38
+# ----------------------------------------------------------------------------- #
+#  abstractlayout.rb  Copyright (C) 2012-2014 j kepler
+
+
+class AbstractLayout
+  attr_accessor :form
+  # top and left are actually row and col in widgets
+  # 
+  attr_accessor :top_margin, :left_margin, :right_margin, :bottom_margin
+  # if width percent is given, then it calculates and overwrites width. Same for height_pc
+  # The _pc values should be between 0 and 1, e.g 0.8 for 80 percent
+  # height and width can be negaive. -1 will stretch the stack to one less than end. 0 will stretch till end.
+  attr_accessor :width, :height, :width_pc, :height_pc
+  # gp between objects
+  attr_accessor :gap
+  attr_accessor :components
+  attr_accessor :ignore_list
+
+  # @param [Form]  optional give a form      
+  # @param [Hash]  optional give settings/attributes which will be set into variables
+  def initialize form, config={}, &block
+    @width = @height = 0
+    @top_margin = @left_margin = @right_margin = @bottom_margin = 0
+    # weightages of each object
+    #@wts = {}
+    # item_config is a hash which contains a hash of attibs for each item.
+    @item_config = Hash.new do |hash, key| hash[key]={}; end
+
+    if form.is_a? Hash
+      @config = form
+    elsif form.is_a? Form
+      @form = form
+    end
+    @gap = 0
+    @ignore_list = ["canis::statusline", "canis::applicationheader"]
+    @config.each_pair { |k,v| instance_variable_set("@#{k}",v) }
+    #@ignore_list = [Canis::StatusLine, Canis::ApplicationHeader]
+    instance_eval &block if block_given?
+  end
+
+  # add one more items for this layout to lay out
+  # If no items are given, this program will take all visible widgets from the form
+  # and stack them, ignoring statusline and applicationheader
+  def push *items
+    @components ||= []
+    @components.push items
+    self
+  end
+  alias :<< :push
+
+  # add a widget giving a hash of attributes to be used later.
+  def add item, config={}
+    @components ||= []
+    @components << item
+    if config
+      @item_config[item] = config
+    end
+    self
+  end
+
+  def configure_item item, config={}
+    @item_config[item].merge( config )
+    self
+  end
+  # return the config value for a key for an item.
+  # The keys are decided by the layout manager itself, such as :weight.
+  # @param [Widget] item for which some attribute is required
+  # @param [Symbol, String] the key
+  def cget item, key
+    return @item_config[item][key]
+  end
+
+  # set a value for an item and key
+  # This is similar to configure_item which takes multiple pairs ( a hash).
+  # I am seeing which will be more useful.
+  def cset item, key, val
+    @item_config[item][key] = val
+    self
+  end
+
+
+  # Add a component, giving a weightage for height
+  # @param [Fixnum, Float] give absolute weight, or fraction of layouts height
+  # if wt is >= 1 then it is absolute height, else if between 0 and 1 ,
+  # it is a percentage.
+  def add_with_weight item, weight
+    @components ||= []
+    @components << item
+    cfg[item][:weight] = weight
+  end
+
+  # remove given item from components list
+  # This could happen if the item has been removed from the form
+  def remove item
+    @components.remove item
+  end
+
+  # clear the list of items the layout has.
+  # Usually, the layout fills this list only once. However, if the list of items has changed
+  # then this can be used to clear the list, so it is fetched again.
+  def clear
+    @components.clear
+  end
+
+  # does some initial common calculations that hopefully should be common across layouters
+  # so that do_layout can be ovveridden while calling this.
+  def _init_layout
+    # when user gives a negative value, we recalc and overwrite so the need to save, for a redraw.
+    @saved_width ||= @width
+    @saved_height ||= @height
+
+    lines = Ncurses.LINES - 1
+    columns = Ncurses.COLS - 1
+    if @height_pc
+      @height = ((lines - @top_margin - @bottom_margin) * @height_pc).floor
+    elsif @saved_height <= 0
+      @height = lines - @saved_height - @top_margin - @bottom_margin
+    end
+    $log.debug "  layout height = #{@height} "
+    if @width_pc
+      @width = ((columns - @left_margin - @right_margin) * width_pc).floor
+    elsif @saved_width <= 0
+      # if width was -1 we have overwritten it so now we cannot recalc it. it remains the same
+      @width = columns - @saved_width - @left_margin - @right_margin
+    end
+    $log.debug "  layout wid = #{@width} "
+    # if user has not specified, then get all the objects
+    @components ||= @form.widgets.select do |w| w.visible != false && !@ignore_list.include?(w.class.to_s.downcase); end
+    $log.debug "  components #{@components.count} "
+  end
+
+  # This program lays out the widgets deciding their row and columm and height and weight.
+  # This program is called once at start of application, and again whenever a RESIZE event happens.
+  def do_layout
+    $log.debug "  inside do_layout"
+    _init_layout
+    raise "please implement this in your subclass "
+    c = @left_margin
+    # determine fixed widths and how much is left to share with others,
+    # and how many variable width components there are.
+    ht = 0   # accumulate fixed height
+    fixed_ctr = 0 # how many items have a fixed wt
+    var_ctr = 0
+    var_wt = 0.0
+    @components.each do |e|
+      $log.debug "  looping 1 #{e.name} "
+      _tmpwt = @wts[e] || 0
+      # what of field and button placed side by side
+      if e.is_a? Field or e.is_a? Button or e.is_a? Label
+        @wts[e] ||= 1
+        ht += @wts[e] || 1
+        fixed_ctr += 1
+      elsif _tmpwt >= 1
+          ht += @wts[e] || 0
+          fixed_ctr += 1
+      elsif _tmpwt > 0 and _tmpwt <= 1
+        # FIXME how to specify 100 % ???
+        var_ctr += 1
+        var_wt += @wts[e]
+      end
+    end
+    unaccounted = @components.count - (fixed_ctr + var_ctr)
+    $log.debug "  unacc #{unaccounted} , fixed #{fixed_ctr} , var : #{var_ctr} , ht #{ht} height #{@height}  "
+    balance_ht = @height - ht # use this for those who have specified a %
+    balance_ht1 = balance_ht * (1 - var_wt )
+    average_ht = (balance_ht1 / unaccounted).floor # give this to those who have not specified ht
+    average_ht = (balance_ht1 / unaccounted) # give this to those who have not specified ht
+    $log.debug "  #{balance_ht} , #{balance_ht1} , #{average_ht} "
+    # not accounted for gap in heights
+    rem = 0 # remainder to be carried over
+    @components.each do |e|
+      $log.debug "  looping 2 #{e.name} #{e.class.to_s.downcase} "
+      next if @ignore_list.include? e.class.to_s.downcase
+      $log.debug "  looping 3 #{e.name} "
+      e.row = r
+      e.col = c
+      wt = @wts[e]
+      if wt
+        if wt.is_a? Fixnum
+          e.height = wt
+        elsif wt.is_a? Float
+          e.height = (wt * balance_ht).floor
+        end
+      else
+        # no wt specified, give average of balance wt
+        e.height = average_ht
+        hround = e.height.floor
+
+        rem += e.height - hround
+        e.height = hround
+        # see comment in prev block regarding remaininder
+        if rem >= 1
+          e.height += 1
+          rem = 0
+        end
+      end
+      $log.debug "  layout #{e.name} , h: #{e.height} r: #{e.row} , c = #{e.col} "
+
+      e.width = @width
+      r += e.height.floor
+      r += @gap
+    end
+    $log.debug "  layout finished "
+  end
+
+end

data/lib/canis/core/include/layouts/flowlayout.rb

@@ -0,0 +1,104 @@
+# ----------------------------------------------------------------------------- #
+#         File: stacklayout.rb
+#  Description: 
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2014-05-08 - 18:33
+#      License: MIT
+#  Last update: 2014-05-09 20:58
+# ----------------------------------------------------------------------------- #
+#  stacklayout.rb  Copyright (C) 2012-2014 j kepler
+require 'canis/core/include/layouts/abstractlayout'
+#  ---- 
+#  This does a simple left to right stacking of objects. 
+#  if no objects are passed to it, it will take all widgets from the form.
+#
+#  Individual objects may be configured by setting :weight using +cset+.
+#       layout = FlowLayout.new :height => -1, :top_margin => 1, :bottom_margin => 1, :left_margin => 1
+#       layout.cset(obj,  :weight, 15)   # fixed width of 15
+#       layout.cset(obj1, :weight, 0.50)  # takes 50% of balance area (area not fixed)
+#  
+class FlowLayout < AbstractLayout
+
+  # @param [Form]  optional give a form      
+  # @param [Hash]  optional give settings/attributes which will be set into variables
+  def initialize arg, config={}, &block
+    super
+  end
+
+
+  # This program lays out the widgets deciding their row and columm and height and weight.
+  # This program is called once at start of application, and again whenever a RESIZE event happens.
+  def do_layout
+    _init_layout
+    r = @top_margin
+    c = @left_margin
+    #
+    # determine fixed widths and how much is left to share with others,
+    # and how many variable width components there are.
+    ht = 0   # accumulate fixed height
+    fixed_ctr = 0 # how many items have a fixed wt
+    var_ctr = 0
+    var_wt = 0.0
+    @components.each do |e|
+      $log.debug "  looping 1 #{e.name} "
+      _tmpwt = cget(e, :weight) || 0
+      # what of field and button placed side by side
+      if e.is_a? Field or e.is_a? Button or e.is_a? Label
+        # what to do here ?
+        @wts[e] ||= 1
+        ht += @wts[e] || 1
+        fixed_ctr += 1
+      elsif _tmpwt >= 1
+          ht += _tmpwt || 0
+          fixed_ctr += 1
+      elsif _tmpwt > 0 and _tmpwt <= 1
+        # FIXME how to specify 100 % ???
+        var_ctr += 1
+        var_wt += _tmpwt
+      end
+    end
+    unaccounted = @components.count - (fixed_ctr + var_ctr)
+    $log.debug "  unacc #{unaccounted} , fixed #{fixed_ctr} , var : #{var_ctr} , ht #{ht} height #{@height}  "
+    balance_ht = @width - ht # use this for those who have specified a %
+    balance_ht1 = balance_ht * (1 - var_wt )
+    average_ht = (balance_ht1 / unaccounted).floor # give this to those who have not specified ht
+    average_ht = (balance_ht1 / unaccounted) # give this to those who have not specified ht
+    $log.debug "  #{balance_ht} , #{balance_ht1} , #{average_ht} "
+    # not accounted for gap in heights
+    rem = 0 # remainder to be carried over
+    @components.each do |e|
+      $log.debug "  looping 2 #{e.name} #{e.class.to_s.downcase} "
+      next if @ignore_list.include? e.class.to_s.downcase
+      $log.debug "  looping 3 #{e.name} "
+      e.row = r
+      e.col = c
+      wt = cget(e, :weight)
+      if wt
+        if wt.is_a? Fixnum
+          e.width = wt
+        elsif wt.is_a? Float
+          e.width = (wt * balance_ht).floor
+        end
+      else
+        # no wt specified, give average of balance wt
+        e.width = average_ht
+        hround = e.width.floor
+
+        rem += e.width - hround
+        e.width = hround
+        # see comment in prev block regarding remaininder
+        if rem >= 1
+          e.width += 1
+          rem = 0
+        end
+      end
+      $log.debug "  layout #{e.name} , w: #{e.width} r: #{e.row} , c = #{e.col} "
+
+      e.height = @height
+      c += e.width.floor
+      c += @gap
+    end
+    $log.debug "  layout finished "
+  end
+
+end

data/lib/canis/core/include/layouts/stacklayout.rb

@@ -0,0 +1,109 @@
+# ----------------------------------------------------------------------------- #
+#         File: stacklayout.rb
+#  Description: 
+#       Author: j kepler  http://github.com/mare-imbrium/canis/
+#         Date: 2014-05-08 - 18:33
+#      License: MIT
+#  Last update: 2014-05-09 19:58
+# ----------------------------------------------------------------------------- #
+#  stacklayout.rb  Copyright (C) 2012-2014 j kepler
+require 'canis/core/include/layouts/abstractlayout'
+#  ---- 
+#  This does a simple stacking of objects. Or all objects.
+#  Some simple layout managers may not require objects to be passed to
+#  it, others that are complex may require the same.
+class StackLayout < AbstractLayout
+
+  # @param [Form]  optional give a form      
+  # @param [Hash]  optional give settings/attributes which will be set into variables
+  def initialize arg, config={}, &block
+    @wts = {}
+    super
+  end
+
+
+  # in case user does not wish to add objects, but wishes to specify the weightage on one,
+  # send in the widget and its weightage.
+  #
+  # @param [Widget] widget whose weightage is to be specified
+  # @param [Float, Fixnum] weightage for the given widget (@see add_with_weight)
+  def weightage item, wt
+    @wts[item] = wt
+  end
+
+
+  # This program lays out the widgets deciding their row and columm and height and weight.
+  # This program is called once at start of application, and again whenever a RESIZE event happens.
+  def do_layout
+    _init_layout
+    r = @top_margin
+    c = @left_margin
+    #
+    # determine fixed widths and how much is left to share with others,
+    # and how many variable width components there are.
+    ht = 0   # accumulate fixed height
+    fixed_ctr = 0 # how many items have a fixed wt
+    var_ctr = 0
+    var_wt = 0.0
+    @components.each do |e|
+      $log.debug "  looping 1 #{e.name} "
+      _tmpwt = @wts[e] || 0
+      # what of field and button placed side by side
+      if e.is_a? Field or e.is_a? Button or e.is_a? Label
+        @wts[e] ||= 1
+        ht += @wts[e] || 1
+        fixed_ctr += 1
+      elsif _tmpwt >= 1
+          ht += @wts[e] || 0
+          fixed_ctr += 1
+      elsif _tmpwt > 0 and _tmpwt <= 1
+        # FIXME how to specify 100 % ???
+        var_ctr += 1
+        var_wt += @wts[e]
+      end
+    end
+    unaccounted = @components.count - (fixed_ctr + var_ctr)
+    $log.debug "  unacc #{unaccounted} , fixed #{fixed_ctr} , var : #{var_ctr} , ht #{ht} height #{@height}  "
+    balance_ht = @height - ht # use this for those who have specified a %
+    balance_ht1 = balance_ht * (1 - var_wt )
+    average_ht = (balance_ht1 / unaccounted).floor # give this to those who have not specified ht
+    average_ht = (balance_ht1 / unaccounted) # give this to those who have not specified ht
+    $log.debug "  #{balance_ht} , #{balance_ht1} , #{average_ht} "
+    # not accounted for gap in heights
+    rem = 0 # remainder to be carried over
+    @components.each do |e|
+      $log.debug "  looping 2 #{e.name} #{e.class.to_s.downcase} "
+      next if @ignore_list.include? e.class.to_s.downcase
+      $log.debug "  looping 3 #{e.name} "
+      e.row = r
+      e.col = c
+      wt = @wts[e]
+      if wt
+        if wt.is_a? Fixnum
+          e.height = wt
+        elsif wt.is_a? Float
+          e.height = (wt * balance_ht).floor
+        end
+      else
+        # no wt specified, give average of balance wt
+        e.height = average_ht
+        hround = e.height.floor
+
+        rem += e.height - hround
+        e.height = hround
+        # see comment in prev block regarding remaininder
+        if rem >= 1
+          e.height += 1
+          rem = 0
+        end
+      end
+      $log.debug "  layout #{e.name} , h: #{e.height} r: #{e.row} , c = #{e.col} "
+
+      e.width = @width
+      r += e.height.floor
+      r += @gap
+    end
+    $log.debug "  layout finished "
+  end
+
+end

data/lib/canis/core/include/listbindings.rb

@@ -0,0 +1,89 @@
+# ----------------------------------------------------------------------------- #
+#         File: listbindings.rb
+#  Description: bindings for multi-row widgets such as listbox, table, 
+#       Author: jkepler http://github.com/mare-imbrium/canis/
+#         Date: 2011-12-11 - 12:58
+#      License: Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+#  Last update: 2014-06-03 14:10
+# ----------------------------------------------------------------------------- #
+#
+module Canis
+  # 
+  #  bindings for multi-row widgets such as listbox, table, 
+  # 
+  module ListBindings
+    extend self
+    def bindings
+      $log.debug "YYYY:  INSIDE LISTBINDING FOR #{self.class} "
+      bind_key(Ncurses::KEY_LEFT, 'cursor backward'){ cursor_backward } if respond_to? :cursor_backward
+      bind_key(Ncurses::KEY_RIGHT, 'cursor_forward'){ cursor_forward } if respond_to? :cursor_forward
+      # very irritating when user pressed up arrow, commented off 2012-01-4  can be made optional
+      bind_key(Ncurses::KEY_UP, 'previous row'){ ret = up;  } #get_window.ungetch(KEY_BTAB) if ret == :NO_PREVIOUS_ROW }
+      # the next was irritating if user wanted to add a row ! 2011-10-10 
+      #bind_key(Ncurses::KEY_DOWN){ ret = down ; get_window.ungetch(KEY_TAB) if ret == :NO_NEXT_ROW }
+      bind_key(Ncurses::KEY_DOWN, 'next row'){ ret = down ; }
+      bind_key(279, 'goto_start'){ goto_start } 
+      bind_key(277, 'goto end'){ goto_end } 
+      bind_key(338, 'scroll forward'){ scroll_forward() } 
+      bind_key(339, 'scroll backward'){ scroll_backward() } 
+
+      # this allows us to set on a component basis, or global basis
+      # Motivation was mainly for textarea which needs emacs keys
+      kmap = $key_map_type || :both
+      if kmap == :emacs || kmap == :both
+        bind_key(?\C-v, 'scroll forward'){ scroll_forward }
+        # clashes with M-v for toggle one key selection, i guess you can set it as you like
+        bind_key(?\M-v, 'scroll backward'){ scroll_backward }
+        bind_key(?\C-s, 'ask search'){ ask_search() }
+        bind_key(?\C-n, 'next row'){ down() }
+        bind_key(?\C-p, 'previous row'){ down() }
+        bind_key(?\M->, 'goto bottom'){ goto_end() }
+        bind_key(?\M-<, 'goto top'){ goto_start() }
+        bind_key([?\C-x, ?>], :scroll_right)
+        bind_key([?\C-x, ?<], :scroll_left)
+      end
+      if kmap == :vim || kmap == :both
+        # some of these will not have effect in textarea such as j k, gg and G, search
+        bind_key(?j, 'next row'){ down() }
+        bind_key(?k, 'previous row'){ up() }
+        bind_key(?w, 'forward_word'){ forward_word }
+        bind_key(?b, 'backward_word'){ backward_word }
+        bind_key(?W, 'forward WORD'){ forward_regex :WORD }
+        bind_key(?B, 'backward WORD'){ backward_regex :WORD }
+        bind_key(?\C-d, 'scroll forward'){ scroll_forward() }
+        bind_key(32, 'scroll forward'){ scroll_forward() } unless $row_selector == 32
+        bind_key(0, 'scroll backward'){ scroll_backward() } unless $range_selector == 0
+        bind_key(?\C-b, 'scroll backward'){ scroll_backward() }
+        bind_key(?\C-e, "Scroll Window Down"){ scroll_window_down } 
+        bind_key(?\C-y, "Scroll Window Up"){ scroll_window_up } 
+        bind_key([?g,?g], 'goto start'){ goto_start } # mapping double keys like vim
+        bind_key(?G, 'goto end'){ goto_end() }
+
+        # textpad has removed this since it messes with bookmarks which are on single-quote
+        bind_key([?',?'], 'goto last position'){ goto_last_position } # vim , goto last row position (not column)
+        bind_key(?L, :bottom_of_window)
+        bind_key(?M, :middle_of_window)
+        bind_key(?H, :top_of_window)
+
+        bind_key(?/, :ask_search)
+        bind_key(?n, :find_more)
+        bind_key(?h, 'cursor backward'){ cursor_backward }  if respond_to? :cursor_backward
+        bind_key(?l, 'cursor forward'){ cursor_forward } if respond_to? :cursor_forward
+        bind_key(?$, :cursor_eol)
+      end
+      bind_key(?\C-a, 'start of line'){ cursor_bol } if respond_to? :cursor_bol
+      bind_key(?\C-e, 'end of line'){ cursor_eol } if respond_to? :cursor_eol
+      bind_key(?\M-l, :scroll_right)
+      bind_key(?\M-h, :scroll_left)
+      bind_key(KEY_ENTER, :fire_action_event)
+
+      # save as and edit_external are only in tv and textarea
+      # save_as can be given to list's also and tables
+      # put them someplace so the code can be shared.
+      bind_key([?\C-x, ?\C-s], :saveas)
+      bind_key([?\C-x, ?e], :edit_external)
+      
+    end # def
+  end
+end
+include Canis::ListBindings