hilfer 0.9.5 → 0.10.0

data/lib/hilfer/scite_editor.rb

@@ -1,61 +1,84 @@
+require 'hilfer/window.rb'
+
 # handle director interface to scite
 class SciteEditor
-	# options can contain :debug
-	# view is a GtkTreeView
-	def initialize( options = {} )
-		@scite_pipe_name = "/tmp/#{ENV['USER']}.#{Process.pid}.scite"
-		@director_pipe_name = "/tmp/#{ENV['USER']}.#{Process.pid}.director"
-		
-		# delete these if they already exist because we
-		# need to use their existence to determine if scite
-		# is running
-		File.exists?( @scite_pipe_name ) && File.unlink( @scite_pipe_name )
-		File.exists?( @director_pipe_name ) && File.unlink( @director_pipe_name )
-		
-		# this is an array of TreeViewer objects
-		@views = []
-		# the command-line options
-		@options = options
-	end
+  # options can contain :debug
+  # view is a GtkTreeView
+  def initialize( options = {} )
+    @scite_pipe_name = "/tmp/#{ENV['USER']}.#{Process.pid}.scite"
+    @director_pipe_name = "/tmp/#{ENV['USER']}.#{Process.pid}.director"
+    
+    cleanup
+    
+    # this is an array of TreeViewer objects
+    @views = []
+    # the command-line options
+    @options = options
+  end
+  
+  attr_reader :options
+  attr_reader :scite_pid
   
   def launched?
-    File.exists?( @director_pipe_name )
+    !@scite_pid.nil?
+  end
+  
+  def window
+    @window ||= Window.pid( @scite_pid )
+  end
+  
+  def reset
+    @scite_pid = nil
+    @window = nil
+  end
+  
+  def kill
+    `kill #{@scite_pid}`
+    reset
+    cleanup
   end
   
   def cleanup
     FileUtils.rm @scite_pipe_name if File.exist? @scite_pipe_name 
-		FileUtils.rm @director_pipe_name if File.exist? @director_pipe_name
+    FileUtils.rm @director_pipe_name if File.exist? @director_pipe_name
     FileUtils.rm pipe_name_file if File.exist? pipe_name_file
   end
 
-	# send some command
-	def send( cmd, arg = '' )
-		launch
-		File.open( @scite_pipe_name, 'a' ) do |file|
-			file.print( cmd + ":" + arg.to_s, "\n" )
-      puts "sending: #{cmd}:#{arg.to_s}" if $options[:debug]
-		end
-	end
+  # send a command to SciTE
+  def send_cmd( cmd, arg = '' )
+    launch
+    File.open( @scite_pipe_name, 'a' ) do |file|
+      file.puts "#{cmd.to_s}:#{arg.to_s}"
+      puts "sending: #{cmd.to_s}:#{arg.to_s}" if @options[:debug]
+    end
+  end
+  
+  # bring the SciTE instance to the current
+  # desktop and raise it.
+  def activate
+    window.activate unless window.nil?
+  end
 
-	# open files in scite
-	def open_action( files )
-		files.each { |x| send "open", x.path }
-    send 'identity',0
-	end
+  # open files in scite
+  def open_action( files )
+    files.each { |x| send_cmd "open", x.path }
+    send_cmd :identity, 0
+    activate
+  end
   
   def dump
-    %w{dyn local user base embed}.each {|x| send 'enumproperties', x}
-    #~ send 'askproperty','dyn:CurrentWord'
+    %w{dyn local user base embed}.each {|x| send_cmd 'enumproperties', x}
+    #~ send_cmd 'askproperty','dyn:CurrentWord'
   end
 
   # fetch the current file in scite
-	def synchronize_path
-		send 'askfilename'
-	end
+  def synchronize_path
+    send_cmd :askfilename
+  end
   
   # shut down editor, if it's open
   def quit
-    send 'quit' if launched?
+    send_cmd :quit if launched?
   end
   
   # insert text to editor, at current caret, or overwriting the current selection
@@ -66,21 +89,21 @@ class SciteEditor
       when arg.respond_to?( :join ); arg.join( '\\n' ) + '\\n'
       else; arg.to_s
     end
-    send 'insert', value
+    send_cmd :insert, value
   end
 
-	# send selection to all registered views
-	def set_selection ( fs_path )
-		@views.each { |v| v.synchronise_editor_path( fs_path ) }
-	end
+  # send selection to all registered views
+  def set_selection ( fs_path )
+    @views.each { |v| v.synchronise_editor_path( fs_path ) }
+  end
 
-	def register_view( view )
-		@views << view
-	end
+  def register_view( view )
+    @views << view
+  end
 
-	def unregister_view( view )
-		@views.delete( view )
-	end
+  def unregister_view( view )
+    @views.delete( view )
+  end
   
   def pipe_name_file
     @pipe_name_file ||= "/tmp/#{ENV['USER']}.hilfer.scite"
@@ -93,98 +116,110 @@ class SciteEditor
     end
   end
 
+  # start up the editor if there isn't already one
+  # calling it when the editor is already open does nothing
+  def launch
+    return if launched?
+    
+    # create the director pipe if it isn't there already
+    unless File.exists?( @director_pipe_name )
+      system( "mkfifo #{@director_pipe_name}" )
+    end
+    
+    scite_cmd = "/usr/bin/scite"
+    
+    # start a process to clean up when scite exits
+    @scite_pid = fork()
+    if @scite_pid.nil?
+      # in child, so exec scite from here, so this pid will become scite's pid
+      # not passing the first arg as a 2 element array doesn't work. So
+      # use the same value for the command and as argv[0]
+      exec(
+        [ scite_cmd ] *2,
+        "-ipc.director.name=#{@director_pipe_name}",
+        "-ipc.scite.name=#{@scite_pipe_name}"
+      )
+    else
+      start_cleanup
+    end
+    
+    puts "scite launched with pid #{@scite_pid}" if @options[:debug]
+    
+    # start the listener thread
+    start_listener
+  end
+  
 protected
 
-	# start up the editor if there isn't already one
-	# calling it when the editor is already open does nothing
-	def launch
-		# create the director pipe if it isn't there already
-		if !File.exists?( @director_pipe_name )
-			system( "mkfifo #{@director_pipe_name}" )
-		end
-		
-		# scite already open, so don't launch another instance
-		return if File.exists? @scite_pipe_name
-		
-		cmd = <<EOF
-/usr/bin/scite
--ipc.director.name=#{@director_pipe_name}
--ipc.scite.name=#{@scite_pipe_name}
-EOF
-		oneline = cmd.gsub( "\n", " ")
-		child_pid = fork
-		if child_pid.nil?
-      # start the editor and wait for it to end
-			system( oneline )
-			
-			# scite ended, so delete the pipes
+  def start_cleanup
+    Thread.new do
+      # wait for Scite to end, and cleanup
       begin
-        File.unlink @director_pipe_name if File.exist? @director_pipe_name
-        File.unlink @scite_pipe_name if File.exist? @scite_pipe_name
+        puts "waiting for scite(#{@scite_pid})" if @options[:debug]
+        Process.wait( @scite_pid )
+        cleanup
+        reset
+        puts "cleaned up scite pipes" if @options[:debug]
       rescue Exception => e
-        puts e.message
+        puts "e: #{e.inspect}"
+        puts e.backtrace
       end
-			
-			# unfork, don't trigger a SystemException
-			exit! true
-		else
-			# start the listener thread
-			start_listener
-		end
-	end
-	
-	def start_listener
-		
-		sleep 0.1 while !File.exists? @scite_pipe_name
-		
-		Thread.new( self ) do |arg|
-			begin
-				arg.listen
-			rescue Errno::ENOENT
-				break
-			rescue Exception => e
-				print "listener thread ended: ", e.inspect, "\n"
-				e.backtrace.each { |x| print x, "\n" }
-			end
-		end
-		
-	end
+    end
+  end
+  
+  def start_listener
+    
+    sleep 0.1 while !File.exists? @scite_pipe_name
+    
+    Thread.new( self ) do |arg|
+      begin
+        arg.listen
+      rescue Errno::ENOENT
+        break
+      rescue Exception => e
+        print "listener thread ended: ", e.inspect, "\n"
+        puts e.backtrace
+      end
+    end
+    
+  end
 
-	# respond to strings from scite
-	def listen
-		File.open( @director_pipe_name ).each( "\x0" ) do |line|
-			begin
-				line = line.slice(0...-1) if line[-1] = 0
-				print "heard #{line}\n" if $options[:debug]
-				case line
-					# scite sends one of these for each file opened
-					when /^opened:(.*)$/
-						set_selection( $1 )
+  # respond to strings from scite
+  def listen
+    File.open( @director_pipe_name ).each( "\x0" ) do |line|
+      begin
+        line = line.slice(0...-1) if line[-1] = 0
+        print "heard #{line}\n" if @options[:debug]
+        case line
+          # scite sends one of these for each file opened
+          when /^opened:(.*)$/
+            set_selection( $1 )
 
-					# scite sends one of these each time the buffer is switched
-					when /^switched:(.*)$/
-						set_selection( $1 )
+          # scite sends one of these each time the buffer is switched
+          when /^switched:(.*)$/
+            set_selection( $1 )
 
-					# response to askfilename, as sent by synchronize_path
-					when /^filename:(.*)$/
-						set_selection( $1 )
+          # response to askfilename, as sent by synchronize_path
+          when /^filename:(.*)$/
+            set_selection( $1 )
 
-					# the specified file has just been saved. Do nothing.
-					# TODO could check that it exists and add it if not.
-					when /^saved:(.*)$/
-					
-					when /^closed$/
+          # the specified file has just been saved. Do nothing.
+          # TODO could check that it exists and add it if not.
+          when /^saved:(.*)$/
+          
+          when /^closed$/
             puts "SciTE closing"
-						break
+            break
 
-					# print it out
-					else
-						print "unknown: ", line, "\n" if $options[:debug]
-				end
-			rescue Exception => e
-				print "caught Exception in listen: ", e.inspect, "\n"
-			end
-		end
-	end
+          # print it out
+          else
+            print "unknown: ", line, "\n" if @options[:debug]
+        end
+      rescue Exception => e
+        print "caught Exception in listen: ", e.inspect, "\n"
+        puts e.backtrace
+      end
+    end
+  end
 
 end

data/lib/hilfer/tree_viewer.rb

@@ -3,6 +3,7 @@ require 'pathname'
 require 'hilfer/hilfer_item.rb'
 require 'hilfer/scite_editor.rb'
 require 'hilfer/hilfer_model.rb'
+require 'hilfer/extensions.rb'
 
 # try to load Gnome terminal
 begin
@@ -42,15 +43,6 @@ rescue
   HAS_SUBVERSION = false
 end
 
-
-module Gdk
-  class EventKey
-    def inspect
-      "#<Gdk::EventKey keycode=#{hardware_keycode} state=#{state.inspect}"
-    end
-  end
-end
-
 =begin
 This is the tree viewer object. It contains a GtkTreeView
 and references an editor object. It also contains a HilferItem
@@ -148,11 +140,11 @@ class TreeViewer
 
     @view.signal_connect( 'row-expanded' ) do
       |view, iter, path|
-      print "expanding row: #{iter[0].path}, #{iter[0].populated?}\n" if $options[:debug]
+      puts "expanding row: #{iter[0].path}, #{iter[0].populated?}" if $options[:debug]
       iter[0].status = :expanded
       child = iter.first_child
       loop do
-        print "expanded child: #{child[0].path}, #{child[0].populated?}\n" if $options[:debug]
+        puts "expanded child: #{child[0].path}, #{child[0].populated?}" if $options[:debug]
         populate( @view.model, child[0], child ) unless child[0].populated?
         break if !child.next!
       end
@@ -328,14 +320,14 @@ class TreeViewer
 
   # handle keypresses
   def init_keys
-    @view.signal_connect( 'key-press-event' ) do
-      |widget,event|
-      puts event.inspect if $options[:debug]
+    @view.signal_connect( 'key-press-event' ) do |widget,event|
+      puts "event: #{event.inspect}" if $options[:debug]
+      
       retval = true
       case
         # enter - go into directory
         # or open all selected files
-        when event.hardware_keycode == 36 && !event.state.control_mask?
+        when event.match( /return/i, /enter/i ) && !event.state.control_mask?
           items = []
           
           # fetch all selected items
@@ -347,7 +339,7 @@ class TreeViewer
           open_action( items )
           
         # ctrl-enter opens new window with the selected root(s)
-        when event.hardware_keycode == 36 && event.state.control_mask?
+        when event.match( /return/i, /enter/i ) && event.state.control_mask?
           widget.selection.selected_each do |model, path, iter|
             new_path = 
             if !iter[0].dir?
@@ -362,14 +354,14 @@ class TreeViewer
           end
           
         # backspace - go up to parent directory
-        when event.hardware_keycode == 22
+        when event =~ 'BackSpace'
           # go up one directory
           temp = Pathname.new( @root_item.path )
           @root_item.path = temp.parent.realpath.to_s
           go_into( @root_item.path )
           
         # del on main keyboard or keypad deletes a file
-        when [91,107].include?( event.hardware_keycode )
+        when event =~ /Delete/
           iters = []
           widget.selection.selected_each do |model, path, iter|
             iters << iter
@@ -377,7 +369,7 @@ class TreeViewer
           confirm_delete_files( iters )
           
         # ctrl-e and F2 edits the file name
-        when ( event.hardware_keycode == 26 && event.state.control_mask? ) || event.hardware_keycode == 68
+        when event.match( :e, :f2 ) && event.state.control_mask?
           # make sure all the files are selected
           rows = widget.selection.selected_rows
           rows.each do |path|
@@ -391,11 +383,11 @@ class TreeViewer
           end
         
         # ctrl-d sends some debug/info commands to scite
-        when event.hardware_keycode == 40 && event.state.control_mask?  && !event.state.shift_mask?
+        when event.d? && event.state.control_mask? && !event.state.shift_mask?
           @editor.dump
           
         # ctrl-b sends the current selection to the editor
-        when event.hardware_keycode == 56 && event.state.control_mask?  && !event.state.shift_mask?
+        when event.b? && event.state.control_mask?  && !event.state.shift_mask?
           paths = []
           widget.selection.selected_each do |model, path, iter|
             # note use of single quotes
@@ -404,7 +396,7 @@ class TreeViewer
           @editor.insert paths
           
         # ctrl-c copies current selections as text
-        when event.hardware_keycode == 54 && event.state.control_mask?  && !event.state.shift_mask?
+        when event.c? && event.state.control_mask?  && !event.state.shift_mask?
           paths = ""
           
           # fetch all selected items
@@ -416,7 +408,7 @@ class TreeViewer
           Gtk::Clipboard.get( Gdk::Selection::CLIPBOARD ).text = paths
         
         # ctrl-v selects the files in the clipboard 
-        when event.hardware_keycode == 55 && event.state.control_mask?  && !event.state.shift_mask?
+        when event.v? && event.state.control_mask?  && !event.state.shift_mask?
           text = Gtk::Clipboard.get( Gdk::Selection::CLIPBOARD ).wait_for_text
           paths = text.strip.split( /\s*\n\s*/ )
           location_path = Pathname.new( @root_item.path )
@@ -428,27 +420,27 @@ class TreeViewer
           select_fs_paths( paths )
           
         # ctrl-n opens new window with same root
-        when event.hardware_keycode == 57 && event.state.control_mask?
+        when event.n? && event.state.control_mask?
           TreeViewerWindow.new( @root_item.path, @editor )
           
         # ctrl-y synchronizes with current editor file
-        when event.hardware_keycode == 29 && event.state.control_mask?
+        when event.y? && event.state.control_mask?
           # make sure other windows don't synchronize
           @expecting_synchronize_path = true
           # ask editor for current file and sync
           @editor.synchronize_path
           
         # alt-y toggles automatic synchronization
-        when event.hardware_keycode == 29 && event.state.mod1_mask?
+        when event.y? && event.state.mod1_mask?
           @auto_synchronize_path = !@auto_synchronize_path
 
         # ctrl-r refreshes from filesystem
-        when event.hardware_keycode == 27 && event.state.control_mask?
+        when event.r? && event.state.control_mask?
           refresh
           
         # ctrl-t opens a terminal window on the given directorties.
         # Uses gnome-terminal and opens directories in tabs
-        when event.hardware_keycode == 28 && event.state.control_mask? && !event.state.shift_mask?
+        when event.t? && event.state.control_mask? && !event.state.shift_mask?
           # collect all unique directories
           dirs = []
           widget.selection.selected_each do |model, path, iter|
@@ -465,22 +457,22 @@ class TreeViewer
           terminal.launch( dirs )
           
         # alt-l toggles the location bar
-        when event.hardware_keycode == 46 && event.state.mod1_mask?
+        when event.l? && event.state.mod1_mask?
           @location.no_show_all = true
           @location.visible = !@location.visible?
           
         # alt-q toggles whether shutdown is automatic or not
-        when event.hardware_keycode == 24 && event.state.mod1_mask?
+        when event.q? && event.state.mod1_mask?
           $options[:quit_editor] = !$options[:quit_editor]
           
         # ctrl-* on keypad means expand the entire tree
-        when event.hardware_keycode == 63 && event.state.control_mask?
+        when event =~ 'KP_Multiply' && event.state.control_mask?
           # 100 levels of directories should be enough...
           populate( @view.model, @root_item, nil, 100 )
           @view.expand_all
           
         # * on keypad means expand subtree
-        when event.hardware_keycode == 63 && event.state.empty?
+        when event =~ 'KP_Multiply' && event.state.empty?
           widget.selection.selected_rows.each do |path|
             iter = @view.model.get_iter( path )
             if iter[0].dir?
@@ -489,11 +481,11 @@ class TreeViewer
           end
           
         # shift-/ on keypad means collapse the entire tree
-        when event.hardware_keycode == 112 && event.state.shift_mask?
+        when event =~ 'KP_Divide' && event.state.shift_mask?
           @view.collapse_all
           
         # ctrl-left means go to parent
-        when event.hardware_keycode == 100 && event.state.control_mask?
+        when event =~ /left$/i && event.state.control_mask?
           widget.selection.selected_each do |model, path, iter|
             if iter.parent != nil
               iter.parent[0].last_child_used = path
@@ -505,7 +497,7 @@ class TreeViewer
           end
         
         # ctrl-right means go to last used path, or first child
-        when event.hardware_keycode == 102 && event.state.control_mask?
+        when event.right? && event.state.control_mask?
           widget.selection.selected_each do |model, path, iter|
             if iter[0].dir?
               widget.expand_row( iter.path, false )
@@ -521,7 +513,7 @@ class TreeViewer
           end
           
         # ctrl-up means go to previous sibling with children
-        when event.hardware_keycode == 98 && event.state.control_mask?
+        when event.up? && event.state.control_mask?
           widget.selection.selected_each do |model, path, iter|
             if iter[0].dir?
               while path.prev!
@@ -537,7 +529,7 @@ class TreeViewer
           end
 
         # ctrl-down means go to next sibling with children
-        when event.hardware_keycode == 104 && event.state.control_mask?
+        when event.down? && event.state.control_mask?
           widget.selection.selected_each do |model, path, iter|
             if iter[0].dir?
               while iter.next!
@@ -560,7 +552,7 @@ class TreeViewer
           end
 
         # shift-left means select parent
-        when event.hardware_keycode == 100 && event.state.shift_mask?
+        when event.left? && event.state.shift_mask?
           widget.selection.selected_each do |model, path, iter|
             if iter.parent != nil
               select_children( widget, iter.parent )
@@ -568,7 +560,7 @@ class TreeViewer
           end
 
         # shift-right means select children
-        when event.hardware_keycode == 102 && event.state.shift_mask?
+        when event.right? && event.state.shift_mask?
           widget.selection.selected_each do |model, path, iter|
             if iter[0].dir?
               select_children( widget, iter )
@@ -576,13 +568,13 @@ class TreeViewer
           end
 
         # left means close level(s)
-        when event.hardware_keycode == 100 && event.state.empty?
+        when event.left? && event.state.empty?
           widget.selection.selected_each do |model, path, iter|
             widget.collapse_row( path ) if iter[0].dir?
           end
 
         # right means open level(s)
-        when event.hardware_keycode == 102
+        when event.right?
           widget.selection.selected_each do
             |model, path, iter|
             # false means don't expand children
@@ -595,7 +587,7 @@ class TreeViewer
           # pass keypress to all locators
           @locators.each {|x| retval = x.handle_keypress( widget, event ) and retval }
           if $options[:debug] && !retval
-            print "hardware_keycode: #{event.hardware_keycode}\n"
+            puts "not handled"
           end
       end
       retval
@@ -825,7 +817,7 @@ class TreeViewer
         # recursively populate files, so the TreeView
         # knows to draw the expanders
         if ( ( File.directory?( next_item_path ) && level < levels_to_populate ) || iter[0].expanded? )
-          print "populating level #{level} #{iter[0].path}\n" if $options[:debug]
+          puts "populating level #{level} #{iter[0].path}" if $options[:debug]
           # populate children
           populate( model, iter[0], iter, levels_to_populate, level + 1 )
         end
@@ -833,8 +825,8 @@ class TreeViewer
       rescue Errno::EACCES
         # mostly to protect against permissions errors
       rescue Exception => ex
-        print "caught exception: #{ex} #{ex.class}\n"
-        ex.backtrace.each { |x| print x, "\n" }
+        puts "caught exception: #{ex} #{ex.class}"
+        puts ex.backtrace
       end
 
     end

data/lib/hilfer/tree_viewer_window.rb

@@ -9,15 +9,15 @@ class TreeViewerWindow
 
   def initialize( root_fs_path, editor )
     @window = Gtk::Window.new
-
+    
     # initialize viewer with a path
     @editor = editor
-
+    
     # location bar
     @location = Gtk::Entry.new
-
+    
     @tv = TreeViewer.new( root_fs_path, editor, @window, @location )
-
+    
     # add scrollbars
     @scroll = Gtk::ScrolledWindow.new( nil, nil )
     @scroll.set_policy( Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC )

data/lib/hilfer/version.rb

@@ -1,3 +1,3 @@
 module Hilfer
-  VERSION = '0.9.5'
+  VERSION = '0.10.0'
 end