src/share/classes/com/sun/tools/javac/processing/PrintingProcessor.java

Sun, 17 Feb 2013 16:44:55 -0500

author
dholmes
date
Sun, 17 Feb 2013 16:44:55 -0500
changeset 1571
af8417e590f4
parent 1054
111bbf1ad913
child 2413
fe033d997ddf
permissions
-rw-r--r--

Merge

duke@1 1 /*
darcy@1042 2 * Copyright (c) 2005, 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.javac.processing;
duke@1 27
duke@1 28 import javax.annotation.processing.*;
duke@1 29 import javax.lang.model.*;
duke@1 30 import javax.lang.model.element.*;
duke@1 31 import static javax.lang.model.element.ElementKind.*;
duke@1 32 import static javax.lang.model.element.NestingKind.*;
duke@1 33 import javax.lang.model.type.*;
duke@1 34 import javax.lang.model.util.*;
duke@1 35
duke@1 36 import java.io.PrintWriter;
duke@1 37 import java.io.Writer;
duke@1 38 import java.util.*;
duke@1 39
duke@1 40 /**
duke@1 41 * A processor which prints out elements. Used to implement the
duke@1 42 * -Xprint option; the included visitor class is used to implement
duke@1 43 * Elements.printElements.
duke@1 44 *
jjg@581 45 * <p><b>This is NOT part of any supported API.
duke@1 46 * If you write code that depends on this, you do so at your own risk.
duke@1 47 * This code and its internal interfaces are subject to change or
duke@1 48 * deletion without notice.</b>
duke@1 49 */
duke@1 50 @SupportedAnnotationTypes("*")
darcy@1042 51 @SupportedSourceVersion(SourceVersion.RELEASE_8)
duke@1 52 public class PrintingProcessor extends AbstractProcessor {
duke@1 53 PrintWriter writer;
duke@1 54
duke@1 55 public PrintingProcessor() {
duke@1 56 super();
duke@1 57 writer = new PrintWriter(System.out);
duke@1 58 }
duke@1 59
duke@1 60 public void setWriter(Writer w) {
duke@1 61 writer = new PrintWriter(w);
duke@1 62 }
duke@1 63
duke@1 64 @Override
duke@1 65 public boolean process(Set<? extends TypeElement> tes,
duke@1 66 RoundEnvironment renv) {
duke@1 67
duke@1 68 for(Element element : renv.getRootElements()) {
duke@1 69 print(element);
duke@1 70 }
duke@1 71
duke@1 72 // Just print the elements, nothing more to do.
duke@1 73 return true;
duke@1 74 }
duke@1 75
duke@1 76 void print(Element element) {
duke@1 77 new PrintingElementVisitor(writer, processingEnv.getElementUtils()).
duke@1 78 visit(element).flush();
duke@1 79 }
duke@1 80
duke@1 81 /**
duke@1 82 * Used for the -Xprint option and called by Elements.printElements
duke@1 83 */
duke@1 84 public static class PrintingElementVisitor
darcy@1054 85 extends SimpleElementVisitor8<PrintingElementVisitor, Boolean> {
duke@1 86 int indentation; // Indentation level;
duke@1 87 final PrintWriter writer;
duke@1 88 final Elements elementUtils;
duke@1 89
duke@1 90 public PrintingElementVisitor(Writer w, Elements elementUtils) {
duke@1 91 super();
duke@1 92 this.writer = new PrintWriter(w);
duke@1 93 this.elementUtils = elementUtils;
duke@1 94 indentation = 0;
duke@1 95 }
duke@1 96
duke@1 97 @Override
duke@1 98 protected PrintingElementVisitor defaultAction(Element e, Boolean newLine) {
duke@1 99 if (newLine != null && newLine)
duke@1 100 writer.println();
duke@1 101 printDocComment(e);
duke@1 102 printModifiers(e);
duke@1 103 return this;
duke@1 104 }
duke@1 105
duke@1 106 @Override
duke@1 107 public PrintingElementVisitor visitExecutable(ExecutableElement e, Boolean p) {
duke@1 108 ElementKind kind = e.getKind();
duke@1 109
duke@1 110 if (kind != STATIC_INIT &&
duke@1 111 kind != INSTANCE_INIT) {
duke@1 112 Element enclosing = e.getEnclosingElement();
duke@1 113
duke@1 114 // Don't print out the constructor of an anonymous class
duke@1 115 if (kind == CONSTRUCTOR &&
duke@1 116 enclosing != null &&
duke@1 117 NestingKind.ANONYMOUS ==
duke@1 118 // Use an anonymous class to determine anonymity!
darcy@575 119 (new SimpleElementVisitor7<NestingKind, Void>() {
duke@1 120 @Override
duke@1 121 public NestingKind visitType(TypeElement e, Void p) {
duke@1 122 return e.getNestingKind();
duke@1 123 }
duke@1 124 }).visit(enclosing))
duke@1 125 return this;
duke@1 126
duke@1 127 defaultAction(e, true);
darcy@224 128 printFormalTypeParameters(e, true);
duke@1 129
duke@1 130 switch(kind) {
duke@1 131 case CONSTRUCTOR:
duke@1 132 // Print out simple name of the class
duke@1 133 writer.print(e.getEnclosingElement().getSimpleName());
duke@1 134 break;
duke@1 135
duke@1 136 case METHOD:
duke@1 137 writer.print(e.getReturnType().toString());
duke@1 138 writer.print(" ");
duke@1 139 writer.print(e.getSimpleName().toString());
duke@1 140 break;
duke@1 141 }
duke@1 142
duke@1 143 writer.print("(");
duke@1 144 printParameters(e);
duke@1 145 writer.print(")");
duke@1 146 AnnotationValue defaultValue = e.getDefaultValue();
duke@1 147 if (defaultValue != null)
duke@1 148 writer.print(" default " + defaultValue);
duke@1 149
duke@1 150 printThrows(e);
duke@1 151 writer.println(";");
duke@1 152 }
duke@1 153 return this;
duke@1 154 }
duke@1 155
duke@1 156
duke@1 157 @Override
duke@1 158 public PrintingElementVisitor visitType(TypeElement e, Boolean p) {
duke@1 159 ElementKind kind = e.getKind();
duke@1 160 NestingKind nestingKind = e.getNestingKind();
duke@1 161
duke@1 162 if (NestingKind.ANONYMOUS == nestingKind) {
duke@1 163 // Print out an anonymous class in the style of a
duke@1 164 // class instance creation expression rather than a
duke@1 165 // class declaration.
duke@1 166 writer.print("new ");
duke@1 167
duke@1 168 // If the anonymous class implements an interface
duke@1 169 // print that name, otherwise print the superclass.
duke@1 170 List<? extends TypeMirror> interfaces = e.getInterfaces();
duke@1 171 if (!interfaces.isEmpty())
duke@1 172 writer.print(interfaces.get(0));
duke@1 173 else
duke@1 174 writer.print(e.getSuperclass());
duke@1 175
duke@1 176 writer.print("(");
duke@1 177 // Anonymous classes that implement an interface can't
duke@1 178 // have any constructor arguments.
duke@1 179 if (interfaces.isEmpty()) {
duke@1 180 // Print out the parameter list from the sole
duke@1 181 // constructor. For now, don't try to elide any
duke@1 182 // synthetic parameters by determining if the
duke@1 183 // anonymous class is in a static context, etc.
duke@1 184 List<? extends ExecutableElement> constructors =
duke@1 185 ElementFilter.constructorsIn(e.getEnclosedElements());
duke@1 186
duke@1 187 if (!constructors.isEmpty())
duke@1 188 printParameters(constructors.get(0));
duke@1 189 }
duke@1 190 writer.print(")");
duke@1 191 } else {
duke@1 192 if (nestingKind == TOP_LEVEL) {
duke@1 193 PackageElement pkg = elementUtils.getPackageOf(e);
duke@1 194 if (!pkg.isUnnamed())
duke@1 195 writer.print("package " + pkg.getQualifiedName() + ";\n");
duke@1 196 }
duke@1 197
duke@1 198 defaultAction(e, true);
duke@1 199
duke@1 200 switch(kind) {
duke@1 201 case ANNOTATION_TYPE:
duke@1 202 writer.print("@interface");
duke@1 203 break;
duke@1 204 default:
duke@1 205 writer.print(kind.toString().toLowerCase());
duke@1 206 }
duke@1 207 writer.print(" ");
duke@1 208 writer.print(e.getSimpleName());
duke@1 209
darcy@224 210 printFormalTypeParameters(e, false);
duke@1 211
duke@1 212 // Print superclass information if informative
duke@1 213 if (kind == CLASS) {
duke@1 214 TypeMirror supertype = e.getSuperclass();
duke@1 215 if (supertype.getKind() != TypeKind.NONE) {
duke@1 216 TypeElement e2 = (TypeElement)
duke@1 217 ((DeclaredType) supertype).asElement();
duke@1 218 if (e2.getSuperclass().getKind() != TypeKind.NONE)
duke@1 219 writer.print(" extends " + supertype);
duke@1 220 }
duke@1 221 }
duke@1 222
duke@1 223 printInterfaces(e);
duke@1 224 }
duke@1 225 writer.println(" {");
duke@1 226 indentation++;
duke@1 227
duke@1 228 if (kind == ENUM) {
duke@1 229 List<Element> enclosedElements =
duke@1 230 new ArrayList<Element>(e.getEnclosedElements());
darcy@530 231 // Handle any enum constants specially before other entities.
duke@1 232 List<Element> enumConstants = new ArrayList<Element>();
duke@1 233 for(Element element : enclosedElements) {
duke@1 234 if (element.getKind() == ENUM_CONSTANT)
duke@1 235 enumConstants.add(element);
duke@1 236 }
darcy@530 237 if (!enumConstants.isEmpty()) {
darcy@530 238 int i;
darcy@530 239 for(i = 0; i < enumConstants.size()-1; i++) {
darcy@530 240 this.visit(enumConstants.get(i), true);
darcy@530 241 writer.print(",");
darcy@530 242 }
darcy@530 243 this.visit(enumConstants.get(i), true);
darcy@530 244 writer.println(";\n");
duke@1 245
darcy@530 246 enclosedElements.removeAll(enumConstants);
duke@1 247 }
duke@1 248
duke@1 249 for(Element element : enclosedElements)
duke@1 250 this.visit(element);
duke@1 251 } else {
duke@1 252 for(Element element : e.getEnclosedElements())
duke@1 253 this.visit(element);
duke@1 254 }
duke@1 255
duke@1 256 indentation--;
duke@1 257 indent();
duke@1 258 writer.println("}");
duke@1 259 return this;
duke@1 260 }
duke@1 261
duke@1 262 @Override
duke@1 263 public PrintingElementVisitor visitVariable(VariableElement e, Boolean newLine) {
duke@1 264 ElementKind kind = e.getKind();
duke@1 265 defaultAction(e, newLine);
duke@1 266
duke@1 267 if (kind == ENUM_CONSTANT)
duke@1 268 writer.print(e.getSimpleName());
duke@1 269 else {
duke@1 270 writer.print(e.asType().toString() + " " + e.getSimpleName() );
duke@1 271 Object constantValue = e.getConstantValue();
duke@1 272 if (constantValue != null) {
duke@1 273 writer.print(" = ");
duke@1 274 writer.print(elementUtils.getConstantExpression(constantValue));
duke@1 275 }
duke@1 276 writer.println(";");
duke@1 277 }
duke@1 278 return this;
duke@1 279 }
duke@1 280
duke@1 281 @Override
duke@1 282 public PrintingElementVisitor visitTypeParameter(TypeParameterElement e, Boolean p) {
duke@1 283 writer.print(e.getSimpleName());
duke@1 284 return this;
duke@1 285 }
duke@1 286
duke@1 287 // Should we do more here?
duke@1 288 @Override
duke@1 289 public PrintingElementVisitor visitPackage(PackageElement e, Boolean p) {
duke@1 290 defaultAction(e, false);
duke@1 291 if (!e.isUnnamed())
duke@1 292 writer.println("package " + e.getQualifiedName() + ";");
duke@1 293 else
duke@1 294 writer.println("// Unnamed package");
duke@1 295 return this;
duke@1 296 }
duke@1 297
duke@1 298 public void flush() {
duke@1 299 writer.flush();
duke@1 300 }
duke@1 301
duke@1 302 private void printDocComment(Element e) {
duke@1 303 String docComment = elementUtils.getDocComment(e);
duke@1 304
duke@1 305 if (docComment != null) {
duke@1 306 // Break comment into lines
duke@1 307 java.util.StringTokenizer st = new StringTokenizer(docComment,
duke@1 308 "\n\r");
duke@1 309 indent();
duke@1 310 writer.println("/**");
duke@1 311
duke@1 312 while(st.hasMoreTokens()) {
duke@1 313 indent();
duke@1 314 writer.print(" *");
duke@1 315 writer.println(st.nextToken());
duke@1 316 }
duke@1 317
duke@1 318 indent();
duke@1 319 writer.println(" */");
duke@1 320 }
duke@1 321 }
duke@1 322
duke@1 323 private void printModifiers(Element e) {
duke@1 324 ElementKind kind = e.getKind();
duke@1 325 if (kind == PARAMETER) {
duke@1 326 printAnnotationsInline(e);
duke@1 327 } else {
duke@1 328 printAnnotations(e);
duke@1 329 indent();
duke@1 330 }
duke@1 331
duke@1 332 if (kind == ENUM_CONSTANT)
duke@1 333 return;
duke@1 334
duke@1 335 Set<Modifier> modifiers = new LinkedHashSet<Modifier>();
duke@1 336 modifiers.addAll(e.getModifiers());
duke@1 337
duke@1 338 switch (kind) {
duke@1 339 case ANNOTATION_TYPE:
duke@1 340 case INTERFACE:
duke@1 341 modifiers.remove(Modifier.ABSTRACT);
duke@1 342 break;
duke@1 343
duke@1 344 case ENUM:
duke@1 345 modifiers.remove(Modifier.FINAL);
duke@1 346 modifiers.remove(Modifier.ABSTRACT);
duke@1 347 break;
duke@1 348
duke@1 349 case METHOD:
duke@1 350 case FIELD:
duke@1 351 Element enclosingElement = e.getEnclosingElement();
duke@1 352 if (enclosingElement != null &&
duke@1 353 enclosingElement.getKind().isInterface()) {
duke@1 354 modifiers.remove(Modifier.PUBLIC);
duke@1 355 modifiers.remove(Modifier.ABSTRACT); // only for methods
duke@1 356 modifiers.remove(Modifier.STATIC); // only for fields
duke@1 357 modifiers.remove(Modifier.FINAL); // only for fields
duke@1 358 }
duke@1 359 break;
duke@1 360
duke@1 361 }
duke@1 362
duke@1 363 for(Modifier m: modifiers) {
duke@1 364 writer.print(m.toString() + " ");
duke@1 365 }
duke@1 366 }
duke@1 367
darcy@224 368 private void printFormalTypeParameters(Parameterizable e,
duke@1 369 boolean pad) {
darcy@224 370 List<? extends TypeParameterElement> typeParams = e.getTypeParameters();
duke@1 371 if (typeParams.size() > 0) {
duke@1 372 writer.print("<");
duke@1 373
duke@1 374 boolean first = true;
duke@1 375 for(TypeParameterElement tpe: typeParams) {
duke@1 376 if (!first)
duke@1 377 writer.print(", ");
darcy@381 378 printAnnotationsInline(tpe);
duke@1 379 writer.print(tpe.toString());
duke@1 380 first = false;
duke@1 381 }
duke@1 382
duke@1 383 writer.print(">");
duke@1 384 if (pad)
duke@1 385 writer.print(" ");
duke@1 386 }
duke@1 387 }
duke@1 388
duke@1 389 private void printAnnotationsInline(Element e) {
duke@1 390 List<? extends AnnotationMirror> annots = e.getAnnotationMirrors();
duke@1 391 for(AnnotationMirror annotationMirror : annots) {
duke@1 392 writer.print(annotationMirror);
duke@1 393 writer.print(" ");
duke@1 394 }
duke@1 395 }
duke@1 396
duke@1 397 private void printAnnotations(Element e) {
duke@1 398 List<? extends AnnotationMirror> annots = e.getAnnotationMirrors();
duke@1 399 for(AnnotationMirror annotationMirror : annots) {
duke@1 400 indent();
duke@1 401 writer.println(annotationMirror);
duke@1 402 }
duke@1 403 }
duke@1 404
duke@1 405 // TODO: Refactor
duke@1 406 private void printParameters(ExecutableElement e) {
duke@1 407 List<? extends VariableElement> parameters = e.getParameters();
duke@1 408 int size = parameters.size();
duke@1 409
duke@1 410 switch (size) {
duke@1 411 case 0:
duke@1 412 break;
duke@1 413
duke@1 414 case 1:
duke@1 415 for(VariableElement parameter: parameters) {
duke@1 416 printModifiers(parameter);
duke@1 417
duke@1 418 if (e.isVarArgs() ) {
duke@1 419 TypeMirror tm = parameter.asType();
duke@1 420 if (tm.getKind() != TypeKind.ARRAY)
duke@1 421 throw new AssertionError("Var-args parameter is not an array type: " + tm);
duke@1 422 writer.print((ArrayType.class.cast(tm)).getComponentType() );
duke@1 423 writer.print("...");
duke@1 424 } else
duke@1 425 writer.print(parameter.asType());
duke@1 426 writer.print(" " + parameter.getSimpleName());
duke@1 427 }
duke@1 428 break;
duke@1 429
duke@1 430 default:
duke@1 431 {
duke@1 432 int i = 1;
duke@1 433 for(VariableElement parameter: parameters) {
duke@1 434 if (i == 2)
duke@1 435 indentation++;
duke@1 436
duke@1 437 if (i > 1)
duke@1 438 indent();
duke@1 439
duke@1 440 printModifiers(parameter);
duke@1 441
duke@1 442 if (i == size && e.isVarArgs() ) {
duke@1 443 TypeMirror tm = parameter.asType();
duke@1 444 if (tm.getKind() != TypeKind.ARRAY)
duke@1 445 throw new AssertionError("Var-args parameter is not an array type: " + tm);
duke@1 446 writer.print((ArrayType.class.cast(tm)).getComponentType() );
duke@1 447
duke@1 448 writer.print("...");
duke@1 449 } else
duke@1 450 writer.print(parameter.asType());
duke@1 451 writer.print(" " + parameter.getSimpleName());
duke@1 452
duke@1 453 if (i < size)
duke@1 454 writer.println(",");
duke@1 455
duke@1 456 i++;
duke@1 457 }
duke@1 458
duke@1 459 if (parameters.size() >= 2)
duke@1 460 indentation--;
duke@1 461 }
duke@1 462 break;
duke@1 463 }
duke@1 464 }
duke@1 465
duke@1 466 private void printInterfaces(TypeElement e) {
duke@1 467 ElementKind kind = e.getKind();
duke@1 468
duke@1 469 if(kind != ANNOTATION_TYPE) {
duke@1 470 List<? extends TypeMirror> interfaces = e.getInterfaces();
duke@1 471 if (interfaces.size() > 0) {
duke@1 472 writer.print((kind.isClass() ? " implements" : " extends"));
duke@1 473
duke@1 474 boolean first = true;
duke@1 475 for(TypeMirror interf: interfaces) {
duke@1 476 if (!first)
duke@1 477 writer.print(",");
duke@1 478 writer.print(" ");
duke@1 479 writer.print(interf.toString());
duke@1 480 first = false;
duke@1 481 }
duke@1 482 }
duke@1 483 }
duke@1 484 }
duke@1 485
duke@1 486 private void printThrows(ExecutableElement e) {
duke@1 487 List<? extends TypeMirror> thrownTypes = e.getThrownTypes();
duke@1 488 final int size = thrownTypes.size();
duke@1 489 if (size != 0) {
duke@1 490 writer.print(" throws");
duke@1 491
duke@1 492 int i = 1;
duke@1 493 for(TypeMirror thrownType: thrownTypes) {
duke@1 494 if (i == 1)
duke@1 495 writer.print(" ");
duke@1 496
duke@1 497 if (i == 2)
duke@1 498 indentation++;
duke@1 499
duke@1 500 if (i >= 2)
duke@1 501 indent();
duke@1 502
duke@1 503 writer.print(thrownType);
duke@1 504
duke@1 505 if (i != size)
duke@1 506 writer.println(", ");
duke@1 507
duke@1 508 i++;
duke@1 509 }
duke@1 510
duke@1 511 if (size >= 2)
duke@1 512 indentation--;
duke@1 513 }
duke@1 514 }
duke@1 515
duke@1 516 private static final String [] spaces = {
duke@1 517 "",
duke@1 518 " ",
duke@1 519 " ",
duke@1 520 " ",
duke@1 521 " ",
duke@1 522 " ",
duke@1 523 " ",
duke@1 524 " ",
duke@1 525 " ",
duke@1 526 " ",
duke@1 527 " "
duke@1 528 };
duke@1 529
duke@1 530 private void indent() {
duke@1 531 int indentation = this.indentation;
duke@1 532 if (indentation < 0)
duke@1 533 return;
duke@1 534 final int maxIndex = spaces.length - 1;
duke@1 535
duke@1 536 while (indentation > maxIndex) {
duke@1 537 writer.print(spaces[maxIndex]);
duke@1 538 indentation -= maxIndex;
duke@1 539 }
duke@1 540 writer.print(spaces[indentation]);
duke@1 541 }
duke@1 542
duke@1 543 }
duke@1 544 }

mercurial