Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Add the ability to write plugins using jruby or groovy.
Student: Anton Arhipov
SVN repo at SF.net: at eclipse-incub
Scripting language like Groovy (or JRuby) is an ideal choice for Java developer to do quick prototyping. The biggest benefit of Eclipse support for Groovy plug-in development is that while changing the plug-in on-the-fly there's no need to start a separate Eclipse instance or restart the IDE when something was changed in the code. This would rapidly improve the speed of lightweight plug-in development.
This project aims to add ability to write plugins in JVM-based scripting language, like Groovy and JRuby. But it could be a starting point for any other JVM scripting language, like BeanShell or Jython.
SVN repo at SF.net at eclipse-incub contains two plug-ins:
- org.eclipse.soc.scripting.plugin - this is the plug-in that should provide the ability to write the new plug-ins in a scripting language, e.g. Groovy.
- org.eclipse.soc.scripting.contributor - a demonstration plug-in that contributes the components written in a scripting language.
I will also provide a set of unit tests as a separate plug-in and feature/site projects for the installation.
Implementation of runtime engine to run the scripts. javax.scripting API is in use for this purpose: ScriptExecutor does the job.
Proxy class. A proxy solution is implemented for delegating the method calls to the scripting world: ScriptExtensionProxy
A reference to a script file is done using a syntax hack that is provided by the org.eclipse.core.runtime.IExecutableExtension interface. Script file name is referenced in the same text value where the class name is specified:
See the demostration plug-in for more: plugin.xml
Exposing the workbench to the script. This should be very much like in Eclipse Monkey. For smooth scripting there should be a set of predefined variables that a script contributor could use out of the box: e.g a reference to workbench, windows, views, etc.
- <language>.jar, e.g. groovy-all.jar
- <language>-engine.jar, e.g. groovy-engine.jar
- yummy-plugin.jar, i.e. the plug-in for any specific language will use the engine to run the scripts executed by <language>-engine.jar at the end. The brand new scripted plug-in will have to use yummy to enable scripting support.
- Licencing issues for 3rd-party libraries, e.g. groovy-all.jar, groovy-engine.jar
- Find the deployed script bundle by its ID
- Browse the scripts in the bundle
- Open any script in an editor and allow to modify it
- Save the modified script in the bundle
- Redeploy the bundle
- Create a a bundle programmaticaly and register it via Equinox?
The goal to be reached is an Eclipse extension/plug-in that could be used to write the new plug-ins in a scripting language, e.g. Groovy.