fxri 0.1.0

data/fxri

@@ -0,0 +1,292 @@
+#!/bin/env ruby
+
+# Load FXRuby: try gem, then Fox 1.2, then Fox 1.0
+begin
+	# try fxruby gem
+	require 'rubygems'
+	require_gem 'fxruby', '>= 1.1.0'
+	require 'fox12'
+	require 'fox12/colors'
+	FOXVERSION="1.2"
+	include Fox
+rescue LoadError
+	# no gem? try fox12 direct.
+	begin
+		require "fox12"
+		require "fox12/colors"
+		FOXVERSION="1.2"
+		include Fox
+	rescue LoadError
+		# no gem, no fox12? try fox 1.0
+		require "fox"
+		require "fox/colors"
+		# grep for FOXVERSION to find all code that depends on this
+		FOXVERSION="1.0"
+		include Fox
+		FXMenuBar = FXMenubar
+		FXToolTip = FXTooltip
+		FXStatusBar = FXStatusbar
+	end
+end
+
+require 'thread'
+
+require 'lib/RiManager'
+require 'lib/Recursive_Open_Struct'
+require 'lib/Globals'
+require 'lib/Packet_List'
+require 'lib/Packet_Item'
+require 'lib/Empty_Text_Field_Handler'
+require 'lib/Icon_Loader'
+require 'lib/Search_Engine'
+require 'lib/FoxDisplayer'
+require 'lib/FoxTextFormatter'
+require 'lib/fxirb'
+
+# Responsible for application initialization
+class Main_Window < FXMainWindow
+	
+	# Initializes the XDCC-application.
+	def initialize(app)
+		super(app, $cfg.app.name, nil, nil, DECOR_ALL, 0, 0, $cfg.app.width, $cfg.app.height)
+		set_default_font
+		# load icons
+		icon_loader = Icon_Loader.new(FXApp::instance)
+		icon_loader.cfg_to_icons($cfg.icons)
+		
+		@gui = Recursive_Open_Struct.new
+		@gui.main = self
+		@data = Recursive_Open_Struct.new
+		@data.gui_mutex = Mutex.new
+		
+		build(self)
+		FXToolTip.new(FXApp::instance, TOOLTIP_NORMAL)
+		
+		@gui.close
+		create_data
+		
+		@data.close
+		
+		@search_engine = Search_Engine.new(@gui, @data)
+		
+		# show init message
+		@data.displayer.display_information($cfg.text.help)
+	end
+	
+	# Automatically called when the Fox application is created
+	def create
+		super
+		show(PLACEMENT_SCREEN)
+		# load items
+		load_items
+		@search_engine.update_search_status_text
+	end
+	
+	def create_data
+		@data.displayer = FoxDisplayer.new(@gui.text)
+		@data.ri_manager = RiManager.new(@data.displayer)
+		@data.items = Array.new
+		@desc = nil
+	end
+	
+	
+	# Set the default font to the first font of $cfg.app.font.name that is available on this system.
+	def set_default_font
+		@font = load_font($cfg.app.font.name)
+		FXApp::instance.normalFont = @font if @font
+	end
+	
+	# Returns the first font of the given array of font names that can be loaded, or nil.
+	def load_font(font_array)
+		# load default font
+		font = nil
+		font_array.detect do |name|
+			next if FXFont.listFonts(name).empty?
+			font = FXFont.new(FXApp::instance, name, $cfg.app.font.size)
+		end
+		font
+	end
+	
+	# build gui
+	def build(parent)
+		FXSplitter.new(parent, SPLITTER_TRACKING|LAYOUT_FILL_X|LAYOUT_FILL_Y) do |base|
+			FXVerticalFrame.new(base, LAYOUT_FILL_X|LAYOUT_FILL_Y, 0,0,$cfg.packet_list_width,0, DEFAULT_SPACING, 0) do |search_frame|
+
+				@gui.search_field = FXTextField.new(search_frame, 1, nil, 0, TEXTFIELD_NORMAL|LAYOUT_FILL_X|FRAME_SUNKEN)
+				Empty_Text_Field_Handler.new(@gui.search_field, $cfg.text.search_field)
+				@gui.search_field.connect(SEL_CHANGED) do |*args|
+					on_search
+				end
+				
+
+				FXVerticalFrame.new(search_frame, FRAME_SUNKEN|LAYOUT_FILL_X|LAYOUT_FILL_Y, 0,0,0,0, 0,0,0,0,0,0) do |list_frame|
+					@gui.packet_list = Packet_List.new(@data, list_frame, nil, 0, HSCROLLER_NEVER|VSCROLLER_ALWAYS|TREELIST_BROWSESELECT|LAYOUT_FILL_X|LAYOUT_FILL_Y) do |packet_list|
+						packet_list.add_header($cfg.text.method_name, $cfg.packet_list_width) { |x| make_sortable(x) }
+					end
+				end
+				
+				@gui.search_label = FXLabel.new(search_frame, "", nil, LAYOUT_FILL_X|LABEL_NORMAL|JUSTIFY_RIGHT, 0,0,0,0, 0,0,0,0)
+				
+				@gui.packet_list.connect(SEL_SELECTED) do |sender, sel, data|
+					item = sender.getItem(data).packet_item
+					show_info(item.data)
+				end
+			end
+			
+			
+			FXSplitter.new(base, SPLITTER_TRACKING|LAYOUT_FILL_X|LAYOUT_FILL_Y|SPLITTER_VERTICAL) do |split|
+				FXHorizontalFrame.new(split, FRAME_SUNKEN|LAYOUT_FILL_X|LAYOUT_FILL_Y, 0,0,0,0, 0,0,0,0,0,0) do |right|
+					@gui.text = FXText.new(right, nil, 0, TEXT_READONLY|TEXT_WORDWRAP|LAYOUT_FILL_X|LAYOUT_FILL_Y)
+				end
+				
+				FXHorizontalFrame.new(split, FRAME_SUNKEN|LAYOUT_FILL_X|LAYOUT_FILL_Y, 0,0,0,0, 0,0,0,0,0,0) do |irb_frame|
+					@irb_frame = irb_frame
+					@gui.irb = FXIrb.init(irb_frame, nil, 0, LAYOUT_FILL_X|LAYOUT_FILL_Y|TEXT_WORDWRAP|TEXT_SHOWACTIVE)
+					@gui.irb.setFont(@font) if @font
+				end
+				split.setSplit(0, $cfg.irb_height)
+			end
+			font = load_font($cfg.ri_font)
+			@gui.text.font = font if font
+			font.create
+			@gui.text_width = font.fontWidth
+			
+			@gui.text.connect(SEL_CONFIGURE) do 
+				on_show if @desc
+			end
+			
+			# construct hilite styles
+			@gui.text.styled = true
+			@gui.text.hiliteStyles = create_styles
+			
+		end
+	end
+		
+	def create_empty_style
+		hs = FXHiliteStyle.new
+		hs.activeBackColor = FXColor::White
+		hs.hiliteBackColor = FXColor::DarkBlue
+		hs.normalBackColor = FXColor::White
+		hs.normalForeColor = FXColor::Black
+		hs.selectBackColor = FXColor::DarkBlue
+		hs.selectForeColor = FXColor::White
+		hs.style = 0
+		hs
+	end
+	
+	def create_styles
+		styles = Array.new
+
+		#normal
+		styles.push create_empty_style
+		
+		# bold
+		hs = create_empty_style
+		hs.style = FXText::STYLE_BOLD
+		styles.push hs
+		
+		# H1
+		hs = create_empty_style
+		hs.style = FXText::STYLE_UNDERLINE|FXText::STYLE_BOLD
+		hs.normalForeColor = FXColor::ForestGreen
+		styles.push hs
+		
+		# H2
+		hs = create_empty_style
+		hs.style = FXText::STYLE_UNDERLINE
+		hs.normalForeColor = FXColor::ForestGreen
+		styles.push hs
+		
+		# H3
+		hs = create_empty_style
+		hs.normalForeColor = FXColor::ForestGreen
+		styles.push hs
+		
+		# teletype
+		hs = create_empty_style
+		hs.normalForeColor = FXColor::DarkCyan
+		styles.push hs
+
+		# code
+		hs = create_empty_style
+		hs.activeBackColor = FXColor::LightGrey
+		hs.normalForeColor = FXColor::DarkGreen
+		hs.style = FXText::STYLE_UNDERLINE|FXText::STYLE_BOLD
+		styles.push hs
+		
+		# emphasis
+		hs = create_empty_style
+		hs.normalForeColor = FXColor::DarkCyan
+		styles.push hs
+
+		# class
+		hs = create_empty_style
+		hs.style = FXText::STYLE_BOLD
+		hs.normalForeColor = FXColor::Blue
+		styles.push hs
+
+		styles		
+	end
+	
+	
+	# loads all ri items
+	def load_items
+		@data.ri_manager.all_names.each do |name|
+			icon = case name.type
+				when NameDescriptor::CLASS
+					$cfg.icons.klass
+				when NameDescriptor::INSTANCE_METHOD
+					$cfg.icons.instance_method
+				when NameDescriptor::CLASS_METHOD
+					$cfg.icons.class_method
+				end
+			item = Packet_Item.new(@gui.packet_list, icon, name.to_s)
+			item.data = name
+			@data.items.push item
+		end
+		# quick hack to sort in right order :-)
+		@gui.packet_list.on_cmd_header(0)
+		@gui.packet_list.on_cmd_header(0)
+		@gui.packet_list.update_header_width
+		recalc
+	end
+	
+	def on_search
+		@search_engine.on_search
+	end
+	
+	def on_show
+		begin
+			w = @gui.text.width / @gui.text_width - 3
+			w = [w, $cfg.minimum_letters_per_line].max
+			@data.ri_manager.show(@desc, w)
+		rescue RiError => e
+			#puts desc
+		end
+	end
+		
+	def show_info(desc)
+		@desc = desc
+		on_show
+	end
+	
+	
+	# x beeing the name of the ri doc, like "Set#delete"
+	# This creates a sortable representation. First class, then class methods, then instance.
+	def make_sortable(x)
+		[ x.downcase.gsub("::", " 1 ").gsub("#", " 2 "),
+		x.downcase,
+		x]
+	end
+	
+end
+
+Thread.abort_on_exception= true
+
+# move to directory of this file, so that icons can load correctly.
+Dir.chdir(File.dirname(File.expand_path(__FILE__)))
+
+$app = FXApp.new($cfg.app.name, $cfg.app.name)
+$main_window = Main_Window.new($app)
+$app.create
+$app.run

data/fxri.gemspec

@@ -0,0 +1,24 @@
+#!/bin/env ruby
+require 'rubygems'
+
+spec = Gem::Specification.new do |s|
+	s.name = "fxri"
+	s.add_dependency('fxruby', '>= 1.2.0')
+	s.version = "0.1.0"
+	s.date = "2005-02-20"
+	s.summary = "Graphical interface to the RI documentation, with search engine."
+	s.require_paths = ["lib"]
+	s.email = "martin.ankerl@gmail.com"
+	s.homepage = "http://fxri.rubyforge.org/"
+	s.rubyforge_project = "fxri"
+	s.description = "FxRi is an FXRuby interface to the RI documentation, with a search engine that allows for search-on-typing."
+	s.has_rdoc = false
+	s.files = Dir.glob("**/*")
+	s.bindir = "."
+	s.executables = ["fxri"]
+end
+
+if __FILE__ == $0
+	Gem.manage_gems
+	Gem::Builder.new(spec).build
+end

data/lib/Empty_Text_Field_Handler.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2004, 2005 Martin Ankerl
+# Shows a grey text in an FXTextField if the user did not enter any input. This is a nice way to 
+# give the user more information about what to enter into a text field, without the need of additional
+# space in the GUI.
+class Empty_Text_Field_Handler
+
+	# Create a new handler for the specified textfield, with the given text. From now on you have to use the
+	# created object to get and set text, not the textfield or this handler would come out of sync
+	def initialize(textField, myText)
+		@textField = textField
+		@myText = myText
+		@isEmpty = true
+		onTextFieldFocusOut
+		# create connections
+		@textField.connect(SEL_FOCUSIN, method(:onTextFieldFocusIn))
+		@textField.connect(SEL_FOCUSOUT, method(:onTextFieldFocusOut))
+	end
+	
+	# Check if textfield is empty (no user input).
+	def empty?
+		@isEmpty
+	end
+	
+	# Set new text for the textfield
+	def text=(newText)
+		onTextFieldFocusIn
+		@textField.text = newText.to_s
+		onTextFieldFocusOut
+	end
+	
+	# Get the textfield's text, if the user has entered something.
+	def text
+		if empty? && !@inside
+			""
+		else
+			@textField.text
+		end
+	end
+	
+	# Set focus to the textfield.
+	def setFocus
+		@textField.setFocus
+	end
+
+	private
+	
+	def onTextFieldFocusIn(*args)
+		@inside = true
+		return if !@isEmpty
+		@textField.textColor = FXColor::Black
+		@textField.text = ""
+	end
+	
+	def onTextFieldFocusOut(*args)
+		@inside = false
+		@textField.killSelection
+		@isEmpty = @textField.text == ""
+		return if !@isEmpty
+		@textField.textColor = FXColor::DarkGrey
+		@textField.text = @myText
+		@isEmpty = true
+	end
+end

data/lib/FoxDisplayer.rb

@@ -0,0 +1,148 @@
+class FoxDisplayer
+	attr_accessor :reader
+	
+	def initialize(text_field)
+		@text_field = text_field
+		@formatter = FoxTextFormatter.new(70, "") do |arg, style|
+			startpos = @str.size
+			@str << arg
+			@formats.push [startpos, arg.size, style]			
+		end
+		@reader = nil
+	end
+	
+	def width=(newWidth)
+		@formatter.width = newWidth
+	end
+	
+	def no_info_available
+		@text_field.text="nothing here, move on!"
+	end
+	
+	def init_text
+		@str = ""
+		@formats = Array.new
+	end
+	
+	# Sets a new text, and all styles
+	def set_text
+		@text_field.text = @str
+		@formats.each do |start, n, style|
+			case style
+			when FoxTextFormatter::STYLE_BOLD
+				@text_field.changeStyle(start, n, 2)				
+			when FoxTextFormatter::STYLE_H1
+				@text_field.changeStyle(start, n, 3)
+			when FoxTextFormatter::STYLE_H2
+				@text_field.changeStyle(start, n, 4)
+			when FoxTextFormatter::STYLE_H3
+				@text_field.changeStyle(start, n, 5)
+			when FoxTextFormatter::STYLE_TELETYPE
+				@text_field.changeStyle(start, n, 6)
+			when FoxTextFormatter::STYLE_CODE
+				@text_field.changeStyle(start, n, 7)
+			when FoxTextFormatter::STYLE_EMPHASIS
+				@text_field.changeStyle(start, n, 8)
+			when FoxTextFormatter::STYLE_CLASS
+				@text_field.changeStyle(start, n, 9)
+			else
+				@text_field.changeStyle(start, n, 1)			
+			end
+			
+		end
+	end
+	
+	# Display method information
+	def display_method_info(method)
+		init_text
+		@formatter.draw_line(method.full_name)
+		@formatter.display_params(method)
+		@formatter.draw_line
+		display_flow(method.comment)
+		
+		if method.aliases && !method.aliases.empty?
+			@formatter.blankline
+			aka = "(also known as "
+			aka << method.aliases.map {|a| a.name }.join(", ") 
+			aka << ")"
+			@formatter.wrap(aka)
+		end
+		set_text
+	end
+	
+	def display_information(message)
+		init_text
+		display_flow(message)
+		set_text
+	end
+	
+	def display_class_info(klass)
+		init_text
+		superclass = klass.superclass_string
+		if superclass
+			superclass = " < " + superclass
+		else
+			superclass = ""
+		end
+		@formatter.draw_line(klass.display_name + ": " + klass.full_name + superclass)
+		display_flow(klass.comment)
+		@formatter.draw_line 
+		
+		unless klass.includes.empty?
+			@formatter.blankline
+			@formatter.display_heading("Includes:", 2, "")
+			incs = []
+			klass.includes.each do |inc|
+				inc_desc = @reader.find_class_by_name(inc.name)
+				if inc_desc
+					str = inc.name + "("
+					str << inc_desc.instance_methods.map{|m| m.name}.join(", ")
+					str << ")"
+					incs << str
+				else
+					incs << inc.name
+				end
+			end
+			@formatter.wrap(incs.sort.join(', '))
+		end
+		
+		unless klass.constants.empty?
+			@formatter.blankline
+			@formatter.display_heading("Constants:", 2, "")
+			len = 0
+			klass.constants.each { |c| len = c.name.length if c.name.length > len }
+			len += 2
+			klass.constants.each do |c|
+				@formatter.wrap(c.value, @formatter.indent+((c.name+":").ljust(len)))
+			end 
+		end
+		
+		unless klass.class_methods.empty?
+			@formatter.blankline
+			@formatter.display_heading("Class methods:", 2, "")
+			@formatter.wrap(klass.class_methods.map{|m| m.name}.sort.join(', '))
+		end
+		
+		unless klass.instance_methods.empty?
+			@formatter.blankline
+			@formatter.display_heading("Instance methods:", 2, "")
+			@formatter.wrap(klass.instance_methods.map{|m| m.name}.sort.join(', '))
+		end
+		
+		unless klass.attributes.empty?
+			@formatter.blankline
+			@formatter.wrap("Attributes:", "")
+			@formatter.wrap(klass.attributes.map{|a| a.name}.sort.join(', '))
+		end		
+
+		set_text
+	end
+	
+	def display_flow(flow)
+		if !flow || flow.empty?
+			@formatter.wrap("(no description...)\n")
+		else
+			@formatter.display_flow(flow)
+		end
+	end	
+end