fxri 0.3.3 → 0.3.4

data/lib/Globals.rb

@@ -1,48 +1,50 @@
-require 'lib/Recursive_Open_Struct'
-
-$cfg = Recursive_Open_Struct.new
-
-$cfg.app.name = "fxri - Instant Ruby Enlightenment"
-
-$cfg.delayed_loading = false
-
-# uses the first font that is available
-$cfg.app.font.name = ["Bitstream Vera Sans", "Verdana", "Trebuchet MS", "Tahoma", "Arial"]
-$cfg.ri_font = ["Bitstream Vera Sans Mono", "Courier New", "Courier"]
-$cfg.app.font.size = 8
-
-$cfg.app.width = 760
-$cfg.app.height = 480
-$cfg.search_delay = 0.1
-$cfg.minimum_letters_per_line = 20
-$cfg.packet_list_width = 160
-$cfg.irb_height = 300
-$cfg.status_line_update_interval = 0.1
-
-$cfg.list.opts = ICONLIST_SINGLESELECT|ICONLIST_DETAILED|LAYOUT_FILL_X|LAYOUT_FILL_Y|ICONLIST_AUTOSIZE
-
-# icons, are automatically loaded from Icon_Loader.
-$cfg.icons_path = File.join("lib","icons")
-$cfg.icons.klass = "class.png"
-$cfg.icons.class_method = "module.png"
-$cfg.icons.instance_method = "method.png"
-
-# all texts
-$cfg.text.search = "%d / %d entries"
-$cfg.text.search_field = "What do you want to know?"
-$cfg.text.method_name = "name"
-
-# IRB
-$cfg.launch_irb = true
-
-$cfg.text.help = %|This is <b>fxri</b>, a graphical interface to the <em>Ruby</em> documentation. Fxri comes with a search engine with quite a few features. Here are several examples:
-'<em>Array</em>': Lists all classes with the name <em>Array</em>. Note that upcase words are treated case sensitive, lowercase words insensitive.
-'<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 the current maintainer with <b>markus.prinz@qsig.org</b>.
-Original author: Martin Ankerl (<b>martin.ankerl@gmail.com</b>).|
-
-
-# prevent further modifications
-$cfg.close
+require 'lib/Recursive_Open_Struct'
+
+$cfg = Recursive_Open_Struct.new
+
+$cfg.app.name = "fxri - Instant Ruby Enlightenment"
+
+$cfg.delayed_loading = false
+
+$cfg.search_paths = ENV['FXRI_SEARCH_PATH'] if ENV.has_key?('FXRI_SEARCH_PATH')
+
+# uses the first font that is available
+$cfg.app.font.name = ["Bitstream Vera Sans", "Verdana", "Trebuchet MS", "Tahoma", "Arial"]
+$cfg.ri_font = ["Bitstream Vera Sans Mono", "Courier New", "Courier"]
+$cfg.app.font.size = 8
+
+$cfg.app.width = 760
+$cfg.app.height = 480
+$cfg.search_delay = 0.1
+$cfg.minimum_letters_per_line = 20
+$cfg.packet_list_width = 160
+$cfg.irb_height = 300
+$cfg.status_line_update_interval = 0.1
+
+$cfg.list.opts = ICONLIST_SINGLESELECT|ICONLIST_DETAILED|LAYOUT_FILL_X|LAYOUT_FILL_Y|ICONLIST_AUTOSIZE
+
+# icons, are automatically loaded from Icon_Loader.
+$cfg.icons_path = File.join("lib","icons")
+$cfg.icons.klass = "class.png"
+$cfg.icons.class_method = "module.png"
+$cfg.icons.instance_method = "method.png"
+
+# all texts
+$cfg.text.search = "%d / %d entries"
+$cfg.text.search_field = "What do you want to know?"
+$cfg.text.method_name = "name"
+
+# IRB
+$cfg.launch_irb = true
+
+$cfg.text.help = %|This is <b>fxri</b>, a graphical interface to the <em>Ruby</em> documentation. Fxri comes with a search engine with quite a few features. Here are several examples:
+'<em>Array</em>': Lists all classes with the name <em>Array</em>. Note that upcase words are treated case sensitive, lowercase words insensitive.
+'<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 the current maintainer with <b>markus.prinz@qsig.org</b>.
+Original author: Martin Ankerl (<b>martin.ankerl@gmail.com</b>).|
+
+
+# prevent further modifications
+$cfg.close

data/lib/Icon_Loader.rb

@@ -1,35 +1,35 @@
-# Copyright (c) 2004, 2005 Martin Ankerl
-
-# 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($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
+# Copyright (c) 2004, 2005 Martin Ankerl
+
+# 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($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
-end
-
-# Lock used to synchronize item removes.
-# 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
+# Copyright (c) 2004, 2005 Christoph Heindl and Martin Ankerl
+class MutexDummy
+  def synchronize
+    yield
+  end
+end
+
+# Lock used to synchronize item removes.
+# 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
 end