jjg@482: /* jjg@482: * Copyright 2010 Sun Microsystems, Inc. All Rights Reserved. jjg@482: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. jjg@482: * jjg@482: * This code is free software; you can redistribute it and/or modify it jjg@482: * under the terms of the GNU General Public License version 2 only, as jjg@482: * published by the Free Software Foundation. jjg@482: * jjg@482: * This code is distributed in the hope that it will be useful, but WITHOUT jjg@482: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or jjg@482: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License jjg@482: * version 2 for more details (a copy is included in the LICENSE file that jjg@482: * accompanied this code). jjg@482: * jjg@482: * You should have received a copy of the GNU General Public License version jjg@482: * 2 along with this work; if not, write to the Free Software Foundation, jjg@482: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. jjg@482: * jjg@482: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, jjg@482: * CA 95054 USA or visit www.sun.com if you need additional information or jjg@482: * have any questions. jjg@482: */ jjg@482: jjg@482: import java.awt.BorderLayout; jjg@482: import java.awt.Color; jjg@482: import java.awt.Dimension; jjg@482: import java.awt.EventQueue; jjg@482: import java.awt.Font; jjg@482: import java.awt.GridBagConstraints; jjg@482: import java.awt.GridBagLayout; jjg@482: import java.awt.Rectangle; jjg@482: import java.awt.event.ActionEvent; jjg@482: import java.awt.event.ActionListener; jjg@482: import java.awt.event.MouseAdapter; jjg@482: import java.awt.event.MouseEvent; jjg@482: import java.io.File; jjg@482: import java.io.IOException; jjg@482: import java.io.PrintStream; jjg@482: import java.io.PrintWriter; jjg@482: import java.io.StringWriter; jjg@482: import java.lang.reflect.Field; jjg@482: import java.lang.reflect.Modifier; jjg@482: import java.nio.charset.Charset; jjg@482: import java.util.ArrayList; jjg@482: import java.util.Collections; jjg@482: import java.util.HashMap; jjg@482: import java.util.HashSet; jjg@482: import java.util.Iterator; jjg@482: import java.util.List; jjg@482: import java.util.Map; jjg@482: import java.util.Set; jjg@482: import javax.swing.DefaultComboBoxModel; jjg@482: import javax.swing.JComboBox; jjg@482: import javax.swing.JComponent; jjg@482: import javax.swing.JFrame; jjg@482: import javax.swing.JLabel; jjg@482: import javax.swing.JPanel; jjg@482: import javax.swing.JScrollPane; jjg@482: import javax.swing.JTextArea; jjg@482: import javax.swing.JTextField; jjg@482: import javax.swing.SwingUtilities; jjg@482: import javax.swing.event.CaretEvent; jjg@482: import javax.swing.event.CaretListener; jjg@482: import javax.swing.text.BadLocationException; jjg@482: import javax.swing.text.DefaultHighlighter; jjg@482: import javax.swing.text.Highlighter; jjg@482: import javax.tools.Diagnostic; jjg@482: import javax.tools.DiagnosticListener; jjg@482: import javax.tools.JavaFileObject; jjg@482: import javax.tools.StandardJavaFileManager; jjg@482: jjg@482: import com.sun.source.tree.CompilationUnitTree; jjg@482: import com.sun.source.util.JavacTask; jjg@482: import com.sun.tools.javac.api.JavacTool; jjg@482: import com.sun.tools.javac.code.Flags; jjg@482: import com.sun.tools.javac.tree.JCTree; jjg@482: import com.sun.tools.javac.tree.JCTree.JCCompilationUnit; jjg@482: import com.sun.tools.javac.tree.JCTree.JCNewClass; jjg@482: import com.sun.tools.javac.tree.JCTree.JCVariableDecl; jjg@482: import com.sun.tools.javac.tree.TreeInfo; jjg@482: import com.sun.tools.javac.tree.TreeScanner; jjg@482: jjg@482: import static com.sun.tools.javac.util.Position.NOPOS; jjg@482: jjg@482: /** jjg@482: * Utility and test program to check validity of tree positions for tree nodes. jjg@482: * The program can be run standalone, or as a jtreg test. In standalone mode, jjg@482: * errors can be displayed in a gui viewer. For info on command line args, jjg@482: * run program with no args. jjg@482: * jjg@482: *

jjg@482: * jtreg: Note that by using the -r switch in the test description below, this test jjg@482: * will process all java files in the langtools/test directory, thus implicitly jjg@482: * covering any new language features that may be tested in this test suite. jjg@482: */ jjg@482: jjg@482: /* jjg@482: * @test jjg@482: * @bug 6919889 jjg@482: * @summary assorted position errors in compiler syntax trees jjg@493: * @run main TreePosTest -q -r -ef ./tools/javac/typeAnnotations -ef ./tools/javap/typeAnnotations -et ANNOTATED_TYPE . jjg@482: */ jjg@482: public class TreePosTest { jjg@482: /** jjg@482: * Main entry point. jjg@482: * If test.src is set, program runs in jtreg mode, and will throw an Error jjg@482: * if any errors arise, otherwise System.exit will be used, unless the gui jjg@482: * viewer is being used. In jtreg mode, the default base directory for file jjg@482: * args is the value of ${test.src}. In jtreg mode, the -r option can be jjg@482: * given to change the default base directory to the root test directory. jjg@482: */ jjg@482: public static void main(String... args) { jjg@482: String testSrc = System.getProperty("test.src"); jjg@482: File baseDir = (testSrc == null) ? null : new File(testSrc); jjg@482: boolean ok = new TreePosTest().run(baseDir, args); jjg@482: if (!ok) { jjg@482: if (testSrc != null) // jtreg mode jjg@482: throw new Error("failed"); jjg@482: else jjg@482: System.exit(1); jjg@482: } jjg@482: } jjg@482: jjg@482: /** jjg@482: * Run the program. A base directory can be provided for file arguments. jjg@482: * In jtreg mode, the -r option can be given to change the default base jjg@482: * directory to the test root directory. For other options, see usage(). jjg@482: * @param baseDir base directory for any file arguments. jjg@482: * @param args command line args jjg@482: * @return true if successful or in gui mode jjg@482: */ jjg@482: boolean run(File baseDir, String... args) { jjg@482: if (args.length == 0) { jjg@482: usage(System.out); jjg@482: return true; jjg@482: } jjg@482: jjg@482: List files = new ArrayList(); jjg@482: for (int i = 0; i < args.length; i++) { jjg@482: String arg = args[i]; jjg@482: if (arg.equals("-encoding") && i + 1 < args.length) jjg@482: encoding = args[++i]; jjg@482: else if (arg.equals("-gui")) jjg@482: gui = true; jjg@482: else if (arg.equals("-q")) jjg@482: quiet = true; jjg@482: else if (arg.equals("-v")) jjg@482: verbose = true; jjg@482: else if (arg.equals("-t") && i + 1 < args.length) jjg@482: tags.add(args[++i]); jjg@482: else if (arg.equals("-ef") && i + 1 < args.length) jjg@482: excludeFiles.add(new File(baseDir, args[++i])); jjg@493: else if (arg.equals("-et") && i + 1 < args.length) jjg@493: excludeTags.add(args[++i]); jjg@482: else if (arg.equals("-r")) { jjg@482: if (excludeFiles.size() > 0) jjg@482: throw new Error("-r must be used before -ef"); jjg@482: File d = baseDir; jjg@482: while (!new File(d, "TEST.ROOT").exists()) { jjg@482: d = d.getParentFile(); jjg@482: if (d == null) jjg@482: throw new Error("cannot find TEST.ROOT"); jjg@482: } jjg@482: baseDir = d; jjg@482: } jjg@482: else if (arg.startsWith("-")) jjg@482: throw new Error("unknown option: " + arg); jjg@482: else { jjg@482: while (i < args.length) jjg@482: files.add(new File(baseDir, args[i++])); jjg@482: } jjg@482: } jjg@482: jjg@482: for (File file: files) { jjg@482: if (file.exists()) jjg@482: test(file); jjg@482: else jjg@482: error("File not found: " + file); jjg@482: } jjg@482: jjg@482: if (fileCount != 1) jjg@482: System.err.println(fileCount + " files read"); jjg@482: if (errors > 0) jjg@482: System.err.println(errors + " errors"); jjg@482: jjg@482: return (gui || errors == 0); jjg@482: } jjg@482: jjg@482: /** jjg@482: * Print command line help. jjg@482: * @param out output stream jjg@482: */ jjg@482: void usage(PrintStream out) { jjg@482: out.println("Usage:"); jjg@482: out.println(" java TreePosTest options... files..."); jjg@482: out.println(""); jjg@482: out.println("where options include:"); jjg@482: out.println("-gui Display returns in a GUI viewer"); jjg@482: out.println("-q Quiet: don't report on inapplicable files"); jjg@482: out.println("-v Verbose: report on files as they are being read"); jjg@482: out.println("-t tag Limit checks to tree nodes with this tag"); jjg@482: out.println(" Can be repeated if desired"); jjg@482: out.println("-ef file Exclude file or directory"); jjg@493: out.println("-et tag Exclude tree nodes with given tag name"); jjg@482: out.println(""); jjg@482: out.println("files may be directories or files"); jjg@482: out.println("directories will be scanned recursively"); jjg@482: out.println("non java files, or java files which cannot be parsed, will be ignored"); jjg@482: out.println(""); jjg@482: } jjg@482: jjg@482: /** jjg@482: * Test a file. If the file is a directory, it will be recursively scanned jjg@482: * for java files. jjg@482: * @param file the file or directory to test jjg@482: */ jjg@482: void test(File file) { jjg@482: if (excludeFiles.contains(file)) { jjg@482: if (!quiet) jjg@482: error("File " + file + " excluded"); jjg@482: return; jjg@482: } jjg@482: jjg@482: if (file.isDirectory()) { jjg@482: for (File f: file.listFiles()) { jjg@482: test(f); jjg@482: } jjg@482: return; jjg@482: } jjg@482: jjg@482: if (file.isFile() && file.getName().endsWith(".java")) { jjg@482: try { jjg@482: if (verbose) jjg@482: System.err.println(file); jjg@482: fileCount++; jjg@482: PosTester p = new PosTester(); jjg@482: p.test(read(file)); jjg@482: } catch (ParseException e) { jjg@482: if (!quiet) { jjg@482: error("Error parsing " + file + "\n" + e.getMessage()); jjg@482: } jjg@482: } catch (IOException e) { jjg@482: error("Error reading " + file + ": " + e); jjg@482: } jjg@482: return; jjg@482: } jjg@482: jjg@482: if (!quiet) jjg@482: error("File " + file + " ignored"); jjg@482: } jjg@482: jjg@482: /** jjg@482: * Read a file. jjg@482: * @param file the file to be read jjg@482: * @return the tree for the content of the file jjg@482: * @throws IOException if any IO errors occur jjg@482: * @throws TreePosTest.ParseException if any errors occur while parsing the file jjg@482: */ jjg@482: JCCompilationUnit read(File file) throws IOException, ParseException { jjg@482: StringWriter sw = new StringWriter(); jjg@482: PrintWriter pw = new PrintWriter(sw); jjg@482: Reporter r = new Reporter(pw); jjg@482: JavacTool tool = JavacTool.create(); jjg@482: Charset cs = (encoding == null ? null : Charset.forName(encoding)); jjg@482: StandardJavaFileManager fm = tool.getStandardFileManager(r, null, null); jjg@482: Iterable files = fm.getJavaFileObjects(file); jjg@482: JavacTask task = tool.getTask(pw, fm, r, Collections.emptyList(), null, files); jjg@482: Iterable trees = task.parse(); jjg@482: pw.flush(); jjg@482: if (r.errors > 0) jjg@482: throw new ParseException(sw.toString()); jjg@482: Iterator iter = trees.iterator(); jjg@482: if (!iter.hasNext()) jjg@482: throw new Error("no trees found"); jjg@482: JCCompilationUnit t = (JCCompilationUnit) iter.next(); jjg@482: if (iter.hasNext()) jjg@482: throw new Error("too many trees found"); jjg@482: return t; jjg@482: } jjg@482: jjg@482: /** jjg@482: * Report an error. When the program is complete, the program will either jjg@482: * exit or throw an Error if any errors have been reported. jjg@482: * @param msg the error message jjg@482: */ jjg@482: void error(String msg) { jjg@482: System.err.println(msg); jjg@482: errors++; jjg@482: } jjg@482: jjg@482: /** Number of files that have been analyzed. */ jjg@482: int fileCount; jjg@482: /** Number of errors reported. */ jjg@482: int errors; jjg@482: /** Flag: don't report irrelevant files. */ jjg@482: boolean quiet; jjg@482: /** Flag: report files as they are processed. */ jjg@482: boolean verbose; jjg@482: /** Flag: show errors in GUI viewer. */ jjg@482: boolean gui; jjg@482: /** Option: encoding for test files. */ jjg@482: String encoding; jjg@482: /** The GUI viewer for errors. */ jjg@482: Viewer viewer; jjg@482: /** The set of tags for tree nodes to be analyzed; if empty, all tree nodes jjg@482: * are analyzed. */ jjg@482: Set tags = new HashSet(); jjg@482: /** Set of files and directories to be excluded from analysis. */ jjg@482: Set excludeFiles = new HashSet(); jjg@493: /** Set of tag names to be excluded from analysis. */ jjg@493: Set excludeTags = new HashSet(); jjg@482: /** Table of printable names for tree tag values. */ jjg@482: TagNames tagNames = new TagNames(); jjg@482: jjg@482: /** jjg@482: * Main class for testing assertions concerning tree positions for tree nodes. jjg@482: */ jjg@482: private class PosTester extends TreeScanner { jjg@482: void test(JCCompilationUnit tree) { jjg@482: sourcefile = tree.sourcefile; jjg@482: endPosTable = tree.endPositions; jjg@482: encl = new Info(); jjg@482: tree.accept(this); jjg@482: } jjg@482: jjg@482: @Override jjg@482: public void scan(JCTree tree) { jjg@482: if (tree == null) jjg@482: return; jjg@482: jjg@482: Info self = new Info(tree, endPosTable); jjg@493: if (check(encl, self)) { jjg@482: // Modifiers nodes are present throughout the tree even where jjg@482: // there is no corresponding source text. jjg@482: // Redundant semicolons in a class definition can cause empty jjg@482: // initializer blocks with no positions. jjg@482: if ((self.tag == JCTree.MODIFIERS || self.tag == JCTree.BLOCK) jjg@482: && self.pos == NOPOS) { jjg@482: // If pos is NOPOS, so should be the start and end positions jjg@482: check("start == NOPOS", encl, self, self.start == NOPOS); jjg@482: check("end == NOPOS", encl, self, self.end == NOPOS); jjg@482: } else { jjg@482: // For this node, start , pos, and endpos should be all defined jjg@482: check("start != NOPOS", encl, self, self.start != NOPOS); jjg@482: check("pos != NOPOS", encl, self, self.pos != NOPOS); jjg@482: check("end != NOPOS", encl, self, self.end != NOPOS); jjg@482: // The following should normally be ordered jjg@482: // encl.start <= start <= pos <= end <= encl.end jjg@482: // In addition, the position of the enclosing node should be jjg@482: // within this node. jjg@482: // The primary exceptions are for array type nodes, because of the jjg@482: // need to support legacy syntax: jjg@482: // e.g. int a[]; int[] b[]; int f()[] { return null; } jjg@482: // and because of inconsistent nesting of left and right of jjg@482: // array declarations: jjg@482: // e.g. int[][] a = new int[2][]; jjg@482: check("encl.start <= start", encl, self, encl.start <= self.start); jjg@482: check("start <= pos", encl, self, self.start <= self.pos); jjg@482: if (!(self.tag == JCTree.TYPEARRAY jjg@482: && (encl.tag == JCTree.VARDEF || encl.tag == JCTree.TYPEARRAY))) { jjg@482: check("encl.pos <= start || end <= encl.pos", jjg@482: encl, self, encl.pos <= self.start || self.end <= encl.pos); jjg@482: } jjg@482: check("pos <= end", encl, self, self.pos <= self.end); jjg@482: if (!(self.tag == JCTree.TYPEARRAY && encl.tag == JCTree.TYPEARRAY)) { jjg@482: check("end <= encl.end", encl, self, self.end <= encl.end); jjg@482: } jjg@482: } jjg@482: } jjg@482: jjg@482: Info prevEncl = encl; jjg@482: encl = self; jjg@482: tree.accept(this); jjg@482: encl = prevEncl; jjg@482: } jjg@482: jjg@482: @Override jjg@482: public void visitVarDef(JCVariableDecl tree) { jjg@482: // enum member declarations are desugared in the parser and have jjg@482: // ill-defined semantics for tree positions, so for now, we jjg@482: // skip the synthesized bits and just check parts which came from jjg@482: // the original source text jjg@482: if ((tree.mods.flags & Flags.ENUM) != 0) { jjg@482: scan(tree.mods); jjg@482: if (tree.init != null) { jjg@482: if (tree.init.getTag() == JCTree.NEWCLASS) { jjg@482: JCNewClass init = (JCNewClass) tree.init; jjg@482: if (init.args != null && init.args.nonEmpty()) { jjg@482: scan(init.args); jjg@482: } jjg@482: if (init.def != null && init.def.defs != null) { jjg@482: scan(init.def.defs); jjg@482: } jjg@482: } jjg@482: } jjg@482: } else jjg@482: super.visitVarDef(tree); jjg@482: } jjg@482: jjg@493: boolean check(Info encl, Info self) { jjg@493: if (excludeTags.size() > 0) { jjg@493: if (encl != null && excludeTags.contains(tagNames.get(encl.tag)) jjg@493: || excludeTags.contains(tagNames.get(self.tag))) jjg@493: return false; jjg@493: } jjg@493: return tags.size() == 0 || tags.contains(tagNames.get(self.tag)); jjg@482: } jjg@482: jjg@482: void check(String label, Info encl, Info self, boolean ok) { jjg@482: if (!ok) { jjg@482: if (gui) { jjg@482: if (viewer == null) jjg@482: viewer = new Viewer(); jjg@482: viewer.addEntry(sourcefile, label, encl, self); jjg@482: } jjg@482: jjg@482: String s = self.tree.toString(); jjg@482: String msg = sourcefile.getName() + ": " + label + ": " + jjg@482: "encl:" + encl + " this:" + self + "\n" + jjg@482: s.substring(0, Math.min(80, s.length())).replaceAll("[\r\n]+", " "); jjg@482: error(msg); jjg@482: } jjg@482: } jjg@482: jjg@482: JavaFileObject sourcefile; jjg@482: Map endPosTable; jjg@482: Info encl; jjg@482: jjg@482: } jjg@482: jjg@482: /** jjg@482: * Utility class providing easy access to position and other info for a tree node. jjg@482: */ jjg@482: private class Info { jjg@482: Info() { jjg@482: tree = null; jjg@482: tag = JCTree.ERRONEOUS; jjg@482: start = 0; jjg@482: pos = 0; jjg@482: end = Integer.MAX_VALUE; jjg@482: } jjg@482: jjg@482: Info(JCTree tree, Map endPosTable) { jjg@482: this.tree = tree; jjg@482: tag = tree.getTag(); jjg@482: start = TreeInfo.getStartPos(tree); jjg@482: pos = tree.pos; jjg@482: end = TreeInfo.getEndPos(tree, endPosTable); jjg@482: } jjg@482: jjg@482: @Override jjg@482: public String toString() { jjg@482: return tagNames.get(tree.getTag()) + "[start:" + start + ",pos:" + pos + ",end:" + end + "]"; jjg@482: } jjg@482: jjg@482: final JCTree tree; jjg@482: final int tag; jjg@482: final int start; jjg@482: final int pos; jjg@482: final int end; jjg@482: } jjg@482: jjg@482: /** jjg@482: * Names for tree tags. jjg@482: * javac does not provide an API to convert tag values to strings, so this class uses jjg@482: * reflection to determine names of public static final int values in JCTree. jjg@482: */ jjg@482: private static class TagNames { jjg@482: String get(int tag) { jjg@482: if (map == null) { jjg@482: map = new HashMap(); jjg@482: Class c = JCTree.class; jjg@482: for (Field f : c.getDeclaredFields()) { jjg@482: if (f.getType().equals(int.class)) { jjg@482: int mods = f.getModifiers(); jjg@482: if (Modifier.isPublic(mods) && Modifier.isStatic(mods) && Modifier.isFinal(mods)) { jjg@482: try { jjg@482: map.put(f.getInt(null), f.getName()); jjg@482: } catch (IllegalAccessException e) { jjg@482: } jjg@482: } jjg@482: } jjg@482: } jjg@482: } jjg@482: String name = map.get(tag); jjg@482: return (name == null) ? "??" : name; jjg@482: } jjg@482: jjg@482: private Map map; jjg@482: } jjg@482: jjg@482: /** jjg@482: * Thrown when errors are found parsing a java file. jjg@482: */ jjg@482: private static class ParseException extends Exception { jjg@482: ParseException(String msg) { jjg@482: super(msg); jjg@482: } jjg@482: } jjg@482: jjg@482: /** jjg@482: * DiagnosticListener to report diagnostics and count any errors that occur. jjg@482: */ jjg@482: private static class Reporter implements DiagnosticListener { jjg@482: Reporter(PrintWriter out) { jjg@482: this.out = out; jjg@482: } jjg@482: jjg@482: public void report(Diagnostic diagnostic) { jjg@482: out.println(diagnostic); jjg@482: switch (diagnostic.getKind()) { jjg@482: case ERROR: jjg@482: errors++; jjg@482: } jjg@482: } jjg@482: int errors; jjg@482: PrintWriter out; jjg@482: } jjg@482: jjg@482: /** jjg@482: * GUI viewer for issues found by TreePosTester. The viewer provides a drop jjg@482: * down list for selecting error conditions, a header area providing details jjg@482: * about an error, and a text area with the ranges of text highlighted as jjg@482: * appropriate. jjg@482: */ jjg@482: private class Viewer extends JFrame { jjg@482: /** jjg@482: * Create a viewer. jjg@482: */ jjg@482: Viewer() { jjg@482: initGUI(); jjg@482: } jjg@482: jjg@482: /** jjg@482: * Add another entry to the list of errors. jjg@482: * @param file The file containing the error jjg@482: * @param check The condition that was being tested, and which failed jjg@482: * @param encl the enclosing tree node jjg@482: * @param self the tree node containing the error jjg@482: */ jjg@482: void addEntry(JavaFileObject file, String check, Info encl, Info self) { jjg@482: Entry e = new Entry(file, check, encl, self); jjg@482: DefaultComboBoxModel m = (DefaultComboBoxModel) entries.getModel(); jjg@482: m.addElement(e); jjg@482: if (m.getSize() == 1) jjg@482: entries.setSelectedItem(e); jjg@482: } jjg@482: jjg@482: /** jjg@482: * Initialize the GUI window. jjg@482: */ jjg@482: private void initGUI() { jjg@482: JPanel head = new JPanel(new GridBagLayout()); jjg@482: GridBagConstraints lc = new GridBagConstraints(); jjg@482: GridBagConstraints fc = new GridBagConstraints(); jjg@482: fc.anchor = GridBagConstraints.WEST; jjg@482: fc.fill = GridBagConstraints.HORIZONTAL; jjg@482: fc.gridwidth = GridBagConstraints.REMAINDER; jjg@482: jjg@482: entries = new JComboBox(); jjg@482: entries.addActionListener(new ActionListener() { jjg@482: public void actionPerformed(ActionEvent e) { jjg@482: showEntry((Entry) entries.getSelectedItem()); jjg@482: } jjg@482: }); jjg@482: fc.insets.bottom = 10; jjg@482: head.add(entries, fc); jjg@482: fc.insets.bottom = 0; jjg@482: head.add(new JLabel("check:"), lc); jjg@482: head.add(checkField = createTextField(80), fc); jjg@482: fc.fill = GridBagConstraints.NONE; jjg@482: head.add(setBackground(new JLabel("encl:"), enclColor), lc); jjg@482: head.add(enclPanel = new InfoPanel(), fc); jjg@482: head.add(setBackground(new JLabel("self:"), selfColor), lc); jjg@482: head.add(selfPanel = new InfoPanel(), fc); jjg@482: add(head, BorderLayout.NORTH); jjg@482: jjg@482: body = new JTextArea(); jjg@482: body.setFont(Font.decode(Font.MONOSPACED)); jjg@482: body.addCaretListener(new CaretListener() { jjg@482: public void caretUpdate(CaretEvent e) { jjg@482: int dot = e.getDot(); jjg@482: int mark = e.getMark(); jjg@482: if (dot == mark) jjg@482: statusText.setText("dot: " + dot); jjg@482: else jjg@482: statusText.setText("dot: " + dot + ", mark:" + mark); jjg@482: } jjg@482: }); jjg@482: JScrollPane p = new JScrollPane(body, jjg@482: JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED, jjg@482: JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED); jjg@482: p.setPreferredSize(new Dimension(640, 480)); jjg@482: add(p, BorderLayout.CENTER); jjg@482: jjg@482: statusText = createTextField(80); jjg@482: add(statusText, BorderLayout.SOUTH); jjg@482: jjg@482: pack(); jjg@482: setLocationRelativeTo(null); // centered on screen jjg@482: setVisible(true); jjg@482: setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); jjg@482: } jjg@482: jjg@482: /** Show an entry that has been selected. */ jjg@482: private void showEntry(Entry e) { jjg@482: try { jjg@482: // update simple fields jjg@482: setTitle(e.file.getName()); jjg@482: checkField.setText(e.check); jjg@482: enclPanel.setInfo(e.encl); jjg@482: selfPanel.setInfo(e.self); jjg@482: // show file text with highlights jjg@482: body.setText(e.file.getCharContent(true).toString()); jjg@482: Highlighter highlighter = body.getHighlighter(); jjg@482: highlighter.removeAllHighlights(); jjg@482: addHighlight(highlighter, e.encl, enclColor); jjg@482: addHighlight(highlighter, e.self, selfColor); jjg@482: scroll(body, getMinPos(enclPanel.info, selfPanel.info)); jjg@482: } catch (IOException ex) { jjg@482: body.setText("Cannot read " + e.file.getName() + ": " + e); jjg@482: } jjg@482: } jjg@482: jjg@482: /** Create a test field. */ jjg@482: private JTextField createTextField(int width) { jjg@482: JTextField f = new JTextField(width); jjg@482: f.setEditable(false); jjg@482: f.setBorder(null); jjg@482: return f; jjg@482: } jjg@482: jjg@482: /** Add a highlighted region based on the positions in an Info object. */ jjg@482: private void addHighlight(Highlighter h, Info info, Color c) { jjg@482: int start = info.start; jjg@482: int end = info.end; jjg@482: if (start == -1 && end == -1) jjg@482: return; jjg@482: if (start == -1) jjg@482: start = end; jjg@482: if (end == -1) jjg@482: end = start; jjg@482: try { jjg@482: h.addHighlight(info.start, info.end, jjg@482: new DefaultHighlighter.DefaultHighlightPainter(c)); jjg@482: if (info.pos != -1) { jjg@482: Color c2 = new Color(c.getRed(), c.getGreen(), c.getBlue(), (int)(.4f * 255)); // 40% jjg@482: h.addHighlight(info.pos, info.pos + 1, jjg@482: new DefaultHighlighter.DefaultHighlightPainter(c2)); jjg@482: } jjg@482: } catch (BadLocationException e) { jjg@482: e.printStackTrace(); jjg@482: } jjg@482: } jjg@482: jjg@482: /** Get the minimum valid position in a set of info objects. */ jjg@482: private int getMinPos(Info... values) { jjg@482: int i = Integer.MAX_VALUE; jjg@482: for (Info info: values) { jjg@482: if (info.start >= 0) i = Math.min(i, info.start); jjg@482: if (info.pos >= 0) i = Math.min(i, info.pos); jjg@482: if (info.end >= 0) i = Math.min(i, info.end); jjg@482: } jjg@482: return (i == Integer.MAX_VALUE) ? 0 : i; jjg@482: } jjg@482: jjg@482: /** Set the background on a component. */ jjg@482: private JComponent setBackground(JComponent comp, Color c) { jjg@482: comp.setOpaque(true); jjg@482: comp.setBackground(c); jjg@482: return comp; jjg@482: } jjg@482: jjg@482: /** Scroll a text area to display a given position near the middle of the visible area. */ jjg@482: private void scroll(final JTextArea t, final int pos) { jjg@482: // Using invokeLater appears to give text a chance to sort itself out jjg@482: // before the scroll happens; otherwise scrollRectToVisible doesn't work. jjg@482: // Maybe there's a better way to sync with the text... jjg@482: EventQueue.invokeLater(new Runnable() { jjg@482: public void run() { jjg@482: try { jjg@482: Rectangle r = t.modelToView(pos); jjg@482: JScrollPane p = (JScrollPane) SwingUtilities.getAncestorOfClass(JScrollPane.class, t); jjg@482: r.y = Math.max(0, r.y - p.getHeight() * 2 / 5); jjg@482: r.height += p.getHeight() * 4 / 5; jjg@482: t.scrollRectToVisible(r); jjg@482: } catch (BadLocationException ignore) { jjg@482: } jjg@482: } jjg@482: }); jjg@482: } jjg@482: jjg@482: private JComboBox entries; jjg@482: private JTextField checkField; jjg@482: private InfoPanel enclPanel; jjg@482: private InfoPanel selfPanel; jjg@482: private JTextArea body; jjg@482: private JTextField statusText; jjg@482: jjg@482: private Color selfColor = new Color(0.f, 1.f, 0.f, 0.2f); // 20% green jjg@482: private Color enclColor = new Color(1.f, 0.f, 0.f, 0.2f); // 20% red jjg@482: jjg@482: /** Panel to display an Info object. */ jjg@482: private class InfoPanel extends JPanel { jjg@482: InfoPanel() { jjg@482: add(tagName = createTextField(20)); jjg@482: add(new JLabel("start:")); jjg@482: add(addListener(start = createTextField(6))); jjg@482: add(new JLabel("pos:")); jjg@482: add(addListener(pos = createTextField(6))); jjg@482: add(new JLabel("end:")); jjg@482: add(addListener(end = createTextField(6))); jjg@482: } jjg@482: jjg@482: void setInfo(Info info) { jjg@482: this.info = info; jjg@482: tagName.setText(tagNames.get(info.tag)); jjg@482: start.setText(String.valueOf(info.start)); jjg@482: pos.setText(String.valueOf(info.pos)); jjg@482: end.setText(String.valueOf(info.end)); jjg@482: } jjg@482: jjg@482: JTextField addListener(final JTextField f) { jjg@482: f.addMouseListener(new MouseAdapter() { jjg@482: @Override jjg@482: public void mouseClicked(MouseEvent e) { jjg@482: body.setCaretPosition(Integer.valueOf(f.getText())); jjg@482: body.getCaret().setVisible(true); jjg@482: } jjg@482: }); jjg@482: return f; jjg@482: } jjg@482: jjg@482: Info info; jjg@482: JTextField tagName; jjg@482: JTextField start; jjg@482: JTextField pos; jjg@482: JTextField end; jjg@482: } jjg@482: jjg@482: /** Object to record information about an error to be displayed. */ jjg@482: private class Entry { jjg@482: Entry(JavaFileObject file, String check, Info encl, Info self) { jjg@482: this.file = file; jjg@482: this.check = check; jjg@482: this.encl = encl; jjg@482: this.self= self; jjg@482: } jjg@482: jjg@482: @Override jjg@482: public String toString() { jjg@482: return file.getName() + " " + check + " " + getMinPos(encl, self); jjg@482: } jjg@482: jjg@482: final JavaFileObject file; jjg@482: final String check; jjg@482: final Info encl; jjg@482: final Info self; jjg@482: } jjg@482: } jjg@482: } jjg@482: