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