rbcurse 1.1.5 → 1.2.0.pre

data/lib/rbcurse/extras/directorylist.rb

@@ -0,0 +1,445 @@
+require 'rbcurse'
+require 'fileutils'
+require 'rbcurse/rlistbox'
+require 'rbcurse/vieditable'
+require 'rbcurse/undomanager'
+##
+# Created on : Wed Sep 22 22:30:13 IST 2010
+# (c) rkumar (arunachalesha)
+#
+module RubyCurses
+  # Display a directory listing, allowing user to drill down on pressing Enter
+  # on a directory, or sort when pressing enter on header row.
+  class DirectoryList < Listbox
+
+    include ViEditable
+
+    def initialize form, config={}, &block
+      @hide_dot_files = false
+      @hide_others = false
+      @curpos = 0
+      super
+
+      #@current_path ||= Dir.getwd # setting it causes selection not to fire if same one
+      # is selected first
+      @_header_array = [ "Attr", "Size", "Modified" , "Name" , "<Order_by_Extension>" ]
+      @_header = " %s %8s  %19s %s   %s " % @_header_array
+    end
+    def init_vars
+      # which rows are not data, thus don't fire, or give error
+      @_non_data_indices = []
+      @_header_row_index   = 0
+      @_first_data_index = 1
+      @one_key_selection = false # this allows us to map keys to methods
+      vieditable_init_listbox
+      undom = SimpleUndo.new self
+      bind_key(?\M-h, :scroll_left)
+      bind_key(?\M-l, :scroll_right)
+      bind_key(KEY_RIGHT, :cursor_forward)
+      bind_key(KEY_LEFT, :cursor_backward)
+      bind_key(?$, :end_of_line)
+      bind_key(?\C-e, :end_of_line)
+      bind_key(?\C-a, :start_of_line)
+      bind_key(?a, :select_all)
+      bind_key(?*, :invert_selection)
+      bind_key(?u, :clear_selection)
+      bind_key(?+, :ask_select)
+      bind_key(?-, :ask_unselect)
+      bind_key(?I) { @hide_dot_files = !@hide_dot_files; prune_entries; }
+      super
+    end
+    # changing the current path, refreshes files
+    def current_path(*val)
+      if val.empty?
+        return @current_path
+      else
+        raise ArgumentError, "current_path should be a directory:#{val[0]}." unless File.directory? val[0]
+        oldvalue = @current_path
+        if oldvalue != val[0]
+          @current_path = val[0]
+          populate @current_path
+          fire_property_change(:current_path, oldvalue, @current_path)
+        end
+      end
+      self
+    end
+    # populate the list with file names
+    # @param [String, Array] string is the path name to populate with
+    #               Array is a list of files 
+    def populate path
+      case path
+      when String
+        @current_path = path
+        @entries = Dir.new(path).entries
+        @entries.delete(".")
+        # isn;t it a bit late here. it needs to happen to what's already there
+        @entries.delete_if {|x| x =~ /^\./} if @hide_dot_files
+        @entries.delete_if {|x| x =~ /\.bak$/ ||  x=~/\.swp$/} if @hide_others
+      when Array
+        path = @current_path
+        # we've been passed @entries so we don't need to put it again ??? XXX
+      end
+      # TODO K M etc
+      list @entries
+      @list.insert 0, @_header
+      @title = @current_path
+      @current_index = @_first_data_index
+    end
+    # called by parent's repaint
+    def convert_value_to_text file, crow
+      if @short
+        file
+      else
+        if crow == @_header_row_index
+          return file
+        else
+          # OUCH i don't know if its a header !!
+          fullname = File.join(@current_path, file)
+          fname = file
+          stat = File::Stat.new fullname
+          time = stat.mtime.to_s[0..18]
+          attr = stat.directory? ? "d" : "-"
+          attr << (stat.writable? ? "w" : "-")
+          attr << (stat.readable? ? "r" : "-")
+          attr << (stat.executable? ? "x" : "-")
+          fname << "/" if stat.directory? && fname[-1] != "/"
+          value = " %s %8d  %s %s" % [attr, stat.size, time, fname]
+          return value
+        end
+      end
+    end
+
+    def ___create_default_cell_renderer
+      cell_renderer( RubyCurses::DirectoryListCellRenderer.new "", {:color=>@color, :bgcolor=>@bgcolor, :parent => self, :display_length=> @width-2-@left_margin})
+    end
+    def _get_word_under_cursor line=@_header, pos=@curpos
+      finish = line.index(" ", pos)
+      start = line.rindex(" ",pos)
+      finish = -1 if finish.nil?
+      start = 0 if start.nil?
+      return line[start..finish]
+    end
+    # sorts entries by various parameters.
+    # Not optimal since it creates file stat objects each time rather than cacheing, but this is a demo of widgets
+    # not a real directory lister!
+    def sort_by key, reverse=false
+      # remove parent before sorting, keep at top
+      first = @entries.delete_at(0) if @entries[0]==".."
+      #key ||= @sort_key
+      sort_keys = { 'Name' => :name, 'Modified' => :mtime, "Size" => :size, "<Order_by_Extension>" => :ext, 'Attr' => :attr, "Accessed" => :atime }
+      key = sort_keys[key] if sort_keys.has_key? key
+      #if key == @sort_key
+        #reverse = true
+      #end
+      cdir=@current_path+"/"
+      case key
+      when  :size
+        @entries.sort! {|x,y| xs = File.stat(cdir+x); ys = File.stat(cdir+y); 
+          if reverse
+            xs.size <=> ys.size 
+          else
+            ys.size <=> xs.size 
+          end
+        }
+      when  :mtime
+        @entries.sort! {|x,y| xs = File.stat(cdir+x); ys = File.stat(cdir+y); 
+          if reverse
+            xs.mtime <=> ys.mtime 
+          else
+            ys.mtime <=> xs.mtime 
+          end
+        }
+      when  :atime
+        @entries.sort! {|x,y| xs = File.stat(cdir+x); ys = File.stat(cdir+y); 
+          if reverse
+            xs.atime <=> ys.atime 
+          else
+            ys.atime <=> xs.atime 
+          end
+        }
+      when  :name
+        @entries.sort! {|x,y| x <=> y 
+          if reverse
+            x <=> y
+          else
+            y <=> x
+          end
+        }
+      when  :ext
+        @entries.sort! {|x,y| 
+          if reverse
+            File.extname(cdir+x) <=> File.extname(cdir+y) 
+          else
+            File.extname(cdir+y) <=> File.extname(cdir+x) 
+          end
+        }
+      when  :attr
+        @entries.sort! {|x,y| xs = File.stat(cdir+x); ys = File.stat(cdir+y); 
+          x = xs.directory? ? "d" : "D"
+          y = ys.directory? ? "d" : "D"
+          if reverse
+            x <=> y
+          else
+            y <=> x
+          end
+        }
+      end
+      @sort_key = key
+      @entries.insert 0, first unless first.nil?  # keep parent on top
+      populate @entries
+    end
+    GIGA_SIZE = 1073741824.0
+    MEGA_SIZE = 1048576.0
+    KILO_SIZE = 1024.0
+
+    # Return the file size with a readable style.
+    def readable_file_size(size, precision)
+      case
+        #when size == 1 : "1 B"
+      when size < KILO_SIZE then "%d B" % size
+      when size < MEGA_SIZE then "%.#{precision}f K" % (size / KILO_SIZE)
+      when size < GIGA_SIZE then "%.#{precision}f M" % (size / MEGA_SIZE)
+      else "%.#{precision}f G" % (size / GIGA_SIZE)
+      end
+    end
+    def date_format t
+      t.strftime "%Y/%m/%d"
+    end
+
+    # on pressing Enter, execute this action.
+    # Here we take the current file and if its a directory, we step into it.
+    def fire_action_event
+      if @_non_data_indices.include? @current_index
+        Ncurses.error
+        return
+      end
+      if @_header_row_index == @current_index
+        # user hit enter on the header row. we determine column and sort.
+        header = _get_word_under_cursor
+        #@reverse = false
+        if header == @_last_header_sorted
+          @reverse = !@reverse # clicking 2 times won't reverse again
+        else 
+          @reverse = false
+        end
+        sort_by header.strip, @reverse
+        @_last_header_sorted = header
+        return
+      end
+      value = current_value
+      value = value.split.last
+      if value == ".."
+        _path = File.dirname(@current_path)
+      else
+        _path =  File.join(@current_path, value)
+      end
+      if File.directory? _path
+        populate _path
+      end
+
+      super
+    end
+    def addcol num
+      #@repaint_required = true
+      @repaint_footer_required = true # 2010-01-23 22:41
+      if @form
+        @form.addcol num
+      else
+        @parent_component.form.addcol num
+      end
+    end
+    # set cursor column position
+    # if i set col1 to @curpos, i can move around left right if key mapped
+    def set_form_col col1=@curpos
+      col1 ||= 0
+      @cols_panned ||= 0 # RFED16 2010-02-17 23:40
+      win_col = 0 # 2010-02-17 23:19 RFED16
+      col2 = win_col + @col + @col_offset + col1 + @cols_panned + @left_margin
+     setrowcol nil, col2 # 2010-02-17 23:19 RFED16
+    end
+    def start_of_line
+      @repaint_required = true if @pcol > 0 # tried other things but did not work
+      set_form_col 0
+      @pcol = 0
+    end
+    # this does not work, since the value in list is not the printed value
+    def end_of_line
+      blen = current_value.rstrip.length
+      set_form_col blen
+    end
+ 
+    def cursor_backward
+      repeatm {
+        if @curpos > 0
+          @curpos -= 1
+          set_form_col
+          #addcol -1
+        elsif @pcol > 0
+          @pcol -= 1
+        end
+      }
+      #@repaint_required = true
+      @repaint_footer_required = true # 2010-01-23 22:41
+    end
+  
+    
+    def cursor_forward
+      @curpos ||= 0
+      maxlen = @maxlen || @width-2
+      repeatm {
+        if @curpos < @width and @curpos < maxlen-1 # else it will do out of box
+          @curpos += 1
+          addcol 1
+        else
+          #@pcol += 1 if @pcol <= @buffer.length
+          # buffer not eixstent FIXME
+        end
+      }
+      set_form_col
+      #@repaint_required = true
+      @repaint_footer_required = true # 2010-01-23 22:41
+    end
+    def [](index)
+      @entries[index]
+    end
+ 
+    @private
+    def longest_line=(l)
+      @longest_line = l
+    end
+    def longest_line
+      @longest_line 
+    end
+    # modify a file name. 
+    # call using 'C'
+  def edit_line lineno=@current_index
+    line = @list[lineno]
+    fullname = File.join(@current_path, line)
+    prompt = "Rename file [#{line}] to: "
+    maxlen = 80
+    config={}; 
+    oldline = line.dup
+    config[:default] = line
+    ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+    $log.debug " rbgetstr returned #{ret} , #{str} "
+    return if ret != 0
+    @list[lineno].replace(str)
+    FileUtils.mv fullname, File.join(@current_path, str)
+    fire_handler :CHANGE, InputDataEvent.new(0,oldline.length, self, :DELETE_LINE, lineno, oldline)
+    fire_handler :CHANGE, InputDataEvent.new(0,str.length, self, :INSERT_LINE, lineno, str)
+    @repaint_required = true
+  end
+  def ask_select
+    prompt = "Select Files: "
+    maxlen = 80
+    config={}
+    config[:default] = @file_pattern if @file_pattern
+    ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+    return if ret != 0
+    @file_pattern = str
+    values = Dir.glob(str)
+    select_values values unless values.empty?
+    @repaint_required = true
+  end
+  def ask_unselect
+    prompt = "Unselect Files: "
+    maxlen = 80
+    config={}
+    config[:default] = @file_pattern if @file_pattern
+    ret, str = rbgetstr(@form.window, $error_message_row, $error_message_col,  prompt, maxlen, config)
+    return if ret != 0
+    @file_pattern = str
+    values = Dir.glob(str)
+    unselect_values values unless values.empty?
+    @repaint_required = true
+  end
+  def select_all
+    # don't select header row
+    add_row_selection_interval 1, row_count()
+  end
+  def invert_selection
+    1.upto(row_count()){|i| toggle_row_selection i }
+  end
+  # selects all rows with the values given, leaving existing selections
+  # intact
+  def select_values values
+    return unless values
+    values.each do |val|
+      row = @list.index val
+      add_row_selection_interval row, row unless row.nil?
+    end
+  end
+  # unselects all rows with the values given, leaving all other rows intact
+  def unselect_values values
+    return unless values
+    values.each do |val|
+      row = @list.index val
+      remove_row_selection_interval row, row unless row.nil?
+    end
+  end
+  private
+  # was meant to filter rows, but no point. since we can't undo the delete
+  # so we just call populate again. this method could get axed
+  def prune_entries
+    #@entries.delete_if {|x| x =~ /^\./} if @hide_dot_files
+    #@entries.delete_if {|x| x =~ /\.bak$/ ||  x=~/\.swp$/} if @hide_others
+    populate @current_path
+    set_form_row
+  end
+    ##
+  end # class
+
+  ## 
+  # A cell renderer should not changed the length of a line otherwise scrolling etc goes for a toss.
+  # The calling repaint method does trimming.
+  #
+  # A cell renderer can do small modifications, or color changing to data.
+  # Here we should color directories or bak files or hidden files, swap files etc differently
+  # Should this class do the trimming of data, else its hard to figure out what the extension
+  # is if its trimeed out. But then it would have to handle the panning too.
+  require 'rbcurse/listcellrenderer'
+  class DirectoryListCellRenderer < ListCellRenderer
+    #def initialize text="", config={}, &block
+      #super
+    #end
+    # sets @color_pair and @attr
+
+    ##
+    #  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
+    def repaint graphic, r=@row,c=@col, row_index=-1,value=@text, focussed=false, selected=false
+
+      prepare_default_colors focussed, selected
+      if row_index == 0
+        #nvalue = " %s %8s  %19s %s   %s " % value.split(",")
+        graphic.printstring r, c, "%-s" % value, @color_pair,@attr
+      else
+        $log.debug " CELL XXX GTETING  #{row_index} ,#{value}"
+
+
+        # ensure we do not exceed
+        if !@display_length.nil?
+          if value.length > @display_length
+            value = value[0..@display_length-1]
+          end
+        end
+        len = @display_length || value.length
+        graphic.printstring r, c, "%-*s" % [len, value], @color_pair,@attr
+      end
+    end
+    # ADD HERE 
+  end
+end # module
+# set filetype=ruby

data/lib/rbcurse/extras/directorytree.rb

@@ -0,0 +1,69 @@
+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