<synopsis>Dieser Anhang enhält eine kurze, aber hoffentlich ausreichende Einführung in die Welt der <emphasis>regulären Ausdrücke</emphasis>. Es werden reguläre Ausdrücke in der Form dokumentiert, in der sie in &kate; anwendbar sind, die aber nicht kompatibel &zb; zu der in Perl oder in <command>grep</command> verwendeten Form ist.</synopsis>
<para><emphasis>Reguläre Ausdrücke</emphasis> stellen eine Möglichkeit zur Verfügung, vielleicht zu suchende Teile von Text in einer Form zu beschreiben, die von einer kleinen Software verstanden wird, so dass diese feststellen kann, ob die Beschreibung zutrifft und sogar Text zur späteren Verwendung speichern kann.</para>
<para>Ein Beispiel: Nehmen Sie an, Sie wollen eine Text nach Abschnitten durchsuchen, die mit einem der Namen <quote>Henrik</quote> oder <quote>Pernille</quote> beginnen, gefolgt von einer Form des Verbs <quote>say</quote>.</para>
<para>Mit einer normalen Suche würden Sie anfangen, nach dem ersten Namen <quote>Henrik</quote> zu suchen, vielleicht gefolgt von <quote>sa</quote>, also <userinput>Henrik sa</userinput>. Bei dieser Suche würden Sie alle Treffer überspringen müssen, die nicht am Anfang eines Abschnittes stehen und die, hinter denen ein <quote>sa</quote> steht, aber kein <quote>says</quote>, <quote>said</quote> und so weiter. Dann natürlich das Ganze von vorn für den nächsten Namen ...</para>
<para>Mit regulären Ausdrücken können Sie dies mit einer einzelnen Suche erreichen und das noch genauer.</para>
<para>Um dies zu erreichen, definieren reguläre Ausdrücke Regeln zum Ausdrücken von Details einer zu suchenden Zeichenkette. Unser Beispiel, das wir wie folgt ausdrücken können: <quote>Eine Zeile mit <quote>Henrik</quote> oder <quote>Pernille</quote> beginnend (eventuell nach bis zu 4 Leerzeichen oder Tabulatoren) gefolgt von einem Leerzeichen gefolgt von <quote>sa</quote> und dann entweder <quote>ys</quote> oder <quote>id</quote></quote> kann so als regulärer Ausdruck geschrieben werden:</para> <para><userinput>^[ \t]{0,4}(Henrik|Pernille) sa(ys|id)</userinput></para>
<para>Das oben angegebene Beispiel zeigt alle vier Hauptkonzepte von regulären Ausdrücke, speziell: </para>
<para>Das Hochzeichen (<literal>^</literal>) am Anfang des Ausdruckes kennzeichnet eine Behauptung, die nur dann wahr ist, wenn sich der folgende Text am Anfang einer Zeile befindet.</para>
<para>Die Zeichenketten <literal>[ \t]</literal> und <literal>(Henrik|Pernille) sa(ys|id)</literal> sind Muster. Das erste ist ein <emphasis>Zeichen</emphasis> das entweder auf ein Leerzeichen oder ein Tabulatorzeichen zutrifft, das andere enthält als erstes ein Untermuster, das entweder auf <literal>Henrik</literal> <emphasis>oder</emphasis> <literal>Pernille</literal> zutrifft, dann ein Muster, das exakt auf <literal> sa</literal> zutrifft und zum Schluss wieder ein Untermuster, das auf <literal>ys</literal>, <emphasis>oder</emphasis> <literal>id</literal> zutrifft.</para>
<para>Die Angabe <literal>{0,4}</literal> ist ein Quantifizierer, der sagt: <quote>von 0 bis 4 mal das vorher spezifizierte</quote>.</para>
<para>Weil Software für reguläre Ausdrücke, die das Konzept von <emphasis>Referenzen</emphasis> den gesamten zutreffenden Teil des Textes wie auch in Klammern eingeschlossene Untermuster sichert, können Sie diese gefundenen Textstellen (diese sind nach dem Suchen mit einem regulären Ausdruck in einem Textdokument in einem Editor meistens ausgewählt) oder den gefundenen Namen oder den letzten Teil des Verbs weiterverwenden, die <emphasis>Referenzen</emphasis> ermöglichen den Zugriff auf diese.</para>
<para>Zusammengefasst: die regulären Ausdrücke treffen zu, wo wir wollten, und nur dort.</para>
<para>Die folgenden Abschnitte beschreiben im einzelnen, wie Muster, Zeichenklassen, Behauptungen, Quantifizierer und Backreferenzen benutzt werden und der letzte Abschnitt gibt einige nützliche Beispiele.</para>
<para>In Mustern und in Zeichenklassen haben einige Zeichen spezielle Bedeutungen. Um diese Steuerzeichen zu finden, müssen sie als solche markiert werden.</para>
<para>Die Software ignoriert die Kennzeichnung als Steuerzeichen von Zeichen, die in dem betrachteten Zusammenhang keine Steuerzeichen sind. So ist &zb; die Angabe von (<userinput>\j</userinput>), also ein <quote>j</quote> als Steuerzeichen markiert, kein Problem. Wenn Sie Zweifel haben, ob ein Zeichen eine spezielle Bedeutung hat, können Sie dies ohne Bedenken als Steuerzeichen markieren.</para>
<para>Eine <emphasis>Zeichenklasse</emphasis> ist ein Ausdruck, der auf einen bestimmten Satz von Zeichen zutrifft. Zeichenklassen werden in regulären Ausdrücken durch Setzen der zugelassenen Zeichen in eckige Klammern <literal>[]</literal> oder durch Nutzen einer der im Folgenden beschriebenen abgekürzten Klassen definiert.</para>
<para>Einfache Zeichenklassen enthalten nur ein oder mehrere Zeichen, &zb; <userinput>[abc]</userinput> (zutreffend auf einen der Buchstaben <quote>a</quote>, <quote>b</quote> oder <quote>c</quote>) oder <userinput>[0123456789]</userinput> (zutreffend auf eine Zahl).</para>
<para>Da Buchstaben und Zahlen eine festgelegte Reihenfolge haben, können diese durch Angabe des Bereiches :abgekürzt werden: <userinput>[a-c]</userinput> entspricht <userinput>[abc]</userinput> und <userinput>[0-9]</userinput> entspricht <userinput>[0123456789]</userinput>. Diese Angaben können auch kombiniert werden, &zb; trifft <userinput>[a-fynot1-38]</userinput> auf die folgenden Zeichen zu: <quote>a</quote>,<quote>b</quote>,<quote>c</quote>,<quote>d</quote>, <quote>e</quote>,<quote>f</quote>,<quote>y</quote>,<quote>n</quote>,<quote>o</quote>,<quote>t</quote>, <quote>1</quote>,<quote>2</quote>,<quote>3</quote> oder <quote>8</quote>.</para>
<para>Da Großbuchstaben von Kleinbuchstaben unterschieden werden, müssen Sie zur Angabe von <quote>a</quote> oder <quote>b</quote> ohne Unterscheidung von Groß- und Kleinschreibung <userinput>[aAbB]</userinput> angeben.</para>
<para>Die Erzeugung von <quote>negativen</quote> Klassen, die auf <quote>alles außer</quote> zutreffen, erfolgt durch das Hoch-Zeichen (<literal>^</literal>) am Anfang der Klassendefinition: </para>
<para><userinput>[^abc]</userinput> trifft auf alle Zeichen <emphasis>außer</emphasis> <quote>a</quote>, <quote>b</quote> oder <quote>c</quote> zu.</para>
<para>Zusätzlich zu den druckbaren Zeichen sind noch einige Abkürzungen definiert, um die Verwendung ein wenig einfacher zu machen: <variablelist>
<listitem><para>Dieser Ausdruck trifft auf das Unicodezeichen mit dem Code mit der Hexadezimalzahl hhhh (zwischen 0x0000 und 0xFFFF) zu. \0ooo (&zb;, \zero ooo) trifft auf das <acronym>ASCII</acronym>-/Latin-1-Zeichen mit dem Code mit der Oktalzahl ooo (zwischen 0 und 0377) zu.</para></listitem>
<listitem><para>Trifft auf ein Zeichen, das keine Ziffer ist, zu. Entspricht <literal>[^0-9]</literal> oder <literal>[^\d]</literal>.</para></listitem>
<listitem><para>Trifft auf ein Zeichen, das keinen Zwischenraum angibt, zu. Praktisch entspricht dies <literal>[^ \t\n\r]</literal> oder <literal>[^\s]</literal>.</para></listitem>
<listitem><para>Trifft auf ein <quote>druckbares Zeichen</quote> zu - in diesem Fall Buchstabe oder Ziffer. Entspricht <literal>[a-zA-Z0-9]</literal>. Das Zeichen Unterstrich (<literal>_</literal>) trifft nicht zu. </para></listitem>
<listitem><para>Trifft auf alle Zeichen außer Buchstaben und Ziffern zu. Entspricht <literal>[^a-zA-Z0-9]</literal> oder <literal>[^\w]</literal></para></listitem>
<para>Die abgekürzten Klassen können in selbstdefinierte Klassen eingefügt werden, &zb; kann für die Klasse <quote>druckbares Zeichen, Leerzeichen oder Punkt</quote> der Ausdruck <userinput>[\w \.]</userinput> verwendet werden.</para>
<note> <para>Die Angabe von Klassen nach POSIX-Notierung, <userinput>[:<class name>:]</userinput>, wird gegenwärtig nicht unterstützt.</para> </note>
<para>Die folgenden Zeichen haben spezielle Bedeutungen innerhalb des Ausdrucks in eckigen Klammern <quote>[]</quote>, diese müssen als Steuerzeichen gekennzeichnet werden, damit sie als Zeichen in die Klasse einbezogen werden:</para>
<listitem><para>Beendet die Definition der Zeichenklasse. Dieses Zeichen braucht nicht als Steuerzeichen gekennzeichnet werden, wenn es das erste Zeichen in einer Zeichenklassendefinition (nach dem Zeichen <quote>[</quote> oder <quote>^</quote>) ist.</para></listitem>
<listitem><para>Bezeichnet eine negative Klasse, wenn es das erste Zeichen in einer Zeichenklassendefinition ist. Wenn es als druckbares Zeichen behandelt werden soll, muss es als Steuerzeichen gekennzeichnet werden, wenn es das erste Zeichen in einer Zeichenklassendefinition ist. </para></listitem>
<listitem><para>Kennzeichnet einen logischen Bereich. Wenn es als Zeichen behandelt werden soll, muss es als Steuerzeichen gekennzeichnet werden.</para></listitem>
<listitem><para>Das Zeichen zum Kennzeichnen eines Steuerzeichens. Dieses Zeichen muss immer als Steuerzeichen gekennzeichnet werden, wenn es als druckbares Zeichen behandelt werden soll.</para></listitem>
<title>Alternativen: trifft zu wenn <quote>eins von</quote></title>
<para>Wenn ein erkanntes Muster von mehreren Mustern als zutreffend erkannt werden soll, dann müssen Sie diese Muster durch einen senkrechten Strich <literal>|</literal> getrennt angeben.</para>
<para>Der Ausdruck <userinput>John|Harry</userinput> wird &zb; als zutreffend erkannt, wenn entweder <quote>John</quote> oder <quote>Harry</quote> gefunden wird.</para>
<para>Sie können Untermuster verwenden, um Gruppen von Alternativen in einem Muster anzugeben. Die Alternativen werden durch den senkrechten Strich <literal>|</literal> getrennt.</para>
<para>Um eines der Worte <quote>int</quote>, <quote>float</quote> oder <quote>double</quote> zu erkennen, geben Sie <userinput>int|float|double</userinput> an. Wenn eines der Worte nur dann erkannt werden soll, wenn nach dem Wort Zwischenraum und dann Buchstaben folgen, dann verwenden Sie den folgenden Ausdruck mit den Worten im Untermuster: <userinput>(int|float|double)\s+\w+</userinput>.</para>
<title>Speichern von gefundenem Text (Referenzen)</title>
<para>Wenn Sie eine Referenz verwenden wollen, dann benutzen Sie ein Untermuster zum Speichern des gewünschten Teils des Musters.</para>
<para>Wenn Sie &zb; das zweifache Auftreten des selben Wortes getrennt durch ein Komma und eventuell Zwischenraum finden wollen, dann würden Sie <userinput>(\w+),\s*\1</userinput> verwenden. Das Untermuster <literal>\w+</literal> findet ein Stück aus druckbaren Zeichen. Der gesamte Ausdruck trifft zu, wenn diese von einem Komma und keinem oder mehreren Zwischenraumzeichen und dann von einem gleichen Stück von Zeichen gefolgt werden. (Der Ausdruck <literal>\1</literal> verweist auf das <emphasis>erste in Klammern angegebene Untermuster</emphasis>.)</para>
<!-- <para>See also <link linkend="backreferences">Back references</link>.</para> -->
<para>Eine vorwärtsgerichtete Behauptung ist ein Untermuster, das mit <literal>?=</literal> oder <literal>?!</literal> anfängt.</para>
<para>Der Ausdruck <userinput>Bill(?! Gates)</userinput> besagt, dass <quote>Bill</quote> gefunden wird, aber nur wenn nicht von <quote> Gates</quote> gefolgt. Dies findet <quote>Bill Clinton</quote> oder <quote>Billy the kid</quote>, aber ignoriert stillschweigend den anderen Treffer.</para>
<para>Untermuster, die für Behauptungen benutzt werden, werden nicht gespeichert.</para>
<para>Sehen Sie auch unter <link linkend="assertions">Behauptungen</link> nach.</para>
<para>Die folgenden Zeichen haben spezielle Bedeutungen innerhalb eines Musters, diese müssen als Steuerzeichen gekennzeichnet werden, damit sie als Zeichen behandelt werden: <variablelist>
<para><emphasis>Quantifizierer</emphasis> gestatten dem regulären Ausdruck die Angabe einer Anzahl von entweder Zeichen, Zeichenklasen oder Untermustern.</para>
<para><emphasis>Quantifizierer</emphasis> werden in geschweifte Klammern (<literal>{</literal> und <literal>}</literal>) eingeschlossen und haben die Form <literal>{[minimale Anzahl][,[maximale Anzahl]]}</literal> </para>
<para>Die Benutzung ist am besten an Beispielen erklärt: <variablelist>
<para>Wenn Quantifizierer ohne Maximum verwendet werden, dann findet der reguläre Ausdruck so viel wie möglich vom Suchtext, dieses Verhalten wird auch als <emphasis>gierig</emphasis> bezeichnet.</para>
<para>Moderne Software für reguläre Ausdrücke stellt die Möglichkeit bereit, das <quote>gierige Verhalten auszuschalten</quote>, aber in einer grafischen Umgebung ist es das Interface, das Ihnen Zugriff auf diese Möglichkeit bereitstellen muss. Ein Dialogfenster zum Suchen kann &zb; eine Option mit dem Namen <quote>Minimales Finden</quote> bereitstellen, es sollte auch anzeigen, ob <quote>gieriges Verhalten</quote> Standard ist.</para>
<listitem><para>Trifft auf die Zahlen in <quote>1234 go</quote> und <quote>12345 now</quote> zu, aber nicht die in für <quote>567 eleven</quote> oder <quote>223459 somewhere</quote></para></listitem>
<listitem><para>Trifft zu für alle in <quote>blablabla</quote> und das <quote>bla</quote> in <quote>blackbird</quote> oder <quote>tabla</quote>.</para></listitem>
<listitem><para>Trifft für das <quote>/></quote> in <quote><closeditem/></quote> sowie auch für das <quote>></quote> in <quote><openitem></quote> zu.</para></listitem>
<para><emphasis>Behauptungen</emphasis> erweitern den regulären Ausdruck so, dass er nur unter bestimmten Bedingungen zutrifft.</para>
<para>Eine Behauptung braucht kein Zeichen um zuzutreffen, diese ermittelt vielmehr die Umgebung eines eventuellen Treffers bevor dieser bestätigt wird. Die Behauptung <emphasis>Wortgrenze</emphasis> &zb; versucht nicht, ein nichtdruckbares Zeichen neben einem druckbaren Zeichen zu finden, sondern stellt fest, dass dort KEIN druckbares Zeichen ist. Das heisst, dass dieses &zb; auch am Ende einer Zeichenkette zutrifft.</para>
<para>Einige Behauptungen haben ein Muster das gefunden werden muss, aber der zutreffende Teil des Suchtextes dieses Musters wird nicht Teil des Ergebnisses des gesamten regulären Ausdrucks.</para>
<para>Reguläre Ausdrücke wie hier beschrieben unterstützen die folgenden Behauptungen: <variablelist>
<varlistentry>
<term><userinput>^</userinput> (Hochzeichen: Anfang der Zeichenkette)</term>
<listitem><para>Trifft auf den Anfang des zu suchenden Textes zu.</para> <para>Der Ausdruck <userinput>^Peter</userinput> trifft auf <quote>Peter</quote> im Text <quote>Peter, hey!</quote> zu, aber nicht auf <quote>Hey, Peter!</quote>. </para> </listitem>
<term><userinput>$</userinput> (Ende der Zeichenkette)</term>
<listitem><para>Trifft auf das Ende des Suchtextes zu.</para>
<para>Der Ausdruck <userinput>you\?$</userinput> trifft auf das letzte <quote>you</quote> in <quote>You didn't do that, did you?</quote> zu, aber nirgendwo in <quote>You didn't do that, right?</quote>.</para>
<listitem><para>Trifft zu, wenn ein druckbares Zeichen auf der einen Seite aber keines auf der anderen Seite ist.</para>
<para>Dieser Ausdruck dient zum Finden von Wortenden, wenn nach beiden Enden gesucht wird, zum Finden des ganzen (einzelnstehenden) Wortes. Der Ausdruck <userinput>\bin\b</userinput> trifft auf das einzelnstehende <quote>in</quote> in <quote>He came in through the window</quote> zu, aber nicht auf das <quote>in</quote> in <quote>window</quote>.</para></listitem>
<listitem><para>Trifft immer dort zu, wo <quote>\b</quote> nicht zutrifft.</para>
<para>Dieser Ausdruck dient zum Finden von Text innerhalb von Worten. Der Ausdruck <userinput>\bin\B</userinput> trifft &zb; auf das <quote>in</quote> im Wort <quote>window</quote> im Text <quote>He came in through the window</quote> zu, aber nicht auf das einzelnstehende <quote>in</quote>.</para>
<listitem><para>Eine Vorwärtsreferenz prüft den Text, der dem eventuell zutreffenden Teil des Textes folgt. Die Vorwärtsreferenz verhindert, dass der Text zutrifft, wenn der nachfolgende Text nicht auf das <emphasis>MUSTER</emphasis> der Behauptung zutrifft. Wenn die Behauptung zutrifft, wird der Text, der auf diese zutrifft, allerdings nicht Bestandteil des Ergebnisses.</para>
<para>Der Ausdruck <userinput>handy(?=\w)</userinput> trifft auf <quote>handy</quote> in <quote>handyman</quote> zu, aber nicht auf das in <quote>That came in handy!</quote></para>
<listitem><para>Eine negative Vorwärtsreferenz verhindert, dass der Text zutrifft, wenn der nachfolgende Text auf das <emphasis>MUSTER</emphasis> zutrifft.</para>
<para>Der Ausdruck <userinput>const \w+\b(?!\s*&)</userinput> trifft auf <quote>const char</quote> im Text <quote>const char* foo</quote>, aber nicht <quote>const QString</quote> in <quote>const QString& bar</quote> weil das <quote>&</quote> auf die negative Vorwärtsreferenz zutrifft.</para>
