/ 
Regex-Common-v1.0.0
River stage zero No dependents
/ Regex::Common::balanced

NAME

Regex::Common::balanced -- provide regexes for strings with balanced parenthesized delimiters or arbitrary delimiters.

SYNOPSIS

use Regex::Common qw /balanced/;

while (<>) {
    /$RE{balanced}{-parens=>'()'}/
                               and print q{balanced parentheses\n};
}

DESCRIPTION

Please consult the manual of Regex::Common for a general description of the works of this interface.

Do not use this module directly, but load it via Regex::Common.

$RE{balanced}{-parens}

Returns a pattern that matches a string that starts with the nominated opening parenthesis or bracket, contains characters and properly nested parenthesized subsequences, and ends in the matching parenthesis.

More than one type of parenthesis can be specified:

$RE{balanced}{-parens=>'(){}'}

in which case all specified parenthesis types must be correctly balanced within the string.

Since version 2013030901, $1 will always be set (to the entire matched substring), regardless whether {-keep} is used or not.

$RE{balanced}{-begin => "begin"}{-end => "end"}

Returns a pattern that matches a string that is properly balanced using the begin and end strings as start and end delimiters. Multiple sets of begin and end strings can be given by separating them by |s (which can be escaped with a backslash).

qr/$RE{balanced}{-begin => "do|if|case"}{-end => "done|fi|esac"}/

will match properly balanced strings that either start with do and end with done, start with if and end with fi, or start with case and end with esac.

If -end contains less cases than -begin, the last case of -end is repeated. If it contains more cases than -begin, the extra cases are ignored. If either of -begin or -end isn't given, or is empty, -begin => '(' and -end => ')' are assumed.

Since version 2013030901, $1 will always be set (to the entire matched substring), regardless whether {-keep} is used or not.

Note

Since version 2013030901 the pattern will make of the recursive construct (?-1), instead of using the problematic (??{ }) construct. This fixes an problem that was introduced in the 5.17 development track.

SEE ALSO

Regex::Common for a general description of how to use this interface.

AUTHOR

Alceu Rodrigues de Freitas Junior <glasswalk3r@yahoo.com.br>

LICENSE and COPYRIGHT

This software is copyright (c) 2024 of Alceu Rodrigues de Freitas Junior, glasswalk3r at yahoo.com.br

This file is part of regex-common project.

regex-commonis free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

regex-common is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with regex-common. If not, see (http://www.gnu.org/licenses/).

The original project [Regex::Common](https://metacpan.org/pod/Regex::Common) is licensed through the MIT License, copyright (c) Damian Conway (damian@cs.monash.edu.au) and Abigail (regexp-common@abigail.be).