1 /*
2 * Copyright (c) 1997, 2017, 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 jdk.javadoc.internal.doclets.formats.html.markup.Table;
29 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
30
31 import java.util.SortedSet;
32 import java.util.TreeSet;
33
34 import javax.lang.model.element.Element;
35 import javax.lang.model.element.ExecutableElement;
36 import javax.lang.model.element.TypeElement;
37 import javax.lang.model.type.TypeMirror;
38
39 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
40 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
41 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
42 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
43 import jdk.javadoc.internal.doclets.formats.html.markup.Links;
44 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
45 import jdk.javadoc.internal.doclets.toolkit.Content;
46 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
47 import jdk.javadoc.internal.doclets.toolkit.MethodWriter;
48 import jdk.javadoc.internal.doclets.toolkit.util.ImplementedMethods;
49 import jdk.javadoc.internal.doclets.toolkit.util.Utils;
50
51 /**
52 * Writes method documentation in HTML format.
53 *
54 * <p><b>This is NOT part of any supported API.
55 * If you write code that depends on this, you do so at your own risk.
56 * This code and its internal interfaces are subject to change or
57 * deletion without notice.</b>
58 *
59 * @author Robert Field
60 * @author Atul M Dambalkar
61 * @author Jamie Ho (rewrite)
62 * @author Bhavesh Patel (Modified)
63 */
64 public class MethodWriterImpl extends AbstractExecutableMemberWriter
65 implements MethodWriter, MemberSummaryWriter {
66
67 /**
68 * Construct a new MethodWriterImpl.
69 *
70 * @param writer the writer for the class that the methods belong to.
71 * @param typeElement the class being documented.
72 */
73 public MethodWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
74 super(writer, typeElement);
75 }
76
77 /**
78 * Construct a new MethodWriterImpl.
79 *
80 * @param writer The writer for the class that the methods belong to.
81 */
82 public MethodWriterImpl(SubWriterHolderWriter writer) {
83 super(writer);
84 }
85
86 /**
87 * {@inheritDoc}
88 */
89 @Override
90 public Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree) {
91 memberSummaryTree.addContent(HtmlConstants.START_OF_METHOD_SUMMARY);
92 Content memberTree = writer.getMemberTreeHeader();
93 writer.addSummaryHeader(this, typeElement, memberTree);
94 return memberTree;
95 }
96
97 /**
98 * {@inheritDoc}
99 */
100 @Override
101 public void addMemberTree(Content memberSummaryTree, Content memberTree) {
102 writer.addMemberTree(memberSummaryTree, memberTree);
103 }
104
105 /**
106 * {@inheritDoc}
107 */
108 @Override
109 public Content getMethodDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree) {
110 memberDetailsTree.addContent(HtmlConstants.START_OF_METHOD_DETAILS);
111 Content methodDetailsTree = writer.getMemberTreeHeader();
112 methodDetailsTree.addContent(links.createAnchor(SectionName.METHOD_DETAIL));
113 Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
114 contents.methodDetailLabel);
115 methodDetailsTree.addContent(heading);
116 return methodDetailsTree;
117 }
118
119 /**
120 * {@inheritDoc}
121 */
122 @Override
123 public Content getMethodDocTreeHeader(ExecutableElement method, Content methodDetailsTree) {
124 String erasureAnchor;
125 if ((erasureAnchor = getErasureAnchor(method)) != null) {
126 methodDetailsTree.addContent(links.createAnchor((erasureAnchor)));
127 }
128 methodDetailsTree.addContent(links.createAnchor(writer.getAnchor(method)));
129 Content methodDocTree = writer.getMemberTreeHeader();
130 Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
131 heading.addContent(name(method));
132 methodDocTree.addContent(heading);
133 return methodDocTree;
134 }
135
136 /**
137 * Get the signature for the given method.
138 *
139 * @param method the method being documented.
140 * @return a content object for the signature
141 */
142 @Override
143 public Content getSignature(ExecutableElement method) {
144 Content pre = new HtmlTree(HtmlTag.PRE);
145 writer.addAnnotationInfo(method, pre);
146 int annotationLength = pre.charCount();
147 addModifiers(method, pre);
148 addTypeParameters(method, pre);
149 addReturnType(method, pre);
150 if (configuration.linksource) {
151 Content methodName = new StringContent(name(method));
152 writer.addSrcLink(method, methodName, pre);
153 } else {
154 addName(name(method), pre);
155 }
156 int indent = pre.charCount() - annotationLength;
157 addParameters(method, pre, indent);
158 addExceptions(method, pre, indent);
159 return pre;
160 }
161
162 /**
163 * {@inheritDoc}
164 */
165 @Override
166 public void addDeprecated(ExecutableElement method, Content methodDocTree) {
167 addDeprecatedInfo(method, methodDocTree);
168 }
169
170 /**
171 * {@inheritDoc}
172 */
173 @Override
174 public void addComments(TypeMirror holderType, ExecutableElement method, Content methodDocTree) {
175 TypeElement holder = utils.asTypeElement(holderType);
176 if (!utils.getFullBody(method).isEmpty()) {
177 if (holder.equals(typeElement) ||
178 !(utils.isPublic(holder) ||
179 utils.isLinkable(holder))) {
180 writer.addInlineComment(method, methodDocTree);
181 } else {
182 Content link =
183 writer.getDocLink(LinkInfoImpl.Kind.EXECUTABLE_ELEMENT_COPY,
184 holder, method,
185 utils.isIncluded(holder)
186 ? utils.getSimpleName(holder)
187 : utils.getFullyQualifiedName(holder),
188 false);
189 Content codelLink = HtmlTree.CODE(link);
190 Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel,
191 utils.isClass(holder)
192 ? contents.descfrmClassLabel
193 : contents.descfrmInterfaceLabel);
194 descfrmLabel.addContent(Contents.SPACE);
195 descfrmLabel.addContent(codelLink);
196 methodDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
197 writer.addInlineComment(method, methodDocTree);
198 }
199 }
200 }
201
202 /**
203 * {@inheritDoc}
204 */
205 @Override
206 public void addTags(ExecutableElement method, Content methodDocTree) {
207 writer.addTagsInfo(method, methodDocTree);
208 }
209
210 /**
211 * {@inheritDoc}
212 */
213 @Override
214 public Content getMethodDetails(Content methodDetailsTree) {
215 if (configuration.allowTag(HtmlTag.SECTION)) {
216 HtmlTree htmlTree = HtmlTree.SECTION(getMemberTree(methodDetailsTree));
217 return htmlTree;
218 }
219 return getMemberTree(methodDetailsTree);
220 }
221
222 /**
223 * {@inheritDoc}
224 */
225 @Override
226 public Content getMethodDoc(Content methodDocTree,
227 boolean isLastContent) {
228 return getMemberTree(methodDocTree, isLastContent);
229 }
230
231 /**
232 * {@inheritDoc}
233 */
234 @Override
235 public void addSummaryLabel(Content memberTree) {
236 Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
237 contents.methodSummary);
238 memberTree.addContent(label);
239 }
240
241 /**
242 * {@inheritDoc}
243 */
244 @Override
245 public TableHeader getSummaryTableHeader(Element member) {
246 return new TableHeader(contents.modifierAndTypeLabel, contents.methodLabel,
247 contents.descriptionLabel);
248 }
249
250 @Override
251 protected Table createSummaryTable() {
252 String summary = resources.getText("doclet.Member_Table_Summary",
253 resources.getText("doclet.Method_Summary"),
254 resources.getText("doclet.methods"));
255
256 return new Table(configuration.htmlVersion, HtmlStyle.memberSummary)
257 .setSummary(summary)
258 .setHeader(getSummaryTableHeader(typeElement))
259 .setRowScopeColumn(1)
260 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colSecond, HtmlStyle.colLast)
261 .setDefaultTab(resources.getText("doclet.All_Methods"))
262 .addTab(resources.getText("doclet.Static_Methods"), utils::isStatic)
263 .addTab(resources.getText("doclet.Instance_Methods"), e -> !utils.isStatic(e))
264 .addTab(resources.getText("doclet.Abstract_Methods"), utils::isAbstract)
265 .addTab(resources.getText("doclet.Concrete_Methods"),
266 e -> !utils.isAbstract(e) && !utils.isInterface(e.getEnclosingElement()))
267 .addTab(resources.getText("doclet.Default_Methods"),
268 e -> !utils.isAbstract(e) && utils.isInterface(e.getEnclosingElement()))
269 .addTab(resources.getText("doclet.Deprecated_Methods"),
270 e -> utils.isDeprecated(e) || utils.isDeprecated(typeElement))
271 .setTabScriptVariable("methods")
272 .setTabScript(i -> "show(" + i + ");")
273 .setUseTBody(false)
274 .setPutIdFirst(true);
275 }
276
277 /**
278 * {@inheritDoc}
279 */
280 @Override
281 public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
282 memberTree.addContent(links.createAnchor(SectionName.METHOD_SUMMARY));
283 }
284
285 /**
286 * {@inheritDoc}
287 */
288 @Override
289 public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
290 inheritedTree.addContent(links.createAnchor(
291 SectionName.METHODS_INHERITANCE, configuration.getClassName(typeElement)));
292 }
293
294 /**
295 * {@inheritDoc}
296 */
297 @Override
298 public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
299 Content classLink = writer.getPreQualifiedClassLink(
300 LinkInfoImpl.Kind.MEMBER, typeElement, false);
301 Content label;
302 if (configuration.summarizeOverriddenMethods) {
303 label = new StringContent(utils.isClass(typeElement)
304 ? configuration.getText("doclet.Methods_Declared_In_Class")
305 : configuration.getText("doclet.Methods_Declared_In_Interface"));
306 } else {
307 label = new StringContent(utils.isClass(typeElement)
308 ? configuration.getText("doclet.Methods_Inherited_From_Class")
309 : configuration.getText("doclet.Methods_Inherited_From_Interface"));
310 }
311 Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
312 label);
313 labelHeading.addContent(Contents.SPACE);
314 labelHeading.addContent(classLink);
315 inheritedTree.addContent(labelHeading);
316 }
317
318 /**
319 * {@inheritDoc}
320 */
321 @Override
322 protected void addSummaryType(Element member, Content tdSummaryType) {
323 ExecutableElement meth = (ExecutableElement)member;
324 addModifierAndType(meth, utils.getReturnType(meth), tdSummaryType);
325 }
326
327 /**
328 * {@inheritDoc}
329 */
330 protected static void addOverridden(HtmlDocletWriter writer,
331 TypeMirror overriddenType, ExecutableElement method, Content dl) {
332 if (writer.configuration.nocomment) {
333 return;
334 }
335 Utils utils = writer.utils;
336 Contents contents = writer.contents;
337 TypeElement holder = utils.getEnclosingTypeElement(method);
338 if (!(utils.isPublic(holder) ||
339 utils.isLinkable(holder))) {
340 //This is an implementation detail that should not be documented.
341 return;
342 }
343 if (utils.isIncluded(holder) && ! utils.isIncluded(method)) {
344 //The class is included but the method is not. That means that it
345 //is not visible so don't document this.
346 return;
347 }
348 Content label = contents.overridesLabel;
349 LinkInfoImpl.Kind context = LinkInfoImpl.Kind.METHOD_OVERRIDES;
350
351 if (method != null) {
352 if (utils.isAbstract(holder) && utils.isAbstract(method)){
353 //Abstract method is implemented from abstract class,
354 //not overridden
355 label = contents.specifiedByLabel;
356 context = LinkInfoImpl.Kind.METHOD_SPECIFIED_BY;
357 }
358 Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, label));
359 dl.addContent(dt);
360 Content overriddenTypeLink =
361 writer.getLink(new LinkInfoImpl(writer.configuration, context, overriddenType));
362 Content codeOverridenTypeLink = HtmlTree.CODE(overriddenTypeLink);
363 Content methlink = writer.getLink(
364 new LinkInfoImpl(writer.configuration, LinkInfoImpl.Kind.MEMBER,
365 holder)
366 .where(writer.links.getName(writer.getAnchor(method))).label(method.getSimpleName()));
367 Content codeMethLink = HtmlTree.CODE(methlink);
368 Content dd = HtmlTree.DD(codeMethLink);
369 dd.addContent(Contents.SPACE);
370 dd.addContent(writer.contents.inClass);
371 dd.addContent(Contents.SPACE);
372 dd.addContent(codeOverridenTypeLink);
373 dl.addContent(dd);
374 }
375 }
376
377 /**
378 * {@inheritDoc}
379 */
380 protected static void addImplementsInfo(HtmlDocletWriter writer,
381 ExecutableElement method, Content dl) {
382 Utils utils = writer.utils;
383 if (utils.isStatic(method) || writer.configuration.nocomment) {
384 return;
385 }
386 Contents contents = writer.contents;
387 ImplementedMethods implementedMethodsFinder =
388 new ImplementedMethods(method, writer.configuration);
389 SortedSet<ExecutableElement> implementedMethods =
390 new TreeSet<>(utils.makeOverrideUseComparator());
391 implementedMethods.addAll(implementedMethodsFinder.build());
392 for (ExecutableElement implementedMeth : implementedMethods) {
393 TypeMirror intfac = implementedMethodsFinder.getMethodHolder(implementedMeth);
394 intfac = utils.getDeclaredType(utils.getEnclosingTypeElement(method), intfac);
395 Content intfaclink = writer.getLink(new LinkInfoImpl(
396 writer.configuration, LinkInfoImpl.Kind.METHOD_SPECIFIED_BY, intfac));
397 Content codeIntfacLink = HtmlTree.CODE(intfaclink);
398 Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, contents.specifiedByLabel));
399 dl.addContent(dt);
400 Content methlink = writer.getDocLink(
401 LinkInfoImpl.Kind.MEMBER, implementedMeth,
402 implementedMeth.getSimpleName(), false);
403 Content codeMethLink = HtmlTree.CODE(methlink);
404 Content dd = HtmlTree.DD(codeMethLink);
405 dd.addContent(Contents.SPACE);
406 dd.addContent(contents.inInterface);
407 dd.addContent(Contents.SPACE);
408 dd.addContent(codeIntfacLink);
409 dl.addContent(dd);
410 }
411 }
412
413 /**
414 * Add the return type.
415 *
416 * @param method the method being documented.
417 * @param htmltree the content tree to which the return type will be added
418 */
419 protected void addReturnType(ExecutableElement method, Content htmltree) {
420 TypeMirror type = utils.getReturnType(method);
421 if (type != null) {
422 Content linkContent = writer.getLink(
423 new LinkInfoImpl(configuration, LinkInfoImpl.Kind.RETURN_TYPE, type));
424 htmltree.addContent(linkContent);
425 htmltree.addContent(Contents.SPACE);
426 }
427 }
428
429 /**
430 * {@inheritDoc}
431 */
432 @Override
433 protected Content getNavSummaryLink(TypeElement typeElement, boolean link) {
434 if (link) {
435 if (typeElement == null) {
436 return Links.createLink(
437 SectionName.METHOD_SUMMARY,
438 contents.navMethod);
439 } else {
440 return links.createLink(
441 SectionName.METHODS_INHERITANCE,
442 configuration.getClassName(typeElement), contents.navMethod);
443 }
444 } else {
445 return contents.navMethod;
446 }
447 }
448
449 /**
450 * {@inheritDoc}
451 */
452 @Override
453 protected void addNavDetailLink(boolean link, Content liNav) {
454 if (link) {
455 liNav.addContent(Links.createLink(
456 SectionName.METHOD_DETAIL, contents.navMethod));
457 } else {
458 liNav.addContent(contents.navMethod);
459 }
460 }
461 }