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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
|
// 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.packages;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.HashMultimap;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.LinkedHashMultimap;
import com.google.common.collect.ListMultimap;
import com.google.common.collect.Lists;
import com.google.common.collect.Multimap;
import com.google.common.collect.SetMultimap;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.LabelSyntaxException;
import com.google.devtools.build.lib.cmdline.RepositoryName;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventHandler;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.packages.License.DistributionType;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.GlobList;
import com.google.devtools.build.lib.syntax.Type;
import com.google.devtools.build.lib.util.BinaryPredicate;
import com.google.devtools.build.lib.util.Preconditions;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
/**
* An instance of a build rule in the build language. A rule has a name, a
* package to which it belongs, a class such as <code>cc_library</code>, and
* set of typed attributes. The set of attribute names and types is a property
* of the rule's class. The use of the term "class" here has nothing to do
* with Java classes. All rules are implemented by the same Java classes, Rule
* and RuleClass.
*
* <p>Here is a typical rule as it appears in a BUILD file:
* <pre>
* cc_library(name = 'foo',
* defines = ['-Dkey=value'],
* srcs = ['foo.cc'],
* deps = ['bar'])
* </pre>
*/
public final class Rule implements Target, DependencyFilter.AttributeInfoProvider {
/** Label predicate that allows every label. */
public static final Predicate<Label> ALL_LABELS = Predicates.alwaysTrue();
private final Label label;
private final Package pkg;
private final RuleClass ruleClass;
private final AttributeContainer attributes;
private RuleVisibility visibility;
private boolean containsErrors;
private final Location location;
private final ImplicitOutputsFunction implicitOutputsFunction;
// Initialized in the call to populateOutputFiles.
private List<OutputFile> outputFiles;
private ListMultimap<String, OutputFile> outputFileMap;
Rule(
Package pkg,
Label label,
RuleClass ruleClass,
Location location,
AttributeContainer attributeContainer) {
this(
pkg,
label,
ruleClass,
location,
attributeContainer,
ruleClass.getDefaultImplicitOutputsFunction());
}
Rule(
Package pkg,
Label label,
RuleClass ruleClass,
Location location,
AttributeContainer attributeContainer,
ImplicitOutputsFunction implicitOutputsFunction) {
this.pkg = Preconditions.checkNotNull(pkg);
this.label = label;
this.ruleClass = Preconditions.checkNotNull(ruleClass);
this.location = Preconditions.checkNotNull(location);
this.attributes = attributeContainer;
this.implicitOutputsFunction = implicitOutputsFunction;
this.containsErrors = false;
}
void setVisibility(RuleVisibility visibility) {
this.visibility = visibility;
}
void setAttributeValue(Attribute attribute, Object value, boolean explicit) {
attributes.setAttributeValue(attribute, value, explicit);
}
void setAttributeValueByName(String attrName, Object value) {
attributes.setAttributeValueByName(attrName, value);
}
void setAttributeLocation(int attrIndex, Location location) {
attributes.setAttributeLocation(attrIndex, location);
}
void setContainsErrors() {
this.containsErrors = true;
}
@Override
public Label getLabel() {
return label;
}
@Override
public String getName() {
return label.getName();
}
@Override
public Package getPackage() {
return pkg;
}
public RuleClass getRuleClassObject() {
return ruleClass;
}
@Override
public String getTargetKind() {
return ruleClass.getTargetKind();
}
/**
* Returns the class of this rule. (e.g. "cc_library")
*/
public String getRuleClass() {
return ruleClass.getName();
}
/**
* Returns the build features that apply to this rule.
*/
public ImmutableSet<String> getFeatures() {
return pkg.getFeatures();
}
/**
* Returns true iff the outputs of this rule should be created beneath the
* bin directory, false if beneath genfiles. For most rule
* classes, this is a constant, but for genrule, it is a property of the
* individual rule instance, derived from the 'output_to_bindir' attribute.
*/
public boolean hasBinaryOutput() {
return ruleClass.getName().equals("genrule") // this is unfortunate...
? NonconfigurableAttributeMapper.of(this).get("output_to_bindir", Type.BOOLEAN)
: ruleClass.hasBinaryOutput();
}
/**
* Returns true iff there were errors while constructing this rule, such as
* attributes with missing values or values of the wrong type.
*/
public boolean containsErrors() {
return containsErrors;
}
/**
* Returns an (unmodifiable, unordered) collection containing all the
* Attribute definitions for this kind of rule. (Note, this doesn't include
* the <i>values</i> of the attributes, merely the schema. Call
* get[Type]Attr() methods to access the actual values.)
*/
public Collection<Attribute> getAttributes() {
return ruleClass.getAttributes();
}
/**
* Returns true if this rule has any attributes that are configurable.
*
* <p>Note this is *not* the same as having attribute *types* that are configurable. For example,
* "deps" is configurable, in that one can write a rule that sets "deps" to a configuration
* dictionary. But if *this* rule's instance of "deps" doesn't do that, its instance
* of "deps" is not considered configurable.
*
* <p>In other words, this method signals which rules might have their attribute values
* influenced by the configuration.
*/
public boolean hasConfigurableAttributes() {
for (Attribute attribute : getAttributes()) {
if (AbstractAttributeMapper.isConfigurable(this, attribute.getName(), attribute.getType())) {
return true;
}
}
return false;
}
/**
* Returns true if the given attribute is configurable.
*/
public boolean isConfigurableAttribute(String attributeName) {
Attribute attribute = ruleClass.getAttributeByNameMaybe(attributeName);
return attribute != null
? AbstractAttributeMapper.isConfigurable(this, attributeName, attribute.getType())
: false;
}
/**
* Returns the attribute definition whose name is {@code attrName}, or null
* if not found. (Use get[X]Attr for the actual value.)
*
* @deprecated use {@link AbstractAttributeMapper#getAttributeDefinition} instead
*/
@Deprecated
public Attribute getAttributeDefinition(String attrName) {
return ruleClass.getAttributeByNameMaybe(attrName);
}
/**
* Returns an (unmodifiable, ordered) collection containing all the declared output files of this
* rule.
*
* <p>All implicit output files (declared in the {@link RuleClass}) are
* listed first, followed by any explicit files (declared via the 'outs' attribute). Additionally
* both implicit and explicit outputs will retain the relative order in which they were declared.
*
* <p>This ordering is useful because it is propagated through to the list of targets returned by
* getOuts() and allows targets to access their implicit outputs easily via
* {@code getOuts().get(N)} (providing that N is less than the number of implicit outputs).
*
* <p>The fact that the relative order of the explicit outputs is also retained is less obviously
* useful but is still well defined.
*/
public Collection<OutputFile> getOutputFiles() {
return outputFiles;
}
/**
* Returns an (unmodifiable, ordered) map containing the list of output files for every
* output type attribute.
*/
public ListMultimap<String, OutputFile> getOutputFileMap() {
return outputFileMap;
}
@Override
public Location getLocation() {
return location;
}
public ImplicitOutputsFunction getImplicitOutputsFunction() {
return implicitOutputsFunction;
}
@Override
public Rule getAssociatedRule() {
return this;
}
/**
* Returns this rule's raw attribute info, suitable for being fed into an
* {@link AttributeMap} for user-level attribute access. Don't use this method
* for direct attribute access.
*/
public AttributeContainer getAttributeContainer() {
return attributes;
}
/********************************************************************
* Attribute accessor functions.
*
* The below provide access to attribute definitions and other generic
* metadata.
*
* For access to attribute *values* (e.g. "What's the value of attribute
* X for Rule Y?"), go through {@link RuleContext#attributes}. If no
* RuleContext is available, create a localized {@link AbstractAttributeMapper}
* instance instead.
********************************************************************/
/**
* Returns the default value for the attribute {@code attrName}, which may be
* of any type, but must exist (an exception is thrown otherwise).
*/
public Object getAttrDefaultValue(String attrName) {
Object defaultValue = ruleClass.getAttributeByName(attrName).getDefaultValue(this);
// Computed defaults not expected here.
Preconditions.checkState(!(defaultValue instanceof Attribute.ComputedDefault));
return defaultValue;
}
/**
* Returns true iff the rule class has an attribute with the given name and type.
*
* <p>Note: RuleContext also has isAttrDefined(), which takes Aspects into account. Whenever
* possible, use RuleContext.isAttrDefined() instead of this method.
*/
public boolean isAttrDefined(String attrName, Type<?> type) {
return ruleClass.hasAttr(attrName, type);
}
/**
* {@see #isAttributeValueExplicitlySpecified(String)}
*/
@Override
public boolean isAttributeValueExplicitlySpecified(Attribute attribute) {
return attributes.isAttributeValueExplicitlySpecified(attribute);
}
/**
* Returns true iff the value of the specified attribute is explicitly set in the BUILD file.
* This returns true also if the value explicity specified in the BUILD file is the same as the
* attribute's default value. In addition, this method return false if the rule has no attribute
* with the given name.
*/
public boolean isAttributeValueExplicitlySpecified(String attrName) {
return attributes.isAttributeValueExplicitlySpecified(attrName);
}
/**
* Returns the location of the attribute definition for this rule, if known;
* or the location of the whole rule otherwise. "attrName" need not be a
* valid attribute name for this rule.
*
* <p>This method ignores whether the present rule was created by a macro or not.
*/
public Location getAttributeLocationWithoutMacro(String attrName) {
return getAttributeLocation(attrName, false /* useBuildLocation */);
}
/**
* Returns the location of the attribute definition for this rule, if known;
* or the location of the whole rule otherwise. "attrName" need not be a
* valid attribute name for this rule.
*
* <p>If this rule was created by a macro, this method returns the
* location of the macro invocation in the BUILD file instead.
*/
public Location getAttributeLocation(String attrName) {
return getAttributeLocation(attrName, true /* useBuildLocation */);
}
private Location getAttributeLocation(String attrName, boolean useBuildLocation) {
/*
* If the rule was created by a macro, we have to deal with two locations: one in the BUILD
* file where the macro is invoked and one in the bzl file where the rule is created.
* For error reporting, we are usually more interested in the former one.
* Different methods in this class refer to different locations, though:
* - getLocation() points to the location of the macro invocation in the BUILD file (thanks to
* RuleFactory).
* - attributes.getAttributeLocation() points to the location in the bzl file.
*/
if (wasCreatedByMacro() && useBuildLocation) {
return getLocation();
}
Location attrLocation = null;
if (!attrName.equals("name")) {
attrLocation = attributes.getAttributeLocation(attrName);
}
return attrLocation != null ? attrLocation : getLocation();
}
/**
* Returns whether this rule was created by a macro.
*/
public boolean wasCreatedByMacro() {
return hasStringAttribute("generator_name") || hasStringAttribute("generator_function");
}
private boolean hasStringAttribute(String attrName) {
Object value = attributes.getAttr(attrName);
if (value != null && value instanceof String) {
return !((String) value).isEmpty();
}
return false;
}
/** Returns a new List instance containing all direct dependencies (all types). */
public Collection<Label> getLabels() throws InterruptedException {
final List<Label> labels = Lists.newArrayList();
AggregatingAttributeMapper.of(this).visitLabels(new AttributeMap.AcceptsLabelAttribute() {
@Override
public void acceptLabelAttribute(Label label, Attribute attribute) {
labels.add(label);
}
});
return labels;
}
/**
* Returns a new Collection containing all Labels that match a given Predicate, not including
* outputs.
*
* @param predicate A binary predicate that determines if a label should be included in the
* result. The predicate is evaluated with this rule and the attribute that contains the
* label. The label will be contained in the result iff (the predicate returned {@code true}
* and the labels are not outputs)
*/
public Collection<Label> getLabels(BinaryPredicate<? super Rule, Attribute> predicate)
throws InterruptedException {
return ImmutableSortedSet.copyOf(getTransitions(predicate).values());
}
/**
* Returns a new Multimap containing all attributes that match a given Predicate and corresponding
* labels, not including outputs.
*
* @param predicate A binary predicate that determines if a label should be included in the
* result. The predicate is evaluated with this rule and the attribute that contains the
* label. The label will be contained in the result iff (the predicate returned {@code true}
* and the labels are not outputs)
*/
public Multimap<Attribute, Label> getTransitions(
final BinaryPredicate<? super Rule, Attribute> predicate) throws InterruptedException {
final Multimap<Attribute, Label> transitions = HashMultimap.create();
// TODO(bazel-team): move this to AttributeMap, too. Just like visitLabels, which labels should
// be visited may depend on the calling context. We shouldn't implicitly decide this for
// the caller.
AggregatingAttributeMapper.of(this).visitLabels(new AttributeMap.AcceptsLabelAttribute() {
@Override
public void acceptLabelAttribute(Label label, Attribute attribute) {
if (predicate.apply(Rule.this, attribute)) {
transitions.put(attribute, label);
}
}
});
return transitions;
}
/**
* Check if this rule is valid according to the validityPredicate of its RuleClass.
*/
void checkValidityPredicate(EventHandler eventHandler) {
PredicateWithMessage<Rule> predicate = getRuleClassObject().getValidityPredicate();
if (!predicate.apply(this)) {
reportError(predicate.getErrorReason(this), eventHandler);
}
}
/**
* Collects the output files (both implicit and explicit). All the implicit output files are added
* first, followed by any explicit files. Additionally both implicit and explicit output files
* will retain the relative order in which they were declared.
*/
void populateOutputFiles(EventHandler eventHandler, Package.Builder pkgBuilder)
throws LabelSyntaxException, InterruptedException {
populateOutputFilesInternal(eventHandler, pkgBuilder, /*performChecks=*/ true);
}
void populateOutputFilesUnchecked(EventHandler eventHandler, Package.Builder pkgBuilder)
throws InterruptedException {
try {
populateOutputFilesInternal(eventHandler, pkgBuilder, /*performChecks=*/ false);
} catch (LabelSyntaxException e) {
throw new IllegalStateException(e);
}
}
void populateOutputFilesInternal(
EventHandler eventHandler, Package.Builder pkgBuilder, boolean performChecks)
throws LabelSyntaxException, InterruptedException {
Preconditions.checkState(outputFiles == null);
// Order is important here: implicit before explicit
ImmutableList.Builder<OutputFile> outputFilesBuilder = ImmutableList.builder();
ImmutableListMultimap.Builder<String, OutputFile> outputFileMapBuilder =
ImmutableListMultimap.builder();
populateImplicitOutputFiles(eventHandler, pkgBuilder, outputFilesBuilder, performChecks);
populateExplicitOutputFiles(
eventHandler, outputFilesBuilder, outputFileMapBuilder, performChecks);
outputFiles = outputFilesBuilder.build();
outputFileMap = outputFileMapBuilder.build();
}
// Explicit output files are user-specified attributes of type OUTPUT.
private void populateExplicitOutputFiles(
EventHandler eventHandler,
ImmutableList.Builder<OutputFile> outputFilesBuilder,
ImmutableListMultimap.Builder<String, OutputFile> outputFileMapBuilder,
boolean performChecks)
throws LabelSyntaxException {
NonconfigurableAttributeMapper nonConfigurableAttributes =
NonconfigurableAttributeMapper.of(this);
for (Attribute attribute : ruleClass.getAttributes()) {
String name = attribute.getName();
Type<?> type = attribute.getType();
if (type == BuildType.OUTPUT) {
Label outputLabel = nonConfigurableAttributes.get(name, BuildType.OUTPUT);
if (outputLabel != null) {
addLabelOutput(
attribute,
outputLabel,
eventHandler,
outputFilesBuilder,
outputFileMapBuilder,
performChecks);
}
} else if (type == BuildType.OUTPUT_LIST) {
for (Label label : nonConfigurableAttributes.get(name, BuildType.OUTPUT_LIST)) {
addLabelOutput(
attribute,
label,
eventHandler,
outputFilesBuilder,
outputFileMapBuilder,
performChecks);
}
}
}
}
/**
* Implicit output files come from rule-specific patterns, and are a function of the rule's
* "name", "srcs", and other attributes.
*/
private void populateImplicitOutputFiles(
EventHandler eventHandler,
Package.Builder pkgBuilder,
ImmutableList.Builder<OutputFile> outputFilesBuilder,
boolean performChecks)
throws InterruptedException {
try {
RawAttributeMapper attributeMap = RawAttributeMapper.of(this);
for (String out : implicitOutputsFunction.getImplicitOutputs(attributeMap)) {
Label label;
if (performChecks) {
try {
label = pkgBuilder.createLabel(out);
} catch (LabelSyntaxException e) {
reportError(
"illegal output file name '"
+ out
+ "' in rule "
+ getLabel()
+ " due to: "
+ e.getMessage(),
eventHandler);
continue;
}
} else {
label = Label.createUnvalidated(pkgBuilder.getPackageIdentifier(), out);
}
addOutputFile(label, eventHandler, outputFilesBuilder);
}
} catch (EvalException e) {
reportError(String.format("In rule %s: %s", getLabel(), e.print()), eventHandler);
}
}
private void addLabelOutput(
Attribute attribute,
Label label,
EventHandler eventHandler,
ImmutableList.Builder<OutputFile> outputFilesBuilder,
ImmutableListMultimap.Builder<String, OutputFile> outputFileMapBuilder,
boolean performChecks)
throws LabelSyntaxException {
if (performChecks) {
if (!label.getPackageIdentifier().equals(pkg.getPackageIdentifier())) {
throw new IllegalStateException("Label for attribute " + attribute
+ " should refer to '" + pkg.getName()
+ "' but instead refers to '" + label.getPackageFragment()
+ "' (label '" + label.getName() + "')");
}
if (label.getName().equals(".")) {
throw new LabelSyntaxException("output file name can't be equal '.'");
}
}
OutputFile outputFile = addOutputFile(label, eventHandler, outputFilesBuilder);
outputFileMapBuilder.put(attribute.getName(), outputFile);
}
private OutputFile addOutputFile(
Label label,
EventHandler eventHandler,
ImmutableList.Builder<OutputFile> outputFilesBuilder) {
if (label.getName().equals(getName())) {
// TODO(bazel-team): for now (23 Apr 2008) this is just a warning. After
// June 1st we should make it an error.
reportWarning("target '" + getName() + "' is both a rule and a file; please choose "
+ "another name for the rule", eventHandler);
}
OutputFile outputFile = new OutputFile(pkg, label, this);
outputFilesBuilder.add(outputFile);
return outputFile;
}
void reportError(String message, EventHandler eventHandler) {
eventHandler.handle(Event.error(location, message));
this.containsErrors = true;
}
void reportWarning(String message, EventHandler eventHandler) {
eventHandler.handle(Event.warn(location, message));
}
/**
* Returns a string of the form "cc_binary rule //foo:foo"
*
* @return a string of the form "cc_binary rule //foo:foo"
*/
@Override
public String toString() {
return getRuleClass() + " rule " + getLabel();
}
/**
* Returns the effective visibility of this Rule. Visibility is computed from
* these sources in this order of preference:
* - 'visibility' attribute
* - 'default_visibility;' attribute of package() declaration
* - public.
*/
@Override
public RuleVisibility getVisibility() {
if (visibility != null) {
return visibility;
}
if (getRuleClassObject().isPublicByDefault()) {
return ConstantRuleVisibility.PUBLIC;
}
return pkg.getDefaultVisibility();
}
public boolean isVisibilitySpecified() {
return visibility != null;
}
@Override
public boolean isConfigurable() {
return true;
}
@Override
@SuppressWarnings("unchecked")
public Set<DistributionType> getDistributions() {
if (isAttrDefined("distribs", BuildType.DISTRIBUTIONS)
&& isAttributeValueExplicitlySpecified("distribs")) {
return NonconfigurableAttributeMapper.of(this).get("distribs", BuildType.DISTRIBUTIONS);
} else {
return getPackage().getDefaultDistribs();
}
}
@Override
public License getLicense() {
if (isAttrDefined("licenses", BuildType.LICENSE)
&& isAttributeValueExplicitlySpecified("licenses")) {
return NonconfigurableAttributeMapper.of(this).get("licenses", BuildType.LICENSE);
} else {
return getPackage().getDefaultLicense();
}
}
/**
* Returns the license of the output of the binary created by this rule, or
* null if it is not specified.
*/
public License getToolOutputLicense(AttributeMap attributes) {
if (isAttrDefined("output_licenses", BuildType.LICENSE)
&& attributes.isAttributeValueExplicitlySpecified("output_licenses")) {
return attributes.get("output_licenses", BuildType.LICENSE);
} else {
return null;
}
}
/**
* Returns the globs that were expanded to create an attribute value, or
* null if unknown or not applicable.
*/
public static GlobList<?> getGlobInfo(Object attributeValue) {
if (attributeValue instanceof GlobList<?>) {
return (GlobList<?>) attributeValue;
} else {
return null;
}
}
private void checkForNullLabel(Label labelToCheck, Object context) {
if (labelToCheck == null) {
throw new IllegalStateException(String.format(
"null label in rule %s, %s", getLabel().toString(), context));
}
}
// Consistency check: check if this label contains any weird labels (i.e.
// null-valued, with a packageFragment that is null...). The bug that prompted
// the introduction of this code is #2210848 (NullPointerException in
// Package.checkForConflicts() ).
void checkForNullLabels() throws InterruptedException {
AggregatingAttributeMapper.of(this).visitLabels(
new AttributeMap.AcceptsLabelAttribute() {
@Override
public void acceptLabelAttribute(Label labelToCheck, Attribute attribute) {
checkForNullLabel(labelToCheck, attribute);
}
});
for (OutputFile outputFile : getOutputFiles()) {
checkForNullLabel(outputFile.getLabel(), "output file");
}
}
/**
* Returns the Set of all tags exhibited by this target. May be empty.
*/
public Set<String> getRuleTags() {
Set<String> ruleTags = new LinkedHashSet<>();
for (Attribute attribute : getRuleClassObject().getAttributes()) {
if (attribute.isTaggable()) {
Type<?> attrType = attribute.getType();
String name = attribute.getName();
// This enforces the expectation that taggable attributes are non-configurable.
Object value = NonconfigurableAttributeMapper.of(this).get(name, attrType);
Set<String> tags = attrType.toTagSet(value, name);
ruleTags.addAll(tags);
}
}
return ruleTags;
}
/**
* Computes labels of additional dependencies that can be provided by aspects that this rule
* can require from its direct dependencies.
*/
public Collection<? extends Label> getAspectLabelsSuperset(DependencyFilter predicate) {
SetMultimap<Attribute, Label> labels = LinkedHashMultimap.create();
for (Attribute attribute : this.getAttributes()) {
for (Aspect candidateClass : attribute.getAspects(this)) {
AspectDefinition.addAllAttributesOfAspect(Rule.this, labels, candidateClass, predicate);
}
}
return labels.values();
}
/**
* @return The repository name.
*/
public RepositoryName getRepository() {
return RepositoryName.createFromValidStrippedName(pkg.getWorkspaceName());
}
/** Returns the suffix of target kind for all rules. */
public static String targetKindSuffix() {
return " rule";
}
}
|