-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
DeclaredGlobalExternsOnWindow.java
147 lines (128 loc) · 4.71 KB
/
DeclaredGlobalExternsOnWindow.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
/*
* Copyright 2014 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.javascript.rhino.IR;
import com.google.javascript.rhino.JSDocInfo;
import com.google.javascript.rhino.JSDocInfoBuilder;
import com.google.javascript.rhino.Node;
import java.util.LinkedHashSet;
import java.util.Set;
/**
* A compiler pass to normalize externs by declaring global names on
* the "window" object, if it is declared in externs.
* The new declarations are added to the window instance, not to Window.prototype.
*/
class DeclaredGlobalExternsOnWindow implements CompilerPass, NodeTraversal.Callback {
private static final String WINDOW_NAME = "window";
private final AbstractCompiler compiler;
private final Set<Node> nodes = new LinkedHashSet<>();
// Whether there is a "var window" declaration in the externs.
private boolean windowInExterns = false;
public DeclaredGlobalExternsOnWindow(AbstractCompiler compiler) {
this.compiler = compiler;
}
@Override
public void process(Node externs, Node root) {
NodeTraversal.traverse(compiler, externs, this);
addWindowProperties();
}
private void addWindowProperties() {
if (!nodes.isEmpty()) {
for (Node node : nodes) {
addExtern(node, windowInExterns);
compiler.reportChangeToEnclosingScope(node);
}
}
}
private static void addExtern(Node node, boolean defineOnWindow) {
String name = node.getString();
JSDocInfo oldJSDocInfo = NodeUtil.getBestJSDocInfo(node);
Node globalRef = defineOnWindow ? IR.name(WINDOW_NAME) : IR.thisNode();
Node string = IR.string(name);
Node getprop = IR.getprop(globalRef, string);
Node newNode = getprop;
if (oldJSDocInfo != null) {
JSDocInfoBuilder builder;
if (oldJSDocInfo.isConstructorOrInterface()
|| oldJSDocInfo.hasEnumParameterType()) {
Node nameNode = IR.name(name);
newNode = IR.assign(getprop, nameNode);
builder = new JSDocInfoBuilder(false);
if (oldJSDocInfo.isConstructor()) {
builder.recordConstructor();
}
if (oldJSDocInfo.isInterface()) {
builder.recordInterface();
}
if (oldJSDocInfo.usesImplicitMatch()) {
builder.recordImplicitMatch();
}
if (oldJSDocInfo.hasEnumParameterType()) {
builder.recordEnumParameterType(oldJSDocInfo.getEnumParameterType());
}
} else {
if (NodeUtil.isNamespaceDecl(node)) {
newNode = IR.assign(getprop, IR.name(name));
} else {
Node rhs = NodeUtil.getRValueOfLValue(node);
// Type-aliasing definition
if (oldJSDocInfo.hasConstAnnotation() && rhs != null && rhs.isQualifiedName()) {
newNode = IR.assign(getprop, rhs.cloneTree());
}
}
builder = JSDocInfoBuilder.copyFrom(oldJSDocInfo);
}
// TODO(blickly): Remove these suppressions when all externs declarations on window are gone.
builder.recordSuppressions(ImmutableSet.of("const", "duplicate"));
JSDocInfo jsDocInfo = builder.build();
newNode.setJSDocInfo(jsDocInfo);
}
newNode.useSourceInfoFromForTree(node);
newNode.setOriginalName(name);
node.getGrandparent().addChildToBack(IR.exprResult(newNode));
}
@Override
public boolean shouldTraverse(NodeTraversal nodeTraversal, Node n, Node parent) {
if (parent != null
&& !NodeUtil.isControlStructure(parent)
&& !NodeUtil.isStatementBlock(parent)) {
return false;
}
if (n.isScript() && NodeUtil.isFromTypeSummary(n)) {
return false;
}
return true;
}
@Override
public void visit(NodeTraversal t, Node n, Node parent) {
if (n.isFunction()) {
nodes.add(n.getFirstChild());
} else if (n.isVar()) {
for (Node c : n.children()) {
if (c.getString().equals(WINDOW_NAME)) {
windowInExterns = true;
continue;
}
// Skip 'location' since there is an existing definition
// for window.location which conflicts with the "var location" one.
if (!c.getString().equals("location")) {
nodes.add(c);
}
}
}
}
}