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

import com.google.common.base.Preconditions;
import com.google.common.collect.Interner;
import com.google.devtools.build.lib.actions.ParameterFile.ParameterFileType;
import com.google.devtools.build.lib.concurrent.BlazeInterners;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec;
import com.google.errorprone.annotations.CanIgnoreReturnValue;
import javax.annotation.Nullable;

/**
 * An object that encapsulates how a params file should be constructed: what is the filetype, what
 * charset to use and what prefix (typically "@") to use.
 */
@AutoCodec
public record ParamFileInfo(
    ParameterFileType fileType,
    String flagFormatString,
    boolean always,
    boolean flagsOnly,
    @Nullable String paramFileName) {

  private static final Interner<ParamFileInfo> paramFileInfoInterner =
      BlazeInterners.newWeakInterner();

  public ParamFileInfo {
    Preconditions.checkNotNull(fileType);
    Preconditions.checkNotNull(flagFormatString);
  }

  @AutoCodec.Instantiator
  static ParamFileInfo create(
      ParameterFileType fileType,
      String flagFormatString,
      boolean always,
      boolean flagsOnly,
      @Nullable String paramFileName) {
    return paramFileInfoInterner.intern(
        new ParamFileInfo(fileType, flagFormatString, always, flagsOnly, paramFileName));
  }

  /** Returns the file type. */
  public ParameterFileType getFileType() {
    return fileType();
  }

  /** Returns the format string for the params filename on the command line (typically "@%s"). */
  public String getFlagFormatString() {
    return flagFormatString();
  }

  /** Returns the custom name for the parameter file, or null if it should be derived. */
  @Nullable
  public String getParamFileName() {
    return paramFileName();
  }

  public static Builder builder(ParameterFileType parameterFileType) {
    return new Builder(parameterFileType);
  }

  /** Builder for a ParamFileInfo. */
  public static class Builder {
    private final ParameterFileType fileType;
    private String flagFormatString = "@%s";
    private boolean always;
    private boolean flagsOnly;
    @Nullable private String paramFileName;

    private Builder(ParameterFileType fileType) {
      this.fileType = fileType;
    }

    /**
     * Sets a format string to use for the flag that is passed to original command.
     *
     * <p>The format string must have a single "%s" that will be replaced by the execution path to
     * the param file.
     */
    @CanIgnoreReturnValue
    public Builder setFlagFormatString(String flagFormatString) {
      this.flagFormatString = flagFormatString;
      return this;
    }

    /** Set whether the parameter file is always used, regardless of parameter file length. */
    @CanIgnoreReturnValue
    public Builder setUseAlways(boolean always) {
      this.always = always;
      return this;
    }

    /**
     * If true, only the flags will be spilled to the file, leaving positional args on the command
     * line. (Default is false.)
     */
    @CanIgnoreReturnValue
    public Builder setFlagsOnly(boolean flagsOnly) {
      this.flagsOnly = flagsOnly;
      return this;
    }

    /** Sets the custom name for the parameter file. */
    @CanIgnoreReturnValue
    public Builder setParamFileName(String paramFileName) {
      this.paramFileName = paramFileName;
      return this;
    }

    public ParamFileInfo build() {
      return create(fileType, flagFormatString, always, flagsOnly, paramFileName);
    }
  }
}