Package gw.internal.gosu.parser

Class ParsedElement

java.lang.Object

gw.internal.gosu.parser.ParsedElement

All Implemented Interfaces:

IParsedElement

Direct Known Subclasses:

Expression, Statement

public abstract class ParsedElement
extends java.lang.Object
implements IParsedElement

ParsedElement is the root class for all non-terminal elements represented in a parse tree i.e., all non-terminal expressions and statements derive either directly or indirectly from this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ParsedElement.LikelyNullFields

Field Summary

Fields

Modifier and Type	Field	Description
private IGosuProgramInternal	_gosuProgram
private int	_iColumn
private int	_iLineNum
private ParsedElement.LikelyNullFields	_lnf
private ParseTree	_location
private IParsedElement	_parent
protected java.util.List<IToken>	_tokens
private static java.util.List<IParseTree>	EMPTY_PARSETREE_LIST
static java.lang.String	UNDEF_FILE
static java.lang.String	UNDEF_FUNCTION
static java.lang.String	UNDEF_MODULE

Constructor Summary

Constructors

Constructor	Description
ParsedElement()

Method Summary

Modifier and Type	Method	Description
void	addExceptionsFrom(IParsedElement elem)
void	addParseException(IFullParserState parserState, ResourceKey msgKey, java.lang.Object... args)
void	addParseException(IParseIssue pe)
void	addParseException(ResourceKey msgKey, java.lang.Object... args)
void	addParseExceptions(java.util.List<IParseIssue> parseExceptions)
void	addParseIssues(java.util.List<IParseIssue> parseIssues)
void	addParseWarning(IParseIssue warning)
void	addParseWarning(ResourceKey msgKey, java.lang.Object... args)
void	addParseWarnings(java.util.List<IParseIssue> parseWarnings)
protected void	addToken(IToken token, IParseTree after)
void	adjustColumn(int offset)
void	adjustLineNum(int offset)
void	assignTokens(java.util.List<Token> tokens)
private void	assignTokensToJustMe(java.util.List<Token> tokens)
private int	binarySearchForFirstToken(java.util.List<Token> tokens, int iTreeOffset, int iTreeEnd, boolean bZeroLengthTree)
private static IParsedElementWithAtLeastOneDeclaration	checkIfDeclaringStatement(IParsedElement parsedElement, java.lang.String identifierName)
void	clearParseExceptions()
void	clearParseTreeInformation()
void	clearParseWarnings()
void	compactParseTree()
private boolean	containsToken(java.util.List<IToken> tokens, IToken target)
private static boolean	elementIsOneOfType(IParsedElement element, java.lang.Class[] parsedElementClasses)
IParsedElement	findAncestorParsedElementByType(java.lang.Class... parsedElementClasses)
IParsedElementWithAtLeastOneDeclaration	findDeclaringStatement(IParsedElement element, java.lang.String identifierName)
private static IParsedElementWithAtLeastOneDeclaration	findDeclaringStatementInChildren(IParsedElement element, java.lang.String identifierName)
int	findLineNumberOfDeclaration(java.lang.String identifierName)
IParsedElement	findRootParsedElement()
java.util.List<IGosuAnnotation>	getAnnotations()
int	getColumn()
<E extends IParsedElement> boolean	getContainedParsedElementsByType(java.lang.Class<E> parsedElementType, java.util.List<E> listResults)	Find all the parsed elements of a given type contained within this parsed element.
boolean	getContainedParsedElementsByTypes(java.util.List<IParsedElement> listResults, java.lang.Class<? extends IParsedElement>... parsedElementTypes)
boolean	getContainedParsedElementsByTypesWithIgnoreSet(java.util.List<IParsedElement> listResults, java.util.Set<java.lang.Class<? extends IParsedElement>> ignoreSet, java.lang.Class<? extends IParsedElement>... parsedElementTypes)
static IFeatureInfo	getEnclosingFeatureInfo(java.util.Stack<IFeatureInfo> enclosingFeatureInfos)
java.lang.String	getFunctionName()
IGosuClass	getGosuClass()
IGosuProgramInternal	getGosuProgram()
IParseIssue	getImmediateParseIssue(ResourceKey errKey)
java.util.List<IParseIssue>	getImmediateParseIssues()
int	getLineNum()
ParseTree	getLocation()
IModule	getModule()
IParsedElement	getParent()
java.util.List<IParseIssue>	getParseExceptions()
private void	getParseExceptions(java.util.List<IParseIssue> allParseExceptions)
java.util.List<IParseIssue>	getParseIssues()
java.util.List<IParseIssue>	getParseWarnings()
private void	getParseWarnings(java.util.List<IParseIssue> allWarnings)
static ITypeInfo	getQualifyingEnclosingTypeInfo(java.util.Stack<IFeatureInfo> enclosingFeatureInfos)
private java.lang.String	getSource()
java.util.List<IToken>	getTokens()
boolean	hasImmediateParseIssue(ResourceKey errKey)
boolean	hasImmediateParseWarning(ResourceKey errKey)
boolean	hasImmediateParseWarnings()
boolean	hasParseException(ResourceKey errKey)
boolean	hasParseExceptions()
boolean	hasParseIssue(IParseIssue pi)
boolean	hasParseIssues()
boolean	hasParseWarning(ResourceKey errKey)
boolean	hasParseWarnings()
void	initEmptyParseTree()
ParseTree	initLocation(int offset, int length, int lineNumber, int iColumn, IScriptPartId scriptPart)
boolean	isCompileTimeConstant()
private boolean	isDescendent(IParseTree after)
boolean	isSuppressed(IWarningSuppressor suppressor)
boolean	isSuppressed(IParseIssue issue)
boolean	isSynthetic()
static double	makeDoubleValue(java.lang.Object obj)	Just like makeDouble(), but creates a double primitive value instead of a Double object.
static float	makeFloatValue(java.lang.Object obj)	Just like makeFloat(), but creates a float primitive value instead of a Float object.
java.lang.Integer	makeInteger(java.lang.Object obj)
static java.lang.Long	makeLong(java.lang.Object obj)
private void	maybeInitLikelyNullFields()
ParseException	removeParseException(ResourceKey keyToRemove)	Removes the specified parse exception or removes them all if the specified exception is null.
private <E extends IParseIssue> E	removeParseIssue(ResourceKey keyToRemove, java.util.List<E> issues)
ParseWarning	removeParseWarning(ResourceKey keyToRemove)
void	removeParseWarningRecursively(ResourceKey keyToRemove)
void	setGosuProgram(IGosuProgramInternal gosuProgram)
void	setLineNum(int iLineNum)
void	setLocation(IParseTree location)	Specifiy the location of this parsed element within the source.
void	setParent(IParsedElement parent)
void	setSynthetic(boolean bSynthetic)
boolean	shouldClearParseInfo()
void	visit(java.util.function.Consumer<IParsedElement> visitor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface gw.lang.parser.IParsedElement

getReturnType

Field Detail

EMPTY_PARSETREE_LIST

private static final java.util.List<IParseTree> EMPTY_PARSETREE_LIST

UNDEF_MODULE

public static final java.lang.String UNDEF_MODULE

See Also:

Constant Field Values

UNDEF_FUNCTION

public static final java.lang.String UNDEF_FUNCTION

See Also:

Constant Field Values

UNDEF_FILE

public static final java.lang.String UNDEF_FILE

See Also:

Constant Field Values

_location

private ParseTree _location

_parent

private IParsedElement _parent

_iLineNum

private int _iLineNum

_iColumn

private int _iColumn

_lnf

private ParsedElement.LikelyNullFields _lnf

_gosuProgram

private IGosuProgramInternal _gosuProgram

_tokens

protected java.util.List<IToken> _tokens

Constructor Detail

ParsedElement

ParsedElement()

Method Detail

getGosuProgram

public IGosuProgramInternal getGosuProgram()

Specified by:

getGosuProgram in interface IParsedElement

setGosuProgram

public void setGosuProgram(IGosuProgramInternal gosuProgram)

addExceptionsFrom

public void addExceptionsFrom(IParsedElement elem)

Specified by:

addExceptionsFrom in interface IParsedElement

maybeInitLikelyNullFields

private void maybeInitLikelyNullFields()

getLocation

public ParseTree getLocation()

Specified by:

getLocation in interface IParsedElement

Returns:

The location of this parsed element within the source.

setLocation

public void setLocation(IParseTree location)

Specifiy the location of this parsed element within the source.

Specified by:

setLocation in interface IParsedElement

Parameters:

location - The location of this parsed element within the source.

initLocation

public ParseTree initLocation(int offset,
                              int length,
                              int lineNumber,
                              int iColumn,
                              IScriptPartId scriptPart)

visit

public void visit(java.util.function.Consumer<IParsedElement> visitor)

Specified by:

visit in interface IParsedElement

initEmptyParseTree

public void initEmptyParseTree()

hasParseIssues

public boolean hasParseIssues()

Specified by:

hasParseIssues in interface IParsedElement

getParseIssues

public java.util.List<IParseIssue> getParseIssues()

Specified by:

getParseIssues in interface IParsedElement

getImmediateParseIssues

public java.util.List<IParseIssue> getImmediateParseIssues()

Specified by:

getImmediateParseIssues in interface IParsedElement

hasParseExceptions

public boolean hasParseExceptions()

Specified by:

hasParseExceptions in interface IParsedElement

hasParseException

public boolean hasParseException(ResourceKey errKey)

Specified by:

hasParseException in interface IParsedElement

getImmediateParseIssue

public IParseIssue getImmediateParseIssue(ResourceKey errKey)

Specified by:

getImmediateParseIssue in interface IParsedElement

hasImmediateParseIssue

public boolean hasImmediateParseIssue(ResourceKey errKey)

Specified by:

hasImmediateParseIssue in interface IParsedElement

hasParseWarning

public boolean hasParseWarning(ResourceKey errKey)

Specified by:

hasParseWarning in interface IParsedElement

addParseWarnings

public void addParseWarnings(java.util.List<IParseIssue> parseWarnings)

addParseExceptions

public void addParseExceptions(java.util.List<IParseIssue> parseExceptions)

addParseIssues

public void addParseIssues(java.util.List<IParseIssue> parseIssues)

getParseExceptions

public java.util.List<IParseIssue> getParseExceptions()

Specified by:

getParseExceptions in interface IParsedElement

getParseExceptions

private void getParseExceptions(java.util.List<IParseIssue> allParseExceptions)

addParseException

public void addParseException(ResourceKey msgKey,
                              java.lang.Object... args)

Specified by:

addParseException in interface IParsedElement

addParseException

public void addParseException(IFullParserState parserState,
                              ResourceKey msgKey,
                              java.lang.Object... args)

removeParseException

public ParseException removeParseException(ResourceKey keyToRemove)

Removes the specified parse exception or removes them all if the specified exception is null.

removeParseWarning

public ParseWarning removeParseWarning(ResourceKey keyToRemove)

removeParseWarningRecursively

public void removeParseWarningRecursively(ResourceKey keyToRemove)

removeParseIssue

private <E extends IParseIssue> E removeParseIssue(ResourceKey keyToRemove,
                                                   java.util.List<E> issues)

getSource

private java.lang.String getSource()

getGosuClass

public IGosuClass getGosuClass()

Specified by:

getGosuClass in interface IParsedElement

addParseWarning

public void addParseWarning(ResourceKey msgKey,
                            java.lang.Object... args)

Specified by:

addParseWarning in interface IParsedElement

addParseException

public void addParseException(IParseIssue pe)

Specified by:

addParseException in interface IParsedElement

clearParseExceptions

public void clearParseExceptions()

Specified by:

clearParseExceptions in interface IParsedElement

clearParseWarnings

public void clearParseWarnings()

Specified by:

clearParseWarnings in interface IParsedElement

hasImmediateParseWarnings

public boolean hasImmediateParseWarnings()

Specified by:

hasImmediateParseWarnings in interface IParsedElement

hasImmediateParseWarning

public boolean hasImmediateParseWarning(ResourceKey errKey)

hasParseWarnings

public boolean hasParseWarnings()

Specified by:

hasParseWarnings in interface IParsedElement

getParseWarnings

public java.util.List<IParseIssue> getParseWarnings()

Specified by:

getParseWarnings in interface IParsedElement

getParseWarnings

private void getParseWarnings(java.util.List<IParseIssue> allWarnings)

addParseWarning

public void addParseWarning(IParseIssue warning)

Specified by:

addParseWarning in interface IParsedElement

hasParseIssue

public boolean hasParseIssue(IParseIssue pi)

Specified by:

hasParseIssue in interface IParsedElement

isSuppressed

public boolean isSuppressed(IParseIssue issue)

isSuppressed

public boolean isSuppressed(IWarningSuppressor suppressor)

Specified by:

isSuppressed in interface IParsedElement

getAnnotations

public java.util.List<IGosuAnnotation> getAnnotations()

isCompileTimeConstant

public boolean isCompileTimeConstant()

Specified by:

isCompileTimeConstant in interface IParsedElement

getContainedParsedElementsByType

public <E extends IParsedElement> boolean getContainedParsedElementsByType(java.lang.Class<E> parsedElementType,
                                                                           java.util.List<E> listResults)

Find all the parsed elements of a given type contained within this parsed element.

Specified by:

getContainedParsedElementsByType in interface IParsedElement

Parameters:

parsedElementType - The type of parsed element to find.

listResults - A list of all the contained parsed elements matching the specified type. Can be null if you are only interested in whether or not parsedElementType exists in this element.

Returns:

True iff one or more parseElementType are found.

getContainedParsedElementsByTypes

public boolean getContainedParsedElementsByTypes(java.util.List<IParsedElement> listResults,
                                                 java.lang.Class<? extends IParsedElement>... parsedElementTypes)

Specified by:

getContainedParsedElementsByTypes in interface IParsedElement

getContainedParsedElementsByTypesWithIgnoreSet

public boolean getContainedParsedElementsByTypesWithIgnoreSet(java.util.List<IParsedElement> listResults,
                                                              java.util.Set<java.lang.Class<? extends IParsedElement>> ignoreSet,
                                                              java.lang.Class<? extends IParsedElement>... parsedElementTypes)

Specified by:

getContainedParsedElementsByTypesWithIgnoreSet in interface IParsedElement

makeInteger

public final java.lang.Integer makeInteger(java.lang.Object obj)

makeLong

public static java.lang.Long makeLong(java.lang.Object obj)

makeDoubleValue

public static double makeDoubleValue(java.lang.Object obj)

Just like makeDouble(), but creates a double primitive value instead of a Double object. Much more efficient if you don't need the object.

Parameters:

obj - Any double convertible object

Returns:

The double primitive value.

makeFloatValue

public static float makeFloatValue(java.lang.Object obj)

Just like makeFloat(), but creates a float primitive value instead of a Float object. Much more efficient if you don't need the object.

Parameters:

obj - Any float convertible object

Returns:

The float primitive value.

compactParseTree

public void compactParseTree()

clearParseTreeInformation

public void clearParseTreeInformation()

Specified by:

clearParseTreeInformation in interface IParsedElement

getParent

public IParsedElement getParent()

Specified by:

getParent in interface IParsedElement

setParent

public void setParent(IParsedElement parent)

Specified by:

setParent in interface IParsedElement

getLineNum

public int getLineNum()

Specified by:

getLineNum in interface IParsedElement

adjustLineNum

public void adjustLineNum(int offset)

setLineNum

public void setLineNum(int iLineNum)

getColumn

public int getColumn()

Specified by:

getColumn in interface IParsedElement

adjustColumn

public void adjustColumn(int offset)

getFunctionName

public java.lang.String getFunctionName()

Specified by:

getFunctionName in interface IParsedElement

isSynthetic

public boolean isSynthetic()

Specified by:

isSynthetic in interface IParsedElement

setSynthetic

public void setSynthetic(boolean bSynthetic)

getModule

public IModule getModule()

Specified by:

getModule in interface IParsedElement

getEnclosingFeatureInfo

public static IFeatureInfo getEnclosingFeatureInfo(java.util.Stack<IFeatureInfo> enclosingFeatureInfos)

getQualifyingEnclosingTypeInfo

public static ITypeInfo getQualifyingEnclosingTypeInfo(java.util.Stack<IFeatureInfo> enclosingFeatureInfos)

findLineNumberOfDeclaration

public int findLineNumberOfDeclaration(java.lang.String identifierName)

findDeclaringStatement

public IParsedElementWithAtLeastOneDeclaration findDeclaringStatement(IParsedElement element,
                                                                      java.lang.String identifierName)

Specified by:

findDeclaringStatement in interface IParsedElement

findDeclaringStatementInChildren

private static IParsedElementWithAtLeastOneDeclaration findDeclaringStatementInChildren(IParsedElement element,
                                                                                        java.lang.String identifierName)

checkIfDeclaringStatement

private static IParsedElementWithAtLeastOneDeclaration checkIfDeclaringStatement(IParsedElement parsedElement,
                                                                                 java.lang.String identifierName)

findRootParsedElement

public IParsedElement findRootParsedElement()

Specified by:

findRootParsedElement in interface IParsedElement

findAncestorParsedElementByType

public IParsedElement findAncestorParsedElementByType(java.lang.Class... parsedElementClasses)

Specified by:

findAncestorParsedElementByType in interface IParsedElement

Parameters:

parsedElementClasses - List of statement types to find

Returns:

The nearest ancestor statement that is any one of the given types. null if this element does not have an ancestor of any of the given types

elementIsOneOfType

private static boolean elementIsOneOfType(IParsedElement element,
                                          java.lang.Class[] parsedElementClasses)

shouldClearParseInfo

public boolean shouldClearParseInfo()

assignTokens

public void assignTokens(java.util.List<Token> tokens)

addToken

protected void addToken(IToken token,
                        IParseTree after)

getTokens

public java.util.List<IToken> getTokens()

Specified by:

getTokens in interface IParsedElement

assignTokensToJustMe

private void assignTokensToJustMe(java.util.List<Token> tokens)

binarySearchForFirstToken

private int binarySearchForFirstToken(java.util.List<Token> tokens,
                                      int iTreeOffset,
                                      int iTreeEnd,
                                      boolean bZeroLengthTree)

containsToken

private boolean containsToken(java.util.List<IToken> tokens,
                              IToken target)

isDescendent

private boolean isDescendent(IParseTree after)