Printer.java revision 3111:dd06d18cd7dd
1/* 2 * Copyright (c) 2009, 2013, 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 26package com.sun.tools.javac.code; 27 28import java.util.Locale; 29 30import com.sun.tools.javac.api.Messages; 31import com.sun.tools.javac.code.Type.ArrayType; 32import com.sun.tools.javac.code.Symbol.*; 33import com.sun.tools.javac.code.Type.*; 34import com.sun.tools.javac.util.List; 35import com.sun.tools.javac.util.ListBuffer; 36 37import static com.sun.tools.javac.code.BoundKind.*; 38import static com.sun.tools.javac.code.Flags.*; 39import static com.sun.tools.javac.code.Kinds.Kind.*; 40import static com.sun.tools.javac.code.TypeTag.CLASS; 41import static com.sun.tools.javac.code.TypeTag.FORALL; 42 43/** 44 * A combined type/symbol visitor for generating non-trivial localized string 45 * representation of types and symbols. 46 * 47 * <p><b>This is NOT part of any supported API. 48 * If you write code that depends on this, you do so at your own risk. 49 * This code and its internal interfaces are subject to change or 50 * deletion without notice.</b> 51 */ 52public abstract class Printer implements Type.Visitor<String, Locale>, Symbol.Visitor<String, Locale> { 53 54 List<Type> seenCaptured = List.nil(); 55 static final int PRIME = 997; // largest prime less than 1000 56 57 protected Printer() { } 58 59 /** 60 * This method should be overriden in order to provide proper i18n support. 61 * 62 * @param locale the locale in which the string is to be rendered 63 * @param key the key corresponding to the message to be displayed 64 * @param args a list of optional arguments 65 * @return localized string representation 66 */ 67 protected abstract String localize(Locale locale, String key, Object... args); 68 69 /** 70 * Maps a captured type into an unique identifier. 71 * 72 * @param t the captured type for which an id is to be retrieved 73 * @param locale locale settings 74 * @return unique id representing this captured type 75 */ 76 protected abstract String capturedVarId(CapturedType t, Locale locale); 77 78 /** 79 * Create a printer with default i18n support provided by Messages. By default, 80 * captured types ids are generated using hashcode. 81 * 82 * @param messages Messages class to be used for i18n 83 * @return printer visitor instance 84 */ 85 public static Printer createStandardPrinter(final Messages messages) { 86 return new Printer() { 87 @Override 88 protected String localize(Locale locale, String key, Object... args) { 89 return messages.getLocalizedString(locale, key, args); 90 } 91 92 @Override 93 protected String capturedVarId(CapturedType t, Locale locale) { 94 return (t.hashCode() & 0xFFFFFFFFL) % PRIME + ""; 95 }}; 96 } 97 98 /** 99 * Get a localized string representation for all the types in the input list. 100 * 101 * @param ts types to be displayed 102 * @param locale the locale in which the string is to be rendered 103 * @return localized string representation 104 */ 105 public String visitTypes(List<Type> ts, Locale locale) { 106 ListBuffer<String> sbuf = new ListBuffer<>(); 107 for (Type t : ts) { 108 sbuf.append(visit(t, locale)); 109 } 110 return sbuf.toList().toString(); 111 } 112 113 /** 114 * * Get a localized string representation for all the symbols in the input list. 115 * 116 * @param ts symbols to be displayed 117 * @param locale the locale in which the string is to be rendered 118 * @return localized string representation 119 */ 120 public String visitSymbols(List<Symbol> ts, Locale locale) { 121 ListBuffer<String> sbuf = new ListBuffer<>(); 122 for (Symbol t : ts) { 123 sbuf.append(visit(t, locale)); 124 } 125 return sbuf.toList().toString(); 126 } 127 128 /** 129 * Get a localized string representation for a given type. 130 * 131 * @param t type to be displayed 132 * @param locale the locale in which the string is to be rendered 133 * @return localized string representation 134 */ 135 public String visit(Type t, Locale locale) { 136 return t.accept(this, locale); 137 } 138 139 /** 140 * Get a localized string representation for a given symbol. 141 * 142 * @param s symbol to be displayed 143 * @param locale the locale in which the string is to be rendered 144 * @return localized string representation 145 */ 146 public String visit(Symbol s, Locale locale) { 147 return s.accept(this, locale); 148 } 149 150 @Override 151 public String visitCapturedType(CapturedType t, Locale locale) { 152 if (seenCaptured.contains(t)) 153 return printAnnotations(t) + 154 localize(locale, "compiler.misc.type.captureof.1", 155 capturedVarId(t, locale)); 156 else { 157 try { 158 seenCaptured = seenCaptured.prepend(t); 159 return printAnnotations(t) + 160 localize(locale, "compiler.misc.type.captureof", 161 capturedVarId(t, locale), 162 visit(t.wildcard, locale)); 163 } 164 finally { 165 seenCaptured = seenCaptured.tail; 166 } 167 } 168 } 169 170 @Override 171 public String visitForAll(ForAll t, Locale locale) { 172 return printAnnotations(t) + "<" + visitTypes(t.tvars, locale) + 173 ">" + visit(t.qtype, locale); 174 } 175 176 @Override 177 public String visitUndetVar(UndetVar t, Locale locale) { 178 if (t.getInst() != null) { 179 return printAnnotations(t) + visit(t.getInst(), locale); 180 } else { 181 return printAnnotations(t) + visit(t.qtype, locale) + "?"; 182 } 183 } 184 185 @Override 186 public String visitArrayType(ArrayType t, Locale locale) { 187 StringBuilder res = new StringBuilder(); 188 printBaseElementType(t, res, locale); 189 printBrackets(t, res, locale); 190 return res.toString(); 191 } 192 193 private String printAnnotations(Type t) { 194 return printAnnotations(t, false); 195 } 196 197 private String printAnnotations(Type t, boolean prefix) { 198 StringBuilder sb = new StringBuilder(); 199 List<Attribute.TypeCompound> annos = t.getAnnotationMirrors(); 200 if (!annos.isEmpty()) { 201 if (prefix) sb.append(' '); 202 sb.append(annos); 203 sb.append(' '); 204 } 205 return sb.toString(); 206 } 207 208 private void printBaseElementType(Type t, StringBuilder sb, Locale locale) { 209 Type arrel = t; 210 while (arrel.hasTag(TypeTag.ARRAY)) { 211 arrel = ((ArrayType) arrel).elemtype; 212 } 213 sb.append(visit(arrel, locale)); 214 } 215 216 private void printBrackets(Type t, StringBuilder sb, Locale locale) { 217 Type arrel = t; 218 while (arrel.hasTag(TypeTag.ARRAY)) { 219 sb.append(printAnnotations(arrel, true)); 220 sb.append("[]"); 221 arrel = ((ArrayType) arrel).elemtype; 222 } 223 } 224 225 @Override 226 public String visitClassType(ClassType t, Locale locale) { 227 StringBuilder buf = new StringBuilder(); 228 if (t.getEnclosingType().hasTag(CLASS) && t.tsym.owner.kind == TYP) { 229 buf.append(visit(t.getEnclosingType(), locale)); 230 buf.append('.'); 231 buf.append(printAnnotations(t)); 232 buf.append(className(t, false, locale)); 233 } else { 234 buf.append(printAnnotations(t)); 235 buf.append(className(t, true, locale)); 236 } 237 if (t.getTypeArguments().nonEmpty()) { 238 buf.append('<'); 239 buf.append(visitTypes(t.getTypeArguments(), locale)); 240 buf.append('>'); 241 } 242 return buf.toString(); 243 } 244 245 @Override 246 public String visitMethodType(MethodType t, Locale locale) { 247 return "(" + printMethodArgs(t.argtypes, false, locale) + ")" + 248 visit(t.restype, locale); 249 } 250 251 @Override 252 public String visitPackageType(PackageType t, Locale locale) { 253 return t.tsym.getQualifiedName().toString(); 254 } 255 256 @Override 257 public String visitWildcardType(WildcardType t, Locale locale) { 258 StringBuilder s = new StringBuilder(); 259 s.append(t.kind); 260 if (t.kind != UNBOUND) { 261 s.append(printAnnotations(t)); 262 s.append(visit(t.type, locale)); 263 } 264 return s.toString(); 265 } 266 267 @Override 268 public String visitErrorType(ErrorType t, Locale locale) { 269 return visitType(t, locale); 270 } 271 272 @Override 273 public String visitTypeVar(TypeVar t, Locale locale) { 274 return visitType(t, locale); 275 } 276 277 public String visitType(Type t, Locale locale) { 278 String s = (t.tsym == null || t.tsym.name == null) 279 ? localize(locale, "compiler.misc.type.none") 280 : t.tsym.name.toString(); 281 return s; 282 } 283 284 /** 285 * Converts a class name into a (possibly localized) string. Anonymous 286 * inner classes get converted into a localized string. 287 * 288 * @param t the type of the class whose name is to be rendered 289 * @param longform if set, the class' fullname is displayed - if unset the 290 * short name is chosen (w/o package) 291 * @param locale the locale in which the string is to be rendered 292 * @return localized string representation 293 */ 294 protected String className(ClassType t, boolean longform, Locale locale) { 295 Symbol sym = t.tsym; 296 if (sym.name.length() == 0 && (sym.flags() & COMPOUND) != 0) { 297 StringBuilder s = new StringBuilder(visit(t.supertype_field, locale)); 298 for (List<Type> is = t.interfaces_field; is.nonEmpty(); is = is.tail) { 299 s.append('&'); 300 s.append(visit(is.head, locale)); 301 } 302 return s.toString(); 303 } else if (sym.name.length() == 0) { 304 String s; 305 ClassType norm = (ClassType) t.tsym.type; 306 if (norm == null) { 307 s = localize(locale, "compiler.misc.anonymous.class", (Object) null); 308 } else if (norm.interfaces_field != null && norm.interfaces_field.nonEmpty()) { 309 s = localize(locale, "compiler.misc.anonymous.class", 310 visit(norm.interfaces_field.head, locale)); 311 } else { 312 s = localize(locale, "compiler.misc.anonymous.class", 313 visit(norm.supertype_field, locale)); 314 } 315 return s; 316 } else if (longform) { 317 return sym.getQualifiedName().toString(); 318 } else { 319 return sym.name.toString(); 320 } 321 } 322 323 /** 324 * Converts a set of method argument types into their corresponding 325 * localized string representation. 326 * 327 * @param args arguments to be rendered 328 * @param varArgs if true, the last method argument is regarded as a vararg 329 * @param locale the locale in which the string is to be rendered 330 * @return localized string representation 331 */ 332 protected String printMethodArgs(List<Type> args, boolean varArgs, Locale locale) { 333 if (!varArgs) { 334 return visitTypes(args, locale); 335 } else { 336 StringBuilder buf = new StringBuilder(); 337 while (args.tail.nonEmpty()) { 338 buf.append(visit(args.head, locale)); 339 args = args.tail; 340 buf.append(','); 341 } 342 if (args.head.hasTag(TypeTag.ARRAY)) { 343 buf.append(visit(((ArrayType) args.head).elemtype, locale)); 344 if (args.head.getAnnotationMirrors().nonEmpty()) { 345 buf.append(' '); 346 buf.append(args.head.getAnnotationMirrors()); 347 buf.append(' '); 348 } 349 buf.append("..."); 350 } else { 351 buf.append(visit(args.head, locale)); 352 } 353 return buf.toString(); 354 } 355 } 356 357 @Override 358 public String visitClassSymbol(ClassSymbol sym, Locale locale) { 359 return sym.name.isEmpty() 360 ? localize(locale, "compiler.misc.anonymous.class", sym.flatname) 361 : sym.fullname.toString(); 362 } 363 364 @Override 365 public String visitMethodSymbol(MethodSymbol s, Locale locale) { 366 if (s.isStaticOrInstanceInit()) { 367 return s.owner.name.toString(); 368 } else { 369 String ms = (s.name == s.name.table.names.init) 370 ? s.owner.name.toString() 371 : s.name.toString(); 372 if (s.type != null) { 373 if (s.type.hasTag(FORALL)) { 374 ms = "<" + visitTypes(s.type.getTypeArguments(), locale) + ">" + ms; 375 } 376 ms += "(" + printMethodArgs( 377 s.type.getParameterTypes(), 378 (s.flags() & VARARGS) != 0, 379 locale) + ")"; 380 } 381 return ms; 382 } 383 } 384 385 @Override 386 public String visitOperatorSymbol(OperatorSymbol s, Locale locale) { 387 return visitMethodSymbol(s, locale); 388 } 389 390 @Override 391 public String visitPackageSymbol(PackageSymbol s, Locale locale) { 392 return s.isUnnamed() 393 ? localize(locale, "compiler.misc.unnamed.package") 394 : s.fullname.toString(); 395 } 396 397 @Override 398 public String visitTypeSymbol(TypeSymbol s, Locale locale) { 399 return visitSymbol(s, locale); 400 } 401 402 @Override 403 public String visitVarSymbol(VarSymbol s, Locale locale) { 404 return visitSymbol(s, locale); 405 } 406 407 @Override 408 public String visitSymbol(Symbol s, Locale locale) { 409 return s.name.toString(); 410 } 411} 412