aoqi@0: /* aoqi@0: * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. aoqi@0: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. aoqi@0: * aoqi@0: * This code is free software; you can redistribute it and/or modify it aoqi@0: * under the terms of the GNU General Public License version 2 only, as aoqi@0: * published by the Free Software Foundation. aoqi@0: * aoqi@0: * This code is distributed in the hope that it will be useful, but WITHOUT aoqi@0: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or aoqi@0: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License aoqi@0: * version 2 for more details (a copy is included in the LICENSE file that aoqi@0: * accompanied this code). aoqi@0: * aoqi@0: * You should have received a copy of the GNU General Public License version aoqi@0: * 2 along with this work; if not, write to the Free Software Foundation, aoqi@0: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. aoqi@0: * aoqi@0: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA aoqi@0: * or visit www.oracle.com if you need additional information or have any aoqi@0: * questions. aoqi@0: */ aoqi@0: aoqi@0: /* aoqi@0: * @test aoqi@0: * @bug 7021614 aoqi@0: * @summary extend com.sun.source API to support parsing javadoc comments aoqi@0: */ aoqi@0: aoqi@0: import com.sun.source.doctree.DocCommentTree; aoqi@0: import com.sun.source.doctree.DocTree; aoqi@0: import com.sun.source.doctree.DocTreeVisitor; aoqi@0: import com.sun.source.tree.ClassTree; aoqi@0: import com.sun.source.tree.CompilationUnitTree; aoqi@0: import com.sun.source.tree.MethodTree; aoqi@0: import com.sun.source.tree.Tree; aoqi@0: import com.sun.source.tree.VariableTree; aoqi@0: import com.sun.source.util.DocTreeScanner; aoqi@0: import com.sun.source.util.DocTrees; aoqi@0: import com.sun.source.util.JavacTask; aoqi@0: import com.sun.source.util.SimpleDocTreeVisitor; aoqi@0: import com.sun.source.util.TreePath; aoqi@0: import com.sun.source.util.TreePathScanner; aoqi@0: import com.sun.tools.javac.api.JavacTool; aoqi@0: import java.io.File; aoqi@0: import java.util.ArrayList; aoqi@0: import java.util.EnumSet; aoqi@0: import java.util.List; aoqi@0: import java.util.Set; aoqi@0: import javax.lang.model.element.Name; aoqi@0: import javax.tools.JavaFileObject; aoqi@0: import javax.tools.StandardJavaFileManager; aoqi@0: aoqi@0: public class SimpleDocTreeVisitorTest { aoqi@0: public static void main(String... args) throws Exception { aoqi@0: SimpleDocTreeVisitorTest t = new SimpleDocTreeVisitorTest(); aoqi@0: t.run(); aoqi@0: } aoqi@0: aoqi@0: void run() throws Exception { aoqi@0: List files = new ArrayList(); aoqi@0: File testSrc = new File(System.getProperty("test.src")); aoqi@0: for (File f: testSrc.listFiles()) { aoqi@0: if (f.isFile() && f.getName().endsWith(".java")) aoqi@0: files.add(f); aoqi@0: } aoqi@0: aoqi@0: JavacTool javac = JavacTool.create(); aoqi@0: StandardJavaFileManager fm = javac.getStandardFileManager(null, null, null); aoqi@0: aoqi@0: Iterable fos = fm.getJavaFileObjectsFromFiles(files); aoqi@0: aoqi@0: JavacTask t = javac.getTask(null, fm, null, null, null, fos); aoqi@0: DocTrees trees = DocTrees.instance(t); aoqi@0: aoqi@0: Iterable units = t.parse(); aoqi@0: aoqi@0: Set found = EnumSet.noneOf(DocTree.Kind.class); aoqi@0: DeclScanner ds = new DeclScanner(trees, found); aoqi@0: for (CompilationUnitTree unit: units) { aoqi@0: ds.scan(unit, null); aoqi@0: } aoqi@0: aoqi@0: for (DocTree.Kind k: DocTree.Kind.values()) { aoqi@0: if (!found.contains(k) && k != DocTree.Kind.OTHER) aoqi@0: error("not found: " + k); aoqi@0: } aoqi@0: aoqi@0: if (errors > 0) aoqi@0: throw new Exception(errors + " errors occurred"); aoqi@0: } aoqi@0: aoqi@0: void error(String msg) { aoqi@0: System.err.println("Error: " + msg); aoqi@0: errors++; aoqi@0: } aoqi@0: aoqi@0: int errors; aoqi@0: aoqi@0: static class DeclScanner extends TreePathScanner { aoqi@0: DocTrees trees; aoqi@0: DocTreeScanner cs; aoqi@0: aoqi@0: DeclScanner(DocTrees trees, final Set found) { aoqi@0: this.trees = trees; aoqi@0: cs = new CommentScanner(found); aoqi@0: } aoqi@0: aoqi@0: @Override aoqi@0: public Void visitClass(ClassTree tree, Void ignore) { aoqi@0: super.visitClass(tree, ignore); aoqi@0: visitDecl(tree, tree.getSimpleName()); aoqi@0: return null; aoqi@0: } aoqi@0: aoqi@0: @Override aoqi@0: public Void visitMethod(MethodTree tree, Void ignore) { aoqi@0: super.visitMethod(tree, ignore); aoqi@0: visitDecl(tree, tree.getName()); aoqi@0: return null; aoqi@0: } aoqi@0: aoqi@0: @Override aoqi@0: public Void visitVariable(VariableTree tree, Void ignore) { aoqi@0: super.visitVariable(tree, ignore); aoqi@0: visitDecl(tree, tree.getName()); aoqi@0: return null; aoqi@0: } aoqi@0: aoqi@0: void visitDecl(Tree tree, Name name) { aoqi@0: TreePath path = getCurrentPath(); aoqi@0: DocCommentTree dc = trees.getDocCommentTree(path); aoqi@0: if (dc != null) aoqi@0: cs.scan(dc, null); aoqi@0: } aoqi@0: } aoqi@0: aoqi@0: static class CommentScanner extends DocTreeScanner { aoqi@0: DocTreeVisitor visitor; aoqi@0: aoqi@0: CommentScanner(Set found) { aoqi@0: visitor = new Visitor(found); aoqi@0: } aoqi@0: aoqi@0: @Override aoqi@0: public Void scan(DocTree tree, Void ignore) { aoqi@0: if (tree != null) aoqi@0: tree.accept(visitor, ignore); aoqi@0: return super.scan(tree, ignore); aoqi@0: } aoqi@0: } aoqi@0: aoqi@0: static class Visitor extends SimpleDocTreeVisitor { aoqi@0: Set found; aoqi@0: aoqi@0: Visitor(Set found) { aoqi@0: this.found = found; aoqi@0: } aoqi@0: aoqi@0: @Override aoqi@0: public Void defaultAction(DocTree tree, Void ignore) { aoqi@0: found.add(tree.getKind()); aoqi@0: return null; aoqi@0: } aoqi@0: } aoqi@0: }