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
|
// 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.SkylarkConstructor;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.SkylarkDict;
/**
* Interface for an info object that indicates what output groups a rule has.
*/
@SkylarkModule(
name = "OutputGroupInfo",
category = SkylarkModuleCategory.PROVIDER,
doc = "A provider that indicates what output groups a rule has.<br>"
+ "See <a href=\"../rules.$DOC_EXT#requesting-output-files\">Requesting output files"
+ "</a> for more information."
)
public interface OutputGroupInfoApi extends StructApi {
/**
* Provider for {@link OutputGroupInfoApi}.
*/
@SkylarkModule(name = "Provider", documented = false, doc = "")
public static interface OutputGroupInfoApiProvider extends ProviderApi {
@SkylarkCallable(
name = "OutputGroupInfo",
doc =
"Instantiate this provider with <br>"
+ "<pre class=language-python>"
+ "OutputGroupInfo(group1 = <files>, group2 = <files>...)</pre>"
+ "See <a href=\"../rules.$DOC_EXT#requesting-output-files\">Requesting output "
+ "files </a> for more information.",
extraKeywords =
@Param(
name = "kwargs",
type = SkylarkDict.class,
defaultValue = "{}",
doc = "Dictionary of arguments."),
useLocation = true,
selfCall = true)
@SkylarkConstructor(objectType = OutputGroupInfoApi.class,
receiverNameForDoc = "OutputGroupInfo")
public OutputGroupInfoApi constructor(
SkylarkDict<?, ?> kwargs, Location loc) throws EvalException;
}
}
|