Fri, 04 Oct 2013 13:32:30 -0700
8008164: Invisible table captions in javadoc-generated html
Reviewed-by: jjg
duke@1 | 1 | /* |
ohair@798 | 2 | * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
duke@1 | 7 | * published by the Free Software Foundation. |
duke@1 | 8 | * |
duke@1 | 9 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 12 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 13 | * accompanied this code). |
duke@1 | 14 | * |
duke@1 | 15 | * You should have received a copy of the GNU General Public License version |
duke@1 | 16 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 17 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 18 | * |
ohair@554 | 19 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 20 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 21 | * questions. |
duke@1 | 22 | */ |
duke@1 | 23 | |
duke@1 | 24 | /* |
duke@1 | 25 | * @test |
duke@1 | 26 | * @bug 4530730 |
duke@1 | 27 | * @summary stddoclet: With frames off, window titles have "()" appended |
duke@1 | 28 | * @author dkramer |
duke@1 | 29 | * @run main WindowTitles |
duke@1 | 30 | */ |
duke@1 | 31 | |
duke@1 | 32 | |
duke@1 | 33 | import com.sun.javadoc.*; |
duke@1 | 34 | import java.util.*; |
duke@1 | 35 | import java.io.*; |
duke@1 | 36 | |
duke@1 | 37 | // If needing regular expression pattern matching, |
duke@1 | 38 | // see /java/pubs/dev/linkfix/src/LinkFix.java |
duke@1 | 39 | |
duke@1 | 40 | /** |
duke@1 | 41 | * Runs javadoc and runs regression tests on the resulting HTML. |
duke@1 | 42 | * It reads each file, complete with newlines, into a string to easily |
duke@1 | 43 | * find strings that contain newlines. |
duke@1 | 44 | */ |
duke@1 | 45 | public class WindowTitles |
duke@1 | 46 | { |
duke@1 | 47 | private static final String BUGID = "4530730"; |
duke@1 | 48 | private static final String BUGNAME = "WindowTitles"; |
duke@1 | 49 | private static final String FS = System.getProperty("file.separator"); |
duke@1 | 50 | private static final String PS = System.getProperty("path.separator"); |
duke@1 | 51 | private static final String LS = System.getProperty("line.separator"); |
duke@1 | 52 | private static final String TMPDIR_STRING1 = "." + FS + "docs1" + FS; |
duke@1 | 53 | private static final String TMPDIR_STRING2 = "." + FS + "docs2" + FS; |
duke@1 | 54 | |
duke@1 | 55 | // Subtest number. Needed because runResultsOnHTML is run twice, and subtestNum |
duke@1 | 56 | // should increment across subtest runs. |
duke@1 | 57 | public static int subtestNum = 0; |
duke@1 | 58 | public static int numSubtestsPassed = 0; |
duke@1 | 59 | |
duke@1 | 60 | // Entry point |
duke@1 | 61 | public static void main(String[] args) { |
duke@1 | 62 | |
duke@1 | 63 | // Directory that contains source files that javadoc runs on |
duke@1 | 64 | String srcdir = System.getProperty("test.src", "."); |
duke@1 | 65 | |
duke@1 | 66 | // Test for all cases except the split index page |
duke@1 | 67 | runJavadoc(new String[] {"-d", TMPDIR_STRING1, |
duke@1 | 68 | "-use", |
duke@1 | 69 | "-sourcepath", srcdir, |
duke@1 | 70 | "p1", "p2"}); |
duke@1 | 71 | runTestsOnHTML(testArray); |
duke@1 | 72 | |
duke@1 | 73 | // Test only for the split-index case (and run on only one package) |
duke@1 | 74 | System.out.println(""); // blank line |
duke@1 | 75 | runJavadoc(new String[] {"-d", TMPDIR_STRING2, |
duke@1 | 76 | "-splitindex", |
duke@1 | 77 | "-sourcepath", System.getProperty("test.src", "."), |
duke@1 | 78 | "p1"}); |
duke@1 | 79 | runTestsOnHTML(testSplitIndexArray); |
duke@1 | 80 | |
duke@1 | 81 | printSummary(); |
duke@1 | 82 | } |
duke@1 | 83 | |
duke@1 | 84 | /** Run javadoc */ |
duke@1 | 85 | public static void runJavadoc(String[] javadocArgs) { |
duke@1 | 86 | if (com.sun.tools.javadoc.Main.execute(javadocArgs) != 0) { |
duke@1 | 87 | throw new Error("Javadoc failed to execute"); |
duke@1 | 88 | } |
duke@1 | 89 | } |
duke@1 | 90 | |
duke@1 | 91 | /** |
duke@1 | 92 | * Assign value for [ stringToFind, filename ] |
duke@1 | 93 | * NOTE: The standard doclet uses platform-specific line separators (LS) |
duke@1 | 94 | */ |
duke@1 | 95 | private static final String[][] testArray = { |
duke@1 | 96 | |
bpatel@766 | 97 | { "<title>Overview</title>", |
duke@1 | 98 | TMPDIR_STRING1 + "overview-summary.html" }, |
duke@1 | 99 | |
bpatel@766 | 100 | { "<title>Class Hierarchy</title>", |
duke@1 | 101 | TMPDIR_STRING1 + "overview-tree.html" }, |
duke@1 | 102 | |
bpatel@766 | 103 | { "<title>Overview List</title>", |
duke@1 | 104 | TMPDIR_STRING1 + "overview-frame.html" }, |
duke@1 | 105 | |
bpatel@766 | 106 | { "<title>p1</title>", |
duke@1 | 107 | TMPDIR_STRING1 + "p1" + FS + "package-summary.html" }, |
duke@1 | 108 | |
bpatel@766 | 109 | { "<title>p1</title>", |
duke@1 | 110 | TMPDIR_STRING1 + "p1" + FS + "package-frame.html" }, |
duke@1 | 111 | |
bpatel@766 | 112 | { "<title>p1 Class Hierarchy</title>", |
duke@1 | 113 | TMPDIR_STRING1 + "p1" + FS + "package-tree.html" }, |
duke@1 | 114 | |
bpatel@766 | 115 | { "<title>Uses of Package p1</title>", |
duke@1 | 116 | TMPDIR_STRING1 + "p1" + FS + "package-use.html" }, |
duke@1 | 117 | |
bpatel@766 | 118 | { "<title>C1</title>", |
duke@1 | 119 | TMPDIR_STRING1 + "p1" + FS + "C1.html" }, |
duke@1 | 120 | |
bpatel@766 | 121 | { "<title>All Classes</title>", |
duke@1 | 122 | TMPDIR_STRING1 + "allclasses-frame.html" }, |
duke@1 | 123 | |
bpatel@766 | 124 | { "<title>All Classes</title>", |
duke@1 | 125 | TMPDIR_STRING1 + "allclasses-noframe.html" }, |
duke@1 | 126 | |
bpatel@766 | 127 | { "<title>Constant Field Values</title>", |
duke@1 | 128 | TMPDIR_STRING1 + "constant-values.html" }, |
duke@1 | 129 | |
bpatel@766 | 130 | { "<title>Deprecated List</title>", |
duke@1 | 131 | TMPDIR_STRING1 + "deprecated-list.html" }, |
duke@1 | 132 | |
bpatel@766 | 133 | { "<title>Serialized Form</title>", |
duke@1 | 134 | TMPDIR_STRING1 + "serialized-form.html" }, |
duke@1 | 135 | |
bpatel@766 | 136 | { "<title>API Help</title>", |
duke@1 | 137 | TMPDIR_STRING1 + "help-doc.html" }, |
duke@1 | 138 | |
bpatel@766 | 139 | { "<title>Index</title>", |
duke@1 | 140 | TMPDIR_STRING1 + "index-all.html" }, |
duke@1 | 141 | |
bpatel@766 | 142 | { "<title>Uses of Class p1.C1</title>", |
duke@1 | 143 | TMPDIR_STRING1 + "p1" + FS + "class-use" + FS + "C1.html" }, |
duke@1 | 144 | }; |
duke@1 | 145 | |
duke@1 | 146 | /** |
duke@1 | 147 | * Assign value for [ stringToFind, filename ] for split index page |
duke@1 | 148 | */ |
duke@1 | 149 | private static final String[][] testSplitIndexArray = { |
bpatel@766 | 150 | { "<title>C-Index</title>", |
duke@1 | 151 | TMPDIR_STRING2 + "index-files" + FS + "index-1.html" }, |
duke@1 | 152 | }; |
duke@1 | 153 | |
duke@1 | 154 | public static void runTestsOnHTML(String[][] testArray) { |
duke@1 | 155 | |
duke@1 | 156 | for (int i = 0; i < testArray.length; i++) { |
duke@1 | 157 | |
duke@1 | 158 | subtestNum += 1; |
duke@1 | 159 | |
duke@1 | 160 | // Read contents of file into a string |
duke@1 | 161 | String fileString = readFileToString(testArray[i][1]); |
duke@1 | 162 | |
duke@1 | 163 | // Get string to find |
duke@1 | 164 | String stringToFind = testArray[i][0]; |
duke@1 | 165 | |
duke@1 | 166 | // Find string in file's contents |
duke@1 | 167 | if (findString(fileString, stringToFind) == -1) { |
duke@1 | 168 | System.out.println("\nSub-test " + (subtestNum) |
duke@1 | 169 | + " for bug " + BUGID + " (" + BUGNAME + ") FAILED\n" |
duke@1 | 170 | + "when searching for:\n" |
duke@1 | 171 | + stringToFind); |
duke@1 | 172 | } else { |
duke@1 | 173 | numSubtestsPassed += 1; |
duke@1 | 174 | System.out.println("\nSub-test " + (subtestNum) + " passed:\n" + stringToFind); |
duke@1 | 175 | } |
duke@1 | 176 | } |
duke@1 | 177 | } |
duke@1 | 178 | |
duke@1 | 179 | public static void printSummary() { |
duke@1 | 180 | if ( numSubtestsPassed == subtestNum ) { |
duke@1 | 181 | System.out.println("\nAll " + numSubtestsPassed + " subtests passed"); |
duke@1 | 182 | } else { |
duke@1 | 183 | throw new Error("\n" + (subtestNum - numSubtestsPassed) + " of " + (subtestNum) |
duke@1 | 184 | + " subtests failed for bug " + BUGID + " (" + BUGNAME + ")\n"); |
duke@1 | 185 | } |
duke@1 | 186 | } |
duke@1 | 187 | |
duke@1 | 188 | // Read the file into a String |
duke@1 | 189 | public static String readFileToString(String filename) { |
duke@1 | 190 | try { |
duke@1 | 191 | File file = new File(filename); |
duke@1 | 192 | if ( !file.exists() ) { |
duke@1 | 193 | System.out.println("\nFILE DOES NOT EXIST: " + filename); |
duke@1 | 194 | } |
duke@1 | 195 | BufferedReader in = new BufferedReader(new FileReader(file)); |
duke@1 | 196 | |
duke@1 | 197 | // Create an array of characters the size of the file |
duke@1 | 198 | char[] allChars = new char[(int)file.length()]; |
duke@1 | 199 | |
duke@1 | 200 | // Read the characters into the allChars array |
duke@1 | 201 | in.read(allChars, 0, (int)file.length()); |
duke@1 | 202 | in.close(); |
duke@1 | 203 | |
duke@1 | 204 | // Convert to a string |
duke@1 | 205 | String allCharsString = new String(allChars); |
duke@1 | 206 | |
duke@1 | 207 | return allCharsString; |
duke@1 | 208 | |
duke@1 | 209 | } catch (FileNotFoundException e) { |
duke@1 | 210 | System.err.println(e); |
duke@1 | 211 | return ""; |
duke@1 | 212 | } catch (IOException e) { |
duke@1 | 213 | System.err.println(e); |
duke@1 | 214 | return ""; |
duke@1 | 215 | } |
duke@1 | 216 | } |
duke@1 | 217 | |
duke@1 | 218 | public static int findString(String fileString, String stringToFind) { |
duke@1 | 219 | return fileString.indexOf(stringToFind); |
duke@1 | 220 | } |
duke@1 | 221 | } |