Implementation notes -- developer-only reference

Related interfaces and classes

org.eclipse.ui.texteditor.ITextEditor

Interface to a text editor. This interface defines functional extensions to IEditorPart as well as the configuration capabilities of a text editor.

Text editors are configured with an IDocumentProvider which
delivers a textual presentation (IDocument) of the editor's
input. The editor works on the document and forwards all input element
related calls, such as save, to the document provider. The
provider also delivers the input's annotation model which is used to control
the editor's vertical ruler.

org.eclipse.jface.text.IDocument

Represents text providing support for

text manipulation,

positions,

partitions,

line information,

document change listeners,

document partition change listeners

org.eclipse.jface.text.IDocumentInformationMapping

A IDocumentInformationMapping represents a mapping between the coordinates of two IDocument objects: the original and the image. The document information mapping can translate document information such as line numbers or character ranges given for the original into the corresponding information of the image and vice versa.

org.eclipse.jface.text.ITextStore

Storing and managing text.

org.eclipse.jface.text.ILineTracker

Maps character positions to line numbers and vice versa.

org.eclipse.jface.text.IDocumentAdapter

Adapts an org.eclipse.jface.text.IDocument to the org.eclipse.swt.custom.StyledTextContent interface.
The document adapter is used by org.eclipse.jface.text.TextViewer to translate document changes into styled text content changes and vice versa.

Previously there seemed to be two candidates for managing and providing wrapping services:

TreeLineTracker is using binary tree structure to hold information about lines, their lengths, offsets and delimiters.
This class is modified to provide additional structure to store wrapping-related information.

Wrapped model is always in sync with physical line model by changing TreeLineTracker.Node.setLength() method.
For testing purposes wrapped model information is always returned for ILineTracker interface.
Later additional interface must be created to support the idea of two line models.

Patching strategy

Two possible locations:

Patching StyledText - this would become too bloated for keeping wrapped document model. In addition, as some visuals need wrapped and some need unwrapped document model then this would separate StyledText wrapped text from IDocument/TextViewer too much. Currently StyledText has WRAP support but it's not complete!

Patching TextViewer - this means patching one or several of it's accessories like IDocumentAdapter, IDocumentInformationMapping. This way column rulers and viewer widget would have access to wrapped or unwrapped model, whichever is more appropriate in that context. Most of the time wrapped model can be used.

Both of these strategies require modifying at least LineNumberRulerColumn.

As a proof of concept I wrote IDocumentAdapter that has additional IDocument that is wrapped and is used when returning line-based selections from the document. Experimenting with IDocumentAdapter showed that wrapping works (except some unregular input handling behaviour). But there seems to be no way to introduce wrapped document to the column rulers without modifying underlying file only by modifying IDocumentAdapter.

IDocumentInformationMapping might be a better place for wrapping model but as current implementation is pretty complex (as is probably the whole code folding support) then I would love to get some hints about the feasibility of extending this with word wrap.

Experiment with IDocumentAdapter

Creating IDocumentAdapter that supports word wrap would fix TextViewer to support wrapping.
But as wrapping is only visual then all related ruler columns like annotations, line numberings etc fall apart.