PT_TCLPARAM_CONFIG_SNIT(n)

πŸ“¦
version 2.0 Β· 2 versions
, in fedora 43, fedora 44, nixos 26.05, nixpkgs unstable

πŸ’– pt::tclparam::configuration::snit β€” the manual, but make it make sense πŸ’–

okay bestie, welcome to the pt::tclparam:...guration::snit(n) page β€” yes that name is giving "someone's cat walked across the keyboard" but we move. this is a Tcl manpage and i'm gonna walk you through it like we're texting at 2am πŸ¦‹


✨ NAME ✨

pt::tclparam::configuration::snit β€” Tcl/PARAM, Canned configuration, Snit. that's it, that's the whole vibe. πŸ’…


🌸 SYNOPSIS 🌸

package require Tcl 8.5 9

package require pt::tclparam::configuration::snit ?1.0.3?

::pt::tclparam::configuration::snit def name pkg version cmdprefix

the ?1.0.3? is optional, she's flexible, we love that for her πŸ’–


πŸŽ€ DESCRIPTION πŸŽ€

are you lost ? bestie. genuinely. are you having trouble understanding this document ? 😭 no shame, it happens to everyone. in that case, please go read the overview provided by the Introduction to Parser Tools. that doc is literally the entrypoint to the whole system this current package is a part of. start there, come back, i'll wait. 🫢

okay so. this package is an adjunct to pt::peg::to::tclparam. it exists to make your life easier, because pt::peg::to::tclparam is highly configurable β€” like, so configurable β€” and this package hands you a canned configuration so you don't have to hand-tune everything yourself. when you apply this configuration, it causes pt::peg::to::tclparam to generate snit-based parser packages. slay. ✨

she's a supporting package in the Core Layer of Parser Tools. important little helper energy. πŸ‘‘

IMAGE: arch_core_support


πŸ’… API πŸ’…

::pt::tclparam::configuration::snit def name pkg version cmdprefix

the command applies the configuration provided by this package to the cmdprefix, causing the creation of snit-based parsers whose class is name, in package pkg with version. πŸŽ€

the use of a command prefix as API is the whole point, because it means you can apply this configuration to not only:

  • pt::peg::to::tclparam (pt::peg::to::tclparam configure)

but ALSO to:

  • export manager instances and PEG containers ($export configuration set and [$container exporter] configuration set respectively) πŸ”₯

or, honestly, anything other command prefix accepting two arguments, option and value. it's giving "works with everything, no gatekeeping." πŸ’œ


😭 BUGS, IDEAS, FEEDBACK 😭

this document, and the package it describes, will undoubtedly contain bugs and other problems. no cap. πŸ’€

please report such in the category pt of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. please also report any ideas for enhancements you may have for either the package and/or the documentation β€” we want all of it, every last thought. πŸ™ˆ

when proposing code changes, please provide unified diffs, i.e the output of diff -u.

note further that attachments are strongly preferred over inlined patches. attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar. iykyk. ✨


πŸ‘‘ KEYWORDS πŸ‘‘

EBNF, LL(k), PEG, TDPL, context-free languages, expression, grammar, matching, parser, parsing expression, parsing expression grammar, push down automaton, recursive descent, state, top-down parsing languages, transducer

(the way this list ate and left no crumbs πŸ“)


🌈 CATEGORY 🌈

Parsing and Grammars


Copyright (c) 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>


okay that's the whole page, bestie, you're officially caught up πŸ’– this was tcllib version 1.0.3, page pt::tclparam:...guration::snit(n) β€” mwah, go forth and configure your snit-based parsers, main character. 🌸✨

πŸ“¦ where this page comes from