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 import com.sun.tools.javac.util.Pair;
  63 
  64 public class SourceTreeScannerTest extends AbstractTreeScannerTest {
  65     /**
  66      * Main entry point.
  67      * If test.src is set, program runs in jtreg mode, and will throw an Error
  68      * if any errors arise, otherwise System.exit will be used. In jtreg mode,
  69      * the default base directory for file args is the value of ${test.src}.
  70      * In jtreg mode, the -r option can be given to change the default base
  71      * directory to the root test directory.
  72      */
  73     public static void main(String... args) {
  74         String testSrc = System.getProperty("test.src");
  75         File baseDir = (testSrc == null) ? null : new File(testSrc);
  76         boolean ok = new SourceTreeScannerTest().run(baseDir, args);
  77         if (!ok) {
  78             if (testSrc != null)  // jtreg mode
  79                 throw new Error("failed");
  80             else
  81                 System.exit(1);
  82         }
  83     }
  84 
  85     int test(JCCompilationUnit tree) {
  86         return new ScanTester().test(tree);
  87     }
  88 
  89     /**
  90      * Main class for testing operation of tree scanner.
  91      * The set of nodes found by the scanner are compared
  92      * against the set of nodes found by reflection.
  93      */
  94     private class ScanTester extends TreeScanner<Void,Void> {
  95         /** Main entry method for the class. */
  96         int test(JCCompilationUnit tree) {
  97             sourcefile = tree.sourcefile;
  98             found = new HashSet<Tree>();
  99             scan(tree, null);
 100             expect = new HashSet<Tree>();
 101             reflectiveScan(tree);
 102 
 103             if (found.equals(expect)) {
 104                 //System.err.println(sourcefile.getName() + ": trees compared OK");
 105                 return found.size();
 106             }
 107 
 108             error(sourcefile.getName() + ": differences found");
 109 
 110             if (found.size() != expect.size())
 111                 error("Size mismatch; found: " + found.size() + ", expected: " + expect.size());
 112 
 113             Set<Tree> missing = new HashSet<Tree>();
 114             missing.addAll(expect);
 115             missing.removeAll(found);
 116             for (Tree t: missing)
 117                 error(sourcefile, t, "missing");
 118 
 119             Set<Tree> excess = new HashSet<Tree>();
 120             excess.addAll(found);
 121             excess.removeAll(expect);
 122             for (Tree t: excess)
 123                 error(sourcefile, t, "unexpected");
 124 
 125             return 0;
 126         }
 127 
 128         /** Record all tree nodes found by scanner. */
 129         @Override
 130         public Void scan(Tree tree, Void ignore) {
 131             if (tree == null)
 132                 return null;
 133             //System.err.println("FOUND: " + tree.getKind() + " " + trim(tree, 64));
 134             found.add(tree);
 135             return super.scan(tree, ignore);
 136         }
 137 
 138         /** record all tree nodes found by reflection. */
 139         public void reflectiveScan(Object o) {
 140             if (o == null)
 141                 return;
 142             if (o instanceof JCTree) {
 143                 JCTree tree = (JCTree) o;
 144                 //System.err.println("EXPECT: " + tree.getKind() + " " + trim(tree, 64));
 145                 expect.add(tree);
 146                 for (Field f: getFields(tree)) {
 147                     if (TypeBoundKind.class.isAssignableFrom(f.getType())) {
 148                         // not part of public API
 149                         continue;
 150                     }
 151                     try {
 152                         //System.err.println("FIELD: " + f.getName());
 153                         if (tree instanceof JCModuleDecl && f.getName().equals("mods")) {
 154                             // The modifiers will not found by TreeScanner,
 155                             // but the embedded annotations will be.
 156                             reflectiveScan(((JCModuleDecl) tree).mods.annotations);
 157                         } else if (tree instanceof JCCase &&
 158                                    ((JCCase) tree).getCaseKind() == CaseKind.RULE &&
 159                                    f.getName().equals("stats")) {
 160                             //value case, visit value:
 161                             reflectiveScan(((JCCase) tree).getBody());
 162                         } else {
 163                             reflectiveScan(f.get(tree));
 164                         }
 165                     } catch (IllegalAccessException e) {
 166                         error(e.toString());
 167                     }
 168                 }
 169             } else if (o instanceof List) {
 170                 List<?> list = (List<?>) o;
 171                 for (Object item: list)
 172                     reflectiveScan(item);
 173             } else if (o instanceof Pair) {
 174                 return;
 175             } else
 176                 error("unexpected item: " + o);
 177         }
 178 
 179         JavaFileObject sourcefile;
 180         Set<Tree> found;
 181         Set<Tree> expect;
 182     }
 183 }