Wed, 03 Feb 2010 11:28:21 -0800
6922429: extend tree position test waiver
Reviewed-by: darcy
jjg@482 | 1 | /* |
jjg@482 | 2 | * Copyright 2010 Sun Microsystems, Inc. All Rights Reserved. |
jjg@482 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
jjg@482 | 4 | * |
jjg@482 | 5 | * This code is free software; you can redistribute it and/or modify it |
jjg@482 | 6 | * under the terms of the GNU General Public License version 2 only, as |
jjg@482 | 7 | * published by the Free Software Foundation. |
jjg@482 | 8 | * |
jjg@482 | 9 | * This code is distributed in the hope that it will be useful, but WITHOUT |
jjg@482 | 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
jjg@482 | 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
jjg@482 | 12 | * version 2 for more details (a copy is included in the LICENSE file that |
jjg@482 | 13 | * accompanied this code). |
jjg@482 | 14 | * |
jjg@482 | 15 | * You should have received a copy of the GNU General Public License version |
jjg@482 | 16 | * 2 along with this work; if not, write to the Free Software Foundation, |
jjg@482 | 17 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
jjg@482 | 18 | * |
jjg@482 | 19 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
jjg@482 | 20 | * CA 95054 USA or visit www.sun.com if you need additional information or |
jjg@482 | 21 | * have any questions. |
jjg@482 | 22 | */ |
jjg@482 | 23 | |
jjg@482 | 24 | import java.awt.BorderLayout; |
jjg@482 | 25 | import java.awt.Color; |
jjg@482 | 26 | import java.awt.Dimension; |
jjg@482 | 27 | import java.awt.EventQueue; |
jjg@482 | 28 | import java.awt.Font; |
jjg@482 | 29 | import java.awt.GridBagConstraints; |
jjg@482 | 30 | import java.awt.GridBagLayout; |
jjg@482 | 31 | import java.awt.Rectangle; |
jjg@482 | 32 | import java.awt.event.ActionEvent; |
jjg@482 | 33 | import java.awt.event.ActionListener; |
jjg@482 | 34 | import java.awt.event.MouseAdapter; |
jjg@482 | 35 | import java.awt.event.MouseEvent; |
jjg@482 | 36 | import java.io.File; |
jjg@482 | 37 | import java.io.IOException; |
jjg@482 | 38 | import java.io.PrintStream; |
jjg@482 | 39 | import java.io.PrintWriter; |
jjg@482 | 40 | import java.io.StringWriter; |
jjg@482 | 41 | import java.lang.reflect.Field; |
jjg@482 | 42 | import java.lang.reflect.Modifier; |
jjg@482 | 43 | import java.nio.charset.Charset; |
jjg@482 | 44 | import java.util.ArrayList; |
jjg@482 | 45 | import java.util.Collections; |
jjg@482 | 46 | import java.util.HashMap; |
jjg@482 | 47 | import java.util.HashSet; |
jjg@482 | 48 | import java.util.Iterator; |
jjg@482 | 49 | import java.util.List; |
jjg@482 | 50 | import java.util.Map; |
jjg@482 | 51 | import java.util.Set; |
jjg@482 | 52 | import javax.swing.DefaultComboBoxModel; |
jjg@482 | 53 | import javax.swing.JComboBox; |
jjg@482 | 54 | import javax.swing.JComponent; |
jjg@482 | 55 | import javax.swing.JFrame; |
jjg@482 | 56 | import javax.swing.JLabel; |
jjg@482 | 57 | import javax.swing.JPanel; |
jjg@482 | 58 | import javax.swing.JScrollPane; |
jjg@482 | 59 | import javax.swing.JTextArea; |
jjg@482 | 60 | import javax.swing.JTextField; |
jjg@482 | 61 | import javax.swing.SwingUtilities; |
jjg@482 | 62 | import javax.swing.event.CaretEvent; |
jjg@482 | 63 | import javax.swing.event.CaretListener; |
jjg@482 | 64 | import javax.swing.text.BadLocationException; |
jjg@482 | 65 | import javax.swing.text.DefaultHighlighter; |
jjg@482 | 66 | import javax.swing.text.Highlighter; |
jjg@482 | 67 | import javax.tools.Diagnostic; |
jjg@482 | 68 | import javax.tools.DiagnosticListener; |
jjg@482 | 69 | import javax.tools.JavaFileObject; |
jjg@482 | 70 | import javax.tools.StandardJavaFileManager; |
jjg@482 | 71 | |
jjg@482 | 72 | import com.sun.source.tree.CompilationUnitTree; |
jjg@482 | 73 | import com.sun.source.util.JavacTask; |
jjg@482 | 74 | import com.sun.tools.javac.api.JavacTool; |
jjg@482 | 75 | import com.sun.tools.javac.code.Flags; |
jjg@482 | 76 | import com.sun.tools.javac.tree.JCTree; |
jjg@482 | 77 | import com.sun.tools.javac.tree.JCTree.JCCompilationUnit; |
jjg@482 | 78 | import com.sun.tools.javac.tree.JCTree.JCNewClass; |
jjg@482 | 79 | import com.sun.tools.javac.tree.JCTree.JCVariableDecl; |
jjg@482 | 80 | import com.sun.tools.javac.tree.TreeInfo; |
jjg@482 | 81 | import com.sun.tools.javac.tree.TreeScanner; |
jjg@482 | 82 | |
jjg@482 | 83 | import static com.sun.tools.javac.util.Position.NOPOS; |
jjg@482 | 84 | |
jjg@482 | 85 | /** |
jjg@482 | 86 | * Utility and test program to check validity of tree positions for tree nodes. |
jjg@482 | 87 | * The program can be run standalone, or as a jtreg test. In standalone mode, |
jjg@482 | 88 | * errors can be displayed in a gui viewer. For info on command line args, |
jjg@482 | 89 | * run program with no args. |
jjg@482 | 90 | * |
jjg@482 | 91 | * <p> |
jjg@482 | 92 | * jtreg: Note that by using the -r switch in the test description below, this test |
jjg@482 | 93 | * will process all java files in the langtools/test directory, thus implicitly |
jjg@482 | 94 | * covering any new language features that may be tested in this test suite. |
jjg@482 | 95 | */ |
jjg@482 | 96 | |
jjg@482 | 97 | /* |
jjg@482 | 98 | * @test |
jjg@482 | 99 | * @bug 6919889 |
jjg@482 | 100 | * @summary assorted position errors in compiler syntax trees |
jjg@486 | 101 | * @run main TreePosTest -q -r -ef ./tools/javac/typeAnnotations -ef ./tools/javap/typeAnnotations . |
jjg@482 | 102 | */ |
jjg@482 | 103 | public class TreePosTest { |
jjg@482 | 104 | /** |
jjg@482 | 105 | * Main entry point. |
jjg@482 | 106 | * If test.src is set, program runs in jtreg mode, and will throw an Error |
jjg@482 | 107 | * if any errors arise, otherwise System.exit will be used, unless the gui |
jjg@482 | 108 | * viewer is being used. In jtreg mode, the default base directory for file |
jjg@482 | 109 | * args is the value of ${test.src}. In jtreg mode, the -r option can be |
jjg@482 | 110 | * given to change the default base directory to the root test directory. |
jjg@482 | 111 | */ |
jjg@482 | 112 | public static void main(String... args) { |
jjg@482 | 113 | String testSrc = System.getProperty("test.src"); |
jjg@482 | 114 | File baseDir = (testSrc == null) ? null : new File(testSrc); |
jjg@482 | 115 | boolean ok = new TreePosTest().run(baseDir, args); |
jjg@482 | 116 | if (!ok) { |
jjg@482 | 117 | if (testSrc != null) // jtreg mode |
jjg@482 | 118 | throw new Error("failed"); |
jjg@482 | 119 | else |
jjg@482 | 120 | System.exit(1); |
jjg@482 | 121 | } |
jjg@482 | 122 | } |
jjg@482 | 123 | |
jjg@482 | 124 | /** |
jjg@482 | 125 | * Run the program. A base directory can be provided for file arguments. |
jjg@482 | 126 | * In jtreg mode, the -r option can be given to change the default base |
jjg@482 | 127 | * directory to the test root directory. For other options, see usage(). |
jjg@482 | 128 | * @param baseDir base directory for any file arguments. |
jjg@482 | 129 | * @param args command line args |
jjg@482 | 130 | * @return true if successful or in gui mode |
jjg@482 | 131 | */ |
jjg@482 | 132 | boolean run(File baseDir, String... args) { |
jjg@482 | 133 | if (args.length == 0) { |
jjg@482 | 134 | usage(System.out); |
jjg@482 | 135 | return true; |
jjg@482 | 136 | } |
jjg@482 | 137 | |
jjg@482 | 138 | List<File> files = new ArrayList<File>(); |
jjg@482 | 139 | for (int i = 0; i < args.length; i++) { |
jjg@482 | 140 | String arg = args[i]; |
jjg@482 | 141 | if (arg.equals("-encoding") && i + 1 < args.length) |
jjg@482 | 142 | encoding = args[++i]; |
jjg@482 | 143 | else if (arg.equals("-gui")) |
jjg@482 | 144 | gui = true; |
jjg@482 | 145 | else if (arg.equals("-q")) |
jjg@482 | 146 | quiet = true; |
jjg@482 | 147 | else if (arg.equals("-v")) |
jjg@482 | 148 | verbose = true; |
jjg@482 | 149 | else if (arg.equals("-t") && i + 1 < args.length) |
jjg@482 | 150 | tags.add(args[++i]); |
jjg@482 | 151 | else if (arg.equals("-ef") && i + 1 < args.length) |
jjg@482 | 152 | excludeFiles.add(new File(baseDir, args[++i])); |
jjg@482 | 153 | else if (arg.equals("-r")) { |
jjg@482 | 154 | if (excludeFiles.size() > 0) |
jjg@482 | 155 | throw new Error("-r must be used before -ef"); |
jjg@482 | 156 | File d = baseDir; |
jjg@482 | 157 | while (!new File(d, "TEST.ROOT").exists()) { |
jjg@482 | 158 | d = d.getParentFile(); |
jjg@482 | 159 | if (d == null) |
jjg@482 | 160 | throw new Error("cannot find TEST.ROOT"); |
jjg@482 | 161 | } |
jjg@482 | 162 | baseDir = d; |
jjg@482 | 163 | } |
jjg@482 | 164 | else if (arg.startsWith("-")) |
jjg@482 | 165 | throw new Error("unknown option: " + arg); |
jjg@482 | 166 | else { |
jjg@482 | 167 | while (i < args.length) |
jjg@482 | 168 | files.add(new File(baseDir, args[i++])); |
jjg@482 | 169 | } |
jjg@482 | 170 | } |
jjg@482 | 171 | |
jjg@482 | 172 | for (File file: files) { |
jjg@482 | 173 | if (file.exists()) |
jjg@482 | 174 | test(file); |
jjg@482 | 175 | else |
jjg@482 | 176 | error("File not found: " + file); |
jjg@482 | 177 | } |
jjg@482 | 178 | |
jjg@482 | 179 | if (fileCount != 1) |
jjg@482 | 180 | System.err.println(fileCount + " files read"); |
jjg@482 | 181 | if (errors > 0) |
jjg@482 | 182 | System.err.println(errors + " errors"); |
jjg@482 | 183 | |
jjg@482 | 184 | return (gui || errors == 0); |
jjg@482 | 185 | } |
jjg@482 | 186 | |
jjg@482 | 187 | /** |
jjg@482 | 188 | * Print command line help. |
jjg@482 | 189 | * @param out output stream |
jjg@482 | 190 | */ |
jjg@482 | 191 | void usage(PrintStream out) { |
jjg@482 | 192 | out.println("Usage:"); |
jjg@482 | 193 | out.println(" java TreePosTest options... files..."); |
jjg@482 | 194 | out.println(""); |
jjg@482 | 195 | out.println("where options include:"); |
jjg@482 | 196 | out.println("-gui Display returns in a GUI viewer"); |
jjg@482 | 197 | out.println("-q Quiet: don't report on inapplicable files"); |
jjg@482 | 198 | out.println("-v Verbose: report on files as they are being read"); |
jjg@482 | 199 | out.println("-t tag Limit checks to tree nodes with this tag"); |
jjg@482 | 200 | out.println(" Can be repeated if desired"); |
jjg@482 | 201 | out.println("-ef file Exclude file or directory"); |
jjg@482 | 202 | out.println(""); |
jjg@482 | 203 | out.println("files may be directories or files"); |
jjg@482 | 204 | out.println("directories will be scanned recursively"); |
jjg@482 | 205 | out.println("non java files, or java files which cannot be parsed, will be ignored"); |
jjg@482 | 206 | out.println(""); |
jjg@482 | 207 | } |
jjg@482 | 208 | |
jjg@482 | 209 | /** |
jjg@482 | 210 | * Test a file. If the file is a directory, it will be recursively scanned |
jjg@482 | 211 | * for java files. |
jjg@482 | 212 | * @param file the file or directory to test |
jjg@482 | 213 | */ |
jjg@482 | 214 | void test(File file) { |
jjg@482 | 215 | if (excludeFiles.contains(file)) { |
jjg@482 | 216 | if (!quiet) |
jjg@482 | 217 | error("File " + file + " excluded"); |
jjg@482 | 218 | return; |
jjg@482 | 219 | } |
jjg@482 | 220 | |
jjg@482 | 221 | if (file.isDirectory()) { |
jjg@482 | 222 | for (File f: file.listFiles()) { |
jjg@482 | 223 | test(f); |
jjg@482 | 224 | } |
jjg@482 | 225 | return; |
jjg@482 | 226 | } |
jjg@482 | 227 | |
jjg@482 | 228 | if (file.isFile() && file.getName().endsWith(".java")) { |
jjg@482 | 229 | try { |
jjg@482 | 230 | if (verbose) |
jjg@482 | 231 | System.err.println(file); |
jjg@482 | 232 | fileCount++; |
jjg@482 | 233 | PosTester p = new PosTester(); |
jjg@482 | 234 | p.test(read(file)); |
jjg@482 | 235 | } catch (ParseException e) { |
jjg@482 | 236 | if (!quiet) { |
jjg@482 | 237 | error("Error parsing " + file + "\n" + e.getMessage()); |
jjg@482 | 238 | } |
jjg@482 | 239 | } catch (IOException e) { |
jjg@482 | 240 | error("Error reading " + file + ": " + e); |
jjg@482 | 241 | } |
jjg@482 | 242 | return; |
jjg@482 | 243 | } |
jjg@482 | 244 | |
jjg@482 | 245 | if (!quiet) |
jjg@482 | 246 | error("File " + file + " ignored"); |
jjg@482 | 247 | } |
jjg@482 | 248 | |
jjg@482 | 249 | /** |
jjg@482 | 250 | * Read a file. |
jjg@482 | 251 | * @param file the file to be read |
jjg@482 | 252 | * @return the tree for the content of the file |
jjg@482 | 253 | * @throws IOException if any IO errors occur |
jjg@482 | 254 | * @throws TreePosTest.ParseException if any errors occur while parsing the file |
jjg@482 | 255 | */ |
jjg@482 | 256 | JCCompilationUnit read(File file) throws IOException, ParseException { |
jjg@482 | 257 | StringWriter sw = new StringWriter(); |
jjg@482 | 258 | PrintWriter pw = new PrintWriter(sw); |
jjg@482 | 259 | Reporter r = new Reporter(pw); |
jjg@482 | 260 | JavacTool tool = JavacTool.create(); |
jjg@482 | 261 | Charset cs = (encoding == null ? null : Charset.forName(encoding)); |
jjg@482 | 262 | StandardJavaFileManager fm = tool.getStandardFileManager(r, null, null); |
jjg@482 | 263 | Iterable<? extends JavaFileObject> files = fm.getJavaFileObjects(file); |
jjg@482 | 264 | JavacTask task = tool.getTask(pw, fm, r, Collections.<String>emptyList(), null, files); |
jjg@482 | 265 | Iterable<? extends CompilationUnitTree> trees = task.parse(); |
jjg@482 | 266 | pw.flush(); |
jjg@482 | 267 | if (r.errors > 0) |
jjg@482 | 268 | throw new ParseException(sw.toString()); |
jjg@482 | 269 | Iterator<? extends CompilationUnitTree> iter = trees.iterator(); |
jjg@482 | 270 | if (!iter.hasNext()) |
jjg@482 | 271 | throw new Error("no trees found"); |
jjg@482 | 272 | JCCompilationUnit t = (JCCompilationUnit) iter.next(); |
jjg@482 | 273 | if (iter.hasNext()) |
jjg@482 | 274 | throw new Error("too many trees found"); |
jjg@482 | 275 | return t; |
jjg@482 | 276 | } |
jjg@482 | 277 | |
jjg@482 | 278 | /** |
jjg@482 | 279 | * Report an error. When the program is complete, the program will either |
jjg@482 | 280 | * exit or throw an Error if any errors have been reported. |
jjg@482 | 281 | * @param msg the error message |
jjg@482 | 282 | */ |
jjg@482 | 283 | void error(String msg) { |
jjg@482 | 284 | System.err.println(msg); |
jjg@482 | 285 | errors++; |
jjg@482 | 286 | } |
jjg@482 | 287 | |
jjg@482 | 288 | /** Number of files that have been analyzed. */ |
jjg@482 | 289 | int fileCount; |
jjg@482 | 290 | /** Number of errors reported. */ |
jjg@482 | 291 | int errors; |
jjg@482 | 292 | /** Flag: don't report irrelevant files. */ |
jjg@482 | 293 | boolean quiet; |
jjg@482 | 294 | /** Flag: report files as they are processed. */ |
jjg@482 | 295 | boolean verbose; |
jjg@482 | 296 | /** Flag: show errors in GUI viewer. */ |
jjg@482 | 297 | boolean gui; |
jjg@482 | 298 | /** Option: encoding for test files. */ |
jjg@482 | 299 | String encoding; |
jjg@482 | 300 | /** The GUI viewer for errors. */ |
jjg@482 | 301 | Viewer viewer; |
jjg@482 | 302 | /** The set of tags for tree nodes to be analyzed; if empty, all tree nodes |
jjg@482 | 303 | * are analyzed. */ |
jjg@482 | 304 | Set<String> tags = new HashSet<String>(); |
jjg@482 | 305 | /** Set of files and directories to be excluded from analysis. */ |
jjg@482 | 306 | Set<File> excludeFiles = new HashSet<File>(); |
jjg@482 | 307 | /** Table of printable names for tree tag values. */ |
jjg@482 | 308 | TagNames tagNames = new TagNames(); |
jjg@482 | 309 | |
jjg@482 | 310 | /** |
jjg@482 | 311 | * Main class for testing assertions concerning tree positions for tree nodes. |
jjg@482 | 312 | */ |
jjg@482 | 313 | private class PosTester extends TreeScanner { |
jjg@482 | 314 | void test(JCCompilationUnit tree) { |
jjg@482 | 315 | sourcefile = tree.sourcefile; |
jjg@482 | 316 | endPosTable = tree.endPositions; |
jjg@482 | 317 | encl = new Info(); |
jjg@482 | 318 | tree.accept(this); |
jjg@482 | 319 | } |
jjg@482 | 320 | |
jjg@482 | 321 | @Override |
jjg@482 | 322 | public void scan(JCTree tree) { |
jjg@482 | 323 | if (tree == null) |
jjg@482 | 324 | return; |
jjg@482 | 325 | |
jjg@482 | 326 | Info self = new Info(tree, endPosTable); |
jjg@482 | 327 | if (check(self)) { |
jjg@482 | 328 | // Modifiers nodes are present throughout the tree even where |
jjg@482 | 329 | // there is no corresponding source text. |
jjg@482 | 330 | // Redundant semicolons in a class definition can cause empty |
jjg@482 | 331 | // initializer blocks with no positions. |
jjg@482 | 332 | if ((self.tag == JCTree.MODIFIERS || self.tag == JCTree.BLOCK) |
jjg@482 | 333 | && self.pos == NOPOS) { |
jjg@482 | 334 | // If pos is NOPOS, so should be the start and end positions |
jjg@482 | 335 | check("start == NOPOS", encl, self, self.start == NOPOS); |
jjg@482 | 336 | check("end == NOPOS", encl, self, self.end == NOPOS); |
jjg@482 | 337 | } else { |
jjg@482 | 338 | // For this node, start , pos, and endpos should be all defined |
jjg@482 | 339 | check("start != NOPOS", encl, self, self.start != NOPOS); |
jjg@482 | 340 | check("pos != NOPOS", encl, self, self.pos != NOPOS); |
jjg@482 | 341 | check("end != NOPOS", encl, self, self.end != NOPOS); |
jjg@482 | 342 | // The following should normally be ordered |
jjg@482 | 343 | // encl.start <= start <= pos <= end <= encl.end |
jjg@482 | 344 | // In addition, the position of the enclosing node should be |
jjg@482 | 345 | // within this node. |
jjg@482 | 346 | // The primary exceptions are for array type nodes, because of the |
jjg@482 | 347 | // need to support legacy syntax: |
jjg@482 | 348 | // e.g. int a[]; int[] b[]; int f()[] { return null; } |
jjg@482 | 349 | // and because of inconsistent nesting of left and right of |
jjg@482 | 350 | // array declarations: |
jjg@482 | 351 | // e.g. int[][] a = new int[2][]; |
jjg@482 | 352 | check("encl.start <= start", encl, self, encl.start <= self.start); |
jjg@482 | 353 | check("start <= pos", encl, self, self.start <= self.pos); |
jjg@482 | 354 | if (!(self.tag == JCTree.TYPEARRAY |
jjg@482 | 355 | && (encl.tag == JCTree.VARDEF || encl.tag == JCTree.TYPEARRAY))) { |
jjg@482 | 356 | check("encl.pos <= start || end <= encl.pos", |
jjg@482 | 357 | encl, self, encl.pos <= self.start || self.end <= encl.pos); |
jjg@482 | 358 | } |
jjg@482 | 359 | check("pos <= end", encl, self, self.pos <= self.end); |
jjg@482 | 360 | if (!(self.tag == JCTree.TYPEARRAY && encl.tag == JCTree.TYPEARRAY)) { |
jjg@482 | 361 | check("end <= encl.end", encl, self, self.end <= encl.end); |
jjg@482 | 362 | } |
jjg@482 | 363 | } |
jjg@482 | 364 | } |
jjg@482 | 365 | |
jjg@482 | 366 | Info prevEncl = encl; |
jjg@482 | 367 | encl = self; |
jjg@482 | 368 | tree.accept(this); |
jjg@482 | 369 | encl = prevEncl; |
jjg@482 | 370 | } |
jjg@482 | 371 | |
jjg@482 | 372 | @Override |
jjg@482 | 373 | public void visitVarDef(JCVariableDecl tree) { |
jjg@482 | 374 | // enum member declarations are desugared in the parser and have |
jjg@482 | 375 | // ill-defined semantics for tree positions, so for now, we |
jjg@482 | 376 | // skip the synthesized bits and just check parts which came from |
jjg@482 | 377 | // the original source text |
jjg@482 | 378 | if ((tree.mods.flags & Flags.ENUM) != 0) { |
jjg@482 | 379 | scan(tree.mods); |
jjg@482 | 380 | if (tree.init != null) { |
jjg@482 | 381 | if (tree.init.getTag() == JCTree.NEWCLASS) { |
jjg@482 | 382 | JCNewClass init = (JCNewClass) tree.init; |
jjg@482 | 383 | if (init.args != null && init.args.nonEmpty()) { |
jjg@482 | 384 | scan(init.args); |
jjg@482 | 385 | } |
jjg@482 | 386 | if (init.def != null && init.def.defs != null) { |
jjg@482 | 387 | scan(init.def.defs); |
jjg@482 | 388 | } |
jjg@482 | 389 | } |
jjg@482 | 390 | } |
jjg@482 | 391 | } else |
jjg@482 | 392 | super.visitVarDef(tree); |
jjg@482 | 393 | } |
jjg@482 | 394 | |
jjg@482 | 395 | boolean check(Info x) { |
jjg@482 | 396 | return tags.size() == 0 || tags.contains(tagNames.get(x.tag)); |
jjg@482 | 397 | } |
jjg@482 | 398 | |
jjg@482 | 399 | void check(String label, Info encl, Info self, boolean ok) { |
jjg@482 | 400 | if (!ok) { |
jjg@482 | 401 | if (gui) { |
jjg@482 | 402 | if (viewer == null) |
jjg@482 | 403 | viewer = new Viewer(); |
jjg@482 | 404 | viewer.addEntry(sourcefile, label, encl, self); |
jjg@482 | 405 | } |
jjg@482 | 406 | |
jjg@482 | 407 | String s = self.tree.toString(); |
jjg@482 | 408 | String msg = sourcefile.getName() + ": " + label + ": " + |
jjg@482 | 409 | "encl:" + encl + " this:" + self + "\n" + |
jjg@482 | 410 | s.substring(0, Math.min(80, s.length())).replaceAll("[\r\n]+", " "); |
jjg@482 | 411 | error(msg); |
jjg@482 | 412 | } |
jjg@482 | 413 | } |
jjg@482 | 414 | |
jjg@482 | 415 | JavaFileObject sourcefile; |
jjg@482 | 416 | Map<JCTree, Integer> endPosTable; |
jjg@482 | 417 | Info encl; |
jjg@482 | 418 | |
jjg@482 | 419 | } |
jjg@482 | 420 | |
jjg@482 | 421 | /** |
jjg@482 | 422 | * Utility class providing easy access to position and other info for a tree node. |
jjg@482 | 423 | */ |
jjg@482 | 424 | private class Info { |
jjg@482 | 425 | Info() { |
jjg@482 | 426 | tree = null; |
jjg@482 | 427 | tag = JCTree.ERRONEOUS; |
jjg@482 | 428 | start = 0; |
jjg@482 | 429 | pos = 0; |
jjg@482 | 430 | end = Integer.MAX_VALUE; |
jjg@482 | 431 | } |
jjg@482 | 432 | |
jjg@482 | 433 | Info(JCTree tree, Map<JCTree, Integer> endPosTable) { |
jjg@482 | 434 | this.tree = tree; |
jjg@482 | 435 | tag = tree.getTag(); |
jjg@482 | 436 | start = TreeInfo.getStartPos(tree); |
jjg@482 | 437 | pos = tree.pos; |
jjg@482 | 438 | end = TreeInfo.getEndPos(tree, endPosTable); |
jjg@482 | 439 | } |
jjg@482 | 440 | |
jjg@482 | 441 | @Override |
jjg@482 | 442 | public String toString() { |
jjg@482 | 443 | return tagNames.get(tree.getTag()) + "[start:" + start + ",pos:" + pos + ",end:" + end + "]"; |
jjg@482 | 444 | } |
jjg@482 | 445 | |
jjg@482 | 446 | final JCTree tree; |
jjg@482 | 447 | final int tag; |
jjg@482 | 448 | final int start; |
jjg@482 | 449 | final int pos; |
jjg@482 | 450 | final int end; |
jjg@482 | 451 | } |
jjg@482 | 452 | |
jjg@482 | 453 | /** |
jjg@482 | 454 | * Names for tree tags. |
jjg@482 | 455 | * javac does not provide an API to convert tag values to strings, so this class uses |
jjg@482 | 456 | * reflection to determine names of public static final int values in JCTree. |
jjg@482 | 457 | */ |
jjg@482 | 458 | private static class TagNames { |
jjg@482 | 459 | String get(int tag) { |
jjg@482 | 460 | if (map == null) { |
jjg@482 | 461 | map = new HashMap<Integer, String>(); |
jjg@482 | 462 | Class c = JCTree.class; |
jjg@482 | 463 | for (Field f : c.getDeclaredFields()) { |
jjg@482 | 464 | if (f.getType().equals(int.class)) { |
jjg@482 | 465 | int mods = f.getModifiers(); |
jjg@482 | 466 | if (Modifier.isPublic(mods) && Modifier.isStatic(mods) && Modifier.isFinal(mods)) { |
jjg@482 | 467 | try { |
jjg@482 | 468 | map.put(f.getInt(null), f.getName()); |
jjg@482 | 469 | } catch (IllegalAccessException e) { |
jjg@482 | 470 | } |
jjg@482 | 471 | } |
jjg@482 | 472 | } |
jjg@482 | 473 | } |
jjg@482 | 474 | } |
jjg@482 | 475 | String name = map.get(tag); |
jjg@482 | 476 | return (name == null) ? "??" : name; |
jjg@482 | 477 | } |
jjg@482 | 478 | |
jjg@482 | 479 | private Map<Integer, String> map; |
jjg@482 | 480 | } |
jjg@482 | 481 | |
jjg@482 | 482 | /** |
jjg@482 | 483 | * Thrown when errors are found parsing a java file. |
jjg@482 | 484 | */ |
jjg@482 | 485 | private static class ParseException extends Exception { |
jjg@482 | 486 | ParseException(String msg) { |
jjg@482 | 487 | super(msg); |
jjg@482 | 488 | } |
jjg@482 | 489 | } |
jjg@482 | 490 | |
jjg@482 | 491 | /** |
jjg@482 | 492 | * DiagnosticListener to report diagnostics and count any errors that occur. |
jjg@482 | 493 | */ |
jjg@482 | 494 | private static class Reporter implements DiagnosticListener<JavaFileObject> { |
jjg@482 | 495 | Reporter(PrintWriter out) { |
jjg@482 | 496 | this.out = out; |
jjg@482 | 497 | } |
jjg@482 | 498 | |
jjg@482 | 499 | public void report(Diagnostic<? extends JavaFileObject> diagnostic) { |
jjg@482 | 500 | out.println(diagnostic); |
jjg@482 | 501 | switch (diagnostic.getKind()) { |
jjg@482 | 502 | case ERROR: |
jjg@482 | 503 | errors++; |
jjg@482 | 504 | } |
jjg@482 | 505 | } |
jjg@482 | 506 | int errors; |
jjg@482 | 507 | PrintWriter out; |
jjg@482 | 508 | } |
jjg@482 | 509 | |
jjg@482 | 510 | /** |
jjg@482 | 511 | * GUI viewer for issues found by TreePosTester. The viewer provides a drop |
jjg@482 | 512 | * down list for selecting error conditions, a header area providing details |
jjg@482 | 513 | * about an error, and a text area with the ranges of text highlighted as |
jjg@482 | 514 | * appropriate. |
jjg@482 | 515 | */ |
jjg@482 | 516 | private class Viewer extends JFrame { |
jjg@482 | 517 | /** |
jjg@482 | 518 | * Create a viewer. |
jjg@482 | 519 | */ |
jjg@482 | 520 | Viewer() { |
jjg@482 | 521 | initGUI(); |
jjg@482 | 522 | } |
jjg@482 | 523 | |
jjg@482 | 524 | /** |
jjg@482 | 525 | * Add another entry to the list of errors. |
jjg@482 | 526 | * @param file The file containing the error |
jjg@482 | 527 | * @param check The condition that was being tested, and which failed |
jjg@482 | 528 | * @param encl the enclosing tree node |
jjg@482 | 529 | * @param self the tree node containing the error |
jjg@482 | 530 | */ |
jjg@482 | 531 | void addEntry(JavaFileObject file, String check, Info encl, Info self) { |
jjg@482 | 532 | Entry e = new Entry(file, check, encl, self); |
jjg@482 | 533 | DefaultComboBoxModel m = (DefaultComboBoxModel) entries.getModel(); |
jjg@482 | 534 | m.addElement(e); |
jjg@482 | 535 | if (m.getSize() == 1) |
jjg@482 | 536 | entries.setSelectedItem(e); |
jjg@482 | 537 | } |
jjg@482 | 538 | |
jjg@482 | 539 | /** |
jjg@482 | 540 | * Initialize the GUI window. |
jjg@482 | 541 | */ |
jjg@482 | 542 | private void initGUI() { |
jjg@482 | 543 | JPanel head = new JPanel(new GridBagLayout()); |
jjg@482 | 544 | GridBagConstraints lc = new GridBagConstraints(); |
jjg@482 | 545 | GridBagConstraints fc = new GridBagConstraints(); |
jjg@482 | 546 | fc.anchor = GridBagConstraints.WEST; |
jjg@482 | 547 | fc.fill = GridBagConstraints.HORIZONTAL; |
jjg@482 | 548 | fc.gridwidth = GridBagConstraints.REMAINDER; |
jjg@482 | 549 | |
jjg@482 | 550 | entries = new JComboBox(); |
jjg@482 | 551 | entries.addActionListener(new ActionListener() { |
jjg@482 | 552 | public void actionPerformed(ActionEvent e) { |
jjg@482 | 553 | showEntry((Entry) entries.getSelectedItem()); |
jjg@482 | 554 | } |
jjg@482 | 555 | }); |
jjg@482 | 556 | fc.insets.bottom = 10; |
jjg@482 | 557 | head.add(entries, fc); |
jjg@482 | 558 | fc.insets.bottom = 0; |
jjg@482 | 559 | head.add(new JLabel("check:"), lc); |
jjg@482 | 560 | head.add(checkField = createTextField(80), fc); |
jjg@482 | 561 | fc.fill = GridBagConstraints.NONE; |
jjg@482 | 562 | head.add(setBackground(new JLabel("encl:"), enclColor), lc); |
jjg@482 | 563 | head.add(enclPanel = new InfoPanel(), fc); |
jjg@482 | 564 | head.add(setBackground(new JLabel("self:"), selfColor), lc); |
jjg@482 | 565 | head.add(selfPanel = new InfoPanel(), fc); |
jjg@482 | 566 | add(head, BorderLayout.NORTH); |
jjg@482 | 567 | |
jjg@482 | 568 | body = new JTextArea(); |
jjg@482 | 569 | body.setFont(Font.decode(Font.MONOSPACED)); |
jjg@482 | 570 | body.addCaretListener(new CaretListener() { |
jjg@482 | 571 | public void caretUpdate(CaretEvent e) { |
jjg@482 | 572 | int dot = e.getDot(); |
jjg@482 | 573 | int mark = e.getMark(); |
jjg@482 | 574 | if (dot == mark) |
jjg@482 | 575 | statusText.setText("dot: " + dot); |
jjg@482 | 576 | else |
jjg@482 | 577 | statusText.setText("dot: " + dot + ", mark:" + mark); |
jjg@482 | 578 | } |
jjg@482 | 579 | }); |
jjg@482 | 580 | JScrollPane p = new JScrollPane(body, |
jjg@482 | 581 | JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED, |
jjg@482 | 582 | JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED); |
jjg@482 | 583 | p.setPreferredSize(new Dimension(640, 480)); |
jjg@482 | 584 | add(p, BorderLayout.CENTER); |
jjg@482 | 585 | |
jjg@482 | 586 | statusText = createTextField(80); |
jjg@482 | 587 | add(statusText, BorderLayout.SOUTH); |
jjg@482 | 588 | |
jjg@482 | 589 | pack(); |
jjg@482 | 590 | setLocationRelativeTo(null); // centered on screen |
jjg@482 | 591 | setVisible(true); |
jjg@482 | 592 | setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); |
jjg@482 | 593 | } |
jjg@482 | 594 | |
jjg@482 | 595 | /** Show an entry that has been selected. */ |
jjg@482 | 596 | private void showEntry(Entry e) { |
jjg@482 | 597 | try { |
jjg@482 | 598 | // update simple fields |
jjg@482 | 599 | setTitle(e.file.getName()); |
jjg@482 | 600 | checkField.setText(e.check); |
jjg@482 | 601 | enclPanel.setInfo(e.encl); |
jjg@482 | 602 | selfPanel.setInfo(e.self); |
jjg@482 | 603 | // show file text with highlights |
jjg@482 | 604 | body.setText(e.file.getCharContent(true).toString()); |
jjg@482 | 605 | Highlighter highlighter = body.getHighlighter(); |
jjg@482 | 606 | highlighter.removeAllHighlights(); |
jjg@482 | 607 | addHighlight(highlighter, e.encl, enclColor); |
jjg@482 | 608 | addHighlight(highlighter, e.self, selfColor); |
jjg@482 | 609 | scroll(body, getMinPos(enclPanel.info, selfPanel.info)); |
jjg@482 | 610 | } catch (IOException ex) { |
jjg@482 | 611 | body.setText("Cannot read " + e.file.getName() + ": " + e); |
jjg@482 | 612 | } |
jjg@482 | 613 | } |
jjg@482 | 614 | |
jjg@482 | 615 | /** Create a test field. */ |
jjg@482 | 616 | private JTextField createTextField(int width) { |
jjg@482 | 617 | JTextField f = new JTextField(width); |
jjg@482 | 618 | f.setEditable(false); |
jjg@482 | 619 | f.setBorder(null); |
jjg@482 | 620 | return f; |
jjg@482 | 621 | } |
jjg@482 | 622 | |
jjg@482 | 623 | /** Add a highlighted region based on the positions in an Info object. */ |
jjg@482 | 624 | private void addHighlight(Highlighter h, Info info, Color c) { |
jjg@482 | 625 | int start = info.start; |
jjg@482 | 626 | int end = info.end; |
jjg@482 | 627 | if (start == -1 && end == -1) |
jjg@482 | 628 | return; |
jjg@482 | 629 | if (start == -1) |
jjg@482 | 630 | start = end; |
jjg@482 | 631 | if (end == -1) |
jjg@482 | 632 | end = start; |
jjg@482 | 633 | try { |
jjg@482 | 634 | h.addHighlight(info.start, info.end, |
jjg@482 | 635 | new DefaultHighlighter.DefaultHighlightPainter(c)); |
jjg@482 | 636 | if (info.pos != -1) { |
jjg@482 | 637 | Color c2 = new Color(c.getRed(), c.getGreen(), c.getBlue(), (int)(.4f * 255)); // 40% |
jjg@482 | 638 | h.addHighlight(info.pos, info.pos + 1, |
jjg@482 | 639 | new DefaultHighlighter.DefaultHighlightPainter(c2)); |
jjg@482 | 640 | } |
jjg@482 | 641 | } catch (BadLocationException e) { |
jjg@482 | 642 | e.printStackTrace(); |
jjg@482 | 643 | } |
jjg@482 | 644 | } |
jjg@482 | 645 | |
jjg@482 | 646 | /** Get the minimum valid position in a set of info objects. */ |
jjg@482 | 647 | private int getMinPos(Info... values) { |
jjg@482 | 648 | int i = Integer.MAX_VALUE; |
jjg@482 | 649 | for (Info info: values) { |
jjg@482 | 650 | if (info.start >= 0) i = Math.min(i, info.start); |
jjg@482 | 651 | if (info.pos >= 0) i = Math.min(i, info.pos); |
jjg@482 | 652 | if (info.end >= 0) i = Math.min(i, info.end); |
jjg@482 | 653 | } |
jjg@482 | 654 | return (i == Integer.MAX_VALUE) ? 0 : i; |
jjg@482 | 655 | } |
jjg@482 | 656 | |
jjg@482 | 657 | /** Set the background on a component. */ |
jjg@482 | 658 | private JComponent setBackground(JComponent comp, Color c) { |
jjg@482 | 659 | comp.setOpaque(true); |
jjg@482 | 660 | comp.setBackground(c); |
jjg@482 | 661 | return comp; |
jjg@482 | 662 | } |
jjg@482 | 663 | |
jjg@482 | 664 | /** Scroll a text area to display a given position near the middle of the visible area. */ |
jjg@482 | 665 | private void scroll(final JTextArea t, final int pos) { |
jjg@482 | 666 | // Using invokeLater appears to give text a chance to sort itself out |
jjg@482 | 667 | // before the scroll happens; otherwise scrollRectToVisible doesn't work. |
jjg@482 | 668 | // Maybe there's a better way to sync with the text... |
jjg@482 | 669 | EventQueue.invokeLater(new Runnable() { |
jjg@482 | 670 | public void run() { |
jjg@482 | 671 | try { |
jjg@482 | 672 | Rectangle r = t.modelToView(pos); |
jjg@482 | 673 | JScrollPane p = (JScrollPane) SwingUtilities.getAncestorOfClass(JScrollPane.class, t); |
jjg@482 | 674 | r.y = Math.max(0, r.y - p.getHeight() * 2 / 5); |
jjg@482 | 675 | r.height += p.getHeight() * 4 / 5; |
jjg@482 | 676 | t.scrollRectToVisible(r); |
jjg@482 | 677 | } catch (BadLocationException ignore) { |
jjg@482 | 678 | } |
jjg@482 | 679 | } |
jjg@482 | 680 | }); |
jjg@482 | 681 | } |
jjg@482 | 682 | |
jjg@482 | 683 | private JComboBox entries; |
jjg@482 | 684 | private JTextField checkField; |
jjg@482 | 685 | private InfoPanel enclPanel; |
jjg@482 | 686 | private InfoPanel selfPanel; |
jjg@482 | 687 | private JTextArea body; |
jjg@482 | 688 | private JTextField statusText; |
jjg@482 | 689 | |
jjg@482 | 690 | private Color selfColor = new Color(0.f, 1.f, 0.f, 0.2f); // 20% green |
jjg@482 | 691 | private Color enclColor = new Color(1.f, 0.f, 0.f, 0.2f); // 20% red |
jjg@482 | 692 | |
jjg@482 | 693 | /** Panel to display an Info object. */ |
jjg@482 | 694 | private class InfoPanel extends JPanel { |
jjg@482 | 695 | InfoPanel() { |
jjg@482 | 696 | add(tagName = createTextField(20)); |
jjg@482 | 697 | add(new JLabel("start:")); |
jjg@482 | 698 | add(addListener(start = createTextField(6))); |
jjg@482 | 699 | add(new JLabel("pos:")); |
jjg@482 | 700 | add(addListener(pos = createTextField(6))); |
jjg@482 | 701 | add(new JLabel("end:")); |
jjg@482 | 702 | add(addListener(end = createTextField(6))); |
jjg@482 | 703 | } |
jjg@482 | 704 | |
jjg@482 | 705 | void setInfo(Info info) { |
jjg@482 | 706 | this.info = info; |
jjg@482 | 707 | tagName.setText(tagNames.get(info.tag)); |
jjg@482 | 708 | start.setText(String.valueOf(info.start)); |
jjg@482 | 709 | pos.setText(String.valueOf(info.pos)); |
jjg@482 | 710 | end.setText(String.valueOf(info.end)); |
jjg@482 | 711 | } |
jjg@482 | 712 | |
jjg@482 | 713 | JTextField addListener(final JTextField f) { |
jjg@482 | 714 | f.addMouseListener(new MouseAdapter() { |
jjg@482 | 715 | @Override |
jjg@482 | 716 | public void mouseClicked(MouseEvent e) { |
jjg@482 | 717 | body.setCaretPosition(Integer.valueOf(f.getText())); |
jjg@482 | 718 | body.getCaret().setVisible(true); |
jjg@482 | 719 | } |
jjg@482 | 720 | }); |
jjg@482 | 721 | return f; |
jjg@482 | 722 | } |
jjg@482 | 723 | |
jjg@482 | 724 | Info info; |
jjg@482 | 725 | JTextField tagName; |
jjg@482 | 726 | JTextField start; |
jjg@482 | 727 | JTextField pos; |
jjg@482 | 728 | JTextField end; |
jjg@482 | 729 | } |
jjg@482 | 730 | |
jjg@482 | 731 | /** Object to record information about an error to be displayed. */ |
jjg@482 | 732 | private class Entry { |
jjg@482 | 733 | Entry(JavaFileObject file, String check, Info encl, Info self) { |
jjg@482 | 734 | this.file = file; |
jjg@482 | 735 | this.check = check; |
jjg@482 | 736 | this.encl = encl; |
jjg@482 | 737 | this.self= self; |
jjg@482 | 738 | } |
jjg@482 | 739 | |
jjg@482 | 740 | @Override |
jjg@482 | 741 | public String toString() { |
jjg@482 | 742 | return file.getName() + " " + check + " " + getMinPos(encl, self); |
jjg@482 | 743 | } |
jjg@482 | 744 | |
jjg@482 | 745 | final JavaFileObject file; |
jjg@482 | 746 | final String check; |
jjg@482 | 747 | final Info encl; |
jjg@482 | 748 | final Info self; |
jjg@482 | 749 | } |
jjg@482 | 750 | } |
jjg@482 | 751 | } |
jjg@482 | 752 |