redcar 0.6.1 → 0.7

data/plugins/edit_view/lib/edit_view.rb

@@ -7,6 +7,7 @@ require "edit_view/command"
 require "edit_view/document"
 require "edit_view/document/command"
 require "edit_view/document/controller"
+require "edit_view/document/history"
 require "edit_view/document/indentation"
 require "edit_view/document/mirror"
 require "edit_view/grammar"
@@ -23,6 +24,45 @@ require "edit_view/commands/align_assignment_command"
 
 module Redcar
   class EditView
+    ACTIONS = [
+      :LINE_UP,
+      :LINE_DOWN,
+      :LINE_START,
+      :LINE_END,
+      :COLUMN_PREVIOUS,
+      :COLUMN_NEXT,
+      :PAGE_UP,
+      :PAGE_DOWN,
+      :WORD_PREVIOUS,
+      :WORD_NEXT,
+      :TEXT_START,
+      :TEXT_END,
+      :WINDOW_START,
+      :WINDOW_END,
+      :SELECT_ALL,
+      :SELECT_LINE_UP,
+      :SELECT_LINE_DOWN,
+      :SELECT_LINE_START,
+      :SELECT_LINE_END,
+      :SELECT_COLUMN_PREVIOUS,
+      :SELECT_COLUMN_NEXT,
+      :SELECT_PAGE_UP,
+      :SELECT_PAGE_DOWN,
+      :SELECT_WORD_PREVIOUS,
+      :SELECT_WORD_NEXT,
+      :SELECT_TEXT_START,
+      :SELECT_TEXT_END,
+      :SELECT_WINDOW_START,
+      :SELECT_WINDOW_END,
+      :CUT,
+      :COPY,
+      :PASTE,
+      :DELETE_PREVIOUS,
+      :DELETE_NEXT,
+      :DELETE_WORD_PREVIOUS,
+      :DELETE_WORD_NEXT
+    ]
+    
     include Redcar::Model
     extend Redcar::Observable
     include Redcar::Observable
@@ -53,9 +93,9 @@ module Redcar
     def self.menus
       Menu::Builder.build do
         sub_menu "Edit" do
-          group(:priority => 90) do
-            separator
-            sub_menu "Convert Text" do
+          sub_menu "Formatting" do
+            item "Align Assignments", EditView::AlignAssignmentCommand
+            sub_menu "Convert Text", :priority => 40 do
               item "to Uppercase",     EditView::UpcaseTextCommand
               item "to Lowercase",     EditView::DowncaseTextCommand
               item "to Titlecase",     EditView::TitlizeTextCommand
@@ -64,8 +104,6 @@ module Redcar
               item "to CamelCase",                           EditView::CamelCaseTextCommand
               item "to snake_case",                          EditView::UnderscoreTextCommand
               item "Toggle PascalCase-underscore-camelCase", EditView::CamelSnakePascalRotateTextCommand
-              separator
-              item "Align Assignments", EditView::AlignAssignmentCommand
             end
           end
         end
@@ -321,12 +359,20 @@ module Redcar
       Redcar.app.windows.map {|w| w.notebooks.map {|n| n.tabs}.flatten }.flatten.select {|t| t.is_a?(EditTab)}.map {|t| t.edit_view}
     end
 
-    attr_reader :document
+    attr_reader :document, :history
 
     def initialize
       create_document
       @grammar = nil
       @focussed = nil
+      create_history
+    end
+    
+    def create_history
+      @history = Document::History.new(500)
+      @history.subscribe do |action|
+        document.controllers.each {|c| c.after_action(action) }
+      end
     end
 
     def create_document
@@ -358,7 +404,6 @@ module Redcar
       self.show_margin   = EditView.tab_settings.show_margin_for(name)
       refresh_show_invisibles
       refresh_show_line_numbers
-      refresh_show_annotations
     end
 
     def focus
@@ -459,22 +504,13 @@ module Redcar
       notify_listeners(:line_number_visibility_changed, @show_line_numbers)
     end
 
-    def show_annotations?
-      @show_annotations
+    def add_annotation(annotation_name, line, text, start, length)
+      start += document.offset_at_line(line)
+      controller.add_annotation(annotation_name, line, text, start, length)
     end
 
-    def self.show_annotations?
-      EditView.tab_settings.show_annotations?
-    end
-
-    def self.show_annotations=(bool)
-      EditView.tab_settings.set_show_annotations(bool)
-      all_edit_views.each {|ev| ev.refresh_show_annotations }
-    end
-
-    def refresh_show_annotations
-      @show_annotations = EditView.tab_settings.show_annotations?
-      notify_listeners(:annotations_visibility_changed, @show_annotations)
+    def add_annotation_type(name, image, rgb)
+      controller.add_annotation_type(name, File.expand_path("#{image}.png", ICONS_DIRECTORY), rgb)
     end
 
     def title=(title)
@@ -523,5 +559,48 @@ module Redcar
       end
       @last_checked = Time.now
     end
+    
+    # This characters have custom Redcar behaviour.
+    OVERRIDDEN_CHARACTERS = {
+      9 => [:tab_pressed, []]
+    }
+    
+    def type_character(character)
+      unless custom_character_handle(character)
+        notify_listeners(:type_character, character)
+      end
+      history.record(character)
+    end
+    
+    def custom_character_handle(character)
+      if method_call = OVERRIDDEN_CHARACTERS[character]
+        send(*method_call)
+      end
+    end
+    
+    # These actions have custom Redcar implementations that
+    # override the default StyledText implementation. (Mainly for
+    # soft tabs purposes.)
+    OVERRIDDEN_ACTIONS = {
+      :COLUMN_PREVIOUS        => Actions::ArrowLeftHandler,
+      :COLUMN_NEXT            => Actions::ArrowRightHandler,
+      :SELECT_COLUMN_PREVIOUS => Actions::ArrowLeftHandler,
+      :SELECT_COLUMN_NEXT     => Actions::ArrowRightHandler,
+      :DELETE_PREVIOUS        => Actions::BackspaceHandler,
+      :DELETE_NEXT            => Actions::DeleteHandler
+    }
+    
+    def invoke_overridden_action(action_symbol)
+      if handler = OVERRIDDEN_ACTIONS[action_symbol]
+        handler.send(action_symbol.to_s.downcase, self)
+      end
+    end
+    
+    def invoke_action(action_symbol)
+      unless invoke_overridden_action(action_symbol)
+        notify_listeners(:invoke_action, action_symbol)
+      end
+      history.record(action_symbol)
+    end
   end
 end

data/plugins/edit_view/lib/edit_view/actions/arrow_keys.rb

@@ -36,14 +36,26 @@ module Redcar
       class ArrowLeftHandler < ArrowHandler
         def self.handle(edit_view, modifiers)
           return if (modifiers & %w(Alt Cmd Ctrl)).any?
-          return if edit_view.document.block_selection_mode?
-          doc = edit_view.document
           if modifiers.include?("Shift")
-            old_selection_offset = doc.selection_offset
-            doc.set_selection_range(move_left_offset(edit_view), old_selection_offset)
+            select_column_previous(edit_view)
           else
-            doc.cursor_offset = move_left_offset(edit_view)
+            column_previous(edit_view)
           end
+        end
+        
+        def self.column_previous(edit_view)
+          return false if edit_view.document.block_selection_mode?
+          doc = edit_view.document
+          doc.cursor_offset = move_left_offset(edit_view)
+          ArrowHandler.ensure_cursor_in_view(edit_view)
+          true
+        end
+        
+        def self.select_column_previous(edit_view)
+          return false if edit_view.document.block_selection_mode?
+          doc = edit_view.document
+          old_selection_offset = doc.selection_offset
+          doc.set_selection_range(move_left_offset(edit_view), old_selection_offset)
           ArrowHandler.ensure_cursor_in_view(edit_view)
           true
         end
@@ -82,15 +94,26 @@ module Redcar
       class ArrowRightHandler < ArrowHandler
         def self.handle(edit_view, modifiers)
           return if (modifiers & %w(Alt Cmd Ctrl)).any?
-          return if edit_view.document.block_selection_mode?
-          doc = edit_view.document
-          
           if modifiers.include?("Shift")
-            old_selection_offset = doc.selection_offset
-            doc.set_selection_range(move_right_offset(edit_view), old_selection_offset)
+            select_column_next(edit_view)
           else
-            doc.cursor_offset = move_right_offset(edit_view)
+            column_next(edit_view)
           end
+        end
+        
+        def self.column_next(edit_view)
+          return false if edit_view.document.block_selection_mode?
+          doc = edit_view.document
+          doc.cursor_offset = move_right_offset(edit_view)
+          ArrowHandler.ensure_cursor_in_view(edit_view)
+          true
+        end
+        
+        def self.select_column_next(edit_view)
+          return false if edit_view.document.block_selection_mode?
+          doc = edit_view.document
+          old_selection_offset = doc.selection_offset
+          doc.set_selection_range(move_right_offset(edit_view), old_selection_offset)
           ArrowHandler.ensure_cursor_in_view(edit_view)
           true
         end

data/plugins/edit_view/lib/edit_view/actions/deletion.rb

@@ -5,24 +5,34 @@ module Redcar
       class DeleteHandler
         def self.handle(edit_view, modifiers)
           return if modifiers.any?
+          delete_next(edit_view)
+        end
+        
+        def self.delete_next(edit_view)
           return if edit_view.document.selection?
           return if edit_view.document.block_selection_mode?
           doc = edit_view.document
           old_offset = doc.cursor_offset
           new_offset = ArrowRightHandler.move_right_offset(edit_view)
           doc.delete(old_offset, new_offset - old_offset)
+          true
         end
       end
       
       class BackspaceHandler
         def self.handle(edit_view, modifiers)
           return if modifiers.any?
+          delete_previous(edit_view)
+        end
+        
+        def self.delete_previous(edit_view)
           return if edit_view.document.selection?
           return if edit_view.document.block_selection_mode?
           doc = edit_view.document
           old_offset = doc.cursor_offset
           new_offset = ArrowLeftHandler.move_left_offset(edit_view)
           doc.delete(new_offset, old_offset - new_offset)
+          true
         end
       end
     end

data/plugins/edit_view/lib/edit_view/command.rb

@@ -4,7 +4,11 @@ module Redcar
     sensitize :edit_tab_focussed
     
     def doc
-      tab.edit_view.document
+      edit_view.document
+    end
+    
+    def edit_view
+      tab.edit_view
     end
   end
 end

data/plugins/edit_view/lib/edit_view/document.rb

@@ -31,7 +31,8 @@ module Redcar
       @controllers = {
         Controller::ModificationCallbacks => [],
         Controller::NewlineCallback       => [],
-        Controller::CursorCallbacks       => []
+        Controller::CursorCallbacks       => [],
+        Controller                        => []
       }
       Document.all_document_controller_types.each do |type|
         controller = type.new
@@ -54,8 +55,12 @@ module Redcar
 
     end
     
-    def controllers(klass)
-      @controllers.values.flatten.uniq.select {|c| c.is_a?(klass) }
+    def controllers(klass=nil)
+      if klass
+        @controllers.values.flatten.uniq.select {|c| c.is_a?(klass) }
+      else
+        @controllers.values.flatten.uniq
+      end
     end
     
     def save!

data/plugins/edit_view/lib/edit_view/document/command.rb

@@ -2,10 +2,24 @@ module Redcar
   class DocumentCommand < Command
     sensitize :edit_view_focussed
     
+    def _finished
+      edit_view.history.record(self)
+    end
+    
+    def run_in_focussed_tab_edit_view
+      if edit_view = Redcar::EditView.focussed_tab_edit_view
+        run(:env => {:edit_view => edit_view})
+      end
+    end
+    
     private
     
+    def edit_view
+      env[:edit_view] || EditView.focussed_edit_view
+    end
+    
     def doc
-      EditView.focussed_edit_view.document
+      edit_view.document
     end
   end
 end

data/plugins/edit_view/lib/edit_view/document/controller.rb

@@ -8,6 +8,15 @@ module Redcar
         "<#{self.class}>"
       end
       
+      # Called after every user action that modifies the document.
+      # E.g. typing "a", moving up, running a search. NOT included
+      # is modifications made by calling methods on Document, but they
+      # are usually implied by the Commands that make them.
+      #
+      # @param [String|Symbol|DocumentCommand] This is a document action.
+      def after_action(action)
+      end
+      
       module ModificationCallbacks
         def before_modify(start_offset, end_offset, text)
           raise "not implemented"

data/plugins/edit_view/lib/edit_view/document/history.rb

@@ -0,0 +1,41 @@
+
+module Redcar
+  class Document
+    class History < Array
+      attr_reader :max
+      
+      def initialize(max)
+        @max         = max
+        @subscribers = []
+      end
+      
+      # Record an action in the History
+      def record(action)
+        self << action
+        notify_subscribers(action)
+        truncate
+      end
+      
+      def subscribe(&block)
+        @subscribers << block
+        block
+      end
+      
+      def unsubscribe(block)
+        @subscribers.delete(block)
+      end
+      
+      private
+      
+      def notify_subscribers(action)
+        @subscribers.each {|subscriber| subscriber.call(action)}
+      end
+      
+      def truncate #:nodoc:
+        if length > @max + 100
+          self[0..(length - @max)] = nil
+        end
+      end
+    end
+  end
+end

data/plugins/edit_view/lib/edit_view/tab_settings.rb

@@ -11,7 +11,7 @@ module Redcar
 
       attr_reader :tab_widths, :softnesses, :word_wraps, :margin_columns
       attr_reader :show_margins
-      attr_reader :show_invisibles, :show_line_numbers, :show_annotations
+      attr_reader :show_invisibles, :show_line_numbers
 
       def initialize
         @tab_widths =
@@ -31,7 +31,6 @@ module Redcar
               EditView.storage['show_margins'] || {})
         @show_invisibles   = !!EditView.storage['show_invisibles']
         @show_line_numbers = !!EditView.storage['show_line_numbers']
-        @show_annotations  = !!EditView.storage['show_annotations']
       end
       
       def width_for(grammar_name)
@@ -123,15 +122,6 @@ module Redcar
         EditView.storage['show_line_numbers'] = bool
       end
 
-      def show_annotations?
-        show_annotations
-      end
-      
-      def set_show_annotations(bool)
-        @show_annotations = bool
-        EditView.storage['show_annotations'] = bool
-      end
-      
       def show_margin?
         show_margin
       end

data/plugins/edit_view_swt/lib/edit_view_swt.rb

@@ -12,7 +12,55 @@ require File.dirname(__FILE__) + '/../vendor/java-mateview'
 
 module Redcar
   class EditViewSWT
+    NAVIGATION_COMMANDS = {
+      :LINE_UP                => 16777217,
+      :LINE_DOWN              => 16777218,
+      :LINE_START             => 16777223,
+      :LINE_END               => 16777224,
+      :COLUMN_PREVIOUS        => 16777219,
+      :COLUMN_NEXT            => 16777220,
+      :PAGE_UP                => 16777221,
+      :PAGE_DOWN              => 16777222,
+      :WORD_PREVIOUS          => 17039363,
+      :WORD_NEXT              => 17039364,
+      :TEXT_START             => 17039367,
+      :TEXT_END               => 17039368,
+      :WINDOW_START           => 17039365,
+      :WINDOW_END             => 17039366
+    }
+    
+    SELECTION_COMMANDS = {
+      :SELECT_ALL             => 262209,
+      :SELECT_LINE_UP         => 16908289,
+      :SELECT_LINE_DOWN       => 16908290,
+      :SELECT_LINE_START      => 16908295,
+      :SELECT_LINE_END        => 16908296,
+      :SELECT_COLUMN_PREVIOUS => 16908291,
+      :SELECT_COLUMN_NEXT     => 16908292,
+      :SELECT_PAGE_UP         => 16908293,
+      :SELECT_PAGE_DOWN       => 16908294,
+      :SELECT_WORD_PREVIOUS   => 17170435,
+      :SELECT_WORD_NEXT       => 17170436,
+      :SELECT_TEXT_START      => 17170439,
+      :SELECT_TEXT_END        => 17170440,
+      :SELECT_WINDOW_START    => 17170437,
+      :SELECT_WINDOW_END      => 17170438
+    }
+    
+    MODIFICATION_COMMANDS = {
+      :CUT                    => 131199,
+      :COPY                   => 17039369,
+      :PASTE                  => 16908297,
+      :DELETE_PREVIOUS        => 8,
+      :DELETE_NEXT            => 0x7F,
+      :DELETE_WORD_PREVIOUS   => 262152,
+      :DELETE_WORD_NEXT       => 262271
+    }
+    
+    ALL_ACTIONS = NAVIGATION_COMMANDS.merge(SELECTION_COMMANDS).merge(MODIFICATION_COMMANDS)
+
     include Redcar::Observable
+    include Redcar::Controller
 
     def self.start
       if gui = Redcar.gui
@@ -59,6 +107,8 @@ module Redcar
       mate_text.add_grammar_listener do |new_grammar|
         @model.set_grammar(new_grammar)
       end
+      
+      create_model_listeners
     end
 
     def create_mate_text
@@ -66,6 +116,82 @@ module Redcar
       @mate_text.set_font(EditView.font, EditView.font_size)
 
       @model.controller = self
+      
+      add_styled_text_command_key_listeners
+    end
+    
+    class CommandKeyListener
+      
+      attr_reader :st
+      
+      def initialize(styled_text, edit_view)
+        @edit_view = edit_view
+        @st = styled_text
+      end
+      
+      def key_pressed(event)
+      end
+      
+      def key_released(event)
+        record_action(event)
+      end
+      
+      # This pile of crap is copied from StyledText#handleKey. Wouldn't
+      # it be great if this logic was accessible on StyledText somehow?
+      def record_action(event)
+        if (event.keyCode != 0)
+          # special key pressed (e.g., F1)
+          action = st.getKeyBinding(event.keyCode | event.stateMask)
+        else 
+          # character key pressed
+          action = st.getKeyBinding(event.character | event.stateMask)
+          if (action == Swt::SWT::NULL)
+            # see if we have a control character
+            if ((event.stateMask & SWT.CTRL) != 0 && event.character <= 31)
+              # get the character from the CTRL+char sequence, the control
+              # key subtracts 64 from the value of the key that it modifies
+              c = event.character + 64
+              action = st.getKeyBinding(c | event.stateMask)
+            end
+          end
+        end
+        
+        if (action == Swt::SWT::NULL)
+		      ignore = false
+		
+          if (Redcar.platform == :osx)
+            # Ignore accelerator key combinations (we do not want to 
+            # insert a character in the text in this instance). Do not  
+            # ignore COMMAND+ALT combinations since that key sequence
+            # produces characters on the mac.
+            ignore = (event.stateMask & Swt::SWT::COMMAND) != 0 ||
+              (event.stateMask & Swt::SWT::CTRL) != 0
+          else
+    			  # Ignore accelerator key combinations (we do not want to 
+            # insert a character in the text in this instance). Don't  
+            # ignore CTRL+ALT combinations since that is the Alt Gr 
+            # key on some keyboards.  See bug 20953. 
+            ignore = (event.stateMask ^ Swt::SWT::ALT) == 0 || 
+              (event.stateMask ^ Swt::SWT::CTRL) == 0 ||
+              (event.stateMask ^ (Swt::SWT::ALT | Swt::SWT::SHIFT)) == 0 ||
+              (event.stateMask ^ (Swt::SWT::CTRL | Swt::SWT::SHIFT)) == 0
+          end
+          # -ignore anything below SPACE except for line delimiter keys and tab.
+          # -ignore DEL 
+          if (!ignore && event.character > 31 && event.character != Swt::SWT::DEL || 
+            event.character == Swt::SWT::CR || event.character == Swt::SWT::LF || 
+                event.character == Swt::SWT::TAB)
+            @edit_view.history.record(event.character)
+          end
+        else
+          @edit_view.history.record(EditViewSWT::ALL_ACTIONS.invert[action])
+        end
+      end
+    end
+    
+    def add_styled_text_command_key_listeners
+      st = @mate_text.get_text_widget
+      st.add_key_listener(CommandKeyListener.new(st, @model))
     end
 
     def create_undo_manager
@@ -111,6 +237,15 @@ module Redcar
       @undo_manager.end_compound_change
     end
 
+    def add_annotation_type(name, image_path, rgb)
+      rgb = Swt::Graphics::RGB.new(rgb[0], rgb[1], rgb[2])
+      @mate_text.addAnnotationType(name, image_path, rgb)
+    end
+
+    def add_annotation(annotation_name, line, text, start, length)
+      @mate_text.addAnnotation(annotation_name, line, text, start, length)
+    end
+
     def create_document
       @document = EditViewSWT::Document.new(@model.document, @mate_text.mate_document)
       @model.document.controller = @document
@@ -136,9 +271,6 @@ module Redcar
       h9 = @model.add_listener(:line_number_visibility_changed) do |new_bool|
         @mate_text.set_line_numbers_visible(new_bool)
       end
-      h10 = @model.add_listener(:annotations_visibility_changed) do |new_bool|
-        @mate_text.set_annotations_visible(new_bool)
-      end
       h11 = @model.add_listener(:margin_column_changed) do |new_column|
         @mate_text.set_margin_column(new_column)
       end
@@ -157,7 +289,7 @@ module Redcar
       @mate_text.get_control.add_key_listener(KeyListener.new(self))
       @handlers << [@model.document, h1] << [@model, h2] << [@model, h3] << [@model, h4] <<
         [@model, h5] << [@model, h6] << [@model, h7] << [@model, h8] <<
-        [@model, h9] << [@model, h10] << [@model, h11]
+        [@model, h9] << [@model, h11]
     end
 
     def right_click(mouse_event)
@@ -169,6 +301,20 @@ module Redcar
         end
       end
     end
+    
+    def type_character(character)
+      mate_text.get_text_widget.doContent(character)
+      mate_text.get_text_widget.update
+    end
+    
+    model_listener :type_character
+    
+    def invoke_action(action_symbol)
+      const = EditViewSWT::ALL_ACTIONS[action_symbol]
+      mate_text.get_text_widget.invokeAction(const)
+    end
+    
+    model_listener :invoke_action
 
     class VerifyKeyListener
       def initialize(edit_view_swt)