/*

 * 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

 * particular file as subject to the "Classpath" exception as provided

 *

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

 *

 */

package com.sun.tools.doclets.internal.toolkit.util;

import com.sun.tools.doclets.internal.toolkit.*;

import com.sun.javadoc.*;

import java.io.*;

/**

 * Handle the directory creations and the path string generations.

 * All static - never instaniated.

 *

 * This code is not part of an API.

 * It is implementation that is subject to change.

 * Do not use it as an API

 *

 * @since 1.2

 * @author Atul M Dambalkar

 */

public class DirectoryManager {

    /**

     * The file separator string, "/", used in the formation of the URL path.

     */

    public static final String URL_FILE_SEPERATOR = "/";

    /**

     * Never instaniated.

     */

    private DirectoryManager() {

    }

    /**

     * Given a PackageDoc, return its URL path string.

     *

     * @param pd PackageDoc

     * @see #getPath(String)

     */

    public static String createPathString(PackageDoc pd) {

        if (pd == null) {

            return "";

        }

        return getPath(pd.name());

    }

    /**

     * Given a ClassDoc, return its URL path string.

     *

     * @param cd ClassDoc

     * @see #getPath(String)

     */

    public static String createPathString(ClassDoc cd) {

        if (cd == null) {

            return "";

        }

        PackageDoc pd = cd.containingPackage();

        return (pd == null)? "": getPath(pd.name());

    }

    /**

     * Given a PackageDoc, return the corresponding directory name

     * with the platform-dependent file separator between subdirectory names.

     * For example, if name of the package is "java.lang" , then it

     * returns "java/lang" on Unix and "java\lang" on Windows.

     * If name of the package contains no dot, then the value

     * will be returned unchanged.  Because package names cannot

     * end in a dot, the return value will never end with a slash.

     * <p>

     * Also see getPath for the URL separator version of this method

     * that takes a string instead of a PackageDoc.

     *

     * @param  pd    the PackageDoc

     * @return       the platform-dependent directory path for the package

     */

    public static String getDirectoryPath(PackageDoc pd) {

        return pd == null || pd.name().length() == 0 ? "" : getDirectoryPath(pd.name());

    }

    /**

     * Given a package name, return the corresponding directory name

     * with the platform-dependent file separator between subdirectory names.

     * For example, if name of the package is "java.lang" , then it

     * returns "java/lang" on Unix and "java\lang" on Windows.

     * If name of the package contains no dot, then the value

     * will be returned unchanged.  Because package names cannot

     * end in a dot, the return value will never end with a slash.

     * <p>

     * Also see getPath for the URL separator version of this method

     * that takes a string instead of a PackageDoc.

     *

     * @param  packageName    the name of the package

     * @return       the platform-dependent directory path for the package

     */

    public static String getDirectoryPath(String packageName) {

        if (packageName == null || packageName.length() == 0) {

            return "";

        }

        StringBuffer pathstr = new StringBuffer();

        for (int i = 0; i < packageName.length(); i++) {

            char ch = packageName.charAt(i);

            if (ch == '.') {

                pathstr.append(URL_FILE_SEPERATOR);

            } else {

                pathstr.append(ch);

            }

        }

        if (pathstr.length() > 0 && ! pathstr.toString().endsWith(URL_FILE_SEPERATOR)) {

            pathstr.append(URL_FILE_SEPERATOR);

        }

        return pathstr.toString();

    }

    /**

     * Given a package name (a string), return the path string,

     * with the URL separator "/" separating the subdirectory names.

     * If name of the package contains no dot, then the value

     * will be returned unchanged.  Because package names cannot

     * end in a dot, the return value will never end with a slash.

     * <p>

     * For example if the string is "com.sun.javadoc" then the URL

     * path string will be "com/sun/javadoc".

     *

     * @param name   the package name as a String

     * @return       the String URL path

     */

    public static String getPath(String name) {

        if (name == null || name.length() == 0) {

            return "";

        }

        StringBuffer pathstr = new StringBuffer();

        for (int i = 0; i < name.length(); i++) {

            char ch = name.charAt(i);

            if (ch == '.') {

                pathstr.append(URL_FILE_SEPERATOR);

            } else {

                pathstr.append(ch);

            }

        }

        return pathstr.toString();

    }

    /**

     * Given two package names as strings, return the relative path

     * from the package directory corresponding to the first string

     * to the package directory corresponding to the second string,

     * with the URL file separator "/" separating subdirectory names.

     * <p>

     * For example, if the parameter "from" is "java.lang"

     * and parameter "to" is "java.applet", return string

     * "../../java/applet".

     *

     * @param from   the package name from which path is calculated

     * @param to     the package name to which path is calculated

     * @return       relative path between "from" and "to" with URL

     *               separators

     * @see          #getRelativePath(String)

     * @see          #getPath(String)

     */

    public static String getRelativePath(String from, String to) {

        StringBuffer pathstr = new StringBuffer();

        pathstr.append(getRelativePath(from));

        pathstr.append(getPath(to));

        pathstr.append(URL_FILE_SEPERATOR);

        return pathstr.toString();

    }

    /**

     * Given a package name as a string, return relative path string

     * from the corresponding package directory to the root of

     * the documentation, using the URL separator "/" between

     * subdirectory names.

     * <p>

     * For example, if the string "from" is "java.lang",

     * return "../../"

     *

     * @param from    the package

     * @return        String relative path from "from".

     * @see           #getRelativePath(String, String)

     */

    public static String getRelativePath(PackageDoc from) {

        return from == null || from.name().length() == 0 ? "" : getRelativePath(from.name());

    }

    /**

     * Given a package name as a string, return relative path string

     * from the corresponding package directory to the root of

     * the documentation, using the URL separator "/" between

     * subdirectory names.

     * <p>

     * For example, if the string "from" is "java.lang",

     * return "../../"

     *

     * @param from    the package name

     * @return        String relative path from "from".

     * @see           #getRelativePath(String, String)

     */

    public static String getRelativePath(String from) {

        if (from == null || from.length() == 0) {

            return "";

        }

        StringBuffer pathstr = new StringBuffer();

        for (int i = 0; i < from.length(); i++) {

            char ch = from.charAt(i);

            if (ch == '.') {

                pathstr.append(".." + URL_FILE_SEPERATOR);

            }

        }

        pathstr.append(".." + URL_FILE_SEPERATOR);

        return pathstr.toString();

    }

    /**

     * Given a relative or absolute path that might be empty,

     * convert it to a path that does not end with a

     * URL separator "/".  Used for converting

     * HtmlStandardWriter.relativepath when replacing {@docRoot}.

     *

     * @param path   the path to convert.  An empty path represents

     *               the current directory.

     */

    public static String getPathNoTrailingSlash(String path) {

        if ( path.equals("") ) {

            return ".";

        }

        if ( path.equals("/") ) {

            return "/.";

        }

        if ( path.endsWith("/") ) {

            // Remove trailing slash

            path = path.substring(0, path.length() -1);

        }

        return path;

    }

    /**

     * Given a path string create all the directories in the path. For example,

     * if the path string is "java/applet", the method will create directory

     * "java" and then "java/applet" if they don't exist. The file separator

     * string "/" is platform dependent system property.

     *

     * @param path Directory path string.

     */

    public static void createDirectory(Configuration configuration,

                                       String path) {

        if (path == null || path.length() == 0) {

            return;

        }

        File dir = new File(path);

        if (dir.exists()) {

            return;

        } else {

            if (dir.mkdirs()) {

                return;

            } else {

                configuration.message.error(

                       "doclet.Unable_to_create_directory_0", path);

                throw new DocletAbortException();

            }

        }

    }

    /**

     * Given a package name and a file name, return the full path to that file.

     * For example, if PackageDoc passed is for "java.lang" and the filename

     * passed is "package-summary.html", then the string returned is

     * "java/lang/package-summary.html".

     *

     * @param pd         PackageDoc.

     * @param filename   File name to be appended to the path of the package.

     */

    public static String getPathToPackage(PackageDoc pd, String filename) {

        StringBuffer buf = new StringBuffer();

        String pathstr = createPathString(pd);

        if (pathstr.length() > 0) {

            buf.append(pathstr);

            buf.append(URL_FILE_SEPERATOR);

        }

        buf.append(filename);

        return buf.toString();

    }

    /**

     * Given a class name return the full path to the class file.

     * For example, if ClassDoc passed is for "java.lang.Object" then the

     * string returned is "java/lang/Object.html".

     *

     * @param cd   ClassDoc.

     */

    public static String getPathToClass(ClassDoc cd) {

        return getPathToPackage(cd.containingPackage(), cd.name() + ".html");

    }

}