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.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 = writer.getMemberTreeHeader();
  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(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 = writer.getMemberTreeHeader();
 110         methodDetailsTree.add(links.createAnchor(SectionName.METHOD_DETAIL));
 111         Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.DETAILS_HEADING,
 112                 contents.methodDetailLabel);
 113         methodDetailsTree.add(heading);
 114         return methodDetailsTree;
 115     }
 116 
 117     /**
 118      * {@inheritDoc}
 119      */
 120     @Override
 121     public Content getMethodDocTreeHeader(ExecutableElement method, Content methodDetailsTree) {
 122         String erasureAnchor;
 123         if ((erasureAnchor = getErasureAnchor(method)) != null) {
 124             methodDetailsTree.add(links.createAnchor((erasureAnchor)));
 125         }
 126         methodDetailsTree.add(links.createAnchor(writer.getAnchor(method)));
 127         Content methodDocTree = writer.getMemberTreeHeader();
 128         Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING);
 129         heading.add(name(method));
 130         methodDocTree.add(heading);
 131         return 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         HtmlTree pre = new HtmlTree(HtmlTag.PRE);
 143         pre.setStyle(HtmlStyle.methodSignature);
 144         writer.addAnnotationInfo(method, pre);
 145         int annotationLength = pre.charCount();
 146         addModifiers(method, pre);
 147         addTypeParameters(method, pre);
 148         addReturnType(method, pre);
 149         if (configuration.linksource) {
 150             Content methodName = new StringContent(name(method));
 151             writer.addSrcLink(method, methodName, pre);
 152         } else {
 153             addName(name(method), pre);
 154         }
 155         int indent = pre.charCount() - annotationLength;
 156         addParameters(method, pre, indent);
 157         addExceptions(method, pre, indent);
 158         return pre;
 159     }
 160 
 161     /**
 162      * {@inheritDoc}
 163      */
 164     @Override
 165     public void addDeprecated(ExecutableElement method, Content methodDocTree) {
 166         addDeprecatedInfo(method, methodDocTree);
 167     }
 168 
 169     /**
 170      * {@inheritDoc}
 171      */
 172     @Override
 173     public void addComments(TypeMirror holderType, ExecutableElement method, Content methodDocTree) {
 174         TypeElement holder = utils.asTypeElement(holderType);
 175         if (!utils.getFullBody(method).isEmpty()) {
 176             if (holder.equals(typeElement) ||
 177                     !(utils.isPublic(holder) ||
 178                     utils.isLinkable(holder))) {
 179                 writer.addInlineComment(method, methodDocTree);
 180             } else {
 181                 Content link =
 182                         writer.getDocLink(LinkInfoImpl.Kind.EXECUTABLE_ELEMENT_COPY,
 183                         holder, method,
 184                         utils.isIncluded(holder)
 185                                 ? utils.getSimpleName(holder)
 186                                 : utils.getFullyQualifiedName(holder),
 187                             false);
 188                 Content codelLink = HtmlTree.CODE(link);
 189                 Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel,
 190                         utils.isClass(holder)
 191                                 ? contents.descfrmClassLabel
 192                                 : contents.descfrmInterfaceLabel);
 193                 descfrmLabel.add(Contents.SPACE);
 194                 descfrmLabel.add(codelLink);
 195                 methodDocTree.add(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
 196                 writer.addInlineComment(method, methodDocTree);
 197             }
 198         }
 199     }
 200 
 201     /**
 202      * {@inheritDoc}
 203      */
 204     @Override
 205     public void addTags(ExecutableElement method, Content methodDocTree) {
 206         writer.addTagsInfo(method, methodDocTree);
 207     }
 208 
 209     /**
 210      * {@inheritDoc}
 211      */
 212     @Override
 213     public Content getMethodDetails(Content methodDetailsTree) {
 214         return HtmlTree.SECTION(getMemberTree(methodDetailsTree));
 215     }
 216 
 217     /**
 218      * {@inheritDoc}
 219      */
 220     @Override
 221     public Content getMethodDoc(Content methodDocTree,
 222             boolean isLastContent) {
 223         return getMemberTree(methodDocTree, isLastContent);
 224     }
 225 
 226     /**
 227      * {@inheritDoc}
 228      */
 229     @Override
 230     public void addSummaryLabel(Content memberTree) {
 231         Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING,
 232                 contents.methodSummary);
 233         memberTree.add(label);
 234     }
 235 
 236     /**
 237      * {@inheritDoc}
 238      */
 239     @Override
 240     public TableHeader getSummaryTableHeader(Element member) {
 241         return new TableHeader(contents.modifierAndTypeLabel, contents.methodLabel,
 242                 contents.descriptionLabel);
 243     }
 244 
 245     @Override
 246     protected Table createSummaryTable() {
 247         return new Table(HtmlStyle.memberSummary)
 248                 .setHeader(getSummaryTableHeader(typeElement))
 249                 .setRowScopeColumn(1)
 250                 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colSecond, HtmlStyle.colLast)
 251                 .setDefaultTab(resources.getText("doclet.All_Methods"))
 252                 .addTab(resources.getText("doclet.Static_Methods"), utils::isStatic)
 253                 .addTab(resources.getText("doclet.Instance_Methods"), e -> !utils.isStatic(e))
 254                 .addTab(resources.getText("doclet.Abstract_Methods"), utils::isAbstract)
 255                 .addTab(resources.getText("doclet.Concrete_Methods"),
 256                         e -> !utils.isAbstract(e) && !utils.isInterface(e.getEnclosingElement()))
 257                 .addTab(resources.getText("doclet.Default_Methods"), utils::isDefault)
 258                 .addTab(resources.getText("doclet.Deprecated_Methods"),
 259                         e -> utils.isDeprecated(e) || utils.isDeprecated(typeElement))
 260                 .setTabScript(i -> "show(" + i + ");");
 261     }
 262 
 263     /**
 264      * {@inheritDoc}
 265      */
 266     @Override
 267     public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
 268         memberTree.add(links.createAnchor(SectionName.METHOD_SUMMARY));
 269     }
 270 
 271     /**
 272      * {@inheritDoc}
 273      */
 274     @Override
 275     public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
 276         inheritedTree.add(links.createAnchor(
 277                 SectionName.METHODS_INHERITANCE, configuration.getClassName(typeElement)));
 278     }
 279 
 280     /**
 281      * {@inheritDoc}
 282      */
 283     @Override
 284     public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
 285         Content classLink = writer.getPreQualifiedClassLink(
 286                 LinkInfoImpl.Kind.MEMBER, typeElement, false);
 287         Content label;
 288         if (configuration.summarizeOverriddenMethods) {
 289             label = new StringContent(utils.isClass(typeElement)
 290                     ? resources.getText("doclet.Methods_Declared_In_Class")
 291                     : resources.getText("doclet.Methods_Declared_In_Interface"));
 292         } else {
 293             label = new StringContent(utils.isClass(typeElement)
 294                     ? resources.getText("doclet.Methods_Inherited_From_Class")
 295                     : resources.getText("doclet.Methods_Inherited_From_Interface"));
 296         }
 297         Content labelHeading = HtmlTree.HEADING(Headings.TypeDeclaration.INHERITED_SUMMARY_HEADING,
 298                 label);
 299         labelHeading.add(Contents.SPACE);
 300         labelHeading.add(classLink);
 301         inheritedTree.add(labelHeading);
 302     }
 303 
 304     /**
 305      * {@inheritDoc}
 306      */
 307     @Override
 308     protected void addSummaryType(Element member, Content tdSummaryType) {
 309         ExecutableElement meth = (ExecutableElement)member;
 310         addModifierAndType(meth, utils.getReturnType(meth), tdSummaryType);
 311     }
 312 
 313     /**
 314      * {@inheritDoc}
 315      */
 316     protected static void addOverridden(HtmlDocletWriter writer,
 317             TypeMirror overriddenType, ExecutableElement method, Content dl) {
 318         if (writer.configuration.nocomment) {
 319             return;
 320         }
 321         Utils utils = writer.utils;
 322         Contents contents = writer.contents;
 323         TypeElement holder = utils.getEnclosingTypeElement(method);
 324         if (!(utils.isPublic(holder) ||
 325             utils.isLinkable(holder))) {
 326             //This is an implementation detail that should not be documented.
 327             return;
 328         }
 329         if (utils.isIncluded(holder) && ! utils.isIncluded(method)) {
 330             //The class is included but the method is not.  That means that it
 331             //is not visible so don't document this.
 332             return;
 333         }
 334         Content label = contents.overridesLabel;
 335         LinkInfoImpl.Kind context = LinkInfoImpl.Kind.METHOD_OVERRIDES;
 336 
 337         if (method != null) {
 338             if (utils.isAbstract(holder) && utils.isAbstract(method)){
 339                 //Abstract method is implemented from abstract class,
 340                 //not overridden
 341                 label = contents.specifiedByLabel;
 342                 context = LinkInfoImpl.Kind.METHOD_SPECIFIED_BY;
 343             }
 344             Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, label));
 345             dl.add(dt);
 346             Content overriddenTypeLink =
 347                     writer.getLink(new LinkInfoImpl(writer.configuration, context, overriddenType));
 348             Content codeOverridenTypeLink = HtmlTree.CODE(overriddenTypeLink);
 349             Content methlink = writer.getLink(
 350                     new LinkInfoImpl(writer.configuration, LinkInfoImpl.Kind.MEMBER,
 351                     holder)
 352                     .where(writer.links.getName(writer.getAnchor(method))).label(method.getSimpleName()));
 353             Content codeMethLink = HtmlTree.CODE(methlink);
 354             Content dd = HtmlTree.DD(codeMethLink);
 355             dd.add(Contents.SPACE);
 356             dd.add(writer.contents.inClass);
 357             dd.add(Contents.SPACE);
 358             dd.add(codeOverridenTypeLink);
 359             dl.add(dd);
 360         }
 361     }
 362 
 363     /**
 364      * {@inheritDoc}
 365      */
 366     protected static void addImplementsInfo(HtmlDocletWriter writer,
 367             ExecutableElement method, Content dl) {
 368         Utils utils = writer.utils;
 369         if (utils.isStatic(method) || writer.configuration.nocomment) {
 370             return;
 371         }
 372         Contents contents = writer.contents;
 373         VisibleMemberTable vmt = writer.configuration
 374                 .getVisibleMemberTable(utils.getEnclosingTypeElement(method));
 375         SortedSet<ExecutableElement> implementedMethods =
 376                 new TreeSet<>(utils.makeOverrideUseComparator());
 377         implementedMethods.addAll(vmt.getImplementedMethods(method));
 378         for (ExecutableElement implementedMeth : implementedMethods) {
 379             TypeMirror intfac = vmt.getImplementedMethodHolder(method, implementedMeth);
 380             intfac = utils.getDeclaredType(utils.getEnclosingTypeElement(method), intfac);
 381             Content intfaclink = writer.getLink(new LinkInfoImpl(
 382                     writer.configuration, LinkInfoImpl.Kind.METHOD_SPECIFIED_BY, intfac));
 383             Content codeIntfacLink = HtmlTree.CODE(intfaclink);
 384             Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, contents.specifiedByLabel));
 385             dl.add(dt);
 386             Content methlink = writer.getDocLink(
 387                     LinkInfoImpl.Kind.MEMBER, implementedMeth,
 388                     implementedMeth.getSimpleName(), false);
 389             Content codeMethLink = HtmlTree.CODE(methlink);
 390             Content dd = HtmlTree.DD(codeMethLink);
 391             dd.add(Contents.SPACE);
 392             dd.add(contents.inInterface);
 393             dd.add(Contents.SPACE);
 394             dd.add(codeIntfacLink);
 395             dl.add(dd);
 396         }
 397     }
 398 
 399     /**
 400      * Add the return type.
 401      *
 402      * @param method the method being documented.
 403      * @param htmltree the content tree to which the return type will be added
 404      */
 405     protected void addReturnType(ExecutableElement method, Content htmltree) {
 406         TypeMirror type = utils.getReturnType(method);
 407         if (type != null) {
 408             Content linkContent = writer.getLink(
 409                     new LinkInfoImpl(configuration, LinkInfoImpl.Kind.RETURN_TYPE, type));
 410             htmltree.add(linkContent);
 411             htmltree.add(Contents.SPACE);
 412         }
 413     }
 414 }