Regexp::Common::delimited -- provides a regex for delimited strings

NAME

Regexp::Common::delimited -- provides a regex for delimited strings

SYNOPSIS

    use Regexp::Common qw /delimited/;
    while (<>) {
        /$RE{delimited}{-delim=>'"'}/  and print 'a \" delimited string';
        /$RE{delimited}{-delim=>'/'}/  and print 'a \/ delimited string';
    }

DESCRIPTION

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

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

$RE{delimited}{-delim}{-esc}

Returns a pattern that matches a single-character-delimited substring, with optional internal escaping of the delimiter.

When -delim=S is specified, each character in the sequence S is a possible delimiter. There is no default delimiter, so this flag must always be specified.

If -esc=S is specified, each character in the sequence S is the delimiter for the corresponding character in the -delim=S list. The default escape is backslash.

For example:

   $RE{delimited}{-delim=>'"'}            # match "a \" delimited string"
   $RE{delimited}{-delim=>'"'}{-esc=>'"'} # match "a "" delimited string"
   $RE{delimited}{-delim=>'/'}            # match /a \/ delimited string/
   $RE{delimited}{-delim=>q{'"}}          # match "string" or 'string'

Under -keep (See the Regexp::Common manpage):

$1
captures the entire match

$2
captures the opening delimiter (provided only one delimiter was specified)

$3
captures delimited portion of the string (provided only one delimiter was specified)

$4
captures the closing delimiter (provided only one delimiter was specified)

$RE{quoted}{-esc}

A synonym for $RE{delimited}{q{-delim='"`}{...}}

SEE ALSO

the Regexp::Common manpage for a general description of how to use this interface.

AUTHOR

Damian Conway (damian@conway.org)

MAINTAINANCE

This package is maintained by Abigail (regexp-common@abigail.nl).

BUGS AND IRRITATIONS

Bound to be plenty.

For a start, there are many common regexes missing. Send them in to regexp-common@abigail.nl.

COPYRIGHT

     Copyright (c) 2001 - 2003, Damian Conway. All Rights Reserved.
       This module is free software. It may be used, redistributed
      and/or modified under the terms of the Perl Artistic License
            (see http://www.perl.com/perl/misc/Artistic.html)
 Regexp::Common::delimited -- provides a regex for delimited strings