src/main/java/com/google/devtools/build/lib/analysis/ExtraActionArtifactsProvider.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.analysis;

import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Artifact;
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.concurrent.ThreadSafety.Immutable;

/**
 * A {@link TransitiveInfoProvider} that creates extra actions.
 */
@Immutable
public final class ExtraActionArtifactsProvider implements TransitiveInfoProvider {
  public static final ExtraActionArtifactsProvider EMPTY =
      new ExtraActionArtifactsProvider(
          NestedSetBuilder.<Artifact>emptySet(Order.STABLE_ORDER),
          NestedSetBuilder.<ExtraArtifactSet>emptySet(Order.STABLE_ORDER));

  /**
   * The set of extra artifacts provided by a single configured target.
   */
  @Immutable
  public static final class ExtraArtifactSet {
    private final Label label;
    private final ImmutableList<Artifact> artifacts;

    private ExtraArtifactSet(Label label, Iterable<Artifact> artifacts) {
      this.label = label;
      this.artifacts = ImmutableList.copyOf(artifacts);
    }

    public Label getLabel() {
      return label;
    }

    public ImmutableList<Artifact> getArtifacts() {
      return artifacts;
    }

    public static ExtraArtifactSet of(Label label, Iterable<Artifact> artifacts) {
      return new ExtraArtifactSet(label, artifacts);
    }

    @Override
    public int hashCode() {
      return label.hashCode();
    }

    @Override
    public boolean equals(Object other) {
      return other == this
          || (other instanceof ExtraArtifactSet
              && label.equals(((ExtraArtifactSet) other).getLabel()));
    }
  }

  public static ExtraActionArtifactsProvider create(NestedSet<Artifact> extraActionArtifacts,
      NestedSet<ExtraArtifactSet> transitiveExtraActionArtifacts) {
    if (extraActionArtifacts.isEmpty() && transitiveExtraActionArtifacts.isEmpty()) {
      return EMPTY;
    }
    return new ExtraActionArtifactsProvider(extraActionArtifacts, transitiveExtraActionArtifacts);
  }

  public static ExtraActionArtifactsProvider merge(
      Iterable<ExtraActionArtifactsProvider> providers) {
    NestedSetBuilder<Artifact> artifacts = NestedSetBuilder.stableOrder();
    NestedSetBuilder<ExtraArtifactSet> transitiveExtraActionArtifacts =
        NestedSetBuilder.stableOrder();

    for (ExtraActionArtifactsProvider provider : providers) {
      artifacts.addTransitive(provider.getExtraActionArtifacts());
      transitiveExtraActionArtifacts.addTransitive(provider.getTransitiveExtraActionArtifacts());
    }
    return ExtraActionArtifactsProvider.create(
        artifacts.build(), transitiveExtraActionArtifacts.build());
  }

  /** The outputs of the extra actions associated with this target. */
  private final NestedSet<Artifact> extraActionArtifacts;
  private final NestedSet<ExtraArtifactSet> transitiveExtraActionArtifacts;

  /**
   * Use {@link #create} instead.
   */
  private ExtraActionArtifactsProvider(NestedSet<Artifact> extraActionArtifacts,
      NestedSet<ExtraArtifactSet> transitiveExtraActionArtifacts) {
    this.extraActionArtifacts = extraActionArtifacts;
    this.transitiveExtraActionArtifacts = transitiveExtraActionArtifacts;
  }

  /**
   * The outputs of the extra actions associated with this target.
   */
  public NestedSet<Artifact> getExtraActionArtifacts() {
    return extraActionArtifacts;
  }

  /**
   * The outputs of the extra actions in the whole transitive closure.
   */
  public NestedSet<ExtraArtifactSet> getTransitiveExtraActionArtifacts() {
    return transitiveExtraActionArtifacts;
  }
}