rbcurse 1.4.1 → 1.5.0.pre1

data/lib/rbcurse/extras/directorytree.rb

@@ -1,69 +0,0 @@
-require 'rbcurse/rtree'
-#require 'forwardable'
-# we can extend from Tree but lets just try forwarding
-module RubyCurses
-  # this class shows a tree of directories. Pressing ENTER expands or collapses
-  # the node. Pressing ENTER selects a node.
-  # Should we give options for displaying filenames also ? TODO
-  class DirectoryTree < Tree
-    attr_reader :selected_path
-    #@t = tree :data => model, :height => ht, :border_attrib => borderattrib, :suppress_borders => true
-    def _directories wd
-      d = Dir.new(wd)
-      ent = d.entries.reject{|e| !File.directory? File.join(wd,e)}
-      ent.delete(".");ent.delete("..")
-      return ent
-    end
-
-    def init_vars
-      super
-
-      one_key_selection = false
-      bind :TREE_WILL_EXPAND_EVENT do |node|
-        will_expand_action node
-      end
-
-      bind :TREE_SELECTION_EVENT do |ev|
-        selection_event ev
-      end 
-    end  # init_v
-
-    # populate this node with child directories
-    # this gives user application a chance to override or extend this action
-    def will_expand_action node
-      path = File.join(*node.user_object_path)
-      dirs = _directories path
-      ch = node.children
-      # add only children that may not be there
-      ch.each do |e| 
-        o = e.user_object
-        if dirs.include? o
-          dirs.delete o
-        else
-          # delete this child since its no longer present TODO
-        end
-      end
-      node.add dirs
-      path_expanded path
-    end
-    # notify applications of path expanded so they may do any
-    # related action
-    # # NOTE: this is not the cleanest way, since you will need objects from your app
-    # scope here. User will have to add objects into the config hash after object creation
-    # and access them here. (See appdirtree.rb in examples)
-    def path_expanded path
-    end
-    def selection_event ev
-      if ev.state == :SELECTED
-        node = ev.node
-        path = File.join(*node.user_object_path)
-        @selected_path = path
-        selected_path_changed path
-      end
-    end
-    # inform applications that path has changed
-    # gives the user application a place to effect changes elsewhere in app
-    def selected_path_changed path
-    end
-  end  # class
-end

data/lib/rbcurse/extras/divider.rb

@@ -1,310 +0,0 @@
-require 'rbcurse/app'
-#include Ncurses # FFI 2011-09-8 
-include RubyCurses
-
-# TODO : We can consider making it independent of objects, or allow for a margin so it does not write
-# over the object. Then it will be always visible.
-# TODO: if lists and tables, can without borders actually adjust then putting this independent
-# would make even more sense, since it won't eat an extra line.
-#
-# @example
-#     lb = list_box ....
-#     rb = Divider.new @form, :parent => lb, :side => :right
-#
-# At a later stage, we will integrate this with lists and tables, so it will happen automatically.
-#
-# @since 1.2.0
-module RubyCurses
-  class DragEvent < Struct.new(:source, :type); end
-
-  # This is a horizontal or vertical bar (like a scrollbar), at present attached to a
-  # widget that is focusable, and allows user to press arrow keys.
-  # It highlights on focus, the caller can expand and contract components in a container
-  # or even screen, based on arrow movements. This allows for a visual resizing of components.
-  # @example
-  #     lb = list_box ....
-  #     rb = Divider.new @form, :parent => lb, :side => :right
-  #
-  # NOTE: since this can be deactivated, containers need to check focusable before passing
-  # focus in
-  #  2010-10-07 23:56 made focusable false by default. Add divider to
-  #  FocusManager when creating, so F3 can be used to set focusable
-  #  See rvimsplit.rb for example
-
-  class Divider < Widget
-    # row to start, same as listbox, required.
-    dsl_property :row
-    # column to start, same as listbox, required.
-    dsl_property :col
-    # how many rows is this (should be same as listboxes height, required.
-    dsl_property :length
-    # vertical or horizontal currently only VERTICAL
-    dsl_property :side
-    # initialize based on parent's values
-    dsl_property :parent
-    # which row is focussed, current_index of listbox, required.
-    # how many total rows of data does the list have, same as @list.length, required.
-    dsl_accessor :next_component  # 'next' bombing in dsl_accessor 2011-10-2 PLS CHANGE ELSEWHERE
-
-    # TODO: if parent passed, we shold bind to ON_ENTER and get current_index, so no extra work is required.
-
-    def initialize form, config={}, &block
-
-      # setting default first or else Widget will place its BW default
-      #@color, @bgcolor = ColorMap.get_colors_for_pair $bottomcolor
-      super
-      @height = 1
-      @color_pair = get_color $datacolor, @color, @bgcolor
-      @scroll_pair = get_color $bottomcolor, :green, :white
-      #@window = form.window
-      @editable = false
-      # you can set to true upon creation, or use F3 on vimsplit to
-      # toggle focusable
-      @focusable = false
-      @repaint_required = true
-      @_events.push(:DRAG_EVENT)
-      map_keys
-      unless @parent
-        raise ArgumentError, "row col and length should be provided" if !@row || !@col || !@length
-      end
-      #if @parent
-        #@parent.bind :ENTER_ROW do |p|
-          ## parent must implement row_count, and have a @current_index
-          #raise StandardError, "Parent must implement row_count" unless p.respond_to? :row_count
-          #self.current_index = p.current_index
-          #@repaint_required = true  #requred otherwise at end when same value sent, prop handler
-          ## will not be fired (due to optimization).
-        #end
-      #end
-    end
-    def map_keys
-      if !defined? $deactivate_dividers
-        $deactivate_dividers = false
-      end
-      # deactivate only this bar
-      bind_key(?f) {@focusable=false; }
-      # deactivate all bars, i've had nuff!
-      bind_key(?F) {deactivate_all(true)}
-    end
-
-    ##
-    # repaint the scrollbar
-    # Taking the data from parent as late as possible in case parent resized, or 
-    # moved around by a container.
-    # NOTE: sometimes if this is inside another object, the divider repaints but then
-    # is wiped out when that objects print_border is called. So such an obkect (e.g.
-    # vimsplit) should call repaint after its has done its own repaint. that does mean
-    # the repaint happens twice during movement
-    def repaint
-      woffset = 2
-      coffset = 1
-      if @parent
-        woffset = 0 if @parent.suppress_borders
-        @border_attrib ||= @parent.border_attrib
-        case @side
-        when :right
-          @row = @parent.row+1
-          @col = @parent.col + @parent.width - 0
-          @length = @parent.height - woffset
-        when :left
-          @row = @parent.row+1
-          @col = @parent.col+0 #+ @parent.width - 1
-          @length = @parent.height - woffset
-        when :top
-          @row = @parent.row+0
-          @col = @parent.col + @parent.col_offset #+ @parent.width - 1
-          @length = @parent.width - woffset
-        when :bottom
-          @row = @parent.row+@parent.height-0 #1
-          @col = @parent.col+@parent.col_offset #+ @parent.width - 1
-          @length = @parent.width - woffset
-        end
-      else
-        # row, col and length should be passed
-      end
-      my_win = @form ? @form.window : @target_window
-      @graphic = my_win unless @graphic
-      raise "graphic is nil in divider, perhaps form was nil when creating" unless @graphic
-      return unless @repaint_required
-
-      # first print a right side vertical line
-      #bc = $bottomcolor  # dark blue
-      bc = $datacolor
-      bordercolor = @border_color || bc
-      borderatt = @border_attrib || Ncurses::A_REVERSE
-      if @focussed 
-        bordercolor = $promptcolor || bordercolor
-      end
-
-      borderatt = convert_attrib_to_sym(borderatt) if borderatt.is_a? Symbol
-
-      @graphic.attron(Ncurses.COLOR_PAIR(bordercolor) | borderatt)
-      $log.debug " XXX DIVIDER #{@row} #{@col} #{@length} "
-      case @side
-      when :right, :left
-        @graphic.mvvline(@row, @col, 1, @length)
-      when :top, :bottom
-        @graphic.mvhline(@row, @col, 1, @length)
-      end
-      @graphic.attroff(Ncurses.COLOR_PAIR(bordercolor) | borderatt)
-      _paint_marker
-      #alert "divider repaint at #{row} #{col} "
-
-      @repaint_required = false
-    end
-    def convert_attrib_to_sym attr
-      case attr
-      when 'reverse'
-        Ncurses::A_REVERSE
-      when 'bold'
-        Ncurses::A_BOLD
-      when 'normal'
-        Ncurses::A_NORMAL
-      when 'blink'
-        Ncurses::A_BLINK
-      when 'underline'
-        Ncurses::A_UNDERLINE
-      else
-        Ncurses::A_REVERSE
-      end
-    end
-    # deactivate all dividers
-    # The application has to provide a key or button to activate all
-    # or just this one.
-    def deactivate_all  tf=true
-      $deactivate_dividers = tf
-      @focusable = !tf
-    end
-    def handle_key ch
-      # all dividers have been deactivated
-      if $deactivate_dividers || !@focusable
-        @focusable = false
-        return :UNHANDLED
-      end
-      case @side
-      when :right, :left
-        case ch
-        when KEY_RIGHT
-          fire_handler :DRAG_EVENT, DragEvent.new(self, ch)
-        when KEY_LEFT
-          fire_handler :DRAG_EVENT, DragEvent.new(self, ch)
-        else
-          ret = process_key ch, self
-          return ret if ret == :UNHANDLED
-        end
-        set_form_col
-      when :top, :bottom
-        case ch
-        when KEY_UP
-          fire_handler :DRAG_EVENT, DragEvent.new(self, ch)
-        when KEY_DOWN
-          fire_handler :DRAG_EVENT, DragEvent.new(self, ch)
-        else
-          ret = process_key ch, self
-          return ret if ret == :UNHANDLED
-        end
-        set_form_col
-      else
-      end
-      @repaint_required = true
-      return 0
-    end
-    def on_enter
-      if $deactivate_dividers || !@focusable
-        @focusable = false
-        return :UNHANDLED
-      end
-      # since it is over border of component, we need to repaint
-      @focussed = true
-      @repaint_required = true
-      repaint
-    end
-    def on_leave
-      @focussed = false
-      @repaint_required = true
-      repaint
-      # TODO: we should review this since its not over the parent any longer
-      if @parent
-        # since it is over border of component, we need to clear
-        @parent.repaint_required 
-        # if we don't paint now, parent paints over other possible dividers
-        @parent.repaint
-      end
-    end
-    def set_form_row
-      return unless @focusable
-      r,c = rowcol
-      setrowcol r, c
-    end
-    # set the cursor on first point of bar
-    def set_form_col
-      return unless @focusable
-      # need to set it to first point, otherwise it could be off the widget
-      r,c = rowcol
-      setrowcol r, c
-    end
-    # is this a vertical divider
-    def v?
-      @side == :top || @side == :bottom
-    end
-    # is this a horizontal divider
-    def h?
-      @side == :right || @side == :left
-    end
-    private
-    def _paint_marker  #:nodoc:
-      r,c = rowcol
-      if @focussed
-        @graphic.mvwaddch r,c, Ncurses::ACS_DIAMOND
-        if v?
-          @graphic.mvwaddch r,c+1, Ncurses::ACS_UARROW
-          @graphic.mvwaddch r,c+2, Ncurses::ACS_DARROW
-        else
-          @graphic.mvwaddch r+1,c, Ncurses::ACS_LARROW
-          @graphic.mvwaddch r+2,c, Ncurses::ACS_RARROW
-        end
-      else
-        #@graphic.mvwaddch r,c, Ncurses::ACS_CKBOARD
-      end
-    end
-    ##
-    ##
-    # ADD HERE 
-    end # class
-end # module
-if __FILE__ == $PROGRAM_NAME
-  App.new do
-    r = 5
-    len = 20
-    list = []
-    0.upto(100) { |v| list << "#{v} scrollable data" }
-    lb = list_box "A list", :list => list, :row => 2, :col => 2
-    #sb = Scrollbar.new @form, :row => r, :col => 20, :length => len, :list_length => 50, :current_index => 0
-    rb = Divider.new @form, :parent => lb, :side => :right
-    rb.bind :DRAG_EVENT do |e|
-      message "got an event #{e.type} "
-      case e.type
-      when KEY_RIGHT
-        lb.width += 1
-      when KEY_LEFT
-        lb.width -= 1
-      end
-      lb.repaint_required
-    end
-    rb1 = Divider.new @form, :parent => lb, :side => :bottom
-    rb.focusable(true)
-    rb1.focusable(true)
-    rb1.bind :DRAG_EVENT do |e|
-      message " 2 got an event #{e.type} "
-    end
-    #hline :width => 20, :row => len+r
-    #keypress do |ch|
-      #case ch
-      #when :down
-        #sb.current_index += 1
-      #when :up
-        #sb.current_index -= 1
-      #end
-    #end
-  end
-end

data/lib/rbcurse/extras/focusmanager.rb

@@ -1,31 +0,0 @@
-# Allow some objects to take focus when a certain key is pressed.
-# This is for objects like scrollbars and grabbars. We don't want these always
-# getting focus, only sometimes when we want to resize panes.
-# This will not only be included by Form but by containers such as Vimsplit
-# or MasterDetail.
-# Usage: the idea is that when you create grabbars, you would add them to the FocusManager
-# Thus they would remain non-focusable on creation. When hte user presses (say F3) then
-# make_focusable is called, or toggle_focusable. Now user can press TAB and access
-# these bars. When he is done he can toggle again.
-# TODO: we might add a Circular class here so user can traverse only these objects
-module RubyCurses
-  module FocusManager
-    extend self
-    attr_reader :focusables
-    # add a component to this list so it can be made focusable later
-    def add component
-      @focusables ||= []
-      @focusables << component
-      self
-    end
-    def make_focusable bool=true
-      @focusing = bool
-      @focusables.each { |e| e.focusable(bool) }
-    end
-    def toggle_focusable
-      return unless @focusables
-      alert "FocusManager Making #{@focusables.length} objects #{!@focusing} "
-      make_focusable !@focusing
-    end
-  end
-end

data/lib/rbcurse/extras/horizlist.rb

@@ -1,203 +0,0 @@
-require 'rbcurse'
-
-# This is a horizontal scroller, to scroll a list of options much like
-# vim often does on the statusline. I'd like to use it for scrolling
-# menus or buttons like on TabbedPanes to avoid another Form.
-
-# You may bind to the ENTER_ROW event to chagne some data elsewhere,
-# or the PRESS event. In this case, PRESS will refer to pressing the
-# space bar or ENTER. There is <em>no</em> LIST_SELECTION event for that.
-
-
-
-module RubyCurses
-
-  # Horizontal list scrolling and selection.
-  #
-  #    == Example
-  #    require 'rbcurse/extras/horizlist'
-  #    require 'fileutils'
-  #    l = HorizList.new @form, :row => 5, :col => 5, :width => 80 
-  #    list = Dir.glob("*")
-  #    l.list(list)
-
-  class HorizList < Widget
-
-    def initialize form, config={}, &block
-      super
-      @_events.push(*[:ENTER_ROW, :LEAVE_ROW, :PRESS])
-      @focusable = true
-      init_vars
-      @list = []
-      @toprow = 0
-
-      # last printed index
-      @last_index = 0
-
-      # item on which cursor is
-      @current_index = 0
-    end
-    def init_vars
-    end
-    # alias :text :getvalue # NEXT VERSION
-
-    def map_keys
-      @keys_mapped = true
-      bind_keys([KEY_RIGHT, ?l, ?.], :next_item)
-      bind_keys([KEY_LEFT, ?h,?,], :previous_item)
-      bind_keys([10,13,32]){ fire_action_event }
-      bind_keys([?\M-l,?>, KEY_DOWN], :scroll_right)
-      bind_keys([?\M-h,?<, KEY_UP], :scroll_left)
-    end
-    def list(strings)
-      @list = strings
-    end
-    def add item
-      @list << item
-    end
-    def repaint
-      return unless @repaint_required
-      @window ||= @form.window
-      $log.debug "XXX:HORIZ REPAINT Ci #{@current_index}, TR #{@toprow} "
-      $status_message.value = " #{@current_index}, TR #{@toprow} "
-      @window.printstring @row, @col, " "* @width, @color_pair || $reversecolor
-      c = @col + 1
-      t = @toprow
-      @list.each_with_index { |e, i| 
-        next if i < t # sucks for large lists
-        break if c + e.length >= @width + @col
-        att = @attrib || FFI::NCurses::A_NORMAL
-        if i == @current_index
-          att = FFI::NCurses::A_REVERSE if i == @current_index
-          acolor = @focussed_color_pair ||  get_color($datacolor,'green', 'white') 
-        else
-          acolor = @color_pair
-        end
-        @window.printstring @row, c, e, acolor  || $reversecolor, att
-        c += e.length + 2
-        @last_index = i
-        break if c >= @width + @col
-      }
-      @repaint_required = false
-    end
-    def handle_key ch
-      map_keys unless @keys_mapped
-      ret = process_key ch, self
-      @multiplier = 0
-      return :UNHANDLED if ret == :UNHANDLED
-    end
-    def previous_item num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
-    
-      return :NO_PREVIOUS_ROW if @current_index == 0 
-      @old_toprow = @toprow
-      @oldrow = @current_index
-      @current_index -= num
-      @current_index = 0 if @current_index < 0
-      bounds_check
-      $multiplier = 0
-      if @current_index < @toprow
-        @toprow = @current_index
-      end
-      @toprow = 0 if @toprow < 0
-      @repaint_required = true
-    end
-    def next_item num=(($multiplier.nil? or $multiplier == 0) ? 1 : $multiplier)
-      rc = row_count
-      return :NO_NEXT_ROW if @current_index == rc-1  # changed 2011-10-5 so process can do something
-      @old_toprow = @toprow
-      @oldrow = @current_index
-      @current_index += num 
-      @current_index = rc - 1 if @current_index >= rc
-      @toprow = @current_index if @current_index > @last_index
-      bounds_check
-      $multiplier = 0
-      @repaint_required = true
-    end
-    def scroll_right
-      rc = row_count
-      return :NO_NEXT_ROW if @current_index == rc-1  # changed 2011-10-5 so process can do something
-      @old_toprow = @toprow
-      @oldrow = @current_index
-
-      @current_index = @last_index + 1
-
-      @current_index = rc - 1 if @current_index >= rc
-      @toprow = @current_index if @current_index > @last_index
-      bounds_check
-      $multiplier = 0
-      @repaint_required = true
-    end
-    def scroll_left
-      return :NO_PREVIOUS_ROW if @current_index == 0 
-      @old_toprow = @toprow
-      @oldrow = @current_index
-      @current_index = @toprow - 4
-      @current_index = 0 if @current_index < 0
-      bounds_check
-      $multiplier = 0
-      if @current_index < @toprow
-        @toprow = @current_index
-      end
-      @toprow = 0 if @toprow < 0
-      @repaint_required = true
-    end
-    def row_count; @list.size; end
-    def bounds_check
-      @row_changed = false
-      if @oldrow != @current_index
-        on_leave_row @oldrow if respond_to? :on_leave_row     # to be defined by widget that has included this
-        on_enter_row @current_index   if respond_to? :on_enter_row  # to be defined by widget that has included this
-        set_form_row
-        @row_changed = true
-      end
-      if @old_toprow != @toprow # only if scrolling has happened should we repaint
-        @repaint_required = true 
-        @widget_scrolled = true
-      end
-    end
-    def on_enter
-      if @list.nil? || @list.size == 0
-        Ncurses.beep
-        return :UNHANDLED
-      end
-      super  
-      on_enter_row @current_index
-      set_form_row
-      true
-    end
-    def on_enter_row arow
-      fire_handler :ENTER_ROW, self
-      @repaint_required = true
-    end
-    def on_leave_row arow
-      fire_handler :LEAVE_ROW, self
-    end
-    def fire_action_event
-      require 'rbcurse/ractionevent'
-      fire_handler :PRESS, ActionEvent.new(self, :PRESS, text)
-    end
-    def current_value
-      @list[@current_index]
-    end
-    alias :text :current_value
-    ##
-  end # class
-end # module
-if __FILE__ == $PROGRAM_NAME
-  require 'rbcurse/app'
-
-  App.new do
-    require 'rbcurse/extras/horizlist'
-    require 'fileutils'
-    l = HorizList.new @form, :row => 5, :col => 5, :width => 80 
-    list = Dir.glob("*")
-    l.list(list)
-    l.bind(:PRESS){ |eve| alert "You pressed #{eve.text} " }
-    sl = status_line
-    sl.command do
-      " Status:  #{$status_message} "
-    end
-  end
-
-  
-end