Hyperlink

Hyperlink（超链接）在 Java 编辑器中用来进行快速的代码定位，当你按住 Ctrl 键并把鼠标指向一个函数名的时候，函数名会显示为超链接，点击之后代码会跳转到函数的声明处。这个功能使得 Eclipse 浏览代码很方便，这次我就来介绍如何在自己的编辑器中添加超链接功能。

超链接的定位

编辑器不会知道哪块区域应该显示为超链接，这是通过 IHyperlinkDetector 接口实现的。这里牵涉到语义方面的内容，因为你必须要能知道鼠标下面到底是个什么。在解析器那一层需要实现这样的支持。

超链接的渲染

JTF 是如何显示超链接的？可能你会想到标注，缺省的实现不是这样。这里要介绍另外一个接口：IHyperlinkPresenter。JTF 缺省的时候是用 StyledText 的 StyleRange 实现的，其实就是把超链接的那块文字置为蓝色且带下划线。但是因为有了这么一个接口，你可以把超链接弄成任何样子。

回页首

实现超链接

本文要实现的超链接功能是：点击某个变量名，编辑器会选中声明该变量的那条语句。

底层支持

底层需要支持两个功能：判断某个位置是一个变量，以及得到变量声明的语句范围。由于我的例子很简单，判断是不是变量也非常简单，只要符号类型是一个 ID 类型就行了。得到变量声明的语句范围需要检查语法树，因为变量声明的子树以等号为根节点，所以找到对应的根节点就行了。然后从等号开始得到子树的最左和最右节点，从而计算出整个子树的字符范围。这些代码已经添加到了 TreeHelper 中，具体请参看 getVariableDeclaration 和 getTreeRange 方法。

实现 IHyperlink

我实现了一个 VariableHyperlink 来封装超链接信息，它最重要的方法是 open()，因为它会在你点击超链接后被调用：

                
   
public void open() {
	// get doc
	IDocument doc = viewer.getDocument();
	
	// get tree
	Tree tree = TreeManager.getTree(doc);
	
	// get variable declaration range
	Point range = TreeHelper.getVariableDeclaration(tree, variable);
	
	// select text
	if(range != null) {
		viewer.setSelectedRange(range.x, range.y);
		viewer.revealRange(range.x, range.y);
	}
}

我用到了刚才提到的 TreeHelper 中的方法来得到声明语句的范围，剩下的事情就比较直接了，选择这个范围并让确保其在编辑器中可见。

实现 IHyperlinkDetector

ExprHyperlinkDetector 完成了发现变量的功能，然后把变量信息包装在 VariableHyperlink 中。在之前的文章中，我已经不止一次的使用了 TokenList 来得到某个偏移处的符号，ExprHyperlinkDetector 也依赖于 TokenList，所以这里不详细解释了。

配置

覆盖 ExprConfiguration 的 getHyperlinkDetectors，让它返回 ExprHyperlinkDetector。它的返回值是一个数组，所以你可以安装多个 IHyperlinkDetector 实例。对于这个简单的小例子，并无必要使用多个 IHyperlinkDetector 实例。

回页首

结束语

超链接是 JTF 中相对简单的一个功能了，但是不要忘了，我是没有实现全部的功能的：

1. 是不是一定需要按住 Ctrl 键才能激活超链接功能呢？不是，请看看 SourceViewerConfiguration 的 getHyperlinkStateMask 方法。
2. 试试看使用 IHyperlinkPresenter 实现一个自定义的超链接样式，这里牵涉到 HyperlinkManager 这个类的使用。这个功能较为复杂一些，需要这样做的时候也不多，没有时间的读者不妨看看 DefaultHyperlinkPresenter 类的实现。
3. 例子还是有 bug 的，比如如果一个变量声明了两次，则只会选择第一条声明语句。可以考虑显示一个浮动窗口来选择跳转到哪个，你想到了什么解决方案呢？

回页首

声明

本文仅代表作者的个人观点，不代表IBM的立场。

回页首

下载

关于下载方法的信息

参考资料

• 如果对 ANTLR 有更多的兴趣，请参考“ANTLR 项目主页”
  
  
• “SWT 和 JFace，第 1 部分: 简介”（developerWorks 中国，2005 年 5 月）介绍了 JFace 基础知识。
  
  

关于作者

为本文评分

评论

回页首

内容

• Hyperlink
• 实现超链接
• 结束语
• 声明
• 下载
• 参考资料
• 关于作者
• 建议