fxri 0.3.2 → 0.3.3

data/lib/Globals.rb

@@ -11,7 +11,7 @@ $cfg.app.font.name = ["Bitstream Vera Sans", "Verdana", "Trebuchet MS", "Tahoma"
 $cfg.ri_font = ["Bitstream Vera Sans Mono", "Courier New", "Courier"]
 $cfg.app.font.size = 8
 
-$cfg.app.width = 760	
+$cfg.app.width = 760
 $cfg.app.height = 480
 $cfg.search_delay = 0.1
 $cfg.minimum_letters_per_line = 20
@@ -40,7 +40,8 @@ $cfg.text.help = %|This is <b>fxri</b>, a graphical interface to the <em>Ruby</e
 '<em>array sort</em>': Everything that contains both <em>array</em> and <em>sort</em> (case insensitive).
 '<em>array -Fox</em>': Everything that contain the name <em>array</em> (case insensitive), but not <em>Fox</em> (case sensitive).
 After searching just press <em>down</em> to browse the search results. Press <em>Tab</em> to move back into the search field.
-If you have any questions, suggestions, problems, please contact me with <b>martin.ankerl@gmail.com</b>.|
+If you have any questions, suggestions, problems, please contact the current maintainer with <b>markus.prinz@qsig.org</b>.
+Original author: Martin Ankerl (<b>martin.ankerl@gmail.com</b>).|
 
 
 # prevent further modifications

data/lib/Icon_Loader.rb

@@ -2,34 +2,34 @@
 
 # Converts a Recursive_Open_Struct that contains filenames of PNG-icons into real icons.
 class Icon_Loader
-	# Create a new Icon_Loader. You need to specify the Fox-application.
-	def initialize(app)
-		@app = app
-	end
-	
-	# Takes each attribute of the given Recursive_Open_Struct,
-	# converts it into a real icon, and sets it.
-	def cfg_to_icons(cfg)
-		cfg.attrs.each do |attr|
-			value = cfg.send(attr.to_sym)
-			if (value.class == Recursive_Open_Struct)
-				cfg_to_icons(value)
-			else
-				# value is a filename
-				icon = make_icon(value)
-				cfg.send((attr + "=").to_sym, icon)
-			end
-		end
-	end
-	
-	# Constructs an icon from the given filename (from the icons directory).
-	def make_icon(filename)
-		filename = File.join("lib", "icons", filename)
-		icon = nil
-		File.open(filename, "rb") do |f|
-			icon = FXPNGIcon.new(@app, f.read, 0)
-		end
-		icon.create
-		icon
-	end
+  # Create a new Icon_Loader. You need to specify the Fox-application.
+  def initialize(app)
+    @app = app
+  end
+  
+  # Takes each attribute of the given Recursive_Open_Struct,
+  # converts it into a real icon, and sets it.
+  def cfg_to_icons(cfg)
+    cfg.attrs.each do |attr|
+      value = cfg.send(attr.to_sym)
+      if (value.class == Recursive_Open_Struct)
+        cfg_to_icons(value)
+      else
+        # value is a filename
+        icon = make_icon(value)
+        cfg.send((attr + "=").to_sym, icon)
+      end
+    end
+  end
+  
+  # Constructs an icon from the given filename (from the icons directory).
+  def make_icon(filename)
+    filename = File.join($cfg.icons_path, filename)
+    icon = nil
+    File.open(filename, "rb") do |f|
+      icon = FXPNGIcon.new(@app, f.read, 0)
+    end
+    icon.create
+    icon
+  end
 end

data/lib/Packet_Item.rb

@@ -1,179 +1,179 @@
 # Copyright (c) 2004, 2005 Christoph Heindl and Martin Ankerl
 class MutexDummy
-	def synchronize
-		yield
-	end
+  def synchronize
+    yield
+  end
 end
 
 # Lock used to synchronize item removes.
-# for now, a global lock is good enough. 
+# for now, a global lock is good enough.
 $fx_icon_item_remove_mutex = Mutex.new
 
 
 # An item for Packet_List. This is a convenient wrapper for the FXIconItem.
 class Packet_Item
 
-	attr_accessor :searchable
-
-	# Fox_Item is a very thin wrapper that calles Packet_Item functionality.
-	class Fox_Item < FXIconItem
-		# optimization: directly sort by sort_key and reversed
-		attr_accessor :sort_key
-		attr_accessor :reversed
-		
-		# Create a new item with packet_item as the parent. *args is passed to the FXIconItem.
-		def initialize(packet_item, *args)
-			@packet_item = packet_item
-			@sort_key = nil
-			@reversed = 1
-			@is_deleted = false
-			super(*args)
-		end
-
-		# Sometimes draw is called AFTER the item has been removed. 
-		# In this case: return immediately. Otherwise a Runtime Error would occur!
-		def draw(*args)
-			$fx_icon_item_remove_mutex.synchronize do
-				#puts "draw"
-				return if @is_deleted
-				super
-			end
-		end
-
-		# Mark item as deleted, to prevent execution of draw afterwards
-		# this is called from Packet_List which uses the same mutex
-		# as draw.
-		def deleted
-			@is_deleted = true
-		end
-		
-		# Called from sortItems, uses packet_item's comparison.
-		def <=>(other)
-			(@sort_key <=> other.sort_key) * @reversed
-		end
-		
-		# Get the packet item
-		def packet_item
-			@packet_item
-		end
-		
-		# Pass-through method
-		def data
-			@packet_item.data
-		end
-	end
-	
-	# Creates a Packet_Item with newParent as the parent list, which is allowed to be nil.
-	# You can also use Packet_List#add_item instead.
-	def initialize(newParent, icon, *content)
-		@content = content
-		@sortable = Array.new(@content.size)
-		@icon = icon
-		@data = nil
-		@parent = nil
-		@sort_key = nil
-		@searchable = nil
-		# call parent=, don't forget the self!!
-		self.parent = newParent
-		show if newParent
-		# update sortable
-		@content.each_index do |pos|
-			update_sortable(pos, @content[pos]) if parent
-		end
-	end
-
-	# Get the content of the given column number.
-	def [](column_nr)
-		@content[column_nr]
-	end
-	
-	# Set new text for the given column number.
-	def []=(column_nr, newVal) 
-		@content[column_nr] = newVal
-		return unless @parent
-		@item.text = @content.join("\t")
-		update_sortable(column_nr, newVal)
-		@parent.recalc
-	end
-	
-	# Get the sortable representation of this column's content.
-	def sortable(pos)
-		@sortable[pos]
-	end
-		
-	# update FXIconItem's sort key and reversed status
-	def update_sort_key
-		@item.sort_key = @sortable[@parent.sort_index]
-		@item.reversed = @parent.reversed? ? -1 : 1
-	end
-	
-	# Get the parent list for this item.
-	def parent
-		@parent
-	end
-	
-	# Set a new parent. This removes this item from the current list and adds itself to 
-	# the new one.
-	def parent=(newParent)
-		return if newParent == @parent
-		remove_item if @parent
-		@parent = newParent
-		@content.each_index do |pos|
-			update_sortable(pos, @content[pos]) if @parent
-		end
-	end
-	
-	# Shows item on parent without updating the search index. This can be used
-	# if an item is removed and added to the same list.
-	def show
-		create_item
-		@parent.add_item(self)
-	end
-	
-	# Get the wrapper item.
-	def fox_item
-		@item
-	end
-	
-	# Allows to set user data.
-	def data=(data)
-		@data = data
-	end
-	
-	# Get user data.
-	def data
-		@data
-	end
-	
-	# Removes the item from its parent.
-	def clear
-		@parent = nil
-	end
-	
-	# The icon of this item.
-	def icon
-		@icon
-	end
-	
-	private
-
-	# Calles the sort function to update the sortable representation of column pos.
-	def update_sortable(pos, newVal)
-		sort_function = @parent.sort_function(pos)
-		if sort_function
-			@sortable[pos] = sort_function.call(newVal)
-		else
-			@sortable[pos] = newVal
-		end
-	end
-	
-	# Remove item from parent
-	def remove_item
-		@parent.remove_item(self)
-	end
-	
-	# Creates wrapper item, and sets it's data
-	def create_item
-		@item = Fox_Item.new(self, @content.join("\t"), @icon, @icon)
-	end
+  attr_accessor :searchable
+
+  # Fox_Item is a very thin wrapper that calles Packet_Item functionality.
+  class Fox_Item < FXIconItem
+    # optimization: directly sort by sort_key and reversed
+    attr_accessor :sort_key
+    attr_accessor :reversed
+
+    # Create a new item with packet_item as the parent. *args is passed to the FXIconItem.
+    def initialize(packet_item, *args)
+      @packet_item = packet_item
+      @sort_key = nil
+      @reversed = 1
+      @is_deleted = false
+      super(*args)
+    end
+
+    # Sometimes draw is called AFTER the item has been removed.
+    # In this case: return immediately. Otherwise a Runtime Error would occur!
+    def draw(*args)
+      $fx_icon_item_remove_mutex.synchronize do
+        #puts "draw"
+        return if @is_deleted
+        super
+      end
+    end
+
+    # Mark item as deleted, to prevent execution of draw afterwards
+    # this is called from Packet_List which uses the same mutex
+    # as draw.
+    def deleted
+      @is_deleted = true
+    end
+
+    # Called from sortItems, uses packet_item's comparison.
+    def <=>(other)
+      (@sort_key <=> other.sort_key) * @reversed
+    end
+
+    # Get the packet item
+    def packet_item
+      @packet_item
+    end
+
+    # Pass-through method
+    def data
+      @packet_item.data
+    end
+  end
+
+  # Creates a Packet_Item with newParent as the parent list, which is allowed to be nil.
+  # You can also use Packet_List#add_item instead.
+  def initialize(newParent, icon, *content)
+    @content = content
+    @sortable = Array.new(@content.size)
+    @icon = icon
+    @data = nil
+    @parent = nil
+    @sort_key = nil
+    @searchable = nil
+    # call parent=, don't forget the self!!
+    self.parent = newParent
+    show if newParent
+    # update sortable
+    @content.each_index do |pos|
+      update_sortable(pos, @content[pos]) if parent
+    end
+  end
+
+  # Get the content of the given column number.
+  def [](column_nr)
+    @content[column_nr]
+  end
+
+  # Set new text for the given column number.
+  def []=(column_nr, newVal)
+    @content[column_nr] = newVal
+    return unless @parent
+    @item.text = @content.join("\t")
+    update_sortable(column_nr, newVal)
+    @parent.recalc
+  end
+
+  # Get the sortable representation of this column's content.
+  def sortable(pos)
+    @sortable[pos]
+  end
+
+  # update FXIconItem's sort key and reversed status
+  def update_sort_key
+    @item.sort_key = @sortable[@parent.sort_index]
+    @item.reversed = @parent.reversed? ? -1 : 1
+  end
+
+  # Get the parent list for this item.
+  def parent
+    @parent
+  end
+
+  # Set a new parent. This removes this item from the current list and adds itself to
+  # the new one.
+  def parent=(newParent)
+    return if newParent == @parent
+    remove_item if @parent
+    @parent = newParent
+    @content.each_index do |pos|
+      update_sortable(pos, @content[pos]) if @parent
+    end
+  end
+
+  # Shows item on parent without updating the search index. This can be used
+  # if an item is removed and added to the same list.
+  def show
+    create_item
+    @parent.add_item(self)
+  end
+
+  # Get the wrapper item.
+  def fox_item
+    @item
+  end
+
+  # Allows to set user data.
+  def data=(data)
+    @data = data
+  end
+
+  # Get user data.
+  def data
+    @data
+  end
+
+  # Removes the item from its parent.
+  def clear
+    @parent = nil
+  end
+
+  # The icon of this item.
+  def icon
+    @icon
+  end
+
+  private
+
+  # Calles the sort function to update the sortable representation of column pos.
+  def update_sortable(pos, newVal)
+    sort_function = @parent.sort_function(pos)
+    if sort_function
+      @sortable[pos] = sort_function.call(newVal)
+    else
+      @sortable[pos] = newVal
+    end
+  end
+
+  # Remove item from parent
+  def remove_item
+    @parent.remove_item(self)
+  end
+
+  # Creates wrapper item, and sets it's data
+  def create_item
+    @item = Fox_Item.new(self, @content.join("\t"), @icon, @icon)
+  end
 end

data/lib/Packet_List.rb

@@ -1,192 +1,192 @@
 # Copyright (c) 2004, 2005 Martin Ankerl
 require 'set'
 
-# Packet_List is a more convenient wrapper for FXIconList. This class has to be used 
+# Packet_List is a more convenient wrapper for FXIconList. This class has to be used
 # in combination with Packet_Item.
 class Packet_List < FXIconList
-	include Responder
-	
-	# Create a new Packet_List. All parameters are passed to the parental constructor FXIconList.
-	def initialize(data, *args)
-		@data = data
-		@sort_mutex = Mutex.new
-		@sort_thread = nil
-		if FOXVERSION=="1.0"
-			def getItem(num)
-				retrieveItem(num)
-			end
-		end
-		
-		@header_item_index = 0
-		@reversed = true
-		@conversions = Array.new
-		@items = Set.new
-		super(*args)
-		
-		header.connect(SEL_COMMAND) do |sender, sel, item_number|
-			on_cmd_header(item_number)
-		end
-		
-		
-		# HACK: only works when one header is there.
-		self.connect(SEL_CONFIGURE) do |sender, sel, data|
-			update_header_width
-		end
-	end
-	
-	def create
-		super
-		recalc
-	end
-	
-	# HACK: only works when one header is there.
-	def update_header_width
-		header.setItemSize(0, width-verticalScrollBar.width)
-		recalc
-	end
-	
-	
-	# Called whenever a header is clicked
-	def on_cmd_header(header_item_index)
-		@data.gui_mutex.synchronize do
-			header.setArrowDir(@header_item_index, MAYBE)
-			if @header_item_index == header_item_index
-				@reversed = !@reversed
-			else
-				@reversed = true
-			end
-			@header_item_index = header_item_index
-			header.setArrowDir(@header_item_index, @reversed)
-			sortItems
-		end
-		# sort array
-		@data.items.sort! do |a, b| 
-			cmp = a.sortable(header_item_index) <=> b.sortable(header_item_index)
-			if @reversed
-				-cmp
-			else 
-				cmp
-			end
-		end
-		return 0
-	end
-	
-	def sortItems
-		@items.each do |item|
-			item.update_sort_key
-		end
-		super
-	end
-	
-	# Check if the search order is reversed (happens when clicking on the same header twice)
-	def reversed?
-		@reversed
-	end
-	
-	# Get index of the header that should be used for sorting
-	def sort_index
-		@header_item_index
-	end
-	
-	# Add a new header. The block that you need to specify is used to convert a string of this
-	# column into something that can be used for sorting. The yielded parameter item_colum_text
-	# is the text of one item of this column.
-	def add_header(text, width, &conversion) # :yields: item_column_text
-		appendHeader(text, nil, width)
-		header.setArrowDir(0, false) if @conversions.empty?
-		@conversions.push conversion
-	end
-		
-	# Create a new Packet_Item. After the icon, you can specify the text for each of the columns.
-	# Here is an example:
-	#  list.create_item(my_icon, "Martin", "Ankerl", "2005")
-	def create_item(icon, *args)
-		Packet_Item.new(self, icon, *args)
-	end
-	
-	# Add a new Packet_Item to this list.Called from within Packet_Item during Packet_Item#parent=
-	def add_item(item)
-		@items.add item
-		appendItem(item.fox_item)
-		item
-	end
-	
-	# Remove the given Packet_Item from the list. This is slow, because
-	# the item has to be searched with a linear search. To remove all items
-	# use #clear.
-	def remove_item(item)
-		i = 0
-		@items.delete item
-		fox_item = item.fox_item
-		i += 1 while i < numItems && fox_item != getItem(i)
-		removeItem(i) if i < numItems
-		item
-	end
-	
-	def appendItem(*args)
-		$fx_icon_item_remove_mutex.synchronize do
-			#puts "appendItem"
-			super
-		end
-	end
-	
-	# Before actually deleting, the item has to be marked as deleted to prevent 
-	# drawing afterwards.
-	def removeItem(*args)
-		$fx_icon_item_remove_mutex.synchronize do
-			#puts "removeitem"
-			# at first, mark item as deleted to prevent drawing afterwards
-			getItem(args[0]).deleted
-			# do the evil delete
-			super
-		end
-	end
-	
-	# Remove all items, but do this within the mutex to be sure everything goes ok.
-	def clearItems(*args)
-		$fx_icon_item_remove_mutex.synchronize do
-			#puts "clearitems"
-			super
-		end
-	end
-	
-	# This may be called when the item is currently beeing deleted.
-	# this method works only before or after the delete, therefore
-	# the mutex is necessary.
-	def getContentWidth(*args)
-		$fx_icon_item_remove_mutex.synchronize do
-			#puts "contentwidth"
-			super
-		end
-	end
-	
-	# This may be called when the item is currently beeing deleted.
-	# this method works only before or after the delete, therefore
-	# the mutex is necessary.
-	def getContentHeight(*args)
-		$fx_icon_item_remove_mutex.synchronize do
-			#puts "contentheight"
-			super
-		end
-	end
-	
-	# Removes all items from the list.
-	def clear
-		@items.each { |item| item.clear }
-		@items.clear
-		# todo: mutex!?
-		clearItems
-	end
-	
-	# use in combination with Packet_Item#show
-	def dirty_clear
-		clearItems
-		@items.clear
-	end
-	
-	# Get the sort for a given header index. The sort function has been supplied
-	# when calling #new. This is used from Packet_Item.
-	def sort_function(header_item_index)
-		@conversions[header_item_index]
-	end
-end	
+  include Responder
+
+  # Create a new Packet_List. All parameters are passed to the parental constructor FXIconList.
+  def initialize(data, *args)
+    @data = data
+    @sort_mutex = Mutex.new
+    @sort_thread = nil
+    if FOXVERSION=="1.0"
+      def getItem(num)
+        retrieveItem(num)
+      end
+    end
+
+    @header_item_index = 0
+    @reversed = true
+    @conversions = Array.new
+    @items = Set.new
+    super(*args)
+
+    header.connect(SEL_COMMAND) do |sender, sel, item_number|
+      on_cmd_header(item_number)
+    end
+
+
+    # HACK: only works when one header is there.
+    self.connect(SEL_CONFIGURE) do |sender, sel, data|
+      update_header_width
+    end
+  end
+
+  def create
+    super
+    recalc
+  end
+
+  # HACK: only works when one header is there.
+  def update_header_width
+    header.setItemSize(0, width-verticalScrollBar.width)
+    recalc
+  end
+
+
+  # Called whenever a header is clicked
+  def on_cmd_header(header_item_index)
+    @data.gui_mutex.synchronize do
+      header.setArrowDir(@header_item_index, MAYBE)
+      if @header_item_index == header_item_index
+        @reversed = !@reversed
+      else
+        @reversed = true
+      end
+      @header_item_index = header_item_index
+      header.setArrowDir(@header_item_index, @reversed)
+      sortItems
+    end
+    # sort array
+    @data.items.sort! do |a, b|
+      cmp = a.sortable(header_item_index) <=> b.sortable(header_item_index)
+      if @reversed
+        -cmp
+      else
+        cmp
+      end
+    end
+    return 0
+  end
+
+  def sortItems
+    @items.each do |item|
+      item.update_sort_key
+    end
+    super
+  end
+
+  # Check if the search order is reversed (happens when clicking on the same header twice)
+  def reversed?
+    @reversed
+  end
+
+  # Get index of the header that should be used for sorting
+  def sort_index
+    @header_item_index
+  end
+
+  # Add a new header. The block that you need to specify is used to convert a string of this
+  # column into something that can be used for sorting. The yielded parameter item_colum_text
+  # is the text of one item of this column.
+  def add_header(text, width, &conversion) # :yields: item_column_text
+    appendHeader(text, nil, width)
+    header.setArrowDir(0, false) if @conversions.empty?
+    @conversions.push conversion
+  end
+
+  # Create a new Packet_Item. After the icon, you can specify the text for each of the columns.
+  # Here is an example:
+  #  list.create_item(my_icon, "Martin", "Ankerl", "2005")
+  def create_item(icon, *args)
+    Packet_Item.new(self, icon, *args)
+  end
+
+  # Add a new Packet_Item to this list.Called from within Packet_Item during Packet_Item#parent=
+  def add_item(item)
+    @items.add item
+    appendItem(item.fox_item)
+    item
+  end
+
+  # Remove the given Packet_Item from the list. This is slow, because
+  # the item has to be searched with a linear search. To remove all items
+  # use #clear.
+  def remove_item(item)
+    i = 0
+    @items.delete item
+    fox_item = item.fox_item
+    i += 1 while i < numItems && fox_item != getItem(i)
+    removeItem(i) if i < numItems
+    item
+  end
+
+  def appendItem(*args)
+    $fx_icon_item_remove_mutex.synchronize do
+      #puts "appendItem"
+      super
+    end
+  end
+
+  # Before actually deleting, the item has to be marked as deleted to prevent
+  # drawing afterwards.
+  def removeItem(*args)
+    $fx_icon_item_remove_mutex.synchronize do
+      #puts "removeitem"
+      # at first, mark item as deleted to prevent drawing afterwards
+      getItem(args[0]).deleted
+      # do the evil delete
+      super
+    end
+  end
+
+  # Remove all items, but do this within the mutex to be sure everything goes ok.
+  def clearItems(*args)
+    $fx_icon_item_remove_mutex.synchronize do
+      #puts "clearitems"
+      super
+    end
+  end
+
+  # This may be called when the item is currently beeing deleted.
+  # this method works only before or after the delete, therefore
+  # the mutex is necessary.
+  def getContentWidth(*args)
+    $fx_icon_item_remove_mutex.synchronize do
+      #puts "contentwidth"
+      super
+    end
+  end
+
+  # This may be called when the item is currently beeing deleted.
+  # this method works only before or after the delete, therefore
+  # the mutex is necessary.
+  def getContentHeight(*args)
+    $fx_icon_item_remove_mutex.synchronize do
+      #puts "contentheight"
+      super
+    end
+  end
+
+  # Removes all items from the list.
+  def clear
+    @items.each { |item| item.clear }
+    @items.clear
+    # todo: mutex!?
+    clearItems
+  end
+
+  # use in combination with Packet_Item#show
+  def dirty_clear
+    clearItems
+    @items.clear
+  end
+
+  # Get the sort for a given header index. The sort function has been supplied
+  # when calling #new. This is used from Packet_Item.
+  def sort_function(header_item_index)
+    @conversions[header_item_index]
+  end
+end