/*
* Copyright (c) 2010, 2019, 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 public DocTreeScanner class.
* The program can be run standalone, or as a jtreg test. 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 8227922
* @summary Verify the behavior of DocTreeScanner
* @modules jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.tree
* jdk.compiler/com.sun.tools.javac.util
* @build AbstractTreeScannerTest SourceDocTreeScannerTest
* @run main SourceDocTreeScannerTest -q -r .
*/
import java.io.*;
import java.lang.reflect.*;
import java.util.*;
import javax.tools.*;
import com.sun.source.doctree.DocCommentTree;
import com.sun.source.doctree.DocTree;
import com.sun.source.tree.Tree;
import com.sun.source.util.DocTreeScanner;
import com.sun.source.util.DocTrees;
import com.sun.source.util.JavacTask;
import com.sun.source.util.TreePath;
import com.sun.source.util.TreePathScanner;
import com.sun.tools.javac.tree.DCTree;
import com.sun.tools.javac.tree.DCTree.DCDocComment;
import com.sun.tools.javac.tree.DCTree.DCReference;
import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
import com.sun.tools.javac.util.List;
import com.sun.tools.javac.util.Pair;
public class SourceDocTreeScannerTest extends AbstractTreeScannerTest {
/**
* 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. 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.
*/
public static void main(String... args) {
String testSrc = System.getProperty("test.src");
File baseDir = (testSrc == null) ? null : new File(testSrc);
boolean ok = new SourceDocTreeScannerTest().run(baseDir, args);
if (!ok) {
if (testSrc != null) // jtreg mode
throw new Error("failed");
else
System.exit(1);
}
}
int test(Pair<JavacTask, JCCompilationUnit> taskAndTree) {
return new ScanTester().test(taskAndTree);
}
/**
* Main class for testing operation of tree scanner.
* The set of nodes found by the scanner are compared
* against the set of nodes found by reflection.
*/
private class ScanTester extends DocTreeScanner<Void,Void> {
/** Main entry method for the class. */
int test(Pair<JavacTask, JCCompilationUnit> taskAndTree) {
sourcefile = taskAndTree.snd.sourcefile;
int[] count = new int[1];
new TreePathScanner<Void, Void>() {
@Override
public Void scan(Tree tree, Void p) {
if (tree != null) {
DocTrees trees = DocTrees.instance(taskAndTree.fst);
DocCommentTree dcTree = trees.getDocCommentTree(new TreePath(getCurrentPath(), tree));
if (dcTree != null) {
found = new HashSet<>();
ScanTester.this.scan(dcTree, null);
expect = new HashSet<>();
ScanTester.this.reflectiveScan(dcTree);
if (found.equals(expect)) {
//System.err.println(sourcefile.getName() + ": trees compared OK");
count[0] += found.size();
} else {
error(sourcefile.getName() + ": differences found");
if (found.size() != expect.size())
error("Size mismatch; found: " + found.size() + ", expected: " + expect.size());
Set<DocTree> missing = new HashSet<>();
missing.addAll(expect);
missing.removeAll(found);
for (DocTree t: missing)
error(sourcefile, dcTree, t, "missing");
Set<DocTree> excess = new HashSet<>();
excess.addAll(found);
excess.removeAll(expect);
for (DocTree t: excess)
error(sourcefile, dcTree, t, "unexpected");
}
}
}
return super.scan(tree, p);
}
}.scan(taskAndTree.snd, null);
return 0;
}
/** Record all tree nodes found by scanner. */
@Override
public Void scan(DocTree tree, Void ignore) {
if (tree == null)
return null;
//System.err.println("FOUND: " + tree.getKind() + " " + trim(tree, 64));
found.add(tree);
return super.scan(tree, ignore);
}
/** record all tree nodes found by reflection. */
public void reflectiveScan(Object o) {
if (o == null)
return;
if (o instanceof DCTree) {
DCTree tree = (DCTree) o;
//System.err.println("EXPECT: " + tree.getKind() + " " + trim(tree, 64));
expect.add(tree);
for (Field f: getFields(tree)) {
try {
if (tree instanceof DCReference && f.getName().equals("paramTypes")) {
//ignore - list of JCTrees
} else if (tree instanceof DCDocComment &&
!f.getName().equals("firstSentence") &&
!f.getName().equals("body") &&
!f.getName().equals("tags")) {
//ignore - covered by other fields
} else {
reflectiveScan(f.get(tree));
}
} catch (IllegalAccessException e) {
error(e.toString());
}
}
} else if (o instanceof List) {
List<?> list = (List<?>) o;
for (Object item: list)
reflectiveScan(item);
} else
error("unexpected item: " + o);
}
JavaFileObject sourcefile;
Set<DocTree> found;
Set<DocTree> expect;
}
}