duke@1: /*
duke@1:  * Copyright 1997-2005 Sun Microsystems, Inc.  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
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun 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:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.formats.html;
duke@1: 
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: /**
duke@1:  * Print method and constructor info.
duke@1:  *
duke@1:  * @author Robert Field
duke@1:  * @author Atul M Dambalkar
duke@1:  */
duke@1: public abstract class AbstractExecutableMemberWriter extends AbstractMemberWriter {
duke@1: 
duke@1:     public AbstractExecutableMemberWriter(SubWriterHolderWriter writer,
duke@1:                                      ClassDoc classdoc) {
duke@1:         super(writer, classdoc);
duke@1:     }
duke@1: 
duke@1:     public AbstractExecutableMemberWriter(SubWriterHolderWriter writer) {
duke@1:         super(writer);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the type parameters for the executable member.
duke@1:      *
duke@1:      * @param member the member to write type parameters for.
duke@1:      * @return the display length required to write this information.
duke@1:      */
duke@1:     protected int writeTypeParameters(ExecutableMemberDoc member) {
duke@1:         LinkInfoImpl linkInfo = new LinkInfoImpl(
duke@1:             LinkInfoImpl.CONTEXT_MEMBER_TYPE_PARAMS, member, false);
duke@1:         String typeParameters = writer.getTypeParameterLinks(linkInfo);
duke@1:         if (linkInfo.displayLength > 0) {
duke@1:             writer.print(typeParameters + " ");
duke@1:             writer.displayLength += linkInfo.displayLength + 1;
duke@1:         }
duke@1:         return linkInfo.displayLength;
duke@1:     }
duke@1: 
duke@1:     protected void writeSignature(ExecutableMemberDoc member) {
duke@1:         writer.displayLength = 0;
duke@1:         writer.pre();
duke@1:         writer.writeAnnotationInfo(member);
duke@1:         printModifiers(member);
duke@1:         writeTypeParameters(member);
duke@1:         if (configuration().linksource &&
duke@1:             member.position().line() != classdoc.position().line()) {
duke@1:             writer.printSrcLink(member, member.name());
duke@1:         } else {
duke@1:             bold(member.name());
duke@1:         }
duke@1:         writeParameters(member);
duke@1:         writeExceptions(member);
duke@1:         writer.preEnd();
duke@1:     }
duke@1: 
duke@1:     protected void writeDeprecatedLink(ProgramElementDoc member) {
duke@1:         ExecutableMemberDoc emd = (ExecutableMemberDoc)member;
duke@1:         writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER, (MemberDoc) emd,
duke@1:             emd.qualifiedName() + emd.flatSignature(), false);
duke@1:     }
duke@1: 
duke@1:     protected void writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member) {
duke@1:         ExecutableMemberDoc emd = (ExecutableMemberDoc)member;
duke@1:         String name = emd.name();
duke@1:         writer.bold();
duke@1:         writer.printDocLink(context, cd, (MemberDoc) emd,
duke@1:             name, false);
duke@1:         writer.boldEnd();
duke@1:         writer.displayLength = name.length();
duke@1:         writeParameters(emd, false);
duke@1:     }
duke@1: 
duke@1:     protected void writeInheritedSummaryLink(ClassDoc cd,
duke@1:             ProgramElementDoc member) {
duke@1:         writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER, cd, (MemberDoc) member,
duke@1:             member.name(), false);
duke@1:     }
duke@1: 
duke@1:     protected void writeParam(ExecutableMemberDoc member, Parameter param,
duke@1:         boolean isVarArg) {
duke@1:         if (param.type() != null) {
duke@1:             writer.printLink(new LinkInfoImpl(
duke@1:                 LinkInfoImpl.CONTEXT_EXECUTABLE_MEMBER_PARAM, param.type(),
duke@1:                 isVarArg));
duke@1:         }
duke@1:         if(param.name().length() > 0) {
duke@1:             writer.space();
duke@1:             writer.print(param.name());
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     protected void writeParameters(ExecutableMemberDoc member) {
duke@1:         writeParameters(member, true);
duke@1:     }
duke@1: 
duke@1:     protected void writeParameters(ExecutableMemberDoc member,
duke@1:             boolean includeAnnotations) {
duke@1:         print('(');
duke@1:         Parameter[] params = member.parameters();
duke@1:         String indent = makeSpace(writer.displayLength);
duke@1:         if (configuration().linksource) {
duke@1:             //add spaces to offset indentation changes caused by link.
duke@1:             indent+= makeSpace(member.name().length());
duke@1:         }
duke@1:         int paramstart;
duke@1:         for (paramstart = 0; paramstart < params.length; paramstart++) {
duke@1:             Parameter param = params[paramstart];
duke@1:             if (!param.name().startsWith("this$")) {
duke@1:                 if (includeAnnotations) {
duke@1:                         boolean foundAnnotations =
duke@1:                                 writer.writeAnnotationInfo(indent.length(), member, param);
duke@1:                         if (foundAnnotations) {
duke@1:                                 writer.println();
duke@1:                                 writer.print(indent);
duke@1:                     }
duke@1:                 }
duke@1:                 writeParam(member, param,
duke@1:                     (paramstart == params.length - 1) && member.isVarArgs());
duke@1:                 break;
duke@1:             }
duke@1:         }
duke@1: 
duke@1:         for (int i = paramstart + 1; i < params.length; i++) {
duke@1:             writer.print(',');
duke@1:             writer.println();
duke@1:             writer.print(indent);
duke@1:             if (includeAnnotations) {
duke@1:                 boolean foundAnnotations =
duke@1:                     writer.writeAnnotationInfo(indent.length(), member, params[i]);
duke@1:                 if (foundAnnotations) {
duke@1:                     writer.println();
duke@1:                     writer.print(indent);
duke@1:                 }
duke@1:             }
duke@1:             writeParam(member, params[i], (i == params.length - 1) && member.isVarArgs());
duke@1:         }
duke@1:         writer.print(')');
duke@1:     }
duke@1: 
duke@1:     protected void writeExceptions(ExecutableMemberDoc member) {
duke@1:         Type[] exceptions = member.thrownExceptionTypes();
duke@1:         if(exceptions.length > 0) {
duke@1:             LinkInfoImpl memberTypeParam = new LinkInfoImpl(
duke@1:                 LinkInfoImpl.CONTEXT_MEMBER, member, false);
duke@1:             int retlen = getReturnTypeLength(member);
duke@1:             writer.getTypeParameterLinks(memberTypeParam);
duke@1:             retlen += memberTypeParam.displayLength == 0 ?
duke@1:                 0 : memberTypeParam.displayLength + 1;
duke@1:             String indent = makeSpace(modifierString(member).length() +
duke@1:                 member.name().length() + retlen - 4);
duke@1:             writer.println();
duke@1:             writer.print(indent);
duke@1:             writer.print("throws ");
duke@1:             indent += "       ";
duke@1:             writer.printLink(new LinkInfoImpl(
duke@1:                 LinkInfoImpl.CONTEXT_MEMBER, exceptions[0]));
duke@1:             for(int i = 1; i < exceptions.length; i++) {
duke@1:                 writer.println(",");
duke@1:                 writer.print(indent);
duke@1:                 writer.printLink(new LinkInfoImpl(
duke@1:                     LinkInfoImpl.CONTEXT_MEMBER, exceptions[i]));
duke@1:             }
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     protected int getReturnTypeLength(ExecutableMemberDoc member) {
duke@1:         if (member instanceof MethodDoc) {
duke@1:             MethodDoc method = (MethodDoc)member;
duke@1:             Type rettype = method.returnType();
duke@1:             if (rettype.isPrimitive()) {
duke@1:                 return rettype.typeName().length() +
duke@1:                        rettype.dimension().length();
duke@1:             } else {
duke@1:                 LinkInfoImpl linkInfo = new LinkInfoImpl(
duke@1:                     LinkInfoImpl.CONTEXT_MEMBER, rettype);
duke@1:                 writer.getLink(linkInfo);
duke@1:                 return linkInfo.displayLength;
duke@1:             }
duke@1:         } else {   // it's a constructordoc
duke@1:             return -1;
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     protected ClassDoc implementsMethodInIntfac(MethodDoc method,
duke@1:                                                 ClassDoc[] intfacs) {
duke@1:         for (int i = 0; i < intfacs.length; i++) {
duke@1:             MethodDoc[] methods = intfacs[i].methods();
duke@1:             if (methods.length > 0) {
duke@1:                 for (int j = 0; j < methods.length; j++) {
duke@1:                     if (methods[j].name().equals(method.name()) &&
duke@1:                           methods[j].signature().equals(method.signature())) {
duke@1:                         return intfacs[i];
duke@1:                     }
duke@1:                 }
duke@1:             }
duke@1:         }
duke@1:         return null;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * For backward compatibility, include an anchor using the erasures of the
duke@1:      * parameters.  NOTE:  We won't need this method anymore after we fix
duke@1:      * see tags so that they use the type instead of the erasure.
duke@1:      *
duke@1:      * @param emd the ExecutableMemberDoc to anchor to.
duke@1:      * @return the 1.4.x style anchor for the ExecutableMemberDoc.
duke@1:      */
duke@1:     protected String getErasureAnchor(ExecutableMemberDoc emd) {
duke@1:         StringBuffer buf = new StringBuffer(emd.name() + "(");
duke@1:         Parameter[] params = emd.parameters();
duke@1:         boolean foundTypeVariable = false;
duke@1:         for (int i = 0; i < params.length; i++) {
duke@1:             if (i > 0) {
duke@1:                 buf.append(",");
duke@1:             }
duke@1:             Type t = params[i].type();
duke@1:             foundTypeVariable = foundTypeVariable || t.asTypeVariable() != null;
duke@1:             buf.append(t.isPrimitive() ?
duke@1:                 t.typeName() : t.asClassDoc().qualifiedName());
duke@1:             buf.append(t.dimension());
duke@1:         }
duke@1:         buf.append(")");
duke@1:         return foundTypeVariable ? buf.toString() : null;
duke@1:     }
duke@1: }