© iStockphoto.com/pictafolio
Das Eclipse-Text-Framework

Editoren mit JavaFX und Eclipse Text


Ohne es zu wissen, verwendet jede Leserin und jeder Leser dieses Magazins bereits „­Eclipse Text“. Egal ob Java-, XML- oder Xtext-DSL-Editor: Alle Editoren in Eclipse bauen auf dem Eclipse-Text-Framework auf. In dieser Artikelserie wollen wir Eclipse Text auf den Grund gehen und die Editorerzeugung mit verschiedenen UI-Technologien beschreiben. Im ersten Teil werfen wir einen Blick auf jenen Teil des Frameworks, der sich mit dem Zerlegen des Texts (Partitioning) und der Umwandlung in visuelle Einzelteile (Tokenizing) beschäftigt.

Wir beginnen mit der Abstraktion des Textinhalts. Ganz allgemein werden Text- bzw. Zeichenketten in Java durch die Klasse java.lang.String repräsentiert. Nun ist ein String bekanntlich unveränderbar (immutable). Da wir bei der Erstellung eines Editors aber zusätzliche Metadaten speichern müssen sowie Informationen, beispielsweise über die Anzahl der Zeilen, benötigen, definiert das Eclipse-Text-Framework ein API vom Typ org.eclipse.jface.text.IDocument. Zudem wird eine Standardimplementierung org.eclipse.jface.text.Document zur Verfügung gestellt, die für die meisten möglichen Einsatzzwecke ausreicht. Die Erzeugung eines IDocument ist denkbar einfach über den Konstruktor Document(String initialContent) realisierbar. Verändert werden kann der Inhalt des Dokuments mit den Methoden:

  • set(String text), um den gesamten Inhalt auszutauschen

  • replace(int offset, int length, String text), um Text hinzuzufügen oder zu entfernen

Der aktuelle Inhalt kann über get() bzw. als Teilbereich über get(int offset, int length) abgefragt werden. Um über Änderungen des Inhalts informiert zu werden, können die Methoden add/removeDocumentListener(­IDocumentListener listener) verwendet werden, wobei Listing 1 die Basisoperationen zeigt, die auf einem Dokument ausgeführt werden können.

Listing 1

// create
Document d = new Document("World!");
// insert "Hello "
d.replace(0, 0, "Hello ");
// remove " World"
d.replace("Hello ".length()-1, " World".length(), "");
// retrieve
System.out.println(d.get());

Bevor wir uns der Partitionierung zuwenden, sollte erwähnt werden, dass sich zwar viele der verwendeten APIs im Namensraum org.eclipse.jface.text befinden, in diesem Fall aber keinerlei Abhängigkeit zu SWT/JFace besteht. Das Eclipse-Text-Framework besteht aus zwei Modulen:

  • org.eclipse.text: Enthält nur Code, der keine Abhängigkeit zu SWT/JFace aufweist und auch außerhalb eines OSGi-Containers wie Equinox lauffähig ist.

  • org.eclipse.jface.text: Enthält Code, der Abhängigkeiten zu SWT/JFace aufweist und ebenso außerhalb eines OSGi-Containers wie Equinox lauffähig ist.

Partitioning – der Hintergrund

Um Sourcecode-Dateien performant zerlegen zu können und bei Änderungen nicht das gesamte Dokument neu überprüfen zu müssen, unterteilt das Text-Framework diese Aufgabe in mehrere Schritte. Der erste Schritt, das „Partitioning“, teilt einen Text in mehr oder weniger große Regionen auf. Java-Quellcode (Abb. 1) könnte zum Beispiel in folgende Partitionen unterteilt werden (Abb. 2):

  • Javadoc

  • Inline Doc (einzeilig)

  • Inline Doc (mehrzeilig)

  • String/Character

  • „Rest“

Diese Bestandteile können durch recht einfache Regeln beschrieben werden:

  • Javadoc beginnt mit einem /** und endet mit einem */

  • einzeiliges Inline Doc beginnt mit einem // und geht bis zum Ende der Zeile

  • mehrzeiliges Inline Doc beginnt mit einem /* und endet mit einem */

  • eine Zeichenkette (String) beginnt mit einem " und endet mit einem "

  • einzelne Zeichen (Character) beginnen mit einem ' und enden mit einem '

schindl_1.tif_fmt1.jpgAbb. 1: Java-Sourcecode
schindl_2.tif_fmt1.jpgAbb. 2: Partitionierter Sourcecode

Der Code

Die oben aufgestellten Regeln für Java-Code lassen sich in zwei Kategorien einteilen:

  • Regeln, die spätestens mit dem Ende der Zeile enden (einzeilige Regeln) und damit nicht notwendigerweise eine Endzeichenreihenfolge benötigen (einzeilige In­line Doc und String/Character).

  • Regeln, die sich über mehrere Zeilen erstecken können und damit zwingend eine Endzeichenreihenfolge benötigen (Javadoc und mehrzeilige...

headline from sands settings