/* * Copyright (c) 1998, 2025, Oracle and/or its affiliates. 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. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package jdk.javadoc.internal.doclets.toolkit.util; import javax.lang.model.element.ModuleElement; import javax.lang.model.element.PackageElement; import javax.lang.model.element.TypeElement; /** * Standard DocPath objects. */ public class DocPaths { private final String moduleSeparator; private final Utils utils; public DocPaths(Utils utils) { this.utils = utils; moduleSeparator = "/module-"; } public static final DocPath DOT_DOT = DocPath.create(".."); /** The name of the file for all classes index. */ public static final DocPath ALLCLASSES_INDEX = DocPath.create("allclasses-index.html"); /** The name of the file for all packages index. */ public static final DocPath ALLPACKAGES_INDEX = DocPath.create("allpackages-index.html"); /** The name of the sub-directory for storing class usage info. */ public static final DocPath CLASS_USE = DocPath.create("class-use"); /** The name of the file for constant values. */ public static final DocPath CONSTANT_VALUES = DocPath.create("constant-values.html"); /** The name of the file for deprecated elements. */ public static final DocPath DEPRECATED_LIST = DocPath.create("deprecated-list.html"); /** The name of the subdirectory for user-provided additional documentation files. */ public static final DocPath DOC_FILES = DocPath.create("doc-files"); /** The name of the file for the element list. */ public static final DocPath ELEMENT_LIST = DocPath.create("element-list"); /** The name of the file for all references to external specifications. */ public static final DocPath EXTERNAL_SPECS = DocPath.create("external-specs.html"); /** The name of the sub-directory containing font resources. */ public static final DocPath FONTS = DocPath.create("fonts"); /** The name of the DejaVu web fonts CSS file. */ public static final DocPath DEJAVU_CSS = DocPath.create("dejavu.css"); /** The name of the svg file showing a magnifying glass on the search box. */ public static final DocPath GLASS_SVG = DocPath.create("glass.svg"); /** The name of the file for help info. */ public static final DocPath HELP_DOC = DocPath.create("help-doc.html"); /** The name of the main index file. */ public static final DocPath INDEX = DocPath.create("index.html"); /** The name of the single index file for all classes. */ public static final DocPath INDEX_ALL = DocPath.create("index-all.html"); /** The name of the directory for the split index files. */ public static final DocPath INDEX_FILES = DocPath.create("index-files"); /** * Generate the name of one of the files in the split index. * @param n the position in the index * @return the path */ public static DocPath indexN(int n) { return DocPath.create("index-" + n + ".html"); } /** The name of the default javascript file. */ public static final DocPath SCRIPT_JS = DocPath.create("script.js"); /** The name of the template of the default javascript file. */ public static final DocPath SCRIPT_JS_TEMPLATE = DocPath.create("script.js.template"); /** The name of the copy-to-clipboard icon file. */ public static final DocPath CLIPBOARD_SVG = DocPath.create("copy.svg"); /** The name of the left pointing angle icon. */ public static final DocPath LEFT_SVG = DocPath.create("left.svg"); /** The name of the link icon file. */ public static final DocPath LINK_SVG = DocPath.create("link.svg"); /** The name of the right pointing angle icon. */ public static final DocPath RIGHT_SVG = DocPath.create("right.svg"); /** The name of the syntax highlighting style sheet. */ public static final DocPath HIGHLIGHT_CSS = DocPath.create("highlight.css"); /** The name of the syntax highlighting script file. */ public static final DocPath HIGHLIGHT_JS = DocPath.create("highlight.js"); /** The name of the default jQuery directory. */ public static final DocPath JQUERY_DIR = DocPath.create("jquery"); /** The name of the default jQuery javascript file. */ public static final DocPath JQUERY_JS = DocPath.create("jquery-3.7.1.min.js"); /** The name of the default jQuery UI stylesheet file. */ public static final DocPath JQUERY_UI_CSS = DocPath.create("jquery-ui.min.css"); /** The name of the default jQuery UI javascript file. */ public static final DocPath JQUERY_UI_JS = DocPath.create("jquery-ui.min.js"); /** The name of the default jQuery file for legal notices. */ public static final DocPath JQUERY_MD = DocPath.create("jquery.md"); /** The name of the directory for legal files. */ public static final DocPath LEGAL = DocPath.create("legal"); /** The name of the member search index js file. */ public static final DocPath MEMBER_SEARCH_INDEX_JS = DocPath.create("member-search-index.js"); /** The name of the module search index js file. */ public static final DocPath MODULE_SEARCH_INDEX_JS = DocPath.create("module-search-index.js"); /** The name of the file for new elements. */ public static final DocPath NEW_LIST = DocPath.create("new-list.html"); /** The name of the file for the overview summary. */ public static final DocPath OVERVIEW_SUMMARY = DocPath.create("overview-summary.html"); /** The name of the file for the overview tree. */ public static final DocPath OVERVIEW_TREE = DocPath.create("overview-tree.html"); /** The name of the file for the package list. This is to support the legacy mode. */ public static final DocPath PACKAGE_LIST = DocPath.create("package-list"); /** The name of the package search index js file. */ public static final DocPath PACKAGE_SEARCH_INDEX_JS = DocPath.create("package-search-index.js"); /** The name of the file for the package summary. */ public static final DocPath PACKAGE_SUMMARY = DocPath.create("package-summary.html"); /** The name of the file for the package tree. */ public static final DocPath PACKAGE_TREE = DocPath.create("package-tree.html"); /** The name of the file for the package usage info. */ public static final DocPath PACKAGE_USE = DocPath.create("package-use.html"); /** The name of the file for preview elements. */ public static final DocPath PREVIEW_LIST = DocPath.create("preview-list.html"); /** The name of the file for restricted methods. */ public static final DocPath RESTRICTED_LIST = DocPath.create("restricted-list.html"); /** The name of the doc-file for restricted methods. */ public static final DocPath RESTRICTED_DOC = DocPath.create("RestrictedMethods.html"); /** The name of the directory for the resource files. */ public static final DocPath RESOURCE_FILES = DocPath.create("resource-files"); /** The name of the directory for the script files. */ public static final DocPath SCRIPT_FILES = DocPath.create("script-files"); /** The name of the file for search page. */ public static final DocPath SEARCH_PAGE = DocPath.create("search.html"); /** The name of the file for search tags index page. */ public static final DocPath SEARCH_TAGS = DocPath.create("search-tags.html"); /** The name of the file for all system properties. */ public static final DocPath SYSTEM_PROPERTIES = DocPath.create("system-properties.html"); /** * Returns the path for a type element. * For example, if the type element is {@code java.lang.Object}, * the path is {@code java/lang/Object.html}. * * @param typeElement the type element * @return the path */ public DocPath forClass(TypeElement typeElement) { return (typeElement == null) ? DocPath.empty : forPackage(utils.containingPackage(typeElement)).resolve(forName(typeElement)); } /** * Returns the path for the simple name of a type element. * For example, if the type element is {@code java.lang.Object}, * the path is {@code Object.html}. * * @param typeElement the type element * @return the path */ public DocPath forName(TypeElement typeElement) { return (typeElement == null) ? DocPath.empty : new DocPath(utils.getSimpleName(typeElement) + ".html"); } public static DocPath forModule(ModuleElement mdle) { return mdle == null || mdle.isUnnamed() ? DocPath.empty : DocPath.create(mdle.getQualifiedName().toString()); } /** * Returns the path for the package of a type element. * For example, if the type element is {@code java.lang.Object}, * the path is {@code java/lang}. * * @param typeElement the type element * @return the path */ public DocPath forPackage(TypeElement typeElement) { return (typeElement == null) ? DocPath.empty : forPackage(utils.containingPackage(typeElement)); } /** * Returns the path for a package. * For example, if the package is {@code java.lang}, * the path is {@code java/lang}. * * @param pkgElement the package element * @return the path */ public DocPath forPackage(PackageElement pkgElement) { if (pkgElement == null || pkgElement.isUnnamed()) { return DocPath.empty; } DocPath pkgPath = DocPath.create(pkgElement.getQualifiedName().toString().replace('.', '/')); ModuleElement mdle = (ModuleElement) pkgElement.getEnclosingElement(); return forModule(mdle).resolve(pkgPath); } /** * Returns the inverse path for a package. * For example, if the package is {@code java.lang}, * the inverse path is {@code ../..}. * * @param pkgElement the package element * @return the path */ public static DocPath forRoot(PackageElement pkgElement) { String name = (pkgElement == null || pkgElement.isUnnamed()) ? "" : pkgElement.getQualifiedName().toString(); return new DocPath(name.replace('.', '/').replaceAll("[^/]+", "..")); } /** * Returns a relative path from one package to another. * * @param from the origin of the relative path * @param to the destination of the relative path * @return the path */ public DocPath relativePath(PackageElement from, PackageElement to) { return forRoot(from).resolve(forPackage(to)); } /** * Returns the path for a file within a module documentation output directory. * @param mdle the module * @param path the path to append to the module path * @return the module documentation path */ public DocPath modulePath(ModuleElement mdle, String path) { return DocPath.create(mdle.getQualifiedName().toString()).resolve(path); } /** * The path for the file for a module's summary page. * @param mdle the module * @return the path */ public DocPath moduleSummary(ModuleElement mdle) { return createModulePath(mdle, "summary.html"); } /** * The path for the file for a module's summary page. * @param mdleName the module * @return the path */ public DocPath moduleSummary(String mdleName) { return createModulePath(mdleName, "summary.html"); } private DocPath createModulePath(ModuleElement mdle, String path) { return DocPath.create(mdle.getQualifiedName() + moduleSeparator + path); } private DocPath createModulePath(String moduleName, String path) { return DocPath.create(moduleName + moduleSeparator + path); } /** The name of the sub-package from which resources are read. */ public static final DocPath RESOURCES = DocPath.create("resources"); /** The name of the search javascript file. */ public static final DocPath SEARCH_JS = DocPath.create("search.js"); /** The name of the template for the search javascript file. */ public static final DocPath SEARCH_JS_TEMPLATE = DocPath.create("search.js.template"); /** The name of the search javascript file. */ public static final DocPath SEARCH_PAGE_JS = DocPath.create("search-page.js"); /** The name of the file for the serialized form info. */ public static final DocPath SERIALIZED_FORM = DocPath.create("serialized-form.html"); /** The name of the directory in which HTML versions of the source code * are generated. */ public static final DocPath SOURCE_OUTPUT = DocPath.create("src-html"); /** The name of the default stylesheet. */ public static final DocPath STYLESHEET = DocPath.create("stylesheet.css"); /** The name of the tag search index js file. */ public static final DocPath TAG_SEARCH_INDEX_JS = DocPath.create("tag-search-index.js"); /** The name of the type search index js file. */ public static final DocPath TYPE_SEARCH_INDEX_JS = DocPath.create("type-search-index.js"); /** The name of the svg file for undo button on the search box. */ public static final DocPath X_SVG = DocPath.create("x.svg"); }