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