// 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 com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.packages.ClassObjectConstructor;
import com.google.devtools.build.lib.packages.PackageSpecification;
import com.google.devtools.build.lib.packages.SkylarkClassObject;
import com.google.devtools.build.lib.packages.SkylarkProviderIdentifier;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.syntax.ClassObject;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.EvalUtils;
import java.util.concurrent.atomic.AtomicReference;
import javax.annotation.Nullable;
/**
* An abstract implementation of ConfiguredTarget in which all properties are
* assigned trivial default values.
*/
public abstract class AbstractConfiguredTarget
implements ConfiguredTarget, VisibilityProvider, ClassObject {
private final Target target;
private final BuildConfiguration configuration;
private final NestedSet<PackageSpecification> visibility;
// Cached on-demand default provider
private final AtomicReference<DefaultProvider> defaultProvider = new AtomicReference<>();
// Accessors for Skylark
private static final String DATA_RUNFILES_FIELD = "data_runfiles";
private static final String DEFAULT_RUNFILES_FIELD = "default_runfiles";
AbstractConfiguredTarget(Target target,
BuildConfiguration configuration) {
this.target = target;
this.configuration = configuration;
this.visibility = NestedSetBuilder.emptySet(Order.STABLE_ORDER);
}
AbstractConfiguredTarget(TargetContext targetContext) {
this.target = targetContext.getTarget();
this.configuration = targetContext.getConfiguration();
this.visibility = targetContext.getVisibility();
}
@Override
public final NestedSet<PackageSpecification> getVisibility() {
return visibility;
}
@Override
public Target getTarget() {
return target;
}
@Override
public BuildConfiguration getConfiguration() {
return configuration;
}
@Override
public Label getLabel() {
return getTarget().getLabel();
}
@Override
public String toString() {
return "ConfiguredTarget(" + getTarget().getLabel() + ", " + getConfiguration() + ")";
}
@Override
public <P extends TransitiveInfoProvider> P getProvider(Class<P> provider) {
AnalysisUtils.checkProvider(provider);
if (provider.isAssignableFrom(getClass())) {
return provider.cast(this);
} else {
return null;
}
}
@Override
public Object getValue(String name) {
switch (name) {
case FILES_FIELD:
case DEFAULT_RUNFILES_FIELD:
case DATA_RUNFILES_FIELD:
case FilesToRunProvider.SKYLARK_NAME:
// Standard fields should be proxied to their default provider object
return getDefaultProvider().getValue(name);
case LABEL_FIELD:
return getLabel();
default:
return get(name);
}
}
@Override
public final Object getIndex(Object key, Location loc) throws EvalException {
if (!(key instanceof ClassObjectConstructor)) {
throw new EvalException(loc, String.format(
"Type Target only supports indexing by object constructors, got %s instead",
EvalUtils.getDataTypeName(key)));
}
ClassObjectConstructor constructor = (ClassObjectConstructor) key;
Object declaredProvider = get(constructor.getKey());
if (declaredProvider != null) {
return declaredProvider;
}
throw new EvalException(loc, String.format(
"Object of type Target doesn't contain declared provider %s",
constructor.getPrintableName()));
}
@Override
public boolean containsKey(Object key, Location loc) throws EvalException {
if (!(key instanceof ClassObjectConstructor)) {
throw new EvalException(loc, String.format(
"Type Target only supports querying by object constructors, got %s instead",
EvalUtils.getDataTypeName(key)));
}
return get(((ClassObjectConstructor) key).getKey()) != null;
}
@Override
public String errorMessage(String name) {
return null;
}
@Override
public final ImmutableCollection<String> getKeys() {
ImmutableList.Builder<String> result = ImmutableList.builder();
result.addAll(ImmutableList.of(
DATA_RUNFILES_FIELD,
DEFAULT_RUNFILES_FIELD,
LABEL_FIELD,
FILES_FIELD,
FilesToRunProvider.SKYLARK_NAME));
if (getProvider(OutputGroupProvider.class) != null) {
result.add(OutputGroupProvider.SKYLARK_NAME);
}
if (getProvider(SkylarkProviders.class) != null) {
result.addAll(getProvider(SkylarkProviders.class).getKeys());
}
return result.build();
}
private DefaultProvider getDefaultProvider() {
if (defaultProvider.get() == null) {
defaultProvider.compareAndSet(
null,
DefaultProvider.build(
getProvider(RunfilesProvider.class),
getProvider(FileProvider.class),
getProvider(FilesToRunProvider.class)));
}
return defaultProvider.get();
}
@Nullable
@Override
public final Object get(SkylarkProviderIdentifier id) {
if (id.isLegacy()) {
return get(id.getLegacyId());
}
return get(id.getKey());
}
/** Returns a declared provider provided by this target. Only meant to use from Skylark. */
@Nullable
@Override
public final SkylarkClassObject get(ClassObjectConstructor.Key providerKey) {
if (providerKey.equals(DefaultProvider.SKYLARK_CONSTRUCTOR.getKey())) {
return getDefaultProvider();
}
if (providerKey.equals(OutputGroupProvider.SKYLARK_CONSTRUCTOR.getKey())) {
return OutputGroupProvider.get(this);
}
SkylarkProviders skylarkProviders = getProvider(SkylarkProviders.class);
if (skylarkProviders != null) {
return skylarkProviders.getDeclaredProvider(providerKey);
}
return null;
}
/**
* Returns a value provided by this target. Only meant to use from Skylark.
*/
@Override
public final Object get(String providerKey) {
if (OutputGroupProvider.SKYLARK_NAME.equals(providerKey)) {
return getProvider(OutputGroupProvider.class);
}
SkylarkProviders skylarkProviders = getProvider(SkylarkProviders.class);
return skylarkProviders != null ? skylarkProviders.getValue(providerKey) : null;
}
}