canis 0.0.4

data/lib/canis/core/widgets/tree/treecellrenderer.rb

@@ -0,0 +1,150 @@
+# 2010-09-18 15:35 
+require 'canis'
+require 'canis/core/widgets/rwidget'
+module Canis
+
+  ## 
+  # This is a basic list cell renderer that will render the to_s value of anything.
+  # 
+  # TODO upgrade as per new listcellrenderer
+  class TreeCellRenderer
+    PLUS_PLUS = "++"
+    PLUS_MINUS = "+-"
+    PLUS_Q     = "+?"
+    include Canis::ConfigSetup
+    include Canis::Utils
+    dsl_accessor :justify     # :right, :left, :center  # added 2008-12-22 19:02 
+    dsl_accessor :display_length     #  please give this to ensure the we only print this much
+    dsl_accessor :height    # if you want a multiline label.
+    dsl_accessor :text    # text of label
+    dsl_accessor :color, :bgcolor
+    dsl_accessor :row, :col
+    dsl_accessor :parent    #usuall the table to get colors and other default info
+    attr_reader :actual_length
+    attr_accessor :pcol
+
+    def initialize text="", config={}, &block
+      @text = text
+      @editable = false
+      @focusable = false
+      @actual_length = 0
+      config_setup config # @config.each_pair { |k,v| variable_set(k,v) }
+      instance_eval &block if block_given?
+      init_vars
+    end
+    def init_vars
+      @justify ||= :left
+      @display_length ||= 10
+    end
+    def getvalue
+      @text
+    end
+    ##
+    # sets @color_pair and @attr
+    def prepare_default_colors focussed, selected
+        @color_pair = get_color $datacolor
+        @attr = @row_attr || Ncurses::A_NORMAL
+
+
+        ## determine bg and fg and attr
+        if selected
+          #@attr = Ncurses::A_BOLD if selected
+          ## 2010-09-18 18:32 making selected row reverse
+          @attr |= Ncurses::A_REVERSE
+
+          # 2010-09-18 18:33 maybe not required, just confuses the whole thing and uglifies it
+          #@color_pair =get_color $selectedcolor, @parent.selected_color, @parent.selected_bgcolor unless @parent.nil?
+        end
+        case focussed
+        when :SOFT_FOCUS
+          @attr |= Ncurses::A_BOLD
+        when true
+          # earlier focussed row showed up in reverse, which was confusing since it looked selected
+          # now focussed row has cursor on side, and can be bold. that's enough.
+          @attr |= Ncurses::A_BOLD
+          #@attr |= Ncurses::A_REVERSE
+        when false
+        end
+    end
+
+    ##
+    #  paint a list box cell
+    #  2010-09-02 15:38 changed focussed to take true, false and :SOFT_FOCUS
+    #  SOFT_FOCUS means the form focus is no longer on this field, but this row
+    #  was focussed when use was last on this field. This row will take focus
+    #  when field is focussed again
+    #
+    #  @param [Buffer] window or buffer object used for printing
+    #  @param [Fixnum] row
+    #  @param [Fixnum] column
+    #  @param [Fixnum] actual index into data, some lists may have actual data elsewhere and
+    #                  display data separate. e.g. rfe_renderer (directory listing)
+    #  @param [String] text to print in cell
+    #  @param [Boolean, :SOFT_FOCUS] cell focussed, not focussed, cell focussed but field is not focussed
+    #  @param [Boolean] cell selected or not
+    #renderer.repaint @graphic, r+hh, c+@left_margin, crow, object, content, focus_type, selected, expanded, leaf
+    def repaint graphic, r=@row,c=@col, row_index=-1, treearraynode=nil, value=@text, leaf=nil, focussed=false, selected=false, expanded=false
+        #$log.debug "label :#{@text}, #{value}, #{r}, #{c} col= #{@color}, #{@bgcolor} acolor= #{acolor} j:#{@justify} dlL: #{@display_length} "
+
+      prepare_default_colors focussed, selected
+
+        value=value.to_s # ??
+        #icon = object.is_leaf? ? "-" : "+"
+        #icon = leaf ? "-" : "+"
+
+        #level = treearraynode.level
+        #node = treearraynode.node
+        level = treearraynode.level
+        node = treearraynode
+        if parent.node_expanded? node
+          icon = PLUS_MINUS  # can collapse
+        else
+          icon = PLUS_PLUS   # can expand
+        end
+        if node.children.size == 0
+          icon = PLUS_Q # either no children or not visited yet
+          if parent.has_been_expanded node
+            icon = PLUS_MINUS # definitely no children, we've visited
+          end
+        end
+        # adding 2 to level, that's the size of icon
+        # XXX FIXME if we put the icon here, then when we scroll right, the icon will show, it shoud not
+        # FIXME we ignore truncation etc on previous level and take the object as is !!!
+        _value =  "%*s %s" % [ level+2, icon,  node.user_object ]
+        @actual_length = _value.length
+        pcol = @pcol
+        if pcol > 0
+          _len = @display_length || @parent.width-2
+          _value = _value[@pcol..@pcol+_len-1] 
+        end
+        _value ||= ""
+        if @height && @height > 1
+        else
+          # ensure we do not exceed
+          if !@display_length.nil?
+            if _value.length > @display_length
+              @actual_length = _value.length
+              _value = _value[0..@display_length-1]
+            end
+          end
+          #lablist << value
+        end
+        len = @display_length || _value.length
+        graphic.printstring r, c, "%-*s" % [len, _value], @color_pair,@attr
+        #_height = @height || 1
+        #0.upto(_height-1) { |i| 
+          #graphic.printstring r+i, c, ( " " * len) , @color_pair,@attr
+        #}
+        #lablist.each_with_index do |_value, ix|
+          #break if ix >= _height
+          #if @justify.to_sym == :center
+            #padding = (@display_length - _value.length)/2
+            #_value = " "*padding + _value + " "*padding # so its cleared if we change it midway
+          #end
+          #graphic.printstring r, c, str % [len, _value], @color_pair,@attr
+          #r += 1
+        #end
+    end
+  # ADD HERE 
+  end
+end

data/lib/canis/core/widgets/tree/treemodel.rb

@@ -0,0 +1,432 @@
+# File TreeModel
+# (c) jkepler ABCD
+# Created on: Fri Sep 17 20:03:10 IST 2010
+require 'canis'
+
+module Canis
+  class IllegalStateException < Exception
+  end
+
+  class DefaultTreeModel #< TreeModel
+    include Canis::EventHandler 
+    attr_reader :asks_allow_children
+    attr_accessor :root_visible
+    def initialize node=nil, asks_allow_children=false, &block
+      @root_visible        = true
+      root(node, asks_allow_children) if node
+      instance_eval &block if block_given?
+    end
+    # insert a node the old sucky java pain in the butt way
+    # private
+    # sets node as root
+    #def root node, asks_allow_children=false, &block
+    def root *args, &block
+      return @root if args.empty?
+      node = args[0]
+      @asks_allow_children = args[1]
+      if !node.is_a? TreeNode
+        n = TreeNode.new node
+        node = n
+      end
+      @root = node
+      $log.debug " XXX def root created root with #{node} "
+      #add node, true, &block 
+      instance_eval &block if block_given?
+    end
+    def insert_node_into nodechild, nodeparent, index
+      $log.debug " TODO remove from existing parent to avoid bugs XXX"
+      nodeparent.insert nodechild, index
+      if @handler # only if someone is listening, won't fire when being prepared
+        tme = TreeModelEvent.new(row, row,:ALL_COLUMNS,  self, :INSERT)
+        fire_handler :TREE_MODEL_EVENT, tme
+      end
+      self
+    end
+    # add a node to root passing a block optionally
+    # @param [String, TreeNode, Array, Hash] node/s to add
+    # @param [Boolean] allow children to be added
+    # @see TreeNode.add
+    # @return [TreeNode] node just added to root (NOT self)
+    def add nodechild, allows_children=true, &block
+      # calling TreeNode.add
+      $log.debug " XXX def add of DTM #{nodechild} to root "
+      node = @root.add nodechild, allows_children, &block
+      if @handler # only if someone is listening, won't fire when being prepared
+        tme = TreeModelEvent.new(row, row,:ALL_COLUMNS,  self, :INSERT)
+        fire_handler :TREE_MODEL_EVENT, tme
+      end
+      #return @root
+      return node
+    end
+    def leaf node, &block
+      add node, false, &block
+    end
+    def branch node, &block
+      add node, true, &block
+    end
+    alias :<< :add
+    def insert row, obj
+      @data.insert row, obj
+      if @handler # only if someone is listening, won't fire when being prepared
+        tme = TreeModelEvent.new(row, row,:ALL_COLUMNS,  self, :INSERT)
+        fire_handler :TREE_MODEL_EVENT, tme
+      end
+    def child_at parent, index
+    end
+    def index_of_child parent, child
+    end
+    def child_count node
+      node.children.size
+    end
+
+    def row_count
+      @data.length
+    end
+    # 
+    def set_value_at row, col, val
+      # if editing allowed
+      raise "not yet used"
+      @data[row][col] = val
+      tme = TreeModelEvent.new(row, row, col, self, :UPDATE)
+      fire_handler :TREE_MODEL_EVENT, tme
+    end
+    ##
+    # please avoid directly hitting this. Suggested to use get_value_at of jtable
+    # since columns could have been switched.
+    def get_value_at row, col
+      raise "not yet used"
+      #$log.debug " def get_value_at #{row}, #{col} "
+
+      raise "IndexError get_value_at #{row}, #{col}" if @data.nil? or row >= @data.size
+      return @data[row][ col]
+    end
+    #def << obj
+      #@data << obj
+      #tme = TreeModelEvent.new(@data.length-1,@data.length-1, :ALL_COLUMNS, self, :INSERT)
+      #fire_handler :TREE_MODEL_EVENT, tme
+    #end
+      # create tablemodelevent and fire_table_changed for all listeners 
+    end
+    def delete obj
+      raise "not yet used"
+      row = @data.index obj
+      return if row.nil?
+      ret = @data.delete obj
+      tme = TreeModelEvent.new(row, row,:ALL_COLUMNS,  self, :DELETE)
+      fire_handler :TREE_MODEL_EVENT, tme
+      # create tablemodelevent and fire_table_changed for all listeners
+      return ret
+    end
+    def delete_at row
+      raise "not yet used"
+      if !$multiplier or $multiplier == 0 
+        @delete_buffer = @data.delete_at row
+      else
+        @delete_buffer = @data.slice!(row, $multiplier)
+      end
+      $multiplier = 0
+      #ret = @data.delete_at row
+      # create tablemodelevent and fire_table_changed for all listeners 
+      # we don;t pass buffer to event as in listeditable. how to undo later?
+      tme = TreeModelEvent.new(row, row+@delete_buffer.length,:ALL_COLUMNS,  self, :DELETE)
+      fire_handler :TREE_MODEL_EVENT, tme
+      return @delete_buffer
+    end
+    # a quick method to undo deletes onto given row. More like paste
+    def undo where
+      raise "not yet used"
+      return unless @delete_buffer
+      case @delete_buffer[0]
+      when Array
+        @delete_buffer.each do |r| 
+          insert where, r 
+        end
+      else
+        insert where, @delete_buffer
+      end
+    end
+    ## 
+    # added 2009-01-17 21:36 
+    # Use with caution, does not call events per row
+    def delete_all
+      raise "not yet used"
+      len = @data.length-1
+      @data=[]
+      tme = TreeModelEvent.new(0, len,:ALL_COLUMNS,  self, :DELETE)
+      fire_handler :TREE_MODEL_EVENT, tme
+    end
+    ##
+    # for those quick cases when you wish to replace all the data
+    # and not have an event per row being generated
+    def data=(data)
+      raise "not yet used"
+      raise "Data nil or invalid" if data.nil? or data.size == 0
+      delete_all
+      @data = data
+      tme = TreeModelEvent.new(0, @data.length-1,:ALL_COLUMNS,  self, :INSERT)
+      fire_handler :TREE_MODEL_EVENT, tme
+    end
+    #def ask_search_forward
+    #regex = get_string "Enter regex to search for:"
+    #ix = get_list_data_model.find_match regex
+    #if ix.nil?
+    #alert("No matching data for: #{regex}")
+    #else
+    #set_focus_on(ix)
+    #end
+    #end
+    ## continues previous search
+    ###
+    #def find_match regex, ix0=0, ix1=row_count()
+    #$log.debug " find_match got #{regex} #{ix0} #{ix1}"
+    #@last_regex = regex
+    #@search_start_ix = ix0
+    #@search_end_ix = ix1
+    #@data.each_with_index do |row, ix|
+    #next if ix < ix0
+    #break if ix > ix1
+    #if row.grep(/#{regex}/) != [] 
+    ##if !row.match(regex).nil?
+    #@search_found_ix = ix
+    #return ix 
+    #end
+    #end
+    #return nil
+    #end
+    #def find_prev regex=@last_regex, start = @search_found_ix 
+    #raise "No previous search" if @last_regex.nil?
+    #$log.debug " find_prev #{@search_found_ix} : #{@current_index}"
+    #start -= 1 unless start == 0
+    #@last_regex = regex
+    #@search_start_ix = start
+    #start.downto(0) do |ix| 
+    #row = @data[ix]
+    #if row.grep(/#{regex}/) != [] 
+    #@search_found_ix = ix
+    #return ix 
+    #end
+    #end
+    #return nil
+    ##return find_match @last_regex, start, @search_end_ix
+    #end
+    ### dtm findnext
+    #def find_next
+    #raise "No more search" if @last_regex.nil?
+    #start = @search_found_ix && @search_found_ix+1 || 0
+    #return find_match @last_regex, start, @search_end_ix
+    #end
+    # just a test program
+    def traverse node=@root, level=0
+      icon = node.is_leaf? ? "-" : "+"
+      puts "%*s %s" % [ level+1, icon,  node.user_object ]
+      node.children.each do |e| 
+        traverse e, level+1
+      end
+    end
+  end # class  DTM
+  # When an event is fired by TableModel, contents are changed, then this object will be passed 
+  # to trigger
+  # type is :INSERT :UPDATE :DELETE :HEADER_ROW 
+  # columns: number or :ALL_COLUMNS
+  class TreeModelEvent
+    attr_accessor :firstrow, :lastrow, :source, :type
+    def initialize firstrow, lastrow, source, type
+      @firstrow = firstrow
+      @lastrow = lastrow
+      @source = source
+      @type = type
+    end
+    def to_s
+      "#{@type.to_s}, firstrow: #{@firstrow}, lastrow: #{@lastrow}, source: #{@source}"
+    end
+    def inspect
+      to_s
+    end
+  end
+  class TreeNode
+    #extend Forwardable
+
+    attr_accessor :parent
+    attr_reader :children
+    attr_reader :user_object
+    attr_reader :allows_children
+    def initialize user_object=nil, allows_children=true, &block #form, config={}, &block
+      @allows_children  = allows_children
+      @user_object  = user_object
+      @children = []
+      #super
+      instance_eval &block if block_given?
+      init_vars
+    end
+    # private
+    #@return [TreeNode] just creates node
+    def _add node, allows_children=true, &block
+      #raise ArgumentError, "Argument should be a node" if !node.is_a? TreeNode
+      $log.debug " TODO remove from existing parent to avoid bugs XXX"
+      if !node.is_a? TreeNode
+        n = TreeNode.new node, allows_children, &block
+        node = n
+      end
+      node.parent = self
+      @children << node
+      node
+    end
+    # add a node to this node, optionally passing a block for further adding 
+    # add a node as child to existing node
+    # If node is not a TreeNode it will be converted to one.
+    # @param [TreeNode, Array, Hash] node/s to add
+    # @param [boolean] should children be allowed
+    # @return [TreeNode] node last added (*NOT* self)
+    def add node, allows_children=true, &block
+      raise IllegalStateException, "Cannot add a child to this node" unless @allows_children
+      $log.debug " XXX def add of TreeNode #{node} parent #{self}  "
+      case node
+      when Array
+        node.each do |e| 
+          add e, allows_children, &block 
+        end
+      when Hash
+        node.each_pair { |name, val|  
+          n = _add name, allows_children, &block 
+          n.add val, allows_children, &block
+        }
+      else
+        return _add node, allows_children, &block 
+      end
+      self
+    end
+    def leaf node, &block
+      add node, false, &block
+    end
+    def branch node, &block
+      add node, true, &block
+    end
+    alias :<< :add
+    def insert node, index
+      raise ArgumentError, "Argument should be a node. it is #{node.class} " if !node.is_a? TreeNode
+      @children.insert index, node
+      self
+    end
+    def child_after node
+    end
+    def child_before node
+    end
+    def child_at node
+    end
+    def next_node node
+    end
+    def remove
+    end
+    def remove_all_children
+    end
+    def remove_from_parent
+    end
+    def is_leaf?
+      @children.size == 0
+    end
+    def leaf_count
+    end
+    def level
+      level = 0
+      nodeparent = parent()
+      while( nodeparent != nil )
+        level += 1
+        nodeparent = nodeparent.parent()
+      end
+      return level
+    end
+    def leaf_count
+    end
+    def traverse_up &block
+      nodeparent = parent()
+      while ( nodeparent != nil )
+        yield nodeparent
+        nodeparent = nodeparent.parent()
+      end
+    end
+    # returns an array of user_objects for the current node
+    # starting from root, ending in the current one. The last node
+    # represents this node.
+    # @return [Array] Strings[]
+    def user_object_path
+      arr = []
+      arr << self.user_object.to_s
+      traverse_up do |e|
+        arr << e.user_object.to_s
+      end
+      arr.reverse!
+    end
+    # returns an array of nodes for the current node
+    # starting from root, ending in the current one. The last node
+    # represents this node.
+    # @return [Array] TreeNode[]
+    def tree_path
+      arr = []
+      arr << self
+      traverse_up do |e|
+        arr << e
+      end
+      arr.reverse!
+    end
+    # http://github.com/evolve75/RubyTree/blob/master/lib/tree.rb
+    def breadth_each(max_depth=999,&block)
+      node_queue = [self] # Create a queue with self as the initial entry
+
+      # Use a queue to do breadth traversal
+      until node_queue.empty?
+        node_to_traverse = node_queue.shift
+        yield node_to_traverse
+        # Enqueue the children from left to right.
+        node_to_traverse.children { |child| node_queue.push child }
+        max_depth -= 1
+        break if max_depth == 0
+      end
+    end
+    def to_s
+      @user_object.to_s
+    end
+    # need by textpad to calculate pad 
+    def length
+      to_s.length
+    end
+    def init_vars
+       @repaint_required = true
+    end
+  end
+end # module
+
+if $0 == __FILE__
+  $log = Logger.new("canis.log")
+  $log.level = Logger::DEBUG
+     
+  include Canis
+  root    =  TreeNode.new "ROOT"
+  subroot =  TreeNode.new "subroot"
+  leaf1   =  TreeNode.new "leaf 1"
+  leaf2   =  TreeNode.new "leaf 2"
+
+  model = DefaultTreeModel.new root
+  #model.insert_node_into(subroot, root,  0)
+  #model.insert_node_into(leaf1, subroot, 0)
+  #model.insert_node_into(leaf2, subroot, 1)
+  root << subroot
+  # this will allow us to do a recursive add
+  #subroot << leaf1 << leaf2
+  subroot << leaf1 
+  subroot << leaf2 
+  leaf1 << "leaf11" << "leaf111"
+  leaf1 << "leaf12" << "leaf121"
+
+  root.add "blocky", true do 
+    add "block2"
+    add "block3" do
+      add "block31"
+    end
+  end
+  
+  model.traverse root
+  puts "tree path: ..."
+  puts leaf2.tree_path
+  puts "object  path: ..."
+  puts leaf2.user_object_path
+end