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