1LaTeXML::Core::Mouth(3)User Contributed Perl DocumentatioLnaTeXML::Core::Mouth(3)
2
3
4

NAME

6       "LaTeXML::Core::Mouth" - tokenize the input.
7

DESCRIPTION

9       A "LaTeXML::Core::Mouth" (and subclasses) is responsible for
10       tokenizing, ie.  converting plain text and strings into
11       LaTeXML::Core::Tokens according to the current category codes
12       (catcodes) stored in the "LaTeXML::Core::State".
13
14       It extends LaTeXML::Common::Object.
15
16   Creating Mouths
17       "$mouth = LaTeXML::Core::Mouth->create($source, %options);"
18           Creates a new Mouth of the appropriate class for reading from
19           $source.
20
21       "$mouth = LaTeXML::Core::Mouth->new($string, %options);"
22           Creates a new Mouth reading from $string.
23
24   Methods
25       "$token = $mouth->readToken;"
26           Returns the next LaTeXML::Core::Token from the source.
27
28       "$boole = $mouth->hasMoreInput;"
29           Returns whether there is more data to read.
30
31       "$string = $mouth->getLocator;"
32           Return a description of current position in the source, for
33           reporting errors.
34
35       "$tokens = $mouth->readTokens;"
36           Reads all remaining tokens in the mouth, removing any trailing
37           space catcode tokens
38
39       "$lines = $mouth->readRawLine;"
40           Reads a raw (untokenized) line from $mouth, or undef if none is
41           found.
42

AUTHOR

44       Bruce Miller <bruce.miller@nist.gov>
45

47       Public domain software, produced as part of work done by the United
48       States Government & not subject to copyright in the US.
49
50
51
52perl v5.32.0                      2020-11-17           LaTeXML::Core::Mouth(3)
Impressum