用 Ruby 和 Eclipse Monkey 编写 IDE 脚本

  • Werner Schuster
  • 郭晓刚

2007 年 11 月 1 日

话题:RubyIDE语言 & 开发

Eclipse 等 IDE 靠着从Smalltalk IDEs 里吸收养分已经赢得了很多用户——增量编译、本地版本管理就是其中的两个。不过 Smalltalk IDEs(或Emacs等编辑器)仍然占据优势的一个领域,就是 IDE 本身的自动化:在 IDE 里将重复性的工作变成脚本。Smalltalk 用户可以直接用 Smalltalk 去访问 IDE 的对象,Emacs 用户用 LISP 可以完成同样的工作——不但可以交互式地完成,还可以在运行时进行

Eclipse Monkey 为 Eclipse 提供了一个方案——Eclipse Monkey 的名字来自著名的 Firefox 插件 GreaseMonkey。它的第一版用 JavaScript(基于 Java 的 Rhino)作为脚本语言,但Christopher Williams 最近宣布也可以用Ruby(采用 JRuby)来编写脚本了

如果你不熟悉 EclipseMonkey,它是一组 Eclipse 插件,可以和用户交互,并用非 Java 的其他语言(最初仅支持 JavaScript)来给 IDE 写脚本。更详细的信息你可以查阅http://www.eclipse.org/dash/monkey-help.php?key=writing

EclipseMonkey 的 Ruby 扩展开启了用 Ruby 代码编写 IDE 脚本的能力。

最初的版本暴露了一个 Editor DOM,让你可以用脚本去操纵编辑器。我们在 Wiki 上已经准备了一些帮助,里面描述了很多细节以及 Editor DOM 的 API 信息。我们也提供了一些示例脚本,演示如何使用这个功能。

Eclipse Monkey 的设计实践了“简单”原则——这么做是有原因的:这个项目的发起人和设计者之一是 Ward Cunningham,他与其他人一起在 1990 年代发明了 Wiki。脚本是项目中的一些文本文件;任何元数据都保存在文件自身里面。元数据包括依赖性,或者运行脚本的一个快捷方式的声明。你可以把一个脚本与 Eclipse 中的任意事件挂钩,比如文件变更、文件保存或者程序启动。

下面是一段用 Ruby 写的 Eclipse Monkey 脚本,用来把编辑器里的 String 转成 Symbol

=begin


Menu: Ruby > String to Symbol

Kudos: Christopher Williams

Key: M1+Shift+;

License: EPL 1.0

DOM: http://download.eclipse.org/technology/dash/update/org.eclipse.eclipsemonkey.lang.ruby

=end

# If the current token is a string containing alnums, change it to

# a symbol

editor = $editors.get_active_editor

selection = editor.selection_range

selected_src = editor.source[selection]

# if entire selection is a string with no dynamic content, then

# convert the string to a symbol

match = selected_src.match(/(['"])([_a-zA-Z][_\w]*)\1/)

return if match.nil? || match.size != 3

symbol = ":" + match[2]

editor.apply_edit(selection.first, selection.size - 1, symbol)

Eclipse Monkey 中的另一个概念是DOM,别跟 HTML 或者 XML DOM 搞混了,它代表的是Domain Object Model。它是一个为特定领域的某些功能提供简化接口的一个对象。

以上面的代码为例,$editors变量指向一个处理所有与 Editors 相关之事的 DOM。为 Eclipse 这类 IDE 编写脚本,DOM 是必要的简化之举。通过直接访问 Eclipse 对象、系统及 API 来完成相同的事情也是可以的,不过写出来的脚本很可能会变得更加复杂。这是由于 Eclipse 的设计非常灵活,它具备的若干概念也造就了它的扩展能力——但也意味着像$editors.get_active_editor这样简单的一句表达式要变成 2-3 行代码。

这些 DOM 都是普通的Eclipse 插件,贡献到org.eclipse.eclipsemonkey.dom扩展点,因此在 Eclipse 的插件开发环境(PDE)中编写一个简化的功能接口是很容易的。Eclipse Monkey 的元数据也有助于 DOM 的配置管理:脚本的元数据段可以指定它所需 DOM 的 update site,当脚本运行的时候系统就会自动去获取需要的 DOM。

由于 Eclipse Monkey 脚本在 Eclipse 的 JVM 里运行,因此可以在脚本里使用所有的 Java API 和所有的 JRuby 标准库。现在已经存在很多 Eclipse Monkey DOM,让开发者得以访问 Eclipse 和 Eclipse 插件元系统提供的丰富代码和功能。

例如用 JMX DOM 就可以通过 JMX 来控制 JVM。通过简单的脚本就能够调用所有的 JMX 操作,查询所有的 JMX 属性。在实用中可以用它来从 Eclipse 启动一个程序,设置程序的属性(比如日志级别),调用程序的操作(比如执行垃圾收集)——只需简单的一步。别的 DOM 还可访问比如 CVS/SVN 插件、工作区、JDT 等等。

更多信息可参阅Aptana 的 Eclipse Monkey网站,或者Eclipse Monkey 网站的官方页面

查看英文原文:IDE scripting with Ruby and Eclipse Monkey
RubyIDE语言 & 开发