uk.ac.ed.ph.snuggletex

Class SnugglePackage

java.lang.Object

uk.ac.ed.ph.snuggletex.SnugglePackage

public final class SnugglePackage
extends Object

A SnugglePackage defines a collection of BuiltinCommands, BuiltinEnvironments, and ErrorCodes/ErrorGroups that can be registered with a SnuggleEngine to add in extra functionality.

The core SnuggleTeX distribution comes with what is essentially a built-in package defined in CorePackageDefinitions which provides its core functionality.

Notes

• As of SnuggleTeX 1.3.0, an instance of this class may now be used by multiple threads.
• This replaces "DefinitionMap" from SnuggleTeX 1.0/1.1, which had fewer features.

Since:

1.2.0

Version:

$Revision:179 $

Author:

David McKain

See Also:

BuiltinCommand, BuiltinEnvironment

Field Summary

Fields

Modifier and Type	Field and Description
static InterpretableSimpleMathHandler	interpretableSimpleMathBuilder Share instance of InterpretableSimpleMathHandler since it is stateless

Constructor Summary

Constructors

Constructor and Description
SnugglePackage(String name)

Method Summary

Modifier and Type	Method and Description
BuiltinCommand	addCombinerCommand(String name, EnumSet<LaTeXMode> allowedModes, CombinerTargetMatcher combinerTargetMatcher, CommandHandler handler, TextFlowContext context)
BuiltinCommand	addCommand(BuiltinCommand command)
void	addCommandInterpretation(String name, Interpretation interpretation)
BuiltinCommand	addComplexCommand(String name, boolean allowOptionalArgument, int arguments, EnumSet<LaTeXMode> allowedModes, LaTeXMode[] argumentModes, CommandHandler handler, TextFlowContext context)
BuiltinCommand	addComplexCommandOneArg(String name, boolean allowOptionalArgument, EnumSet<LaTeXMode> allowedModes, LaTeXMode argumentMode, CommandHandler handler, TextFlowContext context)
BuiltinCommand	addComplexCommandOneArg(String name, boolean allowOptionalArgument, EnumSet<LaTeXMode> allowedModes, LaTeXMode argumentMode, Interpretation interpretation, CommandHandler handler, TextFlowContext context)
BuiltinCommand	addComplexCommandSameArgMode(String name, boolean allowOptionalArgument, int arguments, EnumSet<LaTeXMode> allowedModes, CommandHandler handler, TextFlowContext context)
BuiltinCommand	addComplexCommandSameArgMode(String name, boolean allowOptionalArgument, int arguments, EnumSet<LaTeXMode> allowedModes, Interpretation interpretation, CommandHandler handler, TextFlowContext context)
BuiltinEnvironment	addEnvironment(BuiltinEnvironment environment)
BuiltinEnvironment	addEnvironment(String name, boolean allowOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation[] interpretations, EnvironmentHandler handler, TextFlowContext context)
BuiltinEnvironment	addEnvironment(String name, boolean allowOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation interpretation, EnvironmentHandler handler, TextFlowContext context)
BuiltinEnvironment	addEnvironment(String name, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation[] interpretations, EnvironmentHandler handler, TextFlowContext context)
BuiltinEnvironment	addEnvironment(String name, EnumSet<LaTeXMode> allowedModes, LaTeXMode contentMode, Interpretation interpretation, EnvironmentHandler handler, TextFlowContext context)
void	addErrorCode(ErrorCode errorCode)
void	addErrorCodes(ErrorCode... errorCodes)
BuiltinCommand	addMathCharacterCommand(MathCharacter mathCharacter)
BuiltinCommand	addMathCharacterCommandAlias(String name, MathCharacter mathCharacter)
BuiltinCommand	addSimpleCommand(String name, EnumSet<LaTeXMode> allowedModes, CommandHandler handler, TextFlowContext context)
BuiltinCommand	addSimpleCommand(String name, EnumSet<LaTeXMode> allowedModes, Interpretation[] interpretations, CommandHandler handler, TextFlowContext context)
BuiltinCommand	addSimpleCommand(String name, EnumSet<LaTeXMode> allowedModes, Interpretation interpretation, CommandHandler handler, TextFlowContext context)
BuiltinCommand	addSimpleMathCommand(String name, MathInterpretation... interpretations)
BuiltinCommand	addSimpleMathCommand(String name, MathInterpretation[] interpretations, CommandHandler handler)
BuiltinCommand	addSimpleMathCommand(String name, MathInterpretation interpretation, CommandHandler handler)
BuiltinCommand	getBuiltinCommandByTeXName(String texName) Returns the BuiltinCommand corresponding to LaTeX command called \texName defined by this package, or null if this command is not defined.
Map<String,BuiltinCommand>	getBuiltinCommandMap() Returns a read-only Map of all BuiltinCommands defined in this package, keyed on the name texName of the command (\texName).
BuiltinEnvironment	getBuiltinEnvironmentByTeXName(String texName) Returns the BuiltinEnvironment corresponding to LaTeX environment called texName defined by this package, or null if this environment is not defined.
Map<String,BuiltinEnvironment>	getBuiltinEnvironmentMap() Returns a read-only Map of all BuiltinEnvironments defined in this package, keyed on the name of the environment.
List<ErrorCode>	getErrorCodes(ErrorGroup errorGroup) Returns an unmodifiable view of the ErrorCodes corresponding to the given ErrorGroup.
List<ErrorGroup>	getErrorGroups() Returns an unmodifiable view of all of the ErrorGroups declared for this package.
ResourceBundle	getErrorMessageBundle() Returns the ResourceBundle used to format error messages.
MathCharacter	getMathCharacter(int codePoint) Returns the MathCharacter corresponding to the Unicode character at the given input codePoint, or null if no MathCharacter is defined for this codepoint.
Map<Integer,MathCharacter>	getMathCharacterMap() Returns a read-only Map of all MathCharacters defined in this package, keyed on input Unicode code point.
String	getName() Returns the name for this package.
static boolean	isInputableTeXName(String texName) Tests whether the name of a command or environment is "inputable".
void	loadMathCharacterAliases(String resourceLocation)
void	loadMathCharacterBigLimitTargets(String resourceLocation)
void	loadMathCharacterBrackets(String resourceLocation)
void	loadMathCharacterDefinitions(String resourceLocation)
void	loadMathCharacterNegations(String resourceLocation)
void	loadMathFunctionDefinitions(String resourceLocation)
static EnumMap<InterpretationType,Interpretation>	makeInterpretationMap(Interpretation... interpretations)
static EnumMap<InterpretationType,Interpretation>	makeInterpretationMap(Interpretation interpretation)
void	setErrorMessageBundle(ResourceBundle errorMessageBundle) Sets the ResourceBundle used to format error messages.

Methods inherited from class java.lang.Object

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

Field Detail

interpretableSimpleMathBuilder

public static final InterpretableSimpleMathHandler interpretableSimpleMathBuilder

Share instance of InterpretableSimpleMathHandler since it is stateless

Constructor Detail

SnugglePackage

public SnugglePackage(String name)

Method Detail

getName

public String getName()

Returns the name for this package.

getErrorGroups

public List<ErrorGroup> getErrorGroups()

Returns an unmodifiable view of all of the ErrorGroups declared for this package.

getErrorCodes

public List<ErrorCode> getErrorCodes(ErrorGroup errorGroup)

Returns an unmodifiable view of the ErrorCodes corresponding to the given ErrorGroup.

getErrorMessageBundle

public ResourceBundle getErrorMessageBundle()

Returns the ResourceBundle used to format error messages.

setErrorMessageBundle

public void setErrorMessageBundle(ResourceBundle errorMessageBundle)

Sets the ResourceBundle used to format error messages.

getMathCharacterMap

public Map<Integer,MathCharacter> getMathCharacterMap()

Returns a read-only Map of all MathCharacters defined in this package, keyed on input Unicode code point.

getMathCharacter

public MathCharacter getMathCharacter(int codePoint)

Returns the MathCharacter corresponding to the Unicode character at the given input codePoint, or null if no MathCharacter is defined for this codepoint.

getBuiltinCommandMap

public Map<String,BuiltinCommand> getBuiltinCommandMap()

Returns a read-only Map of all BuiltinCommands defined in this package, keyed on the name texName of the command (\texName).

getBuiltinCommandByTeXName

public BuiltinCommand getBuiltinCommandByTeXName(String texName)

Returns the BuiltinCommand corresponding to LaTeX command called \texName defined by this package, or null if this command is not defined.

getBuiltinEnvironmentMap

public Map<String,BuiltinEnvironment> getBuiltinEnvironmentMap()

Returns a read-only Map of all BuiltinEnvironments defined in this package, keyed on the name of the environment.

getBuiltinEnvironmentByTeXName

public BuiltinEnvironment getBuiltinEnvironmentByTeXName(String texName)

Returns the BuiltinEnvironment corresponding to LaTeX environment called texName defined by this package, or null if this environment is not defined.

isInputableTeXName

public static boolean isInputableTeXName(String texName)

Tests whether the name of a command or environment is "inputable". Ones which cannot be directly input are enclosed in angle brackets. These commands are created during token fixing.

Parameters:

texName -

loadMathFunctionDefinitions

public void loadMathFunctionDefinitions(String resourceLocation)

loadMathCharacterDefinitions

public void loadMathCharacterDefinitions(String resourceLocation)

loadMathCharacterNegations

public void loadMathCharacterNegations(String resourceLocation)

loadMathCharacterBrackets

public void loadMathCharacterBrackets(String resourceLocation)

loadMathCharacterAliases

public void loadMathCharacterAliases(String resourceLocation)

loadMathCharacterBigLimitTargets

public void loadMathCharacterBigLimitTargets(String resourceLocation)

addSimpleCommand

public BuiltinCommand addSimpleCommand(String name,
                                       EnumSet<LaTeXMode> allowedModes,
                                       CommandHandler handler,
                                       TextFlowContext context)

addSimpleCommand

public BuiltinCommand addSimpleCommand(String name,
                                       EnumSet<LaTeXMode> allowedModes,
                                       Interpretation[] interpretations,
                                       CommandHandler handler,
                                       TextFlowContext context)

addSimpleCommand

public BuiltinCommand addSimpleCommand(String name,
                                       EnumSet<LaTeXMode> allowedModes,
                                       Interpretation interpretation,
                                       CommandHandler handler,
                                       TextFlowContext context)

addMathCharacterCommand

public BuiltinCommand addMathCharacterCommand(MathCharacter mathCharacter)

addMathCharacterCommandAlias

public BuiltinCommand addMathCharacterCommandAlias(String name,
                                                   MathCharacter mathCharacter)

addSimpleMathCommand

public BuiltinCommand addSimpleMathCommand(String name,
                                           MathInterpretation... interpretations)

addSimpleMathCommand

public BuiltinCommand addSimpleMathCommand(String name,
                                           MathInterpretation interpretation,
                                           CommandHandler handler)

addSimpleMathCommand

public BuiltinCommand addSimpleMathCommand(String name,
                                           MathInterpretation[] interpretations,
                                           CommandHandler handler)

addCombinerCommand

public BuiltinCommand addCombinerCommand(String name,
                                         EnumSet<LaTeXMode> allowedModes,
                                         CombinerTargetMatcher combinerTargetMatcher,
                                         CommandHandler handler,
                                         TextFlowContext context)

addComplexCommand

public BuiltinCommand addComplexCommand(String name,
                                        boolean allowOptionalArgument,
                                        int arguments,
                                        EnumSet<LaTeXMode> allowedModes,
                                        LaTeXMode[] argumentModes,
                                        CommandHandler handler,
                                        TextFlowContext context)

addComplexCommandSameArgMode

public BuiltinCommand addComplexCommandSameArgMode(String name,
                                                   boolean allowOptionalArgument,
                                                   int arguments,
                                                   EnumSet<LaTeXMode> allowedModes,
                                                   CommandHandler handler,
                                                   TextFlowContext context)

addComplexCommandSameArgMode

public BuiltinCommand addComplexCommandSameArgMode(String name,
                                                   boolean allowOptionalArgument,
                                                   int arguments,
                                                   EnumSet<LaTeXMode> allowedModes,
                                                   Interpretation interpretation,
                                                   CommandHandler handler,
                                                   TextFlowContext context)

addComplexCommandOneArg

public BuiltinCommand addComplexCommandOneArg(String name,
                                              boolean allowOptionalArgument,
                                              EnumSet<LaTeXMode> allowedModes,
                                              LaTeXMode argumentMode,
                                              CommandHandler handler,
                                              TextFlowContext context)

addComplexCommandOneArg

public BuiltinCommand addComplexCommandOneArg(String name,
                                              boolean allowOptionalArgument,
                                              EnumSet<LaTeXMode> allowedModes,
                                              LaTeXMode argumentMode,
                                              Interpretation interpretation,
                                              CommandHandler handler,
                                              TextFlowContext context)

addCommand

public BuiltinCommand addCommand(BuiltinCommand command)

addCommandInterpretation

public void addCommandInterpretation(String name,
                                     Interpretation interpretation)

addEnvironment

public BuiltinEnvironment addEnvironment(String name,
                                         EnumSet<LaTeXMode> allowedModes,
                                         LaTeXMode contentMode,
                                         Interpretation interpretation,
                                         EnvironmentHandler handler,
                                         TextFlowContext context)

addEnvironment

public BuiltinEnvironment addEnvironment(String name,
                                         EnumSet<LaTeXMode> allowedModes,
                                         LaTeXMode contentMode,
                                         Interpretation[] interpretations,
                                         EnvironmentHandler handler,
                                         TextFlowContext context)

addEnvironment

public BuiltinEnvironment addEnvironment(String name,
                                         boolean allowOptionalArgument,
                                         int argumentCount,
                                         EnumSet<LaTeXMode> allowedModes,
                                         LaTeXMode contentMode,
                                         Interpretation interpretation,
                                         EnvironmentHandler handler,
                                         TextFlowContext context)

addEnvironment

public BuiltinEnvironment addEnvironment(String name,
                                         boolean allowOptionalArgument,
                                         int argumentCount,
                                         EnumSet<LaTeXMode> allowedModes,
                                         LaTeXMode contentMode,
                                         Interpretation[] interpretations,
                                         EnvironmentHandler handler,
                                         TextFlowContext context)

addEnvironment

public BuiltinEnvironment addEnvironment(BuiltinEnvironment environment)

addErrorCode

public void addErrorCode(ErrorCode errorCode)

addErrorCodes

public void addErrorCodes(ErrorCode... errorCodes)

makeInterpretationMap

public static EnumMap<InterpretationType,Interpretation> makeInterpretationMap(Interpretation interpretation)

makeInterpretationMap

public static EnumMap<InterpretationType,Interpretation> makeInterpretationMap(Interpretation... interpretations)