uk.ac.ed.ph.snuggletex.internal

Class LaTeXTokeniser

java.lang.Object

uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser

public final class LaTeXTokeniser
extends Object

This class reads in SnuggleTeX input and builds a tree of literal parsed Tokens.

This is probably the most complex class in SnuggleTeX!

Version:

$Revision$

Author:

David McKain

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LaTeXTokeniser.ModeState Trivial "struct" encapsulating information about the state of a tokenisation mode.
static class	LaTeXTokeniser.PatternTerminator This implementation of Terminator represents terminators specified as regular expressions.
static class	LaTeXTokeniser.StringTerminator This implementation of Terminator is used to handle fixed Strings as terminators.
static interface	LaTeXTokeniser.Terminator Represents the "terminator" characters that signify the end of a parsing mode.
static class	LaTeXTokeniser.TokenisationMode Enumeration of the various "tokenisation modes" we will be running in.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	reservedCommands Set of reserved commands.

Constructor Summary

Constructors

Constructor and Description
LaTeXTokeniser(SessionContext sessionContext)

Method Summary

Modifier and Type	Method and Description
void	reset() Resets the parsing state of this tokeniser.
RootToken	tokenise(SnuggleInputReader reader) Tokenises the input specified by the given SnuggleInputReader, returning an ArgumentContainerToken containing the roots of the parsed token tree.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

reservedCommands

public static final Set<String> reservedCommands

Set of reserved commands. These cannot be redefined and are not all listed in CorePackageDefinitions.

Constructor Detail

LaTeXTokeniser

public LaTeXTokeniser(SessionContext sessionContext)

Method Detail

reset

public void reset()

Resets the parsing state of this tokeniser.

tokenise

public RootToken tokenise(SnuggleInputReader reader)
                   throws SnuggleParseException,
                          IOException

Tokenises the input specified by the given SnuggleInputReader, returning an ArgumentContainerToken containing the roots of the parsed token tree.

Throws:

SnuggleParseException

IOException