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
|
// Copyright 2017 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.rules.config;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.devtools.build.lib.analysis.TransitiveInfoCollection;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.packages.NativeInfo;
import com.google.devtools.build.lib.packages.NativeProvider;
import com.google.devtools.build.lib.packages.SkylarkProviderIdentifier;
import com.google.devtools.build.lib.skylarkinterface.Param;
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.syntax.EvalException;
import java.util.Map;
/** Provider for exporting value and valid value predicate of feature flags to consuming targets. */
@SkylarkModule(
name = "FeatureFlagInfo",
doc = "A provider used to access information about config_feature_flag rules."
)
@Immutable
public class ConfigFeatureFlagProvider extends NativeInfo {
/** Name used in Skylark for accessing ConfigFeatureFlagProvider. */
static final String SKYLARK_NAME = "FeatureFlagInfo";
/** Skylark constructor and identifier for ConfigFeatureFlagProvider. */
static final NativeProvider<ConfigFeatureFlagProvider> SKYLARK_CONSTRUCTOR = new Constructor();
private final String value;
private final Predicate<String> validityPredicate;
private ConfigFeatureFlagProvider(String value, Predicate<String> validityPredicate) {
super(SKYLARK_CONSTRUCTOR);
this.value = value;
this.validityPredicate = validityPredicate;
}
/** Creates a new ConfigFeatureFlagProvider with the given value and valid value predicate. */
public static ConfigFeatureFlagProvider create(String value, Predicate<String> isValidValue) {
return new ConfigFeatureFlagProvider(value, isValidValue);
}
/** A constructor callable from Skylark for OutputGroupInfo. */
private static class Constructor extends NativeProvider<ConfigFeatureFlagProvider> {
private Constructor() {
super(ConfigFeatureFlagProvider.class, SKYLARK_NAME);
}
@Override
protected ConfigFeatureFlagProvider createInstanceFromSkylark(Object[] args, Location loc)
throws EvalException {
@SuppressWarnings("unchecked")
Map<String, Object> kwargs = (Map<String, Object>) args[0];
if (!kwargs.containsKey("value") || !(kwargs.get("value") instanceof String)) {
throw new EvalException(loc, "FeatureFlagInfo requires 'value' to be set to a string");
}
return create((String) kwargs.get("value"), Predicates.alwaysTrue());
}
}
public static SkylarkProviderIdentifier id() {
return SKYLARK_CONSTRUCTOR.id();
}
/** Retrieves and casts the provider from the given target. */
public static ConfigFeatureFlagProvider fromTarget(TransitiveInfoCollection target) {
return target.get(SKYLARK_CONSTRUCTOR);
}
/** Gets the current value of the flag in the flag's current configuration. */
@SkylarkCallable(
name = "value",
doc = "The current value of the flag in the flag's current configuration.",
structField = true
)
public String getValue() {
return value;
}
/** Returns whether this value is valid for this flag. */
@SkylarkCallable(
name = "is_valid_value",
doc = "The value of the flag in the configuration used by the flag rule.",
parameters = {
@Param(
name = "value",
type = String.class,
doc = "String, the value to check for validity for this flag."
),
}
)
public boolean isValidValue(String value) {
return validityPredicate.apply(value);
}
// ConfigFeatureFlagProvider instances should all be unique, so we override the default
// equals and hashCode from Info to ensure that. SCO's toString is fine, however.
@Override
public boolean equals(Object other) {
return other == this;
}
@Override
public int hashCode() {
return System.identityHashCode(this);
}
}
|
