1 /*
2 * Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package jdk.javadoc.internal.doclets.formats.html;
27
28 import java.util.SortedSet;
29 import java.util.TreeSet;
30
31 import javax.lang.model.element.Element;
32 import javax.lang.model.element.ExecutableElement;
33 import javax.lang.model.element.TypeElement;
34 import javax.lang.model.type.TypeMirror;
35
36 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
37 import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
38 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
39 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
40 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
41 import jdk.javadoc.internal.doclets.formats.html.markup.Table;
42 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
43 import jdk.javadoc.internal.doclets.toolkit.Content;
44 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
45 import jdk.javadoc.internal.doclets.toolkit.MethodWriter;
46 import jdk.javadoc.internal.doclets.toolkit.util.Utils;
47 import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable;
48
49 /**
50 * Writes method documentation in HTML format.
51 *
52 * <p><b>This is NOT part of any supported API.
53 * If you write code that depends on this, you do so at your own risk.
54 * This code and its internal interfaces are subject to change or
55 * deletion without notice.</b>
56 */
57 public class MethodWriterImpl extends AbstractExecutableMemberWriter
58 implements MethodWriter, MemberSummaryWriter {
59
60 /**
61 * Construct a new MethodWriterImpl.
62 *
63 * @param writer the writer for the class that the methods belong to.
64 * @param typeElement the class being documented.
65 */
66 public MethodWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
67 super(writer, typeElement);
68 }
69
70 /**
71 * Construct a new MethodWriterImpl.
72 *
73 * @param writer The writer for the class that the methods belong to.
74 */
75 public MethodWriterImpl(SubWriterHolderWriter writer) {
76 super(writer);
77 }
78
79 /**
80 * {@inheritDoc}
81 */
82 @Override
83 public Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree) {
84 memberSummaryTree.add(MarkerComments.START_OF_METHOD_SUMMARY);
85 Content memberTree = new ContentBuilder();
86 writer.addSummaryHeader(this, typeElement, memberTree);
87 return memberTree;
88 }
89
90 /**
91 * {@inheritDoc}
92 */
93 @Override
94 public void addMemberTree(Content memberSummaryTree, Content memberTree) {
95 writer.addMemberTree(HtmlStyle.methodSummary, memberSummaryTree, memberTree);
96 }
97
98 /**
99 * {@inheritDoc}
100 */
101 @Override
102 public Content getMethodDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree) {
103 memberDetailsTree.add(MarkerComments.START_OF_METHOD_DETAILS);
104 Content methodDetailsTree = new ContentBuilder();
105 Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.DETAILS_HEADING,
106 contents.methodDetailLabel);
107 methodDetailsTree.add(links.createAnchor(SectionName.METHOD_DETAIL));
108 methodDetailsTree.add(heading);
109 return methodDetailsTree;
110 }
111
112 /**
113 * {@inheritDoc}
114 */
115 @Override
116 public Content getMethodDocTreeHeader(ExecutableElement method, Content methodDetailsTree) {
117 String erasureAnchor;
118 Content methodDocTree = new ContentBuilder();
119 Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING);
120 if ((erasureAnchor = getErasureAnchor(method)) != null) {
121 heading.add(links.createAnchor((erasureAnchor)));
122 }
123 heading.add(links.createAnchor(writer.getAnchor(method), new StringContent(name(method))));
124 methodDocTree.add(heading);
125 return HtmlTree.SECTION(HtmlStyle.detail, methodDocTree);
126 }
127
128 /**
129 * Get the signature for the given method.
130 *
131 * @param method the method being documented.
132 * @return a content object for the signature
133 */
134 @Override
135 public Content getSignature(ExecutableElement method) {
136 return new MemberSignature(method)
137 .addTypeParameters(getTypeParameters(method))
138 .addReturnType(getReturnType(method))
139 .addParameters(getParameters(method, true))
140 .addExceptions(getExceptions(method))
141 .toContent();
142 }
143
144 /**
145 * {@inheritDoc}
146 */
147 @Override
148 public void addDeprecated(ExecutableElement method, Content methodDocTree) {
149 addDeprecatedInfo(method, methodDocTree);
150 }
151
152 /**
153 * {@inheritDoc}
154 */
155 @Override
156 public void addComments(TypeMirror holderType, ExecutableElement method, Content methodDocTree) {
157 TypeElement holder = utils.asTypeElement(holderType);
158 if (!utils.getFullBody(method).isEmpty()) {
159 if (holder.equals(typeElement) ||
160 !(utils.isPublic(holder) ||
161 utils.isLinkable(holder))) {
162 writer.addInlineComment(method, methodDocTree);
163 } else {
164 Content link =
165 writer.getDocLink(LinkInfoImpl.Kind.EXECUTABLE_ELEMENT_COPY,
166 holder, method,
167 utils.isIncluded(holder)
168 ? utils.getSimpleName(holder)
169 : utils.getFullyQualifiedName(holder),
170 false);
171 Content codeLink = HtmlTree.CODE(link);
172 Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel,
173 utils.isClass(holder)
174 ? contents.descfrmClassLabel
175 : contents.descfrmInterfaceLabel);
176 descfrmLabel.add(Entity.NO_BREAK_SPACE);
177 descfrmLabel.add(codeLink);
178 methodDocTree.add(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
179 writer.addInlineComment(method, methodDocTree);
180 }
181 }
182 }
183
184 /**
185 * {@inheritDoc}
186 */
187 @Override
188 public void addTags(ExecutableElement method, Content methodDocTree) {
189 writer.addTagsInfo(method, methodDocTree);
190 }
191
192 /**
193 * {@inheritDoc}
194 */
195 @Override
196 public Content getMethodDetails(Content methodDetailsTreeHeader, Content methodDetailsTree) {
197 Content methodDetails = new ContentBuilder(methodDetailsTreeHeader, methodDetailsTree);
198 return getMemberTree(HtmlTree.SECTION(HtmlStyle.methodDetails, methodDetails));
199 }
200
201 /**
202 * {@inheritDoc}
203 */
204 @Override
205 public Content getMethodDoc(Content methodDocTree) {
206 return getMemberTree(methodDocTree);
207 }
208
209 /**
210 * {@inheritDoc}
211 */
212 @Override
213 public void addSummaryLabel(Content memberTree) {
214 Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING,
215 contents.methodSummary);
216 memberTree.add(label);
217 }
218
219 /**
220 * {@inheritDoc}
221 */
222 @Override
223 public TableHeader getSummaryTableHeader(Element member) {
224 return new TableHeader(contents.modifierAndTypeLabel, contents.methodLabel,
225 contents.descriptionLabel);
226 }
227
228 @Override
229 protected Table createSummaryTable() {
230 return new Table(HtmlStyle.memberSummary)
231 .setHeader(getSummaryTableHeader(typeElement))
232 .setRowScopeColumn(1)
233 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colSecond, HtmlStyle.colLast)
234 .setDefaultTab(resources.getText("doclet.All_Methods"))
235 .addTab(resources.getText("doclet.Static_Methods"), utils::isStatic)
236 .addTab(resources.getText("doclet.Instance_Methods"), e -> !utils.isStatic(e))
237 .addTab(resources.getText("doclet.Abstract_Methods"), utils::isAbstract)
238 .addTab(resources.getText("doclet.Concrete_Methods"),
239 e -> !utils.isAbstract(e) && !utils.isInterface(e.getEnclosingElement()))
240 .addTab(resources.getText("doclet.Default_Methods"), utils::isDefault)
241 .addTab(resources.getText("doclet.Deprecated_Methods"),
242 e -> utils.isDeprecated(e) || utils.isDeprecated(typeElement))
243 .setTabScript(i -> "show(" + i + ");");
244 }
245
246 /**
247 * {@inheritDoc}
248 */
249 @Override
250 public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
251 memberTree.add(links.createAnchor(SectionName.METHOD_SUMMARY));
252 }
253
254 /**
255 * {@inheritDoc}
256 */
257 @Override
258 public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
259 inheritedTree.add(links.createAnchor(
260 SectionName.METHODS_INHERITANCE, configuration.getClassName(typeElement)));
261 }
262
263 /**
264 * {@inheritDoc}
265 */
266 @Override
267 public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
268 Content classLink = writer.getPreQualifiedClassLink(
269 LinkInfoImpl.Kind.MEMBER, typeElement, false);
270 Content label;
271 if (configuration.summarizeOverriddenMethods) {
272 label = new StringContent(utils.isClass(typeElement)
273 ? resources.getText("doclet.Methods_Declared_In_Class")
274 : resources.getText("doclet.Methods_Declared_In_Interface"));
275 } else {
276 label = new StringContent(utils.isClass(typeElement)
277 ? resources.getText("doclet.Methods_Inherited_From_Class")
278 : resources.getText("doclet.Methods_Inherited_From_Interface"));
279 }
280 Content labelHeading = HtmlTree.HEADING(Headings.TypeDeclaration.INHERITED_SUMMARY_HEADING,
281 label);
282 labelHeading.add(Entity.NO_BREAK_SPACE);
283 labelHeading.add(classLink);
284 inheritedTree.add(labelHeading);
285 }
286
287 /**
288 * {@inheritDoc}
289 */
290 @Override
291 protected void addSummaryType(Element member, Content tdSummaryType) {
292 ExecutableElement meth = (ExecutableElement)member;
293 addModifierAndType(meth, utils.getReturnType(meth), tdSummaryType);
294 }
295
296 /**
297 * {@inheritDoc}
298 */
299 protected static void addOverridden(HtmlDocletWriter writer,
300 TypeMirror overriddenType, ExecutableElement method, Content dl) {
301 if (writer.configuration.nocomment) {
302 return;
303 }
304 Utils utils = writer.utils;
305 Contents contents = writer.contents;
306 TypeElement holder = utils.getEnclosingTypeElement(method);
307 if (!(utils.isPublic(holder) ||
308 utils.isLinkable(holder))) {
309 //This is an implementation detail that should not be documented.
310 return;
311 }
312 if (utils.isIncluded(holder) && ! utils.isIncluded(method)) {
313 //The class is included but the method is not. That means that it
314 //is not visible so don't document this.
315 return;
316 }
317 Content label = contents.overridesLabel;
318 LinkInfoImpl.Kind context = LinkInfoImpl.Kind.METHOD_OVERRIDES;
319
320 if (method != null) {
321 if (utils.isAbstract(holder) && utils.isAbstract(method)){
322 //Abstract method is implemented from abstract class,
323 //not overridden
324 label = contents.specifiedByLabel;
325 context = LinkInfoImpl.Kind.METHOD_SPECIFIED_BY;
326 }
327 Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, label));
328 dl.add(dt);
329 Content overriddenTypeLink =
330 writer.getLink(new LinkInfoImpl(writer.configuration, context, overriddenType));
331 Content codeOverriddenTypeLink = HtmlTree.CODE(overriddenTypeLink);
332 Content methlink = writer.getLink(
333 new LinkInfoImpl(writer.configuration, LinkInfoImpl.Kind.MEMBER,
334 holder)
335 .where(writer.links.getName(writer.getAnchor(method))).label(method.getSimpleName()));
336 Content codeMethLink = HtmlTree.CODE(methlink);
337 Content dd = HtmlTree.DD(codeMethLink);
338 dd.add(Entity.NO_BREAK_SPACE);
339 dd.add(writer.contents.inClass);
340 dd.add(Entity.NO_BREAK_SPACE);
341 dd.add(codeOverriddenTypeLink);
342 dl.add(dd);
343 }
344 }
345
346 /**
347 * {@inheritDoc}
348 */
349 protected static void addImplementsInfo(HtmlDocletWriter writer,
350 ExecutableElement method, Content dl) {
351 Utils utils = writer.utils;
352 if (utils.isStatic(method) || writer.configuration.nocomment) {
353 return;
354 }
355 Contents contents = writer.contents;
356 VisibleMemberTable vmt = writer.configuration
357 .getVisibleMemberTable(utils.getEnclosingTypeElement(method));
358 SortedSet<ExecutableElement> implementedMethods =
359 new TreeSet<>(utils.makeOverrideUseComparator());
360 implementedMethods.addAll(vmt.getImplementedMethods(method));
361 for (ExecutableElement implementedMeth : implementedMethods) {
362 TypeMirror intfac = vmt.getImplementedMethodHolder(method, implementedMeth);
363 intfac = utils.getDeclaredType(utils.getEnclosingTypeElement(method), intfac);
364 Content intfaclink = writer.getLink(new LinkInfoImpl(
365 writer.configuration, LinkInfoImpl.Kind.METHOD_SPECIFIED_BY, intfac));
366 Content codeIntfacLink = HtmlTree.CODE(intfaclink);
367 Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, contents.specifiedByLabel));
368 dl.add(dt);
369 Content methlink = writer.getDocLink(
370 LinkInfoImpl.Kind.MEMBER, implementedMeth,
371 implementedMeth.getSimpleName(), false);
372 Content codeMethLink = HtmlTree.CODE(methlink);
373 Content dd = HtmlTree.DD(codeMethLink);
374 dd.add(Entity.NO_BREAK_SPACE);
375 dd.add(contents.inInterface);
376 dd.add(Entity.NO_BREAK_SPACE);
377 dd.add(codeIntfacLink);
378 dl.add(dd);
379 }
380 }
381
382 /**
383 * Get the return type for the given method.
384 *
385 * @param method the method being documented.
386 * @return content containing the return type
387 */
388 protected Content getReturnType(ExecutableElement method) {
389 TypeMirror type = utils.getReturnType(method);
390 if (type != null) {
391 return writer.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.RETURN_TYPE, type));
392 }
393 return new ContentBuilder();
394 }
395
396 @Override
397 public Content getMemberTreeHeader(){
398 return writer.getMemberTreeHeader();
399 }
400 }