-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
AbstractVar.java
224 lines (185 loc) · 5.54 KB
/
AbstractVar.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/*
* Copyright 2018 The Closure Compiler Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.javascript.jscomp;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import com.google.javascript.rhino.JSDocInfo;
import com.google.javascript.rhino.Node;
import com.google.javascript.rhino.StaticRef;
import com.google.javascript.rhino.StaticSlot;
import com.google.javascript.rhino.StaticSourceFile;
import com.google.javascript.rhino.Token;
/**
* Used by {@code Scope} to store information about variables.
*/
public class AbstractVar<S extends AbstractScope<S, V>, V extends AbstractVar<S, V>>
implements StaticSlot, StaticRef {
final String name;
/** Var node */
final Node nameNode;
/** Input source */
final CompilerInput input;
/**
* The index at which the var is declared. e.g. if it's 0, it's the first
* declared variable in that scope
*/
final int index;
/** The enclosing scope */
final S scope;
AbstractVar(String name, Node nameNode, S scope, int index, CompilerInput input) {
this.name = name;
this.nameNode = nameNode;
this.scope = scope;
this.index = index;
this.input = input;
}
// Non-final for jsdev tests
@Override
public String getName() {
return name;
}
@Override
public final Node getNode() {
return nameNode;
}
final CompilerInput getInput() {
return input;
}
@Override
public StaticSourceFile getSourceFile() {
return nameNode.getStaticSourceFile();
}
// Temporarily non-final for TypedVar
@Override
public V getSymbol() {
return thisVar();
}
// Temporarily non-final for TypedVar
@Override
public V getDeclaration() {
return nameNode == null ? null : thisVar();
}
public final Node getParentNode() {
return nameNode == null ? null : nameNode.getParent();
}
/**
* Whether this is a bleeding function (an anonymous named function
* that bleeds into the inner scope).
*/
public boolean isBleedingFunction() {
return NodeUtil.isFunctionExpression(getParentNode());
}
// Temporarily non-final for TypedVar
public S getScope() {
return scope;
}
// Non-final for jsdev tests
public boolean isGlobal() {
return scope.isGlobal();
}
public final boolean isLocal() {
return scope.isLocal();
}
final boolean isExtern() {
return input == null || input.isExtern();
}
/**
* Returns {@code true} if the variable is declared as a constant,
* based on the value reported by {@code NodeUtil}.
*/
public final boolean isInferredConst() {
if (nameNode == null) {
return false;
}
return nameNode.getBooleanProp(Node.IS_CONSTANT_VAR)
|| nameNode.getBooleanProp(Node.IS_CONSTANT_NAME);
}
/**
* Returns {@code true} if the variable is declared as a define.
* A variable is a define if it is annotated by {@code @define}.
*/
public final boolean isDefine() {
JSDocInfo info = getJSDocInfo();
return info != null && info.isDefine();
}
public final Node getInitialValue() {
return NodeUtil.getRValueOfLValue(nameNode);
}
// Non-final for jsdev tests
public Node getNameNode() {
return nameNode;
}
// Non-final for jsdev tests
@Override
public JSDocInfo getJSDocInfo() {
return nameNode == null ? null : NodeUtil.getBestJSDocInfo(nameNode);
}
final boolean isVar() {
return declarationType() == Token.VAR;
}
final boolean isCatch() {
return declarationType() == Token.CATCH;
}
final boolean isLet() {
return declarationType() == Token.LET;
}
final boolean isConst() {
return declarationType() == Token.CONST;
}
final boolean isClass() {
return declarationType() == Token.CLASS;
}
final boolean isParam() {
return declarationType() == Token.PARAM_LIST;
}
public final boolean isDefaultParam() {
Node parent = nameNode.getParent();
return parent.getParent().isParamList() && parent.isDefaultValue()
&& parent.getFirstChild() == nameNode;
}
final boolean isImport() {
return declarationType() == Token.IMPORT;
}
public boolean isArguments() {
return false;
}
private static final ImmutableSet<Token> DECLARATION_TYPES = Sets.immutableEnumSet(
Token.VAR,
Token.LET,
Token.CONST,
Token.FUNCTION,
Token.CLASS,
Token.CATCH,
Token.IMPORT,
Token.PARAM_LIST);
protected Token declarationType() {
for (Node current = nameNode; current != null;
current = current.getParent()) {
if (DECLARATION_TYPES.contains(current.getToken())) {
return current.getToken();
}
}
throw new IllegalStateException("The nameNode for " + this + " must be a descendant"
+ " of one of: " + DECLARATION_TYPES);
}
// This is safe because any concrete subclass of AbstractVar<V> should be assignable to V.
// While it's theoretically possible to do otherwise, such a class would be very awkward to
// implement, and is therefore not worth worrying about.
@SuppressWarnings("unchecked")
private V thisVar() {
return (V) this;
}
}