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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
// Copyright 2016 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.skylarkinterface;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* An annotation for parameters of Skylark built-in functions.
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface Param {
/**
* Name of the parameter, as viewed from Skylark. Used for matching keyword arguments and for
* generating documentation.
*/
String name();
/**
* Documentation of the parameter.
*/
String doc() default "";
/**
* Default value for the parameter, written as a Skylark expression (e.g. "False", "True", "[]",
* "None").
*
* <p>If this is empty (the default), the parameter is treated as mandatory. (Thus an exception
* will be thrown if left unspecified by the caller).
*
* <p>If the function implementation needs to distinguish the case where the caller does not
* supply a value for this parameter, you can set the default to the magic string "unbound", which
* maps to the sentinal object {@link com.google.devtools.build.lib.syntax.Runtime#UNBOUND}
* (which can't appear in normal Skylark code).
*/
String defaultValue() default "";
/**
* Type of the parameter, e.g. {@link String}.class or
* {@link com.google.devtools.build.lib.syntax.SkylarkList}.class.
*/
Class<?> type() default Object.class;
/**
* List of allowed types for the parameter if multiple types are allowed.
*
* <p>If using this, {@link #type()} should be set to {@code Object.class}.
*/
ParamType[] allowedTypes() default {};
/**
* When {@link #type()} is a generic type (e.g.,
* {@link com.google.devtools.build.lib.syntax.SkylarkList}), specify the type parameter (e.g.
* {@link String}.class} along with {@link com.google.devtools.build.lib.syntax.SkylarkList} for
* {@link #type()} to specify a list of strings).
*/
Class<?> generic1() default Object.class;
/**
* Whether the name of a callback function can be given instead of a computed value. If a
* callback function is used then the value of this parameter will be computed only when
* actually requested. E.g., if a parameter {@code foo} of a function {@code bar} is passed a
* callback function, then only when the method {@code bar} actually asks for the value
* {@code foo}, replacing it by a
* {@link com.google.devtools.build.lib.syntax.SkylarkCallbackFunction} in between.
*/
boolean callbackEnabled() default false;
/**
* If true, this parameter can be passed the "None" value in addition to whatever types it allows.
* If false, this parameter cannot be passed "None", no matter the types it allows.
*/
boolean noneable() default false;
/**
* If true, the parameter may be specified as a named parameter. For example for an integer named
* parameter {@code foo} of a method {@code bar}, then the method call will look like {@code
* bar(foo=1)}.
*
* <p>If false, then {@link #positional} must be true (otherwise there is no way to reference the
* parameter via an argument).
*
* <p>If this parameter represents the 'extra positionals' (args) or 'extra keywords' (kwargs)
* element of a method, this field has no effect.
*/
boolean named() default false;
/**
* If true, the parameter may be specified as a positional parameter. For example for an integer
* positional parameter {@code foo} of a method {@code bar}, then the method call will look like
* {@code bar(1)}. If {@link #named()} is {@code false}, then this will be the only way to call
* {@code bar}.
*
* <p>If false, then {@link #named} must be true (otherwise there is no way to reference the
* parameter via an argument)
*
* <p>Positional arguments should come first.
*
* <p>If this parameter represents the 'extra positionals' (args) or 'extra keywords' (kwargs)
* element of a method, this field has no effect.
*/
boolean positional() default true;
// TODO(bazel-team): parse the type from a single field in Skylark syntax,
// and allow a Union as "ThisType or ThatType or NoneType":
// String type() default "Object";
}
|
