test/tools/javac/treepostests/TreePosTest.java

Mon, 15 Feb 2010 16:09:50 -0800

author
jjg
date
Mon, 15 Feb 2010 16:09:50 -0800
changeset 493
7d9e3a15d2b3
parent 486
41ed86f86585
permissions
-rw-r--r--

6926555: 6921979 breaks TreePosTest
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@493 101 * @run main TreePosTest -q -r -ef ./tools/javac/typeAnnotations -ef ./tools/javap/typeAnnotations -et ANNOTATED_TYPE .
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@493 153 else if (arg.equals("-et") && i + 1 < args.length)
jjg@493 154 excludeTags.add(args[++i]);
jjg@482 155 else if (arg.equals("-r")) {
jjg@482 156 if (excludeFiles.size() > 0)
jjg@482 157 throw new Error("-r must be used before -ef");
jjg@482 158 File d = baseDir;
jjg@482 159 while (!new File(d, "TEST.ROOT").exists()) {
jjg@482 160 d = d.getParentFile();
jjg@482 161 if (d == null)
jjg@482 162 throw new Error("cannot find TEST.ROOT");
jjg@482 163 }
jjg@482 164 baseDir = d;
jjg@482 165 }
jjg@482 166 else if (arg.startsWith("-"))
jjg@482 167 throw new Error("unknown option: " + arg);
jjg@482 168 else {
jjg@482 169 while (i < args.length)
jjg@482 170 files.add(new File(baseDir, args[i++]));
jjg@482 171 }
jjg@482 172 }
jjg@482 173
jjg@482 174 for (File file: files) {
jjg@482 175 if (file.exists())
jjg@482 176 test(file);
jjg@482 177 else
jjg@482 178 error("File not found: " + file);
jjg@482 179 }
jjg@482 180
jjg@482 181 if (fileCount != 1)
jjg@482 182 System.err.println(fileCount + " files read");
jjg@482 183 if (errors > 0)
jjg@482 184 System.err.println(errors + " errors");
jjg@482 185
jjg@482 186 return (gui || errors == 0);
jjg@482 187 }
jjg@482 188
jjg@482 189 /**
jjg@482 190 * Print command line help.
jjg@482 191 * @param out output stream
jjg@482 192 */
jjg@482 193 void usage(PrintStream out) {
jjg@482 194 out.println("Usage:");
jjg@482 195 out.println(" java TreePosTest options... files...");
jjg@482 196 out.println("");
jjg@482 197 out.println("where options include:");
jjg@482 198 out.println("-gui Display returns in a GUI viewer");
jjg@482 199 out.println("-q Quiet: don't report on inapplicable files");
jjg@482 200 out.println("-v Verbose: report on files as they are being read");
jjg@482 201 out.println("-t tag Limit checks to tree nodes with this tag");
jjg@482 202 out.println(" Can be repeated if desired");
jjg@482 203 out.println("-ef file Exclude file or directory");
jjg@493 204 out.println("-et tag Exclude tree nodes with given tag name");
jjg@482 205 out.println("");
jjg@482 206 out.println("files may be directories or files");
jjg@482 207 out.println("directories will be scanned recursively");
jjg@482 208 out.println("non java files, or java files which cannot be parsed, will be ignored");
jjg@482 209 out.println("");
jjg@482 210 }
jjg@482 211
jjg@482 212 /**
jjg@482 213 * Test a file. If the file is a directory, it will be recursively scanned
jjg@482 214 * for java files.
jjg@482 215 * @param file the file or directory to test
jjg@482 216 */
jjg@482 217 void test(File file) {
jjg@482 218 if (excludeFiles.contains(file)) {
jjg@482 219 if (!quiet)
jjg@482 220 error("File " + file + " excluded");
jjg@482 221 return;
jjg@482 222 }
jjg@482 223
jjg@482 224 if (file.isDirectory()) {
jjg@482 225 for (File f: file.listFiles()) {
jjg@482 226 test(f);
jjg@482 227 }
jjg@482 228 return;
jjg@482 229 }
jjg@482 230
jjg@482 231 if (file.isFile() && file.getName().endsWith(".java")) {
jjg@482 232 try {
jjg@482 233 if (verbose)
jjg@482 234 System.err.println(file);
jjg@482 235 fileCount++;
jjg@482 236 PosTester p = new PosTester();
jjg@482 237 p.test(read(file));
jjg@482 238 } catch (ParseException e) {
jjg@482 239 if (!quiet) {
jjg@482 240 error("Error parsing " + file + "\n" + e.getMessage());
jjg@482 241 }
jjg@482 242 } catch (IOException e) {
jjg@482 243 error("Error reading " + file + ": " + e);
jjg@482 244 }
jjg@482 245 return;
jjg@482 246 }
jjg@482 247
jjg@482 248 if (!quiet)
jjg@482 249 error("File " + file + " ignored");
jjg@482 250 }
jjg@482 251
jjg@482 252 /**
jjg@482 253 * Read a file.
jjg@482 254 * @param file the file to be read
jjg@482 255 * @return the tree for the content of the file
jjg@482 256 * @throws IOException if any IO errors occur
jjg@482 257 * @throws TreePosTest.ParseException if any errors occur while parsing the file
jjg@482 258 */
jjg@482 259 JCCompilationUnit read(File file) throws IOException, ParseException {
jjg@482 260 StringWriter sw = new StringWriter();
jjg@482 261 PrintWriter pw = new PrintWriter(sw);
jjg@482 262 Reporter r = new Reporter(pw);
jjg@482 263 JavacTool tool = JavacTool.create();
jjg@482 264 Charset cs = (encoding == null ? null : Charset.forName(encoding));
jjg@482 265 StandardJavaFileManager fm = tool.getStandardFileManager(r, null, null);
jjg@482 266 Iterable<? extends JavaFileObject> files = fm.getJavaFileObjects(file);
jjg@482 267 JavacTask task = tool.getTask(pw, fm, r, Collections.<String>emptyList(), null, files);
jjg@482 268 Iterable<? extends CompilationUnitTree> trees = task.parse();
jjg@482 269 pw.flush();
jjg@482 270 if (r.errors > 0)
jjg@482 271 throw new ParseException(sw.toString());
jjg@482 272 Iterator<? extends CompilationUnitTree> iter = trees.iterator();
jjg@482 273 if (!iter.hasNext())
jjg@482 274 throw new Error("no trees found");
jjg@482 275 JCCompilationUnit t = (JCCompilationUnit) iter.next();
jjg@482 276 if (iter.hasNext())
jjg@482 277 throw new Error("too many trees found");
jjg@482 278 return t;
jjg@482 279 }
jjg@482 280
jjg@482 281 /**
jjg@482 282 * Report an error. When the program is complete, the program will either
jjg@482 283 * exit or throw an Error if any errors have been reported.
jjg@482 284 * @param msg the error message
jjg@482 285 */
jjg@482 286 void error(String msg) {
jjg@482 287 System.err.println(msg);
jjg@482 288 errors++;
jjg@482 289 }
jjg@482 290
jjg@482 291 /** Number of files that have been analyzed. */
jjg@482 292 int fileCount;
jjg@482 293 /** Number of errors reported. */
jjg@482 294 int errors;
jjg@482 295 /** Flag: don't report irrelevant files. */
jjg@482 296 boolean quiet;
jjg@482 297 /** Flag: report files as they are processed. */
jjg@482 298 boolean verbose;
jjg@482 299 /** Flag: show errors in GUI viewer. */
jjg@482 300 boolean gui;
jjg@482 301 /** Option: encoding for test files. */
jjg@482 302 String encoding;
jjg@482 303 /** The GUI viewer for errors. */
jjg@482 304 Viewer viewer;
jjg@482 305 /** The set of tags for tree nodes to be analyzed; if empty, all tree nodes
jjg@482 306 * are analyzed. */
jjg@482 307 Set<String> tags = new HashSet<String>();
jjg@482 308 /** Set of files and directories to be excluded from analysis. */
jjg@482 309 Set<File> excludeFiles = new HashSet<File>();
jjg@493 310 /** Set of tag names to be excluded from analysis. */
jjg@493 311 Set<String> excludeTags = new HashSet<String>();
jjg@482 312 /** Table of printable names for tree tag values. */
jjg@482 313 TagNames tagNames = new TagNames();
jjg@482 314
jjg@482 315 /**
jjg@482 316 * Main class for testing assertions concerning tree positions for tree nodes.
jjg@482 317 */
jjg@482 318 private class PosTester extends TreeScanner {
jjg@482 319 void test(JCCompilationUnit tree) {
jjg@482 320 sourcefile = tree.sourcefile;
jjg@482 321 endPosTable = tree.endPositions;
jjg@482 322 encl = new Info();
jjg@482 323 tree.accept(this);
jjg@482 324 }
jjg@482 325
jjg@482 326 @Override
jjg@482 327 public void scan(JCTree tree) {
jjg@482 328 if (tree == null)
jjg@482 329 return;
jjg@482 330
jjg@482 331 Info self = new Info(tree, endPosTable);
jjg@493 332 if (check(encl, self)) {
jjg@482 333 // Modifiers nodes are present throughout the tree even where
jjg@482 334 // there is no corresponding source text.
jjg@482 335 // Redundant semicolons in a class definition can cause empty
jjg@482 336 // initializer blocks with no positions.
jjg@482 337 if ((self.tag == JCTree.MODIFIERS || self.tag == JCTree.BLOCK)
jjg@482 338 && self.pos == NOPOS) {
jjg@482 339 // If pos is NOPOS, so should be the start and end positions
jjg@482 340 check("start == NOPOS", encl, self, self.start == NOPOS);
jjg@482 341 check("end == NOPOS", encl, self, self.end == NOPOS);
jjg@482 342 } else {
jjg@482 343 // For this node, start , pos, and endpos should be all defined
jjg@482 344 check("start != NOPOS", encl, self, self.start != NOPOS);
jjg@482 345 check("pos != NOPOS", encl, self, self.pos != NOPOS);
jjg@482 346 check("end != NOPOS", encl, self, self.end != NOPOS);
jjg@482 347 // The following should normally be ordered
jjg@482 348 // encl.start <= start <= pos <= end <= encl.end
jjg@482 349 // In addition, the position of the enclosing node should be
jjg@482 350 // within this node.
jjg@482 351 // The primary exceptions are for array type nodes, because of the
jjg@482 352 // need to support legacy syntax:
jjg@482 353 // e.g. int a[]; int[] b[]; int f()[] { return null; }
jjg@482 354 // and because of inconsistent nesting of left and right of
jjg@482 355 // array declarations:
jjg@482 356 // e.g. int[][] a = new int[2][];
jjg@482 357 check("encl.start <= start", encl, self, encl.start <= self.start);
jjg@482 358 check("start <= pos", encl, self, self.start <= self.pos);
jjg@482 359 if (!(self.tag == JCTree.TYPEARRAY
jjg@482 360 && (encl.tag == JCTree.VARDEF || encl.tag == JCTree.TYPEARRAY))) {
jjg@482 361 check("encl.pos <= start || end <= encl.pos",
jjg@482 362 encl, self, encl.pos <= self.start || self.end <= encl.pos);
jjg@482 363 }
jjg@482 364 check("pos <= end", encl, self, self.pos <= self.end);
jjg@482 365 if (!(self.tag == JCTree.TYPEARRAY && encl.tag == JCTree.TYPEARRAY)) {
jjg@482 366 check("end <= encl.end", encl, self, self.end <= encl.end);
jjg@482 367 }
jjg@482 368 }
jjg@482 369 }
jjg@482 370
jjg@482 371 Info prevEncl = encl;
jjg@482 372 encl = self;
jjg@482 373 tree.accept(this);
jjg@482 374 encl = prevEncl;
jjg@482 375 }
jjg@482 376
jjg@482 377 @Override
jjg@482 378 public void visitVarDef(JCVariableDecl tree) {
jjg@482 379 // enum member declarations are desugared in the parser and have
jjg@482 380 // ill-defined semantics for tree positions, so for now, we
jjg@482 381 // skip the synthesized bits and just check parts which came from
jjg@482 382 // the original source text
jjg@482 383 if ((tree.mods.flags & Flags.ENUM) != 0) {
jjg@482 384 scan(tree.mods);
jjg@482 385 if (tree.init != null) {
jjg@482 386 if (tree.init.getTag() == JCTree.NEWCLASS) {
jjg@482 387 JCNewClass init = (JCNewClass) tree.init;
jjg@482 388 if (init.args != null && init.args.nonEmpty()) {
jjg@482 389 scan(init.args);
jjg@482 390 }
jjg@482 391 if (init.def != null && init.def.defs != null) {
jjg@482 392 scan(init.def.defs);
jjg@482 393 }
jjg@482 394 }
jjg@482 395 }
jjg@482 396 } else
jjg@482 397 super.visitVarDef(tree);
jjg@482 398 }
jjg@482 399
jjg@493 400 boolean check(Info encl, Info self) {
jjg@493 401 if (excludeTags.size() > 0) {
jjg@493 402 if (encl != null && excludeTags.contains(tagNames.get(encl.tag))
jjg@493 403 || excludeTags.contains(tagNames.get(self.tag)))
jjg@493 404 return false;
jjg@493 405 }
jjg@493 406 return tags.size() == 0 || tags.contains(tagNames.get(self.tag));
jjg@482 407 }
jjg@482 408
jjg@482 409 void check(String label, Info encl, Info self, boolean ok) {
jjg@482 410 if (!ok) {
jjg@482 411 if (gui) {
jjg@482 412 if (viewer == null)
jjg@482 413 viewer = new Viewer();
jjg@482 414 viewer.addEntry(sourcefile, label, encl, self);
jjg@482 415 }
jjg@482 416
jjg@482 417 String s = self.tree.toString();
jjg@482 418 String msg = sourcefile.getName() + ": " + label + ": " +
jjg@482 419 "encl:" + encl + " this:" + self + "\n" +
jjg@482 420 s.substring(0, Math.min(80, s.length())).replaceAll("[\r\n]+", " ");
jjg@482 421 error(msg);
jjg@482 422 }
jjg@482 423 }
jjg@482 424
jjg@482 425 JavaFileObject sourcefile;
jjg@482 426 Map<JCTree, Integer> endPosTable;
jjg@482 427 Info encl;
jjg@482 428
jjg@482 429 }
jjg@482 430
jjg@482 431 /**
jjg@482 432 * Utility class providing easy access to position and other info for a tree node.
jjg@482 433 */
jjg@482 434 private class Info {
jjg@482 435 Info() {
jjg@482 436 tree = null;
jjg@482 437 tag = JCTree.ERRONEOUS;
jjg@482 438 start = 0;
jjg@482 439 pos = 0;
jjg@482 440 end = Integer.MAX_VALUE;
jjg@482 441 }
jjg@482 442
jjg@482 443 Info(JCTree tree, Map<JCTree, Integer> endPosTable) {
jjg@482 444 this.tree = tree;
jjg@482 445 tag = tree.getTag();
jjg@482 446 start = TreeInfo.getStartPos(tree);
jjg@482 447 pos = tree.pos;
jjg@482 448 end = TreeInfo.getEndPos(tree, endPosTable);
jjg@482 449 }
jjg@482 450
jjg@482 451 @Override
jjg@482 452 public String toString() {
jjg@482 453 return tagNames.get(tree.getTag()) + "[start:" + start + ",pos:" + pos + ",end:" + end + "]";
jjg@482 454 }
jjg@482 455
jjg@482 456 final JCTree tree;
jjg@482 457 final int tag;
jjg@482 458 final int start;
jjg@482 459 final int pos;
jjg@482 460 final int end;
jjg@482 461 }
jjg@482 462
jjg@482 463 /**
jjg@482 464 * Names for tree tags.
jjg@482 465 * javac does not provide an API to convert tag values to strings, so this class uses
jjg@482 466 * reflection to determine names of public static final int values in JCTree.
jjg@482 467 */
jjg@482 468 private static class TagNames {
jjg@482 469 String get(int tag) {
jjg@482 470 if (map == null) {
jjg@482 471 map = new HashMap<Integer, String>();
jjg@482 472 Class c = JCTree.class;
jjg@482 473 for (Field f : c.getDeclaredFields()) {
jjg@482 474 if (f.getType().equals(int.class)) {
jjg@482 475 int mods = f.getModifiers();
jjg@482 476 if (Modifier.isPublic(mods) && Modifier.isStatic(mods) && Modifier.isFinal(mods)) {
jjg@482 477 try {
jjg@482 478 map.put(f.getInt(null), f.getName());
jjg@482 479 } catch (IllegalAccessException e) {
jjg@482 480 }
jjg@482 481 }
jjg@482 482 }
jjg@482 483 }
jjg@482 484 }
jjg@482 485 String name = map.get(tag);
jjg@482 486 return (name == null) ? "??" : name;
jjg@482 487 }
jjg@482 488
jjg@482 489 private Map<Integer, String> map;
jjg@482 490 }
jjg@482 491
jjg@482 492 /**
jjg@482 493 * Thrown when errors are found parsing a java file.
jjg@482 494 */
jjg@482 495 private static class ParseException extends Exception {
jjg@482 496 ParseException(String msg) {
jjg@482 497 super(msg);
jjg@482 498 }
jjg@482 499 }
jjg@482 500
jjg@482 501 /**
jjg@482 502 * DiagnosticListener to report diagnostics and count any errors that occur.
jjg@482 503 */
jjg@482 504 private static class Reporter implements DiagnosticListener<JavaFileObject> {
jjg@482 505 Reporter(PrintWriter out) {
jjg@482 506 this.out = out;
jjg@482 507 }
jjg@482 508
jjg@482 509 public void report(Diagnostic<? extends JavaFileObject> diagnostic) {
jjg@482 510 out.println(diagnostic);
jjg@482 511 switch (diagnostic.getKind()) {
jjg@482 512 case ERROR:
jjg@482 513 errors++;
jjg@482 514 }
jjg@482 515 }
jjg@482 516 int errors;
jjg@482 517 PrintWriter out;
jjg@482 518 }
jjg@482 519
jjg@482 520 /**
jjg@482 521 * GUI viewer for issues found by TreePosTester. The viewer provides a drop
jjg@482 522 * down list for selecting error conditions, a header area providing details
jjg@482 523 * about an error, and a text area with the ranges of text highlighted as
jjg@482 524 * appropriate.
jjg@482 525 */
jjg@482 526 private class Viewer extends JFrame {
jjg@482 527 /**
jjg@482 528 * Create a viewer.
jjg@482 529 */
jjg@482 530 Viewer() {
jjg@482 531 initGUI();
jjg@482 532 }
jjg@482 533
jjg@482 534 /**
jjg@482 535 * Add another entry to the list of errors.
jjg@482 536 * @param file The file containing the error
jjg@482 537 * @param check The condition that was being tested, and which failed
jjg@482 538 * @param encl the enclosing tree node
jjg@482 539 * @param self the tree node containing the error
jjg@482 540 */
jjg@482 541 void addEntry(JavaFileObject file, String check, Info encl, Info self) {
jjg@482 542 Entry e = new Entry(file, check, encl, self);
jjg@482 543 DefaultComboBoxModel m = (DefaultComboBoxModel) entries.getModel();
jjg@482 544 m.addElement(e);
jjg@482 545 if (m.getSize() == 1)
jjg@482 546 entries.setSelectedItem(e);
jjg@482 547 }
jjg@482 548
jjg@482 549 /**
jjg@482 550 * Initialize the GUI window.
jjg@482 551 */
jjg@482 552 private void initGUI() {
jjg@482 553 JPanel head = new JPanel(new GridBagLayout());
jjg@482 554 GridBagConstraints lc = new GridBagConstraints();
jjg@482 555 GridBagConstraints fc = new GridBagConstraints();
jjg@482 556 fc.anchor = GridBagConstraints.WEST;
jjg@482 557 fc.fill = GridBagConstraints.HORIZONTAL;
jjg@482 558 fc.gridwidth = GridBagConstraints.REMAINDER;
jjg@482 559
jjg@482 560 entries = new JComboBox();
jjg@482 561 entries.addActionListener(new ActionListener() {
jjg@482 562 public void actionPerformed(ActionEvent e) {
jjg@482 563 showEntry((Entry) entries.getSelectedItem());
jjg@482 564 }
jjg@482 565 });
jjg@482 566 fc.insets.bottom = 10;
jjg@482 567 head.add(entries, fc);
jjg@482 568 fc.insets.bottom = 0;
jjg@482 569 head.add(new JLabel("check:"), lc);
jjg@482 570 head.add(checkField = createTextField(80), fc);
jjg@482 571 fc.fill = GridBagConstraints.NONE;
jjg@482 572 head.add(setBackground(new JLabel("encl:"), enclColor), lc);
jjg@482 573 head.add(enclPanel = new InfoPanel(), fc);
jjg@482 574 head.add(setBackground(new JLabel("self:"), selfColor), lc);
jjg@482 575 head.add(selfPanel = new InfoPanel(), fc);
jjg@482 576 add(head, BorderLayout.NORTH);
jjg@482 577
jjg@482 578 body = new JTextArea();
jjg@482 579 body.setFont(Font.decode(Font.MONOSPACED));
jjg@482 580 body.addCaretListener(new CaretListener() {
jjg@482 581 public void caretUpdate(CaretEvent e) {
jjg@482 582 int dot = e.getDot();
jjg@482 583 int mark = e.getMark();
jjg@482 584 if (dot == mark)
jjg@482 585 statusText.setText("dot: " + dot);
jjg@482 586 else
jjg@482 587 statusText.setText("dot: " + dot + ", mark:" + mark);
jjg@482 588 }
jjg@482 589 });
jjg@482 590 JScrollPane p = new JScrollPane(body,
jjg@482 591 JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED,
jjg@482 592 JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED);
jjg@482 593 p.setPreferredSize(new Dimension(640, 480));
jjg@482 594 add(p, BorderLayout.CENTER);
jjg@482 595
jjg@482 596 statusText = createTextField(80);
jjg@482 597 add(statusText, BorderLayout.SOUTH);
jjg@482 598
jjg@482 599 pack();
jjg@482 600 setLocationRelativeTo(null); // centered on screen
jjg@482 601 setVisible(true);
jjg@482 602 setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
jjg@482 603 }
jjg@482 604
jjg@482 605 /** Show an entry that has been selected. */
jjg@482 606 private void showEntry(Entry e) {
jjg@482 607 try {
jjg@482 608 // update simple fields
jjg@482 609 setTitle(e.file.getName());
jjg@482 610 checkField.setText(e.check);
jjg@482 611 enclPanel.setInfo(e.encl);
jjg@482 612 selfPanel.setInfo(e.self);
jjg@482 613 // show file text with highlights
jjg@482 614 body.setText(e.file.getCharContent(true).toString());
jjg@482 615 Highlighter highlighter = body.getHighlighter();
jjg@482 616 highlighter.removeAllHighlights();
jjg@482 617 addHighlight(highlighter, e.encl, enclColor);
jjg@482 618 addHighlight(highlighter, e.self, selfColor);
jjg@482 619 scroll(body, getMinPos(enclPanel.info, selfPanel.info));
jjg@482 620 } catch (IOException ex) {
jjg@482 621 body.setText("Cannot read " + e.file.getName() + ": " + e);
jjg@482 622 }
jjg@482 623 }
jjg@482 624
jjg@482 625 /** Create a test field. */
jjg@482 626 private JTextField createTextField(int width) {
jjg@482 627 JTextField f = new JTextField(width);
jjg@482 628 f.setEditable(false);
jjg@482 629 f.setBorder(null);
jjg@482 630 return f;
jjg@482 631 }
jjg@482 632
jjg@482 633 /** Add a highlighted region based on the positions in an Info object. */
jjg@482 634 private void addHighlight(Highlighter h, Info info, Color c) {
jjg@482 635 int start = info.start;
jjg@482 636 int end = info.end;
jjg@482 637 if (start == -1 && end == -1)
jjg@482 638 return;
jjg@482 639 if (start == -1)
jjg@482 640 start = end;
jjg@482 641 if (end == -1)
jjg@482 642 end = start;
jjg@482 643 try {
jjg@482 644 h.addHighlight(info.start, info.end,
jjg@482 645 new DefaultHighlighter.DefaultHighlightPainter(c));
jjg@482 646 if (info.pos != -1) {
jjg@482 647 Color c2 = new Color(c.getRed(), c.getGreen(), c.getBlue(), (int)(.4f * 255)); // 40%
jjg@482 648 h.addHighlight(info.pos, info.pos + 1,
jjg@482 649 new DefaultHighlighter.DefaultHighlightPainter(c2));
jjg@482 650 }
jjg@482 651 } catch (BadLocationException e) {
jjg@482 652 e.printStackTrace();
jjg@482 653 }
jjg@482 654 }
jjg@482 655
jjg@482 656 /** Get the minimum valid position in a set of info objects. */
jjg@482 657 private int getMinPos(Info... values) {
jjg@482 658 int i = Integer.MAX_VALUE;
jjg@482 659 for (Info info: values) {
jjg@482 660 if (info.start >= 0) i = Math.min(i, info.start);
jjg@482 661 if (info.pos >= 0) i = Math.min(i, info.pos);
jjg@482 662 if (info.end >= 0) i = Math.min(i, info.end);
jjg@482 663 }
jjg@482 664 return (i == Integer.MAX_VALUE) ? 0 : i;
jjg@482 665 }
jjg@482 666
jjg@482 667 /** Set the background on a component. */
jjg@482 668 private JComponent setBackground(JComponent comp, Color c) {
jjg@482 669 comp.setOpaque(true);
jjg@482 670 comp.setBackground(c);
jjg@482 671 return comp;
jjg@482 672 }
jjg@482 673
jjg@482 674 /** Scroll a text area to display a given position near the middle of the visible area. */
jjg@482 675 private void scroll(final JTextArea t, final int pos) {
jjg@482 676 // Using invokeLater appears to give text a chance to sort itself out
jjg@482 677 // before the scroll happens; otherwise scrollRectToVisible doesn't work.
jjg@482 678 // Maybe there's a better way to sync with the text...
jjg@482 679 EventQueue.invokeLater(new Runnable() {
jjg@482 680 public void run() {
jjg@482 681 try {
jjg@482 682 Rectangle r = t.modelToView(pos);
jjg@482 683 JScrollPane p = (JScrollPane) SwingUtilities.getAncestorOfClass(JScrollPane.class, t);
jjg@482 684 r.y = Math.max(0, r.y - p.getHeight() * 2 / 5);
jjg@482 685 r.height += p.getHeight() * 4 / 5;
jjg@482 686 t.scrollRectToVisible(r);
jjg@482 687 } catch (BadLocationException ignore) {
jjg@482 688 }
jjg@482 689 }
jjg@482 690 });
jjg@482 691 }
jjg@482 692
jjg@482 693 private JComboBox entries;
jjg@482 694 private JTextField checkField;
jjg@482 695 private InfoPanel enclPanel;
jjg@482 696 private InfoPanel selfPanel;
jjg@482 697 private JTextArea body;
jjg@482 698 private JTextField statusText;
jjg@482 699
jjg@482 700 private Color selfColor = new Color(0.f, 1.f, 0.f, 0.2f); // 20% green
jjg@482 701 private Color enclColor = new Color(1.f, 0.f, 0.f, 0.2f); // 20% red
jjg@482 702
jjg@482 703 /** Panel to display an Info object. */
jjg@482 704 private class InfoPanel extends JPanel {
jjg@482 705 InfoPanel() {
jjg@482 706 add(tagName = createTextField(20));
jjg@482 707 add(new JLabel("start:"));
jjg@482 708 add(addListener(start = createTextField(6)));
jjg@482 709 add(new JLabel("pos:"));
jjg@482 710 add(addListener(pos = createTextField(6)));
jjg@482 711 add(new JLabel("end:"));
jjg@482 712 add(addListener(end = createTextField(6)));
jjg@482 713 }
jjg@482 714
jjg@482 715 void setInfo(Info info) {
jjg@482 716 this.info = info;
jjg@482 717 tagName.setText(tagNames.get(info.tag));
jjg@482 718 start.setText(String.valueOf(info.start));
jjg@482 719 pos.setText(String.valueOf(info.pos));
jjg@482 720 end.setText(String.valueOf(info.end));
jjg@482 721 }
jjg@482 722
jjg@482 723 JTextField addListener(final JTextField f) {
jjg@482 724 f.addMouseListener(new MouseAdapter() {
jjg@482 725 @Override
jjg@482 726 public void mouseClicked(MouseEvent e) {
jjg@482 727 body.setCaretPosition(Integer.valueOf(f.getText()));
jjg@482 728 body.getCaret().setVisible(true);
jjg@482 729 }
jjg@482 730 });
jjg@482 731 return f;
jjg@482 732 }
jjg@482 733
jjg@482 734 Info info;
jjg@482 735 JTextField tagName;
jjg@482 736 JTextField start;
jjg@482 737 JTextField pos;
jjg@482 738 JTextField end;
jjg@482 739 }
jjg@482 740
jjg@482 741 /** Object to record information about an error to be displayed. */
jjg@482 742 private class Entry {
jjg@482 743 Entry(JavaFileObject file, String check, Info encl, Info self) {
jjg@482 744 this.file = file;
jjg@482 745 this.check = check;
jjg@482 746 this.encl = encl;
jjg@482 747 this.self= self;
jjg@482 748 }
jjg@482 749
jjg@482 750 @Override
jjg@482 751 public String toString() {
jjg@482 752 return file.getName() + " " + check + " " + getMinPos(encl, self);
jjg@482 753 }
jjg@482 754
jjg@482 755 final JavaFileObject file;
jjg@482 756 final String check;
jjg@482 757 final Info encl;
jjg@482 758 final Info self;
jjg@482 759 }
jjg@482 760 }
jjg@482 761 }
jjg@482 762

mercurial