8213956: javadoc crash using {@index} in doc-files file
Reviewed-by: jlahoda, hannesw, pmuthuswamy
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/DocFilesHandlerImpl.java Mon Nov 26 13:17:39 2018 -0500
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/DocFilesHandlerImpl.java Mon Nov 26 11:00:32 2018 -0800
@@ -169,7 +169,7 @@
DocPath dfilePath = dstPath.resolve(srcfile.getName());
HtmlDocletWriter docletWriter = new DocFileWriter(configuration, dfilePath, element);
- configuration.messages.notice("doclet.Generating_0", docletWriter.filename);
+ configuration.messages.notice("doclet.Generating_0", docletWriter.filename.getPath());
String title = getWindowTitle(docletWriter, dfElement).trim();
HtmlTree htmlContent = docletWriter.getBody(true, title);
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDoclet.java Mon Nov 26 13:17:39 2018 -0500
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDoclet.java Mon Nov 26 11:00:32 2018 -0800
@@ -139,19 +139,6 @@
if (configuration.createtree) {
TreeWriter.generate(configuration, classtree);
}
- if (configuration.createindex) {
- configuration.buildSearchTagIndex();
- if (configuration.splitindex) {
- SplitIndexWriter.generate(configuration, indexbuilder);
- } else {
- SingleIndexWriter.generate(configuration, indexbuilder);
- }
- AllClassesIndexWriter.generate(configuration,
- new IndexBuilder(configuration, nodeprecated, true));
- if (!configuration.packages.isEmpty()) {
- AllPackagesIndexWriter.generate(configuration);
- }
- }
if (!(configuration.nodeprecatedlist || nodeprecated)) {
DeprecatedListWriter.generate(configuration);
@@ -172,6 +159,20 @@
}
}
+ if (configuration.createindex) {
+ configuration.buildSearchTagIndex();
+ if (configuration.splitindex) {
+ SplitIndexWriter.generate(configuration, indexbuilder);
+ } else {
+ SingleIndexWriter.generate(configuration, indexbuilder);
+ }
+ AllClassesIndexWriter.generate(configuration,
+ new IndexBuilder(configuration, nodeprecated, true));
+ if (!configuration.packages.isEmpty()) {
+ AllPackagesIndexWriter.generate(configuration);
+ }
+ }
+
if (!configuration.frames) {
if (configuration.createoverview) {
IndexRedirectWriter.generate(configuration, DocPaths.OVERVIEW_SUMMARY, DocPaths.INDEX);
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java Mon Nov 26 13:17:39 2018 -0500
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TagletWriterImpl.java Mon Nov 26 11:00:32 2018 -0800
@@ -41,11 +41,11 @@
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
-import jdk.javadoc.internal.doclets.formats.html.markup.Links;
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml;
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
import jdk.javadoc.internal.doclets.toolkit.BaseConfiguration;
import jdk.javadoc.internal.doclets.toolkit.Content;
+import jdk.javadoc.internal.doclets.toolkit.DocletElement;
import jdk.javadoc.internal.doclets.toolkit.Resources;
import jdk.javadoc.internal.doclets.toolkit.builders.SerializedFormBuilder;
import jdk.javadoc.internal.doclets.toolkit.taglets.TagletWriter;
@@ -421,42 +421,38 @@
SearchIndexItem si = new SearchIndexItem();
si.setLabel(tagText);
si.setDescription(desc);
+ si.setUrl(htmlWriter.path.getPath() + "#" + anchorName);
DocPaths docPaths = configuration.docPaths;
new SimpleElementVisitor9<Void, Void>() {
@Override
- public Void visitModule(ModuleElement e, Void p) {
- si.setUrl(docPaths.moduleSummary(e).getPath() + "#" + anchorName);
- si.setHolder(utils.getFullyQualifiedName(element));
- return null;
- }
-
- @Override
- public Void visitPackage(PackageElement e, Void p) {
- si.setUrl(docPaths.forPackage(e).getPath()
- + "/" + DocPaths.PACKAGE_SUMMARY.getPath() + "#" + anchorName);
- si.setHolder(utils.getSimpleName(element));
- return null;
- }
-
- @Override
- public Void visitType(TypeElement e, Void p) {
- si.setUrl(docPaths.forClass(e).getPath() + "#" + anchorName);
- si.setHolder(utils.getFullyQualifiedName(e));
- return null;
- }
-
- @Override
public Void visitVariable(VariableElement e, Void p) {
TypeElement te = utils.getEnclosingTypeElement(e);
- si.setUrl(docPaths.forClass(te).getPath() + "#" + anchorName);
si.setHolder(utils.getFullyQualifiedName(e) + "." + utils.getSimpleName(e));
return null;
}
@Override
+ public Void visitUnknown(Element e, Void p) {
+ if (e instanceof DocletElement) {
+ DocletElement de = (DocletElement) e;
+ switch (de.getSubKind()) {
+ case OVERVIEW:
+ si.setHolder(resources.getText("doclet.Overview"));
+ break;
+ case DOCFILE:
+ si.setHolder(de.getPackageElement().toString());
+ break;
+ default:
+ throw new IllegalStateException();
+ }
+ return null;
+ } else {
+ return super.visitUnknown(e, p);
+ }
+ }
+
+ @Override
protected Void defaultAction(Element e, Void p) {
- TypeElement te = utils.getEnclosingTypeElement(e);
- si.setUrl(docPaths.forClass(te).getPath() + "#" + anchorName);
si.setHolder(utils.getFullyQualifiedName(e));
return null;
}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/test/langtools/jdk/javadoc/doclet/testIndexInPackageFiles/TestIndexInPackageFiles.java Mon Nov 26 11:00:32 2018 -0800
@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) 2018, 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.
+ *
+ * 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.
+ */
+
+/*
+ * @test
+ * @bug 8213957 8213958
+ * @summary Test use of at-index in package-iinfo and doc-files
+ * @library /tools/lib ../lib
+ * @modules jdk.javadoc/jdk.javadoc.internal.tool
+ * @build toolbox.ToolBox JavadocTester
+ * @run main TestIndexInPackageFiles
+ */
+
+import java.io.IOException;
+import java.nio.file.Path;
+import toolbox.ToolBox;
+
+public class TestIndexInPackageFiles extends JavadocTester {
+
+ public static void main(String... args) throws Exception {
+ TestIndexInPackageFiles tester = new TestIndexInPackageFiles ();
+ tester.runTests();
+ }
+
+ ToolBox tb = new ToolBox();
+
+ @Test
+ public void test() throws IOException {
+ Path src = Path.of("src");
+ tb.writeJavaFiles(src,
+ "/**\n"
+ + " * Summary.\n"
+ + " * {@index test.name.1 additional info}\n"
+ + " * {@systemProperty test.property.1}\n"
+ + " */\n"
+ + "package p.q;",
+ "package p.q;\n"
+ + "/** This is a class in p.q. */\n"
+ + "public class C { }\n");
+
+ tb.writeFile(src.resolve("p/q/doc-files/extra.html"),
+ "<html><head><title>Extra</title></head><body>\n"
+ + "<h1>Extra</h1>\n"
+ + "{@index test.name.2 additional info}\n"
+ + "{@systemProperty test.property.2}\n"
+ + "</body></html>\n");
+
+ tb.writeFile("overview.html",
+ "<html><head><title>Overview</title></head><body>\n"
+ + "<h1>Overview</h1>\n"
+ + "{@index test.name.3 additional info}\n"
+ + "</body></html>\n");
+
+
+ javadoc("-d", "out",
+ "-sourcepath", src.toString(),
+ "-overview", "overview.html",
+ "p.q");
+
+ checkExit(Exit.OK);
+
+ // Note there is an implicit call to checkLinks, but that only
+ // checks the links are valid if they are actually present.
+ // Here, we specifically check for both ends of each link.
+ // However, we assume the search index files are generated appropriately,
+ // to match the A-Z index files checked here.
+
+ checkOutput("p/q/package-summary.html", true,
+ "<a id=\"test.name.1\" class=\"searchTagResult\">test.name.1</a>",
+ "<a id=\"test.property.1\" class=\"searchTagResult\">test.property.1</a>");
+
+ checkOutput("p/q/doc-files/extra.html", true,
+ "<a id=\"test.name.2\" class=\"searchTagResult\">test.name.2</a>",
+ "<a id=\"test.property.2\" class=\"searchTagResult\">test.property.2</a>");
+
+ checkOutput("index.html", true,
+ "<a id=\"test.name.3\" class=\"searchTagResult\">test.name.3</a>");
+
+ checkOutput("index-all.html", true,
+ "<span class=\"searchTagLink\"><a href=\"p/q/package-summary.html#test.name.1\">test.name.1</a></span>",
+ "<span class=\"searchTagLink\"><a href=\"p/q/doc-files/extra.html#test.name.2\">test.name.2</a></span>",
+ "<span class=\"searchTagLink\"><a href=\"index.html#test.name.3\">test.name.3</a></span> - Search tag in Overview</dt>",
+ "<span class=\"searchTagLink\"><a href=\"p/q/package-summary.html#test.property.1\">test.property.1</a></span>",
+ "<span class=\"searchTagLink\"><a href=\"p/q/doc-files/extra.html#test.property.2\">test.property.2</a></span>");
+ }
+}
+