Prty::Section::Parser - Parser für Abschnitte
Prty::Hash
Ein Objekt der Klasse repräsentiert einen Parser für "Abschnitte".
Ein Abschnitt hat den Aufbau:
# [IDENTIFIER] KEY: VALUE ... CONTENT
Abschnittsbezeichner.
Schlüssel. Ein Abschnitt kann beliebig viele Schlüssel/Wert-Paare definieren.
Wert. Ist mit einer bestimmten Tiefe an Whitespace eingerückt. Kann mehrzeilig sein.
Inhalt. Ist typischerweise mehrzeilig. Es kann höchstens einen Inhalt je Abschnitt geben.
Dekodiere Input gemäß Zeichensatz.
Muster für die erste Zeile eines Abschnitts.
Muster für eine Schlüssel-Zeile.
Speichere den geparsten Quelltext nicht im Abschnittsobjekt. Dies spart Speicherplatz, wenn der Quelltext nicht gebraucht wird.
Startzeile für den Inhalt.
Anzahl der geparsten Abschnitte. Das Attribut kann nur abgefragt werden.
Anzahl der geparsten Zeilen. Das Attribut kann nur abgefragt werden.
Anzahl der geparsten Zeichen. Das Attribut kann nur abgefragt werden.
$par = $class->new(@keyVal);
Referenz auf Parser-Objekt
Instantiiere ein Parser-Objekt mit den Parser-Attributen @keyVal. In abgeleiteten Klassen kann der Konstruktor überschrieben und eine andere Attribut-Initialisierung vorgenommen werden.
$objA|@objs = $par->parse; $objA|@objs = $par->parse($file); $objA|@objs = $par->parse(\$text);
Name der Eingabedatei. Fehlt der Parameter oder ist er undef oder ein Leerstring oder '-', wird die Eingabe von STDIN gelesen.
undef
Lies die Eingabe vom String ("In-Memory-File") $text.
Liste der Abschnittsobjekte (Array-Kontext) oder Referenz auf die Liste (Skalar-Kontext).
Parse die Eingabe und liefere die Liste der Abschnittsobjekte zurück. Die Eingabe besteht aus einer Folge von 0 bis n Syntax. Die Methode kann wiederholt mit verschiedenen Eingaben aufgerufen werden.
$obj = $par->section($identifier,$keyValH,$keyA,$content,$source,$file,$lineNumber);
Abschnitts-Bezeichner einschließlich Klammern.
Referenz auf Schlüssel/Wert-Hash.
Referenz auf Schlüssel-Array.
Der Inhalt.
Der Quelltext des Abschnitts.
Der Name der Datei, die den Abschnitt enthält. Im Falle einer In-Memory-Datei "(source)".
(source)
Die Zeilennummer, an der der Abschnitt in der Datei beginnt.
Nichts oder Abschnitts-Objekt
Die Methode wird vom Parser für jeden vollständig geparsten Abschnitt gerufen.
Die Methode instantiiert per Default ein Objekt der Klasse Prty::Section::Object und liefert eine Referenz auf dieses Objekt zurück. Das Objekt wird zur Liste der Abschnittsobjekte hinzugefügt. Die Liste der Abschnittsobjekte wird von der Methode parse() zurückgeliefert. In abgeleiteten Klassen kann die Methode überschrieben und ein anderes Verhalten implementiert werden.
Prty::Section::Object
$par->error($@,$source,$file,$lineNumber);
Die Exception.
Der Quelltext des Abschnitts bis zur Exception.
Der Name der Datei, die den Abschnitt enthält. "(source)" im Falle einer In-Memory-Datei.
Die Zeilennummer, bei der die Exception ausgelöst wurde.
Die Methode kehrt nicht zurück
Die Methode wird vom Parser im Fehlerfall gerufen.
Die Methode empfängt die betreffende Exception und erzeugt eine neue Exception, die um Angaben zur Fehlerstelle angereichert ist. In abgeleiteten Klassen kann die Methode überschrieben und ein anderes Verhalten implementiert werden.
Anstelle der eckigen Klammern [] kann der Abschnittsbezeichner IDENTIFIER per Default auch in spitze <>, runde () oder geschweifte Klammern {} eingefasst sein. Das Muster kann durch Überschreiben des Parser-Attributs sectionRegex=>$regex geändert werden.
[]
<>
()
sectionRegex=>
Die Einrücktiefe der VALUE-Zeilen ermittelt der Parser anhand der ersten Zeile des ersten Schlüssel/Wert-Paars der Datei. Alle weiteren Werte in der Datei müssen in der gleichen Tiefe eingerückt sein.
KEY-Zeilen können auskommentiert werden, indem zwei Ausrufungszeichen !! gefolgt von mindestens einem Leerzeichen an den Anfang der Zeile gesetzt werden. Einschränkung: Die erste KEY-Zeile kann nicht auskommentiert werden, da sie den betreffenden KEY/VALUE-Abschnitt einleitet. Beispiel (dargestellt mit Pipe- statt Ausrufungszeichen):
Name: width || BriefDescription: || Liefere die Breite und Höhe des Bildes
Ergebnis:
Name: width
VALUE-Zeilen können ganz oder teilweise auskommentiert werden. Eine ganze VALUE-Zeile wird wie eine KEY-Zeile auskommentiert (s.o.). Ein Teil wird auskommentiert, indem mindestens ein Leerzeichen gefolgt von zwei Ausrufungszeichen gefolgt von einem Leerzeichen in eine VALUE-Zeile eingefügt wird. Ab dem ersten Leerzeichen werden bis zum Ende der Zeile alle Zeichen ignoriert. Beispiel (mit Pipe- statt Ausrufungszeichen):
Import: || Old::Hash New::Hash || neue Hash-Klasse
Import: New::Hash
Beginnt CONTENT mit einer Zeile, die wie eine KEY:-Zeile aussieht, oder sind Leerzeilen am Anfang von CONTENT signifikant, muss der Anfang von CONTENT mit einer Start-Zeichenkette gekennzeichnet werden. Die Start-Zeichenkette ist --BEGIN-- oder # --- mit drei oder mehr Bindestrichen bis zum Ende der Zeile. Folgt auf eine # ----Zeile eine Leerzeile, wird diese übergangen, also nicht zum Inhalt hinzugezählt. Dies ist bei --BEGIN-- nicht der Fall.
--BEGIN--
# ---
Enthält CONTENT eine Zeile, die wie der Anfang eines Abschnitts aussieht (welcher CONTENT per Default beendet) oder sind Leerzeilen am Ende von CONTENT signifikant, muss dessen Ende mit einer Stop-Zeichenkette gekennzeichnet werden. Sie Stop-Zeichenkette wird durch Schlüssel/Wert-Paar Stop: definiert:
Stop:
Stop: --END--
Stop: ist eine Parser-Direktive, die nur für den Abschnitt gilt, in dem sie definiert ist. Die Stop-Zeichenkette beendet CONTENT und zählt nicht zum CONTENT hinzu.
1.092
Frank Seitz, http://fseitz.de/
Copyright (C) 2016 Frank Seitz
This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Prty, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Prty
CPAN shell
perl -MCPAN -e shell install Prty
For more information on module installation, please visit the detailed CPAN module installation guide.