Top Interfaces Classes Enums

module snuggletex.core

Package uk.ac.ed.ph.snuggletex

Interface Summary

Modifier and Type	Interface and Description
public interface	DOMPostProcessor This interface allows you to hook into the SnuggleTeX process immediately after the raw DOM tree has been built.
public interface	ErrorCode Interface representing a code for an Error caused by client input.
public interface	ErrorGroup Interface representing a grouping for a set of related `ErrorCode`s.
public interface	InputContext Read-only view of the current document being parsed, which will change shape as user-defined macros and environments are being expanded.
public interface	LinkResolver This interface allows clients to have control over handling any hypertext links encountered in commands like `HrefHandler`, making it possible to remap links as required.
public interface	NumberMatcher Interface for classes which identify numbers in Math mode input.
public interface	SerializationSpecifier Interface specifying various options for serializing XML produced by SnuggleTeX and some of its utility classes.
public interface	SnuggleConstants Public SnuggleTeX-related constants.

Class Summary

Modifier and Type	Class and Description
public class	DecimalFormatNumberMatcher Implementation of `NumberMatcher` that uses a standard Java `DecimalFormat` to match numbers.
public class	DOMOutputOptions This class is used to specify how you want DOM trees to be built when calling relevant methods in `SnuggleSession` (e.g. `SnuggleSession#buildDOMSubtree(org.w3c.dom.Element)`
public class	DownConvertingPostProcessor Trivial implementation of `DOMPostProcessor` that hooks into the `MathMLDownConverter`.
public class	InputError Encapsulates an error in the LaTeX input, providing information about what the error is and where it occurred.
public class	SessionConfiguration Specifies options for how a `SnuggleSession` should parse and process `SnuggleInput`s.
public class	SimpleNumberMatcher Very basic but fast implementation of `NumberMatcher` that handles western-style numeric characters, supporting Locale-specific decimal points.
public class	SnuggleEngine This is the main entry point into SnuggleTeX.
public class	SnuggleInput Simple container for an input into SnuggleTeX.
public class	SnuggleLogicException This `RuntimeException` is thrown if SnuggleTeX has detected something amiss with its logic.
public class	SnugglePackage A `SnugglePackage` defines a collection of `BuiltinCommand`s, `BuiltinEnvironment`s, and `ErrorCode`s/`ErrorGroup`s that can be registered with a `SnuggleEngine` to add in extra functionality.
public class	SnuggleRuntimeException This `RuntimeException` is used to indicate a problem within SnuggleTeX which is due to a mis-configuration of SnuggleTeX, rather than a problem with client input or bad logic within SnuggleTeX.
public class	SnuggleSession This represents a single "job" for SnuggleTeX.
public class	SnuggleSimpleMathRunner FIXME: Document this type!
public class	SnuggleSnapshot A partial result of parsing one or more `SnuggleInput`s by a `SnuggleSession`, created via `SnuggleSession#createSnapshot()`.
public class	WebPageOutputOptions Builds on `XMLStringOutputOptions` to add in options for configuring how to build a web page using the relevant methods in `SnuggleSession` (e.g. `SnuggleSession#buildWebPage(WebPageOutputOptions)`).
public class	WebPageOutputOptionsBuilder Utility class that creates pre-configured and usable `WebPageOutputOptions` instances for various common scenarios.
public class	WebPageOutputOptionsTemplates Deprecated As of SnuggleTeX 1.3.0, use `WebPageOutputOptionsBuilder`. This class will be removed in SnuggleTeX 1.4. Utility class that creates pre-configured and usable `WebPageOutputOptions` instances for the various types of `WebPageType`s supported by SnuggleTeX.
public class	XMLStringOutputOptions Builds on `DOMOutputOptions` to add in options for configuring how to build an serialized output consisting of an XML (or possibly HTML) String using the relevant methods in `SnuggleSession` (e.g. `SnuggleSession#buildXMLString(XMLStringOutputOptions)`).

Enum Summary

Modifier and Type	Enum and Description
public enum	SerializationMethod Enumerates the XML serialization methods available.