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
|
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// 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.devtools.build.lib.syntax;
import com.google.devtools.build.lib.util.SpellChecker;
import java.io.IOException;
import java.util.Set;
import javax.annotation.Nullable;
// TODO(bazel-team): For performance, avoid doing HashMap lookups at runtime, and compile local
// variable access into array reference with a constant index. Variable lookups are currently a
// speed bottleneck, as previously measured in an experiment.
/**
* Syntax node for an identifier.
*
* <p>Unlike most {@link ASTNode} subclasses, this one supports {@link Object#equals} and {@link
* Object#hashCode} (but note that these methods ignore location information). They are needed
* because {@code Identifier}s are stored in maps when constructing {@link LoadStatement}.
*/
public final class Identifier extends Expression {
private final String name;
public Identifier(String name) {
this.name = name;
}
/**
* Returns the name of the Identifier.
*/
public String getName() {
return name;
}
public boolean isPrivate() {
return name.startsWith("_");
}
@Override
public void prettyPrint(Appendable buffer) throws IOException {
buffer.append(name);
}
@Override
public boolean equals(@Nullable Object object) {
if (object instanceof Identifier) {
Identifier that = (Identifier) object;
return this.name.equals(that.name);
}
return false;
}
@Override
public int hashCode() {
return name.hashCode();
}
@Override
Object doEval(Environment env) throws EvalException {
Object value = env.lookup(name);
if (value == null) {
throw createInvalidIdentifierException(env.getVariableNames());
}
return value;
}
@Override
public void accept(SyntaxTreeVisitor visitor) {
visitor.visit(this);
}
@Override
public Kind kind() {
return Kind.IDENTIFIER;
}
EvalException createInvalidIdentifierException(Set<String> symbols) {
if (name.equals("$error$")) {
return new EvalException(getLocation(), "contains syntax error(s)", true);
}
if (name.equals("PACKAGE_NAME")) {
return new EvalException(
getLocation(),
"The value 'PACKAGE_NAME' has been removed in favor of 'package_name()', "
+ "please use the latter ("
+ "https://docs.bazel.build/versions/master/skylark/lib/native.html#package_name). "
+ "You can temporarily allow the old name "
+ "by using --incompatible_package_name_is_a_function=false");
}
if (name.equals("REPOSITORY_NAME")) {
return new EvalException(
getLocation(),
"The value 'REPOSITORY_NAME' has been removed in favor of 'repository_name()', "
+ "please use the latter ("
+ "https://docs.bazel.build/versions/master/skylark/lib/native.html#repository_name)."
+ " You can temporarily allow the old name "
+ "by using --incompatible_package_name_is_a_function=false");
}
String suggestion = SpellChecker.didYouMean(name, symbols);
return new EvalException(getLocation(), "name '" + name + "' is not defined" + suggestion);
}
/** @return The {@link Identifier} of the provided name. */
public static Identifier of(String name) {
return new Identifier(name);
}
}
|
