Pegex::Input(3pm)

📦
version 0.75 · 6 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Pegex::Input — the Pegex Parser Input Abstraction 💖

okay bestie, so this is Pegex::Input, a little module from the User Contributed Perl Documentation fam. think of it as the ✨vibe translator✨ between whatever messy thing you're feeding your parser and the parser itself. she's giving input abstraction, she's giving uniform interface, she's giving main character energy for real 🎀

🌈 SYNOPSIS 🌈

use Pegex;
use Pegex::Input;
my $ast = pegex($foo_grammar)->parse(Pegex::Input->new(string => $foo_input));

like. look at her. one line and your parser is fed. iconic. 💅

🦋 DESCRIPTION 🦋

so Pegex::Parser is the one doing the actual parsing, right? but the input it parses? that can be so many things, bestie:

  • a plain ol' string
  • a reference to a string
  • a file path
  • an open file handle

and that's a lot of different shapes for one parser to deal with 😭 so Pegex::Input steps in as an abstraction over any type of input. she hands the parser one clean, uniform interface so nobody has to think about it. no cap. 💖

🧚 USAGE 🧚

you call new() with two arguments, and the first one tells her what kind of input this is:

Pegex::Input->new(file => 'file.txt')

and here are all the input types you can pass, fr fr:

  • string — the input is a string. classic. simple. slay. ✨
  • stringref — the input is a string reference. lowkey this one's for when your string is really, really long and you don't wanna be copying it around. she gets it. 🫶
  • file — the input is a file path name that gets opened and read. 🍓
  • handle — the input comes from an already opened file handle, just sitting there waiting to be read. 👑

👑 AUTHOR 👑

Ingy döt Net <ingy@cpan.org>

(absolute legend, we love her 💜)

Copyright 2010-2020. Ingy döt Net.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See <http://www.perl.com/perl/misc/Artistic.html>

and that's the whole page, bestie!! this one came from perl v5.36.0, dated 2022-11-19, filed under Pegex::Input(3pm) — go forth and feed your parser whatever you want, she's got you 💅✨🎀🦋

📦 where this page comes from