src/main/java/com/google/devtools/build/lib/rules/java/JavaGenJarsProvider.java

// 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.rules.java;

import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.TransitiveInfoProvider;
import com.google.devtools.build.lib.collect.nestedset.Depset;
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.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.starlarkbuildapi.java.JavaAnnotationProcessingApi;
import java.util.List;
import java.util.Objects;
import javax.annotation.Nullable;
import net.starlark.java.eval.EvalException;
import net.starlark.java.eval.Starlark;

/** The collection of gen jars from the transitive closure. */
@Immutable
public final class JavaGenJarsProvider
    implements TransitiveInfoProvider, JavaAnnotationProcessingApi<Artifact> {

  private final boolean usesAnnotationProcessing;
  @Nullable private final Artifact genClassJar;
  @Nullable private final Artifact genSourceJar;

  private final NestedSet<Artifact> processorClasspath;
  private final NestedSet<String> processorClassNames;

  private final NestedSet<Artifact> transitiveGenClassJars;
  private final NestedSet<Artifact> transitiveGenSourceJars;

  private static final JavaGenJarsProvider EMPTY =
      new JavaGenJarsProvider(
          /* usesAnnotationProcessing= */ false,
          /* genClassJar= */ null,
          /* genSourceJar= */ null,
          /* processorClasspath= */ NestedSetBuilder.emptySet(Order.STABLE_ORDER),
          /* processorClassNames= */ NestedSetBuilder.emptySet(Order.STABLE_ORDER),
          /* transitiveGenClassJars= */ NestedSetBuilder.emptySet(Order.STABLE_ORDER),
          /* transitiveGenSourceJars= */ NestedSetBuilder.emptySet(Order.STABLE_ORDER));

  public static JavaGenJarsProvider create(
      boolean usesAnnotationProcessing,
      @Nullable Artifact genClassJar,
      @Nullable Artifact genSourceJar,
      JavaPluginInfo plugins,
      List<JavaGenJarsProvider> transitiveJavaGenJars) {
    if (!usesAnnotationProcessing
        && genClassJar == null
        && genSourceJar == null
        && plugins.isEmpty()
        && transitiveJavaGenJars.isEmpty()) {
      return EMPTY;
    }

    NestedSetBuilder<Artifact> classJarsBuilder = NestedSetBuilder.stableOrder();
    NestedSetBuilder<Artifact> sourceJarsBuilder = NestedSetBuilder.stableOrder();

    if (genClassJar != null) {
      classJarsBuilder.add(genClassJar);
    }
    if (genSourceJar != null) {
      sourceJarsBuilder.add(genSourceJar);
    }
    for (JavaGenJarsProvider dep : transitiveJavaGenJars) {
      classJarsBuilder.addTransitive(dep.getTransitiveGenClassJars());
      sourceJarsBuilder.addTransitive(dep.getTransitiveGenSourceJars());
    }
    return new JavaGenJarsProvider(
        usesAnnotationProcessing,
        genClassJar,
        genSourceJar,
        plugins.plugins().processorClasspath(),
        plugins.plugins().processorClasses(),
        classJarsBuilder.build(),
        sourceJarsBuilder.build());
  }

  /** Returns a copy with the given details, preserving transitiveXxx sets. */
  public JavaGenJarsProvider withDirectInfo(
      boolean usesAnnotationProcessing,
      @Nullable Artifact genClassJar,
      @Nullable Artifact genSourceJar,
      NestedSet<Artifact> processorClasspath,
      NestedSet<String> processorClassNames)
      throws EvalException {
    // Existing Jars would be a problem b/c we can't remove them from transitiveXxx sets
    if (this.genClassJar != null && !Objects.equals(this.genClassJar, genClassJar)) {
      throw Starlark.errorf("Existing genClassJar: %s", this.genClassJar);
    }
    if (this.genSourceJar != null && !Objects.equals(this.genSourceJar, genSourceJar)) {
      throw Starlark.errorf("Existing genSrcJar: %s", this.genClassJar);
    }
    return new JavaGenJarsProvider(
        usesAnnotationProcessing,
        genClassJar,
        genSourceJar,
        processorClasspath,
        processorClassNames,
        addIf(transitiveGenClassJars, genClassJar),
        addIf(transitiveGenSourceJars, genSourceJar));
  }

  private static <T> NestedSet<T> addIf(NestedSet<T> set, @Nullable T element) {
    if (element == null) {
      return set;
    }
    return NestedSetBuilder.<T>stableOrder().add(element).addTransitive(set).build();
  }

  // Package-private for @AutoCodec
  JavaGenJarsProvider(
      boolean usesAnnotationProcessing,
      @Nullable Artifact genClassJar,
      @Nullable Artifact genSourceJar,
      NestedSet<Artifact> processorClasspath,
      NestedSet<String> processorClassNames,
      NestedSet<Artifact> transitiveGenClassJars,
      NestedSet<Artifact> transitiveGenSourceJars) {
    this.usesAnnotationProcessing = usesAnnotationProcessing;
    this.genClassJar = genClassJar;
    this.genSourceJar = genSourceJar;
    this.processorClasspath = processorClasspath;
    this.processorClassNames = processorClassNames;
    this.transitiveGenClassJars = transitiveGenClassJars;
    this.transitiveGenSourceJars = transitiveGenSourceJars;
  }

  @Override
  public boolean isImmutable() {
    return true; // immutable and Starlark-hashable
  }

  @Override
  public boolean usesAnnotationProcessing() {
    return usesAnnotationProcessing;
  }

  @Override
  @Nullable
  public Artifact getGenClassJar() {
    return genClassJar;
  }

  @Override
  @Nullable
  public Artifact getGenSourceJar() {
    return genSourceJar;
  }

  @Override
  public Depset /*<Artifact>*/ getTransitiveGenClassJarsForStarlark() {
    return Depset.of(Artifact.class, transitiveGenClassJars);
  }

  NestedSet<Artifact> getTransitiveGenClassJars() {
    return transitiveGenClassJars;
  }

  @Override
  public Depset /*<Artifact>*/ getTransitiveGenSourceJarsForStarlark() {
    return Depset.of(Artifact.class, transitiveGenSourceJars);
  }

  NestedSet<Artifact> getTransitiveGenSourceJars() {
    return transitiveGenSourceJars;
  }

  @Override
  public Depset /*<Artifact>*/ getProcessorClasspathForStarlark() {
    return Depset.of(Artifact.class, processorClasspath);
  }

  NestedSet<Artifact> getProcessorClasspath() {
    return processorClasspath;
  }

  @Override
  public ImmutableList<String> getProcessorClassNames() {
    return processorClassNames.toList();
  }

  public boolean isEmpty() {
    return !usesAnnotationProcessing
        && genClassJar == null
        && genSourceJar == null
        && transitiveGenClassJars.isEmpty()
        && transitiveGenSourceJars.isEmpty();
  }
}