1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
|
/*
* Copyright (c) 2018, 2024, 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 8196027 8196202 8320458 8342705
* @summary test navigation links
* @modules jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
* jdk.javadoc/jdk.javadoc.internal.api
* jdk.javadoc/jdk.javadoc.internal.tool
* @library ../../lib /tools/lib
* @build toolbox.ToolBox toolbox.ModuleBuilder javadoc.tester.*
* @run main TestModuleNavigation
*/
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import javadoc.tester.JavadocTester;
import toolbox.ModuleBuilder;
import toolbox.ToolBox;
public class TestModuleNavigation extends JavadocTester {
public final ToolBox tb;
public static void main(String... args) throws Exception {
var tester = new TestModuleNavigation ();
tester.runTests();
}
public TestModuleNavigation () {
tb = new ToolBox();
}
@Test
public void testSingleModule(Path base) throws Exception {
Path src = Files.createDirectories(base.resolve("src"));
ModuleBuilder mb = new ModuleBuilder(tb, "m")
.comment("Module m.")
.exports("p1")
.classes("package p1; @Deprecated public class A {}")
.classes("package p1; public class B {}");
mb.write(src);
javadoc("-d", base.resolve("out-single-module").toString(),
"--module-source-path", src.toString(),
"--module", "m");
checkExit(Exit.OK);
checkOutput("index.html", true,
"""
<script type="text/javascript">window.location.replace('m/module-summary.html')</script>
<noscript>
<meta http-equiv="Refresh" content="0;m/module-summary.html">
</noscript>""",
"""
<p><a href="m/module-summary.html">m/module-summary.html</a></p>""");
checkOutput("m/module-summary.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li class="nav-bar-cell1-rev">Module</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../search.html">Search</a></li>
<li><a href="../help-doc.html#module">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../resource-fil\
es/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("overview-tree.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="m/module-summary.html">Module</a></li>
<li class="nav-bar-cell1-rev">Tree</li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="search.html">Search</a></li>
<li><a href="help-doc.html#tree">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="re\
source-files/sun.svg" alt="Select Theme" class="theme-light"><img src="resource-files/moo\
n.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("deprecated-list.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="m/module-summary.html">Module</a></li>
<li><a href="overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Deprecated</li>
<li><a href="index-all.html">Index</a></li>
<li><a href="search.html">Search</a></li>
<li><a href="help-doc.html#deprecated">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="re\
source-files/sun.svg" alt="Select Theme" class="theme-light"><img src="resource-files/moo\
n.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("index-all.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="m/module-summary.html">Module</a></li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="search.html">Search</a></li>
<li><a href="help-doc.html#index">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="re\
source-files/sun.svg" alt="Select Theme" class="theme-light"><img src="resource-files/moo\
n.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("search.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="m/module-summary.html">Module</a></li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li class="nav-bar-cell1-rev">Search</li>
<li><a href="help-doc.html#search">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="re\
source-files/sun.svg" alt="Select Theme" class="theme-light"><img src="resource-files/moo\
n.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("help-doc.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="m/module-summary.html">Module</a></li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="search.html">Search</a></li>
<li class="nav-bar-cell1-rev">Help</li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="re\
source-files/sun.svg" alt="Select Theme" class="theme-light"><img src="resource-files/moo\
n.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("m/p1/package-summary.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../module-summary.html">Module</a></li>
<li class="nav-bar-cell1-rev">Package</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
<li><a href="../../help-doc.html#package">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/../resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../../resour\
ce-files/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
checkOutput("m/p1/A.html", true,
"""
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../module-summary.html">Module</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
<li><a href="../../help-doc.html#class">Help</a></li>
<li><button id="theme-button" aria-label="Select Theme" title="Select Theme"><img src="..\
/../resource-files/sun.svg" alt="Select Theme" class="theme-light"><img src="../../resour\
ce-files/moon.svg" alt="Select Theme" class="theme-dark"></button></li>
</ul>""");
}
@Test
public void checkNavbar(Path base) throws Exception {
Path src = Files.createDirectories(base.resolve("src"));
ModuleBuilder mb = new ModuleBuilder(tb, "m")
.comment("module m.\n@uses p1.A")
.uses("p1.A")
.uses("p1.B")
.exports("p1")
.classes("package p1; @Deprecated public class A {}")
.classes("package p1; public class B {}");
mb.write(src);
ModuleBuilder mb1 = new ModuleBuilder(tb, "m2")
.comment("module m2.\n@uses m2p1.Am2")
.uses("m2p1.Am2")
.uses("m2p1.Bm2")
.exports("m2p1")
.classes("package m2p1; public class Am2 {}")
.classes("package m2p1; public class Bm2 {}");
mb1.write(src);
javadoc("-d", base.resolve("out").toString(), "-use",
"-quiet",
"--module-source-path", src.toString(),
"--module", "m,m2");
checkExit(Exit.OK);
checkOutput("index.html", false,
"Prev",
"Next",
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("m/module-summary.html", false,
"Prev Module",
"Next Module",
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("m2/m2p1/package-summary.html", false,
"Prev Package",
"Next Package",
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("m2/m2p1/Am2.html", false,
"Prev Class",
"Next Class",
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("m2/m2p1/class-use/Am2.html", false,
"Prev",
"Next",
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("m2/m2p1/package-tree.html", false,
"Prev",
"Next",
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("deprecated-list.html", false,
"Prev",
"Next",
"All Classes",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
checkOutput("index-all.html", false,
"Prev",
"Next",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");""",
"""
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");""");
}
}
|