Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

PPIx::Regexp::Structure::Regexp

Name PPIx::Regexp::Structure::Regexp
Version 0.068
Located at /usr/share/perl5/vendor_perl
File /usr/share/perl5/vendor_perl/PPIx/Regexp/Structure/Regexp.pm
Is Core No
Search CPAN for this module PPIx::Regexp::Structure::Regexp
Documentation PPIx::Regexp::Structure::Regexp
Module Details PPIx::Regexp::Structure::Regexp

NAME

PPIx::Regexp::Structure::Regexp - Represent the top-level regular expression


SYNOPSIS

 use PPIx::Regexp::Dumper;
 PPIx::Regexp::Dumper->new( 'qr{foo}smx' )
     ->print();


INHERITANCE

PPIx::Regexp::Structure::Regexp is a PPIx::Regexp::Structure::Main.

PPIx::Regexp::Structure::Regexp has no descendants.


DESCRIPTION

This class represents the top-level regular expression. In the example given in the SYNOPSIS, the {foo} will be represented by this class.


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.

capture_names

 foreach my $name ( $re->capture_names() ) {
     print "Capture name '$name'\n";
 }

This method returns the capture names found in the regular expression.

max_capture_number

 print "Highest used capture number ",
     $re->max_capture_number(), "\n";

This method returns the highest capture number used by the regular expression. If there are no captures, the return will be 0.


SUPPORT

Support is by the author. Please file bug reports at https://rt.cpan.org, or in electronic mail to the author.


AUTHOR

Thomas R. Wyant, III wyant at cpan dot org


COPYRIGHT AND LICENSE

Copyright (C) 2009-2020 by Thomas R. Wyant, III

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.

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.

Perl Diver brought to you by ScriptSolutions.com © 1997- 2025