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
|
// Copyright 2016 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.packages;
import com.google.common.base.Joiner;
import com.google.common.base.Objects;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Ordering;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
import com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter;
import com.google.devtools.build.lib.skylarkinterface.SkylarkValue;
import com.google.devtools.build.lib.syntax.ClassObject;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.Printer;
import com.google.devtools.build.lib.syntax.SkylarkType;
import com.google.devtools.build.lib.util.Preconditions;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import javax.annotation.Nullable;
/** Represents information provided by a {@link Provider}. */
@SkylarkModule(
name = "struct",
category = SkylarkModuleCategory.BUILTIN,
doc =
"A special language element to support structs (i.e. simple value objects). "
+ "See the global <a href=\"globals.html#struct\">struct</a> function "
+ "for more details."
)
public abstract class Info implements ClassObject, SkylarkValue, Serializable {
private final Provider provider;
private final Location creationLoc;
private final String errorMessage;
/** Creates an empty struct with a given location. */
public Info(Provider provider, Location location) {
this.provider = provider;
this.creationLoc = location;
this.errorMessage = provider.getErrorMessageFormatForInstances();
}
/** Creates a built-in struct (i.e. without creation loc). */
public Info(Provider provider) {
this.provider = provider;
this.creationLoc = null;
this.errorMessage = provider.getErrorMessageFormatForInstances();
}
/**
* Creates a built-in struct (i.e. without creation loc).
*
* <p>Allows to supply a specific error message. Only used in
* {@link com.google.devtools.build.lib.packages.NativeProvider.StructConstructor#create(Map,
* String)} If you need to override an error message, preferred way is to create a specific {@link
* NativeProvider}.
*/
Info(Provider provider, Map<String, Object> values, String errorMessage) {
this.provider = provider;
this.creationLoc = null;
this.errorMessage = Preconditions.checkNotNull(errorMessage);
}
// Ensure that values are all acceptable to Skylark before to stuff them in a ClassObject
protected static ImmutableMap<String, Object> copyValues(Map<String, Object> values) {
ImmutableMap.Builder<String, Object> builder = ImmutableMap.builder();
for (Map.Entry<String, Object> e : values.entrySet()) {
builder.put(
Attribute.getSkylarkName(e.getKey()), SkylarkType.convertToSkylark(e.getValue(), null));
}
return builder.build();
}
public abstract boolean hasKey(String name);
/** Returns a value and try to cast it into specified type */
public <TYPE> TYPE getValue(String key, Class<TYPE> type) throws EvalException {
Object obj = getValue(key);
if (obj == null) {
return null;
}
SkylarkType.checkType(obj, type, key);
return type.cast(obj);
}
public Location getCreationLoc() {
return Preconditions.checkNotNull(creationLoc, "This struct was not created in a Skylark code");
}
public Provider getProvider() {
return provider;
}
@Nullable
public Location getCreationLocOrNull() {
return creationLoc;
}
@Override
public String errorMessage(String name) {
String suffix =
"Available attributes: " + Joiner.on(", ").join(Ordering.natural().sortedCopy(getKeys()));
return String.format(errorMessage, name) + "\n" + suffix;
}
@Override
public boolean equals(Object otherObject) {
if (!(otherObject instanceof Info)) {
return false;
}
Info other = (Info) otherObject;
if (this == other) {
return true;
}
if (!this.provider.equals(other.provider)) {
return false;
}
// Compare objects' keys and values
if (!this.getKeys().equals(other.getKeys())) {
return false;
}
for (String key : getKeys()) {
if (!this.getValue(key).equals(other.getValue(key))) {
return false;
}
}
return true;
}
@Override
public int hashCode() {
List<String> keys = new ArrayList<>(getKeys());
Collections.sort(keys);
List<Object> objectsToHash = new ArrayList<>();
objectsToHash.add(provider);
for (String key : keys) {
objectsToHash.add(key);
objectsToHash.add(getValue(key));
}
return Objects.hashCode(objectsToHash.toArray());
}
/**
* Convert the object to string using Skylark syntax. The output tries to be reversible (but there
* is no guarantee, it depends on the actual values).
*/
@Override
public void repr(SkylarkPrinter printer) {
boolean first = true;
printer.append("struct(");
// Sort by key to ensure deterministic output.
for (String key : Ordering.natural().sortedCopy(getKeys())) {
if (!first) {
printer.append(", ");
}
first = false;
printer.append(key);
printer.append(" = ");
printer.repr(getValue(key));
}
printer.append(")");
}
@Override
public void reprLegacy(SkylarkPrinter printer) {
boolean first = true;
printer.append(provider.getPrintableName());
printer.append("(");
// Sort by key to ensure deterministic output.
for (String key : Ordering.natural().sortedCopy(getKeys())) {
if (!first) {
printer.append(", ");
}
first = false;
printer.append(key);
printer.append(" = ");
printer.repr(getValue(key));
}
printer.append(")");
}
@Override
public String toString() {
return Printer.repr(this);
}
}
|
