Package de.monticore.grammar.grammar._symboltable

Class MCGrammarSymbol

java.lang.Object

de.monticore.grammar.grammar._symboltable.MCGrammarSymbolTOP

de.monticore.grammar.grammar._symboltable.MCGrammarSymbol

All Implemented Interfaces:

ICommonGrammarSymbol, de.monticore.symboltable.IScopeSpanningSymbol, de.monticore.symboltable.ISymbol

Direct Known Subclasses:

MCGrammarSymbolSurrogate

public class MCGrammarSymbol
extends MCGrammarSymbolTOP

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MODE
protected final com.google.common.cache.LoadingCache<String,Optional<ProdSymbol>>	prodCache
protected Map<String,Collection<String>>	replacedKeywords
protected ProdSymbol	startProd
protected final List<Supplier<Optional<MCGrammarSymbol>>>	superGrammars
protected Map<String,Collection<String>>	tokenModes

Fields inherited from class de.monticore.grammar.grammar._symboltable.MCGrammarSymbolTOP

accessModifier, astNode, enclosingScope, fullName, isComponent, name, noKeywords, packageName, spannedScope, splitRules, stereoinfo

Constructor Summary

Constructors

Constructor	Description
MCGrammarSymbol(String name)

Method Summary

Modifier and Type	Method	Description
void	addKeywords(String keyword, Collection<String> additionalKeywords)
void	addMode(String modeName, String tokenName)
void	addSuperGrammar(Supplier<MCGrammarSymbol> superGrammarRef)	Deprecated.
void	addSuperGrammarSupplier(Supplier<Optional<MCGrammarSymbol>> superGrammarRef)
protected String	determineFullName()	Determines dynamically the full name of the symbol.
protected String	determinePackageName()
Map<String,Collection<String>>	getAdditionalKeywords()	Deprecated.
List<MCGrammarSymbol>	getAllSuperGrammars()
Optional<ASTMCGrammar>	getAstGrammar()
Optional<ProdSymbol>	getInheritedProd(String ruleName)
Collection<String>	getKeywordRulesWithInherited()
Optional<ProdSymbol>	getProd(String prodName)
Collection<String>	getProdNames()
Collection<ProdSymbol>	getProds()
Map<String,ProdSymbol>	getProdsWithInherited()
Optional<ProdSymbol>	getProdWithInherited(String ruleName)
Map<String,Collection<String>>	getReplacedKeywords()
Map<String,Collection<String>>	getReplacedKeywordsWithInherited()
Optional<ProdSymbol>	getStartProd()	The start production typically is the first defined production in the grammar.
List<MCGrammarSymbol>	getSuperGrammars()	Deprecated. getSuperGrammarSymbols()
List<MCGrammarSymbol>	getSuperGrammarSymbols()	Returns the list of super grammar symbols.
Map<String,Collection<String>>	getTokenModes()
Map<String,Collection<String>>	getTokenModesWithInherited()
Collection<String>	getTokenRulesWithInherited()
void	setStartProd(ProdSymbol startRule)

Methods inherited from class de.monticore.grammar.grammar._symboltable.MCGrammarSymbolTOP

accept, accept, accept, accept, accept, accept, accept, accept, addAllNoKeywords, addAllNoKeywords, addAllSplitRules, addAllSplitRules, addNoKeywords, addNoKeywords, addSplitRules, addSplitRules, clearNoKeywords, clearSplitRules, containsAllNoKeywords, containsAllSplitRules, containsNoKeywords, containsSplitRules, equals, equalsNoKeywords, equalsSplitRules, forEachNoKeywords, forEachSplitRules, getAccessModifier, getAstNode, getEnclosingScope, getFullName, getName, getNoKeywords, getNoKeywordsList, getPackageName, getSpannedScope, getSplitRules, getSplitRulesList, getStereoinfo, getThis, hashCodeNoKeywords, hashCodeSplitRules, indexOfNoKeywords, indexOfSplitRules, isEmptyNoKeywords, isEmptySplitRules, isIsComponent, isPresentAstNode, iteratorNoKeywords, iteratorSplitRules, lastIndexOfNoKeywords, lastIndexOfSplitRules, listIteratorNoKeywords, listIteratorNoKeywords, listIteratorSplitRules, listIteratorSplitRules, parallelStreamNoKeywords, parallelStreamSplitRules, removeAllNoKeywords, removeAllSplitRules, removeIfNoKeywords, removeIfSplitRules, removeNoKeywords, removeNoKeywords, removeSplitRules, removeSplitRules, replaceAllNoKeywords, replaceAllSplitRules, retainAllNoKeywords, retainAllSplitRules, setAccessModifier, setAstNode, setAstNodeAbsent, setEnclosingScope, setFullName, setIsComponent, setName, setNoKeywords, setNoKeywordsList, setPackageName, setSpannedScope, setSplitRules, setSplitRulesList, setStereoinfo, sizeNoKeywords, sizeSplitRules, sortNoKeywords, sortSplitRules, spliteratorNoKeywords, spliteratorSplitRules, streamNoKeywords, streamSplitRules, subListNoKeywords, subListSplitRules, toArrayNoKeywords, toArrayNoKeywords, toArraySplitRules, toArraySplitRules, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.monticore.symboltable.ISymbol

getSourcePosition

Field Details

DEFAULT_MODE

public static final String DEFAULT_MODE

See Also:

• Constant Field Values

superGrammars

protected final List<Supplier<Optional<MCGrammarSymbol>>> superGrammars

tokenModes

protected Map<String,Collection<String>> tokenModes

replacedKeywords

protected Map<String,Collection<String>> replacedKeywords

prodCache

protected final com.google.common.cache.LoadingCache<String,Optional<ProdSymbol>> prodCache

startProd

protected ProdSymbol startProd

Constructor Details

MCGrammarSymbol

public MCGrammarSymbol(String name)

Method Details

setStartProd

public void setStartProd(ProdSymbol startRule)

getStartProd

public Optional<ProdSymbol> getStartProd()

The start production typically is the first defined production in the grammar.

Returns:

the start production of the grammar, if not a component grammar

getSuperGrammars

@Deprecated
public List<MCGrammarSymbol> getSuperGrammars()

Deprecated.

getSuperGrammarSymbols()

With the (planned) removal of SymbolSurrogates, real symbols are already returned

getSuperGrammarSymbols

public List<MCGrammarSymbol> getSuperGrammarSymbols()

Returns the list of super grammar symbols. Resolves these symbols if needed.

Returns:

the list of resolved super grammar symbols

Throws:

NoSuchElementException - in case errors during the symbol resolution were ignored

getAllSuperGrammars

public List<MCGrammarSymbol> getAllSuperGrammars()

addSuperGrammar

@Deprecated
public void addSuperGrammar(Supplier<MCGrammarSymbol> superGrammarRef)

Deprecated.

addSuperGrammarSupplier

public void addSuperGrammarSupplier(Supplier<Optional<MCGrammarSymbol>> superGrammarRef)

getProds

public Collection<ProdSymbol> getProds()

getProdNames

public Collection<String> getProdNames()

getProd

public Optional<ProdSymbol> getProd(String prodName)

getProdWithInherited

public Optional<ProdSymbol> getProdWithInherited(String ruleName)

getInheritedProd

public Optional<ProdSymbol> getInheritedProd(String ruleName)

getProdsWithInherited

public Map<String,ProdSymbol> getProdsWithInherited()

getTokenRulesWithInherited

public Collection<String> getTokenRulesWithInherited()

getKeywordRulesWithInherited

public Collection<String> getKeywordRulesWithInherited()

getTokenModesWithInherited

public Map<String,Collection<String>> getTokenModesWithInherited()

getReplacedKeywordsWithInherited

public Map<String,Collection<String>> getReplacedKeywordsWithInherited()

getTokenModes

public Map<String,Collection<String>> getTokenModes()

getAdditionalKeywords

@Deprecated
public Map<String,Collection<String>> getAdditionalKeywords()

Deprecated.

getReplacedKeywords

public Map<String,Collection<String>> getReplacedKeywords()

getAstGrammar

public Optional<ASTMCGrammar> getAstGrammar()

determineFullName

protected String determineFullName()

Determines dynamically the full name of the symbol.

Overrides:

determineFullName in class MCGrammarSymbolTOP

Returns:

the full name of the symbol determined dynamically

determinePackageName

protected String determinePackageName()

Overrides:

determinePackageName in class MCGrammarSymbolTOP

addMode

public void addMode(String modeName,
 String tokenName)

addKeywords

public void addKeywords(String keyword,
 Collection<String> additionalKeywords)