CodeTe...mplate(3pm)

📦
version 0.3.4 · 2 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

💖 NAME 💖

Tk::CodeText::Template — a whole template for syntax highlighting plugins, bestie ✨

📜 SYNOPSIS 📜

okay so… this section is literally empty. Not a single line. No cap, there is nothing here to show you 🫶

🌸 DESCRIPTION 🌸

Tk::CodeText::Template is a framework that's here to help out all the girlies (gn) who write plugin modules 🎀 Every single method you'd need to bring syntax highlighting to life inside a Tk::CodeText widget? It's all right there. The only things missing are the syntax definitions and the callbacks, which is lowkey the whole point — you bring those.

🚨 bestie listen: you should never create an instance of Tk::CodeText::Template. Never ever. It is meant to be sub classed only. It's giving "abstract base class, do not touch," and we respect that 💅

✨ METHODS ✨

  • callbacks({'Tagname' => \&callback, ...}) — sets and returns the instance variable 'callbacks' 🦋
  • highlight($text) — highlights $text. It does this by picking the right callback out of the commands hash and invoking it. And it keeps on doing that, over and over, until $text has been reduced all the way down to an empty string. Iconic loop behavior, fr fr 🔥
  • listAdd('listname', $item1, $item2 ...) — adds a list to the 'lists' hash 📋
  • lists(?\%lists?) — sets and returns the instance variable 'lists' 💜
  • out(?\@highlightedlist?) — sets and returns the instance variable 'out' 🌈
  • parserError('text') — the error trapping method. It tries to escape the current mode. If that's not possible, it will parse the text with the default tag instead. On top of all that, it complains about being called at all 😭 which is honestly so valid of it. This one is useful for debugging when you're writing a new plugin 🔍
  • rules(?\@rules?) — sets and returns a reference to a list of tagnames and options. By default it is set to [] ⭐
  • snippetAppend($string) — appends $string to the current snippet ✂️
  • snippetParse(?$text?, ?$tagname?) — parses $text into the 'out' list, and assigns $tagname to it. If $tagname isn't specified, it will go looking for the tagname by calling stackTop. And if $text isn't specified either, it will go looking for text by calling snippet 👑
  • stack — sets and returns the instance variable 'stack', which is a reference to an array 🥞
  • stackPull — retrieves the element that's sitting on top of the stack, and decrements stacksize by 1 📉
  • stackPush($tagname) — puts $tagname on top of the stack, and increments stacksize by 1 📈
  • stackTop — retrieves the element on top of the stack 👀
  • stateCompare(\@state); — compares two lists, \@state and the stack. Returns true if they match 💚
  • stateGet — returns a list containing the entire stack 🗂️
  • stateSet(@list) — accepts @list as the current stack 🔄
  • tokenParse('Tagname'); — parses the currently built snippet and tags it with 'Tagname' 🏷️
  • tokenTest($value, 'Listname'); — returns true if $value is an element of 'Listname' in the 'lists' hash ✅

👑 AUTHOR 👑

Hans Jeuken (haje@toneel.demon.nl) — shoutout to the legend 🫶

💀 BUGS 💀

Unknown. (Which is either slay or terrifying, and honestly? Both 😭)

mwah, that's the whole page bestie 💖 this lovely little doc shipped with perl v5.40.1 and it's dated 2025-05-04, under User Contributed Perl Documentation — go forth and subclass responsibly 🧚✨

📦 where this page comes from