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
|
// Copyright 2015 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.analysis.constraints;
import static com.google.devtools.build.lib.packages.Attribute.attr;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.analysis.BaseRuleClasses;
import com.google.devtools.build.lib.analysis.RuleDefinition;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.packages.BuildType;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.syntax.Type;
import com.google.devtools.build.lib.util.FileTypeSet;
/**
* Rule definition for environment rules (for Bazel's constraint enforcement system).
*/
public class EnvironmentRule implements RuleDefinition {
public static final String RULE_NAME = "environment";
public static final String FULFILLS_ATTRIBUTE = "fulfills";
@Override
public RuleClass build(RuleClass.Builder builder, RuleDefinitionEnvironment env) {
return builder
.override(attr("tags", Type.STRING_LIST)
// No need to show up in ":all", etc. target patterns.
.value(ImmutableList.of("manual"))
.nonconfigurable("low-level attribute, used in TargetUtils without configurations"))
/* <!-- #BLAZE_RULE(environment).ATTRIBUTE(fulfills) -->
The set of environments this one is considered a valid "standin" for.
${SYNOPSIS}
<p>
If rule A depends on rule B, A declares compatibility with environment <code>:foo</code>,
and B declares compatibility with environment <code>:bar</code>, this is normally not
considered a valid dependency. But if <code>:bar</code> fulfills <code>:foo</code>, the
dependency is considered valid. B's own dependencies are subsequently expected to support
<code>:bar</code> (the original expectation for <code>:foo</code> is dropped).
</p>
<p>
Environments may only fulfill other environments in the same environment group.
</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr(FULFILLS_ATTRIBUTE, BuildType.LABEL_LIST)
.allowedRuleClasses(EnvironmentRule.RULE_NAME)
.allowedFileTypes(FileTypeSet.NO_FILE)
.nonconfigurable("used for defining constraint models - this shouldn't be configured"))
.exemptFromConstraintChecking("this rule *defines* a constraint")
.setUndocumented()
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name(EnvironmentRule.RULE_NAME)
.ancestors(BaseRuleClasses.BaseRule.class)
.factoryClass(Environment.class)
.build();
}
}
|
