blob: a67216544c779b9e4275327c2925e9791a3f3c21 (
plain)
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
|
// Copyright 2014 Google Inc. 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.docgen.skylark;
import com.google.devtools.build.lib.syntax.EvalUtils;
import com.google.devtools.build.lib.syntax.FuncallExpression;
import com.google.devtools.build.lib.syntax.Runtime.NoneType;
import com.google.devtools.build.lib.syntax.SkylarkList;
import com.google.devtools.build.lib.syntax.SkylarkList.Tuple;
import com.google.devtools.build.lib.syntax.SkylarkModule;
import com.google.devtools.build.lib.syntax.SkylarkSignature;
import com.google.devtools.build.lib.syntax.SkylarkSignature.Param;
import com.google.devtools.build.lib.syntax.SkylarkSignatureProcessor.HackHackEitherList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
* Abstract class for containing documentation for a Skylark syntactic entity.
*/
abstract class SkylarkDoc {
protected static final String TOP_LEVEL_ID = "globals";
/**
* Returns a string containing the name of the entity being documented.
*/
public abstract String getName();
/**
* Returns a string containing the HTML documentation of the entity being
* documented.
*/
public abstract String getDocumentation();
protected String getTypeAnchor(Class<?> returnType, Class<?> generic1) {
return getTypeAnchor(returnType) + " of " + getTypeAnchor(generic1) + "s";
}
protected String getTypeAnchor(Class<?> type) {
if (type.equals(Boolean.class) || type.equals(boolean.class)) {
return "<a class=\"anchor\" href=\"" + TOP_LEVEL_ID + ".html#bool\">bool</a>";
} else if (type.equals(String.class)) {
return "<a class=\"anchor\" href=\"string.html\">string</a>";
} else if (Map.class.isAssignableFrom(type)) {
return "<a class=\"anchor\" href=\"dict.html\">dict</a>";
} else if (Tuple.class.isAssignableFrom(type)) {
return "<a class=\"anchor\" href=\"list.html\">tuple</a>";
} else if (List.class.isAssignableFrom(type) || SkylarkList.class.isAssignableFrom(type)
|| type == HackHackEitherList.class) {
// Annotated Java methods can return simple java.util.Lists (which get auto-converted).
return "<a class=\"anchor\" href=\"list.html\">list</a>";
} else if (type.equals(Void.TYPE) || type.equals(NoneType.class)) {
return "<a class=\"anchor\" href=\"" + TOP_LEVEL_ID + ".html#None\">None</a>";
} else if (type.isAnnotationPresent(SkylarkModule.class)) {
// TODO(bazel-team): this can produce dead links for types don't show up in the doc.
// The correct fix is to generate those types (e.g. SkylarkFileType) too.
String module = type.getAnnotation(SkylarkModule.class).name();
return "<a class=\"anchor\" href=\"" + module + ".html\">" + module + "</a>";
} else {
return EvalUtils.getDataTypeNameFromClass(type);
}
}
// Elide self parameter from mandatoryPositionals in class methods.
protected static Param[] adjustedMandatoryPositionals(SkylarkSignature annotation) {
Param[] mandatoryPos = annotation.mandatoryPositionals();
if (mandatoryPos.length > 0
&& annotation.objectType() != Object.class
&& !FuncallExpression.isNamespace(annotation.objectType())) {
// Skip the self parameter, which is the first mandatory positional parameter.
return Arrays.copyOfRange(mandatoryPos, 1, mandatoryPos.length);
} else {
return mandatoryPos;
}
}
}
|
