Markers and Annotations in Eclipse for Error Feedback(forward)

Motto:

Ninety per cent of most magic merely consists of knowing one extra fact.
Terry Pratchett, Night Watch

Development in Eclipse keeps fascinating me, as there are a lot of very thoroughly designed services and features integrated to allow detailed customization – on the other hand, “with big power comes big responsibility”, but at least a steep learning curve. I had such an experience with the problem handling support not long ago.

We developed our own textual language, that provided error markers and editor annotations as error feedback. The problem was that the editor annotations were sometimes missing: our planned functionality worked like we like to add an annotation each time our marker was added, but the annotations were not always updated (so we got an inconsistent state between markers and annotations – but not every time).

Of course that was caused by the fact that we were rolling out our own implementation of marker/annotation synchronization – we were not aware that the JFace TextEditor provides such a service out of the box – and I did not found it documented on the various locations (that’s why this blog post is born ).

Our requirements

First of all, lets assemble the various ways Eclipse editors can provide error feedback:

• The most basic (and least usable) way is the use of pop-up windows – they are annoying, and not persistent (after pressing a button, they disappear, before the error could be solved).
• Writing to the Error log view – a bit better, but the log could be overwhelmed, if the messages are too many, because they cannot be deleted when the problem is solved.
• Displaying the error in the Problems view – that’s one of the standard places, where parse errors should be displayed. The problems view is generated by reading (and filtering) the error marker type (org.eclipse.core.resources.problemmarker ).
• Marking the files in the Project Navigator view with a small symbol, if they contain errors/warnings. This is also handled using the previously mentioned error marker.
• Underlining the erroneous parts in the editor. For this reason annotations should be added to the JFace Document Model used by the JFace TextEditor component.

The basic idea is to create a marker and an annotation each time a problem is found. The problem with annotations, that creating them requires some connection with the editor object, or at least the document model, but our parser should not depend on the editor (core component should not depend on the GUI!).

Mark My Words!

The management of the markers is well described in the Mark My Words tutorial. Basically markers are attached to IResources , and provide a simple key-value interface with a freely definable key set (and the IMarker interface specifies some commonly used keys).

Following the tutorial we could create our own marker with the parent of the org.eclipse.core.resources.problemmarker marker, after this adding the markers to the selected files managed the error display in the Problems and Project Navigator views.

So our marker definition looks as follows:

1 2 3 4 5 6 7 8

<extension id ="org.eclipse.viatra2.loaders.vtclparsermarker"      name ="VTCL Parsing Problems"      point ="org.eclipse.core.resources.markers" >    <super type ="org.eclipse.core.resources.problemmarker" >    </super>    <persistent value ="true" >    </persistent> </extension>

The problem marker understands severity, error message and line number parameters, and is capable of displaying them in the Problems view.

1 2 3 4

IMarker marker = file.createMarker ( markerId) ; marker.setAttribute ( IMarker.SEVERITY , severity) ; marker.setAttribute ( IMarker.MESSAGE , message) ; marker.setAttribute ( IMarker.LINE_NUMBER , line) ;

Annotating the document manually

As stated before, markers could be added easily without knowing anything about who has opened the file currently, so they are really useful for error feedback, but this information should be also available in the open editors.

Our first idea may be to create some glue code, that listens to the marker changes, and updates our editor accordingly. The drawbacks of this approach are first the fact that we have to code something that trivial, and the second (as we saw in our project), that the editor update could be quite tricky (missing or not deleted annotations).

My theory is, that we have encountered some kind of race condition with our naive implementation, as the annotation creation code was always executed, but sometimes the results were lost. So, in the end, this listener is not so trivial.

Automatic annotation display

This was the part that gave us the most headache – we did not understand, what caused the inconsistent display problem. On the other hand, knowing one extra fact (“magic”) the problem is trivially solvable.

So, here comes the Eclipse magic: we don’t have to create this service manually, we should reuse the already existing one. For that, we would need that our marker also become a child marker of the org.eclipse.core.resources.textmarker , and a minimal set of position data should be added to the marker.

This position information is described by the start and end offset value – instead of the human-readable line/column position information a machine-readable single position is used: the number of characters that has to be read from the start of the string stream. Its lucky, that most parser generators provide such output that this information is trivially available from the AST level.

1 2 3 4 5 6 7 8 9 10 11

<extension id ="org.eclipse.viatra2.loaders.vtclparsermarker"      name ="VTCL Parsing Problems"      point ="org.eclipse.core.resources.markers" >    <super type ="org.eclipse.core.resources.problemmarker" >    </super>    <persistent value ="true" >    </persistent>    <!-- The following item is added -->    <super type ="org.eclipse.core.resources.textmarker" >    </super> </extension>

And the marker creator Java code looks as follows:

1 2 3 4 5 6 7 8

IMarker marker = file.createMarker ( markerId) ; marker.setAttribute ( IMarker.SEVERITY , severity) ; marker.setAttribute ( IMarker.MESSAGE , message) ; marker.setAttribute ( IMarker.LINE_NUMBER , line) ; if ( pos.offset != 0 ) { marker.setAttribute ( IMarker.CHAR_START ,pos.offset ) ; marker.setAttribute ( IMarker.CHAR_END ,pos.offset + pos.length ) ; }

After that, the platform uses a default implementation, that provides the well-known wriggly underline to annotate our text files with the associated markers.

Summary

Alltogether, the following steps are needed to provide a simple error reporting for our existing editor:

• Create a custom marker type
  • With a supertype of org.eclipse.core.resources.problemmarker to display the report in the problems view
  • With a supertype of org.eclipse.core.resources.textmarker to underline the errors in the textual editor
• Create a marker instance
  • Setting the IMarker.SEVERITY , IMarker.MESSAGE and IMarker.LINE_NUMBER attributes for the Problems view.
  • Setting the IMarker.CHAR_START and IMarker.CHAR_END for the editor annotations.

Conclusion

The Eclipse text editors provide a well-defined, easy to use error reporting mechanism nearly for free. The main catch is, we have to be careful to set everything – if something is missing, we got the silent failure issue – no exception is thrown, but something is not shown.

The biggest issue in our implementation was that the IMarker.CHAR_START and IMarker.CHAR_END marker attributes are ignored, if the used marker is not a text attribute, making this problem hard to identify.

A fine thing with this error reporting mechanism is, that it is independent of the concrete text editor used: when we changed our implementation in the VIATRA framework, the resulting reports were visible in every text editor (e.g. the dedicated VIATRA text editor, or the default text editor in Eclipse) – thus helping error recovery.