Создание сценария Eclipse с проектом Monkey: введение

Рисунок 3. UML-диаграмма, представляющая основные элементы Monkey.

Когда платформа Eclipse запускается,
EclipsePluginсоздает меню «Сценарии» и его содержимое, затем регистрирует listener (
UpdateMonkeyActionsResourceChangeListener), чтобы синхронизировать содержимое меню со сценариями. Пункты меню представлены
MenuRunMonkeyScriptклассом, производным от
org.eclipse.jface.action.IAction. Всякий раз, когда вы выбираете в меню сценарий для запуска, действие получает обработчик сценария из соответствующей
IMonkeyLanguageFactoryреализации и делегирует запрос
IMonkeyScriptRunnerреализации. Помимо создания обработчика сценариев, роль языковой фабрики состоит в том, чтобы понимать заголовок сценария и создавать
ScriptMetadataобъект в результате использования
getScriptMetadataметода. Вообще говоря
ScriptMetadataпредставляет поля, определенные в заголовке. Скрипт-бегун — тот, кто запускает скрипт. На данный момент есть только
JavaScriptRunnerДоступна реализация, позволяющая создавать скрипты Monkey на JavaScript. Другие языки поддерживаются разветвленным проектом GroovyMonkey, о котором я расскажу позже.

DOM

Скрипты были бы бесполезны без возможности взаимодействия с Eclipse. В мире Monkey вы используете DOM — простой Java-объект, доставленный в контекст скрипта. Таким образом, пользователи могут предоставлять любые методы и объекты, которые они хотят. DOM вносятся в Обезьяну через точки расширения. Следующие разделы объяснят детали.

Универсальный ДОМ

Пример лучше всего поможет научить. Давайте создадим простую модель DOM: ExampleDOM. Там будет только два метода:

package com.onjava.monkey.dom;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * Example DOM for use in monkey scripts.
 */
public class ExampleDOM {

        private static final SimpleDateFormat dateFormat = 
                new SimpleDateFormat();

        /** Print current date . **/
        public void printDateNow(){
                System.out.println(dateFormat.format(new Date()));
        }
        
        /** Print debug message. **/
        public void printDebug(String msg){
                System.out.println("DEBUG: "+msg);      
        }
}

Чтобы сделать этот объект доступным для скрипта, нам нужно реализовать org.eclipse.eclipsemonkey.dom.IMonkeyDOMFactoryинтерфейс. Это фабричный интерфейс, в котором реализован только один метод:

public interface IMonkeyDOMFactory {
    public Object getDOMroot();
}}

В нашем примере мы хотим вернуть ExampleDOMэкземпляр класса. Он не имеет состояния, поэтому мы всегда можем вернуть один и тот же экземпляр.

package com.onjava.monkey.dom;

import org.eclipse.eclipsemonkey.dom.IMonkeyDOMFactory;

/**
 * Simple DOM factory.
 */
public class DOMFactory implements IMonkeyDOMFactory {

        private ExampleDOM dom;
        
        public DOMFactory() {
                dom=new ExampleDOM();
        }

        public Object getDOMroot() {
                return dom;
        }
}
Сейчас мы вносим свой вклад DOMFactoryв org.eclipse.eclipsemonkey.domточку расширения , чтобы сделать скрипт бегуна в курсе нашего DOM. Мы должны предоставить следующие значения:

variableName — имя, под которым экземпляр DOM будет зарегистрирован в контексте скрипта. 
class — Фабрика, которая будет производить DOM. 
resource — Имя класса, отражающее класс корня DOM 

Вот что входит в plugin.xml:
<plugin>
   <extension
         point="org.eclipse.eclipsemonkey.dom">
      <dom
            variableName="example"
                class="com.onjava.monkey.dom.DOMFactory"
            resource="com.onjava.monkey.dom.ExampleDOM"
            >
      </dom>
   </extension>
</plugin>


Don’t worry if you feel a little bit lost. I made the code above available as a plug-in, try it to fill the gaps in your understanding. There is source and binary distribution available.
Language specific DOM
Apart from generic DOM, JavaScript engine is supporting objects designed to be used with JavaScript. The way how you can contribute them is not too much different from generic DOM contribution. Important thing to know is that DOM contributed to org.eclipse.eclipsemonkey.lang.javascript.javascript_dom extension point, will be available only to Monkey scripts run by JavaScript engine. It is not a big problem for now as this is the only supported scripting language.
DOM usage and summary
DOM have to be packed as a plug-in an published on an update site in advance to use. The ExampleDOM is available at this update site: http://monkey.brain-bakery.com/update-site/ as a com.onjava.monkey.dom plug-in. The reference is established in a script header. Whenever want to use DOM you have to add «DOM» entry. Following is an example with a reference to ExampleDOM. Please, create new script file ExampleDOM.js and paste following content.
/*
 * Menu: OnJava > ExampleDOM
 * Kudos: OnJava
 * License: EPL 1.0
 * DOM: http://monkey.brain-bakery.com/update-site/com.onjava.monkey.dom
 */
function main() {
        example.printDateNow
        example.printDebug(“This is debug message.â€)
}}


Что сделает Monkey, когда увидит заголовок из предыдущего кода? Попробуйте сами, запустив скрипт. Выберите из OnJava > ExampleDOMпункта меню «Сценарии» . Вы должны увидеть диалоговое окно с предупреждением об отсутствии DOM.
[Img_assist | NID = 741 | название = | убывание = | ссылка = нет | ALIGN = слева | ширина = 500 | Высота = 171]
 
 
 
 
 
 
Рисунок 4. Диалоговое окно «Missing DOM».
Нажмите «Установить плагин». Предполагая, что выше

 ExampleDOMмы создали ранее, скрипт должен поместить два сообщения в представление консоли: текущая дата и сообщение отладки.


То, что только что произошло, является частью магии Обезьяны. Плагин, который доставляет DOM, может быть загружен и доступен для скрипта, благодаря записи в заголовке. Вот что видит Обезьяна:

http://monkey.brain-bakery.com/update-site/ — обновить местоположение сайта 
com.onjava.monkey.dom — плагин, который содержит DOM 

The plug-in is downloaded from the update site, DOMs are made available in script’s context. This mechanism is not perfect. Be aware of fact there is no support for versioning DOM objects. It may happen that a script will stop working, because of changes in remote DOM.
Now you know how powerful Monkey scripts can be. With proper set of DOM contributions a script can access any part of Eclipse. For your convenience there are some DOM available with Monkey distribution:

Generic (no need to mention in header)

resources — org.eclipse.eclipsemonkey.doms.resources.Resources 
workspace — org.eclipse.eclipsemonkey.doms.workspace.WorkspaceDOMFactory 


JavaScript specific (DOM url: http://download.eclipse.org/technology/dash/update/org.eclipse.eclipsemonkey.lang.javascript)

io — org.eclipse.eclipsemonkey.lang.javascript.doms.io.IO org.eclipse.eclipsemonkey.lang.javascript.doms.io.File wrapper around java.io.File org.eclipse.eclipsemonkey.lang.javascript.doms.io.WebRequest 
resources — org.eclipse.eclipsemonkey.lang.javascript.doms.resources.Resources 
views — org.eclipse.eclipsemonkey.lang.javascript.doms.views.Views 
editors — org.eclipse.eclipsemonkey.lang.javascript.doms.editors.Editors 




Your own script
You are ready to write your very first script. Here is the idea: Whenever I’m stuck while coding I use one of code search websites to find examples, related to subject I’m working on. We will use Koders website. These are goals for the script:

take current editor’s selection as an input 
search at Koders website for selected phrase 
show the result in Eclipse view. 
be available in «Scripts» menu, as > Search > Google Code item. 

We start with script’s header. This is what we need:
/* 
 * Menu: Search > Koders
 * Kudos: OnJava.com 
 * License: EPL 1.0
 * DOM: http://download.eclipse.org/technology/dash/update/org.eclipse.eclipsemonkey.lang.javascript
 */

Store the script in a file your workspace. Create a new project named "OnJavaMonkey" and new "scripts" folder within. Create new file CodersSearch.js beneath and paste lines above. Go and check "Scripts" menu, similar items should be there:
[img_assist|nid=742|title=|desc=|link=none|align=left|width=270|height=326]
 
 
 
 
 

 
 
 
 
 














Figure 5. Example script’s location.
Плагин Monkey читает открытые проекты и проверяет папку «scripts». Любой файл с расширением js читается, анализируется и помещается в меню. Скрипт доступен, но не работает. Добавляем функцию

 main:


 
function main() 
{
        var sourceEditor = editors.activeEditor;

        var range = sourceEditor.selectionRange;
        var deleteLength = range.endingOffset - range.startingOffset;
        var selection = sourceEditor.source.substring(range.startingOffset,range.endingOffset);
                
        webView = views.getView("KodersWebView");
        webView.showView(true);
        webView.setTitle("Koders");
        webView.url = "http://www.koders.com/default.aspx?btn=Search&la=*&li=*&s="+selection;
}


Now I want you to open a new editor (New > Untitled Text File) and type String.substring. Select what you have typed and run the script from Search > Koders; menu.
[Img_assist | NID = 743 | название = | убывание = | ссылка = нет | ALIGN = слева | ширина = 500 | Высота = 324]
 
 
 
 
 
 
 
 
 
 
 
Рисунок 6. Результат поиска.
Результат не должен сильно отличаться от того, что вы видите на снимке экрана: список всех вхождений «String.substring» во всем коде, проиндексированном Koders


Обмен скриптами
Скрипты могут быть переданы очень легко. Когда вы публикуете в своем блоге или вики-странице, любой может скопировать и вставить скрипт в свою рабочую область. Вам нужно знать только одно правило. Сценарии должны быть заключены в следующие строки, вдохновленные Jabberwocky:
  --- Came wiffling through the eclipsey wood ---
... script goes here ...
  --- And burbled as it ran! ---}

Как только вы помните это, вы можете поделиться своими сценариями. Для вашего удобства при щелчке правой кнопкой мыши на скрипте в навигаторе проекта доступно меню «Копировать для публикации».
[Img_assist | NID = 744 | название = | убывание = | ссылка = нет | ALIGN = слева | ширина = 460 | высота = 182]
 
 
 
 
 
 
Рисунок 7. Публикация скриптов стала проще.
Возможно, вы захотите проверить следующую площадку скриптов:

 http://monkey.brain-bakery.com/ . Это веб-сайт, на котором вы можете легко публиковать свои работы и искать в других материалах.


GroovyMonkey
GroovyMonkey — это разветвленный проект, начатый Джеймсом Эрвином в мае 2006 года. Первоначально проект был создан для тестирования поддержки многих дополнительных языков: BeanShell, Python, Groovy и Ruby. Сегодня это больше похоже на тестовую площадку для будущих функций, вот некоторые из них:

вклад в контурный вид, дающий вам удобный вид дерева со списком объектов, доступных в ваших скриптах 
расширенные поля заголовка, дающие вам больший контроль над выполнением скрипта (например, вы можете пометить ваш скрипт как UI Job) 
дополнительные деревья DOM 

[Img_assist | NID = 745 | название = | убывание = | ссылка = нет | ALIGN = слева | ширина = 500 | высота = 338]

 
 
 
 
 
 
 
 
 
 
 































Рисунок 8. GrooveMonkey в действии.
Набор функций GroovyMonkey — это нечто большее, чем просто несколько настроек, это заслуживает отдельной статьи. Это, безусловно, проект, который вы хотите попробовать. Просто не забудьте удалить или отключить Monkey перед началом установки GroovyMonkey.


Резюме
Как я уже упоминал в начале, проект все еще развивается. Чтобы быть в курсе последних изменений, вам следует взглянуть на источники. Установить их проще, чем вы думаете. Перейти на домашнюю страницу проекта и проверить.
Now when you are familiar with the Monkey, it is the time to start creating your own scripts. You have learned script’s syntax and concept of DOMs contribution and sharing. This knowledge enables you to make development more productive. Start making your life easier and remember to share your scripts with others.
Resources

The Monkey Project homepage

homepage 
mailing list archive 


Groovy Monkey homepage: http://sourceforge.net/projects/groovy-monkey 
The Scripts Marketplace: http://monkey.brain-bakery.com 
Example DOM — com.onjava.monkey.dom:

Update site http://monkey.brain-bakery.com/update-site/ 
Source and binary distribution 


Rhino project page: http://www.mozilla.org/rhino/scriptjava.html 
Find yourself a JavaScript editor:

http://www.eclipseplugincentral.com/ 
http://eclipse-plugins.2y.net/