1 /*
2 * Copyright (c) 2010, 2018, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23
24 /**
25 * Utility and test program to check javac's internal TreeScanner class.
26 * The program can be run standalone, or as a jtreg test. For info on
27 * command line args, run program with no args.
28 *
29 * <p>
30 * jtreg: Note that by using the -r switch in the test description below, this test
31 * will process all java files in the langtools/test directory, thus implicitly
32 * covering any new language features that may be tested in this test suite.
33 */
34
35 /*
36 * @test
37 * @bug 6923080
38 * @summary TreeScanner.visitNewClass should scan tree.typeargs
39 * @modules jdk.compiler/com.sun.tools.javac.api
40 * jdk.compiler/com.sun.tools.javac.file
41 * jdk.compiler/com.sun.tools.javac.tree
42 * jdk.compiler/com.sun.tools.javac.util
43 * @build AbstractTreeScannerTest SourceTreeScannerTest
44 * @run main SourceTreeScannerTest -q -r .
45 */
46
47 import java.io.*;
48 import java.lang.reflect.*;
49 import java.util.*;
50
51 import javax.tools.*;
52
53 import com.sun.source.tree.CaseTree.CaseKind;
54 import com.sun.source.tree.Tree;
55 import com.sun.source.util.TreeScanner;
56 import com.sun.tools.javac.tree.JCTree;
57 import com.sun.tools.javac.tree.JCTree.JCCase;
58 import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
59 import com.sun.tools.javac.tree.JCTree.JCModuleDecl;
60 import com.sun.tools.javac.tree.JCTree.TypeBoundKind;
61 import com.sun.tools.javac.util.List;
62
63 public class SourceTreeScannerTest extends AbstractTreeScannerTest {
64 /**
65 * Main entry point.
66 * If test.src is set, program runs in jtreg mode, and will throw an Error
67 * if any errors arise, otherwise System.exit will be used. In jtreg mode,
68 * the default base directory for file args is the value of ${test.src}.
69 * In jtreg mode, the -r option can be given to change the default base
70 * directory to the root test directory.
71 */
72 public static void main(String... args) {
73 String testSrc = System.getProperty("test.src");
74 File baseDir = (testSrc == null) ? null : new File(testSrc);
75 boolean ok = new SourceTreeScannerTest().run(baseDir, args);
76 if (!ok) {
77 if (testSrc != null) // jtreg mode
78 throw new Error("failed");
79 else
80 System.exit(1);
81 }
82 }
83
84 int test(JCCompilationUnit tree) {
85 return new ScanTester().test(tree);
86 }
87
88 /**
89 * Main class for testing operation of tree scanner.
90 * The set of nodes found by the scanner are compared
91 * against the set of nodes found by reflection.
92 */
93 private class ScanTester extends TreeScanner<Void,Void> {
94 /** Main entry method for the class. */
95 int test(JCCompilationUnit tree) {
96 sourcefile = tree.sourcefile;
97 found = new HashSet<Tree>();
98 scan(tree, null);
99 expect = new HashSet<Tree>();
100 reflectiveScan(tree);
101
102 if (found.equals(expect)) {
103 //System.err.println(sourcefile.getName() + ": trees compared OK");
104 return found.size();
105 }
106
107 error(sourcefile.getName() + ": differences found");
108
109 if (found.size() != expect.size())
110 error("Size mismatch; found: " + found.size() + ", expected: " + expect.size());
111
112 Set<Tree> missing = new HashSet<Tree>();
113 missing.addAll(expect);
114 missing.removeAll(found);
115 for (Tree t: missing)
116 error(sourcefile, t, "missing");
117
118 Set<Tree> excess = new HashSet<Tree>();
119 excess.addAll(found);
120 excess.removeAll(expect);
121 for (Tree t: excess)
122 error(sourcefile, t, "unexpected");
123
124 return 0;
125 }
126
127 /** Record all tree nodes found by scanner. */
128 @Override
129 public Void scan(Tree tree, Void ignore) {
130 if (tree == null)
131 return null;
132 //System.err.println("FOUND: " + tree.getKind() + " " + trim(tree, 64));
133 found.add(tree);
134 return super.scan(tree, ignore);
135 }
136
137 /** record all tree nodes found by reflection. */
138 public void reflectiveScan(Object o) {
139 if (o == null)
140 return;
141 if (o instanceof JCTree) {
142 JCTree tree = (JCTree) o;
143 //System.err.println("EXPECT: " + tree.getKind() + " " + trim(tree, 64));
144 expect.add(tree);
145 for (Field f: getFields(tree)) {
146 if (TypeBoundKind.class.isAssignableFrom(f.getType())) {
147 // not part of public API
148 continue;
149 }
150 try {
151 //System.err.println("FIELD: " + f.getName());
152 if (tree instanceof JCModuleDecl && f.getName().equals("mods")) {
153 // The modifiers will not found by TreeScanner,
154 // but the embedded annotations will be.
155 reflectiveScan(((JCModuleDecl) tree).mods.annotations);
156 } else if (tree instanceof JCCase &&
157 ((JCCase) tree).getCaseKind() == CaseKind.RULE &&
158 f.getName().equals("stats")) {
159 //value case, visit value:
160 reflectiveScan(((JCCase) tree).getBody());
161 } else {
162 reflectiveScan(f.get(tree));
163 }
164 } catch (IllegalAccessException e) {
165 error(e.toString());
166 }
167 }
168 } else if (o instanceof List) {
169 List<?> list = (List<?>) o;
170 for (Object item: list)
171 reflectiveScan(item);
172 } else
173 error("unexpected item: " + o);
174 }
175
176 JavaFileObject sourcefile;
177 Set<Tree> found;
178 Set<Tree> expect;
179 }
180 }