1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
// Copyright 2018 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;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.skylarkinterface.Param;
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkGlobalLibrary;
import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.EvalException;
/**
* A collection of global skylark build API functions that belong in the global namespace.
*/
@SkylarkGlobalLibrary
public interface SkylarkBuildApiGlobals {
@SkylarkCallable(
name = "configuration_field",
// TODO(cparsons): Provide a link to documentation for available SkylarkConfigurationFields.
doc = "References a late-bound default value for an attribute of type "
+ "<a href=\"attr.html#label\">label</a>. A value is 'late-bound' if it requires "
+ "the configuration to be built before determining the value. Any attribute using this "
+ "as a value must <a href=\"../rules.html#private-attributes\">be private</a>. "
+ "<p>Example usage: "
+ "<p>Defining a rule attribute: <br><pre class=language-python>"
+ "'foo_': attr.label(default=configuration_field(fragment='java', name='toolchain'))</pre>"
+ "<p>Accessing in rule implementation: <br><pre class=language-python>"
+ " def _rule_impl(ctx):\n"
+ " foo_info = ctx.attr._foo\n"
+ " ...</pre>",
parameters = {
@Param(
name = "fragment",
type = String.class,
named = true,
doc = "The name of a configuration fragment which contains the late-bound value."
),
@Param(
name = "name",
type = String.class,
named = true,
doc = "The name of the value to obtain from the configuration fragment."),
},
useLocation = true,
useEnvironment = true
)
public LateBoundDefaultApi configurationField(
String fragment, String name, Location loc, Environment env)
throws EvalException;
}
|
