Index (Rats! Runtime Library 1.15.0 API)

A B C D E F G H I J L M N P R S T U V W X Y

A

abort() - Method in interface xtc.util.State: Abort a state-modifying transaction.
Action<T> - Interface in xtc.util: The interface to all actions.
add(Object) - Method in class xtc.tree.Node: Add the specified object as a child.
add(int, Object) - Method in class xtc.tree.Node: Add the specified object as a child at the specified index.
add(T) - Method in class xtc.util.Pair: Add the specified element to the list starting at this pair.
addAll(Pair<?>) - Method in class xtc.tree.Node: Add all values in the list starting with the specified pair as children.
addAll(int, Pair<?>) - Method in class xtc.tree.Node: Add all values in the list starting with the specified pair as children at the specified index.
addAll(Collection<?>) - Method in class xtc.tree.Node: Add all values in the specified collection as children.
addAll(int, Collection<?>) - Method in class xtc.tree.Node: Add all values in the specified collection as children at the specified index.
addAllTo(Collection<Object>) - Method in class xtc.tree.Node: Add all of this node's children to the specified collection.
addNode(Node) - Method in class xtc.tree.Node: Add the specified node as a child.
addTo(List<? super T>) - Method in class xtc.util.Pair: Add the values of the list starting at this pair in order to the specified Java collections framework list.
after1(Node, Object) - Static method in class xtc.tree.Formatting: Create a formatting annotation.
Annotation - Class in xtc.tree: The superclass of all annotations.
Annotation() - Constructor for class xtc.tree.Annotation: Create a new, empty annotation.
Annotation(Node) - Constructor for class xtc.tree.Annotation: Create a new annotation for the specified node.
append(Pair<T>) - Method in class xtc.util.Pair: Set the tail of a copy of this list's last pair to the specified value.
apply(Pair<Action<T>>, T) - Method in class xtc.parser.ParserBase: Apply the specified actions on the specified seed.
apply(Pair<Action<T>>, T, int) - Method in class xtc.parser.ParserBase: Apply the specified actions on the specified seed while also setting the results' locations.

B

before1(Object, Node) - Static method in class xtc.tree.Formatting: Create a formatting annotation.

C

C_ESCAPES - Static variable in class xtc.util.Utilities: The escape flags for standard C escapes.
cast(Object) - Static method in class xtc.parser.ParserBase: Cast the specified object.
cast(Pair<?>) - Static method in class xtc.parser.ParserBase: Cast the list starting at the specified pair.
cast(Object) - Static method in class xtc.tree.GNode: Cast the specified object to a generic node.
cast(Object) - Static method in class xtc.tree.Token: Cast the specified object to a string.
character(int) - Method in class xtc.parser.ParserBase: Parse a character at the specified index.
Column - Class in xtc.parser: The superclass of memoization table columns.
Column() - Constructor for class xtc.parser.Column
column - Variable in class xtc.parser.Column: The current column.
column(int) - Method in class xtc.parser.ParserBase: Get the column at the specified index.
column - Variable in class xtc.tree.Location: The column.
combine(Pair<T>) - Method in class xtc.util.Pair: Combine the elements on the list starting at this pair with the elements on the list starting at the specified pair.
COMMENT_NEWLINE - Static variable in class xtc.util.Utilities: The regular expression pattern for newlines surrounded by spaces and optionally followed by stars '*'.
commit() - Method in interface xtc.util.State: Commit a state-modifying transaction.
compareTo(Object) - Method in class xtc.tree.Location
consists() - Method in class xtc.util.Pair: Determine whether the list starting at this pair consists of no elements.
consists(Object) - Method in class xtc.util.Pair: Determine whether the list starting at this pair consists of the specified object.
consists(Object, Object) - Method in class xtc.util.Pair: Determine whether the list starting at this pair consists of the specified two objects.
consists(Object, Object, Object) - Method in class xtc.util.Pair: Determine whether the list starting at this pair consists of the specified three objects.
consists(Object, Object, Object, Object) - Method in class xtc.util.Pair: Determine whether the list starting at this pair consists of the specified four objects.
consists(Object, Object, Object, Object, Object) - Method in class xtc.util.Pair: Determine whether the list starting at this pair consists of the specified five objects.
consists(Object...) - Method in class xtc.util.Pair: Determine whether the list starting at this pair consists of the specified objects.
contains(Object) - Method in class xtc.tree.Node: Determine whether this node has the specified object as a child.
contains(Object) - Method in class xtc.util.Pair: Determine whether the list starting at this pair contains the specified element.
create(String) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name.
create(String, int) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name.
create(String, boolean) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name.
create(String, Object) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name and child.
create(String, Object, Object) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name and children.
create(String, Object, Object, Object) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name and children.
create(String, Object, Object, Object, Object) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name and children.
create(String, Object, Object, Object, Object, Object) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name and children.
create(String, Object, Object, Object, Object, Object, Object) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name and children.
create(String, Object, Object, Object, Object, Object, Object, Object) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name and children.
create(String, Object, Object, Object, Object, Object, Object, Object, Object) - Static method in class xtc.tree.GNode: Create a new generic node with the specified name and children.
create(GNode) - Static method in class xtc.tree.GNode: Create a new generic node that is a (shallow) copy of the specified node.
createFromPair(String, Pair) - Static method in class xtc.tree.GNode: Create a new generic node with the list's nodes as its children.
createFromPair(String, Object, Pair) - Static method in class xtc.tree.GNode: Create a new generic node with the specified children.
createValue(Object, ParseError) - Method in class xtc.parser.ParseError
createValue(Object, ParseError) - Method in class xtc.parser.Result: Create a semantic value based on this result.
createValue(Object, ParseError) - Method in class xtc.parser.SemanticValue

D

difference(int, int) - Method in class xtc.parser.ParserBase: Get the difference between the specified indices.
DUMMY - Static variable in class xtc.parser.ParseError: The dummy parse error.

E

EMPTY - Static variable in class xtc.util.Pair: The pair representing the empty list.
empty() - Static method in class xtc.util.Pair: Get the canoncial empty pair.
ensureVariable(GNode) - Static method in class xtc.tree.GNode: Ensure that the specified node supports a variable number of children.
equals(Object) - Method in class xtc.tree.GNode: Determine whether this generic node equals the specified object.
equals(Object) - Method in class xtc.tree.Location
equals(Object) - Method in class xtc.util.Pair: Determine whether the list starting at this pair equals the specified object.
error - Variable in class xtc.parser.SemanticValue: The embedded parse error.
escape(char, Appendable, int) - Static method in class xtc.util.Utilities: Escape the specified character into the specified appendable.
escape(String, Appendable, int) - Static method in class xtc.util.Utilities: Escape the specified string into the specified appendable.
escape(char, int) - Static method in class xtc.util.Utilities: Escape the specified character.
escape(String, int) - Static method in class xtc.util.Utilities: Escape the specified string.
ESCAPE_BELL_VT - Static variable in class xtc.util.Utilities: Flag for escaping the bell '\a' and vertical tab '\v' characters, which may be escaped in standard C but not in Java.
ESCAPE_DOUBLE - Static variable in class xtc.util.Utilities: Flag for using doubled escape sequences.
ESCAPE_HTML - Static variable in class xtc.util.Utilities: Flag for escaping less-than '<' and greater-than '>' signs as HTML entities.
ESCAPE_REGEX - Static variable in class xtc.util.Utilities: Flag for escaping the '[', '-', and ']' characters used in regular expressions.
ESCAPE_UNICODE - Static variable in class xtc.util.Utilities: Flag for escaping all characters that neither are printable ASCII characters nor have named escapes using Unicode escapes.

F

file - Variable in class xtc.parser.Column: The file name.
file - Variable in class xtc.tree.Location: The file name.
FIRST_COLUMN - Static variable in class xtc.parser.ParserBase: The start index for columns.
FIRST_LINE - Static variable in class xtc.parser.ParserBase: The start index for lines.
format(ParseError) - Method in class xtc.parser.ParserBase: Format the specified parse error.
format(List<?>) - Static method in class xtc.util.Utilities: Convert the specified list to a human-readable representation.
Formatting - Class in xtc.tree: An annotation capturing source code formatting.
FULL_ESCAPES - Static variable in class xtc.util.Utilities: The escape flags for Java and regex escapes.
FULL_HTML_ESCAPES - Static variable in class xtc.util.Utilities: The escape flags for Java, regex, and HTML escapes.

G

get(int) - Method in class xtc.tree.Node: Get the child at the specified index.
get(int) - Method in class xtc.tree.Token
get(int) - Method in class xtc.util.Pair: Get the element at the specified index of the list starting at this pair.
getBoolean(int) - Method in class xtc.tree.Node: Get the boolean child at the specified index.
getBooleanProperty(String) - Method in class xtc.tree.Node: Get a property value as a boolean.
getGeneric(int) - Method in class xtc.tree.Node: Get the generic node child at the specified index.
getList(int) - Method in class xtc.tree.Node: Get the list child at the specified index.
getLocation() - Method in interface xtc.tree.Locatable: Get this object's location.
getLocation() - Method in class xtc.tree.Node
getName() - Method in class xtc.tree.GNode
getName() - Method in class xtc.tree.Node: Get the name of this node.
getNode() - Method in class xtc.tree.Annotation: Get the annotated node.
getNode(int) - Method in class xtc.tree.Node: Get the node child at the specified index.
getProperty(String) - Method in class xtc.tree.Node: Get a property value.
getString(int) - Method in class xtc.tree.Node: Get the string child at the specified index.
getStringProperty(String) - Method in class xtc.tree.Node: Get a property value as a string.
getTokenText() - Method in class xtc.tree.Annotation
getTokenText() - Method in class xtc.tree.Node: Treat this node as a token and get its text.
getTokenText() - Method in class xtc.tree.Token
GNode - Class in xtc.tree: A generic node in an abstract syntax tree.

H

hashCode() - Method in class xtc.tree.GNode: Get this generic node's hash code.
hashCode() - Method in class xtc.tree.Location
hashCode() - Method in class xtc.util.Pair: Get a hashcode for the list starting at this pair.
hasLocation() - Method in interface xtc.tree.Locatable: Determine whether this object has a location.
hasLocation() - Method in class xtc.tree.Node
hasName(String) - Method in class xtc.tree.GNode
hasName(String) - Method in class xtc.tree.Node: Determine whether this node's name is the same as the specified name.
hasProperty(String) - Method in class xtc.tree.Node: Test if this node has a property.
hasTraversal() - Method in class xtc.tree.Formatting
hasTraversal() - Method in class xtc.tree.GNode
hasTraversal() - Method in class xtc.tree.Node: Determine whether this node supports generic traversal of its children.
hasTraversal() - Method in class xtc.tree.Token
hasValue() - Method in class xtc.parser.ParseError
hasValue(String) - Method in class xtc.parser.ParseError
hasValue() - Method in class xtc.parser.Result: Determine whether this result has a value.
hasValue(String) - Method in class xtc.parser.Result: Determine whether this result has the specified string value.
hasValue() - Method in class xtc.parser.SemanticValue
hasValue(String) - Method in class xtc.parser.SemanticValue
hasValueIgnoreCase(String) - Method in class xtc.parser.ParseError
hasValueIgnoreCase(String) - Method in class xtc.parser.Result: Determine whether this result has the specified string value, ignoring case.
hasValueIgnoreCase(String) - Method in class xtc.parser.SemanticValue
hasVariable() - Method in class xtc.tree.Node: Determine whether this node supports a variable number of children.
head() - Method in class xtc.util.Pair: Get the head.

I

INCR_SIZE - Static variable in class xtc.parser.ParserBase: The increment for the arrays storing the memoization table's columns.
index - Variable in class xtc.parser.Result: The index into the parser's memoization table.
indexOf(Object) - Method in class xtc.tree.Node: Determine the index of the specified object.
INIT_SIZE - Static variable in class xtc.parser.ParserBase: The default size for the arrays storing the memoization table's columns.
innerMost() - Method in class xtc.tree.Annotation: Return the inner-most annotation.
intersect(Pair<T>) - Method in class xtc.util.Pair: Intersect the elements on the list starting at this pair with the elements on the list starting at the specified pair.
isAnnotation() - Method in class xtc.tree.Annotation
isAnnotation() - Method in class xtc.tree.Node: Determine whether this node is an annotation.
isEmpty() - Method in class xtc.tree.Node: Determine whether this node has no children.
isEmpty() - Method in class xtc.util.Pair: Determine whether the list starting at this pair is empty.
isEOF(int) - Method in class xtc.parser.ParserBase: Determine whether the specified index represents the end-of-file.
isGeneric() - Method in class xtc.tree.GNode: Determine whether this node is generic.
isGeneric() - Method in class xtc.tree.Node: Determine whether this node is a generic node.
isList(Object) - Static method in class xtc.tree.Node: Determine whether the specified object is a list of nodes.
isToken() - Method in class xtc.tree.Node: Determine whether this node is a token.
isToken() - Method in class xtc.tree.Token
iterator() - Method in class xtc.tree.Node: Get an iterator over this node's children.
iterator() - Method in class xtc.util.Pair: Get an iterator over the values of the list starting at this pair.

J

JAVA_ESCAPES - Static variable in class xtc.util.Utilities: The escape flags for Java escapes.
JAVA_HTML_ESCAPES - Static variable in class xtc.util.Utilities: The escape flags for Java and HTML escapes.

L

lastIndexOf(Object) - Method in class xtc.tree.Node: Determine the last index of the specified object.
line - Variable in class xtc.parser.Column: The current line.
line - Variable in class xtc.tree.Location: The line number.
lineAt(int) - Method in class xtc.parser.ParserBase: Get the line at the specified index.
list() - Method in class xtc.util.Pair: Convert the list starting at this pair into a Java collections framework list.
Locatable - Interface in xtc.tree: The interface to objects with a source location.
locate(List<File>, String) - Static method in class xtc.util.Utilities: Locate the specified file.
location(int) - Method in class xtc.parser.ParserBase: Get the location for the specified index.
Location - Class in xtc.tree: The location in a source file.
Location(String, int, int) - Constructor for class xtc.tree.Location: Create a new location.

M

MAX_FIXED - Static variable in class xtc.tree.GNode: The maximum number of children for generic nodes that are optimized to hold a fixed number of children.
msg - Variable in class xtc.parser.ParseError: The error message.

N

newColumn() - Method in class xtc.parser.ParserBase: Create a new column.
NEWLINE - Static variable in class xtc.parser.ParserBase: The platform's line separator.
Node - Class in xtc.tree: A node in an abstract syntax tree.
Node() - Constructor for class xtc.tree.Node: Create a new node.
Node(Location) - Constructor for class xtc.tree.Node: Create a new node.

P

Pair<T> - Class in xtc.util: Implementation of a pair.
Pair(T) - Constructor for class xtc.util.Pair: Create a new pair.
Pair(T, Pair<T>) - Constructor for class xtc.util.Pair: Create a new pair.
ParseError - Class in xtc.parser: An erroneous parse.
ParseError(String, int) - Constructor for class xtc.parser.ParseError: Create a new parse error.
parseError() - Method in class xtc.parser.ParseError
parseError() - Method in class xtc.parser.Result: Get the parse error for this result.
parseError() - Method in class xtc.parser.SemanticValue
ParseException - Exception in xtc.parser: An exception representing a parse error.
ParseException(String) - Constructor for exception xtc.parser.ParseException: Create a new parse exception.
ParserBase - Class in xtc.parser: The base class for packrat parsers.
ParserBase(Reader, String) - Constructor for class xtc.parser.ParserBase: Create a new parser base.
ParserBase(Reader, String, int) - Constructor for class xtc.parser.ParserBase: Create a new parser base.
peek(int) - Method in class xtc.parser.ParserBase: Get the next few characters from the specified index.
properties() - Method in class xtc.tree.Node: Get the set of property names.
pump(Reader, Writer) - Static method in class xtc.util.Utilities: Pump all data from the specified reader to the specified writer.

R

remove(int) - Method in class xtc.tree.Node: Remove the child at the specified index.
removeProperty(String) - Method in class xtc.tree.Node: Remove a property.
reset(String) - Method in interface xtc.util.State: Reset the global state object.
resetTo(int) - Method in class xtc.parser.ParserBase: Reset this parser to the specified index.
Result - Class in xtc.parser: The superclass of all parser results.
Result(int) - Constructor for class xtc.parser.Result: Create a new result with the specified index.
reverse() - Method in class xtc.util.Pair: Reverse the list starting at this pair in place.
round1(Object, Node, Object) - Static method in class xtc.tree.Formatting: Create a formatting annotation.
run(T) - Method in interface xtc.util.Action: Perform this action.

S

seenCR - Variable in class xtc.parser.Column: The flag for whether the previous character was a carriage return.
select(ParseError) - Method in class xtc.parser.ParseError
select(ParseError, int) - Method in class xtc.parser.ParseError
select(String, int) - Method in class xtc.parser.ParseError: Select the more specific parse error.
select(ParseError) - Method in class xtc.parser.Result: Select the more specific parse error.
select(ParseError, int) - Method in class xtc.parser.Result: Select the more specific parse error.
select(ParseError) - Method in class xtc.parser.SemanticValue
select(ParseError, int) - Method in class xtc.parser.SemanticValue
semanticValue() - Method in class xtc.parser.ParseError
semanticValue() - Method in class xtc.parser.Result: Get the semantic value for this result.
SemanticValue - Class in xtc.parser: A semantic value.
SemanticValue(Object, int) - Constructor for class xtc.parser.SemanticValue: Create a new semantic value.
SemanticValue(Object, int, ParseError) - Constructor for class xtc.parser.SemanticValue: Create a new semantic value.
semanticValue() - Method in class xtc.parser.SemanticValue
set(int, Object) - Method in class xtc.tree.Node: Set the child at the specified index to the specified value.
set(int, Object) - Method in class xtc.tree.Token
set(int, T) - Method in class xtc.util.Pair: Replace the element at the specified index of the list starting at this pair.
setHead(T) - Method in class xtc.util.Pair: Set the head.
setLastTail(Pair<T>) - Method in class xtc.util.Pair: Set the tail of this list's last pair to the specified value.
setLocation(int, String, int, int) - Method in class xtc.parser.ParserBase: Set the location for the specified index.
setLocation(Locatable, int) - Method in class xtc.parser.ParserBase: Set the location for the specified locatable object.
setLocation(Location) - Method in interface xtc.tree.Locatable: Set this object's location.
setLocation(Locatable) - Method in interface xtc.tree.Locatable: Set this object's location to the specified locatable's location.
setLocation(Location) - Method in class xtc.tree.Node
setLocation(Locatable) - Method in class xtc.tree.Node
setNode(Node) - Method in class xtc.tree.Annotation: Set the annotated node.
setProperty(String, Object) - Method in class xtc.tree.Node: Set the value of a property.
setTail(Pair<T>) - Method in class xtc.util.Pair: Set the tail.
signal(ParseError) - Method in class xtc.parser.ParserBase: Signal the specified parse error as a parse exception.
size() - Method in class xtc.tree.Node: Get the number of children.
size() - Method in class xtc.tree.Token
size() - Method in class xtc.util.Pair: Get the size of the list starting at this pair.
SPACE_NEWLINE_SPACE - Static variable in class xtc.util.Utilities: The regular expression pattern for newlines surrounded by spaces.
split(String, char) - Static method in class xtc.util.Utilities: Split the specified identifier.
start() - Method in interface xtc.util.State: Start a new state-modifying transaction.
State - Interface in xtc.util: The interface for a global parser state object.
strip() - Method in class xtc.tree.Annotation
strip() - Method in class xtc.tree.Node: Strip any annotations.
subtract(Pair<T>) - Method in class xtc.util.Pair: Subtract the elements on the list starting at the specified list from the elements on the list starting at this pair.

T

tail() - Method in class xtc.util.Pair: Get the tail.
test(Object) - Static method in class xtc.tree.GNode: Test whether the specified object is a generic node, possibly wrapped in annotations.
test(Object) - Static method in class xtc.tree.Token: Determine whether the specified object represents a string.
toAnnotation() - Method in class xtc.tree.Annotation
toAnnotation() - Method in class xtc.tree.Node: Get this node as an annotation.
toArticle(String) - Static method in class xtc.util.Utilities: Get the appropriate indefinite article for the specified noun.
Token - Class in xtc.tree: A token.
Token(String) - Constructor for class xtc.tree.Token: Create a new token.
toList(Object) - Static method in class xtc.tree.Node: Convert the specified object to a list of nodes.
toString() - Method in class xtc.tree.Location
toString() - Method in class xtc.tree.Node: Return a human readable representation of this node.
toString() - Method in class xtc.util.Pair: Get a string representation for the list starting at this pair.
toToken() - Method in class xtc.tree.Node: Get this node as a token.
toToken() - Method in class xtc.tree.Token

U

unescape(String) - Static method in class xtc.util.Utilities: Unescape the specified string.
useBellVTEscapes(int) - Static method in class xtc.util.Utilities: Determine whether the escape bell and vertical tabs flag is set.
useDoubleEscapes(int) - Static method in class xtc.util.Utilities: Determine whether the escape double flag is set.
useHTMLEscapes(int) - Static method in class xtc.util.Utilities: Determine whether the escape HTML flag is set.
useRegexEscapes(int) - Static method in class xtc.util.Utilities: Determine whether the escape regex flag is set.
useUnicodeEscapes(int) - Static method in class xtc.util.Utilities: Determine whether the escape Unicode flag is set.
Utilities - Class in xtc.util: Implementation of utilities for language processors, focusing on strings and I/O.

V

value(Result) - Method in class xtc.parser.ParserBase: Extract the specified result's value.
value - Variable in class xtc.parser.SemanticValue: The actual value.
variable() - Static method in class xtc.tree.Formatting: Create a formatting annotation.

W

WHITE_SPACE - Static variable in class xtc.util.Utilities: The regular expression pattern for white space.
withoutSpace(String) - Static method in class xtc.util.Utilities: Remove all whitespace from the specified string.
write(Appendable) - Method in class xtc.tree.Location: Write this location to the specified appenable.
write(Appendable) - Method in class xtc.tree.Node: Write a human readable representation to the specified appendable.

X

xtc.parser - package xtc.parser
xtc.tree - package xtc.tree
xtc.util - package xtc.util

Y

yyColumns - Variable in class xtc.parser.ParserBase: The memoization table columns.
yyCount - Variable in class xtc.parser.ParserBase: The number of characters consumed from the character stream.
yyData - Variable in class xtc.parser.ParserBase: The characters consumed so far.
yyEOF - Variable in class xtc.parser.ParserBase: The flag for whether the end-of-file has been reached.
yyReader - Variable in class xtc.parser.ParserBase: The reader for the character stream to be parsed.

A B C D E F G H I J L M N P R S T U V W X Y