.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PPIx::Regexp::Token::GroupType 3pm"
.TH PPIx::Regexp::Token::GroupType 3pm "2019-04-03" "perl v5.28.1" "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"
PPIx::Regexp::Token::GroupType \- Represent a grouping parenthesis type.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use PPIx::Regexp::Dumper;
\& PPIx::Regexp::Dumper\->new( \*(Aqqr{(?i:foo)}smx\*(Aq )
\&     \->print();
.Ve
.SH "INHERITANCE"
.IX Header "INHERITANCE"
\&\f(CW\*(C`PPIx::Regexp::Token::GroupType\*(C'\fR is a
PPIx::Regexp::Token.
.PP
\&\f(CW\*(C`PPIx::Regexp::Token::GroupType\*(C'\fR is the parent of
PPIx::Regexp::Token::GroupType::Assertion,
PPIx::Regexp::Token::GroupType::Atomic_Script_Run,
PPIx::Regexp::Token::GroupType::BranchReset,
PPIx::Regexp::Token::GroupType::Code,
PPIx::Regexp::Token::GroupType::Modifier,
PPIx::Regexp::Token::GroupType::NamedCapture,
PPIx::Regexp::Token::GroupType::Script_Run,
PPIx::Regexp::Token::GroupType::Subexpression
and
PPIx::Regexp::Token::GroupType::Switch.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents any of the magic sequences of characters that can
follow an open parenthesis. This particular class is intended to be
abstract.
.SH "METHODS"
.IX Header "METHODS"
This class provides no public methods beyond those provided by its
superclass.
.SS "_\|_defining_string"
.IX Subsection "__defining_string"
.Vb 1
\& my $string = $class\->_\|_defining_string();
.Ve
.PP
This method is private to the \f(CW\*(C`PPIx\-Regexp\*(C'\fR package, and is documented
for the author's benefit only. It may be changed or revoked without
notice.
.PP
This method returns an array of strings that define the specific group
type.  These strings will normally start with \f(CW\*(Aq?\*(Aq\fR.
.PP
Optionally, the first returned item may be a hash reference. The only
supported key is \f(CW\*(C`{suffix}\*(C'\fR, which is a string to be suffixed to each
of the regular expressions made by \f(CW\*(C`_\|_make_group_type_matcher()\*(C'\fR out of
the defining strings, inside a \f(CW\*(C`(?= ... )\*(C'\fR, so that it is not included
in the match.
.PP
This method \fBmust\fR be overridden, unless \f(CW\*(C`_\|_make_group_type_matcher()\*(C'\fR
is. The override \fBmust\fR return the same thing each time, since the
results of \f(CW\*(C`_\|_make_group_type_matcher()\*(C'\fR are cached.
.SS "_\|_make_group_type_matcher"
.IX Subsection "__make_group_type_matcher"
.Vb 1
\& my $hash_ref = $class\->_\|_make_group_type_matcher();
.Ve
.PP
This method is private to the \f(CW\*(C`PPIx\-Regexp\*(C'\fR package, and is documented
for the author's benefit only. It may be changed or revoked without
notice.
.PP
This method returns a reference to a hash. The keys are regexp delimiter
characters which appear in the defining strings for the group type. For
each key, the value is a reference to an array of \f(CW\*(C`Regexp\*(C'\fR objects,
properly escaped for the key character. Key \f(CW\*(Aq\*(Aq\fR provides the regular
expressions to be used if the regexp delimiter does not appear in any of
the defining strings.
.PP
If this method is overridden by the subclass, method
\&\f(CW\*(C`_\|_defining_string()\*(C'\fR need not be, unless the overridden
\&\f(CW\*(C`_\|_make_group_type_matcher()\*(C'\fR calls \f(CW\*(C`_\|_defining_string()\*(C'\fR.
.SS "_\|_match_setup"
.IX Subsection "__match_setup"
.Vb 1
\& $class\->_\|_match_setup( $tokenizer );
.Ve
.PP
This method is private to the \f(CW\*(C`PPIx\-Regexp\*(C'\fR package, and is documented
for the author's benefit only. It may be changed or revoked without
notice.
.PP
This method performs whatever setup is needed once it is determined that
the given group type has been detected.  This method is called only if
the class matched at the current position in the string being parsed. It
must perform whatever extra setup is needed for the match. It returns
nothing.
.PP
This method need not be overridden. The default does nothing.
.SS "_\|_setup_class"
.IX Subsection "__setup_class"
.Vb 1
\& $class\->_\|_setup_class( \e%definition, \e%opt );
.Ve
.PP
This method is private to the \f(CW\*(C`PPIx\-Regexp\*(C'\fR package, and is documented
for the author's benefit only. It may be changed or revoked without
notice.
.PP
This method uses the \f(CW%definition\fR hash to create the
\&\f(CW\*(C`_\|_defining_string()\*(C'\fR, \f(CW\*(C`explain()\*(C'\fR, \f(CW\*(C`perl_version_introduced()\*(C'\fR, and
\&\f(CW\*(C`perl_version_removed()\*(C'\fR methods for the calling class. Any of these
that already exist will \fBnot\fR be replaced.
.PP
The \f(CW%definition\fR hash defines all the strings that specify tokens of
the invoking class. You can not (unfortunately) use this mechanism if
you need a regular expression to recognize a token that belongs to this
class. The keys of the \f(CW%definition\fR hash are strings that specify
members of this class. The values are hashes that define the specific
member of the class. The following values are supported:
.IP "{expl}" 4
.IX Item "{expl}"
This is the explanation of the element, to be returned by the
\&\f(CW\*(C`explain()\*(C'\fR method.
.IP "{intro}" 4
.IX Item "{intro}"
This is the Perl version that introduced the element, as a string. The
default is the value of constant
\&\s-1MINIMUM_PERL\s0.
.IP "{remov}" 4
.IX Item "{remov}"
This is the Perl version that removed the element, as a string. The
default is \f(CW\*(C`undef\*(C'\fR, meaning that the element is still present in the
highest released version of Perl, whether development or production.
.PP
The \f(CW%opt\fR hash is optional, and defaults to the empty hash. It is
used, basically, for ad-hocery. The supported keys are:
.IP "{suffix}" 4
.IX Item "{suffix}"
If this element is defined, the first element returned by the generated
_\|\fB_defining_string()\fR method is a hash containing
this key and value.
.SH "SUPPORT"
.IX Header "SUPPORT"
Support is by the author. Please file bug reports at
<http://rt.cpan.org>, or in electronic mail to the author.
.SH "AUTHOR"
.IX Header "AUTHOR"
Thomas R. Wyant, \s-1III\s0 \fIwyant at cpan dot org\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2009\-2019 by Thomas R. Wyant, \s-1III\s0
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl 5.10.0. For more details, see the full text
of the licenses in the directory \s-1LICENSES.\s0
.PP
This program 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.