// Copyright 2017 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.config;

import com.google.devtools.build.lib.packages.AspectDefinition;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import java.util.Collection;

/**
 * A wrapper for {@link AspectDefinition.Builder} that supports access to {@link
 * com.google.devtools.build.lib.analysis} classes.
 *
 * <p>{@link AspectDefinition.Builder} is in {@link com.google.devtools.build.lib.packages}, so it
 * can't reference analysis-time objects.
 */
public class ConfigAwareAspectBuilder {
  private final AspectDefinition.Builder aspectBuilder;

  /**
   * Instantiates a builder wrapped around the given {@link AspectDefinition.Builder}.
   */
  private ConfigAwareAspectBuilder(AspectDefinition.Builder aspectBuilder) {
    this.aspectBuilder = aspectBuilder;
  }

  /**
   * Instantiates a builder wrapped around the given {@link AspectDefinition.Builder}.
   */
  public static ConfigAwareAspectBuilder of(AspectDefinition.Builder aspectBuilder) {
    return new ConfigAwareAspectBuilder(aspectBuilder);
  }

  /**
   * Returns the {@link AspectDefinition.Builder} this object wraps.
   *
   * <p>Call this when done with config-specific building to re-expose the builder methods in
   * {@link AspectDefinition.Builder}
   */
  public AspectDefinition.Builder originalBuilder() {
    return aspectBuilder;
  }

  /**
   * Declares the fragments required by this aspect for the configuration of the host machine this
   * aspect's actions execute on.
   *
   * <p>This is not the same as the aspect's configuration. The aspect's configuration is its
   * <i>target</i> configuration, which determines the platform it builds outputs for. The actions
   * created by this aspect run on a host machine, which is what the host configuration corresponds
   * to.
   *
   * <p>The value is inherited by subclasses.
   */
  @CanIgnoreReturnValue
  public ConfigAwareAspectBuilder requiresHostConfigurationFragments(
      Class<? extends Fragment>... configurationFragments) {
    aspectBuilder.requiresConfigurationFragments(HostTransition.INSTANCE, configurationFragments);
    return this;
  }

  /**
   * Declares the fragments required by this aspect for the configuration of the host machine this
   * aspect's actions execute on.
   *
   * <p>This is not the same as the aspect's configuration. The aspect's configuration is its
   * <i>target</i> configuration, which determines the platform it builds outputs for. The actions
   * created by this aspect run on a host machine, which is what the host configuration corresponds
   * to.
   *
   * <p>In contrast to {@link #requiresHostConfigurationFragments(Class...)}, this method takes
   * Starlark module names of fragments instead of their classes.
   */
  @CanIgnoreReturnValue
  public ConfigAwareAspectBuilder requiresHostConfigurationFragmentsByStarlarkBuiltinName(
      Collection<String> configurationFragmentNames) {
    aspectBuilder.requiresConfigurationFragmentsByStarlarkBuiltinName(
        HostTransition.INSTANCE, configurationFragmentNames);
    return this;
  }
}
