com.oracle.js.parser.ir

Class Scope

java.lang.Object

com.oracle.js.parser.ir.Scope

public final class Scope
extends Object

Represents a binding scope (corresponds to LexicalEnvironment or VariableEnvironment).

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Map.Entry<VarNode,Scope>>	hoistableBlockFunctionDeclarations
protected List<Map.Entry<VarNode,Scope>>	hoistedVarDeclarations
protected org.graalvm.collections.EconomicMap<String,Symbol>	symbols Symbol table - keys must be returned in the order they were put in.

Method Summary

Modifier and Type	Method and Description
boolean	addPrivateName(String name, int symbolFlags) Add a private bound identifier.
void	close() Closes the scope for symbol registration.
static Scope	createBlock(Scope parent)
static Scope	createCatch(Scope parent)
static Scope	createClass(Scope parent)
static Scope	createEval(Scope parent, boolean strict)
static Scope	createFunctionBody(Scope parent, int functionFlags)
static Scope	createGlobal()
static Scope	createModule()
static Scope	createParameter(Scope parent, int functionFlags)
static Scope	createSwitchBlock(Scope parent)
void	declareHoistedBlockFunctionDeclarations()
Symbol	findBlockScopedSymbolInFunction(String varName) Returns a block scoped symbol in this scope or any of its enclosing scopes within this function.
boolean	findPrivateName(String name)
Symbol	getExistingSymbol(String name) Retrieves an existing symbol defined in the current block.
Scope	getParent()
int	getSymbolCount() Get the number of symbols defined in this block.
Iterable<Symbol>	getSymbols() Get all the symbols defined in this block, in definition order.
boolean	hasBlockScopedOrRedeclaredSymbols()
boolean	hasDeclarations()
boolean	hasHoistedVarDeclarations()
boolean	hasSymbol(String name) Test if a symbol with this name is defined in the current block.
boolean	inClassFieldInitializer()
boolean	inDerivedConstructor()
boolean	inFunction()
boolean	inMethod()
boolean	isBlockScope()
boolean	isCatchParameterScope()
boolean	isClassScope()
boolean	isEvalScope()
boolean	isFunctionBodyScope()
boolean	isFunctionParameterScope()
boolean	isFunctionTopScope()
boolean	isGlobalScope()
boolean	isLexicallyDeclaredName(String varName, boolean annexB, boolean includeParameters) Returns true if the name is lexically declared in this scope or any of its enclosing scopes within this function.
boolean	isModuleScope()
boolean	isSwitchBlockScope()
Symbol	putSymbol(Symbol symbol) Add or overwrite an existing symbol in the block
void	recordHoistableBlockFunctionDeclaration(VarNode functionDeclaration, Scope scope)
void	recordHoistedVarDeclaration(VarNode varDecl, Scope scope)
String	toString()
VarNode	verifyHoistedVarDeclarations()

Methods inherited from class java.lang.Object

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

Field Detail

symbols

protected final org.graalvm.collections.EconomicMap<String,Symbol> symbols

Symbol table - keys must be returned in the order they were put in.

hoistedVarDeclarations

protected List<Map.Entry<VarNode,Scope>> hoistedVarDeclarations

hoistableBlockFunctionDeclarations

protected List<Map.Entry<VarNode,Scope>> hoistableBlockFunctionDeclarations

Method Detail

createGlobal

public static Scope createGlobal()

createModule

public static Scope createModule()

createFunctionBody

public static Scope createFunctionBody(Scope parent,
                                       int functionFlags)

createBlock

public static Scope createBlock(Scope parent)

createCatch

public static Scope createCatch(Scope parent)

createParameter

public static Scope createParameter(Scope parent,
                                    int functionFlags)

createSwitchBlock

public static Scope createSwitchBlock(Scope parent)

createClass

public static Scope createClass(Scope parent)

createEval

public static Scope createEval(Scope parent,
                               boolean strict)

getParent

public Scope getParent()

getSymbols

public Iterable<Symbol> getSymbols()

Get all the symbols defined in this block, in definition order.

Returns:

symbol iterator

getExistingSymbol

public Symbol getExistingSymbol(String name)

Retrieves an existing symbol defined in the current block.

Parameters:

name - the name of the symbol

Returns:

an existing symbol with the specified name defined in the current block, or null if this block doesn't define a symbol with this name.

hasSymbol

public boolean hasSymbol(String name)

Test if a symbol with this name is defined in the current block.

Parameters:

name - the name of the symbol

getSymbolCount

public int getSymbolCount()

Get the number of symbols defined in this block.

putSymbol

public Symbol putSymbol(Symbol symbol)

Add or overwrite an existing symbol in the block

hasBlockScopedOrRedeclaredSymbols

public boolean hasBlockScopedOrRedeclaredSymbols()

hasDeclarations

public boolean hasDeclarations()

isLexicallyDeclaredName

public boolean isLexicallyDeclaredName(String varName,
                                       boolean annexB,
                                       boolean includeParameters)

Returns true if the name is lexically declared in this scope or any of its enclosing scopes within this function.

Parameters:

varName - the declared name

annexB - if true, ignore catch parameters

includeParameters - include parameter scope?

findBlockScopedSymbolInFunction

public Symbol findBlockScopedSymbolInFunction(String varName)

Returns a block scoped symbol in this scope or any of its enclosing scopes within this function.

Parameters:

varName - the symbol name

recordHoistedVarDeclaration

public void recordHoistedVarDeclaration(VarNode varDecl,
                                        Scope scope)

verifyHoistedVarDeclarations

public VarNode verifyHoistedVarDeclarations()

hasHoistedVarDeclarations

public boolean hasHoistedVarDeclarations()

recordHoistableBlockFunctionDeclaration

public void recordHoistableBlockFunctionDeclaration(VarNode functionDeclaration,
                                                    Scope scope)

declareHoistedBlockFunctionDeclarations

public void declareHoistedBlockFunctionDeclarations()

addPrivateName

public boolean addPrivateName(String name,
                              int symbolFlags)

Add a private bound identifier.

Returns:

true if the private name was added, false if it was already declared (duplicate name)

findPrivateName

public boolean findPrivateName(String name)

isBlockScope

public boolean isBlockScope()

isFunctionBodyScope

public boolean isFunctionBodyScope()

isFunctionParameterScope

public boolean isFunctionParameterScope()

isCatchParameterScope

public boolean isCatchParameterScope()

isGlobalScope

public boolean isGlobalScope()

isModuleScope

public boolean isModuleScope()

isFunctionTopScope

public boolean isFunctionTopScope()

isSwitchBlockScope

public boolean isSwitchBlockScope()

isClassScope

public boolean isClassScope()

isEvalScope

public boolean isEvalScope()

inFunction

public boolean inFunction()

inMethod

public boolean inMethod()

inDerivedConstructor

public boolean inDerivedConstructor()

inClassFieldInitializer

public boolean inClassFieldInitializer()

close

public void close()

Closes the scope for symbol registration.

toString

public String toString()

Overrides:

toString in class Object