src/main/java/com/google/devtools/common/options/OptionsProvider.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.common.options;

import com.google.devtools.build.lib.skybridge.SkybridgeInterface;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nullable;

/**
 * A read-only interface for options parser results, which only allows to query the options of a
 * specific class, but not e.g. the residue any other information pertaining to the command line.
 */
@SkybridgeInterface
public interface OptionsProvider {
  public static final OptionsProvider EMPTY =
      new OptionsProvider() {
        @Override
        @Nullable
        public <O extends OptionsBase> O getOptions(Class<O> optionsClass) {
          return null;
        }

        @SuppressWarnings("EmptyMap") // no Guava in skybridge interfaces
        @Override
        public Map<String, Object> getStarlarkOptions() {
          return Collections.emptyMap();
        }

        @SuppressWarnings("EmptyMap") // no Guava in skybridge interfaces
        @Override
        public Map<String, String> getScopesAttributes() {
          return Collections.emptyMap();
        }

        @SuppressWarnings("EmptyMap") // no Guava in skybridge interfaces
        @Override
        public Map<String, Object> getOnLeaveScopeValues() {
          return Collections.emptyMap();
        }

        @SuppressWarnings("EmptyMap") // no Guava in skybridge interfaces
        @Override
        public Map<String, Object> getExplicitCommandLineStarlarkOptions() {
          return Collections.emptyMap();
        }

        @SuppressWarnings("EmptySet") // no Guava in skybridge interfaces
        @Override
        public Set<String> getStarlarkOptionsAllowingMultiple() {
          return Collections.emptySet();
        }

        @SuppressWarnings("EmptyMap") // no Guava in skybridge interface
        @Override
        public Map<String, String> getUserOptions() {
          return Collections.emptyMap();
        }
      };

  /**
   * Returns the options instance for the given {@code optionsClass}, that is, the parsed options,
   * or null if it is not among those available.
   *
   * <p>The returned options should be treated by library code as immutable and a provider is
   * permitted to return the same options instance multiple times.
   */
  @Nullable
  <O extends OptionsBase> O getOptions(Class<O> optionsClass);

  /**
   * Returns the starlark options in a name:value map.
   *
   * <p>These follow the basics of the option syntax, --<name>=<value> but are parsed and stored
   * differently than native options based on <name> starting with "//". This is a sufficient
   * demarcation between starlark flags and native flags for now since all starlark flags are
   * targets and are identified by their package path. But in the future when we implement short
   * names for starlark options, this will need to change.
   */
  Map<String, Object> getStarlarkOptions();

  /**
   * Variant of {@link #getStarlarkOptions()} that only returns Starlark that were explicitly set in
   * the command line.
   */
  Map<String, Object> getExplicitCommandLineStarlarkOptions();

  /**
   * Returns the names of Starlark options allowing multiple option instances on the command line,
   * which are combined into a list value upon parsing (which then needs to be split if one wishes
   * to obtain the original command line). Corresponds to {@code allow_multiple = True} or {@code
   * repeatable = True} in the {@code config} API in Starlark.
   */
  Set<String> getStarlarkOptionsAllowingMultiple();

  /**
   * Returns the options that were parsed from either a user blazerc file or the command line as a
   * map of option name to the option's {@code expandedFrom}, or "" if the option was not expanded.
   */
  Map<String, String> getUserOptions();

  Map<String, String> getScopesAttributes();

  Map<String, Object> getOnLeaveScopeValues();
}