Package org.ek9lang.compiler.symbols

Class LocalScope

java.lang.Object

org.ek9lang.compiler.symbols.SymbolTable

org.ek9lang.compiler.symbols.LocalScope

All Implemented Interfaces:

Serializable, IScope

Direct Known Subclasses:

CaptureScope

public class LocalScope
extends SymbolTable

Used in many ways via composition. The local scope can be either just a block (if, where, etc.) or aggregate (class, component, etc.).

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.ek9lang.compiler.symbols.IScope

IScope.ScopeType

Constructor Summary

Constructors

Constructor	Description
LocalScope(String scopeName, IScope enclosingScope)	Create a new named local scope with an outer enclosing scope.
LocalScope(IScope enclosingScope)
LocalScope(IScope.ScopeType scopeType, String scopeName, IScope enclosingScope)	Create a new named local scope with an outer enclosing scope.

Method Summary

Modifier and Type	Method	Description
LocalScope	clone(IScope withParentAsAppropriate)
LocalScope	cloneIntoLocalScope(LocalScope newCopy)	Clones the content of this into the new copy.
boolean	equals(Object o)
Optional<ScopedSymbol>	findNearestDynamicBlockScopeInEnclosingScopes()
Optional<ScopedSymbol>	findNearestNonBlockScopeInEnclosingScopes()	Traverses up the scope tree of enclosing scopes to find the first scope type that is an aggregate.
IScope	getEnclosingScope()
IScope.ScopeType	getScopeType()
int	hashCode()
boolean	isScopeAMatchForEnclosingScope(IScope toCheck)	Useful to be able to check if the scope you have in hand is the same the enclosing scope for this.
protected MethodSymbolSearchResult	resolveMatchingMethodsInEnclosingScope(MethodSymbolSearch search, MethodSymbolSearchResult result)	There are no supers so this will not add any methods.
Optional<ISymbol>	resolveWithEnclosingScope(SymbolSearch search)	This class is the root and so there is no enclosing scope.
void	setScopeType(IScope.ScopeType scopeType)

Methods inherited from class org.ek9lang.compiler.symbols.SymbolTable

cloneIntoSymbolTable, define, getAllSymbolsMatchingName, getEncounteredExceptionToken, getFriendlyScopeName, getScopeName, getSymbolsForThisScope, getSymbolsForThisScopeOfCategory, isMarkedPure, isTerminatedNormally, resolve, resolveInThisScopeOnly, resolveMatchingMethods, resolveMatchingMethodsInThisScopeOnly, resolveMember, searchIsNotInThisScope, setEncounteredExceptionToken, setMarkedPure, toString

Methods inherited from class java.lang.Object

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

Constructor Details

LocalScope

public LocalScope(String scopeName,
 IScope enclosingScope)

Create a new named local scope with an outer enclosing scope. Scope type default to BLOCK.

LocalScope

public LocalScope(IScope.ScopeType scopeType,
 String scopeName,
 IScope enclosingScope)

Create a new named local scope with an outer enclosing scope. But will set the scope type to the type passed in.

LocalScope

public LocalScope(IScope enclosingScope)

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class SymbolTable

hashCode

public int hashCode()

Overrides:

hashCode in class SymbolTable

clone

public LocalScope clone(IScope withParentAsAppropriate)

Specified by:

clone in interface IScope

Overrides:

clone in class SymbolTable

cloneIntoLocalScope

public LocalScope cloneIntoLocalScope(LocalScope newCopy)

Clones the content of this into the new copy.

getScopeType

public IScope.ScopeType getScopeType()

Specified by:

getScopeType in interface IScope

Overrides:

getScopeType in class SymbolTable

setScopeType

public void setScopeType(IScope.ScopeType scopeType)

getEnclosingScope

public IScope getEnclosingScope()

Specified by:

getEnclosingScope in interface IScope

Overrides:

getEnclosingScope in class SymbolTable

isScopeAMatchForEnclosingScope

public boolean isScopeAMatchForEnclosingScope(IScope toCheck)

Useful to be able to check if the scope you have in hand is the same the enclosing scope for this. Typically, used when looking at access modifiers. Find the scope of the aggregate (assuming not a function) where the call is being made from then call this to see if that scope is the same enclosing scope. Then you can determine if access should be allowed.

Specified by:

isScopeAMatchForEnclosingScope in interface IScope

Overrides:

isScopeAMatchForEnclosingScope in class SymbolTable

Parameters:

toCheck - The scope to check

Returns:

true if a match false otherwise

findNearestNonBlockScopeInEnclosingScopes

public Optional<ScopedSymbol> findNearestNonBlockScopeInEnclosingScopes()

Traverses up the scope tree of enclosing scopes to find the first scope type that is an aggregate. It might not find anything - if you call this in a local scope in a function or program there is no aggregate up the enclosing scopes only in class/component type stuff is there an aggregate scope for things.

Specified by:

findNearestNonBlockScopeInEnclosingScopes in interface IScope

Overrides:

findNearestNonBlockScopeInEnclosingScopes in class SymbolTable

Returns:

An Optional scope of the first encounter with and scope that is an aggregate or empty.

findNearestDynamicBlockScopeInEnclosingScopes

public Optional<ScopedSymbol> findNearestDynamicBlockScopeInEnclosingScopes()

Specified by:

findNearestDynamicBlockScopeInEnclosingScopes in interface IScope

Overrides:

findNearestDynamicBlockScopeInEnclosingScopes in class SymbolTable

resolveWithEnclosingScope

public Optional<ISymbol> resolveWithEnclosingScope(SymbolSearch search)

Description copied from class: SymbolTable

This class is the root and so there is no enclosing scope. subclasses will override to provide the scope that encloses them

Overrides:

resolveWithEnclosingScope in class SymbolTable

resolveMatchingMethodsInEnclosingScope

protected MethodSymbolSearchResult resolveMatchingMethodsInEnclosingScope(MethodSymbolSearch search,
 MethodSymbolSearchResult result)

Description copied from class: SymbolTable

There are no supers so this will not add any methods.

Overrides:

resolveMatchingMethodsInEnclosingScope in class SymbolTable