Fri, 31 Aug 2012 10:37:46 +0100
7151010: Add compiler support for repeating annotations
Reviewed-by: jjg, mcimadamore
duke@1 | 1 | /* |
jjg@910 | 2 | * Copyright (c) 1997, 2011, 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.javadoc; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.javadoc.*; |
duke@1 | 29 | |
duke@1 | 30 | import com.sun.tools.javac.code.Symbol; |
duke@1 | 31 | import com.sun.tools.javac.code.Symbol.ClassSymbol; |
duke@1 | 32 | import com.sun.tools.javac.code.Type; |
duke@1 | 33 | import com.sun.tools.javac.code.Type.ClassType; |
duke@1 | 34 | import com.sun.tools.javac.code.Type.TypeVar; |
duke@1 | 35 | import com.sun.tools.javac.code.Type.ArrayType; |
duke@1 | 36 | import com.sun.tools.javac.util.List; |
duke@1 | 37 | |
duke@1 | 38 | import static com.sun.tools.javac.code.TypeTags.*; |
duke@1 | 39 | |
duke@1 | 40 | |
duke@1 | 41 | public class TypeMaker { |
duke@1 | 42 | |
duke@1 | 43 | public static com.sun.javadoc.Type getType(DocEnv env, Type t) { |
duke@1 | 44 | return getType(env, t, true); |
duke@1 | 45 | } |
duke@1 | 46 | |
duke@1 | 47 | /** |
duke@1 | 48 | * @param errToClassDoc if true, ERROR type results in a ClassDoc; |
duke@1 | 49 | * false preserves legacy behavior |
duke@1 | 50 | */ |
jjg@198 | 51 | @SuppressWarnings("fallthrough") |
duke@1 | 52 | public static com.sun.javadoc.Type getType(DocEnv env, Type t, |
duke@1 | 53 | boolean errToClassDoc) { |
duke@1 | 54 | if (env.legacyDoclet) { |
duke@1 | 55 | t = env.types.erasure(t); |
duke@1 | 56 | } |
duke@1 | 57 | switch (t.tag) { |
duke@1 | 58 | case CLASS: |
duke@1 | 59 | if (ClassDocImpl.isGeneric((ClassSymbol)t.tsym)) { |
duke@1 | 60 | return env.getParameterizedType((ClassType)t); |
duke@1 | 61 | } else { |
duke@1 | 62 | return env.getClassDoc((ClassSymbol)t.tsym); |
duke@1 | 63 | } |
duke@1 | 64 | case WILDCARD: |
duke@1 | 65 | Type.WildcardType a = (Type.WildcardType)t; |
duke@1 | 66 | return new WildcardTypeImpl(env, a); |
duke@1 | 67 | case TYPEVAR: return new TypeVariableImpl(env, (TypeVar)t); |
duke@1 | 68 | case ARRAY: return new ArrayTypeImpl(env, t); |
duke@1 | 69 | case BYTE: return PrimitiveType.byteType; |
duke@1 | 70 | case CHAR: return PrimitiveType.charType; |
duke@1 | 71 | case SHORT: return PrimitiveType.shortType; |
duke@1 | 72 | case INT: return PrimitiveType.intType; |
duke@1 | 73 | case LONG: return PrimitiveType.longType; |
duke@1 | 74 | case FLOAT: return PrimitiveType.floatType; |
duke@1 | 75 | case DOUBLE: return PrimitiveType.doubleType; |
duke@1 | 76 | case BOOLEAN: return PrimitiveType.booleanType; |
duke@1 | 77 | case VOID: return PrimitiveType.voidType; |
duke@1 | 78 | case ERROR: |
duke@1 | 79 | if (errToClassDoc) |
duke@1 | 80 | return env.getClassDoc((ClassSymbol)t.tsym); |
duke@1 | 81 | // FALLTHRU |
duke@1 | 82 | default: |
duke@1 | 83 | return new PrimitiveType(t.tsym.getQualifiedName().toString()); |
duke@1 | 84 | } |
duke@1 | 85 | } |
duke@1 | 86 | |
duke@1 | 87 | /** |
duke@1 | 88 | * Convert a list of javac types into an array of javadoc types. |
duke@1 | 89 | */ |
duke@1 | 90 | public static com.sun.javadoc.Type[] getTypes(DocEnv env, List<Type> ts) { |
duke@1 | 91 | return getTypes(env, ts, new com.sun.javadoc.Type[ts.length()]); |
duke@1 | 92 | } |
duke@1 | 93 | |
duke@1 | 94 | /** |
duke@1 | 95 | * Like the above version, but use and return the array given. |
duke@1 | 96 | */ |
duke@1 | 97 | public static com.sun.javadoc.Type[] getTypes(DocEnv env, List<Type> ts, |
duke@1 | 98 | com.sun.javadoc.Type res[]) { |
duke@1 | 99 | int i = 0; |
duke@1 | 100 | for (Type t : ts) { |
duke@1 | 101 | res[i++] = getType(env, t); |
duke@1 | 102 | } |
duke@1 | 103 | return res; |
duke@1 | 104 | } |
duke@1 | 105 | |
duke@1 | 106 | public static String getTypeName(Type t, boolean full) { |
duke@1 | 107 | switch (t.tag) { |
duke@1 | 108 | case ARRAY: |
jjg@910 | 109 | StringBuilder s = new StringBuilder(); |
duke@1 | 110 | while (t.tag == ARRAY) { |
jjg@910 | 111 | s.append("[]"); |
duke@1 | 112 | t = ((ArrayType)t).elemtype; |
duke@1 | 113 | } |
jjg@910 | 114 | s.insert(0, getTypeName(t, full)); |
jjg@910 | 115 | return s.toString(); |
duke@1 | 116 | case CLASS: |
duke@1 | 117 | return ClassDocImpl.getClassName((ClassSymbol)t.tsym, full); |
duke@1 | 118 | default: |
duke@1 | 119 | return t.tsym.getQualifiedName().toString(); |
duke@1 | 120 | } |
duke@1 | 121 | } |
duke@1 | 122 | |
duke@1 | 123 | /** |
duke@1 | 124 | * Return the string representation of a type use. Bounds of type |
duke@1 | 125 | * variables are not included; bounds of wildcard types are. |
duke@1 | 126 | * Class names are qualified if "full" is true. |
duke@1 | 127 | */ |
duke@1 | 128 | static String getTypeString(DocEnv env, Type t, boolean full) { |
duke@1 | 129 | switch (t.tag) { |
duke@1 | 130 | case ARRAY: |
jjg@910 | 131 | StringBuilder s = new StringBuilder(); |
duke@1 | 132 | while (t.tag == ARRAY) { |
jjg@910 | 133 | s.append("[]"); |
duke@1 | 134 | t = env.types.elemtype(t); |
duke@1 | 135 | } |
jjg@910 | 136 | s.insert(0, getTypeString(env, t, full)); |
jjg@910 | 137 | return s.toString(); |
duke@1 | 138 | case CLASS: |
duke@1 | 139 | return ParameterizedTypeImpl. |
duke@1 | 140 | parameterizedTypeToString(env, (ClassType)t, full); |
duke@1 | 141 | case WILDCARD: |
duke@1 | 142 | Type.WildcardType a = (Type.WildcardType)t; |
duke@1 | 143 | return WildcardTypeImpl.wildcardTypeToString(env, a, full); |
duke@1 | 144 | default: |
duke@1 | 145 | return t.tsym.getQualifiedName().toString(); |
duke@1 | 146 | } |
duke@1 | 147 | } |
duke@1 | 148 | |
duke@1 | 149 | /** |
duke@1 | 150 | * Return the formal type parameters of a class or method as an |
duke@1 | 151 | * angle-bracketed string. Each parameter is a type variable with |
duke@1 | 152 | * optional bounds. Class names are qualified if "full" is true. |
duke@1 | 153 | * Return "" if there are no type parameters or we're hiding generics. |
duke@1 | 154 | */ |
duke@1 | 155 | static String typeParametersString(DocEnv env, Symbol sym, boolean full) { |
duke@1 | 156 | if (env.legacyDoclet || sym.type.getTypeArguments().isEmpty()) { |
duke@1 | 157 | return ""; |
duke@1 | 158 | } |
jjg@910 | 159 | StringBuilder s = new StringBuilder(); |
duke@1 | 160 | for (Type t : sym.type.getTypeArguments()) { |
duke@1 | 161 | s.append(s.length() == 0 ? "<" : ", "); |
duke@1 | 162 | s.append(TypeVariableImpl.typeVarToString(env, (TypeVar)t, full)); |
duke@1 | 163 | } |
duke@1 | 164 | s.append(">"); |
duke@1 | 165 | return s.toString(); |
duke@1 | 166 | } |
duke@1 | 167 | |
duke@1 | 168 | /** |
duke@1 | 169 | * Return the actual type arguments of a parameterized type as an |
duke@1 | 170 | * angle-bracketed string. Class name are qualified if "full" is true. |
duke@1 | 171 | * Return "" if there are no type arguments or we're hiding generics. |
duke@1 | 172 | */ |
duke@1 | 173 | static String typeArgumentsString(DocEnv env, ClassType cl, boolean full) { |
duke@1 | 174 | if (env.legacyDoclet || cl.getTypeArguments().isEmpty()) { |
duke@1 | 175 | return ""; |
duke@1 | 176 | } |
jjg@910 | 177 | StringBuilder s = new StringBuilder(); |
duke@1 | 178 | for (Type t : cl.getTypeArguments()) { |
duke@1 | 179 | s.append(s.length() == 0 ? "<" : ", "); |
duke@1 | 180 | s.append(getTypeString(env, t, full)); |
duke@1 | 181 | } |
duke@1 | 182 | s.append(">"); |
duke@1 | 183 | return s.toString(); |
duke@1 | 184 | } |
duke@1 | 185 | |
duke@1 | 186 | |
duke@1 | 187 | private static class ArrayTypeImpl implements com.sun.javadoc.Type { |
duke@1 | 188 | |
duke@1 | 189 | Type arrayType; |
duke@1 | 190 | |
duke@1 | 191 | DocEnv env; |
duke@1 | 192 | |
duke@1 | 193 | ArrayTypeImpl(DocEnv env, Type arrayType) { |
duke@1 | 194 | this.env = env; |
duke@1 | 195 | this.arrayType = arrayType; |
duke@1 | 196 | } |
duke@1 | 197 | |
duke@1 | 198 | private com.sun.javadoc.Type skipArraysCache = null; |
duke@1 | 199 | |
duke@1 | 200 | private com.sun.javadoc.Type skipArrays() { |
duke@1 | 201 | if (skipArraysCache == null) { |
duke@1 | 202 | Type t; |
duke@1 | 203 | for (t = arrayType; t.tag == ARRAY; t = env.types.elemtype(t)) { } |
duke@1 | 204 | skipArraysCache = TypeMaker.getType(env, t); |
duke@1 | 205 | } |
duke@1 | 206 | return skipArraysCache; |
duke@1 | 207 | } |
duke@1 | 208 | |
duke@1 | 209 | /** |
duke@1 | 210 | * Return the type's dimension information, as a string. |
duke@1 | 211 | * <p> |
duke@1 | 212 | * For example, a two dimensional array of String returns '[][]'. |
duke@1 | 213 | */ |
duke@1 | 214 | public String dimension() { |
jjg@910 | 215 | StringBuilder dimension = new StringBuilder(); |
duke@1 | 216 | for (Type t = arrayType; t.tag == ARRAY; t = env.types.elemtype(t)) { |
jjg@910 | 217 | dimension.append("[]"); |
duke@1 | 218 | } |
duke@1 | 219 | return dimension.toString(); |
duke@1 | 220 | } |
duke@1 | 221 | |
duke@1 | 222 | /** |
duke@1 | 223 | * Return unqualified name of type excluding any dimension information. |
duke@1 | 224 | * <p> |
duke@1 | 225 | * For example, a two dimensional array of String returns 'String'. |
duke@1 | 226 | */ |
duke@1 | 227 | public String typeName() { |
duke@1 | 228 | return skipArrays().typeName(); |
duke@1 | 229 | } |
duke@1 | 230 | |
duke@1 | 231 | /** |
duke@1 | 232 | * Return qualified name of type excluding any dimension information. |
duke@1 | 233 | *<p> |
duke@1 | 234 | * For example, a two dimensional array of String |
duke@1 | 235 | * returns 'java.lang.String'. |
duke@1 | 236 | */ |
duke@1 | 237 | public String qualifiedTypeName() { |
duke@1 | 238 | return skipArrays().qualifiedTypeName(); |
duke@1 | 239 | } |
duke@1 | 240 | |
duke@1 | 241 | /** |
duke@1 | 242 | * Return the simple name of this type excluding any dimension information. |
duke@1 | 243 | */ |
duke@1 | 244 | public String simpleTypeName() { |
duke@1 | 245 | return skipArrays().simpleTypeName(); |
duke@1 | 246 | } |
duke@1 | 247 | |
duke@1 | 248 | /** |
duke@1 | 249 | * Return this type as a class. Array dimensions are ignored. |
duke@1 | 250 | * |
duke@1 | 251 | * @return a ClassDocImpl if the type is a Class. |
duke@1 | 252 | * Return null if it is a primitive type.. |
duke@1 | 253 | */ |
duke@1 | 254 | public ClassDoc asClassDoc() { |
duke@1 | 255 | return skipArrays().asClassDoc(); |
duke@1 | 256 | } |
duke@1 | 257 | |
duke@1 | 258 | /** |
duke@1 | 259 | * Return this type as a <code>ParameterizedType</code> if it |
duke@1 | 260 | * represents a parameterized type. Array dimensions are ignored. |
duke@1 | 261 | */ |
duke@1 | 262 | public ParameterizedType asParameterizedType() { |
duke@1 | 263 | return skipArrays().asParameterizedType(); |
duke@1 | 264 | } |
duke@1 | 265 | |
duke@1 | 266 | /** |
duke@1 | 267 | * Return this type as a <code>TypeVariable</code> if it represents |
duke@1 | 268 | * a type variable. Array dimensions are ignored. |
duke@1 | 269 | */ |
duke@1 | 270 | public TypeVariable asTypeVariable() { |
duke@1 | 271 | return skipArrays().asTypeVariable(); |
duke@1 | 272 | } |
duke@1 | 273 | |
duke@1 | 274 | /** |
duke@1 | 275 | * Return null, as there are no arrays of wildcard types. |
duke@1 | 276 | */ |
duke@1 | 277 | public WildcardType asWildcardType() { |
duke@1 | 278 | return null; |
duke@1 | 279 | } |
duke@1 | 280 | |
duke@1 | 281 | /** |
duke@1 | 282 | * Return this type as an <code>AnnotationTypeDoc</code> if it |
duke@1 | 283 | * represents an annotation type. Array dimensions are ignored. |
duke@1 | 284 | */ |
duke@1 | 285 | public AnnotationTypeDoc asAnnotationTypeDoc() { |
duke@1 | 286 | return skipArrays().asAnnotationTypeDoc(); |
duke@1 | 287 | } |
duke@1 | 288 | |
duke@1 | 289 | /** |
duke@1 | 290 | * Return true if this is an array of a primitive type. |
duke@1 | 291 | */ |
duke@1 | 292 | public boolean isPrimitive() { |
duke@1 | 293 | return skipArrays().isPrimitive(); |
duke@1 | 294 | } |
duke@1 | 295 | |
duke@1 | 296 | /** |
duke@1 | 297 | * Return a string representation of the type. |
duke@1 | 298 | * |
duke@1 | 299 | * Return name of type including any dimension information. |
duke@1 | 300 | * <p> |
duke@1 | 301 | * For example, a two dimensional array of String returns |
duke@1 | 302 | * <code>String[][]</code>. |
duke@1 | 303 | * |
duke@1 | 304 | * @return name of type including any dimension information. |
duke@1 | 305 | */ |
jjg@910 | 306 | @Override |
duke@1 | 307 | public String toString() { |
duke@1 | 308 | return qualifiedTypeName() + dimension(); |
duke@1 | 309 | } |
duke@1 | 310 | } |
duke@1 | 311 | } |