rbcurse-experimental 0.0.0

data/lib/rbcurse/experimental/widgets/directorytree.rb

@@ -0,0 +1,69 @@
+require 'rbcurse/core/widgets/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/experimental/widgets/masterdetail.rb

@@ -0,0 +1,166 @@
+require 'rbcurse/extras/widgets/rvimsplit'
+require 'forwardable'
+# A convenience class that implements a 3 way Master Detail like form
+# as in some email clients. See appemail.rb for usage.
+# You may use this class or extend it. It takes care of expanding,
+# increasing etc the 3 splits.
+# This class is not fully tested beyond appemail.rb, and can change
+# quite a bit. Users may want to copy this to prevent from major changes
+# that could take place.
+class MasterDetail < Widget
+  dsl_property :weight
+  attr_reader :vim # the vimsplit for any further configuration such as min_weight etc
+  extend Forwardable
+  def_delegators :@vim, :on_enter, :on_leave, :handle_key, :current_component
+  def initialize form, config={}, &block
+    @focusable = true
+    @height = Ncurses.LINES-2
+    @weight = 0.25
+    super
+    _create_vimsplit
+    init_vars
+  end
+  def init_vars  #:nodoc:
+    @first_time = true
+    @repaint_required = true
+  end
+  def repaint
+    if @first_time
+      @first_time = nil
+      [@vim, @left, @right1, @right2].each { |e|  
+        e.set_buffering(:target_window => @target_window || @form.window, :form => @form) # removed on 2011-09-29 
+      }
+    end
+    @vim.repaint
+  end
+  # set the single component on the left side/pane, typically a +Listbox+.
+  # If an array is passed, the Listbox created is returned for further
+  # manipulation.
+  # @param [Widget] component to set on left
+  # @return [Widget] component added
+  def set_left_component comp, weight=nil
+    @left = @vim.add comp, :FIRST, weight
+    _add_component comp
+    @left
+  end
+  # set the first component on the right side/pane, typically a +Listbox+.
+  # @param [Widget] component to set on right
+  # @return [Widget] component added
+  def set_right_top_component comp, weight=0.5
+    @added_top = true
+    @right1 = @vim.add comp, :SECOND, weight
+    _add_component comp
+    @right1
+  end
+  # set the second component on the right side/pane, typically a
+  # +TextView+
+  # @param [Widget] component to set on right
+  # @return [Widget] component added
+  def set_right_bottom_component comp, weight=nil
+    raise "Please add top component first!" unless @added_top
+    # what if user gives in wrong order !!
+    @gb = @vim.add :divider, :SECOND, 0
+    @right2 = @vim.add comp, :SECOND, weight
+    @gb.next_component(@right2)
+    _add_component comp
+    @right2
+  end
+  def focus comp
+    case comp
+    when :left
+      @vim.goto_component @left
+    when :top_right
+      @vim.goto_component @right1
+    when :bottom_right
+      @vim.goto_component @right2
+    else
+      @vim.goto_component comp
+    end
+  end
+  private
+  # does nothing at present
+  def _add_component comp  #:nodoc:
+  end
+  # creates a Vimplit containing 3 panes. Sets events in order to
+  # increase and decrease panes/windows.
+  def _create_vimsplit  #:nodoc:
+    @vim = VimSplit.new nil, :row => @row, :col => @col, :width => @width, :height => @height, :weight => @weight, :orientation => :VERTICAL, :suppress_borders => true do |s|
+      s.parent_component = self
+      #s.target_window = @form.window
+      #s.add @left, :FIRST
+      #s.add @right1, :SECOND
+      #s.add @right2, :SECOND
+      s.bind :COMPONENT_RESIZE_EVENT do |e|
+        alert "masterdetail got a resize event #{e.type}, #{e.source}  "
+        case e.type
+        when :INCREASE
+          case e.source
+          when @right2
+            increase_body
+          when @right1
+            increase_headers
+          when @left
+            alert "masterdetail left increase - not handled"
+
+          end
+        when :DECREASE
+          case e.source
+          when @right2
+            increase_headers
+          when @right1
+            increase_body
+          when @left
+            @left.width -= 1
+            @right2.col -=1
+            @right1.col -=1
+            @right1.width +=1
+            @right2.width +=1
+            @right2.repaint_required  true
+            @right1.repaint_required  true
+            @left.repaint_required  true
+            alert "masterdetail left decrease"
+          end
+        when :EXPAND
+          case e.source
+          when @right2
+            h = 3
+            @right2.row(@right1.row + h)
+            oldh = @right1.height
+            @right1.height = h
+            @right1.current_index = 0
+            @right2.height += (oldh - h)
+            @right2.repaint_required  true
+            @right1.repaint_required  true
+          when @right1
+            h = 3
+            @right2.row(@right2.row + (@right2.height - 3))
+            oldh = @right2.height
+            @right2.height = h
+            #@right1.current_index = 0
+            @right1.height += (oldh - h)
+            @right2.repaint_required  true
+            @right1.repaint_required  true
+          end
+        end
+      end # bind
+    end
+  end # def
+  # increase the top right pane and reduces lower one
+  # TODO: to take into account multiplier
+  def increase_headers  #:nodoc:
+    @right2.row @right2.row()+1
+    @right1.height +=1
+    @right2.height -=1
+    @right2.repaint_required  true
+    @right1.repaint_required  true
+  end
+  # decrease the top right pane and increase lower one
+  # TODO: to take into account multiplier
+  def increase_body  #:nodoc:
+    @right2.row @right2.row()-1
+    @right1.height -=1
+    @right2.height +=1
+    @right2.repaint_required  true
+    @right1.repaint_required  true
+  end
+end # class

data/lib/rbcurse/experimental/widgets/multiform.rb

@@ -0,0 +1,330 @@
+=begin
+  * Name: Multiform.rb
+  * Description   View (cycle) multiple forms
+  * Author: rkumar (arunachalesha)
+  * file created  2011-10-17 8:18 PM 
+  --------
+  * License:
+    Same as Ruby's License (http://www.ruby-lang.org/LICENSE.txt)
+
+=end
+require 'rbcurse'
+
+include RubyCurses
+module RubyCurses
+  extend self
+
+  # Trying to implement TabbedPanes using a multiform approach, but no more windows
+  # or pads. Try to keep it as simple as possible
+  class MultiForm < Widget
+    dsl_accessor :title
+
+
+    def initialize form = nil, config={}, &block
+      @focusable = true
+      @window = form.window
+      @row_offset = @col_offset = 1
+      @bmanager = BufferManager.new self
+      @forms = []
+      super
+      init_vars
+
+    end
+    def init_vars
+      super
+      # the following allows us to navigate buffers with :bn :bp etc (with Alt pressed)
+      bind_key(?\M-:, :buffer_menu)
+      bind_key(?\M-;, :buffer_menu)
+      # bind_key([?\C-x, ?f], :file_edit)
+      bind_key([?\C-x, ?k], :delete_component)
+      bind_key([?\C-x, ?\C-b], :list_components)
+      bind_key(?\M-n, :goto_next_component)
+      bind_key(?\M-p, :goto_prev_component)
+      bind_key(?\M-1, :goto_first_component)
+      # easily cycle using p. n is used for next search.
+      #bind_key(?p, :buffer_previous)
+      @suppress_borders = false 
+      @repaint_all = true 
+      @name ||= "multiform"
+    end
+    ## returns current buffer
+    # @return  [RBuffer] current buffer
+    def current_component
+      @bmanager.current
+    end
+    ## 
+    # multi-container
+    def handle_key ch  #:nodoc:
+      @current_component.repaint
+      @current_component.window.wrefresh
+      $log.debug " MULTI handle_key #{ch}, #{@current_component}"
+      ret = :UNHANDLED
+      return :UNHANDLED unless @current_component
+      ret = @current_component.handle_key(ch)
+      $log.debug " MULTI comp #{@current_component} returned #{ret} "
+      if ret == :UNHANDLED
+        # check for bindings, these cannot override above keys since placed at end
+        begin
+          ret = process_key ch, self
+          $log.debug " MULTI = process_key returned #{ret} "
+          if ch > 177 && ch < 187
+            n = ch - 177
+            component_at(n)
+            # go to component n
+          end
+        rescue => err
+#          $error_message = err # changed 2010 dts  
+          $error_message.value = err.to_s
+          #@form.window.print_error_message PLEASE CREATE LABEL
+          $log.error " Multicomponent process_key #{err} "
+          $log.debug(err.backtrace.join("\n"))
+          alert err.to_s
+        end
+        return :UNHANDLED if ret == :UNHANDLED
+      end
+      @current_component.repaint
+      @current_component.window.wrefresh
+      FFI::NCurses.update_panels
+
+      # check for any keys not handled and check our own ones
+      return ret # 
+    end
+    def repaint
+      print_border if (@suppress_borders == false && @repaint_all) # do this once only, unless everything changes
+      return unless @current_component
+      $log.debug " MULTIFORM REPAINT "
+      ret = @current_component.repaint
+    end
+    def print_border  #:nodoc:
+      $log.debug " #{@name} print_borders,  #{@graphic.name} "
+      color = $datacolor
+      @graphic.print_border_only @row, @col, @height-1, @width, color #, Ncurses::A_REVERSE
+      print_title
+    end
+    def print_title  #:nodoc:
+      $log.debug " print_title #{@row}, #{@col}, #{@width} #{@title} "
+      @graphic.printstring( @row, @col+(@width-@title.length)/2, @title, $datacolor, @title_attrib) unless @title.nil?
+    end
+    # this is just a test of the simple "most" menu
+    # can use this for next, prev, first, last, new, delete, overwrite etc
+    def buffer_menu
+      menu = PromptMenu.new self 
+      menu.add(menu.create_mitem( 'l', "list buffers", "list buffers ", :list_components ))
+      item = menu.create_mitem( 'b', "Buffer Options", "Buffer Options" )
+      menu1 = PromptMenu.new( self, "Buffer Options")
+      menu1.add(menu1.create_mitem( 'n', "Next", "Switched to next buffer", :goto_next_component ))
+      menu1.add(menu1.create_mitem( 'p', "Prev", "Switched to previous buffer", :goto_prev_component ))
+      menu1.add(menu1.create_mitem( 'f', "First", "Switched to first buffer", :goto_first_component ))
+      menu1.add(menu1.create_mitem( 'l', "Last", "Switched to last buffer", :goto_last_component ))
+      menu1.add(menu1.create_mitem( 'd', "Delete", "Deleted buffer", :delete_component ))
+      item.action = menu1
+      menu.add(item)
+      # how do i know what's available. the application or window should know where to place
+      menu.display @form.window, $error_message_row, $error_message_col, $datacolor #, menu
+    end
+
+
+    def goto_next_component
+      perror "No other buffer" and return if @bmanager.size < 2
+
+      @current_component = @bmanager.next
+      set_current_component
+      # set_form_row and shit
+    end
+
+    def goto_prev_component
+      perror "No other buffer" and return if @bmanager.size < 2
+
+      @current_component = @bmanager.previous
+      $log.debug " buffer_prev got #{@current_component} "
+      set_current_component
+    end
+    def goto_first_component
+      @current_component = @bmanager.first
+      $log.debug " buffer_first got #{@current_component} "
+      set_current_component
+    end
+    def goto_last_component
+      @current_component = @bmanager.last
+      $log.debug " buffer_last got #{@current_component} "
+      set_current_component
+    end
+    def delete_component
+      if @bmanager.size > 1
+        @bmanager.delete_at
+        @current_component = @bmanager.previous
+        set_current_component
+      else
+        perror "Only one buffer. Cannot delete."
+      end
+    end
+
+    def component_at index
+      cc = @bmanager.element_at index
+      return unless cc 
+      @current_component = cc 
+      #$log.debug " buffer_last got #{@current_component} "
+      set_current_component
+    end
+    def add_form title, config={}, &blk
+      $log.debug "XXX: add_form window coords were hwtl #{@height} , #{@width} , #{@top} , #{@left} "
+      #w = VER::Window.new 16, 30, 2, 2 #@height-1, @width-1, @top, @left
+      w = VER::Window.new @height-2, @width-2, @row+1, @col+1
+      #w.box(0,0)
+      frm = Form.new w
+      @forms << frm
+      frm.parent_form = @form
+      frm.add_cols=@col+@col_offset
+      frm.add_rows=@row+@row_offset
+      @current_component = @bmanager.add frm, title
+      set_current_component
+      yield frm if block_given?
+      return @current_component # not a form but a Rcomponent containing component and title
+    end
+    def _add_to(index, component)
+      raise ArgumentError, "index out of bounds" unless @forms[index]
+      component.set_form(@forms[index])
+      $log.debug "XXX: comp r c #{component.row} #{component.col} "
+      component.row += @row
+      component.col += @col
+      $log.debug "XXX: after comp r c #{component.row} #{component.col} "
+    end
+    ##
+    # Add a component with a title
+    # @param [Widget] component
+    # @param [String] title
+    def add component, title
+      component.row = @row+@row_offset+0 # FFI changed 1 to 0 2011-09-12 
+      component.col = @col+@col_offset+0 # FFI changed 1 to 0 2011-09-12 
+      component.width = @width-2
+      component.height = @height-2
+      component.form = @form
+      component.override_graphic(@graphic)
+      @current_component = @bmanager.add component, title
+      set_current_component
+      set_form_row ## FFI added 2011-09-12 to get cursor at start when adding
+      $log.debug " ADD got cb : #{@current_component} "
+    end
+    def set_current_component
+      @title = @current_component.title
+      @current_component = @current_component.component
+      @current_component.repaint #2011-10-17 need to set all comps to repaint XXX
+      @current_component.window.wrefresh
+      @current_component.window.show
+      FFI::NCurses.update_panels
+      set_form_row
+      #@current_title = @current_component.title
+      #@current_component.repaint_all true 2011-10-17 need to set all comps to repaint XXX
+    end
+    def perror errmess
+      alert errmess
+      #@form.window.print_error_message errmess
+    end
+    def list_components
+      $log.debug " TODO buffers_list: #{@bmanager.size}  "
+      menu = PromptMenu.new self 
+      @bmanager.each_with_index{ |b, ix|
+        aproc = Proc.new { component_at(ix) }
+        name = b.title
+        num = ix + 1
+        menu.add(menu.create_mitem( num.to_s, name, "Switched to buffer #{ix}", aproc ))
+      }
+      menu.display @form.window, $error_message_row, $error_message_col, $datacolor
+    end
+    # required otherwise some components may not get correct cursor position on entry
+    # e.g. table
+    def on_enter
+      set_form_row # 2011-10-17 
+    end
+    # nothing happening, the cursor goes to 1,1 and does not move
+    # alhough the fields can be edited XXX
+    def set_form_row  #:nodoc:
+      if !@current_component.nil?
+        #$log.debug " #{@name} set_form_row calling sfr for #{@current_component.name} "
+        #fc = @current_component.widgets[0]
+        fc = @current_component.get_current_field
+        fc ||= @current_component.widgets[0]
+        fc.set_form_row  if fc
+        #fc.set_form_col 
+      end
+    end
+    # ADD HERE
+  end # class multicontainer
+  ##
+  # Handles multiple buffers, navigation, maintenance etc
+  # Instantiated at startup of 
+  #
+  class BufferManager
+    include Enumerable
+    def initialize source
+      @source = source
+      @buffers = [] # contains RBuffer
+      @counter = 0
+      # for each buffer i need to store data, current_index (row), curpos (col offset) and title (filename).
+    end
+    def element_at index
+      @buffers[index]
+    end
+    def each
+      @buffers.each {|k| yield(k)}
+    end
+
+    ##
+    # @return [RBuffer] current buffer/file
+    ##
+    def current
+      @buffers[@counter]
+    end
+    ##
+    # Would have liked to just return next buffer and not get lost in details of caller
+    #
+    # @return [RBuffer] next buffer/file
+    ##
+    def next
+      @counter += 1
+      @counter = 0 if @counter >= @buffers.size
+      @buffers[@counter]
+    end
+    ##
+    # @return [RBuffer] previous buffer/file
+    ##
+    def previous
+      $log.debug " previous bs: #{@buffers.size}, #{@counter}  "
+      @counter -= 1
+      return last() if @counter < 0
+      $log.debug " previous ctr  #{@counter} "
+      @buffers[@counter]
+    end
+    def first
+      @counter = 0
+      @buffers[@counter]
+    end
+    def last
+      @counter = @buffers.size - 1
+      @buffers[@counter]
+    end
+    ##
+    def delete_at index=@counter
+      @buffers.delete_at index
+    end
+    def delete_by_name name
+      @buffers.delete_if {|b| b.filename == name }
+    end
+    def insert component, position, title=nil
+      anew = RComponents.new(component, title)
+      @buffers.insert position, anew
+      @counter = position
+      return anew
+    end
+    def add component, title=nil
+      #$log.debug " ADD H: #{component.height} C: #{component.width} "
+      insert component, @buffers.size, title
+    end
+    def size
+      @buffers.size
+    end
+    alias :count :size
+  end
+  RComponents = Struct.new(:component, :title)
+
+end # modul