JavacProcessingEnvironment.java revision 3294:9adfb22ff08f
1/* 2 * Copyright (c) 2005, 2016, 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.processing; 27 28import java.io.Closeable; 29import java.io.File; 30import java.io.IOException; 31import java.io.PrintWriter; 32import java.io.StringWriter; 33import java.lang.reflect.Method; 34import java.net.MalformedURLException; 35import java.net.URL; 36import java.nio.file.Path; 37import java.util.*; 38import java.util.regex.*; 39import java.util.stream.Collectors; 40 41import javax.annotation.processing.*; 42import javax.lang.model.SourceVersion; 43import javax.lang.model.element.*; 44import javax.lang.model.util.*; 45import javax.tools.JavaFileManager; 46import javax.tools.JavaFileObject; 47import javax.tools.JavaFileObject.Kind; 48import javax.tools.StandardJavaFileManager; 49 50import static javax.tools.StandardLocation.*; 51 52import com.sun.source.util.TaskEvent; 53import com.sun.tools.javac.api.MultiTaskListener; 54import com.sun.tools.javac.code.*; 55import com.sun.tools.javac.code.Scope.WriteableScope; 56import com.sun.tools.javac.code.Symbol.*; 57import com.sun.tools.javac.code.Type.ClassType; 58import com.sun.tools.javac.code.Types; 59import com.sun.tools.javac.comp.AttrContext; 60import com.sun.tools.javac.comp.Check; 61import com.sun.tools.javac.comp.Enter; 62import com.sun.tools.javac.comp.Env; 63import com.sun.tools.javac.comp.Modules; 64import com.sun.tools.javac.file.JavacFileManager; 65import com.sun.tools.javac.main.JavaCompiler; 66import com.sun.tools.javac.model.JavacElements; 67import com.sun.tools.javac.model.JavacTypes; 68import com.sun.tools.javac.platform.PlatformDescription; 69import com.sun.tools.javac.platform.PlatformDescription.PluginInfo; 70import com.sun.tools.javac.resources.CompilerProperties.Errors; 71import com.sun.tools.javac.tree.*; 72import com.sun.tools.javac.tree.JCTree.*; 73import com.sun.tools.javac.util.Abort; 74import com.sun.tools.javac.util.Assert; 75import com.sun.tools.javac.util.ClientCodeException; 76import com.sun.tools.javac.util.Context; 77import com.sun.tools.javac.util.Convert; 78import com.sun.tools.javac.util.DefinedBy; 79import com.sun.tools.javac.util.DefinedBy.Api; 80import com.sun.tools.javac.util.Iterators; 81import com.sun.tools.javac.util.JCDiagnostic; 82import com.sun.tools.javac.util.JavacMessages; 83import com.sun.tools.javac.util.List; 84import com.sun.tools.javac.util.Log; 85import com.sun.tools.javac.util.MatchingUtils; 86import com.sun.tools.javac.util.ModuleHelper; 87import com.sun.tools.javac.util.Name; 88import com.sun.tools.javac.util.Names; 89import com.sun.tools.javac.util.Options; 90 91import static com.sun.tools.javac.code.Lint.LintCategory.PROCESSING; 92import static com.sun.tools.javac.code.Kinds.Kind.*; 93import static com.sun.tools.javac.main.Option.*; 94import static com.sun.tools.javac.comp.CompileStates.CompileState; 95import static com.sun.tools.javac.util.JCDiagnostic.DiagnosticFlag.*; 96 97/** 98 * Objects of this class hold and manage the state needed to support 99 * annotation processing. 100 * 101 * <p><b>This is NOT part of any supported API. 102 * If you write code that depends on this, you do so at your own risk. 103 * This code and its internal interfaces are subject to change or 104 * deletion without notice.</b> 105 */ 106public class JavacProcessingEnvironment implements ProcessingEnvironment, Closeable { 107 private final Options options; 108 109 private final boolean printProcessorInfo; 110 private final boolean printRounds; 111 private final boolean verbose; 112 private final boolean lint; 113 private final boolean fatalErrors; 114 private final boolean werror; 115 private final boolean showResolveErrors; 116 117 private final JavacFiler filer; 118 private final JavacMessager messager; 119 private final JavacElements elementUtils; 120 private final JavacTypes typeUtils; 121 private final JavaCompiler compiler; 122 private final Modules modules; 123 private final ModuleHelper moduleHelper; 124 private final Types types; 125 126 /** 127 * Holds relevant state history of which processors have been 128 * used. 129 */ 130 private DiscoveredProcessors discoveredProcs; 131 132 /** 133 * Map of processor-specific options. 134 */ 135 private final Map<String, String> processorOptions; 136 137 /** 138 */ 139 private final Set<String> unmatchedProcessorOptions; 140 141 /** 142 * Annotations implicitly processed and claimed by javac. 143 */ 144 private final Set<String> platformAnnotations; 145 146 /** 147 * Set of packages given on command line. 148 */ 149 private Set<PackageSymbol> specifiedPackages = Collections.emptySet(); 150 151 /** The log to be used for error reporting. 152 */ 153 final Log log; 154 155 /** Diagnostic factory. 156 */ 157 JCDiagnostic.Factory diags; 158 159 /** 160 * Source level of the compile. 161 */ 162 Source source; 163 164 private ClassLoader processorClassLoader; 165 private ServiceLoader<Processor> serviceLoader; 166 private SecurityException processorLoaderException; 167 168 private final JavaFileManager fileManager; 169 170 /** 171 * JavacMessages object used for localization 172 */ 173 private JavacMessages messages; 174 175 private MultiTaskListener taskListener; 176 private final Symtab symtab; 177 private final Names names; 178 private final Enter enter; 179 private final Completer initialCompleter; 180 private final Check chk; 181 private final ModuleSymbol defaultModule; 182 183 private final Context context; 184 185 /** Get the JavacProcessingEnvironment instance for this context. */ 186 public static JavacProcessingEnvironment instance(Context context) { 187 JavacProcessingEnvironment instance = context.get(JavacProcessingEnvironment.class); 188 if (instance == null) 189 instance = new JavacProcessingEnvironment(context); 190 return instance; 191 } 192 193 protected JavacProcessingEnvironment(Context context) { 194 this.context = context; 195 context.put(JavacProcessingEnvironment.class, this); 196 log = Log.instance(context); 197 source = Source.instance(context); 198 diags = JCDiagnostic.Factory.instance(context); 199 options = Options.instance(context); 200 printProcessorInfo = options.isSet(XPRINTPROCESSORINFO); 201 printRounds = options.isSet(XPRINTROUNDS); 202 verbose = options.isSet(VERBOSE); 203 lint = Lint.instance(context).isEnabled(PROCESSING); 204 compiler = JavaCompiler.instance(context); 205 if (options.isSet(PROC, "only") || options.isSet(XPRINT)) { 206 compiler.shouldStopPolicyIfNoError = CompileState.PROCESS; 207 } 208 fatalErrors = options.isSet("fatalEnterError"); 209 showResolveErrors = options.isSet("showResolveErrors"); 210 werror = options.isSet(WERROR); 211 fileManager = context.get(JavaFileManager.class); 212 platformAnnotations = initPlatformAnnotations(); 213 214 // Initialize services before any processors are initialized 215 // in case processors use them. 216 filer = new JavacFiler(context); 217 messager = new JavacMessager(context, this); 218 elementUtils = JavacElements.instance(context); 219 typeUtils = JavacTypes.instance(context); 220 modules = Modules.instance(context); 221 types = Types.instance(context); 222 processorOptions = initProcessorOptions(); 223 unmatchedProcessorOptions = initUnmatchedProcessorOptions(); 224 messages = JavacMessages.instance(context); 225 taskListener = MultiTaskListener.instance(context); 226 symtab = Symtab.instance(context); 227 names = Names.instance(context); 228 enter = Enter.instance(context); 229 initialCompleter = ClassFinder.instance(context).getCompleter(); 230 chk = Check.instance(context); 231 moduleHelper = ModuleHelper.instance(context); 232 initProcessorLoader(); 233 234 defaultModule = source.allowModules() && options.isUnset("noModules") 235 ? symtab.unnamedModule : symtab.noModule; 236 } 237 238 public void setProcessors(Iterable<? extends Processor> processors) { 239 Assert.checkNull(discoveredProcs); 240 initProcessorIterator(processors); 241 } 242 243 private Set<String> initPlatformAnnotations() { 244 Set<String> platformAnnotations = new HashSet<>(); 245 platformAnnotations.add("java.lang.Deprecated"); 246 platformAnnotations.add("java.lang.Override"); 247 platformAnnotations.add("java.lang.SuppressWarnings"); 248 platformAnnotations.add("java.lang.annotation.Documented"); 249 platformAnnotations.add("java.lang.annotation.Inherited"); 250 platformAnnotations.add("java.lang.annotation.Retention"); 251 platformAnnotations.add("java.lang.annotation.Target"); 252 return Collections.unmodifiableSet(platformAnnotations); 253 } 254 255 private void initProcessorLoader() { 256 try { 257 if (fileManager.hasLocation(ANNOTATION_PROCESSOR_MODULE_PATH)) { 258 try { 259 serviceLoader = fileManager.getServiceLoader(ANNOTATION_PROCESSOR_MODULE_PATH, Processor.class); 260 } catch (IOException e) { 261 throw new Abort(e); 262 } 263 } else { 264 // If processorpath is not explicitly set, use the classpath. 265 processorClassLoader = fileManager.hasLocation(ANNOTATION_PROCESSOR_PATH) 266 ? fileManager.getClassLoader(ANNOTATION_PROCESSOR_PATH) 267 : fileManager.getClassLoader(CLASS_PATH); 268 269 moduleHelper.addExports(processorClassLoader); 270 271 if (processorClassLoader != null && processorClassLoader instanceof Closeable) { 272 compiler.closeables = compiler.closeables.prepend((Closeable) processorClassLoader); 273 } 274 } 275 } catch (SecurityException e) { 276 processorLoaderException = e; 277 } 278 } 279 280 private void initProcessorIterator(Iterable<? extends Processor> processors) { 281 Iterator<? extends Processor> processorIterator; 282 283 if (options.isSet(XPRINT)) { 284 try { 285 Processor processor = PrintingProcessor.class.newInstance(); 286 processorIterator = List.of(processor).iterator(); 287 } catch (Throwable t) { 288 AssertionError assertError = 289 new AssertionError("Problem instantiating PrintingProcessor."); 290 assertError.initCause(t); 291 throw assertError; 292 } 293 } else if (processors != null) { 294 processorIterator = processors.iterator(); 295 } else { 296 if (processorLoaderException == null) { 297 /* 298 * If the "-processor" option is used, search the appropriate 299 * path for the named class. Otherwise, use a service 300 * provider mechanism to create the processor iterator. 301 */ 302 String processorNames = options.get(PROCESSOR); 303 if (fileManager.hasLocation(ANNOTATION_PROCESSOR_MODULE_PATH)) { 304 processorIterator = (processorNames == null) ? 305 new ServiceIterator(serviceLoader, log) : 306 new NameServiceIterator(serviceLoader, log, processorNames); 307 } else if (processorNames != null) { 308 processorIterator = new NameProcessIterator(processorNames, processorClassLoader, log); 309 } else { 310 processorIterator = new ServiceIterator(processorClassLoader, log); 311 } 312 } else { 313 /* 314 * A security exception will occur if we can't create a classloader. 315 * Ignore the exception if, with hindsight, we didn't need it anyway 316 * (i.e. no processor was specified either explicitly, or implicitly, 317 * in service configuration file.) Otherwise, we cannot continue. 318 */ 319 processorIterator = handleServiceLoaderUnavailability("proc.cant.create.loader", 320 processorLoaderException); 321 } 322 } 323 PlatformDescription platformProvider = context.get(PlatformDescription.class); 324 java.util.List<Processor> platformProcessors = Collections.emptyList(); 325 if (platformProvider != null) { 326 platformProcessors = platformProvider.getAnnotationProcessors() 327 .stream() 328 .map(ap -> ap.getPlugin()) 329 .collect(Collectors.toList()); 330 } 331 List<Iterator<? extends Processor>> iterators = List.of(processorIterator, 332 platformProcessors.iterator()); 333 Iterator<? extends Processor> compoundIterator = 334 Iterators.createCompoundIterator(iterators, i -> i); 335 discoveredProcs = new DiscoveredProcessors(compoundIterator); 336 } 337 338 public <S> ServiceLoader<S> getServiceLoader(Class<S> service) { 339 if (fileManager.hasLocation(ANNOTATION_PROCESSOR_MODULE_PATH)) { 340 try { 341 return fileManager.getServiceLoader(ANNOTATION_PROCESSOR_MODULE_PATH, service); 342 } catch (IOException e) { 343 throw new Abort(e); 344 } 345 } else { 346 return ServiceLoader.load(service, getProcessorClassLoader()); 347 } 348 } 349 350 /** 351 * Returns an empty processor iterator if no processors are on the 352 * relevant path, otherwise if processors are present, logs an 353 * error. Called when a service loader is unavailable for some 354 * reason, either because a service loader class cannot be found 355 * or because a security policy prevents class loaders from being 356 * created. 357 * 358 * @param key The resource key to use to log an error message 359 * @param e If non-null, pass this exception to Abort 360 */ 361 private Iterator<Processor> handleServiceLoaderUnavailability(String key, Exception e) { 362 if (fileManager instanceof JavacFileManager) { 363 StandardJavaFileManager standardFileManager = (JavacFileManager) fileManager; 364 Iterable<? extends Path> workingPath = fileManager.hasLocation(ANNOTATION_PROCESSOR_PATH) 365 ? standardFileManager.getLocationAsPaths(ANNOTATION_PROCESSOR_PATH) 366 : standardFileManager.getLocationAsPaths(CLASS_PATH); 367 368 if (needClassLoader(options.get(PROCESSOR), workingPath) ) 369 handleException(key, e); 370 371 } else { 372 handleException(key, e); 373 } 374 375 java.util.List<Processor> pl = Collections.emptyList(); 376 return pl.iterator(); 377 } 378 379 /** 380 * Handle a security exception thrown during initializing the 381 * Processor iterator. 382 */ 383 private void handleException(String key, Exception e) { 384 if (e != null) { 385 log.error(key, e.getLocalizedMessage()); 386 throw new Abort(e); 387 } else { 388 log.error(key); 389 throw new Abort(); 390 } 391 } 392 393 /** 394 * Use a service loader appropriate for the platform to provide an 395 * iterator over annotations processors; fails if a loader is 396 * needed but unavailable. 397 */ 398 private class ServiceIterator implements Iterator<Processor> { 399 Iterator<Processor> iterator; 400 Log log; 401 ServiceLoader<Processor> loader; 402 403 ServiceIterator(ClassLoader classLoader, Log log) { 404 this.log = log; 405 try { 406 try { 407 loader = ServiceLoader.load(Processor.class, classLoader); 408 this.iterator = loader.iterator(); 409 } catch (Exception e) { 410 // Fail softly if a loader is not actually needed. 411 this.iterator = handleServiceLoaderUnavailability("proc.no.service", null); 412 } 413 } catch (Throwable t) { 414 log.error("proc.service.problem"); 415 throw new Abort(t); 416 } 417 } 418 419 ServiceIterator(ServiceLoader<Processor> loader, Log log) { 420 this.log = log; 421 this.loader = loader; 422 this.iterator = loader.iterator(); 423 } 424 425 @Override 426 public boolean hasNext() { 427 try { 428 return internalHasNext(); 429 } catch(ServiceConfigurationError sce) { 430 log.error("proc.bad.config.file", sce.getLocalizedMessage()); 431 throw new Abort(sce); 432 } catch (Throwable t) { 433 throw new Abort(t); 434 } 435 } 436 437 boolean internalHasNext() { 438 return iterator.hasNext(); 439 } 440 441 @Override 442 public Processor next() { 443 try { 444 return internalNext(); 445 } catch (ServiceConfigurationError sce) { 446 log.error("proc.bad.config.file", sce.getLocalizedMessage()); 447 throw new Abort(sce); 448 } catch (Throwable t) { 449 throw new Abort(t); 450 } 451 } 452 453 Processor internalNext() { 454 return iterator.next(); 455 } 456 457 @Override 458 public void remove() { 459 throw new UnsupportedOperationException(); 460 } 461 462 public void close() { 463 if (loader != null) { 464 try { 465 loader.reload(); 466 } catch(Exception e) { 467 // Ignore problems during a call to reload. 468 } 469 } 470 } 471 } 472 473 private class NameServiceIterator extends ServiceIterator { 474 private Map<String, Processor> namedProcessorsMap = new HashMap<>();; 475 private Iterator<String> processorNames = null; 476 private Processor nextProc = null; 477 478 public NameServiceIterator(ServiceLoader<Processor> loader, Log log, String theNames) { 479 super(loader, log); 480 this.processorNames = Arrays.asList(theNames.split(",")).iterator(); 481 } 482 483 @Override 484 boolean internalHasNext() { 485 if (nextProc != null) { 486 return true; 487 } 488 if (!processorNames.hasNext()) { 489 namedProcessorsMap = null; 490 return false; 491 } 492 String processorName = processorNames.next(); 493 Processor theProcessor = namedProcessorsMap.get(processorName); 494 if (theProcessor != null) { 495 namedProcessorsMap.remove(processorName); 496 nextProc = theProcessor; 497 return true; 498 } else { 499 while (iterator.hasNext()) { 500 theProcessor = iterator.next(); 501 String name = theProcessor.getClass().getName(); 502 if (name.equals(processorName)) { 503 nextProc = theProcessor; 504 return true; 505 } else { 506 namedProcessorsMap.put(name, theProcessor); 507 } 508 } 509 log.error(Errors.ProcProcessorNotFound(processorName)); 510 return false; 511 } 512 } 513 514 @Override 515 Processor internalNext() { 516 if (hasNext()) { 517 Processor p = nextProc; 518 nextProc = null; 519 return p; 520 } else { 521 throw new NoSuchElementException(); 522 } 523 } 524 } 525 526 private static class NameProcessIterator implements Iterator<Processor> { 527 Processor nextProc = null; 528 Iterator<String> names; 529 ClassLoader processorCL; 530 Log log; 531 532 NameProcessIterator(String names, ClassLoader processorCL, Log log) { 533 this.names = Arrays.asList(names.split(",")).iterator(); 534 this.processorCL = processorCL; 535 this.log = log; 536 } 537 538 public boolean hasNext() { 539 if (nextProc != null) 540 return true; 541 else { 542 if (!names.hasNext()) 543 return false; 544 else { 545 String processorName = names.next(); 546 547 Processor processor; 548 try { 549 try { 550 Class<?> processorClass = processorCL.loadClass(processorName); 551 ensureReadable(processorClass); 552 processor = 553 (Processor) (processorClass.newInstance()); 554 } catch (ClassNotFoundException cnfe) { 555 log.error("proc.processor.not.found", processorName); 556 return false; 557 } catch (ClassCastException cce) { 558 log.error("proc.processor.wrong.type", processorName); 559 return false; 560 } catch (Exception e ) { 561 log.error("proc.processor.cant.instantiate", processorName); 562 return false; 563 } 564 } catch(ClientCodeException e) { 565 throw e; 566 } catch(Throwable t) { 567 throw new AnnotationProcessingError(t); 568 } 569 nextProc = processor; 570 return true; 571 } 572 573 } 574 } 575 576 public Processor next() { 577 if (hasNext()) { 578 Processor p = nextProc; 579 nextProc = null; 580 return p; 581 } else 582 throw new NoSuchElementException(); 583 } 584 585 public void remove () { 586 throw new UnsupportedOperationException(); 587 } 588 589 /** 590 * Ensures that the module of the given class is readable to this 591 * module. 592 */ 593 private void ensureReadable(Class<?> targetClass) { 594 try { 595 Method getModuleMethod = Class.class.getMethod("getModule"); 596 Object thisModule = getModuleMethod.invoke(this.getClass()); 597 Object targetModule = getModuleMethod.invoke(targetClass); 598 599 Class<?> moduleClass = getModuleMethod.getReturnType(); 600 Method addReadsMethod = moduleClass.getMethod("addReads", moduleClass); 601 addReadsMethod.invoke(thisModule, targetModule); 602 } catch (NoSuchMethodException e) { 603 // ignore 604 } catch (Exception e) { 605 throw new InternalError(e); 606 } 607 } 608 } 609 610 public boolean atLeastOneProcessor() { 611 return discoveredProcs.iterator().hasNext(); 612 } 613 614 private Map<String, String> initProcessorOptions() { 615 Set<String> keySet = options.keySet(); 616 Map<String, String> tempOptions = new LinkedHashMap<>(); 617 618 for(String key : keySet) { 619 if (key.startsWith("-A") && key.length() > 2) { 620 int sepIndex = key.indexOf('='); 621 String candidateKey = null; 622 String candidateValue = null; 623 624 if (sepIndex == -1) 625 candidateKey = key.substring(2); 626 else if (sepIndex >= 3) { 627 candidateKey = key.substring(2, sepIndex); 628 candidateValue = (sepIndex < key.length()-1)? 629 key.substring(sepIndex+1) : null; 630 } 631 tempOptions.put(candidateKey, candidateValue); 632 } 633 } 634 635 PlatformDescription platformProvider = context.get(PlatformDescription.class); 636 637 if (platformProvider != null) { 638 for (PluginInfo<Processor> ap : platformProvider.getAnnotationProcessors()) { 639 tempOptions.putAll(ap.getOptions()); 640 } 641 } 642 643 return Collections.unmodifiableMap(tempOptions); 644 } 645 646 private Set<String> initUnmatchedProcessorOptions() { 647 Set<String> unmatchedProcessorOptions = new HashSet<>(); 648 unmatchedProcessorOptions.addAll(processorOptions.keySet()); 649 return unmatchedProcessorOptions; 650 } 651 652 /** 653 * State about how a processor has been used by the tool. If a 654 * processor has been used on a prior round, its process method is 655 * called on all subsequent rounds, perhaps with an empty set of 656 * annotations to process. The {@code annotationSupported} method 657 * caches the supported annotation information from the first (and 658 * only) getSupportedAnnotationTypes call to the processor. 659 */ 660 static class ProcessorState { 661 public Processor processor; 662 public boolean contributed; 663 private ArrayList<Pattern> supportedAnnotationPatterns; 664 private ArrayList<String> supportedOptionNames; 665 666 ProcessorState(Processor p, Log log, Source source, ProcessingEnvironment env) { 667 processor = p; 668 contributed = false; 669 670 try { 671 processor.init(env); 672 673 checkSourceVersionCompatibility(source, log); 674 675 supportedAnnotationPatterns = new ArrayList<>(); 676 for (String importString : processor.getSupportedAnnotationTypes()) { 677 supportedAnnotationPatterns.add(importStringToPattern(importString, 678 processor, 679 log)); 680 } 681 682 supportedOptionNames = new ArrayList<>(); 683 for (String optionName : processor.getSupportedOptions() ) { 684 if (checkOptionName(optionName, log)) 685 supportedOptionNames.add(optionName); 686 } 687 688 } catch (ClientCodeException e) { 689 throw e; 690 } catch (Throwable t) { 691 throw new AnnotationProcessingError(t); 692 } 693 } 694 695 /** 696 * Checks whether or not a processor's source version is 697 * compatible with the compilation source version. The 698 * processor's source version needs to be greater than or 699 * equal to the source version of the compile. 700 */ 701 private void checkSourceVersionCompatibility(Source source, Log log) { 702 SourceVersion procSourceVersion = processor.getSupportedSourceVersion(); 703 704 if (procSourceVersion.compareTo(Source.toSourceVersion(source)) < 0 ) { 705 log.warning("proc.processor.incompatible.source.version", 706 procSourceVersion, 707 processor.getClass().getName(), 708 source.name); 709 } 710 } 711 712 private boolean checkOptionName(String optionName, Log log) { 713 boolean valid = isValidOptionName(optionName); 714 if (!valid) 715 log.error("proc.processor.bad.option.name", 716 optionName, 717 processor.getClass().getName()); 718 return valid; 719 } 720 721 public boolean annotationSupported(String annotationName) { 722 for(Pattern p: supportedAnnotationPatterns) { 723 if (p.matcher(annotationName).matches()) 724 return true; 725 } 726 return false; 727 } 728 729 /** 730 * Remove options that are matched by this processor. 731 */ 732 public void removeSupportedOptions(Set<String> unmatchedProcessorOptions) { 733 unmatchedProcessorOptions.removeAll(supportedOptionNames); 734 } 735 } 736 737 // TODO: These two classes can probably be rewritten better... 738 /** 739 * This class holds information about the processors that have 740 * been discovered so far as well as the means to discover more, if 741 * necessary. A single iterator should be used per round of 742 * annotation processing. The iterator first visits already 743 * discovered processors then fails over to the service provider 744 * mechanism if additional queries are made. 745 */ 746 class DiscoveredProcessors implements Iterable<ProcessorState> { 747 748 class ProcessorStateIterator implements Iterator<ProcessorState> { 749 DiscoveredProcessors psi; 750 Iterator<ProcessorState> innerIter; 751 boolean onProcInterator; 752 753 ProcessorStateIterator(DiscoveredProcessors psi) { 754 this.psi = psi; 755 this.innerIter = psi.procStateList.iterator(); 756 this.onProcInterator = false; 757 } 758 759 public ProcessorState next() { 760 if (!onProcInterator) { 761 if (innerIter.hasNext()) 762 return innerIter.next(); 763 else 764 onProcInterator = true; 765 } 766 767 if (psi.processorIterator.hasNext()) { 768 ProcessorState ps = new ProcessorState(psi.processorIterator.next(), 769 log, source, JavacProcessingEnvironment.this); 770 psi.procStateList.add(ps); 771 return ps; 772 } else 773 throw new NoSuchElementException(); 774 } 775 776 public boolean hasNext() { 777 if (onProcInterator) 778 return psi.processorIterator.hasNext(); 779 else 780 return innerIter.hasNext() || psi.processorIterator.hasNext(); 781 } 782 783 public void remove () { 784 throw new UnsupportedOperationException(); 785 } 786 787 /** 788 * Run all remaining processors on the procStateList that 789 * have not already run this round with an empty set of 790 * annotations. 791 */ 792 public void runContributingProcs(RoundEnvironment re) { 793 if (!onProcInterator) { 794 Set<TypeElement> emptyTypeElements = Collections.emptySet(); 795 while(innerIter.hasNext()) { 796 ProcessorState ps = innerIter.next(); 797 if (ps.contributed) 798 callProcessor(ps.processor, emptyTypeElements, re); 799 } 800 } 801 } 802 } 803 804 Iterator<? extends Processor> processorIterator; 805 ArrayList<ProcessorState> procStateList; 806 807 public ProcessorStateIterator iterator() { 808 return new ProcessorStateIterator(this); 809 } 810 811 DiscoveredProcessors(Iterator<? extends Processor> processorIterator) { 812 this.processorIterator = processorIterator; 813 this.procStateList = new ArrayList<>(); 814 } 815 816 /** 817 * Free jar files, etc. if using a service loader. 818 */ 819 public void close() { 820 if (processorIterator != null && 821 processorIterator instanceof ServiceIterator) { 822 ((ServiceIterator) processorIterator).close(); 823 } 824 } 825 } 826 827 private void discoverAndRunProcs(Set<TypeElement> annotationsPresent, 828 List<ClassSymbol> topLevelClasses, 829 List<PackageSymbol> packageInfoFiles) { 830 Map<String, TypeElement> unmatchedAnnotations = new HashMap<>(annotationsPresent.size()); 831 832 for(TypeElement a : annotationsPresent) { 833 unmatchedAnnotations.put(a.getQualifiedName().toString(), 834 a); 835 } 836 837 // Give "*" processors a chance to match 838 if (unmatchedAnnotations.size() == 0) 839 unmatchedAnnotations.put("", null); 840 841 DiscoveredProcessors.ProcessorStateIterator psi = discoveredProcs.iterator(); 842 // TODO: Create proper argument values; need past round 843 // information to fill in this constructor. Note that the 1 844 // st round of processing could be the last round if there 845 // were parse errors on the initial source files; however, we 846 // are not doing processing in that case. 847 848 Set<Element> rootElements = new LinkedHashSet<>(); 849 rootElements.addAll(topLevelClasses); 850 rootElements.addAll(packageInfoFiles); 851 rootElements = Collections.unmodifiableSet(rootElements); 852 853 RoundEnvironment renv = new JavacRoundEnvironment(false, 854 false, 855 rootElements, 856 JavacProcessingEnvironment.this); 857 858 while(unmatchedAnnotations.size() > 0 && psi.hasNext() ) { 859 ProcessorState ps = psi.next(); 860 Set<String> matchedNames = new HashSet<>(); 861 Set<TypeElement> typeElements = new LinkedHashSet<>(); 862 863 for (Map.Entry<String, TypeElement> entry: unmatchedAnnotations.entrySet()) { 864 String unmatchedAnnotationName = entry.getKey(); 865 if (ps.annotationSupported(unmatchedAnnotationName) ) { 866 matchedNames.add(unmatchedAnnotationName); 867 TypeElement te = entry.getValue(); 868 if (te != null) 869 typeElements.add(te); 870 } 871 } 872 873 if (matchedNames.size() > 0 || ps.contributed) { 874 boolean processingResult = callProcessor(ps.processor, typeElements, renv); 875 ps.contributed = true; 876 ps.removeSupportedOptions(unmatchedProcessorOptions); 877 878 if (printProcessorInfo || verbose) { 879 log.printLines("x.print.processor.info", 880 ps.processor.getClass().getName(), 881 matchedNames.toString(), 882 processingResult); 883 } 884 885 if (processingResult) { 886 unmatchedAnnotations.keySet().removeAll(matchedNames); 887 } 888 889 } 890 } 891 unmatchedAnnotations.remove(""); 892 893 if (lint && unmatchedAnnotations.size() > 0) { 894 // Remove annotations processed by javac 895 unmatchedAnnotations.keySet().removeAll(platformAnnotations); 896 if (unmatchedAnnotations.size() > 0) { 897 log.warning("proc.annotations.without.processors", 898 unmatchedAnnotations.keySet()); 899 } 900 } 901 902 // Run contributing processors that haven't run yet 903 psi.runContributingProcs(renv); 904 } 905 906 /** 907 * Computes the set of annotations on the symbol in question. 908 * Leave class public for external testing purposes. 909 */ 910 public static class ComputeAnnotationSet extends 911 ElementScanner9<Set<TypeElement>, Set<TypeElement>> { 912 final Elements elements; 913 914 public ComputeAnnotationSet(Elements elements) { 915 super(); 916 this.elements = elements; 917 } 918 919 @Override @DefinedBy(Api.LANGUAGE_MODEL) 920 public Set<TypeElement> visitPackage(PackageElement e, Set<TypeElement> p) { 921 // Don't scan enclosed elements of a package 922 return p; 923 } 924 925 @Override @DefinedBy(Api.LANGUAGE_MODEL) 926 public Set<TypeElement> visitType(TypeElement e, Set<TypeElement> p) { 927 // Type parameters are not considered to be enclosed by a type 928 scan(e.getTypeParameters(), p); 929 return super.visitType(e, p); 930 } 931 932 @Override @DefinedBy(Api.LANGUAGE_MODEL) 933 public Set<TypeElement> visitExecutable(ExecutableElement e, Set<TypeElement> p) { 934 // Type parameters are not considered to be enclosed by an executable 935 scan(e.getTypeParameters(), p); 936 return super.visitExecutable(e, p); 937 } 938 939 void addAnnotations(Element e, Set<TypeElement> p) { 940 for (AnnotationMirror annotationMirror : 941 elements.getAllAnnotationMirrors(e) ) { 942 Element e2 = annotationMirror.getAnnotationType().asElement(); 943 p.add((TypeElement) e2); 944 } 945 } 946 947 @Override @DefinedBy(Api.LANGUAGE_MODEL) 948 public Set<TypeElement> scan(Element e, Set<TypeElement> p) { 949 addAnnotations(e, p); 950 return super.scan(e, p); 951 } 952 } 953 954 private boolean callProcessor(Processor proc, 955 Set<? extends TypeElement> tes, 956 RoundEnvironment renv) { 957 try { 958 return proc.process(tes, renv); 959 } catch (ClassFinder.BadClassFile ex) { 960 log.error("proc.cant.access.1", ex.sym, ex.getDetailValue()); 961 return false; 962 } catch (CompletionFailure ex) { 963 StringWriter out = new StringWriter(); 964 ex.printStackTrace(new PrintWriter(out)); 965 log.error("proc.cant.access", ex.sym, ex.getDetailValue(), out.toString()); 966 return false; 967 } catch (ClientCodeException e) { 968 throw e; 969 } catch (Throwable t) { 970 throw new AnnotationProcessingError(t); 971 } 972 } 973 974 /** 975 * Helper object for a single round of annotation processing. 976 */ 977 class Round { 978 /** The round number. */ 979 final int number; 980 /** The diagnostic handler for the round. */ 981 final Log.DeferredDiagnosticHandler deferredDiagnosticHandler; 982 983 /** The ASTs to be compiled. */ 984 List<JCCompilationUnit> roots; 985 /** The trees that need to be cleaned - includes roots and implicitly parsed trees. */ 986 Set<JCCompilationUnit> treesToClean; 987 /** The classes to be compiler that have were generated. */ 988 Map<String, JavaFileObject> genClassFiles; 989 990 /** The set of annotations to be processed this round. */ 991 Set<TypeElement> annotationsPresent; 992 /** The set of top level classes to be processed this round. */ 993 List<ClassSymbol> topLevelClasses; 994 /** The set of package-info files to be processed this round. */ 995 List<PackageSymbol> packageInfoFiles; 996 997 /** Create a round (common code). */ 998 private Round(int number, Set<JCCompilationUnit> treesToClean, 999 Log.DeferredDiagnosticHandler deferredDiagnosticHandler) { 1000 this.number = number; 1001 1002 if (number == 1) { 1003 Assert.checkNonNull(deferredDiagnosticHandler); 1004 this.deferredDiagnosticHandler = deferredDiagnosticHandler; 1005 } else { 1006 this.deferredDiagnosticHandler = new Log.DeferredDiagnosticHandler(log); 1007 compiler.setDeferredDiagnosticHandler(this.deferredDiagnosticHandler); 1008 } 1009 1010 // the following will be populated as needed 1011 topLevelClasses = List.nil(); 1012 packageInfoFiles = List.nil(); 1013 this.treesToClean = treesToClean; 1014 } 1015 1016 /** Create the first round. */ 1017 Round(List<JCCompilationUnit> roots, 1018 List<ClassSymbol> classSymbols, 1019 Set<JCCompilationUnit> treesToClean, 1020 Log.DeferredDiagnosticHandler deferredDiagnosticHandler) { 1021 this(1, treesToClean, deferredDiagnosticHandler); 1022 this.roots = roots; 1023 genClassFiles = new HashMap<>(); 1024 1025 // The reverse() in the following line is to maintain behavioural 1026 // compatibility with the previous revision of the code. Strictly speaking, 1027 // it should not be necessary, but a javah golden file test fails without it. 1028 topLevelClasses = 1029 getTopLevelClasses(roots).prependList(classSymbols.reverse()); 1030 1031 packageInfoFiles = getPackageInfoFiles(roots); 1032 1033 findAnnotationsPresent(); 1034 } 1035 1036 /** Create a new round. */ 1037 private Round(Round prev, 1038 Set<JavaFileObject> newSourceFiles, Map<String,JavaFileObject> newClassFiles) { 1039 this(prev.number+1, prev.treesToClean, null); 1040 prev.newRound(); 1041 this.genClassFiles = prev.genClassFiles; 1042 1043 List<JCCompilationUnit> parsedFiles = compiler.parseFiles(newSourceFiles); 1044 roots = prev.roots.appendList(parsedFiles); 1045 1046 // Check for errors after parsing 1047 if (unrecoverableError()) 1048 return; 1049 1050 enterClassFiles(genClassFiles); 1051 List<ClassSymbol> newClasses = enterClassFiles(newClassFiles); 1052 genClassFiles.putAll(newClassFiles); 1053 enterTrees(roots); 1054 1055 if (unrecoverableError()) 1056 return; 1057 1058 topLevelClasses = join( 1059 getTopLevelClasses(parsedFiles), 1060 getTopLevelClassesFromClasses(newClasses)); 1061 1062 packageInfoFiles = join( 1063 getPackageInfoFiles(parsedFiles), 1064 getPackageInfoFilesFromClasses(newClasses)); 1065 1066 findAnnotationsPresent(); 1067 } 1068 1069 /** Create the next round to be used. */ 1070 Round next(Set<JavaFileObject> newSourceFiles, Map<String, JavaFileObject> newClassFiles) { 1071 return new Round(this, newSourceFiles, newClassFiles); 1072 } 1073 1074 /** Prepare the compiler for the final compilation. */ 1075 void finalCompiler() { 1076 newRound(); 1077 } 1078 1079 /** Return the number of errors found so far in this round. 1080 * This may include uncoverable errors, such as parse errors, 1081 * and transient errors, such as missing symbols. */ 1082 int errorCount() { 1083 return compiler.errorCount(); 1084 } 1085 1086 /** Return the number of warnings found so far in this round. */ 1087 int warningCount() { 1088 return compiler.warningCount(); 1089 } 1090 1091 /** Return whether or not an unrecoverable error has occurred. */ 1092 boolean unrecoverableError() { 1093 if (messager.errorRaised()) 1094 return true; 1095 1096 for (JCDiagnostic d: deferredDiagnosticHandler.getDiagnostics()) { 1097 switch (d.getKind()) { 1098 case WARNING: 1099 if (werror) 1100 return true; 1101 break; 1102 1103 case ERROR: 1104 if (fatalErrors || !d.isFlagSet(RECOVERABLE)) 1105 return true; 1106 break; 1107 } 1108 } 1109 1110 return false; 1111 } 1112 1113 /** Find the set of annotations present in the set of top level 1114 * classes and package info files to be processed this round. */ 1115 void findAnnotationsPresent() { 1116 ComputeAnnotationSet annotationComputer = new ComputeAnnotationSet(elementUtils); 1117 // Use annotation processing to compute the set of annotations present 1118 annotationsPresent = new LinkedHashSet<>(); 1119 for (ClassSymbol classSym : topLevelClasses) 1120 annotationComputer.scan(classSym, annotationsPresent); 1121 for (PackageSymbol pkgSym : packageInfoFiles) 1122 annotationComputer.scan(pkgSym, annotationsPresent); 1123 } 1124 1125 /** Enter a set of generated class files. */ 1126 private List<ClassSymbol> enterClassFiles(Map<String, JavaFileObject> classFiles) { 1127 List<ClassSymbol> list = List.nil(); 1128 1129 for (Map.Entry<String,JavaFileObject> entry : classFiles.entrySet()) { 1130 Name name = names.fromString(entry.getKey()); 1131 JavaFileObject file = entry.getValue(); 1132 if (file.getKind() != JavaFileObject.Kind.CLASS) 1133 throw new AssertionError(file); 1134 ClassSymbol cs; 1135 // TODO: for now, we assume that generated code is in a default module; 1136 // in time, we need a way to be able to specify the module for generated code 1137 if (isPkgInfo(file, JavaFileObject.Kind.CLASS)) { 1138 Name packageName = Convert.packagePart(name); 1139 PackageSymbol p = symtab.enterPackage(defaultModule, packageName); 1140 if (p.package_info == null) 1141 p.package_info = symtab.enterClass(defaultModule, Convert.shortName(name), p); 1142 cs = p.package_info; 1143 cs.reset(); 1144 if (cs.classfile == null) 1145 cs.classfile = file; 1146 cs.completer = initialCompleter; 1147 } else { 1148 cs = symtab.enterClass(defaultModule, name); 1149 cs.reset(); 1150 cs.classfile = file; 1151 cs.completer = initialCompleter; 1152 cs.owner.members().enter(cs); //XXX - OverwriteBetweenCompilations; syms.getClass is not sufficient anymore 1153 } 1154 list = list.prepend(cs); 1155 } 1156 return list.reverse(); 1157 } 1158 1159 /** Enter a set of syntax trees. */ 1160 private void enterTrees(List<JCCompilationUnit> roots) { 1161 compiler.enterTrees(compiler.initModules(roots)); 1162 } 1163 1164 /** Run a processing round. */ 1165 void run(boolean lastRound, boolean errorStatus) { 1166 printRoundInfo(lastRound); 1167 1168 if (!taskListener.isEmpty()) 1169 taskListener.started(new TaskEvent(TaskEvent.Kind.ANNOTATION_PROCESSING_ROUND)); 1170 1171 try { 1172 if (lastRound) { 1173 filer.setLastRound(true); 1174 Set<Element> emptyRootElements = Collections.emptySet(); // immutable 1175 RoundEnvironment renv = new JavacRoundEnvironment(true, 1176 errorStatus, 1177 emptyRootElements, 1178 JavacProcessingEnvironment.this); 1179 discoveredProcs.iterator().runContributingProcs(renv); 1180 } else { 1181 discoverAndRunProcs(annotationsPresent, topLevelClasses, packageInfoFiles); 1182 } 1183 } catch (Throwable t) { 1184 // we're specifically expecting Abort here, but if any Throwable 1185 // comes by, we should flush all deferred diagnostics, rather than 1186 // drop them on the ground. 1187 deferredDiagnosticHandler.reportDeferredDiagnostics(); 1188 log.popDiagnosticHandler(deferredDiagnosticHandler); 1189 compiler.setDeferredDiagnosticHandler(null); 1190 throw t; 1191 } finally { 1192 if (!taskListener.isEmpty()) 1193 taskListener.finished(new TaskEvent(TaskEvent.Kind.ANNOTATION_PROCESSING_ROUND)); 1194 } 1195 } 1196 1197 void showDiagnostics(boolean showAll) { 1198 Set<JCDiagnostic.Kind> kinds = EnumSet.allOf(JCDiagnostic.Kind.class); 1199 if (!showAll) { 1200 // suppress errors, which are all presumed to be transient resolve errors 1201 kinds.remove(JCDiagnostic.Kind.ERROR); 1202 } 1203 deferredDiagnosticHandler.reportDeferredDiagnostics(kinds); 1204 log.popDiagnosticHandler(deferredDiagnosticHandler); 1205 compiler.setDeferredDiagnosticHandler(null); 1206 } 1207 1208 /** Print info about this round. */ 1209 private void printRoundInfo(boolean lastRound) { 1210 if (printRounds || verbose) { 1211 List<ClassSymbol> tlc = lastRound ? List.<ClassSymbol>nil() : topLevelClasses; 1212 Set<TypeElement> ap = lastRound ? Collections.<TypeElement>emptySet() : annotationsPresent; 1213 log.printLines("x.print.rounds", 1214 number, 1215 "{" + tlc.toString(", ") + "}", 1216 ap, 1217 lastRound); 1218 } 1219 } 1220 1221 /** Prepare for new round of annotation processing. Cleans trees, resets symbols, and 1222 * asks selected services to prepare to a new round of annotation processing. 1223 */ 1224 private void newRound() { 1225 //ensure treesToClean contains all trees, including implicitly parsed ones 1226 for (Env<AttrContext> env : enter.getEnvs()) { 1227 treesToClean.add(env.toplevel); 1228 } 1229 for (JCCompilationUnit node : treesToClean) { 1230 treeCleaner.scan(node); 1231 } 1232 chk.newRound(); 1233 enter.newRound(); 1234 filer.newRound(); 1235 messager.newRound(); 1236 compiler.newRound(); 1237 modules.newRound(); 1238 types.newRound(); 1239 1240 boolean foundError = false; 1241 1242 for (ClassSymbol cs : symtab.getAllClasses()) { 1243 if (cs.kind == ERR) { 1244 foundError = true; 1245 break; 1246 } 1247 } 1248 1249 if (foundError) { 1250 for (ClassSymbol cs : symtab.getAllClasses()) { 1251 if (cs.classfile != null || cs.kind == ERR) { 1252 cs.reset(); 1253 cs.type = new ClassType(cs.type.getEnclosingType(), null, cs); 1254 if (cs.isCompleted()) { 1255 cs.completer = initialCompleter; 1256 } 1257 } 1258 } 1259 } 1260 } 1261 } 1262 1263 1264 // TODO: internal catch clauses?; catch and rethrow an annotation 1265 // processing error 1266 public boolean doProcessing(List<JCCompilationUnit> roots, 1267 List<ClassSymbol> classSymbols, 1268 Iterable<? extends PackageSymbol> pckSymbols, 1269 Log.DeferredDiagnosticHandler deferredDiagnosticHandler) { 1270 final Set<JCCompilationUnit> treesToClean = 1271 Collections.newSetFromMap(new IdentityHashMap<JCCompilationUnit, Boolean>()); 1272 1273 //fill already attributed implicit trees: 1274 for (Env<AttrContext> env : enter.getEnvs()) { 1275 treesToClean.add(env.toplevel); 1276 } 1277 1278 Set<PackageSymbol> specifiedPackages = new LinkedHashSet<>(); 1279 for (PackageSymbol psym : pckSymbols) 1280 specifiedPackages.add(psym); 1281 this.specifiedPackages = Collections.unmodifiableSet(specifiedPackages); 1282 1283 Round round = new Round(roots, classSymbols, treesToClean, deferredDiagnosticHandler); 1284 1285 boolean errorStatus; 1286 boolean moreToDo; 1287 do { 1288 // Run processors for round n 1289 round.run(false, false); 1290 1291 // Processors for round n have run to completion. 1292 // Check for errors and whether there is more work to do. 1293 errorStatus = round.unrecoverableError(); 1294 moreToDo = moreToDo(); 1295 1296 round.showDiagnostics(errorStatus || showResolveErrors); 1297 1298 // Set up next round. 1299 // Copy mutable collections returned from filer. 1300 round = round.next( 1301 new LinkedHashSet<>(filer.getGeneratedSourceFileObjects()), 1302 new LinkedHashMap<>(filer.getGeneratedClasses())); 1303 1304 // Check for errors during setup. 1305 if (round.unrecoverableError()) 1306 errorStatus = true; 1307 1308 } while (moreToDo && !errorStatus); 1309 1310 // run last round 1311 round.run(true, errorStatus); 1312 round.showDiagnostics(true); 1313 1314 filer.warnIfUnclosedFiles(); 1315 warnIfUnmatchedOptions(); 1316 1317 /* 1318 * If an annotation processor raises an error in a round, 1319 * that round runs to completion and one last round occurs. 1320 * The last round may also occur because no more source or 1321 * class files have been generated. Therefore, if an error 1322 * was raised on either of the last *two* rounds, the compile 1323 * should exit with a nonzero exit code. The current value of 1324 * errorStatus holds whether or not an error was raised on the 1325 * second to last round; errorRaised() gives the error status 1326 * of the last round. 1327 */ 1328 if (messager.errorRaised() 1329 || werror && round.warningCount() > 0 && round.errorCount() > 0) 1330 errorStatus = true; 1331 1332 Set<JavaFileObject> newSourceFiles = 1333 new LinkedHashSet<>(filer.getGeneratedSourceFileObjects()); 1334 roots = round.roots; 1335 1336 errorStatus = errorStatus || (compiler.errorCount() > 0); 1337 1338 if (!errorStatus) 1339 round.finalCompiler(); 1340 1341 if (newSourceFiles.size() > 0) 1342 roots = roots.appendList(compiler.parseFiles(newSourceFiles)); 1343 1344 errorStatus = errorStatus || (compiler.errorCount() > 0); 1345 1346 // Free resources 1347 this.close(); 1348 1349 if (!taskListener.isEmpty()) 1350 taskListener.finished(new TaskEvent(TaskEvent.Kind.ANNOTATION_PROCESSING)); 1351 1352 if (errorStatus) { 1353 if (compiler.errorCount() == 0) 1354 compiler.log.nerrors++; 1355 return true; 1356 } 1357 1358 compiler.enterTreesIfNeeded(roots); 1359 1360 return true; 1361 } 1362 1363 private void warnIfUnmatchedOptions() { 1364 if (!unmatchedProcessorOptions.isEmpty()) { 1365 log.warning("proc.unmatched.processor.options", unmatchedProcessorOptions.toString()); 1366 } 1367 } 1368 1369 /** 1370 * Free resources related to annotation processing. 1371 */ 1372 public void close() { 1373 filer.close(); 1374 if (discoveredProcs != null) // Make calling close idempotent 1375 discoveredProcs.close(); 1376 discoveredProcs = null; 1377 } 1378 1379 private List<ClassSymbol> getTopLevelClasses(List<? extends JCCompilationUnit> units) { 1380 List<ClassSymbol> classes = List.nil(); 1381 for (JCCompilationUnit unit : units) { 1382 for (JCTree node : unit.defs) { 1383 if (node.hasTag(JCTree.Tag.CLASSDEF)) { 1384 ClassSymbol sym = ((JCClassDecl) node).sym; 1385 Assert.checkNonNull(sym); 1386 classes = classes.prepend(sym); 1387 } 1388 } 1389 } 1390 return classes.reverse(); 1391 } 1392 1393 private List<ClassSymbol> getTopLevelClassesFromClasses(List<? extends ClassSymbol> syms) { 1394 List<ClassSymbol> classes = List.nil(); 1395 for (ClassSymbol sym : syms) { 1396 if (!isPkgInfo(sym)) { 1397 classes = classes.prepend(sym); 1398 } 1399 } 1400 return classes.reverse(); 1401 } 1402 1403 private List<PackageSymbol> getPackageInfoFiles(List<? extends JCCompilationUnit> units) { 1404 List<PackageSymbol> packages = List.nil(); 1405 for (JCCompilationUnit unit : units) { 1406 if (isPkgInfo(unit.sourcefile, JavaFileObject.Kind.SOURCE)) { 1407 packages = packages.prepend(unit.packge); 1408 } 1409 } 1410 return packages.reverse(); 1411 } 1412 1413 private List<PackageSymbol> getPackageInfoFilesFromClasses(List<? extends ClassSymbol> syms) { 1414 List<PackageSymbol> packages = List.nil(); 1415 for (ClassSymbol sym : syms) { 1416 if (isPkgInfo(sym)) { 1417 packages = packages.prepend((PackageSymbol) sym.owner); 1418 } 1419 } 1420 return packages.reverse(); 1421 } 1422 1423 // avoid unchecked warning from use of varargs 1424 private static <T> List<T> join(List<T> list1, List<T> list2) { 1425 return list1.appendList(list2); 1426 } 1427 1428 private boolean isPkgInfo(JavaFileObject fo, JavaFileObject.Kind kind) { 1429 return fo.isNameCompatible("package-info", kind); 1430 } 1431 1432 private boolean isPkgInfo(ClassSymbol sym) { 1433 return isPkgInfo(sym.classfile, JavaFileObject.Kind.CLASS) && (sym.packge().package_info == sym); 1434 } 1435 1436 /* 1437 * Called retroactively to determine if a class loader was required, 1438 * after we have failed to create one. 1439 */ 1440 private boolean needClassLoader(String procNames, Iterable<? extends Path> workingpath) { 1441 if (procNames != null) 1442 return true; 1443 1444 URL[] urls = new URL[1]; 1445 for(Path pathElement : workingpath) { 1446 try { 1447 urls[0] = pathElement.toUri().toURL(); 1448 if (ServiceProxy.hasService(Processor.class, urls)) 1449 return true; 1450 } catch (MalformedURLException ex) { 1451 throw new AssertionError(ex); 1452 } 1453 catch (ServiceProxy.ServiceConfigurationError e) { 1454 log.error("proc.bad.config.file", e.getLocalizedMessage()); 1455 return true; 1456 } 1457 } 1458 1459 return false; 1460 } 1461 1462 class ImplicitCompleter implements Completer { 1463 1464 private final JCCompilationUnit topLevel; 1465 1466 public ImplicitCompleter(JCCompilationUnit topLevel) { 1467 this.topLevel = topLevel; 1468 } 1469 1470 @Override public void complete(Symbol sym) throws CompletionFailure { 1471 compiler.readSourceFile(topLevel, (ClassSymbol) sym); 1472 } 1473 } 1474 1475 private final TreeScanner treeCleaner = new TreeScanner() { 1476 public void scan(JCTree node) { 1477 super.scan(node); 1478 if (node != null) 1479 node.type = null; 1480 } 1481 JCCompilationUnit topLevel; 1482 public void visitTopLevel(JCCompilationUnit node) { 1483 if (node.packge != null) { 1484 if (node.packge.package_info != null) { 1485 node.packge.package_info.reset(); 1486 } 1487 node.packge.reset(); 1488 } 1489 boolean isModuleInfo = node.sourcefile.isNameCompatible("module-info", Kind.SOURCE); 1490 if (isModuleInfo) { 1491 node.modle.reset(); 1492 node.modle.completer = sym -> modules.enter(List.of(node), node.modle.module_info); 1493 node.modle.module_info.reset(); 1494 node.modle.module_info.members_field = WriteableScope.create(node.modle.module_info); 1495 } 1496 node.packge = null; 1497 topLevel = node; 1498 try { 1499 super.visitTopLevel(node); 1500 } finally { 1501 topLevel = null; 1502 } 1503 } 1504 public void visitClassDef(JCClassDecl node) { 1505 if (node.sym != null) { 1506 node.sym.reset(); 1507 node.sym.completer = new ImplicitCompleter(topLevel); 1508 } 1509 node.sym = null; 1510 super.visitClassDef(node); 1511 } 1512 public void visitMethodDef(JCMethodDecl node) { 1513 node.sym = null; 1514 super.visitMethodDef(node); 1515 } 1516 public void visitVarDef(JCVariableDecl node) { 1517 node.sym = null; 1518 super.visitVarDef(node); 1519 } 1520 public void visitNewClass(JCNewClass node) { 1521 node.constructor = null; 1522 super.visitNewClass(node); 1523 } 1524 public void visitAssignop(JCAssignOp node) { 1525 node.operator = null; 1526 super.visitAssignop(node); 1527 } 1528 public void visitUnary(JCUnary node) { 1529 node.operator = null; 1530 super.visitUnary(node); 1531 } 1532 public void visitBinary(JCBinary node) { 1533 node.operator = null; 1534 super.visitBinary(node); 1535 } 1536 public void visitSelect(JCFieldAccess node) { 1537 node.sym = null; 1538 super.visitSelect(node); 1539 } 1540 public void visitIdent(JCIdent node) { 1541 node.sym = null; 1542 super.visitIdent(node); 1543 } 1544 public void visitAnnotation(JCAnnotation node) { 1545 node.attribute = null; 1546 super.visitAnnotation(node); 1547 } 1548 }; 1549 1550 1551 private boolean moreToDo() { 1552 return filer.newFiles(); 1553 } 1554 1555 /** 1556 * {@inheritDoc} 1557 * 1558 * Command line options suitable for presenting to annotation 1559 * processors. 1560 * {@literal "-Afoo=bar"} should be {@literal "-Afoo" => "bar"}. 1561 */ 1562 @DefinedBy(Api.ANNOTATION_PROCESSING) 1563 public Map<String,String> getOptions() { 1564 return processorOptions; 1565 } 1566 1567 @DefinedBy(Api.ANNOTATION_PROCESSING) 1568 public Messager getMessager() { 1569 return messager; 1570 } 1571 1572 @DefinedBy(Api.ANNOTATION_PROCESSING) 1573 public Filer getFiler() { 1574 return filer; 1575 } 1576 1577 @DefinedBy(Api.ANNOTATION_PROCESSING) 1578 public JavacElements getElementUtils() { 1579 return elementUtils; 1580 } 1581 1582 @DefinedBy(Api.ANNOTATION_PROCESSING) 1583 public JavacTypes getTypeUtils() { 1584 return typeUtils; 1585 } 1586 1587 @DefinedBy(Api.ANNOTATION_PROCESSING) 1588 public SourceVersion getSourceVersion() { 1589 return Source.toSourceVersion(source); 1590 } 1591 1592 @DefinedBy(Api.ANNOTATION_PROCESSING) 1593 public Locale getLocale() { 1594 return messages.getCurrentLocale(); 1595 } 1596 1597 public Set<Symbol.PackageSymbol> getSpecifiedPackages() { 1598 return specifiedPackages; 1599 } 1600 1601 public static final Pattern noMatches = Pattern.compile("(\\P{all})+"); 1602 1603 /** 1604 * Convert import-style string for supported annotations into a 1605 * regex matching that string. If the string is a valid 1606 * import-style string, return a regex that won't match anything. 1607 */ 1608 private static Pattern importStringToPattern(String s, Processor p, Log log) { 1609 if (MatchingUtils.isValidImportString(s)) { 1610 return MatchingUtils.validImportStringToPattern(s); 1611 } else { 1612 log.warning("proc.malformed.supported.string", s, p.getClass().getName()); 1613 return noMatches; // won't match any valid identifier 1614 } 1615 } 1616 1617 /** 1618 * For internal use only. This method may be removed without warning. 1619 */ 1620 public Context getContext() { 1621 return context; 1622 } 1623 1624 /** 1625 * For internal use only. This method may be removed without warning. 1626 */ 1627 public ClassLoader getProcessorClassLoader() { 1628 return processorClassLoader; 1629 } 1630 1631 public String toString() { 1632 return "javac ProcessingEnvironment"; 1633 } 1634 1635 public static boolean isValidOptionName(String optionName) { 1636 for(String s : optionName.split("\\.", -1)) { 1637 if (!SourceVersion.isIdentifier(s)) 1638 return false; 1639 } 1640 return true; 1641 } 1642} 1643