/*
 * @(#)SourcePath.java	1.3 98/09/22
 *
 * Copyright 1994-1998 by Sun Microsystems, Inc.,
 * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
 * All rights reserved.
 *
 * This software is the confidential and proprietary information
 * of Sun Microsystems, Inc. ("Confidential Information").  You
 * shall not disclose such Confidential Information and shall use
 * it only in accordance with the terms of the license agreement
 * you entered into with Sun.
 */

package com.sun.tools.doclets;

import java.io.File;

/**
 * This class is used to represent a source path which can contain only
 * directories no zip files. If a zip file is specified in the command line it 
 * will not get reflected in the SourcePath.
 *
 * @author Atul M Dambalkar
 */
public
class SourcePath {
    private final char dirSeparator = File.pathSeparatorChar;

    private final String fileSeparator = File.separator;

    /**
     * The original class path string
     */
    private String pathstr;

    /**
     * List of source path entries. Each entry is a directory.
     */
    private File[] sourcePath;


    /**
     * Build a source path from the specified path string on the command line.
     */
    public SourcePath(String pathstr) {
	init(pathstr);
    }

    /**
     * Build a default source path from the path strings specified by
     * the properties env.class.path.
     */
    public SourcePath() {
        init(System.getProperty("env.class.path"));
    }

    /**
     * Initialize the SourcePath File array, which will contain only the 
     * directory names from the given path string.
     *
     * @param pathstr Path String.
     */
    private void init(String pathstr) {
        if (pathstr == null ||  pathstr.length() == 0) {
            pathstr = ".";
        }

	int noOfFileSep = 0;
        int index = 0;
	this.pathstr = pathstr; // Save original class path string

	// Count the number of path separators
	while ((index = pathstr.indexOf(dirSeparator, index)) != -1) {
	    noOfFileSep++;
            index++;
	}
	// Build the source path
	File[] tempPath = new File[noOfFileSep + 1];
        int tempPathIndex = 0;
	int len = pathstr.length();
        int sepPos;
	for (index = 0; index < len; index = sepPos + 1) {
	    sepPos = pathstr.indexOf(dirSeparator, index);
            if (sepPos < 0) {
                sepPos = len;
	    }
            File file = new File(pathstr.substring(index, sepPos));
	    if (file.isDirectory()) {
   	        tempPath[tempPathIndex++] = file;
            } // if it is really a file, ignore it.
	}
	sourcePath = new File[tempPathIndex];
	System.arraycopy((Object)tempPath, 0, (Object)sourcePath, 
                         0, tempPathIndex);
    }

    /**
     * Find the specified directory in the source path.
     * 
     * @param name Name of the directory to be searched for in the source path.
     * @return File Return the directory if found else return null.
     */
    public File getDirectory(String name) {
        for (int i = 0; i < sourcePath.length; i++) {
            File directoryNeeded = new File(sourcePath[i], name);
            if (directoryNeeded.isDirectory()) {
                return directoryNeeded;
            }
        }         
	return null;
    }

    /**
     * Return original source path string.
     */
    public String toString() {
	return pathstr;
    }
}