pt::tclpara...guration::nx(3tcl)

✨ NAME ✨

pt::tclparam::configuration::nx — Tcl/PARAM, Canned configuration, NX 💅

so this is a page from the Parser Tools manual, section 3tcl, and it's all about a little package that hands you a ready-made config so you don't have to build one yourself. bestie energy, zero setup stress. 🎀

---

🌸 SYNOPSIS 🌸

package require Tcl 8.5 9

package require pt::tclparam::configuration::nx ?1.0.2?

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

---

💖 DESCRIPTION 💖

okay so, are you lost? 😭 are you out here having trouble understanding this whole document? it happens, no shame. if that's you, please go read the overview that the Introduction to Parser Tools gives you — that doc is literally the entrypoint to the entire system this package is part of. start there, bestie. 🫶

so what is this package? it's an adjunct to pt::peg::to::tclparam. that package is highly configurable, which is iconic but also a lot, so this one exists to make using it way easier by handing you a canned configuration. when you apply it, it makes pt::peg::to::tclparam generate NX-based parser packages. slay. ✨

also it's a supporting package in the Core Layer of Parser Tools. so it's lowkey part of the main character infrastructure. 👑

IMAGE: arch_core_support

---

🦋 API 🦋

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

this command applies the configuration this package provides to the cmdprefix, which makes NX-based parsers get created — parsers whose class is name, living in package pkg, with version. 💫

the reason it takes a command prefix as its API (instead of just being hardwired to one thing) is so you can apply this configuration to more than just pt::peg::to::tclparam:

• plain old pt::peg::to::tclparam — via pt::peg::to::tclparam configure
• export manager instances — via $export configuration set
• PEG containers — via [$container exporter] configuration set

or literally anything else that's a command prefix accepting two arguments: an option and a value. fr fr, that's the whole vibe check. 🌈

---

💀 BUGS, IDEAS, FEEDBACK 💀

ngl, this document and the package it describes will undoubtedly contain bugs and other problems. 😭 please report them in the category pt of the Tcllib Trackers at http://core.tcl.tk/tcllib/reportlist. and if you've got ideas for enhancements — for the package, for the docs, for either one — send those in too. we want them. 🫶

when you propose code changes, please provide unified diffs, aka the output of diff -u. periodt.

also important: attachments are strongly preferred over inlined patches. to attach one, go to the Edit form of the ticket right after you create it, then use 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

---

👑 CATEGORY 👑

Parsing and Grammars

---

💜 COPYRIGHT 💜

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

---

and that's the whole page, bestie 🎀 this one ships as part of tcllib, version 1.0.2 — go forth and generate your NX parsers, you've absolutely got this. 💖✨🦋