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
|
// Copyright 2014 Google Inc. 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.common.base.Joiner;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Sets;
import com.google.common.collect.Sets.SetView;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.events.Location;
import java.util.Map;
import javax.annotation.Nullable;
/**
* An interface for objects behaving like Skylark structs.
*/
// TODO(bazel-team): type checks
public interface ClassObject {
/**
* Returns the value associated with the name field in this struct,
* or null if the field does not exist.
*/
@Nullable
Object getValue(String name);
/**
* Returns the fields of this struct.
*/
ImmutableCollection<String> getKeys();
/**
* Returns a customized error message to print if the name is not a valid struct field
* of this struct, or returns null to use the default error message.
*/
@Nullable String errorMessage(String name);
/**
* An implementation class of ClassObject for structs created in Skylark code.
*/
// TODO(bazel-team): maybe move the SkylarkModule annotation to the ClassObject interface?
@Immutable
@SkylarkModule(name = "struct",
doc = "A special language element to support structs (i.e. simple value objects). "
+ "See the global <a href=\"#modules._top_level.struct\">struct</a> function "
+ "for more details.")
public class SkylarkClassObject implements ClassObject {
private final ImmutableMap<String, Object> values;
private final Location creationLoc;
private final String errorMessage;
/**
* Creates a built-in struct (i.e. without creation loc). The errorMessage has to have
* exactly one '%s' parameter to substitute the struct field name.
*/
public SkylarkClassObject(Map<String, Object> values, String errorMessage) {
this.values = ImmutableMap.copyOf(values);
this.creationLoc = null;
this.errorMessage = errorMessage;
}
public SkylarkClassObject(Map<String, Object> values, Location creationLoc) {
this.values = ImmutableMap.copyOf(values);
this.creationLoc = Preconditions.checkNotNull(creationLoc);
this.errorMessage = null;
}
@Override
public Object getValue(String name) {
return values.get(name);
}
@Override
public ImmutableCollection<String> getKeys() {
return values.keySet();
}
public Location getCreationLoc() {
return Preconditions.checkNotNull(creationLoc,
"This struct was not created in a Skylark code");
}
static SkylarkClassObject concat(
SkylarkClassObject lval, SkylarkClassObject rval, Location loc) throws EvalException {
SetView<String> commonFields = Sets.intersection(lval.values.keySet(), rval.values.keySet());
if (!commonFields.isEmpty()) {
throw new EvalException(loc, "Cannot concat structs with common field(s): "
+ Joiner.on(",").join(commonFields));
}
return new SkylarkClassObject(ImmutableMap.<String, Object>builder()
.putAll(lval.values).putAll(rval.values).build(), loc);
}
@Override
public String errorMessage(String name) {
return errorMessage != null ? String.format(errorMessage, name) : null;
}
}
}
|
