C.2 Core Modules

LaTeXML::Core::Mouth

Tokenize the input.

Description

A LaTeXML::Core::Mouth (and 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.

Creating Mouths

$mouth = LaTeXML::Core::Mouth->create($source, %options);

Creates a new Mouth of the appropriate class for reading from $source.

$mouth = LaTeXML::Core::Mouth->new($string, %options);

Creates a new Mouth reading from $string.

Methods

$token = $mouth->readToken;

Returns the next LaTeXML::Core::Token from the source.

$boole = $mouth->hasMoreInput;

Returns whether there is more data to read.

$string = $mouth->getLocator;

Return a description of current position in the source, for reporting errors.

$tokens = $mouth->readTokens;

Reads all remaining tokens in the mouth, removing any trailing space catcode tokens

$lines = $mouth->readRawLine;

Reads a raw (untokenized) line from $mouth, or undef if none is found.