NAME
YAPE::Regex::Explain - explanation of a regular expression
SYNOPSIS
use YAPE::Regex::Explain;
my $exp = YAPE::Regex::Explain->new($REx)->explain;
`YAPE' MODULES
The `YAPE' hierarchy of modules is an attempt at a unified means
of parsing and extracting content. It attempts to maintain a
generic interface, to promote simplicity and reusability. The
API is powerful, yet simple. The modules do tokenization (which
can be intercepted) and build trees, so that extraction of
specific nodes is doable.
DESCRIPTION
This module merely sub-classes `YAPE::Regex', and produces a
rather verbose explanation of a regex, suitable for
demonstration and tutorial purposes. Perl 5.6 regex structures
like `\p{...}' and `\P{...}' and `[:...:]' are now supported.
Methods for `YAPE::Regex::Explain'
* `my $p = YAPE::Regex::Explain->new($regex);'
Calls `YAPE::Regex''s `new' method (see its docs).
* `my $p = YAPE::Regex::Explain->explain($mode);'
Returns a string explaining the regex. If `$mode' is
`regex', it will output a valid regex (instead of the normal
string). If `$mode' is `silent', no comments will be added,
but the regex will be expanded into a readable format.
SUPPORT
Visit `YAPE''s web site at http://www.pobox.com/~japhy/YAPE/.
SEE ALSO
The `YAPE::Regex' documentation.
AUTHOR
Jeff "japhy" Pinyan
CPAN ID: PINYAN
japhy@pobox.com
http://www.pobox.com/~japhy/