term::ansi::code::macros(n)

✨ term::ansi::code::macros ✨

okay bestie, so this page is term::ansi::code::macros(n) from the Terminal control manual section, and it's literally all about Macro sequences 💖

---

🎀 SYNOPSIS 🎀

package require Tcl 8.5 9

package require textutil::repeat

package require textutil::tabify

package require term::ansi::code::macros ?0.2?

::term::ansi::code::macros::names

::term::ansi::code::macros::import ?ns? ?arg...?

::term::ansi::code::macros::menu menu

::term::ansi::code::macros::frame string

---

🌸 DESCRIPTION 🌸

So basically this package is giving higher level control sequences for when you wanna draw more complex shapes 🦋 like, the simple stuff isn't enough, you need the fancy terminal art, and this is where it lives. no cap.

---

💅 API 💅

🔍 INTROSPECTION

• ::term::ansi::code::macros::names — this command is for introspection, which is a fancy way of saying "hey what's in here". It returns as its result a list containing the names of all attribute commands. that's it, that's the whole vibe ✨
• ::term::ansi::code::macros::import ?ns? ?arg...? — this one imports some or all attribute commands into the namespace ns. And heads up bestie, by default that namespace is macros. Important detail: this is a relative namespace name, so it places the imported command into a child of the current namespace. By default all commands are imported, but you can restrict that by listing the names of the wanted commands after the namespace argument. iykyk 🫶

🖼️ SEQUENCES

• ::term::ansi::code::macros::menu menu — the description of a menu gets converted into a formatted rectangular block of text, and the menu command characters are highlighted using bold red text 🔥. The result is returned as the result of the command.

And about that description — menu is a dictionary mapping from menu label to command character. iconic.

• ::term::ansi::code::macros::frame string — the paragraph of text contained in string gets padded with spaces at the right margin, after normalizing internal tabs (thank you textutil::tabify and textutil::repeat 🧚), and then it's put into a frame made of box-graphics 📦✨. The result is returned as the result of the command. it's giving cozy little text box.

---

🐛 BUGS, IDEAS, FEEDBACK 🐛

ngl, this document and the package it describes will undoubtedly contain bugs and other problems. Please report such in the category term of the Tcllib Trackers at [http://core.tcl.tk/tcllib/reportlist]. Also please report any ideas for enhancements you may have for either package and/or documentation — we wanna hear it 💜

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

⚠️ 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. periodt.

---

🔑 KEYWORDS 🔑

ansi, control, frame, menu, terminal

---

📂 CATEGORY 📂

Terminal control

---

©️ COPYRIGHT ©️

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

---

and that's the whole page bestie, slay 💅✨

this was tcllib version 0.2, part of the term::ansi::code::macros(n) manual, and yeah the date in the footer is the same 0.2 era vibe — go forth and make your terminal pretty 🦋💖