Frank Seitz
and 1 contributors

NAME

Prty::String - Operationen auf Zeichenketten

BASE CLASS

Prty::Object

METHODS

Encoding

autoDecode() - Auto-dekodiere Zeichenkette

Synopsis

    $str = $class->autoDecode($str);

Description

Analysiere Zeichenkette $str hinsichtlich ihres Character-Encodings und dekodiere sie entsprechend. Unterschieden werden:

    ASCII
    UTF-8
    UTF-16/32 mit BOM
    ISO-8859-1

Weitere Encodings werden nicht erkannt und als ISO-8859-1 angesehen.

Einrückung

determineIndentation() - Einrücktiefe eines Textes

Synopsis

    $n = $class->determineIndentation($str);

Description

Ermittele die Einrücktiefe des Textes $str und liefere diese zurück. Die Einrücktiefe ist der größte gemeinsame Teiler aller Zeilen-Einrückungen. Beispiel:

|Dies | ist | ein | Test

Einrücktiefe ist 4.

WICHTIG: Für die Einrückung zählen nur Leerzeichen, keine Tabs!

reduceIndentation() - Reduziere Einrücktiefe eines Textes

Synopsis

    $str = $class->reduceIndentation($n,$str);
    $class->reduceIndentation($n,\$str);

Description

Reduziere die Einrücktiefe des Textes $str auf Tiefe $n.

Example

Text:

    |Dies
    |    ist
    |        ein
    |            Test

Reduktion auf Einrücktiefe 2:

    Prty::String->reduceIndentation(2,$str);

Resultat:

    |Dies
    |  ist
    |    ein
    |      Test

removeIndentation() - Entferne Text-Einrückung

Synopsis

    $str = $class->removeIndentation($str,@opt); # [1]
    $class->removeIndentation(\$str,@opt);       # [2]

Options

-addNL => $bool (Default: 0)

Nach dem Entfernen aller NEWLINEs am Ende füge ein NEWLINE hinzu.

Description

[1] Entferne Text-Einrückung aus Zeichenkette $str und liefere das Resultat zurück.

[2] Wird eine Referenz auf $str übergeben, wird die Zeichenkette "in place" manipuliert und nichts zurückgegeben.

  • NEWLINEs am Anfang werden entfernt.

  • Whitespace (SPACEs, TABs, NEWLINEs) am Ende wird entfernt. Das Resultat endet also grundsätzlich nicht mit einem NEWLINE.

  • Die Methode kehrt zurück, wenn $str anschließend nicht mit wenigstens einem Whitespace-Zeichen beginnt, denn dann existiert keine Einrückung, die zu entfernen wäre.

  • Die Einrückung von $str ist die längste Folge von SPACEs und TABs, die allen Zeilen von $str gemeinsam ist, ausgenommen Leerzeilen. Diese Einrückung wird am Anfang aller Zeilen von $str entfernt.

  • Eine Leerzeile ist eine Zeile, die nur aus Whitespace besteht.

Example

  • Einrückung entfernen, Leerzeile übergehen:

        |
        |  Dies ist
        |              <- Leerzeile ohne Einrückung
        |  ein Test-
        |  Text.
        |

    wird zu

        |Dies ist
        |
        |ein Test-
        |Text.
  • Tiefere Einrückung bleibt bestehen:

        |
        |    Dies ist
        |  ein Test-
        |  Text.
        |

    wird zu

        |  Dies ist
        |ein Test-
        |Text.

removeIndentationNl() - Entferne Text-Einrückung

Synopsis

    $str = $class->removeIndentationNl($str,@opt); # [1]
    $class->removeIndentationNl(\$str,@opt);       # [2]

Kommentare

removeComments() - Entferne Kommentare aus Quelltext

Synopsis

    $newCode = $this->removeComments($code,$start);
    $newCode = $this->removeComments($code,$start,$stop);

Description

Entferne alle Kommentare aus Quelltext $code und liefere das Resultat zurück. Die Kommentarzeichen werden durch die Parameter $start und $stop definiert. Siehe Abschnitt Examples.

Die Methode entfernt nicht nur die Kommentare selbst, sondern auch nachfolgenden oder vorausgehenden Whitespace, so dass der Quelltext lesbar bleibt.

Im Falle von einzeiligen Kommentaren (d.h. nur $start ist definiert), wird vorausgesetzt, dass dem Kommentarzeichen (der Kommentar-Zeichenkette) im Quelltext zusätzlich ein Leerzeichen oder Tab vorausgeht, sofern es nicht am Anfang der Zeile steht. D.h.

    my $ind = ' ' x 4; # Einrückung
                      ^ ^
                      hier müssen Leerzeichen (oder Tabs) stehen
    
    my $ind = ' ' x 4;# Einrückung
                      ^
                      Wird nicht erkannt!

Im Falle von mehrzeiligen Kommentaren ($start und $stop sind definiert) ist dies das vorausgehende Leereichen nicht nötig.

Examples

HTML, XML:

    $code = Prty::String->removeComments($code,'<!--','-->');

C, Java, CSS:

    $code = Prty::String->removeComments($code,'/*','*/');

C++, JavaScript:

    $code = Prty::String->removeComments($code,'//');

Shell, Perl, Python, Ruby, ...:

    $code = Prty::String->removeComments($code,'#');

SQL:

    $code = Prty::String->removeComments($code,'--');

VERSION

1.083

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2016 Frank Seitz

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.