Class LocalScopeNames

java.lang.Object

org.ek9lang.compiler.common.LocalScopeNames

public final class LocalScopeNames
extends Object

THE names of the LocalScopes phase 1 creates, and the only place their text is spelt.

The prefixes are a de-facto wire format: compiler-services (location resolution and the scope chain) recognises a scope by the start of its name. Use the constants and the is* tests; never write "If-line-" or startsWith("Returning-param-") again, in either module.

Two shapes exist. A structural scope is <Prefix><line> (atLine(String, IToken)) or <Prefix><line>-<position> (atPosition(String, IToken)); an anonymous block scope is Line-<line>-Position-<position> (block(IToken)).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CATCH_LINE
static final String	FINALLY_LINE
static final String	IF_LINE
static final String	RETURNING_PARAM
static final String	STREAM_FOR_LINE
static final String	TERNARY_PART_LINE

Method Summary

Modifier and Type	Method	Description
static String	atLine(String prefix, IToken token)	A structural scope named for the line the construct starts on.
static String	atPosition(String prefix, IToken token)	A structural scope named for the line and position the construct starts at.
static String	block(IToken token)	The name of an anonymous block scope at a token position.
static boolean	isIf(String scopeName)
static boolean	isReturningParam(String scopeName)

Methods inherited from class Object

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

Field Details

IF_LINE

public static final String IF_LINE

See Also:

• Constant Field Values

CATCH_LINE

public static final String CATCH_LINE

See Also:

• Constant Field Values

FINALLY_LINE

public static final String FINALLY_LINE

See Also:

• Constant Field Values

TERNARY_PART_LINE

public static final String TERNARY_PART_LINE

See Also:

• Constant Field Values

STREAM_FOR_LINE

public static final String STREAM_FOR_LINE

See Also:

• Constant Field Values

RETURNING_PARAM

public static final String RETURNING_PARAM

See Also:

• Constant Field Values

Method Details

atLine

public static String atLine(String prefix,
 IToken token)

A structural scope named for the line the construct starts on.

atPosition

public static String atPosition(String prefix,
 IToken token)

A structural scope named for the line and position the construct starts at.

block

public static String block(IToken token)

The name of an anonymous block scope at a token position.

isIf

public static boolean isIf(String scopeName)

isReturningParam

public static boolean isReturningParam(String scopeName)