fileutil::magic::cgen(n)

✨ fileutil::magic::cgen ✨

okay bestie, welcome to fileutil::magic::cgen — the generator core for the compiler of magic(5) files. yes that's a lot of words, we'll get through it together, i promise 💖

---

🎀 NAME 🎀

fileutil::magic::cgen — generator core for compiler of magic(5) files. that's the whole vibe. it generates. it's a core. it does magic files. slay ✨

---

🌸 SYNOPSIS 🌸

package require Tcl 8.5 9

package require fileutil::magic::cgen ?1.2.0?

package require fileutil::magic::rt ?1.2.0?

package require struct::tree

package require struct::list

::fileutil::magic::cgen::2tree script

::fileutil::magic::cgen::treedump tree

::fileutil::magic::cgen::treegen tree node

like, that's it, that's the whole entrance. Tcl 8.5 9, the cgen package itself at ?1.2.0?, plus fileutil::magic::rt at ?1.2.0?, plus struct::tree and struct::list. three commands. iconique. 👑

---

💜 DESCRIPTION 💜

so this package is the generator backend for a compiler that turns magic(5) files into recognizers — and those recognizers are built on top of the fileutil::magic::rt recognizer runtime package. that's the runtime, that's where the actual doing-things lives.

if you're looking for the compiler frontend that uses this generator, that's a different girl: the package fileutil::magic::cfront. go say hi. 🫶

---

💅 COMMANDS 💅

• ::fileutil::magic::cgen::2tree script — converts the recognizer specified by script into a tree, and returns the object command of that tree as its result. it uses the package struct::tree to make the tree happen. and the script? it's in the format specified by magic(5). no cap.
• ::fileutil::magic::cgen::treedump tree — takes a tree that came out of ::fileutil::magic::cgen::2tree and returns a string encoding that tree for human consumption. it's a debugging aid. it's giving "let me see what you actually built". 🔍
• ::fileutil::magic::cgen::treegen tree node — takes a tree that came out of ::fileutil::magic::cgen::2tree and returns a Tcl script — specifically the recognizer for the file types represented by the sub-tree rooted at node. and listen, that generated script makes extensive use of the commands provided by the recognizer runtime package fileutil::magic::rt to do its duties. teamwork, fr fr. 🤝

---

🦋 BUGS, IDEAS, FEEDBACK 🦋

ngl, this document and the package it describes will undoubtedly contain bugs and other problems. i'm just being honest with you. 😭

please report such bugs in the category fileutil :: magic of the Tcllib Trackers: http://core.tcl.tk/tcllib/reportlist

and please also report any ideas for enhancements you may have for either the package and/or the documentation. we want the ideas. we love the ideas. ✨

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

also, 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. 🎀

---

🌈 SEE ALSO 🌈

• file(1)
• fileutil
• magic(5)

---

⭐ KEYWORDS ⭐

file recognition, file type, file utilities, mime, type

---

👑 CATEGORY 👑

Programming tools

---

okay that's the whole page, you understood all of it, i'm so proud of you 🥹💖

this little masterpiece is brought to you by tcllib, version 1.2.0, and it lives under the name fileutil::magic::cgen(n). go forth and generate, bestie. periodt. 💅✨🦋