/*

 * 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 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;

/**

 * Objects of this class hold and manage the state needed to support

 * annotation processing.

 *

 * <p><b>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.</b>

 */

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<String, String> processorOptions;

    /**

     */

    private final Set<String> unmatchedProcessorOptions;

    /**

     * Annotations implicitly processed and claimed by javac.

     */

    private final Set<String> platformAnnotations;

    /**

     * Set of packages given on command line.

     */

    private Set<PackageSymbol> 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<? extends Processor> 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<String> initPlatformAnnotations() {

        Set<String> platformAnnotations = new HashSet<String>();

        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<? extends Processor> processors) {

        Paths paths = Paths.instance(context);

        Log   log   = Log.instance(context);

        Iterator<? extends Processor> 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<Processor> handleServiceLoaderUnavailability(String key, Exception e) {

        JavaFileManager fileManager = context.get(JavaFileManager.class);

        if (fileManager instanceof JavacFileManager) {

            StandardJavaFileManager standardFileManager = (JavacFileManager) fileManager;

            Iterable<? extends File> 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<Processor> 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<Processor> {

        // 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> {

        Processor nextProc = null;

        Iterator<String> 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<String, String> initProcessorOptions(Context context) {

        Options options = Options.instance(context);

        Set<String> keySet = options.keySet();

        Map<String, String> tempOptions = new LinkedHashMap<String, String>();

        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<String> initUnmatchedProcessorOptions() {

        Set<String> unmatchedProcessorOptions = new HashSet<String>();

        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<Pattern> supportedAnnotationPatterns;

        private ArrayList<String>  supportedOptionNames;

        ProcessorState(Processor p, Log log, Source source, ProcessingEnvironment env) {

            processor = p;

            contributed = false;

            try {

                processor.init(env);

                checkSourceVersionCompatibility(source, log);

                supportedAnnotationPatterns = new ArrayList<Pattern>();

                for (String importString : processor.getSupportedAnnotationTypes()) {

                    supportedAnnotationPatterns.add(importStringToPattern(importString,

                                                                          processor,

                                                                          log));

                }

                supportedOptionNames = new ArrayList<String>();

                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;