.\" -*- 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 "Pegex::Regex 3"
.TH Pegex::Regex 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
Pegex::Regex \- Use Pegex Like a Regex
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 6
\&    {
\&        # Turn on Pegex regular expressions in lexical scope.
\&        use Pegex::Regex;
\&        my $grammar = qr{$grammar_text}x;
\&        $text =~ $grammar;
\&        my $result = \e%/;
\&
\&        # Turn off Pegex in this scope.
\&        no Pegex::Regex;
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a trivial sugar module that lets you use Pegex parser grammars like
regular expressions, if you're into that kind of thing.
.PP
This is basically a clone of Damian Conway's Regexp::Grammars module API.
You put a grammar into a \f(CW\*(C`qr{...}x\*(C'\fR and apply it the input string you want
to parse. If the parse is successful, you get a data structure of the
content in \f(CW\*(C`%/\*(C'\fR.
.PP
IMHO, building a recursive descent parser entirely inside of a regular
expression, is not the clearest way to code. But, of course, TMTOWTDI. :)
.SH NOTE
.IX Header "NOTE"
This module is just for experimental fun. See Pegex for the right way to
use the Pegex parsing framework.
.SH TMTOWTDI
.IX Header "TMTOWTDI"
Here's a Pegex::Regex code snippet:
.PP
.Vb 3
\&    use Pegex::Regex;
\&    $text =~ qr{... Pegex grammar text ...};
\&    $data = \e%/;
.Ve
.PP
And the equivalent Pegex code:
.PP
.Vb 2
\&    use Pegex;
\&    my $data = pegex(\*(Aq... Pegex grammar text ...\*(Aq)\->parse($text);
.Ve
.SH WARNING
.IX Header "WARNING"
This gateway drug, er, module, technically should not even work.
.PP
It turns your "grammar inside a regexp" into a Pegex::Grammar using qr{}
overloading, and then turns your regexp itself into a shim that calls the
parse method for you. This is highly magical and technically makes a reentrant
call to the regex engine, which is not supported yet. Use at your own risk.
.PP
Better yet, do yourself a favor and learn how to use the Pegex toolset without
this ::Regex sugar. \f(CW\*(C`:\-)\*(C'\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP \(bu 4
Pegex
.IP \(bu 4
Regexp::Grammars
.SH AUTHOR
.IX Header "AUTHOR"
Ingy döt Net <ingy@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2010\-2020. Ingy döt Net.
.PP
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
.PP
See <http://www.perl.com/perl/misc/Artistic.html>