org.gradle.language.base.plugins.ComponentModelBasePlugin Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation
Show all versions of gradle-api Show documentation
Gradle 6.9.1 API redistribution.
/*
* Copyright 2014 the original author or authors.
*
* 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 org.gradle.language.base.plugins;
import com.google.common.base.Joiner;
import com.google.common.collect.Lists;
import org.gradle.api.Action;
import org.gradle.api.GradleException;
import org.gradle.api.Incubating;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.Task;
import org.gradle.api.internal.CollectionCallbackActionDecorator;
import org.gradle.api.internal.project.ProjectIdentifier;
import org.gradle.api.internal.project.ProjectInternal;
import org.gradle.api.internal.project.ProjectRegistry;
import org.gradle.api.internal.resolve.ProjectModelResolver;
import org.gradle.api.plugins.ExtensionContainer;
import org.gradle.api.tasks.TaskContainer;
import org.gradle.internal.Cast;
import org.gradle.internal.reflect.Instantiator;
import org.gradle.internal.service.ServiceRegistry;
import org.gradle.internal.logging.text.TreeFormatter;
import org.gradle.language.base.LanguageSourceSet;
import org.gradle.language.base.ProjectSourceSet;
import org.gradle.language.base.internal.ProjectLayout;
import org.gradle.language.base.internal.model.BinarySourceTransformations;
import org.gradle.language.base.internal.registry.DefaultLanguageTransformContainer;
import org.gradle.language.base.internal.registry.LanguageTransform;
import org.gradle.language.base.internal.registry.LanguageTransformContainer;
import org.gradle.model.Defaults;
import org.gradle.model.Each;
import org.gradle.model.Finalize;
import org.gradle.model.Model;
import org.gradle.model.ModelMap;
import org.gradle.model.Mutate;
import org.gradle.model.Path;
import org.gradle.model.RuleInput;
import org.gradle.model.RuleSource;
import org.gradle.model.RuleTarget;
import org.gradle.model.Rules;
import org.gradle.model.internal.core.Hidden;
import org.gradle.platform.base.ApplicationSpec;
import org.gradle.platform.base.BinaryContainer;
import org.gradle.platform.base.BinarySpec;
import org.gradle.platform.base.ComponentSpecContainer;
import org.gradle.platform.base.ComponentType;
import org.gradle.platform.base.GeneralComponentSpec;
import org.gradle.platform.base.LibrarySpec;
import org.gradle.platform.base.PlatformAwareComponentSpec;
import org.gradle.platform.base.PlatformContainer;
import org.gradle.platform.base.SourceComponentSpec;
import org.gradle.platform.base.TypeBuilder;
import org.gradle.platform.base.VariantComponentSpec;
import org.gradle.platform.base.component.BaseComponentSpec;
import org.gradle.platform.base.internal.BinarySpecInternal;
import org.gradle.platform.base.internal.DefaultPlatformContainer;
import org.gradle.platform.base.internal.DefaultPlatformResolvers;
import org.gradle.platform.base.internal.HasIntermediateOutputsComponentSpec;
import org.gradle.platform.base.internal.PlatformAwareComponentSpecInternal;
import org.gradle.platform.base.internal.PlatformResolvers;
import org.gradle.platform.base.internal.dependents.BaseDependentBinariesResolutionStrategy;
import org.gradle.platform.base.internal.dependents.DefaultDependentBinariesResolver;
import org.gradle.platform.base.internal.dependents.DependentBinariesResolver;
import org.gradle.platform.base.plugins.BinaryBasePlugin;
import java.io.File;
import java.util.List;
import java.util.Set;
import static com.google.common.base.Strings.emptyToNull;
/**
* Base plugin for component support.
*
* Adds a {@link org.gradle.platform.base.ComponentSpecContainer} named {@code components} to the model.
*
* For each binary instance added to the binaries container, registers a lifecycle task to create that binary.
*/
@Incubating
public class ComponentModelBasePlugin implements Plugin {
@Override
public void apply(Project project) {
project.getPluginManager().apply(LanguageBasePlugin.class);
project.getPluginManager().apply(BinaryBasePlugin.class);
}
@SuppressWarnings("UnusedDeclaration")
static class PluginRules extends RuleSource {
@ComponentType
void registerGeneralComponentSpec(TypeBuilder builder) {
builder.defaultImplementation(BaseComponentSpec.class);
}
@ComponentType
void registerLibrarySpec(TypeBuilder builder) {
builder.defaultImplementation(BaseComponentSpec.class);
}
@ComponentType
void registerApplicationSpec(TypeBuilder builder) {
builder.defaultImplementation(BaseComponentSpec.class);
}
@ComponentType
void registerPlatformAwareComponent(TypeBuilder builder) {
builder.internalView(PlatformAwareComponentSpecInternal.class);
}
@Hidden @Model
LanguageTransformContainer languageTransforms(CollectionCallbackActionDecorator collectionCallbackActionDecorator) {
return new DefaultLanguageTransformContainer(collectionCallbackActionDecorator);
}
// Finalizing here, as we need this to run after any 'assembling' task (jar, link, etc) is created.
// TODO: Convert this to `@BinaryTasks` when we model a `NativeAssembly` instead of wiring compile tasks directly to LinkTask
@Finalize
void createSourceTransformTasks(final TaskContainer tasks, @Path("binaries") final ModelMap binaries, LanguageTransformContainer languageTransforms, ServiceRegistry serviceRegistry) {
BinarySourceTransformations transformations = new BinarySourceTransformations(tasks, languageTransforms, serviceRegistry);
for (BinarySpecInternal binary : binaries) {
if (binary.isLegacyBinary()) {
continue;
}
transformations.createTasksFor(binary);
}
}
@Model
public ProjectLayout projectLayout(ProjectIdentifier projectIdentifier, @Path("buildDir") File buildDir) {
return new ProjectLayout(projectIdentifier, buildDir);
}
@Model
PlatformContainer platforms(Instantiator instantiator, CollectionCallbackActionDecorator collectionCallbackActionDecorator) {
return instantiator.newInstance(DefaultPlatformContainer.class, instantiator, collectionCallbackActionDecorator);
}
@Hidden @Model
PlatformResolvers platformResolver(PlatformContainer platforms) {
return new DefaultPlatformResolvers(platforms);
}
@Mutate
void registerPlatformExtension(ExtensionContainer extensions, PlatformContainer platforms) {
extensions.add(PlatformContainer.class, "platforms", platforms);
}
@Mutate
void collectBinaries(BinaryContainer binaries, ComponentSpecContainer componentSpecs) {
for (VariantComponentSpec componentSpec : componentSpecs.withType(VariantComponentSpec.class)) {
for (BinarySpecInternal binary : componentSpec.getBinaries().withType(BinarySpecInternal.class).values()) {
binaries.put(binary.getProjectScopedName(), binary);
}
}
}
@Mutate
void attachBinariesToAssembleLifecycle(@Path("tasks.assemble") Task assemble, ComponentSpecContainer components) {
List notBuildable = Lists.newArrayList();
boolean hasBuildableBinaries = false;
for (VariantComponentSpec component : components.withType(VariantComponentSpec.class)) {
for (BinarySpecInternal binary : component.getBinaries().withType(BinarySpecInternal.class)) {
if (binary.isBuildable()) {
assemble.dependsOn(binary);
hasBuildableBinaries = true;
} else {
notBuildable.add(binary);
}
}
}
if (!hasBuildableBinaries && !notBuildable.isEmpty()) {
assemble.doFirst(new CheckForNotBuildableBinariesAction(notBuildable));
}
}
private static class CheckForNotBuildableBinariesAction implements Action {
private final List notBuildable;
public CheckForNotBuildableBinariesAction(List notBuildable) {
this.notBuildable = notBuildable;
}
@Override
public void execute(Task task) {
Set taskDependencies = task.getTaskDependencies().getDependencies(task);
if (taskDependencies.isEmpty()) {
TreeFormatter formatter = new TreeFormatter();
formatter.node("No buildable binaries found");
formatter.startChildren();
for (BinarySpecInternal binary : notBuildable) {
formatter.node(binary.getDisplayName());
formatter.startChildren();
binary.getBuildAbility().explain(formatter);
formatter.endChildren();
}
formatter.endChildren();
throw new GradleException(formatter.toString());
}
}
}
@Defaults
void initializeComponentSourceSets(@Each HasIntermediateOutputsComponentSpec component, LanguageTransformContainer languageTransforms) {
// If there is a transform for the language into one of the component inputs, add a default source set
for (LanguageTransform languageTransform : languageTransforms) {
if (component.getIntermediateTypes().contains(languageTransform.getOutputType())) {
component.getSources().create(languageTransform.getLanguageName(), languageTransform.getSourceSetType());
}
}
}
@Finalize
void applyFallbackSourceConventions(@Each LanguageSourceSet languageSourceSet, ProjectIdentifier projectIdentifier) {
// Only apply default locations when none explicitly configured
if (languageSourceSet.getSource().getSourceDirectories().isEmpty()) {
File baseDir = projectIdentifier.getProjectDir();
String defaultSourceDir = Joiner.on(File.separator).skipNulls().join(baseDir.getPath(), "src", emptyToNull(languageSourceSet.getParentName()), emptyToNull(languageSourceSet.getName()));
languageSourceSet.getSource().srcDir(defaultSourceDir);
}
}
@Defaults
// TODO:LPTR We should collect all source sets in the project source set, however this messes up ComponentReportRenderer
void addComponentSourcesSetsToProjectSourceSet(@Each SourceComponentSpec component, final ProjectSourceSet projectSourceSet) {
component.getSources().afterEach(new Action() {
@Override
public void execute(LanguageSourceSet languageSourceSet) {
projectSourceSet.add(languageSourceSet);
}
});
}
@Rules
void inputRules(AttachInputs attachInputs, @Each GeneralComponentSpec component) {
attachInputs.setBinaries(component.getBinaries());
attachInputs.setSources(component.getSources());
}
static abstract class AttachInputs extends RuleSource {
@RuleTarget
abstract ModelMap getBinaries();
abstract void setBinaries(ModelMap binaries);
@RuleInput
abstract ModelMap getSources();
abstract void setSources(ModelMap sources);
@Mutate
void initializeBinarySourceSets(ModelMap binaries) {
// TODO - sources is not actual an input to binaries, it's an input to each binary
binaries.withType(BinarySpecInternal.class, new Action() {
@Override
public void execute(BinarySpecInternal binary) {
binary.getInputs().addAll(getSources().values());
}
});
}
}
@Hidden @Model
DependentBinariesResolver dependentBinariesResolver(Instantiator instantiator) {
return instantiator.newInstance(DefaultDependentBinariesResolver.class);
}
@Defaults
void registerBaseDependentBinariesResolutionStrategy(DependentBinariesResolver resolver, ServiceRegistry serviceRegistry) {
ProjectRegistry projectRegistry = Cast.uncheckedCast(serviceRegistry.get(ProjectRegistry.class));
ProjectModelResolver projectModelResolver = serviceRegistry.get(ProjectModelResolver.class);
resolver.register(new BaseDependentBinariesResolutionStrategy(projectRegistry, projectModelResolver));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy