fileutil::magic::cfront(n)

💖 fileutil::magic::cfront(n) — the file utilities era 💖

okay so bestie, picture this: it's the file utilities corner of the Tcllib manual, and this page is literally the generator core for the compiler of magic(5) files. main character energy fr fr. 🧚✨

---

🌸 NAME 🌸

fileutil::magic::cfront — the generator core for the compiler of magic(5) files. yes she's the frontend, she's the moment, she's doing the compiling. 💅

---

✨ SYNOPSIS ✨

package require Tcl 8.5 9

package require fileutil::magic::cfront ?1.3.2?

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

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

package require struct::list

package require fileutil

::fileutil::magic::cfront::compile path...

::fileutil::magic::cfront::procdef procname path...

::fileutil::magic::cfront::install path...

like. look at those package require lines. Tcl 8.5 9, the whole squad. ?1.3.2? and ?1.2.0? optional version vibes. slay. 🎀

---

🦋 DESCRIPTION 🦋

So this package is the frontend of a compiler that turns magic(5) files into recognizers — and those recognizers are built on top of the fileutil::magic::rt recognizer runtime package. it's giving pipeline. it's giving teamwork. 🫶

And if you're wondering who the generator backend is for this compiler? that's a whole other package, bestie: fileutil::magic::cgen. go say hi. 💜

---

👑 COMMANDS 👑

• ::fileutil::magic::cfront::compile path... — bestie this one takes the paths of one or more files and directories, and compiles every single file — plus everything inside all those directories — into ONE single analyzer covering all the file types spelled out in those files. iconic honestly.

It returns a list, and the list has two items: the first item is a list of per-file dictionaries of analyzer scripts, and the second item is a list of analyzer commands. two-for-one deal. 🍓

Heads up: every one of those files has to be in the format specified by magic(5). no freestyling.

The result of the command is a Tcl script containing the generated recognizer. ✨

• ::fileutil::magic::cfront::procdef procname path... — this one acts exactly like ::fileutil::magic::cfront::compile does with regard to the path arguments it's given. but THEN — plot twist — it wraps the resulting recognizer script into a procedure named procname, sticks code that sets up the namespace of procname right in front of it, and hands you back the resulting script. it's the compile result but wearing a little outfit. 🎀
• ::fileutil::magic::cfront::install path... — this one uses ::fileutil::magic::cfront::procdef to compile each of the paths into a recognizer procedure, and then installs the result right into the current interpreter. boom. live. 🌈

The name of each new procedure is derived from the name of the file/directory that was used to create it — so a file/directory named FOO causes the creation of the procedure ::fileutil::magic::/FOO::run. yes literally that. no cap. 💅

---

😭 BUGS, IDEAS, FEEDBACK 😭

ngl, this document — and the package it describes — will undoubtedly contain bugs and other problems. it's giving "we're all just doing our best". Please report such things in the category fileutil :: magic of the Tcllib Trackers: http://core.tcl.tk/tcllib/reportlist. 🙈

Also please report any ideas for enhancements you may have for either the package and/or the documentation. we love a glow-up suggestion. 💖

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

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 bestie, go compile something cute 💅✨

this was tcllib, version 1.3.2, fileutil::magic::cfront(n) — mwah, take care of her 🫶🌸