LaTeXML...finition(3)

hey bestie 💖 welcome to the LaTeXML::Core::Definition(3) page, straight out of User Contributed Perl Documentation. it's giving core-TeX-definition energy, and we're gonna walk it together, no cap.

🎀 NAME 🎀

LaTeXML::Core::Definition — control sequence definitions. periodt.

✨ DESCRIPTION ✨

okay so this is an abstract class. it represents all the different executables that correspond to control sequences — the whole little definition family. if you want the most convenient way to create them, peek at LaTeXML::Package, iykyk.

it extends LaTeXML::Common::Object — inheritance icon behavior, slay.

💅 Methods 💅

here are the methods, bestie — every single one, no skipping:

• $token = $defn->getCS; — returns the (main) token that is bound to this definition. that's the main-character token, fr fr.
• $string = $defn->getCSName; — returns the string form of the token bound to this definition, taking into account any alias for this definition. alias awareness = iconic.
• $defn->readArguments($gullet); — reads the arguments for this $defn from the $gullet, returning a list of LaTeXML::Core::Tokens. gullet does the reading, we love to see it.
• $parameters = $defn->getParameters; — returns the LaTeXML::Core::Parameters object representing the formal parameters of the definition. formal parameters are literally the blueprint bestie.
• @tokens = $defn->invocation(@args); — returns the tokens that would invoke the given definition with the provided arguments. this is used to recreate the TeX code (or its equivalent). it's giving "put the invocation back together" energy.
• $defn->invoke; — invokes the action of the $defn. for expandable definitions, this is done in the Gullet, and returns a list of LaTeXML::Core::Tokens. for primitives, it is carried out in the Stomach, and returns a list of LaTeXML::Core::Boxes. for a constructor, it is also carried out by the Stomach, and returns a LaTeXML::Core::Whatsit. that whatsit will be responsible for constructing the XML document fragment, when the LaTeXML::Core::Document invokes $whatsit->beAbsorbed($document);. yes, the arrow is doing its thing 💅.

primitives and constructors also support before and after daemons — lists of subroutines that are executed before and after digestion. these can be useful for changing modes, etc. lowkey useful for mode changes, no cap.

🌈 SEE ALSO 🌈

go look at these too, bestie — they're the rest of the definition crew:

• LaTeXML::Core::Definition::Expandable
• LaTeXML::Core::Definition::Conditional
• LaTeXML::Core::Definition::Primitive
• LaTeXML::Core::Definition::Register
• LaTeXML::Core::Definition::CharDef
• LaTeXML::Core::Definition::Constructor

👑 AUTHOR 👑

Bruce Miller <bruce.miller@nist.gov> — author credit, periodt.

🦋 COPYRIGHT 🦋

Public domain software, produced as part of work done by the United States Government & not subject to copyright in the US.

okay that's the whole page — cute sign-off time: perl v5.42.3, dated 2024-02-26, footer title LaTeXML...finition(3). bye bestie, go define some control sequences 💖✨