| // Copyright 2019 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.starlarkbuildapi; |
| |
| import com.google.devtools.build.docgen.annot.GlobalMethods; |
| import com.google.devtools.build.docgen.annot.GlobalMethods.Environment; |
| import net.starlark.java.annot.Param; |
| import net.starlark.java.annot.ParamType; |
| import net.starlark.java.annot.StarlarkMethod; |
| import net.starlark.java.eval.EvalException; |
| import net.starlark.java.eval.NoneType; |
| import net.starlark.java.eval.Sequence; |
| import net.starlark.java.eval.StarlarkThread; |
| |
| /** A collection of global Starlark build API functions that apply to WORKSPACE files. */ |
| @GlobalMethods(environment = Environment.WORKSPACE) |
| public interface WorkspaceGlobalsApi { |
| |
| @StarlarkMethod( |
| name = "workspace", |
| doc = |
| "<p>This function can only be used in a <code>WORKSPACE</code> file and must be declared " |
| + "before all other functions in the <code>WORKSPACE</code> file. " |
| + "Each <code>WORKSPACE</code> file should have a <code>workspace</code> " |
| + "function.</p>" |
| + "<p>Sets the name for this workspace. " |
| + "Workspace names should be a Java-package-style " |
| + "description of the project, using underscores as separators, e.g., " |
| + "github.com/bazelbuild/bazel should use com_github_bazelbuild_bazel. " |
| + "<p>This name is used for the directory that the repository's runfiles are stored " |
| + "in. For example, if there is a runfile <code>foo/bar</code> in the local " |
| + "repository and the WORKSPACE file contains " |
| + "<code>workspace(name = 'baz')</code>, then the runfile will be available under " |
| + "<code>mytarget.runfiles/baz/foo/bar</code>. If no workspace name is " |
| + "specified, then the runfile will be symlinked to " |
| + "<code>bar.runfiles/foo/bar</code>.</p> " |
| + "<p><a href=\"/docs/external\">Remote repository</a> rule names must be" |
| + " valid workspace names. For example, you could have" |
| + " <code>maven_jar(name = 'foo')</code>, but not" |
| + " <code>maven_jar(name = 'foo%bar')</code>, as Bazel would attempt to write a" |
| + " WORKSPACE file for the <code>maven_jar</code> containing" |
| + " <code>workspace(name = 'foo%bar')</code>." |
| + "</p>", |
| parameters = { |
| @Param( |
| name = "name", |
| doc = |
| "the name of the workspace. Names must start with a letter and can only contain " |
| + "letters, numbers, underscores, dashes, and dots.", |
| named = true, |
| positional = false), |
| }, |
| useStarlarkThread = true) |
| void workspace(String name, StarlarkThread thread) throws EvalException, InterruptedException; |
| |
| @StarlarkMethod( |
| name = "register_execution_platforms", |
| doc = |
| "Register an already-defined platform so that Bazel can use it as an " |
| + "<a href=\"${link toolchains#toolchain-resolution}\">execution platform</a> " |
| + "during <a href=\"${link toolchains}\">toolchain resolution</a>.", |
| extraPositionals = |
| @Param( |
| name = "platform_labels", |
| allowedTypes = {@ParamType(type = Sequence.class, generic1 = String.class)}, |
| doc = "The labels of the platforms to register."), |
| useStarlarkThread = true) |
| void registerExecutionPlatforms(Sequence<?> platformLabels, StarlarkThread thread) |
| throws EvalException, InterruptedException; |
| |
| @StarlarkMethod( |
| name = "register_toolchains", |
| doc = |
| "Register an already-defined toolchain so that Bazel can use it during " |
| + "<a href=\"${link toolchains}\">toolchain resolution</a>. See examples of " |
| + "<a href=\"${link toolchains#defining-toolchains}\">defining</a> and " |
| + "<a href=\"${link toolchains#registering-and-building-with-toolchains}\">" |
| + "registering toolchains</a>.", |
| extraPositionals = |
| @Param( |
| name = "toolchain_labels", |
| allowedTypes = {@ParamType(type = Sequence.class, generic1 = String.class)}, |
| doc = |
| "The labels of the toolchains to register. Labels can include " |
| + "<code>:all</code>, in which case, all toolchain-providing targets in the " |
| + "package will be registered in lexicographical order by name."), |
| useStarlarkThread = true) |
| void registerToolchains(Sequence<?> toolchainLabels, StarlarkThread thread) |
| throws EvalException, InterruptedException; |
| |
| @StarlarkMethod( |
| name = "bind", |
| doc = |
| "<p>Warning: use of <code>bind()</code> is not recommended. See <a" |
| + " href=\"https://github.com/bazelbuild/bazel/issues/1952\">Consider removing" |
| + " bind</a> for a long discussion of its issues and alternatives.</p> <p>Gives a" |
| + " target an alias in the <code>//external</code> package.</p>", |
| parameters = { |
| @Param( |
| name = "name", |
| named = true, |
| positional = false, |
| doc = "The label under '//external' to serve as the alias name"), |
| @Param( |
| name = "actual", |
| allowedTypes = { |
| @ParamType(type = String.class), |
| @ParamType(type = NoneType.class), |
| }, |
| named = true, |
| positional = false, |
| defaultValue = "None", |
| doc = "The real label to be aliased") |
| }, |
| useStarlarkThread = true) |
| void bind(String name, Object actual, StarlarkThread thread) |
| throws EvalException, InterruptedException; |
| } |