PPIx::R...::Regexp(3)

πŸ’– PPIx::Regexp::Structure::Regexp β€” the whole vibe ✨

okay bestie, welcome to PPIx::R...::Regexp(3), the manual page you're gonna be lowkey obsessed with. this one's about PPIx::Regexp::Structure::Regexp, and no cap, it's giving main character of the whole regex object tree. let's get into it 🫢


🌸 NAME 🌸

PPIx::Regexp::Structure::Regexp β€” the class that represents the top-level regular expression. yep. the big one. the queen bee. πŸ‘‘


✨ SYNOPSIS ✨

like, here's how you'd actually use it, bestie:

use PPIx::Regexp::Dumper;
PPIx::Regexp::Dumper->new( 'qr{foo}smx' )
    ->print();

that's it. that's the whole flex. πŸ’…


πŸ¦‹ INHERITANCE πŸ¦‹

so here's the family tree, and it's a short one:

  • PPIx::Regexp::Structure::Regexp is a PPIx::Regexp::Structure::Main.
  • PPIx::Regexp::Structure::Regexp has no descendants.

so like, it's a leaf node. it inherited its whole lewk from Main and then said "i'm done, no kids, periodt." 🌈


πŸŽ€ DESCRIPTION πŸŽ€

this class represents the top-level regular expression. literally the outermost shell of the whole thing.

remember the example from the SYNOPSIS? the {foo} part in there β€” that's this class. that's it. that's the moment. it's not a sub-piece, it's not a fragment, it's the entire regex holding court at the top. πŸ‘‘


πŸ’œ METHODS πŸ’œ

this class provides the following public methods, bestie. and listen β€”

methods that aren't documented here are private, and they're unsupported in the sense that the author reserves the right to change or remove them without notice. so like, don't build your whole personality on them, okay? πŸ™ˆ

πŸ“ capture_names

foreach my $name ( $re->capture_names() ) {
    print "Capture name '$name'\n";
}

this method returns the capture names found in the regular expression. that's it. all of them, handed back to you. slay. ✨


🧚 max_capture_number

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

this method returns the highest capture number used by the regular expression.

and here's the lil gotcha: if there are no captures, the return will be 0. not undef, not a sad empty string β€” 0. noted. πŸ“


🫢 SUPPORT 🫢

support is by the author, so like, this is a one-person show and they're doing amazing, okay?

please file bug reports at:

or, if you're feeling old-school, in electronic mail to the author. either way, be nice. πŸ₯Ί


πŸ‘‘ AUTHOR πŸ‘‘

Thomas R. Wyant, III β€” harryfmudd at comcast dot net


Copyright (C) 2009-2023, 2025-2026 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. so like, no promises, bestie. read the license. 😭


and that's the whole page, fr fr πŸ’– this was PPIx::R...::Regexp(3), documented for perl v5.42.2, dated 2026-06-15. go forth and parse some regexes, you absolute icon. 🌟

πŸ“¦ where this page comes from