Thu, 10 Jun 2010 17:09:56 -0700
6960407: Potential rebranding issues in openjdk/langtools repository sources
Reviewed-by: darcy
duke@1 | 1 | /* |
ohair@554 | 2 | * Copyright (c) 1997, 2005, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.formats.html; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.javadoc.*; |
duke@1 | 29 | |
duke@1 | 30 | /** |
duke@1 | 31 | * Print method and constructor info. |
duke@1 | 32 | * |
duke@1 | 33 | * @author Robert Field |
duke@1 | 34 | * @author Atul M Dambalkar |
duke@1 | 35 | */ |
duke@1 | 36 | public abstract class AbstractExecutableMemberWriter extends AbstractMemberWriter { |
duke@1 | 37 | |
duke@1 | 38 | public AbstractExecutableMemberWriter(SubWriterHolderWriter writer, |
duke@1 | 39 | ClassDoc classdoc) { |
duke@1 | 40 | super(writer, classdoc); |
duke@1 | 41 | } |
duke@1 | 42 | |
duke@1 | 43 | public AbstractExecutableMemberWriter(SubWriterHolderWriter writer) { |
duke@1 | 44 | super(writer); |
duke@1 | 45 | } |
duke@1 | 46 | |
duke@1 | 47 | /** |
duke@1 | 48 | * Write the type parameters for the executable member. |
duke@1 | 49 | * |
duke@1 | 50 | * @param member the member to write type parameters for. |
duke@1 | 51 | * @return the display length required to write this information. |
duke@1 | 52 | */ |
duke@1 | 53 | protected int writeTypeParameters(ExecutableMemberDoc member) { |
duke@1 | 54 | LinkInfoImpl linkInfo = new LinkInfoImpl( |
duke@1 | 55 | LinkInfoImpl.CONTEXT_MEMBER_TYPE_PARAMS, member, false); |
duke@1 | 56 | String typeParameters = writer.getTypeParameterLinks(linkInfo); |
duke@1 | 57 | if (linkInfo.displayLength > 0) { |
duke@1 | 58 | writer.print(typeParameters + " "); |
duke@1 | 59 | writer.displayLength += linkInfo.displayLength + 1; |
duke@1 | 60 | } |
duke@1 | 61 | return linkInfo.displayLength; |
duke@1 | 62 | } |
duke@1 | 63 | |
duke@1 | 64 | protected void writeSignature(ExecutableMemberDoc member) { |
duke@1 | 65 | writer.displayLength = 0; |
duke@1 | 66 | writer.pre(); |
duke@1 | 67 | writer.writeAnnotationInfo(member); |
duke@1 | 68 | printModifiers(member); |
duke@1 | 69 | writeTypeParameters(member); |
duke@1 | 70 | if (configuration().linksource && |
duke@1 | 71 | member.position().line() != classdoc.position().line()) { |
duke@1 | 72 | writer.printSrcLink(member, member.name()); |
duke@1 | 73 | } else { |
bpatel@182 | 74 | strong(member.name()); |
duke@1 | 75 | } |
duke@1 | 76 | writeParameters(member); |
duke@1 | 77 | writeExceptions(member); |
duke@1 | 78 | writer.preEnd(); |
duke@1 | 79 | } |
duke@1 | 80 | |
duke@1 | 81 | protected void writeDeprecatedLink(ProgramElementDoc member) { |
duke@1 | 82 | ExecutableMemberDoc emd = (ExecutableMemberDoc)member; |
duke@1 | 83 | writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER, (MemberDoc) emd, |
duke@1 | 84 | emd.qualifiedName() + emd.flatSignature(), false); |
duke@1 | 85 | } |
duke@1 | 86 | |
duke@1 | 87 | protected void writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member) { |
duke@1 | 88 | ExecutableMemberDoc emd = (ExecutableMemberDoc)member; |
duke@1 | 89 | String name = emd.name(); |
bpatel@182 | 90 | writer.strong(); |
duke@1 | 91 | writer.printDocLink(context, cd, (MemberDoc) emd, |
duke@1 | 92 | name, false); |
bpatel@182 | 93 | writer.strongEnd(); |
duke@1 | 94 | writer.displayLength = name.length(); |
duke@1 | 95 | writeParameters(emd, false); |
duke@1 | 96 | } |
duke@1 | 97 | |
duke@1 | 98 | protected void writeInheritedSummaryLink(ClassDoc cd, |
duke@1 | 99 | ProgramElementDoc member) { |
duke@1 | 100 | writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER, cd, (MemberDoc) member, |
duke@1 | 101 | member.name(), false); |
duke@1 | 102 | } |
duke@1 | 103 | |
duke@1 | 104 | protected void writeParam(ExecutableMemberDoc member, Parameter param, |
duke@1 | 105 | boolean isVarArg) { |
duke@1 | 106 | if (param.type() != null) { |
duke@1 | 107 | writer.printLink(new LinkInfoImpl( |
duke@1 | 108 | LinkInfoImpl.CONTEXT_EXECUTABLE_MEMBER_PARAM, param.type(), |
duke@1 | 109 | isVarArg)); |
duke@1 | 110 | } |
duke@1 | 111 | if(param.name().length() > 0) { |
duke@1 | 112 | writer.space(); |
duke@1 | 113 | writer.print(param.name()); |
duke@1 | 114 | } |
duke@1 | 115 | } |
duke@1 | 116 | |
duke@1 | 117 | protected void writeParameters(ExecutableMemberDoc member) { |
duke@1 | 118 | writeParameters(member, true); |
duke@1 | 119 | } |
duke@1 | 120 | |
duke@1 | 121 | protected void writeParameters(ExecutableMemberDoc member, |
duke@1 | 122 | boolean includeAnnotations) { |
duke@1 | 123 | print('('); |
duke@1 | 124 | Parameter[] params = member.parameters(); |
duke@1 | 125 | String indent = makeSpace(writer.displayLength); |
duke@1 | 126 | if (configuration().linksource) { |
duke@1 | 127 | //add spaces to offset indentation changes caused by link. |
duke@1 | 128 | indent+= makeSpace(member.name().length()); |
duke@1 | 129 | } |
duke@1 | 130 | int paramstart; |
duke@1 | 131 | for (paramstart = 0; paramstart < params.length; paramstart++) { |
duke@1 | 132 | Parameter param = params[paramstart]; |
duke@1 | 133 | if (!param.name().startsWith("this$")) { |
duke@1 | 134 | if (includeAnnotations) { |
duke@1 | 135 | boolean foundAnnotations = |
duke@1 | 136 | writer.writeAnnotationInfo(indent.length(), member, param); |
duke@1 | 137 | if (foundAnnotations) { |
duke@1 | 138 | writer.println(); |
duke@1 | 139 | writer.print(indent); |
duke@1 | 140 | } |
duke@1 | 141 | } |
duke@1 | 142 | writeParam(member, param, |
duke@1 | 143 | (paramstart == params.length - 1) && member.isVarArgs()); |
duke@1 | 144 | break; |
duke@1 | 145 | } |
duke@1 | 146 | } |
duke@1 | 147 | |
duke@1 | 148 | for (int i = paramstart + 1; i < params.length; i++) { |
duke@1 | 149 | writer.print(','); |
duke@1 | 150 | writer.println(); |
duke@1 | 151 | writer.print(indent); |
duke@1 | 152 | if (includeAnnotations) { |
duke@1 | 153 | boolean foundAnnotations = |
duke@1 | 154 | writer.writeAnnotationInfo(indent.length(), member, params[i]); |
duke@1 | 155 | if (foundAnnotations) { |
duke@1 | 156 | writer.println(); |
duke@1 | 157 | writer.print(indent); |
duke@1 | 158 | } |
duke@1 | 159 | } |
duke@1 | 160 | writeParam(member, params[i], (i == params.length - 1) && member.isVarArgs()); |
duke@1 | 161 | } |
duke@1 | 162 | writer.print(')'); |
duke@1 | 163 | } |
duke@1 | 164 | |
duke@1 | 165 | protected void writeExceptions(ExecutableMemberDoc member) { |
duke@1 | 166 | Type[] exceptions = member.thrownExceptionTypes(); |
duke@1 | 167 | if(exceptions.length > 0) { |
duke@1 | 168 | LinkInfoImpl memberTypeParam = new LinkInfoImpl( |
duke@1 | 169 | LinkInfoImpl.CONTEXT_MEMBER, member, false); |
duke@1 | 170 | int retlen = getReturnTypeLength(member); |
duke@1 | 171 | writer.getTypeParameterLinks(memberTypeParam); |
duke@1 | 172 | retlen += memberTypeParam.displayLength == 0 ? |
duke@1 | 173 | 0 : memberTypeParam.displayLength + 1; |
duke@1 | 174 | String indent = makeSpace(modifierString(member).length() + |
duke@1 | 175 | member.name().length() + retlen - 4); |
duke@1 | 176 | writer.println(); |
duke@1 | 177 | writer.print(indent); |
duke@1 | 178 | writer.print("throws "); |
duke@1 | 179 | indent += " "; |
duke@1 | 180 | writer.printLink(new LinkInfoImpl( |
duke@1 | 181 | LinkInfoImpl.CONTEXT_MEMBER, exceptions[0])); |
duke@1 | 182 | for(int i = 1; i < exceptions.length; i++) { |
duke@1 | 183 | writer.println(","); |
duke@1 | 184 | writer.print(indent); |
duke@1 | 185 | writer.printLink(new LinkInfoImpl( |
duke@1 | 186 | LinkInfoImpl.CONTEXT_MEMBER, exceptions[i])); |
duke@1 | 187 | } |
duke@1 | 188 | } |
duke@1 | 189 | } |
duke@1 | 190 | |
duke@1 | 191 | protected int getReturnTypeLength(ExecutableMemberDoc member) { |
duke@1 | 192 | if (member instanceof MethodDoc) { |
duke@1 | 193 | MethodDoc method = (MethodDoc)member; |
duke@1 | 194 | Type rettype = method.returnType(); |
duke@1 | 195 | if (rettype.isPrimitive()) { |
duke@1 | 196 | return rettype.typeName().length() + |
duke@1 | 197 | rettype.dimension().length(); |
duke@1 | 198 | } else { |
duke@1 | 199 | LinkInfoImpl linkInfo = new LinkInfoImpl( |
duke@1 | 200 | LinkInfoImpl.CONTEXT_MEMBER, rettype); |
duke@1 | 201 | writer.getLink(linkInfo); |
duke@1 | 202 | return linkInfo.displayLength; |
duke@1 | 203 | } |
duke@1 | 204 | } else { // it's a constructordoc |
duke@1 | 205 | return -1; |
duke@1 | 206 | } |
duke@1 | 207 | } |
duke@1 | 208 | |
duke@1 | 209 | protected ClassDoc implementsMethodInIntfac(MethodDoc method, |
duke@1 | 210 | ClassDoc[] intfacs) { |
duke@1 | 211 | for (int i = 0; i < intfacs.length; i++) { |
duke@1 | 212 | MethodDoc[] methods = intfacs[i].methods(); |
duke@1 | 213 | if (methods.length > 0) { |
duke@1 | 214 | for (int j = 0; j < methods.length; j++) { |
duke@1 | 215 | if (methods[j].name().equals(method.name()) && |
duke@1 | 216 | methods[j].signature().equals(method.signature())) { |
duke@1 | 217 | return intfacs[i]; |
duke@1 | 218 | } |
duke@1 | 219 | } |
duke@1 | 220 | } |
duke@1 | 221 | } |
duke@1 | 222 | return null; |
duke@1 | 223 | } |
duke@1 | 224 | |
duke@1 | 225 | /** |
duke@1 | 226 | * For backward compatibility, include an anchor using the erasures of the |
duke@1 | 227 | * parameters. NOTE: We won't need this method anymore after we fix |
duke@1 | 228 | * see tags so that they use the type instead of the erasure. |
duke@1 | 229 | * |
duke@1 | 230 | * @param emd the ExecutableMemberDoc to anchor to. |
duke@1 | 231 | * @return the 1.4.x style anchor for the ExecutableMemberDoc. |
duke@1 | 232 | */ |
duke@1 | 233 | protected String getErasureAnchor(ExecutableMemberDoc emd) { |
duke@1 | 234 | StringBuffer buf = new StringBuffer(emd.name() + "("); |
duke@1 | 235 | Parameter[] params = emd.parameters(); |
duke@1 | 236 | boolean foundTypeVariable = false; |
duke@1 | 237 | for (int i = 0; i < params.length; i++) { |
duke@1 | 238 | if (i > 0) { |
duke@1 | 239 | buf.append(","); |
duke@1 | 240 | } |
duke@1 | 241 | Type t = params[i].type(); |
duke@1 | 242 | foundTypeVariable = foundTypeVariable || t.asTypeVariable() != null; |
duke@1 | 243 | buf.append(t.isPrimitive() ? |
duke@1 | 244 | t.typeName() : t.asClassDoc().qualifiedName()); |
duke@1 | 245 | buf.append(t.dimension()); |
duke@1 | 246 | } |
duke@1 | 247 | buf.append(")"); |
duke@1 | 248 | return foundTypeVariable ? buf.toString() : null; |
duke@1 | 249 | } |
duke@1 | 250 | } |