.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "PPIx::Regexp::Structure::Regexp 3"
.TH PPIx::Regexp::Structure::Regexp 3 2024-09-01 "perl v5.40.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
PPIx::Regexp::Structure::Regexp \- Represent the top\-level regular expression
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& use PPIx::Regexp::Dumper;
\& PPIx::Regexp::Dumper\->new( \*(Aqqr{foo}smx\*(Aq )
\&     \->print();
.Ve
.SH INHERITANCE
.IX Header "INHERITANCE"
\&\f(CW\*(C`PPIx::Regexp::Structure::Regexp\*(C'\fR is a
PPIx::Regexp::Structure::Main.
.PP
\&\f(CW\*(C`PPIx::Regexp::Structure::Regexp\*(C'\fR has no descendants.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class represents the top-level regular expression. In the example
given in the "SYNOPSIS", the \f(CW\*(C`{foo}\*(C'\fR will be represented by this
class.
.SH METHODS
.IX Header "METHODS"
This class provides the following public methods. Methods not documented
here are private, and unsupported in the sense that the author reserves
the right to change or remove them without notice.
.SS capture_names
.IX Subsection "capture_names"
.Vb 3
\& foreach my $name ( $re\->capture_names() ) {
\&     print "Capture name \*(Aq$name\*(Aq\en";
\& }
.Ve
.PP
This method returns the capture names found in the regular expression.
.SS max_capture_number
.IX Subsection "max_capture_number"
.Vb 2
\& print "Highest used capture number ",
\&     $re\->max_capture_number(), "\en";
.Ve
.PP
This method returns the highest capture number used by the regular
expression. If there are no captures, the return will be 0.
.SH SUPPORT
.IX Header "SUPPORT"
Support is by the author. Please file bug reports at
<https://rt.cpan.org/Public/Dist/Display.html?Name=PPIx\-Regexp>,
<https://github.com/trwyant/perl\-PPIx\-Regexp/issues>, or in
electronic mail to the author.
.SH AUTHOR
.IX Header "AUTHOR"
Thomas R. Wyant, III \fIwyant at cpan dot org\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2009\-2023 by Thomas R. Wyant, III
.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 LICENSES.
.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.