| Package | Description |
|---|---|
| uk.ac.ed.ph.snuggletex |
Public API Package - almost all of the classes you will need for normal SnuggleTeX
use are contained in here.
|
| uk.ac.ed.ph.snuggletex.dombuilding |
Contains handler classes for building DOM tree branches for various commands and environments.
|
| 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.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SnuggleSession.registerError(InputError inputError)
Records a new error, throwing a
SnuggleParseException if
the current SessionConfiguration deems that we should
fail on the first error. |
| Modifier and Type | Method and Description |
|---|---|
protected void |
AbstractCustomXMLElementHandler.buildCustomElement(DOMBuilder builder,
Element parentElement,
ArgumentContainerToken attrsToken,
ArgumentContainerToken namespaceToken,
ArgumentContainerToken qNameToken,
ArgumentContainerToken contentToken) |
String |
HSpaceHandler.convertLaTeXSize(DOMBuilder builder,
Element parentElement,
Token sizeToken) |
void |
XMLUnparseHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
XMLNameOrIdHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
XMLAttrHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
UnitsHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
TextHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
TextClassHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
TagHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
TabularHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token)
The command matched here is
\\hline. |
void |
SimpleXHTMLContainerBuildingHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
SetVarHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
ParagraphHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
MrowHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
ModeDelegatingHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
MathVariantMapHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
MathUnderOrOverHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
MathRootHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
MathLimitsHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
MathComplexCommandHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
LiteralHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
ListEnvironmentHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken itemToken) |
void |
InsertUnicodeHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
HSpaceHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
HrefHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
GetVarHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
EnsureMathHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
CommandHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token)
Called when a
CommandToken is being handled by the DOMBuilder. |
void |
BoxHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
AnchorHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
AccentHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
AbstractCustomXMLElementHandler.handleCommand(DOMBuilder builder,
Element parentElement,
CommandToken token) |
void |
AccentHandler.handleCommandMathMode(DOMBuilder builder,
Element parentElement,
CommandToken token)
Handles accents in MATH mode.
|
void |
AccentHandler.handleCommandTextMode(DOMBuilder builder,
Element parentElement,
CommandToken token)
LaTeX only adds an accent to the first character of the first token, and only if it is
text.
|
protected void |
SimpleXHTMLContainerBuildingHandler.handleContent(DOMBuilder builder,
Element parentElement,
ArgumentContainerToken contentToken) |
void |
XMLUnparseHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
void |
TabularHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
void |
StyleHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
void |
SimpleXHTMLContainerBuildingHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
void |
MatrixHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
void |
MathFenceHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
void |
MathEnvironmentHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
void |
ListEnvironmentHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token)
Builds the actual List environment
|
void |
EqnArrayHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
void |
EnvironmentHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token)
Called when a
CommandToken is being handled by the DOMBuilder. |
void |
ArrayHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
void |
AlignHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
void |
AbstractCustomXMLElementHandler.handleEnvironment(DOMBuilder builder,
Element parentElement,
EnvironmentToken token) |
| Modifier and Type | Method and Description |
|---|---|
Element |
DOMBuilder.appendOrThrowError(Element parentElement,
Token token,
ErrorCode errorCode,
Object... arguments) |
void |
DOMBuildingController.buildDOMSubtree(Element targetRoot,
List<FlowToken> fixedTokens) |
void |
DOMBuilder.buildDOMSubtree(List<FlowToken> fixedTokens)
This is the external entry point used by
SnuggleSession only. |
void |
DOMBuilder.buildMathElement(Element parentElement,
Token token,
ArgumentContainerToken mathContentToken,
boolean isDisplayMath)
Builds a MathML
math element for the given Token token, using contentToken
to provide the content, descending into child Nodes as normal. |
void |
DOMBuilder.buildMathElement(Element parentElement,
Token token,
ArgumentContainerToken mathContentToken,
boolean isDisplayMath,
DOMBuilder.MathContentBuilderCallback mathContentBuilderCallback)
Builds a MathML
math element for the given Token token, using contentToken
to provide the content, using the given DOMBuilder.MathContentBuilderCallback to
supply the content. |
void |
DOMBuilder.MathContentBuilderCallback.buildMathElementContent(Element contentContainerElement,
ArgumentContainerToken mathContentToken,
boolean isAnnotated) |
Document |
WebPageBuilder.buildWebPage(List<FlowToken> fixedTokens) |
String |
WebPageBuilder.buildWebPageString(List<FlowToken> fixedTokens) |
WorkingDocument |
SnuggleInputReader.createWorkingDocument() |
void |
StyleEvaluator.evaluateStyles(RootToken rootToken) |
NodeList |
DOMBuilder.extractNodeListValue(ArgumentContainerToken token) |
String |
DOMBuilder.extractStringValue(ArgumentContainerToken token)
This "converts" the given token to a String by performing
{
DOMBuilder.handleTokens(Element, ArgumentContainerToken, boolean)}
with a fake root element and then extracting the String value of the resulting Text Node(s). |
void |
TokenFixer.fixTokenTree(RootToken rootToken) |
void |
DOMBuilder.handleMathTokensAsSingleElement(Element parentElement,
ArgumentContainerToken containerToken) |
void |
DOMBuilder.handleMathTokensAsSingleElement(Element parentElement,
List<FlowToken> tokens) |
void |
DOMBuilder.handleToken(Element parentElement,
FlowToken token)
Creates a single Node from the given token.
|
void |
DOMBuilder.handleTokens(Element parentElement,
ArgumentContainerToken containerToken,
boolean trimWhitespace) |
void |
DOMBuilder.handleTokens(Element parentElement,
List<FlowToken> siblingTokens,
boolean trimWhitespace) |
void |
SessionContext.registerError(InputError error) |
URI |
DOMBuilder.resolveLink(Element parentElement,
Token token,
String rawHref) |
RootToken |
LaTeXTokeniser.tokenise(SnuggleInputReader reader)
Tokenises the input specified by the given
SnuggleInputReader, returning an
ArgumentContainerToken containing the roots of the parsed token tree. |
URI |
DOMBuilder.validateURI(Element parentElement,
Token token,
String rawURI)
Checks the given raw URI to ensure that it is valid, returning a
URI Object if
valid or null if not. |
String |
DOMBuilder.validateXMLId(Element parentElement,
Token nameToken,
String rawName)
Checks the given XML Name as in
DOMBuilder.validateXMLName(Element, Token, String), additionally
checking that an ID of the same name is not already in use in the output DOM. |
String |
DOMBuilder.validateXMLName(Element parentElement,
Token nameToken,
String rawName)
Checks the given raw XML Name to ensure that it confirms to the correct syntax, returning
it unchanged if successful.
|
void |
WebPageBuilder.writeWebPage(List<FlowToken> fixedTokens,
Object contentTypeSettable,
OutputStream outputStream,
SnuggleSession.EndOutputAction endOutputOptions)
Creates a web page representing the given (fixed) Tokens, and writes the results to
the given
OutputStream. |
Copyright © 2008–2026 The University of Edinburgh. All rights reserved.