WorkingDocument (SnuggleTeX Core 1.5.0-SNAPSHOT API)

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

All Implemented Interfaces:

InputContext
```
public final class WorkingDocument
extends Object
implements InputContext
```
Represents the "working view" of the current SnuggleInput document. This is slightly non-trivial in that user-defined command and environments generally work as simple text substitutions, so the state of the document changes during tokenisation. However, we also need to be able to keep track of where each character in the document comes from so as to enable decent error reporting. hence the complexity within here.

Version:

$Revision$

Author:

David McKain

Nested Class Summary

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

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInput
```
public SnuggleInput getInput()
```
    Description copied from interface: InputContext
    
    Accesses the underlying SnuggleInput
    
    Specified by:
    
    getInput in interface InputContext
  - freezeSlice
```
public FrozenSlice freezeSlice(int startIndex,
                               int endIndex)
```
  - unfreeze
```
public void unfreeze(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.
    
    Parameters:
    
    newFreezeIndex -
  - length
```
public int length()
```
    Description copied from interface: InputContext
    
    Current length of this input
    
    Specified by:
    
    length in interface InputContext
  - resolveIndex
```
public WorkingDocument.IndexResolution resolveIndex(int index,
                                                    boolean fallLeftOnBoundaries)
```
  - getSubstitutionDepth
```
public int getSubstitutionDepth(int index)
```
  - charAt
```
public int charAt(int index)
```
    Description copied from interface: InputContext
    
    Returns the character at the given index in the input document, or -1 if the index is not contained within the document.
    
    Specified by:
    
    charAt in interface InputContext
  - matchesAt
```
public boolean matchesAt(int index,
                         char c)
```
    Description copied from interface: InputContext
    
    Tests whether the character at the given index is equal to that specified.
    
    Specified by:
    
    matchesAt in interface InputContext
  - matchesAt
```
public boolean matchesAt(int index,
                         String s)
```
    Description copied from interface: InputContext
    
    Tests whether the characters at the given index are equal to the String specified.
    
    Specified by:
    
    matchesAt in interface InputContext
  - indexOf
```
public int indexOf(int startSearchIndex,
                   char c)
```
    Description copied from interface: InputContext
    
    Returns the first index of the given character, starting the search at the given index. Returns -1 if not found.
    
    Specified by:
    
    indexOf in interface InputContext
  - indexOf
```
public int indexOf(int startSearchIndex,
                   String s)
```
    Description copied from interface: InputContext
    
    Returns the first index of the given String, starting the search at the given index. Returns -1 if not found.
    
    Specified by:
    
    indexOf in interface InputContext
  - isRegionWhitespace
```
public boolean isRegionWhitespace(int startIndex,
                                  int endIndex)
```
    Description copied from interface: InputContext
    
    Tests whether all characters in the document with index satisfying startIndex <= index < endIndex are whitespace.
    
    Specified by:
    
    isRegionWhitespace in interface InputContext
  - extract
```
public CharSequence extract()
```
    Description copied from interface: InputContext
    
    Extracts a copy of the current entire content of the input as a CharSequence
    
    Specified by:
    
    extract in interface InputContext
  - extract
```
public CharSequence extract(int startIndex,
                            int endIndex)
```
    Description copied from interface: InputContext
    
    Extracts a copy of a slice of the current entire content of the input as a CharSequence, including all characters with startIndex <= index < endIndex.
    
    Specified by:
    
    extract in interface InputContext
  - substitute
```
public WorkingDocument.CharacterSource substitute(int startIndex,
                                                  int endIndex,
                                                  CharSequence replacement)
```
  - dumpScoreboard
```
public void dumpScoreboard()
```

Class WorkingDocument

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInput

freezeSlice

unfreeze

length

resolveIndex

getSubstitutionDepth

charAt

matchesAt

matchesAt

indexOf

indexOf

isRegionWhitespace

extract

extract

substitute

dumpScoreboard