[vwnc] RBBlueMagic (new RB plugin)

Hi list, i wanted to let you all know I've published an addon in the public repository to provide some quick navigation features to the Refactoring Browser. All the functionality is accessed through the middle mouse button.
The plugin was born as an addon to give the middle button the same behavior you´d expect from an Internet browser (a kind of FireFox feel), now it has lots of other useful features.

Name of the package: RBBlueMagic
VW image: 7.6
Prerequisites: RBTabbedToolsets-Ext (by Lautaro Fernandez), RBCodeHighlighting and RBQuickNavToolset.

Features:

• Middle-Click on a method/class in the source code or the browser navigator opens the definition of the selected item in a new tab or the current one.
• Open implementors/senders for methods and references for classes.
• Edit resources spec and open applicationModel classes with one click.
• Rename almost anything with [Alt + Middle-Click].
• Define new... when clicking on undefined instance variables/methods/classes.
• Some common refactorings and quick code comment.
• Browse the history for each tab with Alt key pressed and the mouse wheel. [Works only if RBrowserHistory is loaded (not prerequisite)].
• Close tabs in the refactoring browser.
• If no action is defined for a specific situation, the middle button will work as usual (window menu).
• Different policies to select/act upon the code (relative to mouse or key cursor/middle button can also select code).
• Basic and Extended Options to configure how the Blue Magic will react to each modifier combination (ctrl|shift|alt).
  

It still needs work so any suggestion/comment/bug-report will be more than welcome.
I've attached some screenshots of the config apps so you can get the idea. I'll be soon sharing a tutorial screencast to show it in action (as it is a controller, still pics don't say that much...).
That's all. Hope you enjoy it and use it to make your class browsing a little bit easier.

Cheers, Emiliano

pd1: I strongly recommend to load also NewVasillisIcons and the RBrowserHistory, and do the fix i mention in the last part of the comments (otherwise browser history will override tab functionality).
pd2: I guess now you know why i been whining about the wheel mouse events so much...  : )

------------------------------------------------------
PACKAGE COMMENTS:

This package provides quick RB navigation features accessed thorough the middle mouse button ("window" button, blue button, whatever...).
Quick Config? Evaluate: BlueMagicBasicConfig open.
It started as a link-like navigation complement to work with RBTabbedToolset and RBrowserHistory in order to give the refactoring browser a FireFox look&feel (check the tip in last part of this comments).

FEATURES:
- In the Source tab, the middle click acts upon the source code.
- In the browser navigator the middle click acts upon pointed node (class/method/protocol/packages).
- You can use ctrl, shift and alt keys to modify the behavior of the middle click.
- At the moment there are more than 30 possible actions to use between the source code and the navigator, including (but not limited to) the following:
    - Method/class quick browsing.
    - Rename, extract and inline refactorings.
    - Method/class inspection using the menu/image/canvas editors.
    - New classes/methods/v.i. definition.
    - You can see them all and change the modifiers assigned to them in the config app.
- There are 8 possible combinations (ctrl|alt|shift) for each context of selection (class,method,protocol, etc) so you can configure lots of actions for the browser.
- If no action is defined for the combination, the middle button will work as usual (window menu).
- New behavior possibilities for middle clicking in the code (point and click/dragging selection).
- If RBrowserHistory is loaded, alt+wheel goes back and forth the history.
- Middle Click on a tab closes it.

NOTES:
- Will only work properly in new opened browsers.
- Some overrides, for compatibility with other addons check them.
- RBCodeHighlighting and RBTabbedToolset are prereqs to exploit the source code and tab functionality.
- RBTabbedToolset-ext from Lautaro "The Tab Guru" Fernandez also loaded to perform some tab-specific functionality.

NEW MIDDLE CLICK BEHAVIOR:
- Different policies to select code with the middle-click. Some examples:
    - Middle button can be static and ignore the mouse pointer, you have to left-click to select and then middle-click to work the magic.
    - Middle button can be relative to the mouse pointer, but don't move the cursor from its actual position.
    - Middle button can select and deselect with point and click, just like the left button.
    - Middle button can select the code in which it will act dragging the mouse over the selection.
        - Press to start selecting.
        - Release to act upon selection.
        - This mode enables extract refactorings with just one click!

ACTIONS EXAMPLES:
-These are some examples of the most used actions with the default config:
   - Clicking a class or a method opens class/method in new inactive tab.
   - [Clicking + CTRL + ALT] Navigates to class/method within the same browser.
            - A selection list will be shown if selector has more than one implementor.
    - If a chunk of code is selected it runs the Extract to method refactory.
    - Rename almost anything with [Alt + Middle-Click].
- Check the config app for the rest.

CONFIG:
- To configure the controller go to the the settings page under System>>Settings>>Tools>>Browser>>Blue Magic .
- There are two versions of the config application.
    - I recommend you to start with the basic one:
        - It's easier, divides the actions into categories so you wont have to define 30 different combinations to use them.
        - It also helps to keep consistence for the effects of the modifier keys (same key has the same effect in different contexts).
    - When you get the hang of the Blue Magic functions, you can move on to the advanced action options if it suits you better:
        - This one allows you to define single actions for each context/key combinations.
        - A bit more tricky but way more powerful than the basic one.

THANKS TO:
- Lautaro Fernandez author of the Blue Magic icon and two other great plugins (NewVasillisIcons and RBTabbedToolsets-Ext wich i use here).
- Sebastian Perez Escribano that has been beta testing the plugin for some time now.

------------------------------------------------------
EXTRA TIP:
RBrowserHistory and RBTabbedToolset don't work together, both packages override the same method so they exclude each other.
To make them work in the same image you have to load them and then redefine the following method like this:

RefactoringBrowser>>postOpenWith: aBuilder

    super postOpenWith: aBuilder.
    self addFind.
    self addHistory.
    self addToolsetsTabs.
    self updateToolbar.
    (RBHistoryCompatibility currentToolFrom: self) updateDisplay.
    self enableHistoryButtons
------------------------------------------------------

[To Do]:
- Better support for namespaces.
- Review the RB controller api hookup.
- Move blue magic actions to commands.

Author:
    Emiliano Pérez
Contact:
    [hidden email]


_______________________________________________
vwnc mailing list
[hidden email]
http://lists.cs.uiuc.edu/mailman/listinfo/vwnc