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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
// 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.skydoc.fakebuildapi;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.LabelSyntaxException;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.skylarkbuildapi.FileApi;
import com.google.devtools.build.lib.skylarkbuildapi.FileTypeApi;
import com.google.devtools.build.lib.skylarkbuildapi.ProviderApi;
import com.google.devtools.build.lib.skylarkbuildapi.SkylarkAspectApi;
import com.google.devtools.build.lib.skylarkbuildapi.SkylarkRuleFunctionsApi;
import com.google.devtools.build.lib.syntax.BaseFunction;
import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.FuncallExpression;
import com.google.devtools.build.lib.syntax.Runtime;
import com.google.devtools.build.lib.syntax.SkylarkDict;
import com.google.devtools.build.lib.syntax.SkylarkList;
import com.google.devtools.build.skydoc.fakebuildapi.FakeDescriptor.Type;
import com.google.devtools.build.skydoc.rendering.AttributeInfo;
import com.google.devtools.build.skydoc.rendering.RuleInfo;
import java.util.Comparator;
import java.util.List;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
/**
* Fake implementation of {@link SkylarkRuleFunctionsApi}.
*
* <p>This fake hooks into the global {@code rule()} function, adding descriptors of calls of that
* function to a {@link List} given in the class constructor.</p>
*/
public class FakeSkylarkRuleFunctionsApi implements SkylarkRuleFunctionsApi<FileApi> {
private static final FakeDescriptor IMPLICIT_NAME_ATTRIBUTE_DESCRIPTOR =
new FakeDescriptor(Type.STRING, "A unique name for this rule.", true);
private final List<RuleInfo> ruleInfoList;
/**
* Constructor.
*
* @param ruleInfoList the list of {@link RuleInfo} objects to which rule() invocation information
* will be added
*/
public FakeSkylarkRuleFunctionsApi(List<RuleInfo> ruleInfoList) {
this.ruleInfoList = ruleInfoList;
}
@Override
public ProviderApi provider(String doc, Object fields, Location location) throws EvalException {
return new FakeProviderApi();
}
@Override
public BaseFunction rule(BaseFunction implementation, Boolean test, Object attrs,
Object implicitOutputs, Boolean executable, Boolean outputToGenfiles,
SkylarkList<?> fragments, SkylarkList<?> hostFragments, Boolean skylarkTestable,
SkylarkList<?> toolchains, String doc, SkylarkList<?> providesArg,
Boolean executionPlatformConstraintsAllowed, SkylarkList<?> execCompatibleWith,
FuncallExpression ast, Environment funcallEnv) throws EvalException {
List<AttributeInfo> attrInfos;
ImmutableMap.Builder<String, FakeDescriptor> attrsMapBuilder = ImmutableMap.builder();
if (attrs != null && attrs != Runtime.NONE) {
SkylarkDict<?, ?> attrsDict = (SkylarkDict<?, ?>) attrs;
attrsMapBuilder.putAll(attrsDict.getContents(String.class, FakeDescriptor.class, "attrs"));
}
attrsMapBuilder.put("name", IMPLICIT_NAME_ATTRIBUTE_DESCRIPTOR);
attrInfos = attrsMapBuilder.build().entrySet().stream()
.map(entry -> new AttributeInfo(
entry.getKey(),
entry.getValue().getDocString(),
entry.getValue().getType().getDescription(),
entry.getValue().isMandatory()))
.collect(Collectors.toList());
attrInfos.sort(new AttributeNameComparator());
RuleDefinitionIdentifier functionIdentifier = new RuleDefinitionIdentifier();
ruleInfoList.add(new RuleInfo(functionIdentifier, ast.getLocation(), doc, attrInfos));
return functionIdentifier;
}
@Override
public Label label(String labelString, Boolean relativeToCallerRepository, Location loc,
Environment env) throws EvalException {
try {
return Label.parseAbsolute(
labelString,
/* defaultToMain= */ false,
/* repositoryMapping= */ ImmutableMap.of());
} catch (LabelSyntaxException e) {
throw new EvalException(loc, "Illegal absolute label syntax: " + labelString);
}
}
@Override
public FileTypeApi<FileApi> fileType(SkylarkList<?> types, Location loc, Environment env)
throws EvalException {
return null;
}
@Override
public SkylarkAspectApi aspect(BaseFunction implementation, SkylarkList<?> attributeAspects,
Object attrs, SkylarkList<?> requiredAspectProvidersArg, SkylarkList<?> providesArg,
SkylarkList<?> fragments, SkylarkList<?> hostFragments, SkylarkList<?> toolchains, String doc,
FuncallExpression ast, Environment funcallEnv) throws EvalException {
return null;
}
/**
* A fake {@link BaseFunction} implementation which serves as an identifier for a rule definition.
* A skylark invocation of 'rule()' should spawn a unique instance of this class and return it.
* Thus, skylark code such as 'foo = rule()' will result in 'foo' being assigned to a unique
* identifier, which can later be matched to a registered rule() invocation saved by the fake
* build API implementation.
*/
private static class RuleDefinitionIdentifier extends BaseFunction {
private static int idCounter = 0;
public RuleDefinitionIdentifier() {
super("RuleDefinitionIdentifier" + idCounter++);
}
@Override
public boolean equals(@Nullable Object other) {
// Use exact object matching.
return this == other;
}
}
/**
* A comparator for {@link AttributeInfo} objects which sorts by attribute name alphabetically,
* except that any attribute named "name" is placed first.
*/
private static class AttributeNameComparator implements Comparator<AttributeInfo> {
@Override
public int compare(AttributeInfo o1, AttributeInfo o2) {
if (o1.getName().equals("name")) {
return o2.getName().equals("name") ? 0 : -1;
} else if (o2.getName().equals("name")) {
return 1;
} else {
return o1.getName().compareTo(o2.getName());
}
}
}
}
|
