LaTeXML...::Mouth(3)

💖 NAME 💖

okay so bestie, welcome to the LaTeXML...::Mouth(3) page — it's from the User Contributed Perl Documentation, and it's all about "LaTeXML::Core::Mouth", whose whole main-character job is to tokenize the input. periodt. ✨

✨ DESCRIPTION ✨

A "LaTeXML::Core::Mouth" (plus all its subclasses) is responsible for tokenizing — ie. converting plain text and strings into LaTeXML::Core::Tokens according to the current category codes (catcodes) stored in the "LaTeXML::Core::State". It extends LaTeXML::Common::Object. No cap, that's the whole job. 💅

🎀 Creating Mouths 🎀

• $mouth = LaTeXML::Core::Mouth->create($source, %options); — creates a new Mouth of the appropriate class for reading from $source. source-specific class, iykyk.
• $mouth = LaTeXML::Core::Mouth->new($string, %options); — creates a new Mouth reading from $string. string input icon.

🦋 Methods 🦋

• $token = $mouth->readToken; — returns the next LaTeXML::Core::Token from the source. main character token.
• $boole = $mouth->hasMoreInput; — returns whether there is more data to read. vibe check for leftover input.
• $string = $mouth->getLocator; — return a description of current position in the source, for reporting errors. lowkey the error-reporting glow-up.
• $tokens = $mouth->readTokens; — reads all remaining tokens in the mouth, removing any trailing space catcode tokens. clean up the trailing space vibes.
• $lines = $mouth->readRawLine; — reads a raw (untokenized) line from $mouth, or undef if none is found. no tokenizing, just raw line energy.

👑 AUTHOR 👑

Bruce Miller <bruce.miller@nist.gov> — the icon behind this page. 🫶

🌈 COPYRIGHT 🌈

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

and that's the whole page, bestie 💅 it's from perl v5.42.3, dated 2024-02-26, and it's the LaTeXML...::Mouth(3) page — periodt. 🦋