uk.ac.ed.ph.snuggletex.definitions

Class BuiltinCommand

java.lang.Object

uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand

All Implemented Interfaces:

Command, CommandOrEnvironment

public final class BuiltinCommand
extends Object
implements Command

Represents a Command that has been defined internally via a SnugglePackage.

All of the core LaTeX macros have been defined in this way - see CorePackageDefinitions.

Version:

$Revision:179 $

Author:

David McKain

See Also:

BuiltinEnvironment, CorePackageDefinitions

Field Summary

Fields

Modifier and Type	Field and Description
protected EnumSet<LaTeXMode>	allowedModes
protected boolean	allowingOptionalArgument
protected int	argumentCount
protected H	domBuildingHandler
protected EnumMap<InterpretationType,Interpretation>	interpretationMap
protected String	texName
protected TextFlowContext	textFlowContext

Constructor Summary

Constructors

Constructor and Description
BuiltinCommand(String texName, CommandType commandType, boolean allowingOptionalArgument, int argumentCount, EnumSet<LaTeXMode> allowedModes, LaTeXMode[] argumentModes, EnumMap<InterpretationType,Interpretation> interpretations, CommandHandler domBuilderHandler, TextFlowContext textFlowContext, CombinerTargetMatcher combinerTargetMatcher)

Method Summary

Modifier and Type	Method and Description
EnumSet<LaTeXMode>	getAllowedModes()
int	getArgumentCount() Returns the number of mandatory arguments this command expects, which will be zero or greater.
LaTeXMode	getArgumentMode(int argumentIndex) Returns the LaTeX mode that each argument should be parsed in, starting with the optional argument (if used) and then each mandatory argument in order.
CombinerTargetMatcher	getCombinerTargetMatcher()
H	getDOMBuildingHandler()
Interpretation	getInterpretation(InterpretationType type)
EnumMap<InterpretationType,Interpretation>	getInterpretationMap()
MathCharacter	getMathCharacter()
int	getMathCharacterCodePoint()
String	getTeXName() Returns the TeX name for this command or environment.
TextFlowContext	getTextFlowContext()
CommandType	getType()
boolean	hasInterpretation(InterpretationType type)
boolean	isAllowingOptionalArgument() Returns whether this command/environment takes an optional argument.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment

getArgumentCount, getTeXName, isAllowingOptionalArgument

Field Detail

texName

protected final String texName

allowingOptionalArgument

protected final boolean allowingOptionalArgument

argumentCount

protected final int argumentCount

allowedModes

protected final EnumSet<LaTeXMode> allowedModes

interpretationMap

protected final EnumMap<InterpretationType,Interpretation> interpretationMap

textFlowContext

protected final TextFlowContext textFlowContext

domBuildingHandler

protected final H domBuildingHandler

Constructor Detail

BuiltinCommand

public BuiltinCommand(String texName,
                      CommandType commandType,
                      boolean allowingOptionalArgument,
                      int argumentCount,
                      EnumSet<LaTeXMode> allowedModes,
                      LaTeXMode[] argumentModes,
                      EnumMap<InterpretationType,Interpretation> interpretations,
                      CommandHandler domBuilderHandler,
                      TextFlowContext textFlowContext,
                      CombinerTargetMatcher combinerTargetMatcher)

Method Detail

getType

public CommandType getType()

getArgumentMode

public LaTeXMode getArgumentMode(int argumentIndex)

Description copied from interface: CommandOrEnvironment

Returns the LaTeX mode that each argument should be parsed in, starting with the optional argument (if used) and then each mandatory argument in order. Null entries indicate that the current LaTeX mode should be used.

Specified by:

getArgumentMode in interface CommandOrEnvironment

getCombinerTargetMatcher

public CombinerTargetMatcher getCombinerTargetMatcher()

getMathCharacter

public MathCharacter getMathCharacter()

getMathCharacterCodePoint

public int getMathCharacterCodePoint()

getTeXName

public String getTeXName()

Description copied from interface: CommandOrEnvironment

Returns the TeX name for this command or environment. (In the case of commands, this does not include the leading backslash.)

Specified by:

getTeXName in interface CommandOrEnvironment

isAllowingOptionalArgument

public boolean isAllowingOptionalArgument()

Description copied from interface: CommandOrEnvironment

Returns whether this command/environment takes an optional argument. As per LaTeX convention, this will only return true if the command/environment takes at least one mandatory argument as well.

Specified by:

isAllowingOptionalArgument in interface CommandOrEnvironment

getArgumentCount

public int getArgumentCount()

Description copied from interface: CommandOrEnvironment

Returns the number of mandatory arguments this command expects, which will be zero or greater.

Specified by:

getArgumentCount in interface CommandOrEnvironment

getAllowedModes

public EnumSet<LaTeXMode> getAllowedModes()

getInterpretationMap

public EnumMap<InterpretationType,Interpretation> getInterpretationMap()

hasInterpretation

public boolean hasInterpretation(InterpretationType type)

getInterpretation

public Interpretation getInterpretation(InterpretationType type)

getTextFlowContext

public TextFlowContext getTextFlowContext()

getDOMBuildingHandler

public H getDOMBuildingHandler()

toString

public final String toString()

Overrides:

toString in class Object