Package gw.lang.parser.exceptions

Class ParseIssue

java.lang.Object

java.lang.Throwable

java.lang.Exception

gw.lang.parser.exceptions.ParseIssue

All Implemented Interfaces:

IParseIssue, java.io.Serializable

Direct Known Subclasses:

ParseException, ParseWarning

public abstract class ParseIssue
extends java.lang.Exception
implements IParseIssue

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Integer	_lineNumber
private java.lang.Integer	_lineOffset
private java.lang.Object[]	_messageArgs
private ResourceKey	_messageKey
private IGosuClass	_parentClass
private IParsedElement	_parentElement
private java.lang.String	_stateSource
private ISymbolTable	_symbolTable
private java.lang.Integer	_tokenColumn
private java.lang.Integer	_tokenEnd
private java.lang.Integer	_tokenStart
private static int	CONTEXT_LINES
private static java.lang.String	SOURCE_DELIMITER

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParseIssue(IParserState parserState, ResourceKey key, java.lang.Object... msgArgs)
protected	ParseIssue(IParserState state, java.lang.Throwable t)
protected	ParseIssue(java.lang.Integer lineNumber, java.lang.Integer lineOffset, java.lang.Integer tokenColumn, java.lang.Integer tokenStart, java.lang.Integer tokenEnd, ISymbolTable symbolTable, ResourceKey key, java.lang.Object... msgArgs)

Method Summary

Modifier and Type	Method	Description
void	addLineOffset(int offset)
void	adjustOffset(int offset, int lineNumOffset, int columnOffset)
boolean	appliesToPosition(int iPos)	Returns true if this issue is relevant to the given position
private void	debug()
java.lang.Throwable	fillInStackTrace()	Don't fill in stack trace since parse issues are not really "exceptional" in terms of the parser's Java implementation; we don't care much about the Java stack trace when these are thrown.
protected static java.lang.String	formatError(ResourceKey key, java.lang.Object... msgArgs)
int	getColumn()
java.lang.String	getConsoleMessage()
java.lang.String	getContextString()
java.lang.String	getContextStringNoLineNumbers()
IType	getExpectedType()
int	getLine()
java.lang.Integer	getLineNumber()
java.lang.Integer	getLineOffset()
int	getLineReportingOffset()
java.lang.Object[]	getMessageArgs()
ResourceKey	getMessageKey()
private java.lang.String	getMyMessage()
java.lang.String	getPlainMessage()
IParsedElement	getSource()	Warning: Only valid if called from the parser thread.
java.lang.String	getStateSource()
ISymbolTable	getSymbolTable()	Warning: Only valid if called from the parser thread.
java.lang.Integer	getTokenColumn()
java.lang.Integer	getTokenEnd()
java.lang.Integer	getTokenStart()
java.lang.String	getUIMessage()
private void	initFieldsFromParserState(IParserState parserState)
static java.lang.String	makeContextString(int lineOfError, java.lang.String source, int lineReportingOffset)
private static java.lang.String	makeContextString(int lineOfError, java.lang.String source, int lineReportingOffset, boolean showLineNumbers)
private java.lang.Object[]	normalizeMessageArgs(java.lang.Object[] args)	Normalize all non string & non number args to string types to prevent race conditions wrt/ the TypeSystem lock when the message is formatted.
void	resetPositions()
void	resolve(IParserPart parserBase)
void	setMessage(ResourceKey key, java.lang.Object... args)
void	setSource(IParsedElement sourceOfError)
void	setStateSource(java.lang.String parserSource)

Methods inherited from class java.lang.Throwable

addSuppressed, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface gw.lang.parser.IParseIssue

printStackTrace, setExpectedType

Field Detail

SOURCE_DELIMITER

private static final java.lang.String SOURCE_DELIMITER

See Also:

Constant Field Values

CONTEXT_LINES

private static final int CONTEXT_LINES

See Also:

Constant Field Values

_lineNumber

private java.lang.Integer _lineNumber

_lineOffset

private java.lang.Integer _lineOffset

_tokenColumn

private java.lang.Integer _tokenColumn

_tokenStart

private java.lang.Integer _tokenStart

_tokenEnd

private java.lang.Integer _tokenEnd

_messageKey

private ResourceKey _messageKey

_messageArgs

private java.lang.Object[] _messageArgs

_symbolTable

private ISymbolTable _symbolTable

_parentElement

private IParsedElement _parentElement

_stateSource

private java.lang.String _stateSource

_parentClass

private IGosuClass _parentClass

Constructor Detail

ParseIssue

protected ParseIssue(IParserState parserState,
                     ResourceKey key,
                     java.lang.Object... msgArgs)

ParseIssue

protected ParseIssue(java.lang.Integer lineNumber,
                     java.lang.Integer lineOffset,
                     java.lang.Integer tokenColumn,
                     java.lang.Integer tokenStart,
                     java.lang.Integer tokenEnd,
                     ISymbolTable symbolTable,
                     ResourceKey key,
                     java.lang.Object... msgArgs)

ParseIssue

protected ParseIssue(IParserState state,
                     java.lang.Throwable t)

Method Detail

debug

private void debug()

fillInStackTrace

public java.lang.Throwable fillInStackTrace()

Don't fill in stack trace since parse issues are not really "exceptional" in terms of the parser's Java implementation; we don't care much about the Java stack trace when these are thrown. Rather parse issues provide a means to tag parsed elements with issues discovered during parsing, such as syntax warnings and errors. Hence, the ParseIssue interface.

Note this method is otherwise very costly from a performance standpoint.

Overrides:

fillInStackTrace in class java.lang.Throwable

initFieldsFromParserState

private void initFieldsFromParserState(IParserState parserState)

normalizeMessageArgs

private java.lang.Object[] normalizeMessageArgs(java.lang.Object[] args)

Normalize all non string & non number args to string types to prevent race conditions wrt/ the TypeSystem lock when the message is formatted.

formatError

protected static java.lang.String formatError(ResourceKey key,
                                              java.lang.Object... msgArgs)

getLineNumber

public java.lang.Integer getLineNumber()

getLineOffset

public java.lang.Integer getLineOffset()

addLineOffset

public void addLineOffset(int offset)

getTokenColumn

public java.lang.Integer getTokenColumn()

getTokenEnd

public java.lang.Integer getTokenEnd()

Specified by:

getTokenEnd in interface IParseIssue

getTokenStart

public java.lang.Integer getTokenStart()

Specified by:

getTokenStart in interface IParseIssue

getContextString

public java.lang.String getContextString()

getContextStringNoLineNumbers

public java.lang.String getContextStringNoLineNumbers()

getStateSource

public java.lang.String getStateSource()

setStateSource

public void setStateSource(java.lang.String parserSource)

getMyMessage

private java.lang.String getMyMessage()

getPlainMessage

public java.lang.String getPlainMessage()

Specified by:

getPlainMessage in interface IParseIssue

Returns:

the raw message for this parse issue, with no formatting

getConsoleMessage

public java.lang.String getConsoleMessage()

Specified by:

getConsoleMessage in interface IParseIssue

Returns:

the message for this parse issue formatted for printing out to a console

makeContextString

public static java.lang.String makeContextString(int lineOfError,
                                                 java.lang.String source,
                                                 int lineReportingOffset)

makeContextString

private static java.lang.String makeContextString(int lineOfError,
                                                  java.lang.String source,
                                                  int lineReportingOffset,
                                                  boolean showLineNumbers)

getUIMessage

public java.lang.String getUIMessage()

Specified by:

getUIMessage in interface IParseIssue

Returns:

the message formatted for use by an IDE

getLine

public int getLine()

Specified by:

getLine in interface IParseIssue

Returns:

the line that this issue is on

getColumn

public int getColumn()

Specified by:

getColumn in interface IParseIssue

getSource

public IParsedElement getSource()

Warning: Only valid if called from the parser thread. Otherwise we null it out.

Specified by:

getSource in interface IParseIssue

Returns:

the parsed element that this issue is associated with

setSource

public void setSource(IParsedElement sourceOfError)

getSymbolTable

public ISymbolTable getSymbolTable()

Warning: Only valid if called from the parser thread. Otherwise we null it out.

Specified by:

getSymbolTable in interface IParseIssue

Returns:

the symbol table state at the creation of this issue. Can return null if no symbol table is present.

appliesToPosition

public boolean appliesToPosition(int iPos)

Description copied from interface: IParseIssue

Returns true if this issue is relevant to the given position

Specified by:

appliesToPosition in interface IParseIssue

getMessageKey

public ResourceKey getMessageKey()

Specified by:

getMessageKey in interface IParseIssue

Returns:

the resource key for this ParseIssue, which can be used as a kind of identifier for the type of issue.

resolve

public void resolve(IParserPart parserBase)

Specified by:

resolve in interface IParseIssue

resetPositions

public void resetPositions()

Specified by:

resetPositions in interface IParseIssue

adjustOffset

public void adjustOffset(int offset,
                         int lineNumOffset,
                         int columnOffset)

setMessage

public void setMessage(ResourceKey key,
                       java.lang.Object... args)

getMessageArgs

public java.lang.Object[] getMessageArgs()

Specified by:

getMessageArgs in interface IParseIssue

getLineReportingOffset

public int getLineReportingOffset()

getExpectedType

public IType getExpectedType()

Specified by:

getExpectedType in interface IParseIssue