jdk-sandbox: comparison langtools/src/share/classes/com/sun/tools/doclets/formats/html/HtmlDocletWriter.java

equal deleted inserted replaced

-:6321fbe0cf50
+:faf9cde2817b
 public class HtmlDocletWriter extends HtmlDocWriter {
 /**
 * Relative path from the file getting generated to the destination
 * directory. For example, if the file getting generated is
-* "java/lang/Object.html", then the relative path string is "../../".
+* "java/lang/Object.html", then the path to the root is "../..".
 * This string can be empty if the file getting generated is in
 * the destination directory.
 */
-public String relativePath = "";
+public final DocPath pathToRoot;
 /**
-* Same as relativepath, but normalized to never be empty or
+* Platform-independent path from the current or the
-* end with a slash.
-*/
-public String relativepathNoSlash = "";
-/**
-* Platform-dependent directory path from the current or the
 * destination directory to the file getting generated.
 * Used when creating the file.
-* For example, if the file getting generated is
+*/
-* "java/lang/Object.html", then the path string is "java/lang".
+public final DocPath path;
-*/
-public String path = "";
 /**
 * Name of the file getting generated. If the file getting generated is
 * "java/lang/Object.html", then the filename is "Object.html".
 */
-public String filename = "";
+public final DocPath filename;
 /**
 * The display length used for indentation while generating the class page.
 */
 public int displayLength = 0;
 protected boolean printedAnnotationHeading = false;
 /**
 * Constructor to construct the HtmlStandardWriter object.
 *
-* @param filename File to be generated.
+* @param path File to be generated.
 */
-public HtmlDocletWriter(ConfigurationImpl configuration,
+public HtmlDocletWriter(ConfigurationImpl configuration, DocPath path)
-String filename) throws IOException {
+throws IOException {
-super(configuration, filename);
+super(configuration, path);
-this.configuration = configuration;
-this.filename = filename;
-}
-/**
-* Constructor to construct the HtmlStandardWriter object.
-*
-* @param path         Platform-dependent {@link #path} used when
-*                     creating file.
-* @param filename     Name of file to be generated.
-* @param relativePath Value for the variable {@link #relativePath}.
-*/
-public HtmlDocletWriter(ConfigurationImpl configuration,
-String path, String filename,
-String relativePath) throws IOException {
-super(configuration, path, filename);
 this.configuration = configuration;
 this.path = path;
-this.relativePath = relativePath;
+this.pathToRoot = path.parent().invert();
-this.relativepathNoSlash =
+this.filename = path.basename();
-DirectoryManager.getPathNoTrailingSlash(this.relativePath);
-this.filename = filename;
 }
 /**
 * Replace {&#064;docRoot} tag used in options that accept HTML text, such
 * as -header, -footer, -top and -bottom, and when converting a relative
 }
 StringBuilder buf = new StringBuilder();
 int previndex = 0;
 while (true) {
 if (configuration.docrootparent.length() > 0) {
+final String docroot_parent = "{@docroot}/..";
 // Search for lowercase version of {@docRoot}/..
-index = lowerHtml.indexOf("{@docroot}/..", previndex);
+index = lowerHtml.indexOf(docroot_parent, previndex);
 // If next {@docRoot}/.. pattern not found, append rest of htmlstr and exit loop
 if (index < 0) {
 buf.append(htmlstr.substring(previndex));
 break;
 }
 // If next {@docroot}/.. pattern found, append htmlstr up to start of tag
 buf.append(htmlstr.substring(previndex, index));
-previndex = index + 13;  // length for {@docroot}/.. string
+previndex = index + docroot_parent.length();
 // Insert docrootparent absolute path where {@docRoot}/.. was located
 buf.append(configuration.docrootparent);
 // Append slash if next character is not a slash
 if (previndex < htmlstr.length() && htmlstr.charAt(previndex) != '/') {
-buf.append(DirectoryManager.URL_FILE_SEPARATOR);
+buf.append('/');
 }
 } else {
+final String docroot = "{@docroot}";
 // Search for lowercase version of {@docRoot}
-index = lowerHtml.indexOf("{@docroot}", previndex);
+index = lowerHtml.indexOf(docroot, previndex);
 // If next {@docRoot} tag not found, append rest of htmlstr and exit loop
 if (index < 0) {
 buf.append(htmlstr.substring(previndex));
 break;
 }
 // If next {@docroot} tag found, append htmlstr up to start of tag
 buf.append(htmlstr.substring(previndex, index));
-previndex = index + 10;  // length for {@docroot} string
+previndex = index + docroot.length();
 // Insert relative path where {@docRoot} was located
-buf.append(relativepathNoSlash);
+buf.append(pathToRoot.isEmpty() ? "." : pathToRoot.getPath());
 // Append slash if next character is not a slash
-if (relativepathNoSlash.length() > 0 && previndex < htmlstr.length() &&
+if (previndex < htmlstr.length() && htmlstr.charAt(previndex) != '/') {
-htmlstr.charAt(previndex) != '/') {
+buf.append('/');
-buf.append(DirectoryManager.URL_FILE_SEPARATOR);
 }
 }
 }
 return buf.toString();
 }
 * @param label tag for the link
 * @return a content for the target package link
 */
 public Content getTargetPackageLink(PackageDoc pd, String target,
 Content label) {
-return getHyperLink(pathString(pd, "package-summary.html"), "", label, "", target);
+return getHyperLink(pathString(pd, DocPaths.PACKAGE_SUMMARY), "", label, "", target);
 }
 /**
 * Generates the HTML document tree and prints it out.
 *
 * Get link to the "overview-summary.html" page.
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkContents() {
-Content linkContent = getHyperLink(relativePath +
+Content linkContent = getHyperLink(pathToRoot.resolve(DocPaths.OVERVIEW_SUMMARY),
-"overview-summary.html", "", overviewLabel, "", "");
+"", overviewLabel, "", "");
 Content li = HtmlTree.LI(linkContent);
 return li;
 }
 /**
 * Get link for previous file.
 *
 * @param prev File name for the prev link
 * @return a content tree for the link
 */
-public Content getNavLinkPrevious(String prev) {
+public Content getNavLinkPrevious(DocPath prev) {
 Content li;
 if (prev != null) {
 li = HtmlTree.LI(getHyperLink(prev, "", prevLabel, "", ""));
 }
 else
 * without linking it anywhere.
 *
 * @param next File name for the next link
 * @return a content tree for the link
 */
-public Content getNavLinkNext(String next) {
+public Content getNavLinkNext(DocPath next) {
 Content li;
 if (next != null) {
 li = HtmlTree.LI(getHyperLink(next, "", nextLabel, "", ""));
 }
 else
 * Get "FRAMES" link, to switch to the frame version of the output.
 *
 * @param link File to be linked, "index.html"
 * @return a content tree for the link
 */
-protected Content getNavShowLists(String link) {
+protected Content getNavShowLists(DocPath link) {
-Content framesContent = getHyperLink(link + "?" + path +
+Content framesContent = getHyperLink(link.getPath() + "?" + path.getPath(),
-filename, "", framesLabel, "", "_top");
+"", framesLabel, "", "_top");
 Content li = HtmlTree.LI(framesContent);
 return li;
 }
 /**
 * Get "FRAMES" link, to switch to the frame version of the output.
 *
 * @return a content tree for the link
 */
 protected Content getNavShowLists() {
-return getNavShowLists(relativePath + "index.html");
+return getNavShowLists(pathToRoot.resolve(DocPaths.INDEX));
 }
 /**
 * Get "NO FRAMES" link, to switch to the non-frame version of the output.
 *
 * @param link File to be linked
 * @return a content tree for the link
 */
-protected Content getNavHideLists(String link) {
+protected Content getNavHideLists(DocPath link) {
 Content noFramesContent = getHyperLink(link, "", noframesLabel, "", "_top");
 Content li = HtmlTree.LI(noFramesContent);
 return li;
 }
 protected Content getNavLinkTree() {
 Content treeLinkContent;
 PackageDoc[] packages = configuration.root.specifiedPackages();
 if (packages.length == 1 && configuration.root.specifiedClasses().length == 0) {
 treeLinkContent = getHyperLink(pathString(packages[0],
-"package-tree.html"), "", treeLabel,
+DocPaths.PACKAGE_TREE), "", treeLabel,
 "", "");
 } else {
-treeLinkContent = getHyperLink(relativePath + "overview-tree.html",
+treeLinkContent = getHyperLink(pathToRoot.resolve(DocPaths.OVERVIEW_TREE),
 "", treeLabel, "", "");
 }
 Content li = HtmlTree.LI(treeLinkContent);
 return li;
 }
 *
 * @param label the label for the link
 * @return a content tree for the link
 */
 protected Content getNavLinkMainTree(String label) {
-Content mainTreeContent = getHyperLink(relativePath + "overview-tree.html",
+Content mainTreeContent = getHyperLink(pathToRoot.resolve(DocPaths.OVERVIEW_TREE),
 new StringContent(label));
 Content li = HtmlTree.LI(mainTreeContent);
 return li;
 }
 * Get "Deprecated" API link in the navigation bar.
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkDeprecated() {
-Content linkContent = getHyperLink(relativePath +
+Content linkContent = getHyperLink(pathToRoot.resolve(DocPaths.DEPRECATED_LIST),
-"deprecated-list.html", "", deprecatedLabel, "", "");
+"", deprecatedLabel, "", "");
 Content li = HtmlTree.LI(linkContent);
 return li;
 }
 /**
 * generated otherwise link to file "index-all.html" is generated.
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkClassIndex() {
-Content allClassesContent = getHyperLink(relativePath +
+Content allClassesContent = getHyperLink(pathToRoot.resolve(
-AllClassesFrameWriter.OUTPUT_FILE_NAME_NOFRAMES, "",
+DocPaths.ALLCLASSES_NOFRAME), "",
 allclassesLabel, "", "");
 Content li = HtmlTree.LI(allClassesContent);
 return li;
 }
 * Get link for generated class index.
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkIndex() {
-Content linkContent = getHyperLink(relativePath +(configuration.splitindex?
+Content linkContent = getHyperLink(pathToRoot.resolve(
-DirectoryManager.getPath("index-files") + fileseparator: "") +
+(configuration.splitindex
-(configuration.splitindex?"index-1.html" : "index-all.html"), "",
+? DocPaths.INDEX_FILES.resolve(DocPaths.indexN(1))
+: DocPaths.INDEX_ALL)), "",
 indexLabel, "", "");
 Content li = HtmlTree.LI(linkContent);
 return li;
 }
 * destination directory.
 *
 * @return a content tree for the link
 */
 protected Content getNavLinkHelp() {
-String helpfilenm = configuration.helpfile;
+String helpfile = configuration.helpfile;
-if (helpfilenm.equals("")) {
+DocPath helpfilenm;
-helpfilenm = "help-doc.html";
+if (helpfile.isEmpty()) {
+helpfilenm = DocPaths.HELP_DOC;
 } else {
-int lastsep;
+helpfilenm = DocPath.create(new File(helpfile).getName());
-if ((lastsep = helpfilenm.lastIndexOf(File.separatorChar)) != -1) {
+}
-helpfilenm = helpfilenm.substring(lastsep + 1);
+Content linkContent = getHyperLink(pathToRoot.resolve(helpfilenm), "",
-}
-}
-Content linkContent = getHyperLink(relativePath + helpfilenm, "",
 helpLabel, "", "");
 Content li = HtmlTree.LI(linkContent);
 return li;
 }
 contentTree.addContent(ul);
 }
 }
 /**
-* Return path to the class page for a classdoc. For example, the class
-* name is "java.lang.Object" and if the current file getting generated is
-* "java/io/File.html", then the path string to the class, returned is
-* "../../java/lang.Object.html".
-*
-* @param cd Class to which the path is requested.
-*/
-protected String pathToClass(ClassDoc cd) {
-return pathString(cd.containingPackage(), cd.name() + ".html");
-}
-/**
 * Return the path to the class page for a classdoc. Works same as
 * {@link #pathToClass(ClassDoc)}.
 *
 * @param cd   Class to which the path is requested.
 * @param name Name of the file(doesn't include path).
 */
-protected String pathString(ClassDoc cd, String name) {
+protected DocPath pathString(ClassDoc cd, DocPath name) {
 return pathString(cd.containingPackage(), name);
 }
 /**
 * Return path to the given file name in the given package. So if the name
 * "../../java/lang/Object.html"
 *
 * @param pd Package in which the file name is assumed to be.
 * @param name File name, to which path string is.
 */
-protected String pathString(PackageDoc pd, String name) {
+protected DocPath pathString(PackageDoc pd, DocPath name) {
-StringBuilder buf = new StringBuilder(relativePath);
+return pathToRoot.resolve(DocPath.forPackage(pd).resolve(name));
-buf.append(DirectoryManager.getPathToPackage(pd, name));
-return buf.toString();
 }
 /**
 * Return the link to the given package.
 *
 break;
 }
 }
 }
 if (included || pkg == null) {
-return getHyperLinkString(pathString(pkg, "package-summary.html"),
+return getHyperLinkString(pathString(pkg, DocPaths.PACKAGE_SUMMARY),
 "", label, isStrong, style);
 } else {
 String crossPkgLink = getCrossPackageLink(Util.getPackageName(pkg));
 if (crossPkgLink != null) {
-return getHyperLinkString(crossPkgLink, "", label, isStrong, style);
+return getHyperLinkString(/*TEMP*/ DocPath.create(crossPkgLink), "", label, isStrong, style);
 } else {
 return label;
 }
 }
 }
 break;
 }
 }
 }
 if (included || pkg == null) {
-return getHyperLink(pathString(pkg, "package-summary.html"),
+return getHyperLink(pathString(pkg, DocPaths.PACKAGE_SUMMARY),
 "", label);
 } else {
 String crossPkgLink = getCrossPackageLink(Util.getPackageName(pkg));
 if (crossPkgLink != null) {
-return getHyperLink(crossPkgLink, "", label);
+return getHyperLink(/*TEMP*/ DocPath.create(crossPkgLink), "", label);
 } else {
 return label;
 }
 }
 }
 ClassDoc cd = doc.containingClass();
 if (cd == null) {
 //d must be a class doc since in has no containing class.
 cd = (ClassDoc) doc;
 }
-String href = relativePath + DocletConstants.SOURCE_OUTPUT_DIR_NAME
+DocPath href = pathToRoot
-+ DirectoryManager.getDirectoryPath(cd.containingPackage())
+.resolve(DocPaths.SOURCE_OUTPUT)
-+ cd.name() + ".html#" + SourceToHTMLConverter.getAnchorName(doc);
+.resolve(DocPath.forClass(cd));
-Content linkContent = getHyperLink(href, "", label, "", "");
+Content linkContent = getHyperLink(href, SourceToHTMLConverter.getAnchorName(doc), label, "", "");
 htmltree.addContent(linkContent);
 }
 /**
 * Return the link to the given class.
 //class (assuming that it exists).  This is definitely a limitation of
 //the -link option.  There are ways to determine if an external package
 //exists, but no way to determine if the external class exists.  We just
 //have to assume that it does.
 return getHyperLinkString(
-configuration.extern.getExternalLink(packageName, relativePath,
+configuration.extern.getExternalLink(packageName, pathToRoot,
 className + ".html?is-external=true"),
 refMemName == null ? "" : refMemName,
 label == null || label.length() == 0 ? defaultLabel : label,
 strong, style,
 configuration.getText("doclet.Href_Class_Or_Interface_Title", packageName),
 }
 return configuration.extern.isExternal(cd);
 }
 public String getCrossPackageLink(String pkgName) {
-return configuration.extern.getExternalLink(pkgName, relativePath,
+return configuration.extern.getExternalLink(pkgName, pathToRoot,
 "package-summary.html?is-external=true");
 }
 /**
 * Get the class link.
 } else {
 //@see is not referencing an included class or package.  Check for cross links.
 String classCrossLink, packageCrossLink = getCrossPackageLink(refClassName);
 if (packageCrossLink != null) {
 //Package cross link found
-return getHyperLinkString(packageCrossLink, "",
+return getHyperLinkString(/*TEMP*/ DocPath.create(packageCrossLink), "",
 (label.isEmpty() ? text : label), false);
 } else if ((classCrossLink = getCrossClassLink(refClassName,
 refMemName, label, false, "", !plain)) != null) {
 //Class cross link found (possibly to a member in the class)
 return classCrossLink;
 * Adds the comment tags.
 *
 * @param doc the doc for which the comment tags will be generated
 * @param tags the first sentence tags for the doc
 * @param depr true if it is deprecated
-* @param first true if the first sentenge tags should be added
+* @param first true if the first sentence tags should be added
 * @param htmltree the documentation tree to which the comment tags will be added
 */
 private void addCommentTags(Doc doc, Tag[] tags, boolean depr,
 boolean first, Content htmltree) {
 if(configuration.nocomment){
 this instanceof PackageSummaryWriter;
 }
 /**
 * Suppose a piece of documentation has a relative link.  When you copy
-* that documetation to another place such as the index or class-use page,
+* that documentation to another place such as the index or class-use page,
 * that relative link will no longer work.  We should redirect those links
 * so that they will work again.
 * <p>
 * Here is the algorithm used to fix the link:
 * <p>
 private String redirectRelativeLinks(Doc doc, String text) {
 if (doc == null || shouldNotRedirectRelativeLinks()) {
 return text;
 }
-String redirectPathFromRoot;
+DocPath redirectPathFromRoot;
 if (doc instanceof ClassDoc) {
-redirectPathFromRoot = DirectoryManager.getDirectoryPath(((ClassDoc) doc).containingPackage());
+redirectPathFromRoot = DocPath.forPackage(((ClassDoc) doc).containingPackage());
 } else if (doc instanceof MemberDoc) {
-redirectPathFromRoot = DirectoryManager.getDirectoryPath(((MemberDoc) doc).containingPackage());
+redirectPathFromRoot = DocPath.forPackage(((MemberDoc) doc).containingPackage());
 } else if (doc instanceof PackageDoc) {
-redirectPathFromRoot = DirectoryManager.getDirectoryPath((PackageDoc) doc);
+redirectPathFromRoot = DocPath.forPackage((PackageDoc) doc);
 } else {
 return text;
-}
-if (! redirectPathFromRoot.endsWith(DirectoryManager.URL_FILE_SEPARATOR)) {
-redirectPathFromRoot += DirectoryManager.URL_FILE_SEPARATOR;
 }
 //Redirect all relative links.
 int end, begin = text.toLowerCase().indexOf("<a");
 if(begin >= 0){
 if (end == -1) {
 //Break without warning.  This <a> tag is not necessarily malformed.  The text
 //might be missing '>' character because the href has an inline tag.
 break;
 }
-if(textBuff.substring(begin, end).indexOf("\"") != -1){
+if (textBuff.substring(begin, end).indexOf("\"") != -1){
 begin = textBuff.indexOf("\"", begin) + 1;
 end = textBuff.indexOf("\"", begin +1);
-if(begin == 0 || end == -1){
+if (begin == 0 || end == -1){
 //Link is missing a quote.
 break;
 }
 }
 String relativeLink = textBuff.substring(begin, end);
-if(!(relativeLink.toLowerCase().startsWith("mailto:") ||
+if (!(relativeLink.toLowerCase().startsWith("mailto:") ||
 relativeLink.toLowerCase().startsWith("http:") ||
 relativeLink.toLowerCase().startsWith("https:") ||
-relativeLink.toLowerCase().startsWith("file:"))){
+relativeLink.toLowerCase().startsWith("file:"))) {
-relativeLink = "{@"+(new DocRootTaglet()).getName() + "}"
+relativeLink = "{@"+(new DocRootTaglet()).getName() + "}/"
-+ redirectPathFromRoot
++ redirectPathFromRoot.resolve(relativeLink).getPath();
-+ relativeLink;
 textBuff.replace(begin, end, relativeLink);
 }
 begin = textBuff.toString().toLowerCase().indexOf("<a", begin + 1);
 }
 return textBuff.toString();
 *
 * @return an HtmlTree for the lINK tag which provides the stylesheet location
 */
 public HtmlTree getStyleSheetProperties() {
 String filename = configuration.stylesheetfile;
+DocPath stylesheet;
 if (filename.length() > 0) {
-File stylefile = new File(filename);
+stylesheet = DocPath.create(new File(filename).getName());
-String parent = stylefile.getParent();
-filename = (parent == null)?
-filename:
-filename.substring(parent.length() + 1);
 } else {
-filename = "stylesheet.css";
+stylesheet = DocPaths.STYLESHEET;
 }
-filename = relativePath + filename;
+HtmlTree link = HtmlTree.LINK("stylesheet", "text/css",
-HtmlTree link = HtmlTree.LINK("stylesheet", "text/css", filename, "Style");
+pathToRoot.resolve(stylesheet).getPath(),
+"Style");
 return link;
 }
 /**
 * According to

changeset 14357	faf9cde2817b
parent 14266	69453558960d
child 14358	9eda9239cba0