Package uk.ac.ed.ph.snuggletex.internal

This package contains the guts of SnuggleTeX; classes here are responsible for the parsing process, token fixing and DOM/web building.

See: Description

Interface Summary

Interface	Description
DOMBuilder.MathContentBuilderCallback	Internal callback interface that specifies how to build the real content of a MathML element.
LaTeXTokeniser.Terminator	Represents the "terminator" characters that signify the end of a parsing mode.
SessionContext	Provides access to session-related Objects used during the various parts of the snuggle process.
WorkingDocument.SourceContext	Marker interface that can be applied to classes that provide information for a WorkingDocument.CharacterSource.

Class Summary

Class	Description
DOMBuilder	This takes a List of (fixed) Tokens and builds a (raw) XHTML + MathML DOM tree branch from them.
DOMBuildingController	This is the main entry point into the DOM generation process.
FrozenSlice	Represents a finished "segment" of text in the WorkingDocument.
LaTeXTokeniser	This class reads in SnuggleTeX input and builds a tree of literal parsed Tokens.
LaTeXTokeniser.ModeState	Trivial "struct" encapsulating information about the state of a tokenisation mode.
LaTeXTokeniser.PatternTerminator	This implementation of Terminator represents terminators specified as regular expressions.
LaTeXTokeniser.StringTerminator	This implementation of Terminator is used to handle fixed Strings as terminators.
SnuggleInputReader	Helper class that does the job of taking a SnuggleInput, checking its contents for allowed Unicode characters, working out how to map absolute offsets into (line,column) pairs and producing a WorkingDocument for later use.
StyleEvaluator	This calculates the ComputedStyle for each raw parsed Token.
StyleRebuilder	This runs after TokenFixer and groups style changes together using the pseudo-environment CorePackageDefinitions.ENV_STYLE, which makes DOM building much easier.
TokenFixer	This takes the parse tree after StyleEvaluator has run and performs grouping operations on the FlowTokens to convert them to a more tree-like structure that is easier to handle.
VariableManager	Manages the values of user-defined variables.
WebPageBuilder	Builds a web page from a List of fixed FlowTokens, using the supplied WebPageOutputOptions to determine the exact form of the results.
WorkingDocument	Represents the "working view" of the current SnuggleInput document.
WorkingDocument.CharacterSource	Represents a block of text that has been imported into this document.
WorkingDocument.IndexResolution	Holds information about how a particular index in the document is resolved against the WorkingDocument.Slice in which it is contained.
WorkingDocument.Slice	Represents a contiguous portion of the document hat comes from the same WorkingDocument.CharacterSource.
WorkingDocument.SubstitutionContext	Implementation of WorkingDocument.SourceContext that represents the result of a substitution.

Enum Summary

Enum	Description
DOMBuilder.OutputContext	Trivial enumeration to keep track of where we are in the outgoing DOM.
LaTeXTokeniser.TokenisationMode	Enumeration of the various "tokenisation modes" we will be running in.

Exception Summary

Exception	Description
SnuggleParseException	Internal Exception thrown by SnuggleSession.registerError(InputError) when a parsing error occurs and the client has requested immediate failure in such circumstances.

Package uk.ac.ed.ph.snuggletex.internal Description

This package contains the guts of SnuggleTeX; classes here are responsible for the parsing process, token fixing and DOM/web building.