uk.ac.ed.ph.snuggletex

Class SessionConfiguration

java.lang.Object

uk.ac.ed.ph.snuggletex.SessionConfiguration

All Implemented Interfaces:

Cloneable

public final class SessionConfiguration
extends Object
implements Cloneable

Specifies options for how a SnuggleSession should parse and process SnuggleInputs.

Version:

$Revision:179 $

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_EXPANSION_LIMIT

Constructor Summary

Constructors

Constructor and Description
SessionConfiguration()

Method Summary

Modifier and Type	Method and Description
Object	clone()
int	getExpansionLimit() Gets the maximum depth when expanding out user-defined commands and environments.
NumberMatcher	getNumberMatcher() Gets the NumberMatcher used to identify numbers in Math mode input.
boolean	isFailingFast() Returns whether or not the SnuggleSession will fail immediately on error, or keep going.
void	setExpansionLimit(int expansionLimit) Sets the maximum depth when expanding out user-defined commands and environments.
void	setFailingFast(boolean failingFast) Sets whether or not the SnuggleSession will fail immediately on error, or keep going.
void	setNumberMatcher(NumberMatcher numberMatcher) Sets the NumberMatcher used to identify numbers in Math mode input.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPANSION_LIMIT

public static final int DEFAULT_EXPANSION_LIMIT

See Also:

Constant Field Values

Constructor Detail

SessionConfiguration

public SessionConfiguration()

Method Detail

isFailingFast

public boolean isFailingFast()

Returns whether or not the SnuggleSession will fail immediately on error, or keep going.

Returns:

true to fail immediately, false to keep going

setFailingFast

public void setFailingFast(boolean failingFast)

Sets whether or not the SnuggleSession will fail immediately on error, or keep going.

Parameters:

failingFast - true to fail immediately, false to keep going

getExpansionLimit

public int getExpansionLimit()

Gets the maximum depth when expanding out user-defined commands and environments. This prevents possible infinite recursion issues, which are hard to detect due to the highly dynamic nature of LaTeX input.

The default value is DEFAULT_EXPANSION_LIMIT. Set this to 0 or less to disable this safeguard (and risk possible consequences, such as the stack or heap being eaten up).

Evaluating a user-defined command body, or the begin/end clause of an environment increases the current depth by 1.

setExpansionLimit

public void setExpansionLimit(int expansionLimit)

Sets the maximum depth when expanding out user-defined commands and environments. This prevents possible infinite recursion issues, which are hard to detect due to the highly dynamic nature of LaTeX input.

The default value is DEFAULT_EXPANSION_LIMIT. Set this to 0 or less to disable this safeguard (and risk possible consequences, such as the stack or heap being eaten up).

Evaluating a user-defined command body, or the begin/end clause of an environment increases the current depth by 1.

getNumberMatcher

public NumberMatcher getNumberMatcher()

Gets the NumberMatcher used to identify numbers in Math mode input. Returns null if a default SimpleNumberMatcher is being used.

Since:

1.3.0

setNumberMatcher

public void setNumberMatcher(NumberMatcher numberMatcher)

Sets the NumberMatcher used to identify numbers in Math mode input.

This may be null, which results in a default SimpleNumberMatcher being used.

Since:

1.3.0

clone

public Object clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object