Mon, 21 Jan 2013 11:16:28 -0800
Merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. |
aoqi@0 | 8 | * |
aoqi@0 | 9 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 12 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 13 | * accompanied this code). |
aoqi@0 | 14 | * |
aoqi@0 | 15 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 16 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 17 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 18 | * |
aoqi@0 | 19 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 20 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 21 | * questions. |
aoqi@0 | 22 | */ |
aoqi@0 | 23 | |
aoqi@0 | 24 | /* @test |
aoqi@0 | 25 | * @bug 6985202 |
aoqi@0 | 26 | * @summary no access to doc comments from Tree API |
aoqi@0 | 27 | */ |
aoqi@0 | 28 | |
aoqi@0 | 29 | import java.io.*; |
aoqi@0 | 30 | import java.util.*; |
aoqi@0 | 31 | import javax.tools.*; |
aoqi@0 | 32 | import com.sun.source.tree.*; |
aoqi@0 | 33 | import com.sun.source.util.*; |
aoqi@0 | 34 | import com.sun.tools.javac.api.JavacTool; |
aoqi@0 | 35 | |
aoqi@0 | 36 | /** |
aoqi@0 | 37 | * class-TestDocComments. |
aoqi@0 | 38 | */ |
aoqi@0 | 39 | public class TestDocComments { |
aoqi@0 | 40 | /** |
aoqi@0 | 41 | * method-main. |
aoqi@0 | 42 | */ |
aoqi@0 | 43 | public static void main(String... args) throws Exception { |
aoqi@0 | 44 | new TestDocComments().run(); |
aoqi@0 | 45 | } |
aoqi@0 | 46 | |
aoqi@0 | 47 | /** |
aoqi@0 | 48 | * method-run. |
aoqi@0 | 49 | */ |
aoqi@0 | 50 | void run() throws Exception { |
aoqi@0 | 51 | File testSrc = new File(System.getProperty("test.src")); |
aoqi@0 | 52 | File file = new File(testSrc, "TestDocComments.java"); |
aoqi@0 | 53 | |
aoqi@0 | 54 | JavacTool tool = JavacTool.create(); |
aoqi@0 | 55 | StandardJavaFileManager fm = tool.getStandardFileManager(null, null, null); |
aoqi@0 | 56 | |
aoqi@0 | 57 | StringWriter sw = new StringWriter(); |
aoqi@0 | 58 | PrintWriter pw = new PrintWriter(sw); |
aoqi@0 | 59 | Iterable<? extends JavaFileObject> fileObjects = fm.getJavaFileObjects(file); |
aoqi@0 | 60 | JavacTask task = tool.getTask(pw, fm, null, null, null, fileObjects); |
aoqi@0 | 61 | Iterable<? extends CompilationUnitTree> units = task.parse(); |
aoqi@0 | 62 | Trees trees = Trees.instance(task); |
aoqi@0 | 63 | |
aoqi@0 | 64 | CommentScanner s = new CommentScanner(); |
aoqi@0 | 65 | int n = s.scan(units, trees); |
aoqi@0 | 66 | |
aoqi@0 | 67 | if (n != 12) |
aoqi@0 | 68 | error("Unexpected number of doc comments found: " + n); |
aoqi@0 | 69 | |
aoqi@0 | 70 | if (errors > 0) |
aoqi@0 | 71 | throw new Exception(errors + " errors occurred"); |
aoqi@0 | 72 | } |
aoqi@0 | 73 | |
aoqi@0 | 74 | /** |
aoqi@0 | 75 | * class-CommentScanner. |
aoqi@0 | 76 | */ |
aoqi@0 | 77 | class CommentScanner extends TreePathScanner<Integer,Trees> { |
aoqi@0 | 78 | |
aoqi@0 | 79 | /** |
aoqi@0 | 80 | * method-visitClass. |
aoqi@0 | 81 | */ |
aoqi@0 | 82 | @Override |
aoqi@0 | 83 | public Integer visitClass(ClassTree t, Trees trees) { |
aoqi@0 | 84 | return reduce(super.visitClass(t, trees), |
aoqi@0 | 85 | check(trees, "class-" + t.getSimpleName() + ".")); |
aoqi@0 | 86 | } |
aoqi@0 | 87 | |
aoqi@0 | 88 | /** |
aoqi@0 | 89 | * method-visitMethod. |
aoqi@0 | 90 | */ |
aoqi@0 | 91 | @Override |
aoqi@0 | 92 | public Integer visitMethod(MethodTree t, Trees trees) { |
aoqi@0 | 93 | return reduce(super.visitMethod(t, trees), |
aoqi@0 | 94 | check(trees, "method-" + t.getName() + ".")); |
aoqi@0 | 95 | } |
aoqi@0 | 96 | |
aoqi@0 | 97 | /** |
aoqi@0 | 98 | * method-visitVariable. |
aoqi@0 | 99 | */ |
aoqi@0 | 100 | @Override |
aoqi@0 | 101 | public Integer visitVariable(VariableTree t, Trees trees) { |
aoqi@0 | 102 | // for simplicity, only check fields, not parameters or local decls |
aoqi@0 | 103 | int n = (getCurrentPath().getParentPath().getLeaf().getKind() == Tree.Kind.CLASS) |
aoqi@0 | 104 | ? check(trees, "field-" + t.getName() + ".") |
aoqi@0 | 105 | : 0; |
aoqi@0 | 106 | return reduce(super.visitVariable(t, trees), n); |
aoqi@0 | 107 | } |
aoqi@0 | 108 | |
aoqi@0 | 109 | /** |
aoqi@0 | 110 | * method-reduce. |
aoqi@0 | 111 | */ |
aoqi@0 | 112 | @Override |
aoqi@0 | 113 | public Integer reduce(Integer i1, Integer i2) { |
aoqi@0 | 114 | return (i1 == null) ? i2 : (i2 == null) ? i1 : Integer.valueOf(i1 + i2); |
aoqi@0 | 115 | } |
aoqi@0 | 116 | |
aoqi@0 | 117 | /** |
aoqi@0 | 118 | * method-check. |
aoqi@0 | 119 | */ |
aoqi@0 | 120 | int check(Trees trees, String expect) { |
aoqi@0 | 121 | TreePath p = getCurrentPath(); |
aoqi@0 | 122 | String dc = trees.getDocComment(p); |
aoqi@0 | 123 | |
aoqi@0 | 124 | if (dc != null && dc.trim().equals(expect)) |
aoqi@0 | 125 | return 1; |
aoqi@0 | 126 | |
aoqi@0 | 127 | Tree.Kind k = p.getLeaf().getKind(); |
aoqi@0 | 128 | if (dc == null) |
aoqi@0 | 129 | error("no doc comment for " + k); |
aoqi@0 | 130 | else |
aoqi@0 | 131 | error("unexpected doc comment for " + k + "\nexpect: " + expect + "\nfound: " + dc); |
aoqi@0 | 132 | |
aoqi@0 | 133 | return 0; |
aoqi@0 | 134 | } |
aoqi@0 | 135 | } |
aoqi@0 | 136 | |
aoqi@0 | 137 | /** |
aoqi@0 | 138 | * method-nullCheck. |
aoqi@0 | 139 | */ |
aoqi@0 | 140 | int nullCheck(Integer i) { |
aoqi@0 | 141 | return (i == null) ? 0 : i; |
aoqi@0 | 142 | } |
aoqi@0 | 143 | |
aoqi@0 | 144 | /** |
aoqi@0 | 145 | * method-error. |
aoqi@0 | 146 | */ |
aoqi@0 | 147 | void error(String msg) { |
aoqi@0 | 148 | System.err.println("Error: " + msg); |
aoqi@0 | 149 | errors++; |
aoqi@0 | 150 | } |
aoqi@0 | 151 | |
aoqi@0 | 152 | /** |
aoqi@0 | 153 | * field-errors. |
aoqi@0 | 154 | */ |
aoqi@0 | 155 | int errors; |
aoqi@0 | 156 | } |
aoqi@0 | 157 |