/* * Copyright (c) 2013, 2017, 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 8025633 8025524 8081854 8187521 * @summary Test for valid name attribute in HTML anchors. * @author Bhavesh Patel * @library /tools/lib ../lib * @modules jdk.javadoc/jdk.javadoc.internal.tool * @build toolbox.ToolBox JavadocTester * @run main TestAnchorNames */ import java.io.IOException; import java.nio.charset.Charset; import java.nio.file.Path; import java.nio.file.Paths; import toolbox.*; public class TestAnchorNames extends JavadocTester { public final ToolBox tb; public static void main(String... args) throws Exception { TestAnchorNames tester = new TestAnchorNames(); tester.runTests(m -> new Object[] { Paths.get(m.getName()) }); } public TestAnchorNames() { tb = new ToolBox(); } @Test void testHtml4(Path ignore) { javadoc("-d", "out-html4", "-sourcepath", testSrc, "-source", "8", //so that '_' can be used as an identifier "-use", "pkg1"); checkExit(Exit.OK); // Test some section markers and links to these markers checkOutput("pkg1/RegClass.html", true, "", "", "", "", "", "", "", "", "", ""); // Test some members and link to these members checkOutput("pkg1/RegClass.html", true, //The marker for this appears in the serialized-form.html which we will //test below ""); // Test some fields checkOutput("pkg1/RegClass.html", true, "", "", "", "", "", "", "", "", "", "", "", "", "", ""); checkOutput("pkg1/DeprMemClass.html", true, "", ""); // Test constructor checkOutput("pkg1/RegClass.html", true, "", ""); // Test some methods checkOutput("pkg1/RegClass.html", true, "", "", "", "", "", "", "", "", "", "", "", "", "", ""); checkOutput("pkg1/DeprMemClass.html", true, "", ""); // Test enum checkOutput("pkg1/RegClass.Te$t_Enum.html", true, "", ""); // Test nested class checkOutput("pkg1/RegClass._NestedClas$.html", true, "", ""); // Test class use page checkOutput("pkg1/class-use/DeprMemClass.html", true, ""); // Test deprecated list page checkOutput("deprecated-list.html", true, "", ""); // Test constant values page checkOutput("constant-values.html", true, ""); // Test serialized form page checkOutput("serialized-form.html", true, //This is the marker for the link that appears in the pkg1.RegClass.html page ""); // Test member name index page checkOutput("index-all.html", true, "", "$", "_"); // The marker name conversion should only affect HTML anchors. It should not // affect the labels. checkOutput("pkg1/RegClass.html", false, " Z:Z_", " Z:Z:Dfield", " Z:Z_field_In_Class", " S_:D:D:D:D:DINT"); } @Test void testHtml5(Path ignore) { javadoc("-d", "out-html5", "-sourcepath", testSrc, "-source", "8", //so that '_' can be used as an identifier "-use", "-html5", "pkg1"); checkExit(Exit.OK); // Test some section markers and links to these markers checkOutput("pkg1/RegClass.html", true, "", "", "", "", "", "", "", "", ""); // Test some members and link to these members checkOutput("pkg1/RegClass.html", true, //The marker for this appears in the serialized-form.html which we will //test below ""); // Test some fields checkOutput("pkg1/RegClass.html", true, "", "", "", "", "", "", "", "", "", "", "", "", "", ""); checkOutput("pkg1/DeprMemClass.html", true, "", ""); // Test constructor checkOutput("pkg1/RegClass.html", true, "", ""); // Test some methods checkOutput("pkg1/RegClass.html", true, "", "", "", "", "", "", "", "", "", "", "", "", "", ""); checkOutput("pkg1/DeprMemClass.html", true, "", ""); // Test enum checkOutput("pkg1/RegClass.Te$t_Enum.html", true, "", ""); // Test nested class checkOutput("pkg1/RegClass._NestedClas$.html", true, "", ""); // Test class use page checkOutput("pkg1/class-use/DeprMemClass.html", true, ""); // Test deprecated list page checkOutput("deprecated-list.html", true, "", ""); // Test constant values page checkOutput("constant-values.html", true, ""); // Test serialized form page checkOutput("serialized-form.html", true, //This is the marker for the link that appears in the pkg1.RegClass.html page ""); // Test member name index page checkOutput("index-all.html", true, "", "$", "_"); } /** * The following test is somewhat simplistic, but it is useful * in conjunction with the W3C Validation Service at https://validator.w3.org/nu/#file * @param base A working directory for this method, in which some UTF-8 source files * will be generated * @throws IOException if there is a problem generating the source files */ @Test void testNonAscii(Path base) throws IOException { Path src = base.resolve("src"); tb.writeJavaFiles(src, "package p; public class Def {\n" + " public int \u00e0\u00e9;\n" // a`e' + " public void \u00c0\u00c9() { }\n" // A`E' + " public int \u03b1\u03b2\u03b3;\n" // alpha beta gamma + " public void \u0391\u0392\u0393() { }\n" // ALPHA BETA GAMMA + "}", "package p; \n" + "/**\n" + " * {@link Def#\u00e0\u00e9 àé}
\n" + " * {@link Def#\u00c0\u00c9() ÀÉ}
\n" + " * {@link Def#\u03b1\u03b2\u03b3 αβγ}
\n" + " * {@link Def#\u0391\u0392\u0393() ΑΒΓ}
\n" + " */\n" + "public class Ref { }"); javadoc("-d", "out-nonAscii", "-sourcepath", src.toString(), "-html5", "-encoding", "utf-8", "p"); checkExit(Exit.OK); checkOutput("p/Def.html", true, "", "", "", ""); checkOutput("p/Ref.html", true, "àé", "ÀÉ", "αβγ", "ΑΒΓ"); } }