// 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.analysis;
import static com.google.devtools.build.lib.analysis.ExtraActionUtils.createExtraActionProvider;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.actions.ActionAnalysisMetadata;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.packages.AspectClass;
import com.google.devtools.build.lib.packages.AspectDescriptor;
import com.google.devtools.build.lib.packages.AspectParameters;
import com.google.devtools.build.lib.packages.ClassObjectConstructor;
import com.google.devtools.build.lib.packages.ClassObjectConstructor.Key;
import com.google.devtools.build.lib.packages.SkylarkClassObject;
import com.google.devtools.build.lib.packages.SkylarkClassObjectConstructor;
import com.google.devtools.build.lib.packages.SkylarkProviderIdentifier;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.util.Preconditions;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.TreeMap;
import javax.annotation.Nullable;
/**
* Extra information about a configured target computed on request of a dependent.
*
* <p>Analogous to {@link ConfiguredTarget}: contains a bunch of transitive info providers, which
* are merged with the providers of the associated configured target before they are passed to the
* configured target factories that depend on the configured target to which this aspect is added.
*
* <p>Aspects are created alongside configured targets on request from dependents.
*
* <p>For more information about aspects, see {@link
* com.google.devtools.build.lib.packages.AspectClass}.
*
* @see com.google.devtools.build.lib.rules.RuleConfiguredTargetFactory
* @see com.google.devtools.build.lib.packages.AspectClass
*/
@Immutable
public final class ConfiguredAspect {
private final TransitiveInfoProviderMap providers;
private final AspectDescriptor descriptor;
private ConfiguredAspect(AspectDescriptor descriptor, TransitiveInfoProviderMap providers) {
this.descriptor = descriptor;
this.providers = providers;
}
/**
* Returns the aspect name.
*/
public String getName() {
return descriptor.getAspectClass().getName();
}
/**
* The aspect descriptor originating this ConfiguredAspect.
*/
public AspectDescriptor getDescriptor() {
return descriptor;
}
/** Returns the providers created by the aspect. */
public TransitiveInfoProviderMap getProviders() {
return providers;
}
@Nullable
@VisibleForTesting
public <P extends TransitiveInfoProvider> P getProvider(Class<P> providerClass) {
AnalysisUtils.checkProvider(providerClass);
return providers.getProvider(providerClass);
}
SkylarkProviders getSkylarkProviders() {
return providers.getProvider(SkylarkProviders.class);
}
public Object getProvider(SkylarkProviderIdentifier id) {
if (id.isLegacy()) {
return get(id.getLegacyId());
} else {
return get(id.getKey());
}
}
public SkylarkClassObject get(ClassObjectConstructor.Key key) {
if (OutputGroupProvider.SKYLARK_CONSTRUCTOR.getKey().equals(key)) {
return getProvider(OutputGroupProvider.class);
}
SkylarkProviders skylarkProviders = providers.getProvider(SkylarkProviders.class);
return skylarkProviders != null ? skylarkProviders.getDeclaredProvider(key) : null;
}
public Object get(String legacyKey) {
if (OutputGroupProvider.SKYLARK_NAME.equals(legacyKey)) {
return getProvider(OutputGroupProvider.class);
}
SkylarkProviders skylarkProviders = providers.getProvider(SkylarkProviders.class);
return skylarkProviders != null
? skylarkProviders.get(SkylarkProviderIdentifier.forLegacy(legacyKey))
: null;
}
public static ConfiguredAspect forAlias(ConfiguredAspect real) {
return new ConfiguredAspect(real.descriptor, real.getProviders());
}
public static ConfiguredAspect forNonapplicableTarget(AspectDescriptor descriptor) {
return new ConfiguredAspect(descriptor, new TransitiveInfoProviderMapBuilder().add().build());
}
public static Builder builder(
AspectClass aspectClass, AspectParameters parameters, RuleContext ruleContext) {
return new Builder(aspectClass, parameters, ruleContext);
}
/**
* Builder for {@link ConfiguredAspect}.
*/
public static class Builder {
private final TransitiveInfoProviderMapBuilder providers =
new TransitiveInfoProviderMapBuilder();
private final Map<String, NestedSetBuilder<Artifact>> outputGroupBuilders = new TreeMap<>();
private final ImmutableMap.Builder<String, Object> skylarkProviderBuilder =
ImmutableMap.builder();
private final LinkedHashMap<Key, SkylarkClassObject>
skylarkDeclaredProvidersBuilder = new LinkedHashMap<>();
private final RuleContext ruleContext;
private final AspectDescriptor descriptor;
public Builder(
AspectClass aspectClass,
AspectParameters parameters,
RuleContext context) {
this(new AspectDescriptor(aspectClass, parameters), context);
}
public Builder(AspectDescriptor descriptor, RuleContext ruleContext) {
this.descriptor = descriptor;
this.ruleContext = ruleContext;
}
public <T extends TransitiveInfoProvider> Builder addProvider(
Class<? extends T> providerClass, T provider) {
Preconditions.checkNotNull(provider);
checkProviderClass(providerClass);
providers.put(providerClass, provider);
return this;
}
/** Adds a provider to the aspect. */
public Builder addProvider(TransitiveInfoProvider provider) {
Preconditions.checkNotNull(provider);
addProvider(TransitiveInfoProviderEffectiveClassHelper.get(provider), provider);
return this;
}
private void checkProviderClass(Class<? extends TransitiveInfoProvider> providerClass) {
Preconditions.checkNotNull(providerClass);
Preconditions.checkArgument(
!SkylarkProviders.class.equals(providerClass),
"Do not provide SkylarkProviders directly");
}
/** Adds providers to the aspect. */
public Builder addProviders(TransitiveInfoProviderMap providers) {
for (int i = 0; i < providers.getProviderCount(); ++i) {
Class<? extends TransitiveInfoProvider> providerClass = providers.getProviderClassAt(i);
TransitiveInfoProvider provider = providers.getProviderAt(i);
addProvider(providerClass, providerClass.cast(provider));
}
return this;
}
/** Adds providers to the aspect. */
public Builder addProviders(TransitiveInfoProvider... providers) {
return addProviders(Arrays.asList(providers));
}
/** Adds providers to the aspect. */
public Builder addProviders(Iterable<TransitiveInfoProvider> providers) {
for (TransitiveInfoProvider provider : providers) {
addProvider(provider);
}
return this;
}
/**
* Adds a set of files to an output group.
*/
public Builder addOutputGroup(String name, NestedSet<Artifact> artifacts) {
NestedSetBuilder<Artifact> nestedSetBuilder = outputGroupBuilders.get(name);
if (nestedSetBuilder == null) {
nestedSetBuilder = NestedSetBuilder.<Artifact>stableOrder();
outputGroupBuilders.put(name, nestedSetBuilder);
}
nestedSetBuilder.addTransitive(artifacts);
return this;
}
public Builder addSkylarkTransitiveInfo(String name, Object value) {
skylarkProviderBuilder.put(name, value);
return this;
}
public Builder addSkylarkTransitiveInfo(String name, Object value, Location loc)
throws EvalException {
skylarkProviderBuilder.put(name, value);
return this;
}
public Builder addSkylarkDeclaredProvider(SkylarkClassObject declaredProvider, Location loc)
throws EvalException {
ClassObjectConstructor constructor = declaredProvider.getConstructor();
if (!constructor.isExported()) {
throw new EvalException(
constructor.getLocation(), "All providers must be top level values");
}
ClassObjectConstructor.Key key = constructor.getKey();
addDeclaredProvider(key, declaredProvider);
return this;
}
private void addDeclaredProvider(Key key, SkylarkClassObject declaredProvider) {
if (OutputGroupProvider.SKYLARK_CONSTRUCTOR.getKey().equals(key)) {
addProvider(OutputGroupProvider.class, (OutputGroupProvider) declaredProvider);
} else {
skylarkDeclaredProvidersBuilder.put(key, declaredProvider);
}
}
public Builder addNativeDeclaredProvider(SkylarkClassObject declaredProvider) {
ClassObjectConstructor constructor = declaredProvider.getConstructor();
Preconditions.checkState(constructor.isExported());
addDeclaredProvider(constructor.getKey(), declaredProvider);
return this;
}
public ConfiguredAspect build() {
if (!outputGroupBuilders.isEmpty()) {
ImmutableMap.Builder<String, NestedSet<Artifact>> outputGroups = ImmutableMap.builder();
for (Map.Entry<String, NestedSetBuilder<Artifact>> entry : outputGroupBuilders.entrySet()) {
outputGroups.put(entry.getKey(), entry.getValue().build());
}
if (skylarkDeclaredProvidersBuilder.containsKey(
OutputGroupProvider.SKYLARK_CONSTRUCTOR.getKey())) {
throw new IllegalStateException(
"OutputGroupProvider was provided explicitly; do not use addOutputGroup");
}
addDeclaredProvider(OutputGroupProvider.SKYLARK_CONSTRUCTOR.getKey(),
new OutputGroupProvider(outputGroups.build()));
}
ImmutableMap<String, Object> skylarkProvidersMap = skylarkProviderBuilder.build();
ImmutableMap<SkylarkClassObjectConstructor.Key, SkylarkClassObject>
skylarkDeclaredProvidersMap = ImmutableMap.copyOf(skylarkDeclaredProvidersBuilder);
if (!skylarkProvidersMap.isEmpty() || !skylarkDeclaredProvidersMap.isEmpty()) {
providers.add(new SkylarkProviders(skylarkProvidersMap, skylarkDeclaredProvidersMap));
}
addProvider(
createExtraActionProvider(
ImmutableSet.<ActionAnalysisMetadata>of() /* actionsWithoutExtraAction */,
ruleContext));
return new ConfiguredAspect(descriptor, providers.build());
}
}
}