org.eclipse.xtext.parser.antlr

Class AbstractInternalAntlrParser

java.lang.Object

org.antlr.runtime.BaseRecognizer

org.antlr.runtime.Parser

org.eclipse.xtext.parser.antlr.AbstractInternalAntlrParser

Direct Known Subclasses:

InternalXtextParser

public abstract class AbstractInternalAntlrParser
extends org.antlr.runtime.Parser

Base class for Xtext's generated parsers. It is reasonable customizable by means of object composition, e.g. error messages can be tailored to specific needs with an ISyntaxErrorMessageProvider, objects construction is subject to an IAstFactory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractInternalAntlrParser.ErrorContext
protected class	AbstractInternalAntlrParser.LexerErrorContext
protected class	AbstractInternalAntlrParser.ParserErrorContext
protected class	AbstractInternalAntlrParser.UnorderedGroupErrorContext
protected class	AbstractInternalAntlrParser.ValueConverterErrorContext

Field Summary

Fields inherited from class org.antlr.runtime.Parser

input

Fields inherited from class org.antlr.runtime.BaseRecognizer

DEFAULT_TOKEN_CHANNEL, HIDDEN, INITIAL_FOLLOW_STACK_SIZE, MEMO_RULE_FAILED, MEMO_RULE_UNKNOWN, NEXT_TOKEN_RULE_NAME, state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractInternalAntlrParser(org.antlr.runtime.TokenStream input)
protected	AbstractInternalAntlrParser(org.antlr.runtime.TokenStream input, org.antlr.runtime.RecognizerSharedState state)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	add(org.eclipse.emf.ecore.EObject _this, String feature, Object value, String lexerRule)
protected void	add(org.eclipse.emf.ecore.EObject _this, String feature, Object value, String lexerRule, INode node)
protected void	addWithLastConsumed(org.eclipse.emf.ecore.EObject _this, String feature, Object value, String lexerRule)
protected void	afterParserOrEnumRuleCall()
protected void	appendAllTokens()
protected void	appendError(INode node)
protected List<ILeafNode>	appendSkippedTokens()
protected void	appendTrailingHiddenTokens()
protected void	associateNodeWithAstElement(ICompositeNode node, org.eclipse.emf.ecore.EObject astElement)
protected ISyntaxErrorMessageProvider.IParserErrorContext	createErrorContext(org.antlr.runtime.RecognitionException e)
protected org.eclipse.emf.ecore.EObject	createModelElement(AbstractRule rule)
protected org.eclipse.emf.ecore.EObject	createModelElement(org.eclipse.emf.ecore.EClassifier classifier)
protected org.eclipse.emf.ecore.EObject	createModelElement(org.eclipse.emf.ecore.EClassifier classifier, ICompositeNode compositeNode)
protected org.eclipse.emf.ecore.EObject	createModelElementForParent(AbstractRule rule)
protected org.eclipse.emf.ecore.EObject	createModelElementForParent(org.eclipse.emf.ecore.EClassifier classifier)
protected ISyntaxErrorMessageProvider.IValueConverterErrorContext	createValueConverterErrorContext(ValueConverterException vce)
void	displayRecognitionError(String[] tokenNames, org.antlr.runtime.RecognitionException e)
void	emitErrorMessage(String msg)
protected void	enterRule()
protected org.eclipse.emf.ecore.EObject	forceCreateModelElement(Action action, org.eclipse.emf.ecore.EObject value)
protected org.eclipse.emf.ecore.EObject	forceCreateModelElementAndAdd(Action action, org.eclipse.emf.ecore.EObject value)
protected org.eclipse.emf.ecore.EObject	forceCreateModelElementAndSet(Action action, org.eclipse.emf.ecore.EObject value)
String	getErrorMessage(org.antlr.runtime.RecognitionException e, String[] tokenNames)
protected abstract String	getFirstRuleName()
protected abstract IGrammarAccess	getGrammarAccess()
org.antlr.runtime.TokenStream	getInput()
protected INode	getLastLeafNode()
NodeModelBuilder	getNodeModelBuilder()
IAstFactory	getSemanticModelBuilder()
SyntaxErrorMessage	getSyntaxErrorMessage(org.antlr.runtime.RecognitionException e, String[] tokenNames)
ISyntaxErrorMessageProvider	getSyntaxErrorProvider()
IUnorderedGroupHelper	getUnorderedGroupHelper()
protected String	getValueConverterExceptionMessage(ValueConverterException vce)
protected void	handleValueConverterException(ValueConverterException vce)
protected void	insertCompositeNode(Action action)
protected void	leaveRule()
protected void	newCompositeNode(org.eclipse.emf.ecore.EObject grammarElement)
protected void	newLeafNode(org.antlr.runtime.Token token, org.eclipse.emf.ecore.EObject grammarElement)
IParseResult	parse()
IParseResult	parse(String entryRuleName)
void	recover(org.antlr.runtime.IntStream input, org.antlr.runtime.RecognitionException re)
protected Object	recoverFromMismatchedToken(org.antlr.runtime.IntStream input, int ttype, org.antlr.runtime.BitSet follow)
protected void	registerRules(Grammar grammar)
void	reportError(org.antlr.runtime.RecognitionException e)
protected void	set(org.eclipse.emf.ecore.EObject _this, String feature, Object value, String lexerRule)
protected void	set(org.eclipse.emf.ecore.EObject _this, String feature, Object value, String lexerRule, INode node)
void	setNodeModelBuilder(NodeModelBuilder nodeModelBuilder)
void	setSemanticModelBuilder(IAstFactory semanticModelBuilder)
void	setSyntaxErrorProvider(ISyntaxErrorMessageProvider syntaxErrorProvider)
void	setTokenTypeMap(Map<Integer,String> tokenTypeMap)
void	setUnorderedGroupHelper(IUnorderedGroupHelper unorderedGroupHelper)
protected void	setWithLastConsumed(org.eclipse.emf.ecore.EObject _this, String feature, Object value, String lexerRule)
protected String	superGetErrorMessage(org.antlr.runtime.RecognitionException e, String[] tokenNames)
protected static short[][]	unpackEncodedStringArray(String[] arr)

Methods inherited from class org.antlr.runtime.Parser

getCurrentInputSymbol, getMissingSymbol, getSourceName, getTokenStream, reset, setTokenStream, traceIn, traceOut

Methods inherited from class org.antlr.runtime.BaseRecognizer

alreadyParsedRule, beginResync, combineFollows, computeContextSensitiveRuleFOLLOW, computeErrorRecoverySet, consumeUntil, consumeUntil, endResync, failed, getBacktrackingLevel, getErrorHeader, getGrammarFileName, getNumberOfSyntaxErrors, getRuleInvocationStack, getRuleInvocationStack, getRuleMemoization, getRuleMemoizationCacheSize, getTokenErrorDisplay, getTokenNames, match, matchAny, memoize, mismatchIsMissingToken, mismatchIsUnwantedToken, pushFollow, recoverFromMismatchedSet, setBacktrackingLevel, toStrings, traceIn, traceOut

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractInternalAntlrParser

protected AbstractInternalAntlrParser(org.antlr.runtime.TokenStream input)

AbstractInternalAntlrParser

protected AbstractInternalAntlrParser(org.antlr.runtime.TokenStream input,
                           org.antlr.runtime.RecognizerSharedState state)

Method Detail

registerRules

protected void registerRules(Grammar grammar)

getInput

public org.antlr.runtime.TokenStream getInput()

getGrammarAccess

protected abstract IGrammarAccess getGrammarAccess()

associateNodeWithAstElement

protected void associateNodeWithAstElement(ICompositeNode node,
                               org.eclipse.emf.ecore.EObject astElement)

setTokenTypeMap

public void setTokenTypeMap(Map<Integer,String> tokenTypeMap)

setSyntaxErrorProvider

public void setSyntaxErrorProvider(ISyntaxErrorMessageProvider syntaxErrorProvider)

getSyntaxErrorProvider

public ISyntaxErrorMessageProvider getSyntaxErrorProvider()

set

protected void set(org.eclipse.emf.ecore.EObject _this,
       String feature,
       Object value,
       String lexerRule,
       INode node)

set

protected void set(org.eclipse.emf.ecore.EObject _this,
       String feature,
       Object value,
       String lexerRule)

setWithLastConsumed

protected void setWithLastConsumed(org.eclipse.emf.ecore.EObject _this,
                       String feature,
                       Object value,
                       String lexerRule)

add

protected void add(org.eclipse.emf.ecore.EObject _this,
       String feature,
       Object value,
       String lexerRule,
       INode node)

add

protected void add(org.eclipse.emf.ecore.EObject _this,
       String feature,
       Object value,
       String lexerRule)

addWithLastConsumed

protected void addWithLastConsumed(org.eclipse.emf.ecore.EObject _this,
                       String feature,
                       Object value,
                       String lexerRule)

appendError

protected void appendError(INode node)

appendAllTokens

protected void appendAllTokens()

getLastLeafNode

protected INode getLastLeafNode()

appendSkippedTokens

protected List<ILeafNode> appendSkippedTokens()

appendTrailingHiddenTokens

protected void appendTrailingHiddenTokens()

recover

public void recover(org.antlr.runtime.IntStream input,
           org.antlr.runtime.RecognitionException re)

Overrides:

recover in class org.antlr.runtime.BaseRecognizer

getValueConverterExceptionMessage

protected String getValueConverterExceptionMessage(ValueConverterException vce)

handleValueConverterException

protected void handleValueConverterException(ValueConverterException vce)

createValueConverterErrorContext

protected ISyntaxErrorMessageProvider.IValueConverterErrorContext createValueConverterErrorContext(ValueConverterException vce)

getErrorMessage

public String getErrorMessage(org.antlr.runtime.RecognitionException e,
                     String[] tokenNames)

Overrides:

getErrorMessage in class org.antlr.runtime.BaseRecognizer

displayRecognitionError

public void displayRecognitionError(String[] tokenNames,
                           org.antlr.runtime.RecognitionException e)

Overrides:

displayRecognitionError in class org.antlr.runtime.BaseRecognizer

reportError

public void reportError(org.antlr.runtime.RecognitionException e)

Overrides:

reportError in class org.antlr.runtime.BaseRecognizer

recoverFromMismatchedToken

protected Object recoverFromMismatchedToken(org.antlr.runtime.IntStream input,
                                int ttype,
                                org.antlr.runtime.BitSet follow)
                                     throws org.antlr.runtime.RecognitionException

Overrides:

recoverFromMismatchedToken in class org.antlr.runtime.BaseRecognizer

Throws:

org.antlr.runtime.RecognitionException

getSyntaxErrorMessage

public SyntaxErrorMessage getSyntaxErrorMessage(org.antlr.runtime.RecognitionException e,
                                       String[] tokenNames)

superGetErrorMessage

protected String superGetErrorMessage(org.antlr.runtime.RecognitionException e,
                          String[] tokenNames)

createErrorContext

protected ISyntaxErrorMessageProvider.IParserErrorContext createErrorContext(org.antlr.runtime.RecognitionException e)

parse

public final IParseResult parse()
                         throws org.antlr.runtime.RecognitionException

Throws:

org.antlr.runtime.RecognitionException

parse

public final IParseResult parse(String entryRuleName)
                         throws org.antlr.runtime.RecognitionException

Throws:

org.antlr.runtime.RecognitionException

emitErrorMessage

public void emitErrorMessage(String msg)

Overrides:

emitErrorMessage in class org.antlr.runtime.BaseRecognizer

getFirstRuleName

protected abstract String getFirstRuleName()

Returns:

the name of the entry rule.

setUnorderedGroupHelper

public void setUnorderedGroupHelper(IUnorderedGroupHelper unorderedGroupHelper)

getUnorderedGroupHelper

public IUnorderedGroupHelper getUnorderedGroupHelper()

afterParserOrEnumRuleCall

protected void afterParserOrEnumRuleCall()

createModelElementForParent

protected org.eclipse.emf.ecore.EObject createModelElementForParent(AbstractRule rule)

createModelElement

protected org.eclipse.emf.ecore.EObject createModelElement(AbstractRule rule)

createModelElementForParent

protected org.eclipse.emf.ecore.EObject createModelElementForParent(org.eclipse.emf.ecore.EClassifier classifier)

createModelElement

protected org.eclipse.emf.ecore.EObject createModelElement(org.eclipse.emf.ecore.EClassifier classifier)

createModelElement

protected org.eclipse.emf.ecore.EObject createModelElement(org.eclipse.emf.ecore.EClassifier classifier,
                                               ICompositeNode compositeNode)

forceCreateModelElementAndSet

protected org.eclipse.emf.ecore.EObject forceCreateModelElementAndSet(Action action,
                                                          org.eclipse.emf.ecore.EObject value)

forceCreateModelElementAndAdd

protected org.eclipse.emf.ecore.EObject forceCreateModelElementAndAdd(Action action,
                                                          org.eclipse.emf.ecore.EObject value)

forceCreateModelElement

protected org.eclipse.emf.ecore.EObject forceCreateModelElement(Action action,
                                                    org.eclipse.emf.ecore.EObject value)

insertCompositeNode

protected void insertCompositeNode(Action action)

enterRule

protected void enterRule()

leaveRule

protected void leaveRule()

newCompositeNode

protected void newCompositeNode(org.eclipse.emf.ecore.EObject grammarElement)

newLeafNode

protected void newLeafNode(org.antlr.runtime.Token token,
               org.eclipse.emf.ecore.EObject grammarElement)

setNodeModelBuilder

public void setNodeModelBuilder(NodeModelBuilder nodeModelBuilder)

getNodeModelBuilder

public NodeModelBuilder getNodeModelBuilder()

setSemanticModelBuilder

public void setSemanticModelBuilder(IAstFactory semanticModelBuilder)

getSemanticModelBuilder

public IAstFactory getSemanticModelBuilder()

unpackEncodedStringArray

protected static short[][] unpackEncodedStringArray(String[] arr)

Since:

2.9