Package snap.parse

Class Parser

java.lang.Object

snap.parse.Parser

Direct Known Subclasses:

JSParser, KeyChainParser, ParseRuleParser, XMLParser

public class Parser
extends Object

A class to parse a given input (string) using given rule(s).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Parser.HandlerRef	A class to pass Handler by reference, allowing it to be created lazily, but used higher up in stack.

Constructor Summary

Constructors

Constructor	Description
Parser()	Constructor.
Parser(ParseRule aRule)	Constructor for given rule.

Method Summary

Modifier and Type	Method	Description
final char	charAt(int anIndex)	CharSequence method.
void	clearTokens()	Clears any currently set tokens.
protected ParseNode	createNode(ParseRule aRule, ParseToken aStartToken, ParseToken anEndToken)	Creates a node for given rule and start/end tokens (returns a shared node by default).
protected ParseRule	createRule()	Creates the top level rule.
protected Tokenizer	createTokenizer()	Creates the tokenizer instance.
final char	eatChar()	Returns the char at the current index plus offset.
final char	getChar()	Returns the current parse char.
int	getCharIndex()	Returns the current parse char location.
CharSequence	getInput()	Returns the current parse character input.
protected ParseToken	getLookAheadToken(int anIndex)	Returns the look ahead token at given index.
protected ParseToken	getNextToken()	Fetches and returns the next token.
ParseRule	getRule()	Returns the top level rule.
ParseRule	getRule(String aName)	Returns a named rule.
ParseToken	getToken()	Returns the current token.
Tokenizer	getTokenizer()	Returns the tokenizer.
protected void	initRule()	Initializes rule(s).
final int	length()	CharSequence method.
protected int	lookAhead(ParseRule aRule, int aTokenCount, int aTokenIndex)	Looks ahead given number of tokens and returns the remainder or -1 if it fails.
ParseNode	parse()	Parses input and returns ParseNode.
ParseNode	parse(CharSequence anInput)	Parses a given input and returns ParseNode (convenience).
ParseNode	parse(ParseRule aRule)	Parses input and returns ParseNode.
protected ParseNode	parse(ParseRule aRule, Parser.HandlerRef aHRef)	Returns a parse node if this rule matches string.
<T> T	parseCustom(CharSequence anInput, Class<T> aClass)	Parses given input and returns custom parse tree node (convenience).
<T> T	parseCustom(Class<T> aClass)	Parses input and returns custom parse tree node.
<T> T	parseCustom(ParseRule aRule, Class<T> aClass)	Parses input and returns custom parse tree node.
protected void	parseFailed(ParseRule aRule, ParseHandler<?> aHandler)	Called when parse fails.
void	setCharIndex(int aLoc)	Sets the current parse location.
Parser	setInput(CharSequence aSequence)	Sets the current parse string.
void	setRule(ParseRule aRule)	Sets the top level rule.
protected void	setTokenizer(Tokenizer aTokenizer)	Sets the tokenizer.

Methods inherited from class java.lang.Object

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

Constructor Details

Parser

public Parser()

Constructor.

Parser

public Parser(ParseRule aRule)

Constructor for given rule.

Method Details

getRule

public ParseRule getRule()

Returns the top level rule.

setRule

public void setRule(ParseRule aRule)

Sets the top level rule.

createRule

protected ParseRule createRule()

Creates the top level rule. Default version tries to load rules from ClassName.txt.

initRule

protected void initRule()

Initializes rule(s).

getRule

public ParseRule getRule(String aName)

Returns a named rule.

getInput

public CharSequence getInput()

Returns the current parse character input.

setInput

public Parser setInput(CharSequence aSequence)

Sets the current parse string.

length

public final int length()

CharSequence method.

charAt

public final char charAt(int anIndex)

CharSequence method.

getChar

public final char getChar()

Returns the current parse char.

eatChar

public final char eatChar()

Returns the char at the current index plus offset.

getCharIndex

public int getCharIndex()

Returns the current parse char location.

setCharIndex

public void setCharIndex(int aLoc)

Sets the current parse location.

getTokenizer

public Tokenizer getTokenizer()

Returns the tokenizer.

createTokenizer

protected Tokenizer createTokenizer()

Creates the tokenizer instance.

setTokenizer

protected void setTokenizer(Tokenizer aTokenizer)

Sets the tokenizer.

getToken

public ParseToken getToken()

Returns the current token.

getNextToken

protected ParseToken getNextToken()

Fetches and returns the next token.

getLookAheadToken

protected ParseToken getLookAheadToken(int anIndex)

Returns the look ahead token at given index.

clearTokens

public void clearTokens()

Clears any currently set tokens.

parse

public ParseNode parse(CharSequence anInput)

Parses a given input and returns ParseNode (convenience).

parse

public ParseNode parse()

Parses input and returns ParseNode.

parse

public ParseNode parse(ParseRule aRule)

Parses input and returns ParseNode.

parseCustom

public <T> T parseCustom(Class<T> aClass)

Parses input and returns custom parse tree node.

parseCustom

public <T> T parseCustom(ParseRule aRule,
 Class<T> aClass)

Parses input and returns custom parse tree node.

parse

protected ParseNode parse(ParseRule aRule,
 Parser.HandlerRef aHRef)

Returns a parse node if this rule matches string.

lookAhead

protected int lookAhead(ParseRule aRule,
 int aTokenCount,
 int aTokenIndex)

Looks ahead given number of tokens and returns the remainder or -1 if it fails.

createNode

protected ParseNode createNode(ParseRule aRule,
 ParseToken aStartToken,
 ParseToken anEndToken)

Creates a node for given rule and start/end tokens (returns a shared node by default).

parseFailed

protected void parseFailed(ParseRule aRule,
 ParseHandler<?> aHandler)

Called when parse fails.

parseCustom

public <T> T parseCustom(CharSequence anInput,
 Class<T> aClass)

Parses given input and returns custom parse tree node (convenience).