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
|
// 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.Preconditions;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import java.util.ArrayList;
import java.util.Objects;
/**
* Captures the the set of providers rules and aspects can advertise.
* It is either of:
* <ul>
* <li>a set of native and skylark providers</li>
* <li>"can have any provider" set that alias rules have.</li>
* </ul>
*
* <p>
* Native providers should in theory only contain subclasses of
* {@link com.google.devtools.build.lib.analysis.TransitiveInfoProvider}, but
* our current dependency structure does not allow a reference to that class here.
* </p>
*/
@Immutable
public final class AdvertisedProviderSet {
private final boolean canHaveAnyProvider;
private final ImmutableSet<Class<?>> nativeProviders;
private final ImmutableSet<SkylarkProviderIdentifier> skylarkProviders;
private AdvertisedProviderSet(boolean canHaveAnyProvider,
ImmutableSet<Class<?>> nativeProviders,
ImmutableSet<SkylarkProviderIdentifier> skylarkProviders) {
this.canHaveAnyProvider = canHaveAnyProvider;
this.nativeProviders = nativeProviders;
this.skylarkProviders = skylarkProviders;
}
public static final AdvertisedProviderSet ANY =
new AdvertisedProviderSet(true,
ImmutableSet.<Class<?>>of(),
ImmutableSet.<SkylarkProviderIdentifier>of());
public static final AdvertisedProviderSet EMPTY =
new AdvertisedProviderSet(false,
ImmutableSet.<Class<?>>of(),
ImmutableSet.<SkylarkProviderIdentifier>of());
public static AdvertisedProviderSet create(
ImmutableSet<Class<?>> nativeProviders,
ImmutableSet<SkylarkProviderIdentifier> skylarkProviders) {
if (nativeProviders.isEmpty() && skylarkProviders.isEmpty()) {
return EMPTY;
}
return new AdvertisedProviderSet(false, nativeProviders, skylarkProviders);
}
@Override
public int hashCode() {
return Objects.hash(canHaveAnyProvider, nativeProviders, skylarkProviders);
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof AdvertisedProviderSet)) {
return false;
}
AdvertisedProviderSet that = (AdvertisedProviderSet) obj;
return Objects.equals(this.canHaveAnyProvider, that.canHaveAnyProvider)
&& Objects.equals(this.nativeProviders, that.nativeProviders)
&& Objects.equals(this.skylarkProviders, that.skylarkProviders);
}
@Override
public String toString() {
if (canHaveAnyProvider()) {
return "Any Provider";
}
return String.format("allowed native providers=%s, allowed skylark providers=%s",
getNativeProviders(), getSkylarkProviders());
}
/** Checks whether the rule can have any provider.
*
* Used for alias rules.
*/
public boolean canHaveAnyProvider() {
return canHaveAnyProvider;
}
/**
* Get all advertised native providers.
*/
public ImmutableSet<Class<?>> getNativeProviders() {
return nativeProviders;
}
/**
* Get all advertised Skylark providers.
*/
public ImmutableSet<SkylarkProviderIdentifier> getSkylarkProviders() {
return skylarkProviders;
}
public static Builder builder() {
return new Builder();
}
/** Builder for {@link AdvertisedProviderSet} */
public static class Builder {
private boolean canHaveAnyProvider;
private final ArrayList<Class<?>> nativeProviders;
private final ArrayList<SkylarkProviderIdentifier> skylarkProviders;
private Builder() {
nativeProviders = new ArrayList<>();
skylarkProviders = new ArrayList<>();
}
/**
* Advertise all providers inherited from a parent rule.
*/
public Builder addParent(AdvertisedProviderSet parentSet) {
Preconditions.checkState(!canHaveAnyProvider, "Alias rules inherit from no other rules");
Preconditions.checkState(!parentSet.canHaveAnyProvider(),
"Cannot inherit from alias rules");
nativeProviders.addAll(parentSet.getNativeProviders());
skylarkProviders.addAll(parentSet.getSkylarkProviders());
return this;
}
public Builder addNative(Class<?> nativeProvider) {
this.nativeProviders.add(nativeProvider);
return this;
}
public void canHaveAnyProvider() {
Preconditions.checkState(nativeProviders.isEmpty() && skylarkProviders.isEmpty());
this.canHaveAnyProvider = true;
}
public AdvertisedProviderSet build() {
if (canHaveAnyProvider) {
Preconditions.checkState(nativeProviders.isEmpty() && skylarkProviders.isEmpty());
return ANY;
}
return AdvertisedProviderSet.create(
ImmutableSet.copyOf(nativeProviders), ImmutableSet.copyOf(skylarkProviders));
}
public Builder addSkylark(String providerName) {
skylarkProviders.add(SkylarkProviderIdentifier.forLegacy(providerName));
return this;
}
public Builder addSkylark(SkylarkProviderIdentifier id) {
skylarkProviders.add(id);
return this;
}
public Builder addSkylark(Provider.Key id) {
skylarkProviders.add(SkylarkProviderIdentifier.forKey(id));
return this;
}
}
}
|
