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
|
// Copyright 2014 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.docgen.skylark;
import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.skylarkinterface.Param;
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkInterfaceUtils;
import com.google.devtools.build.lib.skylarkinterface.SkylarkSignature;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
/**
* An abstract class containing documentation for a Skylark method.
*/
public abstract class SkylarkMethodDoc extends SkylarkDoc {
/** Returns whether the Skylark method is documented. */
public abstract boolean documented();
/**
* Returns a string containing additional documentation about the method's return value.
*
* <p>Returns an empty string by default.
*/
public String getReturnTypeExtraMessage() {
return "";
}
/**
* Returns a string containing a name for the method's return type.
*/
public String getReturnType() {
return "";
}
/**
* Returns a list containing the documentation for each of the method's parameters.
*/
public List<SkylarkParamDoc> getParams() {
return ImmutableList.<SkylarkParamDoc>of();
}
private String getParameterString(Method method) {
SkylarkCallable annotation = SkylarkInterfaceUtils.getSkylarkCallable(method);
List<String> argList = new ArrayList<>();
boolean named = false;
for (Param param : withoutSelfParam(annotation, method)) {
if (param.named() && !param.positional() && !named) {
named = true;
if (!argList.isEmpty()) {
argList.add("*");
}
}
argList.add(formatParameter(param));
}
if (!annotation.extraPositionals().name().isEmpty()) {
argList.add("*" + annotation.extraPositionals().name());
}
if (!annotation.extraKeywords().name().isEmpty()) {
argList.add("**" + annotation.extraKeywords().name());
}
return Joiner.on(", ").join(argList);
}
/**
* Returns a string representing the method signature of the Skylark method, which contains
* HTML links to the documentation of parameter types if available.
*/
public abstract String getSignature();
protected String getSignature(String objectName, String methodName, Method method) {
String objectDotExpressionPrefix =
objectName.isEmpty() ? "" : objectName + ".";
return getSignature(objectDotExpressionPrefix + methodName, method);
}
protected String getSignature(String fullyQualifiedMethodName, Method method) {
String args = SkylarkInterfaceUtils.getSkylarkCallable(method).structField()
? "" : "(" + getParameterString(method) + ")";
return String.format("%s %s%s",
getTypeAnchor(method.getReturnType()), fullyQualifiedMethodName, args);
}
protected String getSignature(String objectName, SkylarkSignature method) {
List<String> argList = new ArrayList<>();
boolean named = false;
for (Param param : withoutSelfParam(method)) {
if (param.named() && !param.positional() && !named) {
named = true;
if (!method.extraPositionals().name().isEmpty()) {
argList.add("*" + method.extraPositionals().name());
}
if (!argList.isEmpty()) {
argList.add("*");
}
}
argList.add(formatParameter(param));
}
if (!named && !method.extraPositionals().name().isEmpty()) {
argList.add("*" + method.extraPositionals().name());
}
if (!method.extraKeywords().name().isEmpty()) {
argList.add("**" + method.extraKeywords().name());
}
String args = "(" + Joiner.on(", ").join(argList) + ")";
if (!objectName.equals(TOP_LEVEL_ID)) {
return String.format("%s %s.%s%s\n",
getTypeAnchor(method.returnType()), objectName, method.name(), args);
} else {
return String.format("%s %s%s\n",
getTypeAnchor(method.returnType()), method.name(), args);
}
}
private String formatParameter(Param param) {
String defaultValue = param.defaultValue();
String name = param.name();
if (defaultValue == null || !defaultValue.isEmpty()) {
return String.format("%s=%s", name, defaultValue == null ? "…" : defaultValue);
} else {
return name;
}
}
}
|
