INSTALL.txt plugins/redcar/tasks/docs.rake @@ -1,6 +1,8 @@ -Redcar - by Daniel Lucraft - http://RedcarEditor.com/ += Redcar + +by Daniel Lucraft + +http://RedcarEditor.com/ == DESCRIPTION: @@ -13,52 +15,11 @@ snippets, macros and is highly extensible. * Extensive snippets. * Ruby plugins. -== INSTALL: - -For now, installation is still pretty long-winded. It's a bit easier if you live within Ubuntu's packages. - -=== Installing on Ubuntu 8.04 - 9.04 - -1. First you will need to install Ruby-GNOME2, the build tools and some other necessary libraries. On Ubuntu/Debian you may simply do: - - $ sudo apt-get install ruby ruby1.8-dev rubygems1.8 libhttp-access2-ruby1.8 rubygems1.8 ruby-gnome2 build-essential libonig2 libonig-dev libgtk2.0-dev libglib2.0-dev libgee0 libgee-dev libgtksourceview2.0-dev libxul-dev xvfb libdbus-ruby - -If you are not using Debian/Ubuntu, or have installed Ruby yourself from source, then you should make sure that you have these libraries installed: - 1. Ruby, Rubygems, Glib, Gtk, GtkSourceView 2 with development headers - 2. Ruby-GNOME2 http://ruby-gnome2.sourceforge.jp/ - 3. Oniguruma (any version will probably work, tested with 5.9.0) http://www.geocities.jp/kosako3/oniguruma/ - 4. Libgee http://live.gnome.org/Libgee - 5. Ruby DBus git://github.com/sdague/ruby-dbus.git - 6. GtkSourceView 2.0 - -2. Install the required Ruby gems: - - $ sudo gem install oniguruma activesupport rspec cucumber hoe open4 zerenity +== INSTALLATION -3. Download Redcar: +See INSTALL.txt - $ wget http://redcareditor.com/releases/redcar-latest.tar.gz - -4. Unzip the source: - - $ tar xzvf redcar-latest.tar.gz - -5. Build Redcar - - $ cd redcar/ - $ rake build - -6. Now try running Redcar - $ cd REDCAR_PATH - $ ./bin/redcar - -The first time Redcar runs it will spend time loading the Textmate Bundles. -This only happens once. - -NB. Ubuntu 9.10 users should start Redcar with the --multiple-instance flag, as -there appears to be a bug in the Jaunty ruby dbus package. - -== Running Features +== FEATURES rake features rake features:[plugin_name] README.txt @@ -44,6 +44,12 @@ def execute(command) $?.to_i == 0 ? true : false end +def plugin_names + Dir["plugins/*"].map do |fn| + name = fn.split("/").last + end +end + Dir[File.join(File.dirname(__FILE__), *%w[plugins *])].each do |plugin_dir| rakefiles = [File.join(plugin_dir, "Rakefile")] + Dir[File.join(plugin_dir, "tasks", "*.rake")] @@ -54,13 +60,6 @@ Dir[File.join(File.dirname(__FILE__), *%w[plugins *])].each do |plugin_dir| end end -desc "Build core documentation (requires mislav-hanna gem)" -task :coredoc do - FileUtils.rm_rf "doc" - files = Dir["plugins/core/lib/core/*"].select{|f| File.file? f} - sh "rdoc -o doc --inline-source --format=html -T hanna #{files.join(" ")} README.txt" -end - task :clear_cache do sh "rm cache/*/*.dump" end Rakefile @@ -18,7 +18,6 @@ load 'core/gui.rb' load 'core/speedbar.rb' load 'core/shell_command.rb' load 'core/pane.rb' -load 'core/standard_menus.rb' load 'core/template.rb' load 'core/command_history.rb' load 'core/dialog.rb' plugins/core/lib/core.rb @@ -1,5 +1,6 @@ -# This is the Redcar API documentation for plugin authors and developers. +# This is the Redcar API documentation for Redcar developers and plugin +# authors. # For documentation regarding the day to day use of Redcar as an editor # please refer to http://www.redcaride.com/doc/user_guide/index.html. module Redcar @@ -8,10 +9,14 @@ module Redcar module App include FreeBASE::DataBusHelper - def self.[]=(name, val) - bus("/redcar/appdata/#{name}").data = val + # Set key-value pair to be stored in the databus. This + # is persistent across application instances. + def self.[]=(key, val) + bus("/redcar/appdata/#{key}").data = val end + # Retrieve a value associated with this key. This + # may have been set in a previous instance of the application. def self.[](name) if slot = bus("/redcar/appdata/#{name}", true) slot.data plugins/core/lib/core/app.rb @@ -1,5 +1,6 @@ module Redcar + # A simple DBus listener thread that watches for method calls across DBus. class DBus def self.start_listener Thread.new do plugins/core/lib/core/dbus.rb @@ -1,5 +1,8 @@ module Redcar + # This class is responsible for interpreting key press events + # and dispatching the appropriate Redcar::Commands. It should + # be split up into Keymap and Dispatcher classes. class Keymap include FreeBASE::DataBusHelper @@ -17,12 +20,15 @@ module Redcar end end + # Normalizes a Redcar style keymap string like "Ctrl+G". def self.normalize(redcar_key) bits = redcar_key.split("+") bits = bits[0..-2].sort << bits.last bits.join("+") end + # Given a Gdk::EventKey returns a Redcar style keymap + # like "Ctrl+G" def self.clean_gdk_eventkey(gdk_eventkey) kv = gdk_eventkey.keyval ks = gdk_eventkey.state - Gdk::Window::MOD2_MASK @@ -46,8 +52,9 @@ module Redcar end end - # Process a Gdk::EventKey (which is created on a keypress) - def self.process(gdk_eventkey) #:nodoc: + # Process a Gdk::EventKey (which is created on a keypress). This is the + # entry point for Command dispatch from Window. + def self.process(gdk_eventkey) if key = clean_gdk_eventkey(gdk_eventkey) execute_key(key, gdk_eventkey) else @@ -73,9 +80,6 @@ module Redcar # Use to execute a key. key_name should be a string like "Ctrl+G". def self.execute_key(key_name, gdk_eventkey) -# if key_name == "Return" # FIXME! -# return false -# end if coms = bus("/redcar/keymaps/#{normalize(key_name)}").data App.log.debug "[Keymap] #{coms.length} candidate commands" coms = coms.select do |com| plugins/core/lib/core/keymap.rb @@ -1,5 +1,8 @@ module Redcar + # A Redcar Window contains a menu bar, a collection of Panes and a status bar. + # At the moment, there may only be one Window open in an instance of the Redcar + # application. This should change, hopefully soon. class Window < Gtk::Window include FreeBASE::DataBusHelper @@ -51,14 +54,6 @@ module Redcar end end - def pane_for_tab_class(tab_class) - panes.reverse.sort_by do |pane| - num_same_class = pane.tabs.select {|t| t.is_a? tab_class}.length - num = pane.tabs.length - num_same_class*100 - (num - num_same_class) - end.last - end - # Equivalent to calling Pane#new_tab on the currently # focussed Pane. def new_tab(tab_class, *args) @@ -70,6 +65,7 @@ module Redcar panes.map {|pane| pane.tabs }.flatten end + # Returns an array of all open tabs that are instances of klass. def collect_tabs(klass) tabs.select {|t| t.is_a? klass} end @@ -184,6 +180,14 @@ module Redcar end end + def pane_for_tab_class(tab_class) + panes.reverse.sort_by do |pane| + num_same_class = pane.tabs.select {|t| t.is_a? tab_class}.length + num = pane.tabs.length + num_same_class*100 - (num - num_same_class) + end.last + end + def collect_tabs_from_dual(dual) [dual.child1, dual.child2].map do |child| if child.class == Gtk::Notebook plugins/core/lib/core/window.rb f8424666bfe97c87c331eceb772f44be3f32c194 Daniel Lucraft dan@fluentradical.com http://github.com/danlucraft/redcar/commit/111304762d6fd0d4f960a5bda024beec490b2c94 111304762d6fd0d4f960a5bda024beec490b2c94 2009-04-04T13:51:35-07:00 2009-04-04T13:51:35-07:00 Bits of documentation here and there + rake doc tasks 7685019593a23b529017970cef1e8dda235a4a50 Daniel Lucraft dan@fluentradical.com