/* * Copyright (c) 2010, 2017, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions.
*/
/** * Utility and test program to check validity of tree positions for tree nodes. * The program can be run standalone, or as a jtreg test. In standalone mode, * errors can be displayed in a gui viewer. For info on command line args, * run program with no args. * * <p> * jtreg: Note that by using the -r switch in the test description below, this test * will process all java files in the langtools/test directory, thus implicitly * covering any new language features that may be tested in this test suite.
*/
/* * @test * @bug 6919889 * @summary assorted position errors in compiler syntax trees * OLD: -q -r -ef ./tools/javac/typeAnnotations -ef ./tools/javap/typeAnnotations -et ANNOTATED_TYPE . * @modules java.desktop * jdk.compiler/com.sun.tools.javac.api * jdk.compiler/com.sun.tools.javac.code * jdk.compiler/com.sun.tools.javac.file * jdk.compiler/com.sun.tools.javac.tree * jdk.compiler/com.sun.tools.javac.util * @run main TreePosTest -q -r .
*/ publicclass TreePosTest { /** * Main entry point. * If test.src is set, program runs in jtreg mode, and will throw an Error * if any errors arise, otherwise System.exit will be used, unless the gui * viewer is being used. In jtreg mode, the default base directory for file * args is the value of ${test.src}. In jtreg mode, the -r option can be * given to change the default base directory to the root test directory.
*/ publicstaticvoid main(String... args) throws IOException {
String testSrc = System.getProperty("test.src");
File baseDir = (testSrc == null) ? null : new File(testSrc); boolean ok = new TreePosTest().run(baseDir, args); if (!ok) { if (testSrc != null) // jtreg mode thrownew Error("failed"); else
System.exit(1);
}
}
/** * Run the program. A base directory can be provided for file arguments. * In jtreg mode, the -r option can be given to change the default base * directory to the test root directory. For other options, see usage(). * @param baseDir base directory for any file arguments. * @param args command line args * @return true if successful or in gui mode
*/ boolean run(File baseDir, String... args) throws IOException { try { if (args.length == 0) {
usage(System.out); returntrue;
}
List<File> files = new ArrayList<File>(); for (int i = 0; i < args.length; i++) {
String arg = args[i]; if (arg.equals("-encoding") && i + 1 < args.length)
encoding = args[++i]; elseif (arg.equals("-gui"))
gui = true; elseif (arg.equals("-q"))
quiet = true; elseif (arg.equals("-v"))
verbose = true; elseif (arg.equals("-t") && i + 1 < args.length)
tags.add(args[++i]); elseif (arg.equals("-ef") && i + 1 < args.length)
excludeFiles.add(new File(baseDir, args[++i])); elseif (arg.equals("-et") && i + 1 < args.length)
excludeTags.add(args[++i]); elseif (arg.equals("-r")) { if (excludeFiles.size() > 0) thrownew Error("-r must be used before -ef");
File d = baseDir; while (!new File(d, "TEST.ROOT").exists()) {
d = d.getParentFile(); if (d == null) thrownew Error("cannot find TEST.ROOT");
}
baseDir = d;
} elseif (arg.startsWith("-")) thrownew Error("unknown option: " + arg); else { while (i < args.length)
files.add(new File(baseDir, args[i++]));
}
}
for (File file: files) { if (file.exists())
test(file); else
error("File not found: " + file);
}
if (fileCount != 1)
System.err.println(fileCount + " files read"); if (errors > 0)
System.err.println(errors + " errors");
/** * Print command line help. * @param out output stream
*/ void usage(PrintStream out) {
out.println("Usage:");
out.println(" java TreePosTest options... files...");
out.println("");
out.println("where options include:");
out.println("-gui Display returns in a GUI viewer");
out.println("-q Quiet: don't report on inapplicable files");
out.println("-v Verbose: report on files as they are being read");
out.println("-t tag Limit checks to tree nodes with this tag");
out.println(" Can be repeated if desired");
out.println("-ef file Exclude file or directory");
out.println("-et tag Exclude tree nodes with given tag name");
out.println("");
out.println("files may be directories or files");
out.println("directories will be scanned recursively");
out.println("non java files, or java files which cannot be parsed, will be ignored");
out.println("");
}
/** * Test a file. If the file is a directory, it will be recursively scanned * for java files. * @param file the file or directory to test
*/ void test(File file) { if (excludeFiles.contains(file)) { if (!quiet)
error("File " + file + " excluded"); return;
}
if (file.isDirectory()) { for (File f: file.listFiles()) {
test(f);
} return;
}
// See CR: 6982992 Tests CheckAttributedTree.java, JavacTreeScannerTest.java, and SourceTreeeScannerTest.java timeout
StringWriter sw = new StringWriter();
PrintWriter pw = new PrintWriter(sw);
Reporter r = new Reporter(pw);
JavacTool tool = JavacTool.create();
StandardJavaFileManager fm = tool.getStandardFileManager(r, null, null);
/** * Read a file. * @param file the file to be read * @return the tree for the content of the file * @throws IOException if any IO errors occur * @throws TreePosTest.ParseException if any errors occur while parsing the file
*/
JCCompilationUnit read(File file) throws IOException, ParseException {
JavacTool tool = JavacTool.create();
r.errors = 0;
Iterable<? extends JavaFileObject> files = fm.getJavaFileObjects(file);
JavacTask task = tool.getTask(pw, fm, r, List.of("-proc:none"), null, files);
Iterable<? extends CompilationUnitTree> trees = task.parse();
pw.flush(); if (r.errors > 0) thrownew ParseException(sw.toString());
Iterator<? extends CompilationUnitTree> iter = trees.iterator(); if (!iter.hasNext()) thrownew Error("no trees found");
JCCompilationUnit t = (JCCompilationUnit) iter.next(); if (iter.hasNext()) thrownew Error("too many trees found"); return t;
}
/** * Report an error. When the program is complete, the program will either * exit or throw an Error if any errors have been reported. * @param msg the error message
*/ void error(String msg) {
System.err.println(msg);
errors++;
}
/** * Names for tree tags.
*/ privatestatic String getTagName(JCTree.Tag tag) {
String name = tag.name(); return (name == null) ? "??" : name;
}
/** Number of files that have been analyzed. */ int fileCount; /** Number of errors reported. */ int errors; /** Flag: don't report irrelevant files. */ boolean quiet; /** Flag: report files as they are processed. */ boolean verbose; /** Flag: show errors in GUI viewer. */ boolean gui; /** Option: encoding for test files. */
String encoding; /** The GUI viewer for errors. */
Viewer viewer; /** The set of tags for tree nodes to be analyzed; if empty, all tree nodes
* are analyzed. */
Set<String> tags = new HashSet<String>(); /** Set of files and directories to be excluded from analysis. */
Set<File> excludeFiles = new HashSet<File>(); /** Set of tag names to be excluded from analysis. */
Set<String> excludeTags = new HashSet<String>();
/** * Main class for testing assertions concerning tree positions for tree nodes.
*/ privateclass PosTester extends TreeScanner { void test(JCCompilationUnit tree) {
sourcefile = tree.sourcefile;
endPosTable = tree.endPositions;
encl = new Info();
tree.accept(this);
}
@Override publicvoid scan(JCTree tree) { if (tree == null) return;
Info self = new Info(tree, endPosTable); if (check(encl, self)) { // Modifiers nodes are present throughout the tree even where // there is no corresponding source text. // Redundant semicolons in a class definition can cause empty // initializer blocks with no positions. if ((self.tag == MODIFIERS || self.tag == BLOCK)
&& self.pos == NOPOS) { // If pos is NOPOS, so should be the start and end positions
check("start == NOPOS", encl, self, self.start == NOPOS);
check("end == NOPOS", encl, self, self.end == NOPOS);
} else { // For this node, start , pos, and endpos should be all defined
check("start != NOPOS", encl, self, self.start != NOPOS);
check("pos != NOPOS", encl, self, self.pos != NOPOS);
check("end != NOPOS", encl, self, self.end != NOPOS); // The following should normally be ordered // encl.start <= start <= pos <= end <= encl.end // In addition, the position of the enclosing node should be // within this node. // The primary exceptions are for array type nodes, because of the // need to support legacy syntax: // e.g. int a[]; int[] b[]; int f()[] { return null; } // and because of inconsistent nesting of left and right of // array declarations: // e.g. int[][] a = new int[2][]; if (!(encl.tag == REFERENCE && self.tag == ANNOTATED_TYPE)) {
check("encl.start <= start", encl, self, encl.start <= self.start);
}
check("start <= pos", encl, self, self.start <= self.pos); if (!( (self.tag == TYPEARRAY ||
isAnnotatedArray(self.tree))
&& (encl.tag == VARDEF ||
encl.tag == METHODDEF ||
encl.tag == TYPEARRAY ||
isAnnotatedArray(encl.tree))
||
encl.tag == ANNOTATED_TYPE && self.tag == SELECT
||
encl.tag == REFERENCE && self.tag == ANNOTATED_TYPE
)) {
check("encl.pos <= start || end <= encl.pos",
encl, self, encl.pos <= self.start || self.end <= encl.pos);
}
check("pos <= end", encl, self, self.pos <= self.end); if (!( (self.tag == TYPEARRAY || isAnnotatedArray(self.tree)) &&
(encl.tag == TYPEARRAY || isAnnotatedArray(encl.tree))
||
encl.tag == MODIFIERS && self.tag == ANNOTATION
) ) {
check("end <= encl.end", encl, self, self.end <= encl.end);
}
}
}
@Override publicvoid visitMethodDef(JCMethodDecl tree) { // ignore compact record constructors if ((tree.mods.flags & Flags.COMPACT_RECORD_CONSTRUCTOR) == 0) { super.visitMethodDef(tree);
}
}
@Override publicvoid visitVarDef(JCVariableDecl tree) { // enum member declarations are desugared in the parser and have // ill-defined semantics for tree positions, so for now, we // skip the synthesized bits and just check parts which came from // the original source text if ((tree.mods.flags & Flags.ENUM) != 0) {
scan(tree.mods); if (tree.init != null) { if (tree.init.hasTag(NEWCLASS)) {
JCNewClass init = (JCNewClass) tree.init; if (init.args != null && init.args.nonEmpty()) {
scan(init.args);
} if (init.def != null && init.def.defs != null) {
scan(init.def.defs);
}
}
}
} else super.visitVarDef(tree);
}
boolean check(Info encl, Info self) { if (excludeTags.size() > 0) { if (encl != null && excludeTags.contains(getTagName(encl.tag))
|| excludeTags.contains(getTagName(self.tag))) returnfalse;
} return tags.size() == 0 || tags.contains(getTagName(self.tag));
}
void check(String label, Info encl, Info self, boolean ok) { if (!ok) { if (gui) { if (viewer == null)
viewer = new Viewer();
viewer.addEntry(sourcefile, label, encl, self);
}
JavaFileObject sourcefile;
EndPosTable endPosTable;
Info encl;
}
/** * Utility class providing easy access to position and other info for a tree node.
*/ privateclass Info {
Info() {
tree = null;
tag = ERRONEOUS;
start = 0;
pos = 0;
end = Integer.MAX_VALUE;
}
final JCTree tree; final JCTree.Tag tag; finalint start; finalint pos; finalint end;
}
/** * Thrown when errors are found parsing a java file.
*/ privatestaticclass ParseException extends Exception {
ParseException(String msg) { super(msg);
}
}
/** * DiagnosticListener to report diagnostics and count any errors that occur.
*/ privatestaticclass Reporter implements DiagnosticListener<JavaFileObject> {
Reporter(PrintWriter out) { this.out = out;
}
publicvoid report(Diagnostic<? extends JavaFileObject> diagnostic) {
out.println(diagnostic); switch (diagnostic.getKind()) { case ERROR:
errors++;
}
} int errors;
PrintWriter out;
}
/** * GUI viewer for issues found by TreePosTester. The viewer provides a drop * down list for selecting error conditions, a header area providing details * about an error, and a text area with the ranges of text highlighted as * appropriate.
*/ privateclass Viewer extends JFrame { /** * Create a viewer.
*/
Viewer() {
initGUI();
}
/** * Add another entry to the list of errors. * @param file The file containing the error * @param check The condition that was being tested, and which failed * @param encl the enclosing tree node * @param self the tree node containing the error
*/ void addEntry(JavaFileObject file, String check, Info encl, Info self) {
Entry e = new Entry(file, check, encl, self);
DefaultComboBoxModel m = (DefaultComboBoxModel) entries.getModel();
m.addElement(e); if (m.getSize() == 1)
entries.setSelectedItem(e);
}
/** * Initialize the GUI window.
*/ privatevoid initGUI() {
JPanel head = new JPanel(new GridBagLayout());
GridBagConstraints lc = new GridBagConstraints();
GridBagConstraints fc = new GridBagConstraints();
fc.anchor = GridBagConstraints.WEST;
fc.fill = GridBagConstraints.HORIZONTAL;
fc.gridwidth = GridBagConstraints.REMAINDER;
pack();
setLocationRelativeTo(null); // centered on screen
setVisible(true);
setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
}
/** Show an entry that has been selected. */ privatevoid showEntry(Entry e) { try { // update simple fields
setTitle(e.file.getName());
checkField.setText(e.check);
enclPanel.setInfo(e.encl);
selfPanel.setInfo(e.self); // show file text with highlights
body.setText(e.file.getCharContent(true).toString());
Highlighter highlighter = body.getHighlighter();
highlighter.removeAllHighlights();
addHighlight(highlighter, e.encl, enclColor);
addHighlight(highlighter, e.self, selfColor);
scroll(body, getMinPos(enclPanel.info, selfPanel.info));
} catch (IOException ex) {
body.setText("Cannot read " + e.file.getName() + ": " + e);
}
}
/** Create a test field. */ private JTextField createTextField(int width) {
JTextField f = new JTextField(width);
f.setEditable(false);
f.setBorder(null); return f;
}
/** Add a highlighted region based on the positions in an Info object. */ privatevoid addHighlight(Highlighter h, Info info, Color c) { int start = info.start; int end = info.end; if (start == -1 && end == -1) return; if (start == -1)
start = end; if (end == -1)
end = start; try {
h.addHighlight(info.start, info.end, new DefaultHighlighter.DefaultHighlightPainter(c)); if (info.pos != -1) {
Color c2 = new Color(c.getRed(), c.getGreen(), c.getBlue(), (int)(.4f * 255)); // 40%
h.addHighlight(info.pos, info.pos + 1, new DefaultHighlighter.DefaultHighlightPainter(c2));
}
} catch (BadLocationException e) {
e.printStackTrace();
}
}
/** Get the minimum valid position in a set of info objects. */ privateint getMinPos(Info... values) { int i = Integer.MAX_VALUE; for (Info info: values) { if (info.start >= 0) i = Math.min(i, info.start); if (info.pos >= 0) i = Math.min(i, info.pos); if (info.end >= 0) i = Math.min(i, info.end);
} return (i == Integer.MAX_VALUE) ? 0 : i;
}
/** Set the background on a component. */ private JComponent setBackground(JComponent comp, Color c) {
comp.setOpaque(true);
comp.setBackground(c); return comp;
}
/** Scroll a text area to display a given position near the middle of the visible area. */ privatevoid scroll(final JTextArea t, finalint pos) { // Using invokeLater appears to give text a chance to sort itself out // before the scroll happens; otherwise scrollRectToVisible doesn't work. // Maybe there's a better way to sync with the text...
EventQueue.invokeLater(new Runnable() { publicvoid run() { try {
Rectangle r = t.modelToView(pos);
JScrollPane p = (JScrollPane) SwingUtilities.getAncestorOfClass(JScrollPane.class, t);
r.y = Math.max(0, r.y - p.getHeight() * 2 / 5);
r.height += p.getHeight() * 4 / 5;
t.scrollRectToVisible(r);
} catch (BadLocationException ignore) {
}
}
});
}
/** Object to record information about an error to be displayed. */ privateclass Entry {
Entry(JavaFileObject file, String check, Info encl, Info self) { this.file = file; this.check = check; this.encl = encl; this.self= self;
}
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.