InputContext (SnuggleTeX Core 1.5.0-SNAPSHOT API)

All Known Implementing Classes:

WorkingDocument
```
public interface InputContext
```
Read-only view of the current document being parsed, which will change shape as user-defined macros and environments are being expanded.
This is used by helper classes like NumberMatcher that let you change the way certain things get parsed.
The actual implementation of this is the (internal and very complicated) WorkingDocument class.

Since:

1.3.0

Version:

$Revision$

Author:

David McKain

Method Summary

All Methods Instance Methods Abstract 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.
`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.
`SnuggleInput`	`getInput()` Accesses the underlying `SnuggleInput`
`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.

- Method Detail
  - getInput
```
SnuggleInput getInput()
```
    Accesses the underlying SnuggleInput
  - length
```
int length()
```
    Current length of this input
  - charAt
```
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.
  - matchesAt
```
boolean matchesAt(int index,
                  char c)
```
    Tests whether the character at the given index is equal to that specified.
  - matchesAt
```
boolean matchesAt(int index,
                  String s)
```
    Tests whether the characters at the given index are equal to the String specified.
  - indexOf
```
int indexOf(int startSearchIndex,
            char c)
```
    Returns the first index of the given character, starting the search at the given index. Returns -1 if not found.
  - indexOf
```
int indexOf(int startSearchIndex,
            String s)
```
    Returns the first index of the given String, starting the search at the given index. Returns -1 if not found.
  - isRegionWhitespace
```
boolean isRegionWhitespace(int startIndex,
                           int endIndex)
```
    Tests whether all characters in the document with index satisfying startIndex <= index < endIndex are whitespace.
  - extract
```
CharSequence extract()
```
    Extracts a copy of the current entire content of the input as a CharSequence
  - extract
```
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.

Interface InputContext

Method Summary

Method Detail

getInput

length

charAt

matchesAt

matchesAt

indexOf

indexOf

isRegionWhitespace

extract

extract