.\" -*- 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::Input 3"
.TH Pegex::Input 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::Input \- Pegex Parser Input Abstraction
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&    use Pegex;
\&    use Pegex::Input;
\&    my $ast = pegex($foo_grammar)\->parse(Pegex::Input\->new(string => $foo_input));
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Pegex::Parser parses input. The input can be a string, a string reference, a
file path, or an open file handle. Pegex::Input is an abstraction over any
type of input. It provides a uniform interface to the parser.
.SH USAGE
.IX Header "USAGE"
You call \fBnew()\fR with two arguments, where the first argument is the input type:
.PP
.Vb 1
\&    Pegex::Input\->new(file => \*(Aqfile.txt\*(Aq)
.Ve
.PP
The following input types are available:
.IP string 4
.IX Item "string"
Input is a string.
.IP stringref 4
.IX Item "stringref"
Input is a string reference. This may be desirable for really long strings.
.IP file 4
.IX Item "file"
Input is a file path name to be opened and read.
.IP handle 4
.IX Item "handle"
Input is from a opened file handle, to be read.
.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>