PPIx::Regexp::Structure::Regexp(3pm)			User Contributed Perl Documentation		      PPIx::Regexp::Structure::Regexp(3pm)

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'
";
	}

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

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

       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 <http://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-2012 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 v5.14.2							    2012-06-06				      PPIx::Regexp::Structure::Regexp(3pm)