如何在 Eclipse 编辑器插件中显示语法错误

Question

我如何指示语法错误（例如非法的标记序列）在 Eclipse 编辑器插件中就像在 Eclipse Java 编辑器中一样，即通过红色蠕动的下划线、滚动条上的红色标记（您可以跳转到该标记）以及将鼠标悬停在任一标记上时的解释性消息？

我正在为自定义文件格式（特别是 Shark3D 游戏引擎的“蛇文件格式”）编写一个 Eclipse 编辑器插件。我已经实现了一个扫描仪来获取语法突出显示和大纲。

• 对于下划线，我是否只需让扫描仪返回一个 IToken 带有“蠕动的下划线” TextAttribute 而不是普通的，或者是否有一种特定的机制来标记语法错误？
• 如何实现滚动条标记？是 IAnnotationModel 相关接口在这里？如果是这样，我在哪里注册实现以便标记出现？
• 我只找到了 SourceViewerConfiguration.getAnnotationHover(), ，这将允许我实现悬停行为，但仅限于“注释”，我认为这意味着滚动条标记 - 如何实现文本本身的悬停行为？

我很乐意提供具体的建议以及涵盖此内容的教程的 URL - Eclipse 帮助文档和示例似乎没有。

编辑：标记是最好的解决方案。有关如何使用它们的工作示例可以在插件示例代码中找到 org.eclipse.ui.examples.readmetool.AddReadmeMarkerAction

Answer 1

您应该使用标记。

源自“The Java Developer's Guide to Eclipse”的示例如下：

<extension point="org.eclipse.core.resources.markers"  
            id="snakesyntax"  
            name="Snake syntax error">  
    <super type="org.eclipse.core.resources.problemmarker" />  
    <super type="org.eclipse.core.resources.textmarker" />  
    <persistent value="true" />
<extension>

IMarker marker = res.createMarker("com.ibm.tool.resources.snakesyntax");

marker.setAttribute(IMarker.SEVERITY, 0);
marker.setAttribute(IMarker.CHAR_START, startOfSyntaxError);
marker.setAttribute(IMarker.CHAR_END, endOfSyntaxError);
marker.setAttribute(IMarker.LOCATION, "Snake file");
marker.setAttribute(IMarker.MESSAGE, "Syntax error");

Answer 2

正确的方法是使用标记接口。

标记本质上是一个将标记对象映射到源代码中位置的模型，因此这在多个文件中可能存在错误的情况下是有意义的。（参见IMarker界面）

如果您想将标记添加到当前编辑器但不是所有项目，一个更便宜的选择是使用注释，您可以自己添加或删除注释。

标记在 UI 中表示为注释，但 Eclipse 会自行添加和删除注释。通过直接注释，一切尽在您的掌控之中。