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
202
203
204
205
206
207
|
// 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.Function;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.cmdline.Label;
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.syntax.BaseFunction;
import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.Type;
import com.google.devtools.build.lib.util.Preconditions;
import java.util.Arrays;
import java.util.List;
/** A Skylark value that is a result of an 'aspect(..)' function call. */
@SkylarkModule(
name = "Aspect",
category = SkylarkModuleCategory.NONE,
doc =
"For more information about Aspects, please consult the <a href=\"globals.html#aspect\">"
+ "documentation of the aspect function</a> or the "
+ "<a href=\"../aspects.md\">introduction to Aspects</a>."
)
public class SkylarkAspect implements SkylarkExportable {
private final BaseFunction implementation;
private final ImmutableList<String> attributeAspects;
private final ImmutableList<Attribute> attributes;
private final ImmutableList<ImmutableSet<SkylarkProviderIdentifier>> requiredAspectProviders;
private final ImmutableSet<SkylarkProviderIdentifier> provides;
private final ImmutableSet<String> paramAttributes;
private final ImmutableSet<String> fragments;
private final ImmutableSet<String> hostFragments;
private final ImmutableList<Label> requiredToolchains;
private final Environment funcallEnv;
private SkylarkAspectClass aspectClass;
public SkylarkAspect(
BaseFunction implementation,
ImmutableList<String> attributeAspects,
ImmutableList<Attribute> attributes,
ImmutableList<ImmutableSet<SkylarkProviderIdentifier>> requiredAspectProviders,
ImmutableSet<SkylarkProviderIdentifier> provides,
ImmutableSet<String> paramAttributes,
ImmutableSet<String> fragments,
ImmutableSet<String> hostFragments,
ImmutableList<Label> requiredToolchains,
Environment funcallEnv) {
this.implementation = implementation;
this.attributeAspects = attributeAspects;
this.attributes = attributes;
this.requiredAspectProviders = requiredAspectProviders;
this.provides = provides;
this.paramAttributes = paramAttributes;
this.fragments = fragments;
this.hostFragments = hostFragments;
this.requiredToolchains = requiredToolchains;
this.funcallEnv = funcallEnv;
}
public BaseFunction getImplementation() {
return implementation;
}
public ImmutableList<String> getAttributeAspects() {
return attributeAspects;
}
public Environment getFuncallEnv() {
return funcallEnv;
}
public ImmutableList<Attribute> getAttributes() {
return attributes;
}
@Override
public boolean isImmutable() {
return implementation.isImmutable();
}
@Override
public void repr(SkylarkPrinter printer) {
printer.append("<aspect>");
}
@Override
public void reprLegacy(SkylarkPrinter printer) {
printer.append("Aspect:");
printer.repr(implementation);
}
public String getName() {
return getAspectClass().getName();
}
public SkylarkAspectClass getAspectClass() {
Preconditions.checkState(isExported());
return aspectClass;
}
public ImmutableSet<String> getParamAttributes() {
return paramAttributes;
}
@Override
public void export(Label extensionLabel, String name) {
Preconditions.checkArgument(!isExported());
this.aspectClass = new SkylarkAspectClass(extensionLabel, name);
}
private static final List<String> allAttrAspects = Arrays.asList("*");
public AspectDefinition getDefinition(AspectParameters aspectParams) {
AspectDefinition.Builder builder = new AspectDefinition.Builder(aspectClass);
if (allAttrAspects.equals(attributeAspects)) {
builder.propagateAlongAllAttributes();
} else {
for (String attributeAspect : attributeAspects) {
builder.propagateAlongAttribute(attributeAspect);
}
}
for (Attribute attribute : attributes) {
Attribute attr = attribute; // Might be reassigned.
if (!aspectParams.getAttribute(attr.getName()).isEmpty()) {
String value = aspectParams.getOnlyValueOfAttribute(attr.getName());
Preconditions.checkState(!Attribute.isImplicit(attr.getName()));
Preconditions.checkState(attr.getType() == Type.STRING);
Preconditions.checkArgument(aspectParams.getAttribute(attr.getName()).size() == 1,
String.format("Aspect %s parameter %s has %d values (must have exactly 1).",
getName(),
attr.getName(),
aspectParams.getAttribute(attr.getName()).size()));
attr = attr.cloneBuilder(Type.STRING).value(value).build(attr.getName());
}
builder.add(attr);
}
builder.requireAspectsWithProviders(requiredAspectProviders);
ImmutableList.Builder<SkylarkProviderIdentifier> advertisedSkylarkProviders =
ImmutableList.builder();
for (SkylarkProviderIdentifier provider : provides) {
advertisedSkylarkProviders.add(provider);
}
builder.advertiseProvider(advertisedSkylarkProviders.build());
builder.requiresConfigurationFragmentsBySkylarkModuleName(fragments);
builder.requiresHostConfigurationFragmentsBySkylarkModuleName(hostFragments);
builder.addRequiredToolchains(requiredToolchains);
return builder.build();
}
@Override
public boolean isExported() {
return aspectClass != null;
}
public Function<Rule, AspectParameters> getDefaultParametersExtractor() {
return rule -> {
AttributeMap ruleAttrs = RawAttributeMapper.of(rule);
AspectParameters.Builder builder = new AspectParameters.Builder();
for (Attribute aspectAttr : attributes) {
if (!Attribute.isImplicit(aspectAttr.getName())) {
String param = aspectAttr.getName();
Attribute ruleAttr = ruleAttrs.getAttributeDefinition(param);
if (paramAttributes.contains(aspectAttr.getName())) {
// These are preconditions because if they are false, RuleFunction.call() should
// already have generated an error.
Preconditions.checkArgument(
ruleAttr != null,
String.format(
"Cannot apply aspect %s to %s that does not define attribute '%s'.",
getName(), rule.getTargetKind(), param));
Preconditions.checkArgument(
ruleAttr.getType() == Type.STRING,
String.format(
"Cannot apply aspect %s to %s with non-string attribute '%s'.",
getName(), rule.getTargetKind(), param));
}
if (ruleAttr != null && ruleAttr.getType() == aspectAttr.getType()) {
builder.addAttribute(param, (String) ruleAttrs.get(param, ruleAttr.getType()));
}
}
}
return builder.build();
};
}
public ImmutableList<Label> getRequiredToolchains() {
return requiredToolchains;
}
}
|
