PT_CPARAM_CONFIG_CRITCL(n)

💖 pt::cparam::configuration::critcl — the manual, but make it make sense 💖

okay bestie, you're reading the man page for pt::cparam::configuration::critcl, from the tcllib docs. Sit down, hydrate, and let's get into it. 🫶

---

✨ NAME ✨

pt::cparam::configuration::critcl — C/PARAM, Canned configuration, Critcl. That's the whole vibe: it's a canned config. Like a preset. Like when your phone already knows your coffee order. ☕

---

🌸 SYNOPSIS 🌸

package require Tcl 8.5 9

package require pt::cparam::configuration::critcl ?1.0.3?

::pt::cparam::configuration::critcl def name pkg version cmdprefix

ngl the ?1.0.3? with the question marks means "this version is optional / you may pin it" — it's not me being indecisive, it's literally how Tcl writes it. 💅

---

🦋 DESCRIPTION 🦋

Are you lost? Genuinely confused by this document? No shame, it happens to the best of us. 😭 In that case please go read the overview in the Introduction to Parser Tools. That doc is the entrypoint to the whole system, and this package is just one little piece of it.

So. This package is an adjunct to pt::peg::to::cparam. Translation: it exists to make that wildly configurable package easier to use, by handing you a canned configuration. When you apply this config, it makes pt::peg::to::cparam generate critcl-based parser packages. That's the whole point. That's the assignment and it ate. 🔥

It's a supporting package in the Core Layer of Parser Tools.

IMAGE: arch_core_support

---

👑 API 👑

::pt::cparam::configuration::critcl def name pkg version cmdprefix

The command applies the configuration provided by this package to the cmdprefix, causing the creation of critcl-based parsers whose class is name, in package pkg with version. ✨

The use of a command prefix as API allows application of the configuration to not only pt::peg::to::cparam (pt::peg::to::cparam configure), but also export manager instances and PEG containers ($export configuration set and [$container exporter] configuration set respectively). Look at her, being flexible. Versatile queen. 👑

Or anything other command prefix accepting two arguments, option and value. That's it. That's the whole requirement. 💅

---

💀 BUGS, IDEAS, FEEDBACK 💀

This document, and the package it describes, will undoubtedly contain bugs and other problems. 😭 (Their words, not mine, but fr fr, that's just software.) 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. They want them. Give them your ideas. 🫶

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

Also note: attachments are strongly preferred over inlined patches. You can attach stuff 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. Go find that button, bestie, it's right there. 🎀

---

🌈 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

(that's a lot of words and every single one of them is doing its job 🧚)

---

🍓 CATEGORY 🍓

Parsing and Grammars

---

💜 COPYRIGHT 💜

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

---

and that's the page, bestie!! 🎀✨ written up under tcllib, version 1.0.3, and yeah it's the pt::cparam::c...ration::critcl(n) page in case the truncation was stressing you out. go configure something iconic. periodt. 💅🦋