Thomas
Diehl

    thd@kde.org

GUI-Übersetzung
Matthias
Schulz

    matthias.schulz@kdemail.net

Deutsche Übersetzung

# Arbeiten mit Syntax-Hervorhebungen

## Überblick

Syntax-Hervorhebungen bewirken, dass der Editor den Text automatisch in verschiedenen Farben und Schriftstilen anzeigt, abhängig von der Funktion der Zeichenkette in Beziehung zum Zweck des Dokumentes. Zum Beispiel können in Quelltext Kontrollbefehle fett dargestellt werden, während Daten und Kommentare andere Farben als der Rest des Textes bekommen. Dies verbessert die Lesbarkeit des Textes erheblich und verhilft damit dem Autor zu mehr Effizienz und Produktivität.

Eine Perl-Funktion, mit Hervorhebungen angezeigt.

Eine Perl-Funktion, mit Hervorhebungen angezeigt.

Die selbe Perl-Funktion, ohne Hervorhebungen.

Die selbe Perl-Funktion, ohne Hervorhebungen.

Welche der beiden ist einfacher zu lesen?

&kate; enthält ein flexibles, konfigurierbares und leistungsfähiges System für Syntax-Hervorhebungen, und die Standarddistribution enthält bereits Definitionen für eine Anzahl von Programmiersprachen, Markup- und Skriptsprachen sowie andere Textformaten. Außerdem können Sie eigene Definitionen in einfachen &XML;-Dateien erstellen.

&kate; erkennt auf Basis des &MIME;-Typs, der Dateiendung oder des Inhalts des Dokumentes automatisch die richtigen Regeln für die Syntax-Hervorhebungen bereits beim Öffnen des Dokuments. Wenn die automatische Auswahl nicht die richtigen Regeln ausgewählt hat, können Sie dies manuell korrigieren (Dokument Hervorhebungsmodus).

Die Schriftstile und Farben, die von jeder Syntax-Hervorhebungsdefinition benutzt werden sollen sowie die &MIME;-Typen, für die diese benutzt werden sollen, können Sie im Dialog Hervorhebungen einrichten des Einrichtungsdialogs bearbeiten.

Syntax-Hervorhebungen sind gedacht, um die Lesbarkeit von Text zu verbessern, aber nicht geeignet, um die Richtigkeit des Quelltextes zu überprüfen. Die Erstellung der Regeln für die Hervorhebungen ist kompliziert, abhängig davon, welches Format Sie benutzen. In manchen Fällen sind die Autoren der Regeln stolz, wenn 98% des Textes korrekt hervorgehoben werden, meistens jedoch sehen Sie die nicht korrekten 2% nur bei seltenen Konstruktionen.

Sie können zusätzliche oder aktualisierte Syntax-Hervorhebungsdefinitionen von der &kate;-Webseite durch Klicken auf Herunterladen im Dialog Hervorhebungen einrichten des Einrichtungsdialogs einrichten bzw. aktualisieren.

## Das &kate; Syntax-Hervorhebungssystem

Dieser Abschnitt behandelt die Mechanismen des &kate; Syntax-Hervorhebungssystems genauer, wenn Sie selbst Definitionen erstellen oder verändern möchten, sollten Sie diesen genau lesen.

### Wie es funktioniert

Immer, wenn Sie ein Dokument öffnen, ist eines der ersten Dinge, die &kate; macht, festzustellen, welche Syntaxdefinition für dieses Dokument benutzt werden soll. Während Sie den Text lesen und neuen Text eingeben, analysiert das Syntax-Hervorhebungssystem den Text anhand der Regeln in der Syntaxdefinition und markiert ihn dementsprechend.

Wenn Sie Text eingeben, wird der neue Text sofort analysiert und markiert.

Die Syntaxdefinitionen, die in &kate; benutzt werden, sind &XML;-Dateien, die Folgendes enthalten

- Regeln für das Erkennen von Text, organisiert in Kontextblöcken

- Schlüsselwortlisten

- Stildefinitionen

Beim Analysieren von Text werden die Erkennungsregeln in der Reihenfolge, in der sie definiert wurden, überprüft und wenn der Anfang des aktuellen Textes mit einer Definition übereinstimmt, wird der zugehörige Kontext benutzt. Der nächste Startpunkt wird nach dem Ende des erkannten Bereichs gesetzt und von dort aus wird eine neue Schleife für die Regeln beginnt, beginnend mit dem Kontext der gerade gefundenen Regel.

### Regeln

Die Erkennungsregeln sind das Herzstück des Syntax-Hervorhebungssystems. Eine Regel besteht aus einer Zeichenkette, einem Zeichen oder einem regulären Ausdruck. Mit diesen wird der zu analysierende Text verglichen. Sie enthalten Informationen, welche Darstellung für das erkannte Stück Text verwendet werden soll und ob entweder zu einem explizit angegebenem Kontext oder zum vorher vom Text benutzten Kontext gewechselt werden soll.

Die Regeln sind in Kontextgruppen organisiert. Eine Kontextgruppe wird für die grundlegenden Textkonzepte innerhalb des Formates benutzt, z.B. für Textteile in Anführungszeichen oder Kommentarblöcke in Programmquelltext. Dadurch wird sichergestellt, dass sich das Syntax-Hervorhebungssystem nicht durch alle Regeln hindurcharbeiten muss, wenn nicht nötig, und dass einige Zeichenketten im Text abhängig vom aktuellen Kontext unterschiedlich behandelt werden können.

### Kontextstile und Schlüsselwörter

In einigen Programmiersprachen werden Integerzahlen durch den Compiler (das Programm, das den Quelltext in ein ausführbares Programm übersetzt) anders behandelt als Gleitkommazahlen und es gibt Zeichen, die eine spezielle Bedeutung innerhalb einer in Anführungszeichen eingeschlossenen Zeichenkette haben. In solchen Fällen ist es sinnvoll, diese unterschiedlich darzustellen, so dass sie beim Lesen einfach von umgebenden Text zu unterscheiden sind. Auch wenn diese keine speziellen Kontexte repräsentieren, können sie durch das Syntax-Hervorhebungssystem erkannt und anders dargestellt werden.

Eine Syntaxdefinition kann so viele verschiedene Stile, wie im benutzten Format notwendig enthalten.

In vielen Formaten gibt es Listen mit Wörtern, die einem speziellen Konzept zugehörig sind. In Programmiersprachen sind z.B. die Kontrollanweisungen ein Konzept, die Datentypen ein anderes und die eingebauten Funktionen ein drittes. Das Syntax-Hervorhebungssystem von &kate; kann benutzt werden, um solche Wörter anhand der Listen zu finden und zur Hervorhebung der Konzepte im Text zu markieren.

### Standardstile

Wenn Sie eine C++ Quelltextdatei, eine &Java;-Quelltextdatei und eine HTML-Datei in &kate; öffnen, sehen Sie dass auch in unterschiedlichen Formaten und damit unterschiedlichen Worten, die spezielle Behandlung bekommen, die benutzten Farben dieselben sind. Der Grund dafür ist, dass &kate; vordefinierte Standardstile benutzt, die von den individuellen Syntaxdefinitionen verwendet werden.

Dadurch wird die Erkennung von ähnlichen Konzepten in verschiedenen Textformaten einfach. Kommentare z.B. gibt es in fast allen Programmiersprachen, Skripten und Markup-Sprachen; diese werden in allen Sprachen gleich dargestellt, so dass Sie sich auf die Arbeit konzentrieren können und nicht über den Zweck einzelner Einträge nachdenken müssen.

Alle Stile in einer Syntaxdefinition nutzen einen der Standardstile. Einige wenige Syntaxdefinitionen nutzen mehr als Stile, Standardstile vorhanden sind, wenn Sie ein Format sehr oft benutzen, kann es die Arbeit wert sein, den Einrichtungsdialog zu starten und nachzusehen, ob mehrere Konzepte die selben Stile benutzen. In der Programmiersprache Perl z.B. gibt es zwei Typen von Zeichenketten, so dass Sie die Hervorhebung durch eine etwas andere Darstellung des zweiten Typs verbessern können.

## Die Hervorhebungsdefinition für das &XML; Format

### Überblick

Dieser Abschnitt ist ein Überblick über die Hervorhebungsdefinition für das &XML; Format.. Es beschreibt die Hauptbestandteile, deren Bedeutung und Nutzung; und im Detail die Erkennungsregeln.

Die formale Definition, auch als DTD bekannt, wird in der Datei `language.dtd` gespeichert, die in Ihrem System im Verzeichnis `$`KDEDIR`/share/apps/kate/syntax` stehen sollte.

#### Hauptbestandteile der &kate;-Hervorhebungsdefinitionen

Der Abschnitt General

  Der Abschnitt General enthält Informationen über Kommentare in der beschriebenen Programmiersprache und legt fest, ob bei Schlüsselwörtern Groß- und Kleinschreibung beachtet wird oder nicht.

Hervorhebung

  Der Abschnitt Hervorhebung enthält alle Daten, die zum Analysieren und Darstellen von Text gebraucht werden. Im Einzelnen sind das:

  ItemDatas

    Enthält ItemData-Elemente, jedes definiert einen Stil.

  Schlüsslewortlisten

    Jede Liste hat einen Namen und kann eine beliebige Anzahl von Elementen enthalten.

  Contexts

    Enthält Kontexts, die die Syntax-Erkennungsregeln enthalten.

## Hervorhebungs-Erkennungsregeln

Dieser Abschnitt beschreibt die Hervorhebungs-Erkennungsregeln

Jede Regel kann auf Null oder mehrere Zeichen am Anfang der untersuchten Zeichenkette zutreffen. Wenn eine Übereinstimmung gefunden wird, wird den erkannten Zeichen der Stil oder die Eigenschaft, die durch die Regel festgelegt wurde, zugeordnet und die Regel kann außerdem ein Umschalten des aktuellen Kontexts festlegen.

Die Eigenschaften attribute und context sind für alle Regeln gemeinsam.

Eine Regel sieht wie folgt aus:

    <RuleName attribute="(identifier)" context="(identifier|order)" [rule specific attributes] />

Die attribute (Eigenschaft) legt den Stil fest, der für die erkannten Zeichen benutzt werden soll und der context (Kontext) legt den Kontext fest, der ab hier benutzt werden soll.

Die attribute (Eigenschaft) kann entweder durch einen Namen oder durch einen nullbasierten Index in der Gruppe ItemDatas identifiziert werden.

Der context (Kontext) kann durch Folgendes identifiziert werden.

- Einen Identifizierer, derzeit nur dessen nullbasierten Index in der Gruppe contexts(Kontexte).

- Eine Anweisung, die vorgibt, im aktuellen Kontext zu bleiben (`#stay`), oder zu einem vorher in der Zeichenkette benutzten Kontext zurückzuspringen (`#pop`).

  Zum Zurückgehen über mehrere Schritte kann das Schlüsselwort #pop wiederholt werden: `#pop#pop#pop`

Regeln können child rules(Unterregeln) haben, deren Einhaltung nur dann untersucht wird, wenn die Einhaltung der Hauptregel erkannt wurde. Der gesamten erkannten Zeichenkette wird die durch die Hauptregel festgelegte attribute (Eigenschaft) zugeordnet. Eine Regel mit Unterregel sieht z.B. so aus:

    <RuleName (attributes)>
      <ChildRuleName (attributes) />
      ...
    </RuleName>

Regelspezifische Eigenschaften sind unterschiedlich und werden im Folgenden beschrieben.

### Die Regeln im Einzelnen:

DetectChar

  Entdeckt ein einzelnes bestimmtes Zeichen. Häufig zum Finden des Endes von Zeichenketten in Anführungszeichen benutzt.

      <DetectChar char="(character)" (common attributes) />

  Die Eigenschaft `char` definiert das zu erkennende Zeichen.

Detect2Chars

  Entdeckt zwei bestimmte Zeichen in einer bestimmten Reihenfolge.

      <Detect2Chars char="(character)" char1="(character)" (common attributes) />

  Die Eigenschaft `char` definiert das erste zu erkennende Zeichen, `char1` das zweite.

AnyChar

  Entdeckt ein Zeichen aus einem bestimmten Satz von Zeichen.

      <AnyChar String="(string)" (common attributes) />

  Die Eigenschaft `String` definiert den Satz der Zeichen.

StringDetect

  Entdeckt eine bestimmte Zeichenkette.

      <StringDetect String="(string)" [insensitive="TRUE|FALSE;"] (common attributes) />

  Die Eigenschaft `String` definiert die zu entdeckende Zeichenkette. Die Eigenschaft `insensitive` ist standardmäßig auf `FALSE` gesetzt und wird an die Zeichenketten-Vergleichsfunktion übergeben. Wenn der Wert auf `TRUE` gesetzt wird, wird Groß- und Kleinschreibung ignoriert.

RegExpr

  Prüft die Übereinstimmung mit einem regulären Ausdruck.

      <RegExpr String="(string)" [insensitive="TRUE|FALSE;"] [minimal="TRUE|FALSE"] (common attributes) />

  Die Eigenschaft `String` definiert den regulären Ausdruck.

  Die Eigenschaft `insensitive` ist standardmäßig auf `FALSE` gesetzt und wird an die Funktion zur Auswertung des regulären Ausdrucks übergeben.

  Die Eigenschaft `minimal` ist standardmäßig auf `FALSE` gesetzt und wird an die Funktion zur Auswertung des regulären Ausdrucks übergeben.

  Weil die Regeleinhaltung am Anfang der aktuellen Zeichenkette immer als erfüllt erkannt wird, kann mit dem Hochzeichen (`^`) angegeben werden, dass die Regeleinhaltung nur am Anfang der Zeile untersucht werden soll.

  Sehen Sie unter Reguläre Ausdrücke für weitere Informationen zu diesen nach.

Keyword

  Erkennt ein Schlüsselwort aus einer angegebenen Liste.

      <keyword String="(list name)" (common attributes) />

  Die Eigenschaft `String` definiert die Schlüsselwortliste durch deren Name. Eine Liste mit diesem Namen muss vorhanden sein.

Int

  Erkennt eine ganze Zahl(integer).

      <Int (common attributes) />

  Diese Regel hat keine Eigenschaften. Häufig werden Unterregeln dazu benutzt, Kombinationen mit `L` oder `U` nach der Zahl zu entdecken, die den Typ der ganzen Zahl(integer) anzeigen.

Float

  Entdeckt eine Gleitkommazahl.

      <Float (common attributes)
      />

  Diese Regel hat keine Eigenschaften.

HlCOct

  Entdeckt eine oktale Zahl.

      <HlCOct (common attributes) />

  Diese Regel hat keine Eigenschaften.

HlCHex

  Entdeckt eine Hexazahl.

      <Int (common attributes) />

  Diese Regel hat keine Eigenschaften.

HlCStringChar

  Entdeckt ein Steuerzeichen.

      <HlCStringChar (common attributes)
      />

  Diese Regel hat keine Eigenschaften.

  Solche Zeichen sind durch druckbare Zeichen dargestellte nichtdruckbare Zeichen, die in Programmquelltexten häufig benutzt werden. z.B.: `\n` (Zeilenvorschub) oder `\t` (TAB)

  Die folgenden Zeichen werden erkannt, wenn sie einem `\` folgen: `abefnrtv"'?`. Zusätzlich werden auch hexadezimale (`\xff`) oder oktale (`\033`) Zahlen nach einem `\` erkannt.

RangeDetect

  Entdeckt eine Zeichenkette mit definierten Anfangs- und Endzeichen.

      <RangeDetect char="(character)"  char1="(character)" (common attributes) />

  `char` definiert das Zeichen am Anfang des Bereichs, `char2` das Zeichen am Ende des Bereichs.

  Diese Regel ist für das Entdecken von kleinen Zeichenketten in Anführungszeichen nützlich, kann aber wegen der verwendeten Funktion keine über mehrere Zeilen gehenden Zeichenketten entdecken.

LineContinue

  Entdeckt das Zeilenende.

      <LineContinue (common attributes) />

  Diese Regel hat keine Eigenschaften.

  Diese Regel ist für das Umschalten des Kontextes am Zeilenende nützlich.