PT_CPARAM_CONFIG_TEA(3tcl)

💖 pt::cparam::configuration::tea — the manual page, bestie edition 💖

okay so you opened the manpage for pt::cparam::configuration::tea from the tcllib crew and you're like "what is this" — don't worry, I got you. pull up a chair. 🫶

---

✨ NAME ✨

pt::cparam::configuration::tea — it's the C/PARAM, Canned configuration, TEA situation. that's literally the whole name, three little words doing a whole lot of work. 💅

---

🌈 SYNOPSIS 🌈

package require Tcl 8.5 9

package require pt::cparam::configuration::tea ?0.2?

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

like, that's it. that's the whole vibe. she's small but she's powerful. 👑

---

🦋 DESCRIPTION 🦋

Are you lost ? Do you have trouble understanding this document ? In that case please read the overview provided by the Introduction to Parser Tools. This document is the entrypoint to the whole system the current package is a part of. — okay yes that part is me relaying the official "hey go read the intro" moment, and fr fr, if this page is giving you a headache, that intro doc is the entrypoint to the whole system this package lives in. go read it, I'll wait. 🧚

So. This package is an adjunct to pt::peg::to::cparam. it exists to make that highly configurable package easier to use by handing you a canned configuration. and when you apply it, that configuration makes pt::peg::to::cparam generate plain parser code that's ready to be included into a TEA-based C extension. no cap. that's the whole job.

It is a supporting package in the Core Layer of Parser Tools. so it's lowkey holding up the whole architecture, and honestly? iconic.

IMAGE: arch_core_support

---

💅 API 💅

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

The command applies the configuration provided by this package to the cmdprefix, causing the creation of tea-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).

Or anything other command prefix accepting two arguments, option and value. like, whatever you hand her, as long as she gets those two args she's happy. 🎀

---

😭 BUGS, IDEAS, FEEDBACK 😭

This document, and the package it describes, will undoubtedly contain bugs and other problems. 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 package and/or documentation. — yes, even the docs, they wanna hear it. 🙈

When proposing code changes, please provide unified diffs, i.e the output of diff -u. we love a clean diff in this house. ✨

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. like, attach it, don't paste a wall of text, pls and thank you. 💖

---

🌸 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 a wrap bestie!! 🌈✨ this lil page came to you from tcllib, version 0.2 — go forth and generate your TEA-based parsers, you absolute main character. bye bye!! 🎀🦋💖