duke@1: /*
jjg@1230:  * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
jjg@50: package com.sun.tools.javac.file;
jjg@50: 
jjg@1116: import java.io.FileNotFoundException;
jjg@1116: import java.util.Iterator;
duke@1: import java.io.File;
duke@1: import java.io.IOException;
darcy@497: import java.net.MalformedURLException;
darcy@497: import java.net.URL;
jjg@1116: import java.util.Arrays;
jjg@1116: import java.util.Collection;
jjg@1116: import java.util.Collections;
jjg@1116: import java.util.EnumMap;
jjg@1116: import java.util.EnumSet;
duke@1: import java.util.HashMap;
duke@1: import java.util.HashSet;
jjg@1116: import java.util.LinkedHashSet;
duke@1: import java.util.Map;
duke@1: import java.util.Set;
darcy@497: import java.util.StringTokenizer;
duke@1: import java.util.zip.ZipFile;
duke@1: import javax.tools.JavaFileManager.Location;
jjg@1116: import javax.tools.StandardLocation;
duke@1: 
jjg@50: import com.sun.tools.javac.code.Lint;
jjg@1157: import com.sun.tools.javac.main.Option;
jjg@151: import com.sun.tools.javac.util.ListBuffer;
jjg@50: import com.sun.tools.javac.util.Log;
jjg@50: import com.sun.tools.javac.util.Options;
jjg@50: 
jjg@1116: import javax.tools.JavaFileManager;
jjg@50: import static javax.tools.StandardLocation.*;
jjg@1157: import static com.sun.tools.javac.main.Option.*;
duke@1: 
duke@1: /** This class converts command line arguments, environment variables
duke@1:  *  and system properties (in File.pathSeparator-separated String form)
duke@1:  *  into a boot class path, user class path, and source path (in
duke@1:  *  Collection<String> form).
duke@1:  *
jjg@581:  *  <p><b>This is NOT part of any supported API.
jjg@581:  *  If you write code that depends on this, you do so at your own risk.
duke@1:  *  This code and its internal interfaces are subject to change or
duke@1:  *  deletion without notice.</b>
duke@1:  */
jjg@1116: public class Locations {
duke@1: 
duke@1:     /** The log to use for warning output */
duke@1:     private Log log;
duke@1: 
duke@1:     /** Collection of command-line options */
duke@1:     private Options options;
duke@1: 
duke@1:     /** Handler for -Xlint options */
duke@1:     private Lint lint;
duke@1: 
jjg@106:     /** Access to (possibly cached) file info */
jjg@106:     private FSInfo fsInfo;
duke@1: 
jjg@1116:     /** Whether to warn about non-existent path elements */
jjg@1116:     private boolean warn;
jjg@1116: 
jjg@1116:     // TODO: remove need for this
jjg@1116:     private boolean inited = false; // TODO? caching bad?
jjg@1116: 
jjg@1116:     public Locations() {
jjg@1116:         initHandlers();
duke@1:     }
duke@1: 
jjg@1111:     public void update(Log log, Options options, Lint lint, FSInfo fsInfo) {
jjg@1111:         this.log = log;
jjg@1111:         this.options = options;
jjg@1111:         this.lint = lint;
jjg@1111:         this.fsInfo = fsInfo;
duke@1:     }
duke@1: 
jjg@1116:     public Collection<File> bootClassPath() {
jjg@1116:         return getLocation(PLATFORM_CLASS_PATH);
duke@1:     }
duke@1: 
jjg@758:     public boolean isDefaultBootClassPath() {
jjg@1116:         BootClassPathLocationHandler h =
jjg@1116:                 (BootClassPathLocationHandler) getHandler(PLATFORM_CLASS_PATH);
jjg@1116:         return h.isDefault();
duke@1:     }
duke@1: 
jjg@818:     boolean isDefaultBootClassPathRtJar(File file) {
jjg@1116:         BootClassPathLocationHandler h =
jjg@1116:                 (BootClassPathLocationHandler) getHandler(PLATFORM_CLASS_PATH);
jjg@1116:         return h.isDefaultRtJar(file);
jjg@1116:     }
jjg@1116: 
jjg@1116:     public Collection<File> userClassPath() {
jjg@1116:         return getLocation(CLASS_PATH);
jjg@1116:     }
jjg@1116: 
jjg@1116:     public Collection<File> sourcePath() {
jjg@1116:         Collection<File> p = getLocation(SOURCE_PATH);
jjg@1116:         // TODO: this should be handled by the LocationHandler
jjg@1116:         return p == null || p.isEmpty() ? null : p;
duke@1:     }
duke@1: 
jjg@151:     /**
jjg@151:      * Split a path into its elements. Empty path elements will be ignored.
jjg@151:      * @param path The path to be split
jjg@151:      * @return The elements of the path
jjg@151:      */
jjg@151:     private static Iterable<File> getPathEntries(String path) {
jjg@151:         return getPathEntries(path, null);
jjg@151:     }
duke@1: 
jjg@151:     /**
jjg@151:      * Split a path into its elements. If emptyPathDefault is not null, all
jjg@151:      * empty elements in the path, including empty elements at either end of
jjg@151:      * the path, will be replaced with the value of emptyPathDefault.
jjg@151:      * @param path The path to be split
jjg@151:      * @param emptyPathDefault The value to substitute for empty path elements,
jjg@151:      *  or null, to ignore empty path elements
jjg@151:      * @return The elements of the path
jjg@151:      */
jjg@151:     private static Iterable<File> getPathEntries(String path, File emptyPathDefault) {
jjg@151:         ListBuffer<File> entries = new ListBuffer<File>();
jjg@151:         int start = 0;
jjg@151:         while (start <= path.length()) {
jjg@151:             int sep = path.indexOf(File.pathSeparatorChar, start);
jjg@151:             if (sep == -1)
jjg@151:                 sep = path.length();
jjg@151:             if (start < sep)
jjg@151:                 entries.add(new File(path.substring(start, sep)));
jjg@151:             else if (emptyPathDefault != null)
jjg@151:                 entries.add(emptyPathDefault);
jjg@151:             start = sep + 1;
duke@1:         }
jjg@151:         return entries;
duke@1:     }
duke@1: 
jjg@1116:     /**
jjg@1116:      * Utility class to help evaluate a path option.
jjg@1116:      * Duplicate entries are ignored, jar class paths can be expanded.
jjg@1116:      */
duke@1:     private class Path extends LinkedHashSet<File> {
duke@1:         private static final long serialVersionUID = 0;
duke@1: 
duke@1:         private boolean expandJarClassPaths = false;
duke@1:         private Set<File> canonicalValues = new HashSet<File>();
duke@1: 
duke@1:         public Path expandJarClassPaths(boolean x) {
duke@1:             expandJarClassPaths = x;
duke@1:             return this;
duke@1:         }
duke@1: 
duke@1:         /** What to use when path element is the empty string */
jjg@151:         private File emptyPathDefault = null;
duke@1: 
jjg@151:         public Path emptyPathDefault(File x) {
duke@1:             emptyPathDefault = x;
duke@1:             return this;
duke@1:         }
duke@1: 
duke@1:         public Path() { super(); }
duke@1: 
duke@1:         public Path addDirectories(String dirs, boolean warn) {
jjg@874:             boolean prev = expandJarClassPaths;
jjg@874:             expandJarClassPaths = true;
jjg@874:             try {
jjg@874:                 if (dirs != null)
jjg@874:                     for (File dir : getPathEntries(dirs))
jjg@874:                         addDirectory(dir, warn);
jjg@874:                 return this;
jjg@874:             } finally {
jjg@874:                 expandJarClassPaths = prev;
jjg@874:             }
duke@1:         }
duke@1: 
duke@1:         public Path addDirectories(String dirs) {
duke@1:             return addDirectories(dirs, warn);
duke@1:         }
duke@1: 
jjg@151:         private void addDirectory(File dir, boolean warn) {
jjg@151:             if (!dir.isDirectory()) {
duke@1:                 if (warn)
jjg@612:                     log.warning(Lint.LintCategory.PATH,
jjg@612:                             "dir.path.element.not.found", dir);
duke@1:                 return;
duke@1:             }
duke@1: 
jjg@151:             File[] files = dir.listFiles();
duke@1:             if (files == null)
duke@1:                 return;
duke@1: 
duke@1:             for (File direntry : files) {
duke@1:                 if (isArchive(direntry))
duke@1:                     addFile(direntry, warn);
duke@1:             }
duke@1:         }
duke@1: 
duke@1:         public Path addFiles(String files, boolean warn) {
jjg@757:             if (files != null) {
jjg@1116:                 addFiles(getPathEntries(files, emptyPathDefault), warn);
jjg@1116:             }
jjg@1116:             return this;
jjg@1116:         }
jjg@1116: 
jjg@1116:         public Path addFiles(String files) {
jjg@1116:             return addFiles(files, warn);
jjg@1116:         }
jjg@1116: 
jjg@1116:         public Path addFiles(Iterable<? extends File> files, boolean warn) {
jjg@1116:             if (files != null) {
jjg@1116:                 for (File file: files)
duke@1:                     addFile(file, warn);
jjg@757:             }
duke@1:             return this;
duke@1:         }
duke@1: 
jjg@1116:         public Path addFiles(Iterable<? extends File> files) {
duke@1:             return addFiles(files, warn);
duke@1:         }
duke@1: 
duke@1:         public void addFile(File file, boolean warn) {
jjh@801:             if (contains(file)) {
jjh@801:                 // discard duplicates
duke@1:                 return;
duke@1:             }
duke@1: 
jjg@106:             if (! fsInfo.exists(file)) {
duke@1:                 /* No such file or directory exists */
jjg@612:                 if (warn) {
jjg@612:                     log.warning(Lint.LintCategory.PATH,
jjg@612:                             "path.element.not.found", file);
jjg@612:                 }
jjh@801:                 super.add(file);
jjh@801:                 return;
jjh@801:             }
jjh@801: 
jjh@801:             File canonFile = fsInfo.getCanonicalFile(file);
jjh@801:             if (canonicalValues.contains(canonFile)) {
jjh@801:                 /* Discard duplicates and avoid infinite recursion */
jjh@801:                 return;
jjh@801:             }
jjh@801: 
jjh@801:             if (fsInfo.isFile(file)) {
duke@1:                 /* File is an ordinary file. */
duke@1:                 if (!isArchive(file)) {
duke@1:                     /* Not a recognized extension; open it to see if
duke@1:                      it looks like a valid zip file. */
duke@1:                     try {
duke@1:                         ZipFile z = new ZipFile(file);
duke@1:                         z.close();
jjg@612:                         if (warn) {
jjg@612:                             log.warning(Lint.LintCategory.PATH,
jjg@612:                                     "unexpected.archive.file", file);
jjg@612:                         }
duke@1:                     } catch (IOException e) {
duke@1:                         // FIXME: include e.getLocalizedMessage in warning
jjg@612:                         if (warn) {
jjg@612:                             log.warning(Lint.LintCategory.PATH,
jjg@612:                                     "invalid.archive.file", file);
jjg@612:                         }
duke@1:                         return;
duke@1:                     }
duke@1:                 }
duke@1:             }
duke@1: 
duke@1:             /* Now what we have left is either a directory or a file name
jjh@801:                conforming to archive naming convention */
duke@1:             super.add(file);
jjg@106:             canonicalValues.add(canonFile);
duke@1: 
jjh@801:             if (expandJarClassPaths && fsInfo.isFile(file))
duke@1:                 addJarClassPath(file, warn);
duke@1:         }
duke@1: 
duke@1:         // Adds referenced classpath elements from a jar's Class-Path
duke@1:         // Manifest entry.  In some future release, we may want to
duke@1:         // update this code to recognize URLs rather than simple
duke@1:         // filenames, but if we do, we should redo all path-related code.
duke@1:         private void addJarClassPath(File jarFile, boolean warn) {
duke@1:             try {
jjg@106:                 for (File f: fsInfo.getJarClassPath(jarFile)) {
jjg@106:                     addFile(f, warn);
duke@1:                 }
duke@1:             } catch (IOException e) {
jjg@510:                 log.error("error.reading.file", jarFile, JavacFileManager.getMessage(e));
duke@1:             }
duke@1:         }
duke@1:     }
duke@1: 
jjg@1116:     /**
jjg@1116:      * Base class for handling support for the representation of Locations.
jjg@1116:      * Implementations are responsible for handling the interactions between
jjg@1116:      * the command line options for a location, and API access via setLocation.
jjg@1116:      * @see #initHandlers
jjg@1116:      * @see #getHandler
jjg@1116:      */
jjg@1116:     protected abstract class LocationHandler {
jjg@1116:         final Location location;
jjg@1157:         final Set<Option> options;
duke@1: 
jjg@1116:         /**
jjg@1116:          * Create a handler. The location and options provide a way to map
jjg@1116:          * from a location or an option to the corresponding handler.
jjg@1116:          * @see #initHandlers
jjg@1116:          */
jjg@1157:         protected LocationHandler(Location location, Option... options) {
jjg@1116:             this.location = location;
jjh@1117:             this.options = options.length == 0 ?
jjg@1157:                 EnumSet.noneOf(Option.class):
jjh@1117:                 EnumSet.copyOf(Arrays.asList(options));
jjg@1116:         }
duke@1: 
jjg@1116:         // TODO: TEMPORARY, while Options still used for command line options
jjg@1116:         void update(Options optionTable) {
jjg@1157:             for (Option o: options) {
jjg@1116:                 String v = optionTable.get(o);
jjg@1116:                 if (v != null) {
jjg@1116:                     handleOption(o, v);
jjg@1116:                 }
duke@1:             }
duke@1:         }
duke@1: 
jjg@1116:         /** @see JavaFileManager#handleOption. */
jjg@1157:         abstract boolean handleOption(Option option, String value);
jjg@1116:         /** @see JavaFileManager#getLocation. */
jjg@1116:         abstract Collection<File> getLocation();
jjg@1116:         /** @see JavaFileManager#setLocation. */
jjg@1116:         abstract void setLocation(Iterable<? extends File> files) throws IOException;
duke@1:     }
duke@1: 
jjg@1116:     /**
jjg@1116:      * General purpose implementation for output locations,
jjg@1116:      * such as -d/CLASS_OUTPUT and -s/SOURCE_OUTPUT.
jjg@1116:      * All options are treated as equivalent (i.e. aliases.)
jjg@1116:      * The value is a single file, possibly null.
jjg@1116:      */
jjg@1116:     private class OutputLocationHandler extends LocationHandler {
jjg@1116:         private File outputDir;
duke@1: 
jjg@1157:         OutputLocationHandler(Location location, Option... options) {
jjg@1116:             super(location, options);
jjg@1116:         }
duke@1: 
jjg@1116:         @Override
jjg@1157:         boolean handleOption(Option option, String value) {
jjg@1116:             if (!options.contains(option))
jjg@1116:                 return false;
duke@1: 
jjg@1116:             // TODO: could/should validate outputDir exists and is a directory
jjg@1116:             // need to decide how best to report issue for benefit of
jjg@1116:             // direct API call on JavaFileManager.handleOption(specifies IAE)
jjg@1116:             // vs. command line decoding.
jjg@1116:             outputDir = new File(value);
jjg@1116:             return true;
jjg@1116:         }
duke@1: 
jjg@1116:         @Override
jjg@1116:         Collection<File> getLocation() {
jjg@1116:             return (outputDir == null) ? null : Collections.singleton(outputDir);
jjg@1116:         }
jjg@1116: 
jjg@1116:         @Override
jjg@1116:         void setLocation(Iterable<? extends File> files) throws IOException {
jjg@1116:             if (files == null) {
jjg@1116:                 outputDir = null;
jjg@1116:             } else {
jjg@1116:                 Iterator<? extends File> pathIter = files.iterator();
jjg@1116:                 if (!pathIter.hasNext())
jjg@1116:                     throw new IllegalArgumentException("empty path for directory");
jjg@1116:                 File dir = pathIter.next();
jjg@1116:                 if (pathIter.hasNext())
jjg@1116:                     throw new IllegalArgumentException("path too long for directory");
jjg@1116:                 if (!dir.exists())
jjg@1116:                     throw new FileNotFoundException(dir + ": does not exist");
jjg@1116:                 else if (!dir.isDirectory())
jjg@1116:                     throw new IOException(dir + ": not a directory");
jjg@1116:                 outputDir = dir;
jjg@1116:             }
jjg@1116:         }
duke@1:     }
duke@1: 
jjg@1116:     /**
jjg@1116:      * General purpose implementation for search path locations,
jjg@1116:      * such as -sourcepath/SOURCE_PATH and -processorPath/ANNOTATION_PROCESS_PATH.
jjg@1116:      * All options are treated as equivalent (i.e. aliases.)
jjg@1116:      * The value is an ordered set of files and/or directories.
jjg@1116:      */
jjg@1116:     private class SimpleLocationHandler extends LocationHandler {
jjg@1116:         protected Collection<File> searchPath;
duke@1: 
jjg@1157:         SimpleLocationHandler(Location location, Option... options) {
jjg@1116:             super(location, options);
jjg@1116:         }
jjg@1116: 
jjg@1116:         @Override
jjg@1157:         boolean handleOption(Option option, String value) {
jjg@1116:             if (!options.contains(option))
jjg@1116:                 return false;
jjg@1116:             searchPath = value == null ? null :
jjg@1116:                     Collections.unmodifiableCollection(computePath(value));
jjg@1116:             return true;
jjg@1116:         }
jjg@1116: 
jjg@1116:         protected Path computePath(String value) {
jjg@1116:             return new Path().addFiles(value);
jjg@1116:         }
jjg@1116: 
jjg@1116:         @Override
jjg@1116:         Collection<File> getLocation() {
jjg@1116:             return searchPath;
jjg@1116:         }
jjg@1116: 
jjg@1116:         @Override
jjg@1116:         void setLocation(Iterable<? extends File> files) {
jjg@1116:             Path p;
jjg@1116:             if (files == null) {
jjg@1116:                 p = computePath(null);
jjg@1116:             } else {
jjg@1116:                 p = new Path().addFiles(files);
jjg@1116:             }
jjg@1116:             searchPath = Collections.unmodifiableCollection(p);
jjg@1116:         }
duke@1:     }
duke@1: 
jjg@1116:     /**
jjg@1116:      * Subtype of SimpleLocationHandler for -classpath/CLASS_PATH.
jjg@1116:      * If no value is given, a default is provided, based on system properties
jjg@1116:      * and other values.
jjg@1116:      */
jjg@1116:     private class ClassPathLocationHandler extends SimpleLocationHandler {
jjg@1116:         ClassPathLocationHandler() {
jjg@1116:             super(StandardLocation.CLASS_PATH,
jjg@1157:                     Option.CLASSPATH, Option.CP);
jjg@1116:         }
duke@1: 
jjg@1116:         @Override
jjg@1116:         Collection<File> getLocation() {
jjg@1116:             lazy();
jjg@1116:             return searchPath;
jjg@1116:         }
jjg@1116: 
jjg@1116:         @Override
jjg@1116:         protected Path computePath(String value) {
jjg@1116:             String cp = value;
jjg@1116: 
jjg@1116:             // CLASSPATH environment variable when run from `javac'.
jjg@1116:             if (cp == null) cp = System.getProperty("env.class.path");
jjg@1116: 
jjg@1116:             // If invoked via a java VM (not the javac launcher), use the
jjg@1116:             // platform class path
jjg@1116:             if (cp == null && System.getProperty("application.home") == null)
jjg@1116:                 cp = System.getProperty("java.class.path");
jjg@1116: 
jjg@1116:             // Default to current working directory.
jjg@1116:             if (cp == null) cp = ".";
jjg@1116: 
jjg@1116:             return new Path()
jjg@1116:                 .expandJarClassPaths(true)        // Only search user jars for Class-Paths
jjg@1116:                 .emptyPathDefault(new File("."))  // Empty path elt ==> current directory
jjg@1116:                 .addFiles(cp);
jjg@1116:             }
jjg@1116: 
jjg@1116:         private void lazy() {
jjg@1116:             if (searchPath == null)
jjg@1116:                 setLocation(null);
jjg@1116:         }
duke@1:     }
duke@1: 
jjg@1116:     /**
jjg@1116:      * Custom subtype of LocationHandler for PLATFORM_CLASS_PATH.
jjg@1116:      * Various options are supported for different components of the
jjg@1116:      * platform class path.
jjg@1116:      * Setting a value with setLocation overrides all existing option values.
jjg@1116:      * Setting any option overrides any value set with setLocation, and reverts
jjg@1116:      * to using default values for options that have not been set.
jjg@1116:      * Setting -bootclasspath or -Xbootclasspath overrides any existing
jjg@1116:      * value for -Xbootclasspath/p: and -Xbootclasspath/a:.
jjg@1116:      */
jjg@1116:     private class BootClassPathLocationHandler extends LocationHandler {
jjg@1116:         private Collection<File> searchPath;
jjg@1157:         final Map<Option, String> optionValues = new EnumMap<Option,String>(Option.class);
duke@1: 
jjg@1116:         /**
jjg@1116:          * rt.jar as found on the default bootclasspath.
jjg@1116:          * If the user specified a bootclasspath, null is used.
jjg@1116:          */
jjg@1116:         private File defaultBootClassPathRtJar = null;
jjg@1116: 
jjg@1116:         /**
jjg@1116:          *  Is bootclasspath the default?
jjg@1116:          */
jjg@1116:         private boolean isDefaultBootClassPath;
jjg@1116: 
jjg@1116:         BootClassPathLocationHandler() {
jjg@1116:             super(StandardLocation.PLATFORM_CLASS_PATH,
jjg@1157:                     Option.BOOTCLASSPATH, Option.XBOOTCLASSPATH,
jjg@1157:                     Option.XBOOTCLASSPATH_PREPEND,
jjg@1157:                     Option.XBOOTCLASSPATH_APPEND,
jjg@1157:                     Option.ENDORSEDDIRS, Option.DJAVA_ENDORSED_DIRS,
jjg@1157:                     Option.EXTDIRS, Option.DJAVA_EXT_DIRS);
jjg@1116:         }
jjg@1116: 
jjg@1116:         boolean isDefault() {
duke@1:             lazy();
jjg@1116:             return isDefaultBootClassPath;
duke@1:         }
jjg@1116: 
jjg@1116:         boolean isDefaultRtJar(File file) {
jjg@1116:             lazy();
jjg@1116:             return file.equals(defaultBootClassPathRtJar);
jjg@1116:         }
jjg@1116: 
jjg@1116:         @Override
jjg@1157:         boolean handleOption(Option option, String value) {
jjg@1116:             if (!options.contains(option))
jjg@1116:                 return false;
jjg@1116: 
jjg@1116:             option = canonicalize(option);
jjg@1116:             optionValues.put(option, value);
jjg@1116:             if (option == BOOTCLASSPATH) {
jjg@1116:                 optionValues.remove(XBOOTCLASSPATH_PREPEND);
jjg@1116:                 optionValues.remove(XBOOTCLASSPATH_APPEND);
jjg@1116:             }
jjg@1116:             searchPath = null;  // reset to "uninitialized"
jjg@1116:             return true;
jjg@1116:         }
jjg@1116:         // where
jjg@1116:             // TODO: would be better if option aliasing was handled at a higher
jjg@1116:             // level
jjg@1157:             private Option canonicalize(Option option) {
jjg@1116:                 switch (option) {
jjg@1116:                     case XBOOTCLASSPATH:
jjg@1157:                         return Option.BOOTCLASSPATH;
jjg@1116:                     case DJAVA_ENDORSED_DIRS:
jjg@1157:                         return Option.ENDORSEDDIRS;
jjg@1116:                     case DJAVA_EXT_DIRS:
jjg@1157:                         return Option.EXTDIRS;
jjg@1116:                     default:
jjg@1116:                         return option;
jjg@1116:                 }
jjg@1116:             }
jjg@1116: 
jjg@1116:         @Override
jjg@1116:         Collection<File> getLocation() {
jjg@1116:             lazy();
jjg@1116:             return searchPath;
jjg@1116:         }
jjg@1116: 
jjg@1116:         @Override
jjg@1116:         void setLocation(Iterable<? extends File> files) {
jjg@1116:             if (files == null) {
jjg@1116:                 searchPath = null;  // reset to "uninitialized"
jjg@1116:             } else {
jjg@1116:                 defaultBootClassPathRtJar = null;
jjg@1116:                 isDefaultBootClassPath = false;
jjg@1116:                 Path p = new Path().addFiles(files, false);
jjg@1116:                 searchPath = Collections.unmodifiableCollection(p);
jjg@1116:                 optionValues.clear();
jjg@1116:             }
jjg@1116:         }
jjg@1116: 
jjg@1116:         Path computePath() {
jjg@1116:             defaultBootClassPathRtJar = null;
jjg@1116:             Path path = new Path();
jjg@1116: 
jjg@1116:             String bootclasspathOpt = optionValues.get(BOOTCLASSPATH);
jjg@1116:             String endorseddirsOpt = optionValues.get(ENDORSEDDIRS);
jjg@1116:             String extdirsOpt = optionValues.get(EXTDIRS);
jjg@1116:             String xbootclasspathPrependOpt = optionValues.get(XBOOTCLASSPATH_PREPEND);
jjg@1116:             String xbootclasspathAppendOpt = optionValues.get(XBOOTCLASSPATH_APPEND);
jjg@1116: 
jjg@1116:             path.addFiles(xbootclasspathPrependOpt);
jjg@1116: 
jjg@1116:             if (endorseddirsOpt != null)
jjg@1116:                 path.addDirectories(endorseddirsOpt);
jjg@1116:             else
jjg@1116:                 path.addDirectories(System.getProperty("java.endorsed.dirs"), false);
jjg@1116: 
jjg@1116:             if (bootclasspathOpt != null) {
jjg@1116:                 path.addFiles(bootclasspathOpt);
jjg@1116:             } else {
jjg@1116:                 // Standard system classes for this compiler's release.
jjg@1116:                 String files = System.getProperty("sun.boot.class.path");
jjg@1116:                 path.addFiles(files, false);
jjg@1116:                 File rt_jar = new File("rt.jar");
jjg@1116:                 for (File file : getPathEntries(files)) {
jjg@1116:                     if (new File(file.getName()).equals(rt_jar))
jjg@1116:                         defaultBootClassPathRtJar = file;
jjg@1116:                 }
jjg@1116:             }
jjg@1116: 
jjg@1116:             path.addFiles(xbootclasspathAppendOpt);
jjg@1116: 
jjg@1116:             // Strictly speaking, standard extensions are not bootstrap
jjg@1116:             // classes, but we treat them identically, so we'll pretend
jjg@1116:             // that they are.
jjg@1116:             if (extdirsOpt != null)
jjg@1116:                 path.addDirectories(extdirsOpt);
jjg@1116:             else
jjg@1116:                 path.addDirectories(System.getProperty("java.ext.dirs"), false);
jjg@1116: 
jjg@1116:             isDefaultBootClassPath =
jjg@1116:                     (xbootclasspathPrependOpt == null) &&
jjg@1116:                     (bootclasspathOpt == null) &&
jjg@1116:                     (xbootclasspathAppendOpt == null);
jjg@1116: 
jjg@1116:             return path;
jjg@1116:         }
jjg@1116: 
jjg@1116:         private void lazy() {
jjg@1116:             if (searchPath == null)
jjg@1116:                 searchPath = Collections.unmodifiableCollection(computePath());
jjg@1116:         }
duke@1:     }
duke@1: 
jjg@1116:     Map<Location, LocationHandler> handlersForLocation;
jjg@1157:     Map<Option, LocationHandler> handlersForOption;
duke@1: 
jjg@1116:     void initHandlers() {
jjg@1116:         handlersForLocation = new HashMap<Location, LocationHandler>();
jjg@1157:         handlersForOption = new EnumMap<Option, LocationHandler>(Option.class);
jjg@1116: 
jjg@1116:         LocationHandler[] handlers = {
jjg@1116:             new BootClassPathLocationHandler(),
jjg@1116:             new ClassPathLocationHandler(),
jjg@1157:             new SimpleLocationHandler(StandardLocation.SOURCE_PATH, Option.SOURCEPATH),
jjg@1157:             new SimpleLocationHandler(StandardLocation.ANNOTATION_PROCESSOR_PATH, Option.PROCESSORPATH),
jjg@1157:             new OutputLocationHandler((StandardLocation.CLASS_OUTPUT), Option.D),
jjg@1230:             new OutputLocationHandler((StandardLocation.SOURCE_OUTPUT), Option.S),
jjg@1230:             new OutputLocationHandler((StandardLocation.NATIVE_HEADER_OUTPUT), Option.H)
jjg@1116:         };
jjg@1116: 
jjg@1116:         for (LocationHandler h: handlers) {
jjg@1116:             handlersForLocation.put(h.location, h);
jjg@1157:             for (Option o: h.options)
jjg@1116:                 handlersForOption.put(o, h);
duke@1:         }
duke@1:     }
duke@1: 
jjg@1157:     boolean handleOption(Option option, String value) {
jjg@1116:         LocationHandler h = handlersForOption.get(option);
jjg@1116:         return (h == null ? false : h.handleOption(option, value));
jjg@1116:     }
duke@1: 
jjg@1116:     Collection<File> getLocation(Location location) {
jjg@1116:         LocationHandler h = getHandler(location);
jjg@1116:         return (h == null ? null : h.getLocation());
jjg@1116:     }
jjg@1116: 
jjg@1116:     File getOutputLocation(Location location) {
jjg@1116:         if (!location.isOutputLocation())
jjg@1116:             throw new IllegalArgumentException();
jjg@1116:         LocationHandler h = getHandler(location);
jjg@1116:         return ((OutputLocationHandler) h).outputDir;
jjg@1116:     }
jjg@1116: 
jjg@1116:     void setLocation(Location location, Iterable<? extends File> files) throws IOException {
jjg@1116:         LocationHandler h = getHandler(location);
jjg@1116:         if (h == null) {
jjg@1116:             if (location.isOutputLocation())
jjg@1116:                 h = new OutputLocationHandler(location);
jjg@1116:             else
jjg@1116:                 h = new SimpleLocationHandler(location);
jjg@1116:             handlersForLocation.put(location, h);
jjg@1116:         }
jjg@1116:         h.setLocation(files);
jjg@1116:     }
jjg@1116: 
jjg@1116:     protected LocationHandler getHandler(Location location) {
jjg@1116:         location.getClass(); // null check
jjg@1116:         lazy();
jjg@1116:         return handlersForLocation.get(location);
jjg@1116:     }
jjg@1116: 
jjg@1116: // TOGO
jjg@1116:     protected void lazy() {
jjg@1116:         if (!inited) {
jjg@1116:             warn = lint.isEnabled(Lint.LintCategory.PATH);
jjg@1116: 
jjg@1116:             for (LocationHandler h: handlersForLocation.values()) {
jjg@1116:                 h.update(options);
duke@1:             }
jjg@1116: 
jjg@1116:             inited = true;
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /** Is this the name of an archive file? */
jjg@106:     private boolean isArchive(File file) {
duke@1:         String n = file.getName().toLowerCase();
jjg@106:         return fsInfo.isFile(file)
duke@1:             && (n.endsWith(".jar") || n.endsWith(".zip"));
duke@1:     }
darcy@497: 
darcy@497:     /**
darcy@497:      * Utility method for converting a search path string to an array
darcy@497:      * of directory and JAR file URLs.
darcy@497:      *
darcy@497:      * Note that this method is called by apt and the DocletInvoker.
darcy@497:      *
darcy@497:      * @param path the search path string
darcy@497:      * @return the resulting array of directory and JAR file URLs
darcy@497:      */
darcy@497:     public static URL[] pathToURLs(String path) {
darcy@497:         StringTokenizer st = new StringTokenizer(path, File.pathSeparator);
darcy@497:         URL[] urls = new URL[st.countTokens()];
darcy@497:         int count = 0;
darcy@497:         while (st.hasMoreTokens()) {
darcy@497:             URL url = fileToURL(new File(st.nextToken()));
darcy@497:             if (url != null) {
darcy@497:                 urls[count++] = url;
darcy@497:             }
darcy@497:         }
jjg@1339:         urls = Arrays.copyOf(urls, count);
darcy@497:         return urls;
darcy@497:     }
darcy@497: 
darcy@497:     /**
darcy@497:      * Returns the directory or JAR file URL corresponding to the specified
darcy@497:      * local file name.
darcy@497:      *
darcy@497:      * @param file the File object
darcy@497:      * @return the resulting directory or JAR file URL, or null if unknown
darcy@497:      */
darcy@497:     private static URL fileToURL(File file) {
darcy@497:         String name;
darcy@497:         try {
darcy@497:             name = file.getCanonicalPath();
darcy@497:         } catch (IOException e) {
darcy@497:             name = file.getAbsolutePath();
darcy@497:         }
darcy@497:         name = name.replace(File.separatorChar, '/');
darcy@497:         if (!name.startsWith("/")) {
darcy@497:             name = "/" + name;
darcy@497:         }
darcy@497:         // If the file does not exist, then assume that it's a directory
darcy@497:         if (!file.isFile()) {
darcy@497:             name = name + "/";
darcy@497:         }
darcy@497:         try {
darcy@497:             return new URL("file", "", name);
darcy@497:         } catch (MalformedURLException e) {
darcy@497:             throw new IllegalArgumentException(file.toString());
darcy@497:         }
darcy@497:     }
duke@1: }