Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	WorkingDocument.CharacterSource Represents a block of text that has been imported into this document.
public static class	WorkingDocument.IndexResolution Holds information about how a particular index in the document is resolved against the `Slice` in which it is contained.
public static class	WorkingDocument.Slice Represents a contiguous portion of the document hat comes from the same `CharacterSource`.
public static interface	WorkingDocument.SourceContext Marker interface that can be applied to classes that provide information for a `CharacterSource`.
public static class	WorkingDocument.SubstitutionContext Implementation of `SourceContext` that represents the result of a substitution.

Field Summary

Modifier and Type	Field and Description
private final StringBuilder	buffer
private int	freezeIndex
private final SnuggleInput	input
pack-priv int	lastResolvedSliceIndex Index in scoreboard of last successful resolution used in `resolveIndex(int, boolean)` below
private int	length Current length of document (this is kept in sync with buffer.length())
private final List<WorkingDocument.Slice>	scoreBoard

Access	Constructor and Description
pack-priv	WorkingDocument(final CharSequence initialData, final SnuggleInputReader inputReader)

Method Summary

Modifier and Type	Method and Description
public int	charAt(final int index) Implements uk.ac.ed.ph.snuggletex.InputContext.charAt. Returns the character at the given index in the input document, or -1 if the index is not contained within the document.
private void	checkIndex(final int index, final String errorStart)
private void	checkRange(final int startIndex, final int endIndex)
public void	dumpScoreboard()
public CharSequence	extract() Implements uk.ac.ed.ph.snuggletex.InputContext.extract. Extracts a copy of the current entire content of the input as a `CharSequence`
public CharSequence	extract(final int startIndex, final int endIndex) Implements uk.ac.ed.ph.snuggletex.InputContext.extract. Extracts a copy of a slice of the current entire content of the input as a `CharSequence`, including all characters with startIndex <= index < endIndex.
public FrozenSlice	freezeSlice(final int startIndex, final int endIndex)
public SnuggleInput	getInput() Implements uk.ac.ed.ph.snuggletex.InputContext.getInput. Accesses the underlying `SnuggleInput`
public int	getSubstitutionDepth(final int index)
public int	indexOf(final int startSearchIndex, final char c) Implements uk.ac.ed.ph.snuggletex.InputContext.indexOf. Returns the first index of the given character, starting the search at the given index.
public int	indexOf(final int startSearchIndex, final String s) Implements uk.ac.ed.ph.snuggletex.InputContext.indexOf. Returns the first index of the given String, starting the search at the given index.
public boolean	isRegionWhitespace(final int startIndex, final int endIndex) Implements uk.ac.ed.ph.snuggletex.InputContext.isRegionWhitespace. Tests whether all characters in the document with index satisfying startIndex <= index < endIndex are whitespace.
public int	length() Implements uk.ac.ed.ph.snuggletex.InputContext.length. Current length of this input
public boolean	matchesAt(final int index, final char c) Implements uk.ac.ed.ph.snuggletex.InputContext.matchesAt. Tests whether the character at the given index is equal to that specified.
public boolean	matchesAt(final int index, final String s) Implements uk.ac.ed.ph.snuggletex.InputContext.matchesAt. Tests whether the characters at the given index are equal to the String specified.
public WorkingDocument.IndexResolution	resolveIndex(final int index, final boolean fallLeftOnBoundaries)
public WorkingDocument.CharacterSource	substitute(final int startIndex, final int endIndex, final CharSequence replacement)
public void	unfreeze(final int newFreezeIndex) This is a rather nasty method which resets the "freeze index" of this document back to the given index.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

buffer	back to summary
private final StringBuilder buffer

freezeIndex	back to summary
private int freezeIndex

input	back to summary
private final SnuggleInput input

lastResolvedSliceIndex	back to summary
pack-priv int lastResolvedSliceIndex Index in scoreboard of last successful resolution used in `resolveIndex(int, boolean)` below

length	back to summary
private int length Current length of document (this is kept in sync with buffer.length())

scoreBoard	back to summary
private final List<WorkingDocument.Slice> scoreBoard

Constructor Detail

WorkingDocument	back to summary
pack-priv WorkingDocument(final CharSequence initialData, final SnuggleInputReader inputReader)

Method Detail

charAt	back to summary
public int charAt(final int index) Implements uk.ac.ed.ph.snuggletex.InputContext.charAt. Doc from uk.ac.ed.ph.snuggletex.InputContext.charAt. Returns the character at the given index in the input document, or -1 if the index is not contained within the document.

charAt

back to summary

public int charAt(final int index)

Implements uk.ac.ed.ph.snuggletex.InputContext.charAt.

Doc from uk.ac.ed.ph.snuggletex.InputContext.charAt.

Returns the character at the given index in the input document, or -1 if the index is not contained within the document.

checkIndex	back to summary
private void checkIndex(final int index, final String errorStart)

checkRange	back to summary
private void checkRange(final int startIndex, final int endIndex)

dumpScoreboard	back to summary
public void dumpScoreboard()

extract back to summary

extract	back to summary
public CharSequence extract() Implements uk.ac.ed.ph.snuggletex.InputContext.extract. Doc from uk.ac.ed.ph.snuggletex.InputContext.extract. Extracts a copy of the current entire content of the input as a `CharSequence`

public CharSequence extract()

Implements uk.ac.ed.ph.snuggletex.InputContext.extract.

Doc from uk.ac.ed.ph.snuggletex.InputContext.extract.

Extracts a copy of the current entire content of the input as a CharSequence

extract back to summary

extract	back to summary
public CharSequence extract(final int startIndex, final int endIndex) Implements uk.ac.ed.ph.snuggletex.InputContext.extract. Doc from uk.ac.ed.ph.snuggletex.InputContext.extract. Extracts a copy of a slice of the current entire content of the input as a `CharSequence`, including all characters with startIndex <= index < endIndex.

public CharSequence extract(final int startIndex, final int endIndex)

Implements uk.ac.ed.ph.snuggletex.InputContext.extract.

Doc from uk.ac.ed.ph.snuggletex.InputContext.extract.

Extracts a copy of a slice of the current entire content of the input as a CharSequence, including all characters with startIndex <= index < endIndex.

freezeSlice	back to summary
public FrozenSlice freezeSlice(final int startIndex, final int endIndex)

getInput back to summary

getInput	back to summary
public SnuggleInput getInput() Implements uk.ac.ed.ph.snuggletex.InputContext.getInput. Doc from uk.ac.ed.ph.snuggletex.InputContext.getInput. Accesses the underlying `SnuggleInput`

public SnuggleInput getInput()

Implements uk.ac.ed.ph.snuggletex.InputContext.getInput.

Doc from uk.ac.ed.ph.snuggletex.InputContext.getInput.

Accesses the underlying SnuggleInput

getSubstitutionDepth	back to summary
public int getSubstitutionDepth(final int index)

indexOf	back to summary
public int indexOf(final int startSearchIndex, final char c) Implements uk.ac.ed.ph.snuggletex.InputContext.indexOf. Doc from uk.ac.ed.ph.snuggletex.InputContext.indexOf. Returns the first index of the given character, starting the search at the given index. Returns -1 if not found.

indexOf

back to summary

public int indexOf(final int startSearchIndex, final char c)

Implements uk.ac.ed.ph.snuggletex.InputContext.indexOf.

Doc from uk.ac.ed.ph.snuggletex.InputContext.indexOf.

Returns the first index of the given character, starting the search at the given index. Returns -1 if not found.

indexOf	back to summary
public int indexOf(final int startSearchIndex, final String s) Implements uk.ac.ed.ph.snuggletex.InputContext.indexOf. Doc from uk.ac.ed.ph.snuggletex.InputContext.indexOf. Returns the first index of the given String, starting the search at the given index. Returns -1 if not found.

indexOf

back to summary

public int indexOf(final int startSearchIndex, final String s)

Implements uk.ac.ed.ph.snuggletex.InputContext.indexOf.

Doc from uk.ac.ed.ph.snuggletex.InputContext.indexOf.

Returns the first index of the given String, starting the search at the given index. Returns -1 if not found.

isRegionWhitespace	back to summary
public boolean isRegionWhitespace(final int startIndex, final int endIndex) Implements uk.ac.ed.ph.snuggletex.InputContext.isRegionWhitespace. Doc from uk.ac.ed.ph.snuggletex.InputContext.isRegionWhitespace. Tests whether all characters in the document with index satisfying startIndex <= index < endIndex are whitespace.

isRegionWhitespace

back to summary

public boolean isRegionWhitespace(final int startIndex, final int endIndex)

Implements uk.ac.ed.ph.snuggletex.InputContext.isRegionWhitespace.

Doc from uk.ac.ed.ph.snuggletex.InputContext.isRegionWhitespace.

Tests whether all characters in the document with index satisfying startIndex <= index < endIndex are whitespace.

length	back to summary
public int length() Implements uk.ac.ed.ph.snuggletex.InputContext.length. Doc from uk.ac.ed.ph.snuggletex.InputContext.length. Current length of this input

length

back to summary

public int length()

Implements uk.ac.ed.ph.snuggletex.InputContext.length.

Doc from uk.ac.ed.ph.snuggletex.InputContext.length.

Current length of this input

matchesAt	back to summary
public boolean matchesAt(final int index, final char c) Implements uk.ac.ed.ph.snuggletex.InputContext.matchesAt. Doc from uk.ac.ed.ph.snuggletex.InputContext.matchesAt. Tests whether the character at the given index is equal to that specified.

matchesAt

back to summary

public boolean matchesAt(final int index, final char c)

Implements uk.ac.ed.ph.snuggletex.InputContext.matchesAt.

Doc from uk.ac.ed.ph.snuggletex.InputContext.matchesAt.

Tests whether the character at the given index is equal to that specified.

matchesAt	back to summary
public boolean matchesAt(final int index, final String s) Implements uk.ac.ed.ph.snuggletex.InputContext.matchesAt. Doc from uk.ac.ed.ph.snuggletex.InputContext.matchesAt. Tests whether the characters at the given index are equal to the String specified.

matchesAt

back to summary

public boolean matchesAt(final int index, final String s)

Implements uk.ac.ed.ph.snuggletex.InputContext.matchesAt.

Doc from uk.ac.ed.ph.snuggletex.InputContext.matchesAt.

Tests whether the characters at the given index are equal to the String specified.

resolveIndex	back to summary
public WorkingDocument.IndexResolution resolveIndex(final int index, final boolean fallLeftOnBoundaries)

substitute	back to summary
public WorkingDocument.CharacterSource substitute(final int startIndex, final int endIndex, final CharSequence replacement)

unfreeze back to summary

unfreeze	back to summary
public void unfreeze(final int newFreezeIndex) This is a rather nasty method which resets the "freeze index" of this document back to the given index. Any `FrozenSlice`s that may previously have spanned this index are no longer valid as their contents may change. This class does NOT attempt to enforce this in any way - it is up to the caller to make sure he/she understands the implications of doing this. The main requirement for having this is when evaluating single-argument user-defined commands like `\\udc \\alpha` where the argument is implicitly taken to be the next valid token.

public void unfreeze(final int newFreezeIndex)

This is a rather nasty method which resets the "freeze index" of this document back to the given index. Any FrozenSlices that may previously have spanned this index are no longer valid as their contents may change.

This class does NOT attempt to enforce this in any way - it is up to the caller to make sure he/she understands the implications of doing this.

The main requirement for having this is when evaluating single-argument user-defined commands like \\udc \\alpha where the argument is implicitly taken to be the next valid token.

uk.ac.ed.ph.snuggletex.internal back to summary

public final Class WorkingDocument.CharacterSource

Class Inheritance

extends Object

java.lang.Object
uk.ac.ed.ph.snuggletex.internal.WorkingDocument.CharacterSource

Represents a block of text that has been imported into this document.

Field Summary

Modifier and Type	Field and Description
public final WorkingDocument.SourceContext	context Contextual information about where this data came from
private transient String	stringRepresentation
public final WorkingDocument.CharacterSource	substitutedSource The block that this block was initially substituted into, or null to indicate that it is "top level" or was appended rather than substituted.
public final CharSequence	substitutedText The text in the parent component that this data replaced, or null if `substitutedSource` is null.
public final int	substitutionOffset The offset in `substitutedSource` where the substitution occurred, or 0 if `substitutedSource` is null.

Constructor Summary

Access	Constructor and Description
public	CharacterSource(final WorkingDocument.SourceContext context)
public	CharacterSource(final WorkingDocument.SourceContext context, final WorkingDocument.CharacterSource substitutedSource, final int substitutionOffset, final CharSequence substitutedText)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

context	back to summary
public final WorkingDocument.SourceContext context Contextual information about where this data came from

stringRepresentation	back to summary
private transient String stringRepresentation

substitutedSource	back to summary
public final WorkingDocument.CharacterSource substitutedSource The block that this block was initially substituted into, or null to indicate that it is "top level" or was appended rather than substituted.

substitutedText	back to summary
public final CharSequence substitutedText The text in the parent component that this data replaced, or null if `substitutedSource` is null.

substitutionOffset	back to summary
public final int substitutionOffset The offset in `substitutedSource` where the substitution occurred, or 0 if `substitutedSource` is null.

Constructor Detail

CharacterSource	back to summary
public CharacterSource(final WorkingDocument.SourceContext context)

CharacterSource	back to summary
public CharacterSource(final WorkingDocument.SourceContext context, final WorkingDocument.CharacterSource substitutedSource, final int substitutionOffset, final CharSequence substitutedText)

Method Detail

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

uk.ac.ed.ph.snuggletex.internal back to summary

public Class WorkingDocument.IndexResolution

Class Inheritance

extends Object

java.lang.Object
uk.ac.ed.ph.snuggletex.internal.WorkingDocument.IndexResolution

Holds information about how a particular index in the document is resolved against the Slice in which it is contained.

Author: David McKain
Version: $Revision$

Field Summary

Modifier and Type	Field and Description
public final int	indexInComponent
public final int	scoreboardIndex
public final WorkingDocument.Slice	slice

Constructor Summary

Access	Constructor and Description
public	IndexResolution(final int scoreboardIndex, final WorkingDocument.Slice slice, final int indexInComponent)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

indexInComponent	back to summary
public final int indexInComponent

scoreboardIndex	back to summary
public final int scoreboardIndex

slice	back to summary
public final WorkingDocument.Slice slice

Constructor Detail

IndexResolution	back to summary
public IndexResolution(final int scoreboardIndex, final WorkingDocument.Slice slice, final int indexInComponent)

Method Detail

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

uk.ac.ed.ph.snuggletex.internal back to summary

public final Class WorkingDocument.Slice

Class Inheritance

extends Object

java.lang.Object
uk.ac.ed.ph.snuggletex.internal.WorkingDocument.Slice

Represents a contiguous portion of the document hat comes from the same CharacterSource. During parsing, Slices will be broken up to create new Slices whenever user-defined commands and environments are substituted.

Field Summary

Modifier and Type	Field and Description
public final int	componentIndexOffset
public final int	endIndex
public final WorkingDocument.CharacterSource	resolvedComponent
public final int	startIndex

Constructor Summary

Access	Constructor and Description
public	Slice(final int startIndex, final int endIndex, final WorkingDocument.CharacterSource resolvedComponent, final int componentIndexOffset)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

componentIndexOffset	back to summary
public final int componentIndexOffset

endIndex	back to summary
public final int endIndex

resolvedComponent	back to summary
public final WorkingDocument.CharacterSource resolvedComponent

startIndex	back to summary
public final int startIndex

Constructor Detail

Slice	back to summary
public Slice(final int startIndex, final int endIndex, final WorkingDocument.CharacterSource resolvedComponent, final int componentIndexOffset)

Method Detail

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

uk.ac.ed.ph.snuggletex.internal back to summary

public Interface WorkingDocument.SourceContext

Known Direct Implementers: uk.ac.ed.ph.snuggletex.internal.WorkingDocument.SubstitutionContext, uk.ac.ed.ph.snuggletex.internal.SnuggleInputReader

Marker interface that can be applied to classes that provide information for a CharacterSource.

uk.ac.ed.ph.snuggletex.internal back to summary

public final Class WorkingDocument.SubstitutionContext

Class Inheritance

extends Object
implements SourceContext

java.lang.Object
uk.ac.ed.ph.snuggletex.internal.WorkingDocument.SubstitutionContext

All Implemented Interfaces

uk.ac.ed.ph.snuggletex.internal.WorkingDocument.SourceContext

Implementation of SourceContext that represents the result of a substitution.

Field Summary

Modifier and Type	Field and Description
public CharSequence	replacement The characters that replaced what was originally in the document.

Constructor Summary

Access	Constructor and Description
public	SubstitutionContext(final CharSequence replacement)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

replacement	back to summary
public CharSequence replacement The characters that replaced what was originally in the document.

Constructor Detail

SubstitutionContext	back to summary
public SubstitutionContext(final CharSequence replacement)

Method Detail

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override