Scope (Closure Compiler v20170910 API)

java.lang.Object
- com.google.javascript.jscomp.Scope

All Implemented Interfaces:

StaticScope, Serializable

Direct Known Subclasses:

TypedScope
```
public class Scope
extends Object
implements StaticScope, Serializable
```
Scope contains information about a variable scope in JavaScript. Scopes can be nested, a scope points back to its parent scope. A Scope contains information about variables defined in that scope.

See Also:

NodeTraversal, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected int depth

protected Scope parent

protected Node rootNode

protected Map<String,Var> vars

Fields
Modifier and Type	Field and Description
`protected int`	`depth`
`protected Scope`	`parent`
`protected Node`	`rootNode`
`protected Map<String,Var>`	`vars`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Scope(Node rootNode)

Constructors
Modifier	Constructor and Description
`protected`	`Scope(Node rootNode)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Iterable<? extends Var>`	`getAllAccessibleVariables()` Return an iterable over all of the variables accessible to this scope (i.e.
`Iterable<? extends Var>`	`getAllSymbols()`
`Var`	`getArgumentsVar()` Get a unique VAR object to represents "arguments" within this scope
`Scope`	`getClosestHoistScope()` If a var were declared in this scope, return the scope it would be hoisted to.
`int`	`getDepth()` The depth of the scope.
`Var`	`getOwnSlot(String name)` Like `getSlot` but does not recurse into parent scopes.
`Scope`	`getParent()`
`StaticScope`	`getParentScope()` Returns the scope enclosing this one or null if none.
`Node`	`getRootNode()` Gets the container node of the scope.
`Var`	`getSlot(String name)` Returns any defined slot within this scope for this name.
`Var`	`getVar(String name)` Returns the variable, may be null
`int`	`getVarCount()` Returns number of variables in this scope (excluding the special 'arguments' variable)
`Iterable<? extends Var>`	`getVarIterable()` Return an iterable over all of the variables declared in this scope (except the special 'arguments' variable).
`boolean`	`isBlockScope()`
`boolean`	`isCatchScope()`
`boolean`	`isDeclared(String name, boolean recurse)` Returns true if a variable is declared.
`boolean`	`isDeclaredInFunctionBlockOrParameter(String name)` Use only when in a function block scope and want to tell if a name is either at the top of the function block scope or the function parameter scope
`boolean`	`isFunctionBlockScope()`
`boolean`	`isFunctionScope()`
`boolean`	`isGlobal()` Returns whether this is the global scope.
`static boolean`	`isHoistScopeRootNode(Node n)`
`boolean`	`isLocal()` Returns whether this is a local scope (i.e.
`boolean`	`isModuleScope()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - vars
```
protected final Map<String,Var> vars
```
  - parent
```
protected Scope parent
```
  - depth
```
protected int depth
```
  - rootNode
```
protected final Node rootNode
```
- Constructor Detail
  - Scope
```
protected Scope(Node rootNode)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getDepth
```
public int getDepth()
```
    The depth of the scope. The global scope has depth 0.
  - getRootNode
```
public Node getRootNode()
```
    Gets the container node of the scope. This is typically the FUNCTION node or the global BLOCK/SCRIPT node.
    
    Specified by:
    
    getRootNode in interface StaticScope
  - getParent
```
public Scope getParent()
```
  - getParentScope
```
public StaticScope getParentScope()
```
    Description copied from interface: StaticScope
    
    Returns the scope enclosing this one or null if none.
    
    Specified by:
    
    getParentScope in interface StaticScope
  - getSlot
```
public Var getSlot(String name)
```
    Description copied from interface: StaticScope
    
    Returns any defined slot within this scope for this name. This call continues searching through parent scopes if a slot with this name is not found in the current scope.
    
    Specified by:
    
    getSlot in interface StaticScope
    
    Parameters:
    
    name - The name of the variable slot to look up.
    
    Returns:
    
    The defined slot for the variable, or null if no definition exists.
  - getOwnSlot
```
public Var getOwnSlot(String name)
```
    Description copied from interface: StaticScope
    
    Like getSlot but does not recurse into parent scopes.
    
    Specified by:
    
    getOwnSlot in interface StaticScope
  - getVar
```
public Var getVar(String name)
```
    Returns the variable, may be null
  - getArgumentsVar
```
public Var getArgumentsVar()
```
    Get a unique VAR object to represents "arguments" within this scope
  - isDeclaredInFunctionBlockOrParameter
```
public boolean isDeclaredInFunctionBlockOrParameter(String name)
```
    Use only when in a function block scope and want to tell if a name is either at the top of the function block scope or the function parameter scope
  - isDeclared
```
public boolean isDeclared(String name,
                          boolean recurse)
```
    Returns true if a variable is declared.
  - getVarIterable
```
public Iterable<? extends Var> getVarIterable()
```
    Return an iterable over all of the variables declared in this scope (except the special 'arguments' variable).
  - getAllAccessibleVariables
```
public Iterable<? extends Var> getAllAccessibleVariables()
```
    Return an iterable over all of the variables accessible to this scope (i.e. the variables in this scope and its parent scopes). Any variables declared in the local scope with the same name as a variable declared in a parent scope gain precedence - if let x exists in the block scope, a declaration let x from the parent scope would not be included because the parent scope's variable gets shadowed.
    The iterable contains variables from inner scopes before adding variables from outer parent scopes.
    We do not include the special 'arguments' variable.
  - getAllSymbols
```
public Iterable<? extends Var> getAllSymbols()
```
  - getVarCount
```
public int getVarCount()
```
    Returns number of variables in this scope (excluding the special 'arguments' variable)
  - isGlobal
```
public boolean isGlobal()
```
    Returns whether this is the global scope.
  - isLocal
```
public boolean isLocal()
```
    Returns whether this is a local scope (i.e. not the global scope).
  - isBlockScope
```
public boolean isBlockScope()
```
  - isFunctionBlockScope
```
public boolean isFunctionBlockScope()
```
  - isFunctionScope
```
public boolean isFunctionScope()
```
  - isModuleScope
```
public boolean isModuleScope()
```
  - isCatchScope
```
public boolean isCatchScope()
```
  - isHoistScopeRootNode
```
public static boolean isHoistScopeRootNode(Node n)
```
  - getClosestHoistScope
```
public Scope getClosestHoistScope()
```
    If a var were declared in this scope, return the scope it would be hoisted to. For function scopes, we return back the scope itself, since even though there is no way to declare a var inside function parameters, it would make even less sense to say that such declarations would be "hoisted" somewhere else.

Class Scope

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

vars

parent

depth

rootNode

Constructor Detail

Scope

Method Detail

toString

getDepth

getRootNode

getParent

getParentScope

getSlot

getOwnSlot

getVar

getArgumentsVar

isDeclaredInFunctionBlockOrParameter

isDeclared

getVarIterable

getAllAccessibleVariables

getAllSymbols

getVarCount

isGlobal

isLocal

isBlockScope

isFunctionBlockScope

isFunctionScope

isModuleScope

isCatchScope

isHoistScopeRootNode

getClosestHoistScope