diff -r fd16c54261b3 -r 06bc494ca11e langtools/src/share/classes/com/sun/tools/javac/processing/JavacProcessingEnvironment.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/langtools/src/share/classes/com/sun/tools/javac/processing/JavacProcessingEnvironment.java Sat Dec 01 00:00:00 2007 +0000 @@ -0,0 +1,1387 @@ +/* + * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Sun designates this + * particular file as subject to the "Classpath" exception as provided + * by Sun in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, + * CA 95054 USA or visit www.sun.com if you need additional information or + * have any questions. + */ + +package com.sun.tools.javac.processing; + +import com.sun.source.util.TaskEvent; +import com.sun.source.util.TaskListener; +import com.sun.tools.javac.api.JavacTaskImpl; +import com.sun.tools.javac.util.List; +import com.sun.tools.javac.util.*; +import com.sun.tools.javac.code.*; +import com.sun.tools.javac.code.Symbol.*; +import com.sun.tools.javac.comp.*; +import com.sun.tools.javac.jvm.*; +import com.sun.tools.javac.tree.*; +import com.sun.tools.javac.parser.*; +import com.sun.tools.javac.code.Symbol.*; +import com.sun.tools.javac.model.JavacElements; +import com.sun.tools.javac.model.JavacTypes; +import com.sun.tools.javac.tree.JCTree.*; +import com.sun.tools.javac.main.JavaCompiler; +import java.io.StringWriter; + +import javax.annotation.processing.*; +import javax.lang.model.SourceVersion; +import javax.lang.model.element.AnnotationMirror; +import javax.lang.model.element.Element; +import javax.lang.model.element.TypeElement; +import javax.lang.model.element.PackageElement; +import javax.lang.model.util.*; + +import javax.tools.JavaFileManager; +import javax.tools.StandardJavaFileManager; +import javax.tools.JavaFileObject; +import javax.tools.DiagnosticListener; +import static javax.tools.StandardLocation.*; + +import java.lang.reflect.*; +import java.util.*; +import java.util.regex.*; + +import java.net.URLClassLoader; +import java.net.URL; +import java.io.Closeable; +import java.io.File; +import java.io.PrintWriter; +import java.io.IOException; +import java.net.MalformedURLException; + +/** + * Objects of this class hold and manage the state needed to support + * annotation processing. + * + *

This is NOT part of any API supported by Sun Microsystems. + * If you write code that depends on this, you do so at your own risk. + * This code and its internal interfaces are subject to change or + * deletion without notice. + */ +public class JavacProcessingEnvironment implements ProcessingEnvironment, Closeable { + Options options; + + private final boolean printProcessorInfo; + private final boolean printRounds; + private final boolean verbose; + private final boolean lint; + private final boolean procOnly; + private final boolean fatalErrors; + + private final JavacFiler filer; + private final JavacMessager messager; + private final JavacElements elementUtils; + private final JavacTypes typeUtils; + + /** + * Holds relevant state history of which processors have been + * used. + */ + private DiscoveredProcessors discoveredProcs; + + /** + * Map of processor-specific options. + */ + private final Map processorOptions; + + /** + */ + private final Set unmatchedProcessorOptions; + + /** + * Annotations implicitly processed and claimed by javac. + */ + private final Set platformAnnotations; + + /** + * Set of packages given on command line. + */ + private Set specifiedPackages = Collections.emptySet(); + + /** The log to be used for error reporting. + */ + Log log; + + /** + * Source level of the compile. + */ + Source source; + + private Context context; + + public JavacProcessingEnvironment(Context context, Iterable processors) { + options = Options.instance(context); + this.context = context; + log = Log.instance(context); + source = Source.instance(context); + printProcessorInfo = options.get("-XprintProcessorInfo") != null; + printRounds = options.get("-XprintRounds") != null; + verbose = options.get("-verbose") != null; + lint = options.lint("processing"); + procOnly = options.get("-proc:only") != null || + options.get("-Xprint") != null; + fatalErrors = options.get("fatalEnterError") != null; + platformAnnotations = initPlatformAnnotations(); + + // Initialize services before any processors are initialzied + // in case processors use them. + filer = new JavacFiler(context); + messager = new JavacMessager(context, this); + elementUtils = new JavacElements(context); + typeUtils = new JavacTypes(context); + processorOptions = initProcessorOptions(context); + unmatchedProcessorOptions = initUnmatchedProcessorOptions(); + initProcessorIterator(context, processors); + } + + private Set initPlatformAnnotations() { + Set platformAnnotations = new HashSet(); + platformAnnotations.add("java.lang.Deprecated"); + platformAnnotations.add("java.lang.Override"); + platformAnnotations.add("java.lang.SuppressWarnings"); + platformAnnotations.add("java.lang.annotation.Documented"); + platformAnnotations.add("java.lang.annotation.Inherited"); + platformAnnotations.add("java.lang.annotation.Retention"); + platformAnnotations.add("java.lang.annotation.Target"); + return Collections.unmodifiableSet(platformAnnotations); + } + + private void initProcessorIterator(Context context, Iterable processors) { + Paths paths = Paths.instance(context); + Log log = Log.instance(context); + Iterator processorIterator; + + if (options.get("-Xprint") != null) { + try { + Processor processor = PrintingProcessor.class.newInstance(); + processorIterator = List.of(processor).iterator(); + } catch (Throwable t) { + AssertionError assertError = + new AssertionError("Problem instantiating PrintingProcessor."); + assertError.initCause(t); + throw assertError; + } + } else if (processors != null) { + processorIterator = processors.iterator(); + } else { + String processorNames = options.get("-processor"); + JavaFileManager fileManager = context.get(JavaFileManager.class); + try { + // If processorpath is not explicitly set, use the classpath. + ClassLoader processorCL = fileManager.hasLocation(ANNOTATION_PROCESSOR_PATH) + ? fileManager.getClassLoader(ANNOTATION_PROCESSOR_PATH) + : fileManager.getClassLoader(CLASS_PATH); + + /* + * If the "-processor" option is used, search the appropriate + * path for the named class. Otherwise, use a service + * provider mechanism to create the processor iterator. + */ + if (processorNames != null) { + processorIterator = new NameProcessIterator(processorNames, processorCL, log); + } else { + processorIterator = new ServiceIterator(processorCL, log); + } + } catch (SecurityException e) { + /* + * A security exception will occur if we can't create a classloader. + * Ignore the exception if, with hindsight, we didn't need it anyway + * (i.e. no processor was specified either explicitly, or implicitly, + * in service configuration file.) Otherwise, we cannot continue. + */ + processorIterator = handleServiceLoaderUnavailability("proc.cant.create.loader", e); + } + } + discoveredProcs = new DiscoveredProcessors(processorIterator); + } + + /** + * Returns an empty processor iterator if no processors are on the + * relevant path, otherwise if processors are present, logs an + * error. Called when a service loader is unavailable for some + * reason, either because a service loader class cannot be found + * or because a security policy prevents class loaders from being + * created. + * + * @param key The resource key to use to log an error message + * @param e If non-null, pass this exception to Abort + */ + private Iterator handleServiceLoaderUnavailability(String key, Exception e) { + JavaFileManager fileManager = context.get(JavaFileManager.class); + + if (fileManager instanceof JavacFileManager) { + StandardJavaFileManager standardFileManager = (JavacFileManager) fileManager; + Iterable workingPath = fileManager.hasLocation(ANNOTATION_PROCESSOR_PATH) + ? standardFileManager.getLocation(ANNOTATION_PROCESSOR_PATH) + : standardFileManager.getLocation(CLASS_PATH); + + if (needClassLoader(options.get("-processor"), workingPath) ) + handleException(key, e); + + } else { + handleException(key, e); + } + + java.util.List pl = Collections.emptyList(); + return pl.iterator(); + } + + /** + * Handle a security exception thrown during initializing the + * Processor iterator. + */ + private void handleException(String key, Exception e) { + if (e != null) { + log.error(key, e.getLocalizedMessage()); + throw new Abort(e); + } else { + log.error(key); + throw new Abort(); + } + } + + /** + * Use a service loader appropriate for the platform to provide an + * iterator over annotations processors. If + * java.util.ServiceLoader is present use it, otherwise, use + * sun.misc.Service, otherwise fail if a loader is needed. + */ + private class ServiceIterator implements Iterator { + // The to-be-wrapped iterator. + private Iterator iterator; + private Log log; + + ServiceIterator(ClassLoader classLoader, Log log) { + Class loaderClass; + String loadMethodName; + boolean jusl; + + this.log = log; + try { + try { + loaderClass = Class.forName("java.util.ServiceLoader"); + loadMethodName = "load"; + jusl = true; + } catch (ClassNotFoundException cnfe) { + try { + loaderClass = Class.forName("sun.misc.Service"); + loadMethodName = "providers"; + jusl = false; + } catch (ClassNotFoundException cnfe2) { + // Fail softly if a loader is not actually needed. + this.iterator = handleServiceLoaderUnavailability("proc.no.service", + null); + return; + } + } + + // java.util.ServiceLoader.load or sun.misc.Service.providers + Method loadMethod = loaderClass.getMethod(loadMethodName, + Class.class, + ClassLoader.class); + + Object result = loadMethod.invoke(null, + Processor.class, + classLoader); + + // For java.util.ServiceLoader, we have to call another + // method to get the iterator. + if (jusl) { + Method m = loaderClass.getMethod("iterator"); + result = m.invoke(result); // serviceLoader.iterator(); + } + + // The result should now be an iterator. + this.iterator = (Iterator) result; + } catch (Throwable t) { + log.error("proc.service.problem"); + throw new Abort(t); + } + } + + public boolean hasNext() { + try { + return iterator.hasNext(); + } catch (Throwable t) { + if ("ServiceConfigurationError". + equals(t.getClass().getSimpleName())) { + log.error("proc.bad.config.file", t.getLocalizedMessage()); + } + throw new Abort(t); + } + } + + public Processor next() { + try { + return (Processor)(iterator.next()); + } catch (Throwable t) { + if ("ServiceConfigurationError". + equals(t.getClass().getSimpleName())) { + log.error("proc.bad.config.file", t.getLocalizedMessage()); + } else { + log.error("proc.processor.constructor.error", t.getLocalizedMessage()); + } + throw new Abort(t); + } + } + + public void remove() { + throw new UnsupportedOperationException(); + } + } + + + private static class NameProcessIterator implements Iterator { + Processor nextProc = null; + Iterator names; + ClassLoader processorCL; + Log log; + + NameProcessIterator(String names, ClassLoader processorCL, Log log) { + this.names = Arrays.asList(names.split(",")).iterator(); + this.processorCL = processorCL; + this.log = log; + } + + public boolean hasNext() { + if (nextProc != null) + return true; + else { + if (!names.hasNext()) + return false; + else { + String processorName = names.next(); + + Processor processor; + try { + try { + processor = + (Processor) (processorCL.loadClass(processorName).newInstance()); + } catch (ClassNotFoundException cnfe) { + log.error("proc.processor.not.found", processorName); + return false; + } catch (ClassCastException cce) { + log.error("proc.processor.wrong.type", processorName); + return false; + } catch (Exception e ) { + log.error("proc.processor.cant.instantiate", processorName); + return false; + } + } catch(Throwable t) { + throw new AnnotationProcessingError(t); + } + nextProc = processor; + return true; + } + + } + } + + public Processor next() { + if (hasNext()) { + Processor p = nextProc; + nextProc = null; + return p; + } else + throw new NoSuchElementException(); + } + + public void remove () { + throw new UnsupportedOperationException(); + } + } + + public boolean atLeastOneProcessor() { + return discoveredProcs.iterator().hasNext(); + } + + private Map initProcessorOptions(Context context) { + Options options = Options.instance(context); + Set keySet = options.keySet(); + Map tempOptions = new LinkedHashMap(); + + for(String key : keySet) { + if (key.startsWith("-A") && key.length() > 2) { + int sepIndex = key.indexOf('='); + String candidateKey = null; + String candidateValue = null; + + if (sepIndex == -1) + candidateKey = key.substring(2); + else if (sepIndex >= 3) { + candidateKey = key.substring(2, sepIndex); + candidateValue = (sepIndex < key.length()-1)? + key.substring(sepIndex+1) : null; + } + tempOptions.put(candidateKey, candidateValue); + } + } + + return Collections.unmodifiableMap(tempOptions); + } + + private Set initUnmatchedProcessorOptions() { + Set unmatchedProcessorOptions = new HashSet(); + unmatchedProcessorOptions.addAll(processorOptions.keySet()); + return unmatchedProcessorOptions; + } + + /** + * State about how a processor has been used by the tool. If a + * processor has been used on a prior round, its process method is + * called on all subsequent rounds, perhaps with an empty set of + * annotations to process. The {@code annotatedSupported} method + * caches the supported annotation information from the first (and + * only) getSupportedAnnotationTypes call to the processor. + */ + static class ProcessorState { + public Processor processor; + public boolean contributed; + private ArrayList supportedAnnotationPatterns; + private ArrayList supportedOptionNames; + + ProcessorState(Processor p, Log log, Source source, ProcessingEnvironment env) { + processor = p; + contributed = false; + + try { + processor.init(env); + + checkSourceVersionCompatibility(source, log); + + supportedAnnotationPatterns = new ArrayList(); + for (String importString : processor.getSupportedAnnotationTypes()) { + supportedAnnotationPatterns.add(importStringToPattern(importString, + processor, + log)); + } + + supportedOptionNames = new ArrayList(); + for (String optionName : processor.getSupportedOptions() ) { + if (checkOptionName(optionName, log)) + supportedOptionNames.add(optionName); + } + + } catch (Throwable t) { + throw new AnnotationProcessingError(t); + } + } + + /** + * Checks whether or not a processor's source version is + * compatible with the compilation source version. The + * processor's source version needs to be greater than or + * equal to the source version of the compile. + */ + private void checkSourceVersionCompatibility(Source source, Log log) { + SourceVersion procSourceVersion = processor.getSupportedSourceVersion(); + + if (procSourceVersion.compareTo(Source.toSourceVersion(source)) < 0 ) { + log.warning("proc.processor.incompatible.source.version", + procSourceVersion, + processor.getClass().getName(), + source.name); + } + } + + private boolean checkOptionName(String optionName, Log log) { + boolean valid = isValidOptionName(optionName); + if (!valid) + log.error("proc.processor.bad.option.name", + optionName, + processor.getClass().getName()); + return valid; + } + + public boolean annotationSupported(String annotationName) { + for(Pattern p: supportedAnnotationPatterns) { + if (p.matcher(annotationName).matches()) + return true; + } + return false; + } + + /** + * Remove options that are matched by this processor. + */ + public void removeSupportedOptions(Set unmatchedProcessorOptions) { + unmatchedProcessorOptions.removeAll(supportedOptionNames); + } + } + + // TODO: These two classes can probably be rewritten better... + /** + * This class holds information about the processors that have + * been discoverd so far as well as the means to discover more, if + * necessary. A single iterator should be used per round of + * annotation processing. The iterator first visits already + * discovered processors then fails over to the service provided + * mechanism if additional queries are made. + */ + class DiscoveredProcessors implements Iterable { + + class ProcessorStateIterator implements Iterator { + DiscoveredProcessors psi; + Iterator innerIter; + boolean onProcInterator; + + ProcessorStateIterator(DiscoveredProcessors psi) { + this.psi = psi; + this.innerIter = psi.procStateList.iterator(); + this.onProcInterator = false; + } + + public ProcessorState next() { + if (!onProcInterator) { + if (innerIter.hasNext()) + return innerIter.next(); + else + onProcInterator = true; + } + + if (psi.processorIterator.hasNext()) { + ProcessorState ps = new ProcessorState(psi.processorIterator.next(), + log, source, JavacProcessingEnvironment.this); + psi.procStateList.add(ps); + return ps; + } else + throw new NoSuchElementException(); + } + + public boolean hasNext() { + if (onProcInterator) + return psi.processorIterator.hasNext(); + else + return innerIter.hasNext() || psi.processorIterator.hasNext(); + } + + public void remove () { + throw new UnsupportedOperationException(); + } + + /** + * Run all remaining processors on the procStateList that + * have not already run this round with an empty set of + * annotations. + */ + public void runContributingProcs(RoundEnvironment re) { + if (!onProcInterator) { + Set emptyTypeElements = Collections.emptySet(); + while(innerIter.hasNext()) { + ProcessorState ps = innerIter.next(); + if (ps.contributed) + callProcessor(ps.processor, emptyTypeElements, re); + } + } + } + } + + Iterator processorIterator; + ArrayList procStateList; + + public ProcessorStateIterator iterator() { + return new ProcessorStateIterator(this); + } + + DiscoveredProcessors(Iterator processorIterator) { + this.processorIterator = processorIterator; + this.procStateList = new ArrayList(); + } + } + + private void discoverAndRunProcs(Context context, + Set annotationsPresent, + List topLevelClasses, + List packageInfoFiles) { + // Writer for -XprintRounds and -XprintProcessorInfo data + PrintWriter xout = context.get(Log.outKey); + + Map unmatchedAnnotations = + new HashMap(annotationsPresent.size()); + + for(TypeElement a : annotationsPresent) { + unmatchedAnnotations.put(a.getQualifiedName().toString(), + a); + } + + // Give "*" processors a chance to match + if (unmatchedAnnotations.size() == 0) + unmatchedAnnotations.put("", null); + + DiscoveredProcessors.ProcessorStateIterator psi = discoveredProcs.iterator(); + // TODO: Create proper argument values; need past round + // information to fill in this constructor. Note that the 1 + // st round of processing could be the last round if there + // were parse errors on the initial source files; however, we + // are not doing processing in that case. + + Set rootElements = new LinkedHashSet(); + rootElements.addAll(topLevelClasses); + rootElements.addAll(packageInfoFiles); + rootElements = Collections.unmodifiableSet(rootElements); + + RoundEnvironment renv = new JavacRoundEnvironment(false, + false, + rootElements, + JavacProcessingEnvironment.this); + + while(unmatchedAnnotations.size() > 0 && psi.hasNext() ) { + ProcessorState ps = psi.next(); + Set matchedNames = new HashSet(); + Set typeElements = new LinkedHashSet(); + for (String unmatchedAnnotationName : unmatchedAnnotations.keySet()) { + if (ps.annotationSupported(unmatchedAnnotationName) ) { + matchedNames.add(unmatchedAnnotationName); + TypeElement te = unmatchedAnnotations.get(unmatchedAnnotationName); + if (te != null) + typeElements.add(te); + } + } + + if (matchedNames.size() > 0 || ps.contributed) { + boolean processingResult = callProcessor(ps.processor, typeElements, renv); + ps.contributed = true; + ps.removeSupportedOptions(unmatchedProcessorOptions); + + if (printProcessorInfo || verbose) { + xout.println(Log.getLocalizedString("x.print.processor.info", + ps.processor.getClass().getName(), + matchedNames.toString(), + processingResult)); + } + + if (processingResult) { + unmatchedAnnotations.keySet().removeAll(matchedNames); + } + + } + } + unmatchedAnnotations.remove(""); + + if (lint && unmatchedAnnotations.size() > 0) { + // Remove annotations processed by javac + unmatchedAnnotations.keySet().removeAll(platformAnnotations); + if (unmatchedAnnotations.size() > 0) { + log = Log.instance(context); + log.warning("proc.annotations.without.processors", + unmatchedAnnotations.keySet()); + } + } + + // Run contributing processors that haven't run yet + psi.runContributingProcs(renv); + + // Debugging + if (options.get("displayFilerState") != null) + filer.displayState(); + } + + /** + * Computes the set of annotations on the symbol in question. + * Leave class public for external testing purposes. + */ + public static class ComputeAnnotationSet extends + ElementScanner6, Set> { + final Elements elements; + + public ComputeAnnotationSet(Elements elements) { + super(); + this.elements = elements; + } + + @Override + public Set visitPackage(PackageElement e, Set p) { + // Don't scan enclosed elements of a package + return p; + } + + @Override + public Set scan(Element e, Set p) { + for (AnnotationMirror annotationMirror : + elements.getAllAnnotationMirrors(e) ) { + Element e2 = annotationMirror.getAnnotationType().asElement(); + p.add((TypeElement) e2); + } + return super.scan(e, p); + } + } + + private boolean callProcessor(Processor proc, + Set tes, + RoundEnvironment renv) { + try { + return proc.process(tes, renv); + } catch (CompletionFailure ex) { + StringWriter out = new StringWriter(); + ex.printStackTrace(new PrintWriter(out)); + log.error("proc.cant.access", ex.sym, ex.errmsg, out.toString()); + return false; + } catch (Throwable t) { + throw new AnnotationProcessingError(t); + } + } + + + // TODO: internal catch clauses?; catch and rethrow an annotation + // processing error + public JavaCompiler doProcessing(Context context, + List roots, + List classSymbols, + Iterable pckSymbols) + throws IOException { + + log = Log.instance(context); + // Writer for -XprintRounds and -XprintProcessorInfo data + PrintWriter xout = context.get(Log.outKey); + TaskListener taskListener = context.get(TaskListener.class); + + + AnnotationCollector collector = new AnnotationCollector(); + + JavaCompiler compiler = JavaCompiler.instance(context); + compiler.todo.clear(); // free the compiler's resources + + int round = 0; + + // List annotationsPresentInSource = collector.findAnnotations(roots); + List topLevelClasses = getTopLevelClasses(roots); + + for (ClassSymbol classSym : classSymbols) + topLevelClasses = topLevelClasses.prepend(classSym); + List packageInfoFiles = + getPackageInfoFiles(roots); + + Set specifiedPackages = new LinkedHashSet(); + for (PackageSymbol psym : pckSymbols) + specifiedPackages.add(psym); + this.specifiedPackages = Collections.unmodifiableSet(specifiedPackages); + + // Use annotation processing to compute the set of annotations present + Set annotationsPresent = new LinkedHashSet(); + ComputeAnnotationSet annotationComputer = new ComputeAnnotationSet(elementUtils); + for (ClassSymbol classSym : topLevelClasses) + annotationComputer.scan(classSym, annotationsPresent); + for (PackageSymbol pkgSym : packageInfoFiles) + annotationComputer.scan(pkgSym, annotationsPresent); + + Context currentContext = context; + + int roundNumber = 0; + boolean errorStatus = false; + + runAround: + while(true) { + if (fatalErrors && compiler.errorCount() != 0) { + errorStatus = true; + break runAround; + } + + this.context = currentContext; + roundNumber++; + printRoundInfo(xout, roundNumber, topLevelClasses, annotationsPresent, false); + + if (taskListener != null) + taskListener.started(new TaskEvent(TaskEvent.Kind.ANNOTATION_PROCESSING_ROUND)); + + try { + discoverAndRunProcs(currentContext, annotationsPresent, topLevelClasses, packageInfoFiles); + } finally { + if (taskListener != null) + taskListener.finished(new TaskEvent(TaskEvent.Kind.ANNOTATION_PROCESSING_ROUND)); + } + + /* + * Processors for round n have run to completion. Prepare + * for round (n+1) by checked for errors raised by + * annotation processors and then checking for syntax + * errors on any generated source files. + */ + if (messager.errorRaised()) { + errorStatus = true; + break runAround; + } else { + if (moreToDo()) { + // annotationsPresentInSource = List.nil(); + annotationsPresent = new LinkedHashSet(); + topLevelClasses = List.nil(); + packageInfoFiles = List.nil(); + + compiler.close(); + currentContext = contextForNextRound(currentContext, true); + + JavaFileManager fileManager = currentContext.get(JavaFileManager.class); + + List fileObjects = List.nil(); + for (JavaFileObject jfo : filer.getGeneratedSourceFileObjects() ) { + fileObjects = fileObjects.prepend(jfo); + } + + + compiler = JavaCompiler.instance(currentContext); + List parsedFiles = compiler.parseFiles(fileObjects); + roots = cleanTrees(roots).reverse(); + + + for (JCCompilationUnit unit : parsedFiles) + roots = roots.prepend(unit); + roots = roots.reverse(); + + // Check for errors after parsing + if (compiler.parseErrors()) { + errorStatus = true; + break runAround; + } else { + ListBuffer classes = enterNewClassFiles(currentContext); + compiler.enterTrees(roots); + + // annotationsPresentInSource = + // collector.findAnnotations(parsedFiles); + classes.appendList(getTopLevelClasses(parsedFiles)); + topLevelClasses = classes.toList(); + packageInfoFiles = getPackageInfoFiles(parsedFiles); + + annotationsPresent = new LinkedHashSet(); + for (ClassSymbol classSym : topLevelClasses) + annotationComputer.scan(classSym, annotationsPresent); + for (PackageSymbol pkgSym : packageInfoFiles) + annotationComputer.scan(pkgSym, annotationsPresent); + + updateProcessingState(currentContext, false); + } + } else + break runAround; // No new files + } + } + runLastRound(xout, roundNumber, errorStatus, taskListener); + + compiler.close(); + currentContext = contextForNextRound(currentContext, true); + compiler = JavaCompiler.instance(currentContext); + filer.newRound(currentContext, true); + filer.warnIfUnclosedFiles(); + warnIfUnmatchedOptions(); + + /* + * If an annotation processor raises an error in a round, + * that round runs to completion and one last round occurs. + * The last round may also occur because no more source or + * class files have been generated. Therefore, if an error + * was raised on either of the last *two* rounds, the compile + * should exit with a nonzero exit code. The current value of + * errorStatus holds whether or not an error was raised on the + * second to last round; errorRaised() gives the error status + * of the last round. + */ + errorStatus = errorStatus || messager.errorRaised(); + + + // Free resources + this.close(); + + if (taskListener != null) + taskListener.finished(new TaskEvent(TaskEvent.Kind.ANNOTATION_PROCESSING)); + + if (errorStatus) { + compiler.log.nerrors += messager.errorCount(); + if (compiler.errorCount() == 0) + compiler.log.nerrors++; + } else if (procOnly) { + compiler.todo.clear(); + } else { // Final compilation + compiler.close(); + currentContext = contextForNextRound(currentContext, true); + compiler = JavaCompiler.instance(currentContext); + + if (true) { + compiler.enterTrees(cleanTrees(roots)); + } else { + List fileObjects = List.nil(); + for (JCCompilationUnit unit : roots) + fileObjects = fileObjects.prepend(unit.getSourceFile()); + roots = null; + compiler.enterTrees(compiler.parseFiles(fileObjects.reverse())); + } + } + + return compiler; + } + + // Call the last round of annotation processing + private void runLastRound(PrintWriter xout, + int roundNumber, + boolean errorStatus, + TaskListener taskListener) throws IOException { + roundNumber++; + List noTopLevelClasses = List.nil(); + Set noAnnotations = Collections.emptySet(); + printRoundInfo(xout, roundNumber, noTopLevelClasses, noAnnotations, true); + + Set emptyRootElements = Collections.emptySet(); // immutable + RoundEnvironment renv = new JavacRoundEnvironment(true, + errorStatus, + emptyRootElements, + JavacProcessingEnvironment.this); + if (taskListener != null) + taskListener.started(new TaskEvent(TaskEvent.Kind.ANNOTATION_PROCESSING_ROUND)); + + try { + discoveredProcs.iterator().runContributingProcs(renv); + } finally { + if (taskListener != null) + taskListener.finished(new TaskEvent(TaskEvent.Kind.ANNOTATION_PROCESSING_ROUND)); + } + } + + private void updateProcessingState(Context currentContext, boolean lastRound) { + filer.newRound(currentContext, lastRound); + messager.newRound(currentContext); + + elementUtils.setContext(currentContext); + typeUtils.setContext(currentContext); + } + + private void warnIfUnmatchedOptions() { + if (!unmatchedProcessorOptions.isEmpty()) { + log.warning("proc.unmatched.processor.options", unmatchedProcessorOptions.toString()); + } + } + + private void printRoundInfo(PrintWriter xout, + int roundNumber, + List topLevelClasses, + Set annotationsPresent, + boolean lastRound) { + if (printRounds || verbose) { + xout.println(Log.getLocalizedString("x.print.rounds", + roundNumber, + "{" + topLevelClasses.toString(", ") + "}", + annotationsPresent, + lastRound)); + } + } + + private ListBuffer enterNewClassFiles(Context currentContext) { + ClassReader reader = ClassReader.instance(currentContext); + Name.Table names = Name.Table.instance(currentContext); + ListBuffer list = new ListBuffer(); + + for (Map.Entry entry : filer.getGeneratedClasses().entrySet()) { + Name name = names.fromString(entry.getKey()); + JavaFileObject file = entry.getValue(); + if (file.getKind() != JavaFileObject.Kind.CLASS) + throw new AssertionError(file); + ClassSymbol cs = reader.enterClass(name, file); + list.append(cs); + } + return list; + } + + /** + * Free resources related to annotation processing. + */ + public void close() { + filer.close(); + discoveredProcs = null; + } + + private List getTopLevelClasses(List units) { + List classes = List.nil(); + for (JCCompilationUnit unit : units) { + for (JCTree node : unit.defs) { + if (node.getTag() == JCTree.CLASSDEF) { + classes = classes.prepend(((JCClassDecl) node).sym); + } + } + } + return classes.reverse(); + } + + private List getPackageInfoFiles(List units) { + List packages = List.nil(); + for (JCCompilationUnit unit : units) { + boolean isPkgInfo = unit.sourcefile.isNameCompatible("package-info", + JavaFileObject.Kind.SOURCE); + if (isPkgInfo) { + packages = packages.prepend(unit.packge); + } + } + return packages.reverse(); + } + + private Context contextForNextRound(Context context, boolean shareNames) + throws IOException + { + Context next = new Context(); + + Options options = Options.instance(context); + assert options != null; + next.put(Options.optionsKey, options); + + PrintWriter out = context.get(Log.outKey); + assert out != null; + next.put(Log.outKey, out); + + if (shareNames) { + Name.Table names = Name.Table.instance(context); + assert names != null; + next.put(Name.Table.namesKey, names); + } + + DiagnosticListener dl = context.get(DiagnosticListener.class); + if (dl != null) + next.put(DiagnosticListener.class, dl); + + TaskListener tl = context.get(TaskListener.class); + if (tl != null) + next.put(TaskListener.class, tl); + + JavaFileManager jfm = context.get(JavaFileManager.class); + assert jfm != null; + next.put(JavaFileManager.class, jfm); + if (jfm instanceof JavacFileManager) { + ((JavacFileManager)jfm).setContext(next); + } + + Name.Table names = Name.Table.instance(context); + assert names != null; + next.put(Name.Table.namesKey, names); + + Keywords keywords = Keywords.instance(context); + assert(keywords != null); + next.put(Keywords.keywordsKey, keywords); + + JavaCompiler oldCompiler = JavaCompiler.instance(context); + JavaCompiler nextCompiler = JavaCompiler.instance(next); + nextCompiler.initRound(oldCompiler); + + JavacTaskImpl task = context.get(JavacTaskImpl.class); + if (task != null) { + next.put(JavacTaskImpl.class, task); + task.updateContext(next); + } + + context.clear(); + return next; + } + + /* + * Called retroactively to determine if a class loader was required, + * after we have failed to create one. + */ + private boolean needClassLoader(String procNames, Iterable workingpath) { + if (procNames != null) + return true; + + String procPath; + URL[] urls = new URL[1]; + for(File pathElement : workingpath) { + try { + urls[0] = pathElement.toURI().toURL(); + if (ServiceProxy.hasService(Processor.class, urls)) + return true; + } catch (MalformedURLException ex) { + throw new AssertionError(ex); + } + catch (ServiceProxy.ServiceConfigurationError e) { + log.error("proc.bad.config.file", e.getLocalizedMessage()); + return true; + } + } + + return false; + } + + private class AnnotationCollector extends TreeScanner { + List path = List.nil(); + static final boolean verbose = false; + List annotations = List.nil(); + + public List findAnnotations(List nodes) { + annotations = List.nil(); + scan(nodes); + List found = annotations; + annotations = List.nil(); + return found.reverse(); + } + + public void scan(JCTree node) { + if (node == null) + return; + Symbol sym = TreeInfo.symbolFor(node); + if (sym != null) + path = path.prepend(node); + super.scan(node); + if (sym != null) + path = path.tail; + } + + public void visitAnnotation(JCAnnotation node) { + annotations = annotations.prepend(node); + if (verbose) { + StringBuilder sb = new StringBuilder(); + for (JCTree tree : path.reverse()) { + System.err.print(sb); + System.err.println(TreeInfo.symbolFor(tree)); + sb.append(" "); + } + System.err.print(sb); + System.err.println(node); + } + } + } + + private static List cleanTrees(List nodes) { + for (T node : nodes) + treeCleaner.scan(node); + return nodes; + } + + private static TreeScanner treeCleaner = new TreeScanner() { + public void scan(JCTree node) { + super.scan(node); + if (node != null) + node.type = null; + } + public void visitTopLevel(JCCompilationUnit node) { + node.packge = null; + super.visitTopLevel(node); + } + public void visitClassDef(JCClassDecl node) { + node.sym = null; + super.visitClassDef(node); + } + public void visitMethodDef(JCMethodDecl node) { + node.sym = null; + super.visitMethodDef(node); + } + public void visitVarDef(JCVariableDecl node) { + node.sym = null; + super.visitVarDef(node); + } + public void visitNewClass(JCNewClass node) { + node.constructor = null; + super.visitNewClass(node); + } + public void visitAssignop(JCAssignOp node) { + node.operator = null; + super.visitAssignop(node); + } + public void visitUnary(JCUnary node) { + node.operator = null; + super.visitUnary(node); + } + public void visitBinary(JCBinary node) { + node.operator = null; + super.visitBinary(node); + } + public void visitSelect(JCFieldAccess node) { + node.sym = null; + super.visitSelect(node); + } + public void visitIdent(JCIdent node) { + node.sym = null; + super.visitIdent(node); + } + }; + + + private boolean moreToDo() { + return filer.newFiles(); + } + + /** + * {@inheritdoc} + * + * Command line options suitable for presenting to annotation + * processors. "-Afoo=bar" should be "-Afoo" => "bar". + */ + public Map getOptions() { + return processorOptions; + } + + public Messager getMessager() { + return messager; + } + + public Filer getFiler() { + return filer; + } + + public JavacElements getElementUtils() { + return elementUtils; + } + + public JavacTypes getTypeUtils() { + return typeUtils; + } + + public SourceVersion getSourceVersion() { + return Source.toSourceVersion(source); + } + + public Locale getLocale() { + return Locale.getDefault(); + } + + public Set getSpecifiedPackages() { + return specifiedPackages; + } + + // Borrowed from DocletInvoker and apt + // TODO: remove from apt's Main + /** + * Utility method for converting a search path string to an array + * of directory and JAR file URLs. + * + * @param path the search path string + * @return the resulting array of directory and JAR file URLs + */ + public static URL[] pathToURLs(String path) { + StringTokenizer st = new StringTokenizer(path, File.pathSeparator); + URL[] urls = new URL[st.countTokens()]; + int count = 0; + while (st.hasMoreTokens()) { + URL url = fileToURL(new File(st.nextToken())); + if (url != null) { + urls[count++] = url; + } + } + if (urls.length != count) { + URL[] tmp = new URL[count]; + System.arraycopy(urls, 0, tmp, 0, count); + urls = tmp; + } + return urls; + } + + /** + * Returns the directory or JAR file URL corresponding to the specified + * local file name. + * + * @param file the File object + * @return the resulting directory or JAR file URL, or null if unknown + */ + private static URL fileToURL(File file) { + String name; + try { + name = file.getCanonicalPath(); + } catch (IOException e) { + name = file.getAbsolutePath(); + } + name = name.replace(File.separatorChar, '/'); + if (!name.startsWith("/")) { + name = "/" + name; + } + // If the file does not exist, then assume that it's a directory + if (!file.isFile()) { + name = name + "/"; + } + try { + return new URL("file", "", name); + } catch (MalformedURLException e) { + throw new IllegalArgumentException("file"); + } + } + + + + private static final Pattern allMatches = Pattern.compile(".*"); + + private static final Pattern noMatches = Pattern.compile("(\\P{all})+"); + /** + * Convert import-style string to regex matching that string. If + * the string is a valid import-style string, return a regex that + * won't match anything. + */ + // TODO: remove version in Apt.java + public static Pattern importStringToPattern(String s, Processor p, Log log) { + if (s.equals("*")) { + return allMatches; + } else { + String t = s; + boolean star = false; + + /* + * Validate string from factory is legal. If the string + * has more than one asterisks or the asterisks does not + * appear as the last character (preceded by a period), + * the string is not legal. + */ + + boolean valid = true; + int index = t.indexOf('*'); + if (index != -1) { + // '*' must be last character... + if (index == t.length() -1) { + // ... and preceeding character must be '.' + if ( index-1 >= 0 ) { + valid = t.charAt(index-1) == '.'; + // Strip off ".*$" for identifier checks + t = t.substring(0, t.length()-2); + } + } else + valid = false; + } + + // Verify string is off the form (javaId \.)+ or javaId + if (valid) { + String[] javaIds = t.split("\\.", t.length()+2); + for(String javaId: javaIds) + valid &= SourceVersion.isIdentifier(javaId); + } + + if (!valid) { + log.warning("proc.malformed.supported.string", s, p.getClass().getName()); + return noMatches; // won't match any valid identifier + } + + String s_prime = s.replaceAll("\\.", "\\\\."); + + if (s_prime.endsWith("*")) { + s_prime = s_prime.substring(0, s_prime.length() - 1) + ".+"; + } + + return Pattern.compile(s_prime); + } + } + + /** + * For internal use by Sun Microsystems only. This method will be + * removed without warning. + */ + public Context getContext() { + return context; + } + + public String toString() { + return "javac ProcessingEnvironment"; + } + + public static boolean isValidOptionName(String optionName) { + for(String s : optionName.split("\\.", -1)) { + if (!SourceVersion.isIdentifier(s)) + return false; + } + return true; + } +}