.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Regexp::RegGrp 3pm"
.TH Regexp::RegGrp 3pm "2021-01-05" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Regexp::RegGrp \- Groups a regular expressions collection
.SH "VERSION"
.IX Header "VERSION"
Version 1.002
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Groups regular expressions to one regular expression
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Regexp::RegGrp;
\&
\&    my $reggrp = Regexp::RegGrp\->new(
\&        {
\&            reggrp          => [
\&                {
\&                    regexp => \*(Aq%name%\*(Aq,
\&                    replacement => \*(AqJohn Doe\*(Aq,
\&                    modifier    => $modifier
\&                },
\&                {
\&                    regexp => \*(Aq%company%\*(Aq,
\&                    replacement => \*(AqACME\*(Aq,
\&                    modifier    => $modifier
\&                }
\&            ],
\&            restore_pattern => $restore_pattern
\&        }
\&    );
\&
\&    $reggrp\->exec( \e$scalar );
.Ve
.PP
To return a scalar without changing the input simply use (e.g. example 2):
.PP
.Vb 1
\&    my $ret = $reggrp\->exec( \e$scalar );
.Ve
.PP
The first argument must be a hashref. The keys are:
.IP "reggrp (required)" 4
.IX Item "reggrp (required)"
Arrayref of hashrefs. The keys of each hashref are:
.RS 4
.IP "regexp (required)" 8
.IX Item "regexp (required)"
A regular expression
.IP "replacement (optional)" 8
.IX Item "replacement (optional)"
Scalar or sub.
.Sp
A replacement for the regular expression match. If not set, nothing will be replaced except \*(L"store\*(R" is set.
In this case the match is replaced by something like sprintf(\*(L"\ex01%d\ex01\*(R", \f(CW$idx\fR) where \f(CW$idx\fR is the index
of the stored element in the store_data arrayref. If \*(L"store\*(R" is set the default is:
.Sp
.Vb 3
\&    sub {
\&        return sprintf( "\ex01%d\ex01", $_[0]\->{store_index} );
\&    }
.Ve
.Sp
If a custom restore_pattern is passed to to constructor you \s-1MUST\s0 also define a replacement. Otherwise
it is undefined.
.Sp
If you define a subroutine as replacement an hashref is passed to this subroutine. This hashref has
four keys:
.RS 8
.IP "match" 12
.IX Item "match"
Scalar. The match of the regular expression.
.IP "submatches" 12
.IX Item "submatches"
Arrayref of submatches.
.IP "store_index" 12
.IX Item "store_index"
The next index. You need this if you want to create a placeholder and store the replacement in the
\&\f(CW$self\fR\->{store_data} arrayref.
.IP "opts" 12
.IX Item "opts"
Hashref of custom options.
.RE
.RS 8
.RE
.IP "modifier (optional)" 8
.IX Item "modifier (optional)"
Scalar. The default is 'sm'.
.IP "store (optional)" 8
.IX Item "store (optional)"
Scalar or sub. If you define a subroutine an hashref is passed to this subroutine. This hashref has
three keys:
.RS 8
.IP "match" 12
.IX Item "match"
Scalar. The match of the regular expression.
.IP "submatches" 12
.IX Item "submatches"
Arrayref of submatches.
.IP "opts" 12
.IX Item "opts"
Hashref of custom options.
.RE
.RS 8
.Sp
A replacement for the regular expression match. It will not replace the match directly. The replacement
will be stored in the \f(CW$self\fR\->{store_data} arrayref. The placeholders in the text can easily be rereplaced
with the restore_stored method later.
.RE
.RE
.RS 4
.RE
.IP "restore_pattern (optional)" 4
.IX Item "restore_pattern (optional)"
Scalar or Regexp object. The default restore pattern is
.Sp
.Vb 1
\&    qr~\ex01(\ed+)\ex01~
.Ve
.Sp
This means, if you use the restore_stored method it is looking for \ex010\ex01, \ex011\ex01, ... and
replaces the matches with \f(CW$self\fR\->{store_data}\->[0], \f(CW$self\fR\->{store_data}\->[1], ...
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.IP "Example 1" 4
.IX Item "Example 1"
Common usage.
.Sp
.Vb 1
\&    #!/usr/bin/perl
\&
\&    use strict;
\&    use warnings;
\&
\&    use Regexp::RegGrp;
\&
\&    my $reggrp = Regexp::RegGrp\->new(
\&        {
\&            reggrp          => [
\&                {
\&                    regexp => \*(Aq%name%\*(Aq,
\&                    replacement => \*(AqJohn Doe\*(Aq
\&                },
\&                {
\&                    regexp => \*(Aq%company%\*(Aq,
\&                    replacement => \*(AqACME\*(Aq
\&                }
\&            ]
\&        }
\&    );
\&
\&    open( INFILE, \*(Aqunprocessed.txt\*(Aq );
\&    open( OUTFILE, \*(Aq>processed.txt\*(Aq );
\&
\&    my $txt = join( \*(Aq\*(Aq, <INFILE> );
\&
\&    $reggrp\->exec( \e$txt );
\&
\&    print OUTFILE $txt;
\&    close(INFILE);
\&    close(OUTFILE);
.Ve
.IP "Example 2" 4
.IX Item "Example 2"
A scalar is requested by the context. The input will remain unchanged.
.Sp
.Vb 1
\&    #!/usr/bin/perl
\&
\&    use strict;
\&    use warnings;
\&
\&    use Regexp::RegGrp;
\&
\&    my $reggrp = Regexp::RegGrp\->new(
\&        {
\&            reggrp          => [
\&                {
\&                    regexp => \*(Aq%name%\*(Aq,
\&                    replacement => \*(AqJohn Doe\*(Aq
\&                },
\&                {
\&                    regexp => \*(Aq%company%\*(Aq,
\&                    replacement => \*(AqACME\*(Aq
\&                }
\&            ]
\&        }
\&    );
\&
\&    open( INFILE, \*(Aqunprocessed.txt\*(Aq );
\&    open( OUTFILE, \*(Aq>processed.txt\*(Aq );
\&
\&    my $unprocessed = join( \*(Aq\*(Aq, <INFILE> );
\&
\&    my $processed = $reggrp\->exec( \e$unprocessed );
\&
\&    print OUTFILE $processed;
\&    close(INFILE);
\&    close(OUTFILE);
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Merten Falk, \f(CW\*(C`<nevesenin at cpan.org>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests through the web interface at
<http://github.com/nevesenin/regexp\-reggrp\-perl/issues>.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
perldoc Regexp::RegGrp
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2010, 2011 Merten Falk, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.