src/main/java/com/google/devtools/build/lib/skylarkbuildapi/platform/ExecGroupCollectionApi.java

// Copyright 2020 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.skylarkbuildapi.platform;

import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.StarlarkBuiltin;
import com.google.devtools.build.lib.skylarkinterface.StarlarkDocumentationCategory;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.SkylarkIndexable;
import com.google.devtools.build.lib.syntax.StarlarkValue;

/** Stores {@link com.google.devtools.build.lib.packages.ExecGroup}s available to a given rule. */
@StarlarkBuiltin(
    name = "ExecGroupCollection",
    category = StarlarkDocumentationCategory.BUILTIN,
    // TODO(b/151742236) update this doc when this becomes non-experimental.
    doc = "<i>experimental</i> Stores exec groups available to a given rule.")
public interface ExecGroupCollectionApi extends StarlarkValue, SkylarkIndexable {

  /**
   * Stores information about a single ExecGroup. The SkylarkCallable functions in this module
   * should be a subset of the SkylarkCallable functions available for the default exec group via
   * {@link com.google.devtools.build.lib.skylarkbuildapi.SkylarkRuleContextApi}. This allows a user
   * to pass in a rule ctx to the same places that take an exec group ctx to have them operate on
   * the default exec group.
   */
  @StarlarkBuiltin(
      name = "ExecGroupContext",
      category = StarlarkDocumentationCategory.BUILTIN,
      // TODO(b/151742236) update this doc when this becomes non-experimental.
      doc = "<i>experimental</i> Stores information about an exec group.")
  interface ExecGroupContextApi extends StarlarkValue {
    @SkylarkCallable(
        name = "toolchains",
        structField = true,
        // TODO(b/151742236) update this doc when this becomes non-experimental.
        doc = "<i>experimental</i> Toolchains required for this exec group")
    ToolchainContextApi toolchains() throws EvalException;
  }
}