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
|
// 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.rules;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.packages.MethodLibrary;
import com.google.devtools.build.lib.packages.SkylarkNativeModule;
import com.google.devtools.build.lib.syntax.BaseFunction;
import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.EvaluationContext;
import com.google.devtools.build.lib.syntax.SkylarkEnvironment;
import com.google.devtools.build.lib.syntax.SkylarkModule;
import com.google.devtools.build.lib.syntax.SkylarkSignature;
import com.google.devtools.build.lib.syntax.ValidationEnvironment;
import java.lang.reflect.Field;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
/**
* A class to handle all Skylark modules, to create and setup Validation and regular Environments.
*/
// TODO(bazel-team): move that to the syntax package and
// let each extension register itself in a static { } statement.
public class SkylarkModules {
/**
* The list of built in Skylark modules.
* Documentation is generated automatically for all these modules.
* They are also registered with the {@link ValidationEnvironment}
* and the {@link SkylarkEnvironment}.
* Note that only functions with a {@link SkylarkSignature} annotations are handled properly.
*/
// TODO(bazel-team): find a more general, more automated way of registering classes and building
// initial environments. And don't give syntax.Environment and packages.MethodLibrary a special
// treatment, have them use the same registration mechanism as other classes currently below.
public static final ImmutableList<Class<?>> MODULES = ImmutableList.of(
SkylarkAttr.class,
SkylarkCommandLine.class,
SkylarkNativeModule.class,
SkylarkRuleClassFunctions.class,
SkylarkRuleImplementationFunctions.class);
private static final ImmutableMap<Class<?>, ImmutableList<BaseFunction>> FUNCTION_MAP;
private static final ImmutableMap<String, Object> OBJECTS;
static {
try {
ImmutableMap.Builder<Class<?>, ImmutableList<BaseFunction>> functionMap =
ImmutableMap.builder();
ImmutableMap.Builder<String, Object> objects = ImmutableMap.builder();
for (Class<?> moduleClass : MODULES) {
if (moduleClass.isAnnotationPresent(SkylarkModule.class)) {
objects.put(moduleClass.getAnnotation(SkylarkModule.class).name(),
moduleClass.newInstance());
}
ImmutableList.Builder<BaseFunction> functions = ImmutableList.builder();
collectSkylarkFunctionsAndObjectsFromFields(moduleClass, functions, objects);
functionMap.put(moduleClass, functions.build());
}
FUNCTION_MAP = functionMap.build();
OBJECTS = objects.build();
} catch (InstantiationException | IllegalAccessException e) {
throw new RuntimeException(e);
}
}
/**
* Returns a new SkylarkEnvironment with the elements of the Skylark modules.
*/
public static SkylarkEnvironment getNewEnvironment(
EventHandler eventHandler, String astFileContentHashCode) {
SkylarkEnvironment env = new SkylarkEnvironment(eventHandler, astFileContentHashCode);
setupEnvironment(env);
return env;
}
@VisibleForTesting
public static SkylarkEnvironment getNewEnvironment(EventHandler eventHandler) {
return getNewEnvironment(eventHandler, null);
}
private static void setupEnvironment(Environment env) {
MethodLibrary.setupMethodEnvironment(env);
for (Map.Entry<Class<?>, ImmutableList<BaseFunction>> entry : FUNCTION_MAP.entrySet()) {
for (BaseFunction function : entry.getValue()) {
if (function.getObjectType() != null) {
env.registerFunction(function.getObjectType(), function.getName(), function);
} else {
env.update(function.getName(), function);
}
}
}
for (Map.Entry<String, Object> entry : OBJECTS.entrySet()) {
env.update(entry.getKey(), entry.getValue());
}
}
/**
* Returns a new ValidationEnvironment with the elements of the Skylark modules.
*/
public static ValidationEnvironment getValidationEnvironment() {
return getValidationEnvironment(ImmutableSet.<String>of());
}
/**
* Returns a new ValidationEnvironment with the elements of the Skylark modules and extraObjects.
*/
public static ValidationEnvironment getValidationEnvironment(ImmutableSet<String> extraObjects) {
Set<String> builtIn = new HashSet<>();
collectSkylarkTypesFromFields(Environment.class, builtIn);
for (Class<?> moduleClass : MODULES) {
if (moduleClass.isAnnotationPresent(SkylarkModule.class)) {
builtIn.add(moduleClass.getAnnotation(SkylarkModule.class).name());
}
}
MethodLibrary.setupValidationEnvironment(builtIn);
for (Class<?> module : MODULES) {
collectSkylarkTypesFromFields(module, builtIn);
}
builtIn.addAll(extraObjects);
return new ValidationEnvironment(builtIn);
}
public static EvaluationContext newEvaluationContext(EventHandler eventHandler) {
return EvaluationContext.newSkylarkContext(
getNewEnvironment(eventHandler), getValidationEnvironment());
}
/**
* Collects the BaseFunctions from the fields of the class of the object parameter
* and adds them into the builder.
*/
private static void collectSkylarkFunctionsAndObjectsFromFields(Class<?> type,
ImmutableList.Builder<BaseFunction> functions, ImmutableMap.Builder<String, Object> objects) {
try {
for (Field field : type.getDeclaredFields()) {
if (field.isAnnotationPresent(SkylarkSignature.class)) {
// Fields in Skylark modules are sometimes private.
// Nevertheless they have to be annotated with SkylarkSignature.
field.setAccessible(true);
SkylarkSignature annotation = field.getAnnotation(SkylarkSignature.class);
Object value = field.get(null);
if (BaseFunction.class.isAssignableFrom(field.getType())) {
functions.add((BaseFunction) value);
} else {
objects.put(annotation.name(), value);
}
}
}
} catch (IllegalArgumentException | IllegalAccessException e) {
// This should never happen.
throw new RuntimeException(e);
}
}
/**
* Collects the BaseFunctions from the fields of the class of the object parameter
* and adds their class and their corresponding return value to the builder.
*/
private static void collectSkylarkTypesFromFields(Class<?> classObject, Set<String> builtIn) {
for (Field field : classObject.getDeclaredFields()) {
if (field.isAnnotationPresent(SkylarkSignature.class)) {
SkylarkSignature annotation = field.getAnnotation(SkylarkSignature.class);
if (BaseFunction.class.isAssignableFrom(field.getType())) {
// Ignore non-global values.
if (annotation.objectType().equals(Object.class)) {
builtIn.add(annotation.name());
}
} else {
builtIn.add(annotation.name());
}
}
}
}
}
|
