// 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.devtools.build.lib.actions.Artifact; import com.google.devtools.build.lib.analysis.config.BuildConfiguration; import com.google.devtools.build.lib.analysis.configuredtargets.InputFileConfiguredTarget; import com.google.devtools.build.lib.analysis.configuredtargets.PackageGroupConfiguredTarget; 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.packages.RequiredProviders; import com.google.devtools.build.lib.skyframe.BuildConfigurationValue; import com.google.devtools.build.lib.skylarkbuildapi.TransitiveInfoCollectionApi; import com.google.devtools.build.lib.syntax.SkylarkIndexable; import com.google.devtools.build.lib.syntax.SkylarkNestedSet; import javax.annotation.Nullable; /** * Multiple {@link TransitiveInfoProvider}s bundled together. * *
Represents the information made available by a {@link ConfiguredTarget} to other ones that * depend on it. For more information about the analysis phase, see {@link * com.google.devtools.build.lib.analysis.RuleConfiguredTargetFactory}. * *
Implementations of build rules should not hold on to references to the {@link
* TransitiveInfoCollection}s representing their direct prerequisites in order to reduce their
* memory footprint (otherwise, the referenced object could refer one of its direct dependencies in
* turn, thereby making the size of the objects reachable from a single instance unbounded).
*
* @see com.google.devtools.build.lib.analysis.RuleConfiguredTargetFactory
* @see TransitiveInfoProvider
*/
public interface TransitiveInfoCollection
extends SkylarkIndexable, SkylarkProviderCollection, TransitiveInfoCollectionApi {
@Override
default SkylarkNestedSet outputGroup(String group) {
OutputGroupInfo provider = OutputGroupInfo.get(this);
NestedSet P getProvider(Class provider);
/**
* Returns the label associated with this prerequisite.
*/
Label getLabel();
/**
* Returns the {@link BuildConfigurationValue.Key} naming the {@link BuildConfiguration} for which
* this transitive info collection is defined. Configuration is defined for all configured targets
* with exception of {@link InputFileConfiguredTarget} and {@link PackageGroupConfiguredTarget}
* for which it is always null.
*/
@Nullable
BuildConfigurationValue.Key getConfigurationKey();
/**
* Checks whether this {@link TransitiveInfoCollection} satisfies given {@link RequiredProviders}.
*/
default boolean satisfies(RequiredProviders providers) {
return providers.isSatisfiedBy(
aClass -> getProvider(aClass.asSubclass(TransitiveInfoProvider.class)) != null,
id -> this.get(id) != null);
}
/**
* Returns providers that this {@link TransitiveInfoCollection} misses from a given {@link
* RequiredProviders}.
*
* If none are missing, returns {@link RequiredProviders} that accept any set of providers.
*/
default RequiredProviders missingProviders(RequiredProviders providers) {
return providers.getMissing(
aClass -> getProvider(aClass.asSubclass(TransitiveInfoProvider.class)) != null,
id -> this.get(id) != null);
}
}