duke@1: /*
jjg@1521:  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.formats.html;
duke@1: 
bpatel@233: import java.io.*;
bpatel@233: 
bpatel@233: import com.sun.javadoc.*;
bpatel@766: import com.sun.tools.doclets.formats.html.markup.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: 
duke@1: /**
duke@1:  * Writes method documentation in HTML format.
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
jjg@1359:  *
duke@1:  * @author Robert Field
duke@1:  * @author Atul M Dambalkar
duke@1:  * @author Jamie Ho (rewrite)
bpatel@243:  * @author Bhavesh Patel (Modified)
duke@1:  */
duke@1: public class MethodWriterImpl extends AbstractExecutableMemberWriter
duke@1:         implements MethodWriter, MemberSummaryWriter {
duke@1: 
duke@1:     /**
duke@1:      * Construct a new MethodWriterImpl.
duke@1:      *
duke@1:      * @param writer the writer for the class that the methods belong to.
duke@1:      * @param classDoc the class being documented.
duke@1:      */
duke@1:     public MethodWriterImpl(SubWriterHolderWriter writer, ClassDoc classDoc) {
duke@1:         super(writer, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Construct a new MethodWriterImpl.
duke@1:      *
duke@1:      * @param writer The writer for the class that the methods belong to.
duke@1:      */
duke@1:     public MethodWriterImpl(SubWriterHolderWriter writer) {
duke@1:         super(writer);
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getMemberSummaryHeader(ClassDoc classDoc,
bpatel@766:             Content memberSummaryTree) {
bpatel@766:         memberSummaryTree.addContent(HtmlConstants.START_OF_METHOD_SUMMARY);
bpatel@766:         Content memberTree = writer.getMemberTreeHeader();
bpatel@766:         writer.addSummaryHeader(this, classDoc, memberTree);
bpatel@766:         return memberTree;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getMethodDetailsTreeHeader(ClassDoc classDoc,
bpatel@766:             Content memberDetailsTree) {
bpatel@766:         memberDetailsTree.addContent(HtmlConstants.START_OF_METHOD_DETAILS);
bpatel@766:         Content methodDetailsTree = writer.getMemberTreeHeader();
bpatel@2101:         methodDetailsTree.addContent(writer.getMarkerAnchor(
bpatel@2101:                 SectionName.METHOD_DETAIL));
bpatel@766:         Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
bpatel@766:                 writer.methodDetailsLabel);
bpatel@766:         methodDetailsTree.addContent(heading);
bpatel@766:         return methodDetailsTree;
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getMethodDocTreeHeader(MethodDoc method,
bpatel@766:             Content methodDetailsTree) {
bpatel@766:         String erasureAnchor;
bpatel@766:         if ((erasureAnchor = getErasureAnchor(method)) != null) {
bpatel@766:             methodDetailsTree.addContent(writer.getMarkerAnchor((erasureAnchor)));
bpatel@766:         }
bpatel@766:         methodDetailsTree.addContent(
bpatel@766:                 writer.getMarkerAnchor(writer.getAnchor(method)));
bpatel@766:         Content methodDocTree = writer.getMemberTreeHeader();
bpatel@766:         Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
bpatel@766:         heading.addContent(method.name());
bpatel@766:         methodDocTree.addContent(heading);
bpatel@766:         return methodDocTree;
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * Get the signature for the given method.
duke@1:      *
bpatel@766:      * @param method the method being documented.
bpatel@766:      * @return a content object for the signature
duke@1:      */
bpatel@766:     public Content getSignature(MethodDoc method) {
bpatel@766:         Content pre = new HtmlTree(HtmlTag.PRE);
bpatel@766:         writer.addAnnotationInfo(method, pre);
bpatel@766:         addModifiers(method, pre);
bpatel@766:         addTypeParameters(method, pre);
bpatel@766:         addReturnType(method, pre);
jjg@1410:         if (configuration.linksource) {
bpatel@766:             Content methodName = new StringContent(method.name());
bpatel@766:             writer.addSrcLink(method, methodName, pre);
bpatel@766:         } else {
bpatel@766:             addName(method.name(), pre);
bpatel@766:         }
jjg@1741:         int indent = pre.charCount();
jjg@1741:         addParameters(method, pre, indent);
jjg@1741:         addExceptions(method, pre, indent);
bpatel@766:         return pre;
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public void addDeprecated(MethodDoc method, Content methodDocTree) {
bpatel@766:         addDeprecatedInfo(method, methodDocTree);
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public void addComments(Type holder, MethodDoc method, Content methodDocTree) {
duke@1:         ClassDoc holderClassDoc = holder.asClassDoc();
duke@1:         if (method.inlineTags().length > 0) {
duke@1:             if (holder.asClassDoc().equals(classdoc) ||
bpatel@766:                     (! (holderClassDoc.isPublic() ||
jjg@1410:                     Util.isLinkable(holderClassDoc, configuration)))) {
bpatel@766:                 writer.addInlineComment(method, methodDocTree);
duke@1:             } else {
jjg@1736:                 Content link =
jjg@1735:                         writer.getDocLink(LinkInfoImpl.Kind.METHOD_DOC_COPY,
duke@1:                         holder.asClassDoc(), method,
duke@1:                         holder.asClassDoc().isIncluded() ?
duke@1:                             holder.typeName() : holder.qualifiedTypeName(),
jjg@1736:                             false);
bpatel@766:                 Content codelLink = HtmlTree.CODE(link);
bpatel@2147:                 Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel, holder.asClassDoc().isClass()?
bpatel@766:                     writer.descfrmClassLabel : writer.descfrmInterfaceLabel);
bpatel@2147:                 descfrmLabel.addContent(writer.getSpace());
bpatel@2147:                 descfrmLabel.addContent(codelLink);
bpatel@2147:                 methodDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
bpatel@766:                 writer.addInlineComment(method, methodDocTree);
duke@1:             }
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public void addTags(MethodDoc method, Content methodDocTree) {
bpatel@766:         writer.addTagsInfo(method, methodDocTree);
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getMethodDetails(Content methodDetailsTree) {
bpatel@766:         return getMemberTree(methodDetailsTree);
duke@1:     }
duke@1: 
duke@1:     /**
bpatel@766:      * {@inheritDoc}
duke@1:      */
bpatel@766:     public Content getMethodDoc(Content methodDocTree,
bpatel@766:             boolean isLastContent) {
bpatel@766:         return getMemberTree(methodDocTree, isLastContent);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Close the writer.
duke@1:      */
duke@1:     public void close() throws IOException {
duke@1:         writer.close();
duke@1:     }
duke@1: 
duke@1:     public int getMemberKind() {
duke@1:         return VisibleMemberMap.METHODS;
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public void addSummaryLabel(Content memberTree) {
bpatel@766:         Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
bpatel@766:                 writer.getResource("doclet.Method_Summary"));
bpatel@766:         memberTree.addContent(label);
bpatel@243:     }
bpatel@243: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public String getTableSummary() {
jjg@1410:         return configuration.getText("doclet.Member_Table_Summary",
jjg@1410:                 configuration.getText("doclet.Method_Summary"),
jjg@1410:                 configuration.getText("doclet.methods"));
bpatel@243:     }
bpatel@243: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
jjg@1747:     public Content getCaption() {
jjg@1747:         return configuration.getResource("doclet.Methods");
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public String[] getSummaryTableHeader(ProgramElementDoc member) {
bpatel@243:         String[] header = new String[] {
bpatel@243:             writer.getModifierTypeHeader(),
jjg@1410:             configuration.getText("doclet.0_and_1",
jjg@1410:                     configuration.getText("doclet.Method"),
jjg@1410:                     configuration.getText("doclet.Description"))
bpatel@243:         };
bpatel@766:         return header;
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
bpatel@2101:         memberTree.addContent(writer.getMarkerAnchor(
bpatel@2101:                 SectionName.METHOD_SUMMARY));
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
bpatel@766:         inheritedTree.addContent(writer.getMarkerAnchor(
bpatel@2101:                 SectionName.METHODS_INHERITANCE, configuration.getClassName(cd)));
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
jjg@1737:         Content classLink = writer.getPreQualifiedClassLink(
jjg@1737:                 LinkInfoImpl.Kind.MEMBER, cd, false);
bpatel@766:         Content label = new StringContent(cd.isClass() ?
jjg@1410:             configuration.getText("doclet.Methods_Inherited_From_Class") :
jjg@1410:             configuration.getText("doclet.Methods_Inherited_From_Interface"));
bpatel@766:         Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
bpatel@766:                 label);
bpatel@766:         labelHeading.addContent(writer.getSpace());
bpatel@766:         labelHeading.addContent(classLink);
bpatel@766:         inheritedTree.addContent(labelHeading);
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) {
duke@1:         MethodDoc meth = (MethodDoc)member;
bpatel@766:         addModifierAndType(meth, meth.returnType(), tdSummaryType);
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected static void addOverridden(HtmlDocletWriter writer,
bpatel@766:             Type overriddenType, MethodDoc method, Content dl) {
jjg@1410:         if (writer.configuration.nocomment) {
duke@1:             return;
duke@1:         }
duke@1:         ClassDoc holderClassDoc = overriddenType.asClassDoc();
duke@1:         if (! (holderClassDoc.isPublic() ||
jjg@1410:             Util.isLinkable(holderClassDoc, writer.configuration))) {
duke@1:             //This is an implementation detail that should not be documented.
duke@1:             return;
duke@1:         }
duke@1:         if (overriddenType.asClassDoc().isIncluded() && ! method.isIncluded()) {
duke@1:             //The class is included but the method is not.  That means that it
duke@1:             //is not visible so don't document this.
duke@1:             return;
duke@1:         }
bpatel@766:         Content label = writer.overridesLabel;
jjg@1735:         LinkInfoImpl.Kind context = LinkInfoImpl.Kind.METHOD_OVERRIDES;
duke@1: 
duke@1:         if (method != null) {
jjg@1410:             if (overriddenType.asClassDoc().isAbstract() && method.isAbstract()){
duke@1:                 //Abstract method is implemented from abstract class,
duke@1:                 //not overridden
bpatel@766:                 label = writer.specifiedByLabel;
jjg@1735:                 context = LinkInfoImpl.Kind.METHOD_SPECIFIED_BY;
duke@1:             }
bpatel@2147:             Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, label));
bpatel@766:             dl.addContent(dt);
jjg@1736:             Content overriddenTypeLink =
jjg@1736:                     writer.getLink(new LinkInfoImpl(writer.configuration, context, overriddenType));
bpatel@766:             Content codeOverridenTypeLink = HtmlTree.CODE(overriddenTypeLink);
duke@1:             String name = method.name();
jjg@1736:             Content methlink = writer.getLink(
jjg@1735:                     new LinkInfoImpl(writer.configuration, LinkInfoImpl.Kind.MEMBER,
jjg@1738:                     overriddenType.asClassDoc())
bpatel@2101:                     .where(writer.getName(writer.getAnchor(method))).label(name));
bpatel@766:             Content codeMethLink = HtmlTree.CODE(methlink);
bpatel@766:             Content dd = HtmlTree.DD(codeMethLink);
bpatel@766:             dd.addContent(writer.getSpace());
bpatel@766:             dd.addContent(writer.getResource("doclet.in_class"));
bpatel@766:             dd.addContent(writer.getSpace());
bpatel@766:             dd.addContent(codeOverridenTypeLink);
bpatel@766:             dl.addContent(dd);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Parse the &lt;Code&gt; tag and return the text.
duke@1:      */
duke@1:     protected String parseCodeTag(String tag){
duke@1:         if(tag == null){
duke@1:             return "";
duke@1:         }
duke@1: 
duke@1:         String lc = tag.toLowerCase();
duke@1:         int begin = lc.indexOf("<code>");
duke@1:         int end = lc.indexOf("</code>");
duke@1:         if(begin == -1 || end == -1 || end <= begin){
duke@1:             return tag;
duke@1:         } else {
duke@1:             return tag.substring(begin + 6, end);
duke@1:         }
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected static void addImplementsInfo(HtmlDocletWriter writer,
bpatel@766:             MethodDoc method, Content dl) {
duke@1:         if(writer.configuration.nocomment){
duke@1:             return;
duke@1:         }
duke@1:         ImplementedMethods implementedMethodsFinder =
bpatel@766:                 new ImplementedMethods(method, writer.configuration);
duke@1:         MethodDoc[] implementedMethods = implementedMethodsFinder.build();
duke@1:         for (int i = 0; i < implementedMethods.length; i++) {
duke@1:             MethodDoc implementedMeth = implementedMethods[i];
duke@1:             Type intfac = implementedMethodsFinder.getMethodHolder(implementedMeth);
jjg@1736:             Content intfaclink = writer.getLink(new LinkInfoImpl(
jjg@1736:                     writer.configuration, LinkInfoImpl.Kind.METHOD_SPECIFIED_BY, intfac));
bpatel@766:             Content codeIntfacLink = HtmlTree.CODE(intfaclink);
bpatel@2147:             Content dt = HtmlTree.DT(HtmlTree.SPAN(HtmlStyle.overrideSpecifyLabel, writer.specifiedByLabel));
bpatel@766:             dl.addContent(dt);
jjg@1736:             Content methlink = writer.getDocLink(
jjg@1735:                     LinkInfoImpl.Kind.MEMBER, implementedMeth,
jjg@1736:                     implementedMeth.name(), false);
bpatel@766:             Content codeMethLink = HtmlTree.CODE(methlink);
bpatel@766:             Content dd = HtmlTree.DD(codeMethLink);
bpatel@766:             dd.addContent(writer.getSpace());
bpatel@766:             dd.addContent(writer.getResource("doclet.in_interface"));
bpatel@766:             dd.addContent(writer.getSpace());
bpatel@766:             dd.addContent(codeIntfacLink);
bpatel@766:             dl.addContent(dd);
duke@1:         }
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * Add the return type.
bpatel@766:      *
bpatel@766:      * @param method the method being documented.
bpatel@766:      * @param htmltree the content tree to which the return type will be added
bpatel@766:      */
bpatel@766:     protected void addReturnType(MethodDoc method, Content htmltree) {
bpatel@766:         Type type = method.returnType();
bpatel@766:         if (type != null) {
jjg@1736:             Content linkContent = writer.getLink(
jjg@1736:                     new LinkInfoImpl(configuration, LinkInfoImpl.Kind.RETURN_TYPE, type));
bpatel@766:             htmltree.addContent(linkContent);
bpatel@766:             htmltree.addContent(writer.getSpace());
duke@1:         }
duke@1:     }
duke@1: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
duke@1:         if (link) {
bpatel@2101:             if (cd == null) {
bpatel@2101:                 return writer.getHyperLink(
bpatel@2101:                         SectionName.METHOD_SUMMARY,
bpatel@2101:                         writer.getResource("doclet.navMethod"));
bpatel@2101:             } else {
bpatel@2101:                 return writer.getHyperLink(
bpatel@2101:                         SectionName.METHODS_INHERITANCE,
bpatel@2101:                         configuration.getClassName(cd), writer.getResource("doclet.navMethod"));
bpatel@2101:             }
duke@1:         } else {
bpatel@766:             return writer.getResource("doclet.navMethod");
bpatel@766:         }
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     protected void addNavDetailLink(boolean link, Content liNav) {
bpatel@766:         if (link) {
bpatel@2101:             liNav.addContent(writer.getHyperLink(
bpatel@2101:                     SectionName.METHOD_DETAIL, writer.getResource("doclet.navMethod")));
bpatel@766:         } else {
bpatel@766:             liNav.addContent(writer.getResource("doclet.navMethod"));
duke@1:         }
duke@1:     }
duke@1: }