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 * @author Robert Field 58 * @author Atul M Dambalkar 59 * @author Jamie Ho (rewrite) 60 * @author Bhavesh Patel (Modified) 61 */ 62 public class MethodWriterImpl extends AbstractExecutableMemberWriter 63 implements MethodWriter, MemberSummaryWriter { 64 65 /** 66 * Construct a new MethodWriterImpl. 67 * 68 * @param writer the writer for the class that the methods belong to. 69 * @param typeElement the class being documented. 70 */ 71 public MethodWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) { 72 super(writer, typeElement); 73 } 74 75 /** 76 * Construct a new MethodWriterImpl. 77 * 78 * @param writer The writer for the class that the methods belong to. 79 */ 80 public MethodWriterImpl(SubWriterHolderWriter writer) { 81 super(writer); 82 } 83 84 /** 85 * {@inheritDoc} 86 */ 87 @Override 88 public Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree) { 89 memberSummaryTree.add(MarkerComments.START_OF_METHOD_SUMMARY); 90 Content memberTree = new ContentBuilder(); 91 writer.addSummaryHeader(this, typeElement, memberTree); 92 return memberTree; 93 } 94 95 /** 96 * {@inheritDoc} 97 */ 98 @Override 99 public void addMemberTree(Content memberSummaryTree, Content memberTree) { 100 writer.addMemberTree(HtmlStyle.methodSummary, memberSummaryTree, memberTree); 101 } 102 103 /** 104 * {@inheritDoc} 105 */ 106 @Override 107 public Content getMethodDetailsTreeHeader(TypeElement typeElement, Content memberDetailsTree) { 108 memberDetailsTree.add(MarkerComments.START_OF_METHOD_DETAILS); 109 Content methodDetailsTree = new ContentBuilder(); 110 Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.DETAILS_HEADING, 111 contents.methodDetailLabel); 112 methodDetailsTree.add(heading); 113 methodDetailsTree.add(links.createAnchor(SectionName.METHOD_DETAIL)); 114 return methodDetailsTree; 115 } 116 117 /** 118 * {@inheritDoc} 119 */ 120 @Override 121 public Content getMethodDocTreeHeader(ExecutableElement method, Content methodDetailsTree) { 122 String erasureAnchor; 123 Content methodDocTree = new ContentBuilder(); 124 Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING); 125 heading.add(name(method)); 126 methodDocTree.add(heading); 127 if ((erasureAnchor = getErasureAnchor(method)) != null) { 128 methodDocTree.add(links.createAnchor((erasureAnchor))); 129 } 130 methodDocTree.add(links.createAnchor(writer.getAnchor(method))); 131 return HtmlTree.SECTION(HtmlStyle.detail, methodDocTree); 132 } 133 134 /** 135 * Get the signature for the given method. 136 * 137 * @param method the method being documented. 138 * @return a content object for the signature 139 */ 140 @Override 141 public Content getSignature(ExecutableElement method) { 142 MemberSignature sig = new MemberSignature(method); 143 sig.addTypeParametersAndReturnType(getTypeParameters(method), getReturnType(method)); 144 sig.addName(method); 145 sig.addParametersAndExceptions(getParameters(method, true), getExceptions(method)); 146 return sig.toContent(); 147 } 148 149 /** 150 * {@inheritDoc} 151 */ 152 @Override 153 public void addDeprecated(ExecutableElement method, Content methodDocTree) { 154 addDeprecatedInfo(method, methodDocTree); 155 } 156 157 /** 158 * {@inheritDoc} 159 */ 160 @Override 161 public void addComments(TypeMirror holderType, ExecutableElement method, Content methodDocTree) { 162 TypeElement holder = utils.asTypeElement(holderType); 163 if (!utils.getFullBody(method).isEmpty()) { 164 if (holder.equals(typeElement) || 165 !(utils.isPublic(holder) || 166 utils.isLinkable(holder))) { 167 writer.addInlineComment(method, methodDocTree); 168 } else { 169 Content link = 170 writer.getDocLink(LinkInfoImpl.Kind.EXECUTABLE_ELEMENT_COPY, 171 holder, method, 172 utils.isIncluded(holder) 173 ? utils.getSimpleName(holder) 174 : utils.getFullyQualifiedName(holder), 175 false); 176 Content codelLink = HtmlTree.CODE(link); 177 Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel, 178 utils.isClass(holder) 179 ? contents.descfrmClassLabel 180 : contents.descfrmInterfaceLabel); 181 descfrmLabel.add(Entity.NO_BREAK_SPACE); 182 descfrmLabel.add(codelLink); 183 methodDocTree.add(HtmlTree.DIV(HtmlStyle.block, descfrmLabel)); 184 writer.addInlineComment(method, methodDocTree); 185 } 186 } 187 } 188 189 /** 190 * {@inheritDoc} 191 */ 192 @Override 193 public void addTags(ExecutableElement method, Content methodDocTree) { 194 writer.addTagsInfo(method, methodDocTree); 195 } 196 197 /** 198 * {@inheritDoc} 199 */ 200 @Override 201 public Content getMethodDetails(Content methodDetailsTreeHeader, Content methodDetailsTree) { 202 Content methodDetails = new ContentBuilder(methodDetailsTreeHeader, methodDetailsTree); 203 return getMemberTree(HtmlTree.SECTION(HtmlStyle.methodDetails, methodDetails)); 204 } 205 206 /** 207 * {@inheritDoc} 208 */ 209 @Override 210 public Content getMethodDoc(Content methodDocTree, 211 boolean isLastContent) { 212 return getMemberTree(methodDocTree, isLastContent); 213 } 214 215 /** 216 * {@inheritDoc} 217 */ 218 @Override 219 public void addSummaryLabel(Content memberTree) { 220 Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING, 221 contents.methodSummary); 222 memberTree.add(label); 223 } 224 225 /** 226 * {@inheritDoc} 227 */ 228 @Override 229 public TableHeader getSummaryTableHeader(Element member) { 230 return new TableHeader(contents.modifierAndTypeLabel, contents.methodLabel, 231 contents.descriptionLabel); 232 } 233 234 @Override 235 protected Table createSummaryTable() { 236 return new Table(HtmlStyle.memberSummary) 237 .setHeader(getSummaryTableHeader(typeElement)) 238 .setRowScopeColumn(1) 239 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colSecond, HtmlStyle.colLast) 240 .setDefaultTab(resources.getText("doclet.All_Methods")) 241 .addTab(resources.getText("doclet.Static_Methods"), utils::isStatic) 242 .addTab(resources.getText("doclet.Instance_Methods"), e -> !utils.isStatic(e)) 243 .addTab(resources.getText("doclet.Abstract_Methods"), utils::isAbstract) 244 .addTab(resources.getText("doclet.Concrete_Methods"), 245 e -> !utils.isAbstract(e) && !utils.isInterface(e.getEnclosingElement())) 246 .addTab(resources.getText("doclet.Default_Methods"), utils::isDefault) 247 .addTab(resources.getText("doclet.Deprecated_Methods"), 248 e -> utils.isDeprecated(e) || utils.isDeprecated(typeElement)) 249 .setTabScript(i -> "show(" + i + ");"); 250 } 251 252 /** 253 * {@inheritDoc} 254 */ 255 @Override 256 public void addSummaryAnchor(TypeElement typeElement, Content memberTree) { 257 memberTree.add(links.createAnchor(SectionName.METHOD_SUMMARY)); 258 } 259 260 /** 261 * {@inheritDoc} 262 */ 263 @Override 264 public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) { 265 inheritedTree.add(links.createAnchor( 266 SectionName.METHODS_INHERITANCE, configuration.getClassName(typeElement))); 267 } 268 269 /** 270 * {@inheritDoc} 271 */ 272 @Override 273 public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) { 274 Content classLink = writer.getPreQualifiedClassLink( 275 LinkInfoImpl.Kind.MEMBER, typeElement, false); 276 Content label; 277 if (configuration.summarizeOverriddenMethods) { 278 label = new StringContent(utils.isClass(typeElement) 279 ? resources.getText("doclet.Methods_Declared_In_Class") 280 : resources.getText("doclet.Methods_Declared_In_Interface")); 281 } else { 282 label = new StringContent(utils.isClass(typeElement) 283 ? resources.getText("doclet.Methods_Inherited_From_Class") 284 : resources.getText("doclet.Methods_Inherited_From_Interface")); 285 } 286 Content labelHeading = HtmlTree.HEADING(Headings.TypeDeclaration.INHERITED_SUMMARY_HEADING, 287 label); 288 labelHeading.add(Entity.NO_BREAK_SPACE); 289 labelHeading.add(classLink); 290 inheritedTree.add(labelHeading); 291 } 292 293 /** 294 * {@inheritDoc} 295 */ 296 @Override 297 protected void addSummaryType(Element member, Content tdSummaryType) { 298 ExecutableElement meth = (ExecutableElement)member; 299 addModifierAndType(meth, utils.getReturnType(meth), tdSummaryType); 300 } 301 302 /** 303 * {@inheritDoc} 304 */ 305 protected static void addOverridden(HtmlDocletWriter writer, 306 TypeMirror overriddenType, ExecutableElement method, Content dl) { 307 if (writer.configuration.nocomment) { 308 return; 309 } 310 Utils utils = writer.utils; 311 Contents contents = writer.contents; 312 TypeElement holder = utils.getEnclosingTypeElement(method); 313 if (!(utils.isPublic(holder) || 314 utils.isLinkable(holder))) { 315 //This is an implementation detail that should not be documented. 316 return; 317 } 318 if (utils.isIncluded(holder) && ! utils.isIncluded(method)) { 319 //The class is included but the method is not. That means that it 320 //is not visible so don't document this. 321 return; 322 } 323 Content label = contents.overridesLabel; 324 LinkInfoImpl.Kind context = LinkInfoImpl.Kind.METHOD_OVERRIDES; 325 326 if (method != null) { 327 if (utils.isAbstract(holder) && utils.isAbstract(method)){ 328 //Abstract method is implemented from abstract class, 329 //not overridden 330 label = contents.specifiedByLabel; 331 context = LinkInfoImpl.Kind.METHOD_SPECIFIED_BY; 332 } 333 Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, label)); 334 dl.add(dt); 335 Content overriddenTypeLink = 336 writer.getLink(new LinkInfoImpl(writer.configuration, context, overriddenType)); 337 Content codeOverridenTypeLink = HtmlTree.CODE(overriddenTypeLink); 338 Content methlink = writer.getLink( 339 new LinkInfoImpl(writer.configuration, LinkInfoImpl.Kind.MEMBER, 340 holder) 341 .where(writer.links.getName(writer.getAnchor(method))).label(method.getSimpleName())); 342 Content codeMethLink = HtmlTree.CODE(methlink); 343 Content dd = HtmlTree.DD(codeMethLink); 344 dd.add(Entity.NO_BREAK_SPACE); 345 dd.add(writer.contents.inClass); 346 dd.add(Entity.NO_BREAK_SPACE); 347 dd.add(codeOverridenTypeLink); 348 dl.add(dd); 349 } 350 } 351 352 /** 353 * {@inheritDoc} 354 */ 355 protected static void addImplementsInfo(HtmlDocletWriter writer, 356 ExecutableElement method, Content dl) { 357 Utils utils = writer.utils; 358 if (utils.isStatic(method) || writer.configuration.nocomment) { 359 return; 360 } 361 Contents contents = writer.contents; 362 VisibleMemberTable vmt = writer.configuration 363 .getVisibleMemberTable(utils.getEnclosingTypeElement(method)); 364 SortedSet<ExecutableElement> implementedMethods = 365 new TreeSet<>(utils.makeOverrideUseComparator()); 366 implementedMethods.addAll(vmt.getImplementedMethods(method)); 367 for (ExecutableElement implementedMeth : implementedMethods) { 368 TypeMirror intfac = vmt.getImplementedMethodHolder(method, implementedMeth); 369 intfac = utils.getDeclaredType(utils.getEnclosingTypeElement(method), intfac); 370 Content intfaclink = writer.getLink(new LinkInfoImpl( 371 writer.configuration, LinkInfoImpl.Kind.METHOD_SPECIFIED_BY, intfac)); 372 Content codeIntfacLink = HtmlTree.CODE(intfaclink); 373 Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, contents.specifiedByLabel)); 374 dl.add(dt); 375 Content methlink = writer.getDocLink( 376 LinkInfoImpl.Kind.MEMBER, implementedMeth, 377 implementedMeth.getSimpleName(), false); 378 Content codeMethLink = HtmlTree.CODE(methlink); 379 Content dd = HtmlTree.DD(codeMethLink); 380 dd.add(Entity.NO_BREAK_SPACE); 381 dd.add(contents.inInterface); 382 dd.add(Entity.NO_BREAK_SPACE); 383 dd.add(codeIntfacLink); 384 dl.add(dd); 385 } 386 } 387 388 /** 389 * Get the return type for the given method. 390 * 391 * @param method the method being documented. 392 * @return content containing the return type 393 */ 394 protected Content getReturnType(ExecutableElement method) { 395 TypeMirror type = utils.getReturnType(method); 396 if (type != null) { 397 return writer.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.RETURN_TYPE, type)); 398 } 399 return new ContentBuilder(); 400 } 401 402 @Override 403 public Content getMemberTreeHeader(){ 404 return writer.getMemberTreeHeader(); 405 } 406 } --- EOF ---