0N/A/*
815N/A * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
553N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
553N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
553N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
553N/A * or visit www.oracle.com if you need additional information or have any
553N/A * questions.
0N/A */
0N/A
0N/Apackage javax.tools;
0N/A
0N/Aimport java.io.File;
658N/Aimport java.lang.ref.Reference;
658N/Aimport java.lang.ref.WeakReference;
0N/Aimport java.net.URL;
0N/Aimport java.net.URLClassLoader;
0N/Aimport java.net.MalformedURLException;
658N/Aimport java.util.HashMap;
0N/Aimport java.util.Locale;
658N/Aimport java.util.Map;
0N/Aimport java.util.logging.Logger;
0N/Aimport java.util.logging.Level;
0N/Aimport static java.util.logging.Level.*;
0N/A
0N/A/**
0N/A * Provides methods for locating tool providers, for example,
0N/A * providers of compilers. This class complements the
0N/A * functionality of {@link java.util.ServiceLoader}.
0N/A *
0N/A * @author Peter von der Ahé
0N/A * @since 1.6
0N/A */
0N/Apublic class ToolProvider {
0N/A
0N/A private static final String propertyName = "sun.tools.ToolProvider";
0N/A private static final String loggerName = "javax.tools";
0N/A
0N/A /*
0N/A * Define the system property "sun.tools.ToolProvider" to enable
0N/A * debugging:
0N/A *
0N/A * java ... -Dsun.tools.ToolProvider ...
0N/A */
0N/A static <T> T trace(Level level, Object reason) {
0N/A // NOTE: do not make this method private as it affects stack traces
0N/A try {
0N/A if (System.getProperty(propertyName) != null) {
0N/A StackTraceElement[] st = Thread.currentThread().getStackTrace();
0N/A String method = "???";
0N/A String cls = ToolProvider.class.getName();
0N/A if (st.length > 2) {
0N/A StackTraceElement frame = st[2];
0N/A method = String.format((Locale)null, "%s(%s:%s)",
0N/A frame.getMethodName(),
0N/A frame.getFileName(),
0N/A frame.getLineNumber());
0N/A cls = frame.getClassName();
0N/A }
0N/A Logger logger = Logger.getLogger(loggerName);
0N/A if (reason instanceof Throwable) {
0N/A logger.logp(level, cls, method,
0N/A reason.getClass().getName(), (Throwable)reason);
0N/A } else {
0N/A logger.logp(level, cls, method, String.valueOf(reason));
0N/A }
0N/A }
0N/A } catch (SecurityException ex) {
0N/A System.err.format((Locale)null, "%s: %s; %s%n",
0N/A ToolProvider.class.getName(),
0N/A reason,
0N/A ex.getLocalizedMessage());
0N/A }
0N/A return null;
0N/A }
0N/A
658N/A private static final String defaultJavaCompilerName
658N/A = "com.sun.tools.javac.api.JavacTool";
658N/A
0N/A /**
0N/A * Gets the Java&trade; programming language compiler provided
0N/A * with this platform.
0N/A * @return the compiler provided with this platform or
0N/A * {@code null} if no compiler is provided
0N/A */
0N/A public static JavaCompiler getSystemJavaCompiler() {
658N/A return instance().getSystemTool(JavaCompiler.class, defaultJavaCompilerName);
0N/A }
0N/A
0N/A /**
0N/A * Returns the class loader for tools provided with this platform.
0N/A * This does not include user-installed tools. Use the
0N/A * {@linkplain java.util.ServiceLoader service provider mechanism}
0N/A * for locating user installed tools.
0N/A *
0N/A * @return the class loader for tools provided with this platform
0N/A * or {@code null} if no tools are provided
0N/A */
0N/A public static ClassLoader getSystemToolClassLoader() {
658N/A try {
658N/A Class<? extends JavaCompiler> c =
658N/A instance().getSystemToolClass(JavaCompiler.class, defaultJavaCompilerName);
658N/A return c.getClassLoader();
658N/A } catch (Throwable e) {
658N/A return trace(WARNING, e);
658N/A }
658N/A }
658N/A
658N/A
658N/A private static ToolProvider instance;
658N/A
658N/A private static synchronized ToolProvider instance() {
658N/A if (instance == null)
658N/A instance = new ToolProvider();
658N/A return instance;
658N/A }
658N/A
658N/A // Cache for tool classes.
658N/A // Use weak references to avoid keeping classes around unnecessarily
658N/A private Map<String, Reference<Class<?>>> toolClasses = new HashMap<String, Reference<Class<?>>>();
658N/A
658N/A // Cache for tool classloader.
658N/A // Use a weak reference to avoid keeping it around unnecessarily
658N/A private Reference<ClassLoader> refToolClassLoader = null;
658N/A
658N/A
658N/A private ToolProvider() { }
658N/A
658N/A private <T> T getSystemTool(Class<T> clazz, String name) {
658N/A Class<? extends T> c = getSystemToolClass(clazz, name);
658N/A try {
658N/A return c.asSubclass(clazz).newInstance();
658N/A } catch (Throwable e) {
658N/A trace(WARNING, e);
658N/A return null;
658N/A }
0N/A }
0N/A
658N/A private <T> Class<? extends T> getSystemToolClass(Class<T> clazz, String name) {
658N/A Reference<Class<?>> refClass = toolClasses.get(name);
658N/A Class<?> c = (refClass == null ? null : refClass.get());
658N/A if (c == null) {
0N/A try {
658N/A c = findSystemToolClass(name);
658N/A } catch (Throwable e) {
658N/A return trace(WARNING, e);
0N/A }
658N/A toolClasses.put(name, new WeakReference<Class<?>>(c));
658N/A }
658N/A return c.asSubclass(clazz);
658N/A }
658N/A
658N/A private static final String[] defaultToolsLocation = { "lib", "tools.jar" };
658N/A
658N/A private Class<?> findSystemToolClass(String toolClassName)
658N/A throws MalformedURLException, ClassNotFoundException
658N/A {
658N/A // try loading class directly, in case tool is on the bootclasspath
658N/A try {
815N/A return Class.forName(toolClassName, false, null);
658N/A } catch (ClassNotFoundException e) {
658N/A trace(FINE, e);
658N/A
658N/A // if tool not on bootclasspath, look in default tools location (tools.jar)
658N/A ClassLoader cl = (refToolClassLoader == null ? null : refToolClassLoader.get());
658N/A if (cl == null) {
658N/A File file = new File(System.getProperty("java.home"));
658N/A if (file.getName().equalsIgnoreCase("jre"))
658N/A file = file.getParentFile();
658N/A for (String name : defaultToolsLocation)
658N/A file = new File(file, name);
658N/A
658N/A // if tools not found, no point in trying a URLClassLoader
658N/A // so rethrow the original exception.
658N/A if (!file.exists())
658N/A throw e;
658N/A
658N/A URL[] urls = { file.toURI().toURL() };
658N/A trace(FINE, urls[0].toString());
658N/A
658N/A cl = URLClassLoader.newInstance(urls);
658N/A refToolClassLoader = new WeakReference<ClassLoader>(cl);
658N/A }
658N/A
658N/A return Class.forName(toolClassName, false, cl);
0N/A }
658N/A }
0N/A}