Sun, 16 Dec 2012 11:09:36 +0100
8005098: Provide isSynthesized() information on Attribute.Compound
Reviewed-by: jjg
jjg@1455 | 1 | /* |
jjg@1455 | 2 | * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved. |
jjg@1455 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
jjg@1455 | 4 | * |
jjg@1455 | 5 | * This code is free software; you can redistribute it and/or modify it |
jjg@1455 | 6 | * under the terms of the GNU General Public License version 2 only, as |
jjg@1455 | 7 | * published by the Free Software Foundation. Oracle designates this |
jjg@1455 | 8 | * particular file as subject to the "Classpath" exception as provided |
jjg@1455 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
jjg@1455 | 10 | * |
jjg@1455 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
jjg@1455 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
jjg@1455 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
jjg@1455 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
jjg@1455 | 15 | * accompanied this code). |
jjg@1455 | 16 | * |
jjg@1455 | 17 | * You should have received a copy of the GNU General Public License version |
jjg@1455 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
jjg@1455 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
jjg@1455 | 20 | * |
jjg@1455 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
jjg@1455 | 22 | * or visit www.oracle.com if you need additional information or have any |
jjg@1455 | 23 | * questions. |
jjg@1455 | 24 | */ |
jjg@1455 | 25 | |
jjg@1455 | 26 | package com.sun.tools.doclint; |
jjg@1455 | 27 | |
jjg@1455 | 28 | import java.io.File; |
jjg@1455 | 29 | import java.io.IOException; |
jjg@1455 | 30 | import java.io.PrintWriter; |
jjg@1455 | 31 | import java.util.ArrayList; |
jjg@1455 | 32 | import java.util.List; |
jjg@1455 | 33 | |
jjg@1455 | 34 | import javax.lang.model.element.Name; |
jjg@1455 | 35 | import javax.tools.StandardLocation; |
jjg@1455 | 36 | |
jjg@1455 | 37 | import com.sun.source.doctree.DocCommentTree; |
jjg@1455 | 38 | import com.sun.source.tree.ClassTree; |
jjg@1455 | 39 | import com.sun.source.tree.CompilationUnitTree; |
jjg@1455 | 40 | import com.sun.source.tree.MethodTree; |
jjg@1455 | 41 | import com.sun.source.tree.Tree; |
jjg@1455 | 42 | import com.sun.source.tree.VariableTree; |
jjg@1455 | 43 | import com.sun.source.util.JavacTask; |
jjg@1455 | 44 | import com.sun.source.util.Plugin; |
jjg@1455 | 45 | import com.sun.source.util.TaskEvent; |
jjg@1455 | 46 | import com.sun.source.util.TaskListener; |
jjg@1455 | 47 | import com.sun.source.util.TreePath; |
jjg@1455 | 48 | import com.sun.source.util.TreePathScanner; |
jjg@1455 | 49 | import com.sun.tools.javac.api.JavacTaskImpl; |
jjg@1455 | 50 | import com.sun.tools.javac.api.JavacTool; |
jjg@1455 | 51 | import com.sun.tools.javac.file.JavacFileManager; |
jjg@1455 | 52 | import com.sun.tools.javac.main.JavaCompiler; |
jjg@1455 | 53 | import com.sun.tools.javac.util.Context; |
jjg@1455 | 54 | |
jjg@1455 | 55 | /** |
jjg@1455 | 56 | * Multi-function entry point for the doc check utility. |
jjg@1455 | 57 | * |
jjg@1455 | 58 | * This class can be invoked in the following ways: |
jjg@1455 | 59 | * <ul> |
jjg@1455 | 60 | * <li>From the command line |
jjg@1455 | 61 | * <li>From javac, as a plugin |
jjg@1455 | 62 | * <li>Directly, via a simple API |
jjg@1455 | 63 | * </ul> |
jjg@1455 | 64 | * |
jjg@1455 | 65 | * <p><b>This is NOT part of any supported API. |
jjg@1455 | 66 | * If you write code that depends on this, you do so at your own |
jjg@1455 | 67 | * risk. This code and its internal interfaces are subject to change |
jjg@1455 | 68 | * or deletion without notice.</b></p> |
jjg@1455 | 69 | */ |
jjg@1455 | 70 | public class DocLint implements Plugin { |
jjg@1455 | 71 | |
jjg@1455 | 72 | public static final String XMSGS_OPTION = "-Xmsgs"; |
jjg@1455 | 73 | public static final String XMSGS_CUSTOM_PREFIX = "-Xmsgs:"; |
jjg@1455 | 74 | private static final String STATS = "-stats"; |
jjg@1455 | 75 | |
jjg@1455 | 76 | // <editor-fold defaultstate="collapsed" desc="Command-line entry point"> |
jjg@1455 | 77 | public static void main(String... args) { |
jjg@1455 | 78 | try { |
jjg@1455 | 79 | new DocLint().run(args); |
jjg@1455 | 80 | } catch (BadArgs e) { |
jjg@1455 | 81 | System.err.println(e.getMessage()); |
jjg@1455 | 82 | System.exit(1); |
jjg@1455 | 83 | } catch (IOException e) { |
jjg@1455 | 84 | System.err.println(e); |
jjg@1455 | 85 | System.exit(2); |
jjg@1455 | 86 | } |
jjg@1455 | 87 | } |
jjg@1455 | 88 | |
jjg@1455 | 89 | // </editor-fold> |
jjg@1455 | 90 | |
jjg@1455 | 91 | // <editor-fold defaultstate="collapsed" desc="Simple API"> |
jjg@1455 | 92 | |
jjg@1455 | 93 | public static class BadArgs extends Exception { |
jjg@1455 | 94 | private static final long serialVersionUID = 0; |
jjg@1455 | 95 | BadArgs(String code, Object... args) { |
jjg@1455 | 96 | this.code = code; |
jjg@1455 | 97 | this.args = args; |
jjg@1455 | 98 | } |
jjg@1455 | 99 | |
jjg@1455 | 100 | final String code; |
jjg@1455 | 101 | final Object[] args; |
jjg@1455 | 102 | } |
jjg@1455 | 103 | |
jjg@1455 | 104 | /** |
jjg@1455 | 105 | * Simple API entry point. |
jjg@1455 | 106 | */ |
jjg@1455 | 107 | public void run(String... args) throws BadArgs, IOException { |
jjg@1455 | 108 | PrintWriter out = new PrintWriter(System.out); |
jjg@1455 | 109 | try { |
jjg@1455 | 110 | run(out, args); |
jjg@1455 | 111 | } finally { |
jjg@1455 | 112 | out.flush(); |
jjg@1455 | 113 | } |
jjg@1455 | 114 | } |
jjg@1455 | 115 | |
jjg@1455 | 116 | public void run(PrintWriter out, String... args) throws BadArgs, IOException { |
jjg@1455 | 117 | env = new Env(); |
jjg@1455 | 118 | processArgs(args); |
jjg@1455 | 119 | |
jjg@1455 | 120 | if (needHelp) |
jjg@1455 | 121 | showHelp(out); |
jjg@1455 | 122 | |
jjg@1455 | 123 | if (javacFiles.isEmpty()) { |
jjg@1455 | 124 | if (!needHelp) |
jjg@1455 | 125 | System.out.println("no files given"); |
jjg@1455 | 126 | } |
jjg@1455 | 127 | |
jjg@1455 | 128 | JavacTool tool = JavacTool.create(); |
jjg@1455 | 129 | |
jjg@1455 | 130 | JavacFileManager fm = new JavacFileManager(new Context(), false, null); |
jjg@1455 | 131 | fm.setSymbolFileEnabled(false); |
jjg@1455 | 132 | fm.setLocation(StandardLocation.PLATFORM_CLASS_PATH, javacBootClassPath); |
jjg@1455 | 133 | fm.setLocation(StandardLocation.CLASS_PATH, javacClassPath); |
jjg@1455 | 134 | fm.setLocation(StandardLocation.SOURCE_PATH, javacSourcePath); |
jjg@1455 | 135 | |
jjg@1455 | 136 | JavacTask task = tool.getTask(out, fm, null, javacOpts, null, |
jjg@1455 | 137 | fm.getJavaFileObjectsFromFiles(javacFiles)); |
jjg@1455 | 138 | Iterable<? extends CompilationUnitTree> units = task.parse(); |
jjg@1455 | 139 | ((JavacTaskImpl) task).enter(); |
jjg@1455 | 140 | |
jjg@1455 | 141 | env.init(task); |
jjg@1455 | 142 | checker = new Checker(env); |
jjg@1455 | 143 | |
jjg@1455 | 144 | DeclScanner ds = new DeclScanner() { |
jjg@1455 | 145 | @Override |
jjg@1455 | 146 | void visitDecl(Tree tree, Name name) { |
jjg@1455 | 147 | TreePath p = getCurrentPath(); |
jjg@1455 | 148 | DocCommentTree dc = env.trees.getDocCommentTree(p); |
jjg@1455 | 149 | |
jjg@1455 | 150 | checker.scan(dc, p); |
jjg@1455 | 151 | } |
jjg@1455 | 152 | }; |
jjg@1455 | 153 | |
jjg@1455 | 154 | ds.scan(units, null); |
jjg@1455 | 155 | |
jjg@1455 | 156 | reportStats(out); |
jjg@1455 | 157 | |
jjg@1455 | 158 | Context ctx = ((JavacTaskImpl) task).getContext(); |
jjg@1455 | 159 | JavaCompiler c = JavaCompiler.instance(ctx); |
jjg@1455 | 160 | c.printCount("error", c.errorCount()); |
jjg@1455 | 161 | c.printCount("warn", c.warningCount()); |
jjg@1455 | 162 | } |
jjg@1455 | 163 | |
jjg@1455 | 164 | void processArgs(String... args) throws BadArgs { |
jjg@1455 | 165 | javacOpts = new ArrayList<String>(); |
jjg@1455 | 166 | javacFiles = new ArrayList<File>(); |
jjg@1455 | 167 | |
jjg@1455 | 168 | if (args.length == 0) |
jjg@1455 | 169 | needHelp = true; |
jjg@1455 | 170 | |
jjg@1455 | 171 | for (int i = 0; i < args.length; i++) { |
jjg@1455 | 172 | String arg = args[i]; |
jjg@1455 | 173 | if (arg.matches("-Xmax(errs|warns)") && i + 1 < args.length) { |
jjg@1455 | 174 | if (args[++i].matches("[0-9]+")) { |
jjg@1455 | 175 | javacOpts.add(arg); |
jjg@1455 | 176 | javacOpts.add(args[i]); |
jjg@1455 | 177 | } else { |
jjg@1455 | 178 | throw new BadArgs("dc.bad.value.for.option", arg, args[i]); |
jjg@1455 | 179 | } |
jjg@1455 | 180 | } else if (arg.equals(STATS)) { |
jjg@1455 | 181 | env.messages.setStatsEnabled(true); |
jjg@1455 | 182 | } else if (arg.matches("-bootclasspath") && i + 1 < args.length) { |
jjg@1455 | 183 | javacBootClassPath = splitPath(args[++i]); |
jjg@1455 | 184 | } else if (arg.matches("-classpath") && i + 1 < args.length) { |
jjg@1455 | 185 | javacClassPath = splitPath(args[++i]); |
jjg@1455 | 186 | } else if (arg.matches("-sourcepath") && i + 1 < args.length) { |
jjg@1455 | 187 | javacSourcePath = splitPath(args[++i]); |
jjg@1455 | 188 | } else if (arg.equals(XMSGS_OPTION)) { |
jjg@1455 | 189 | env.messages.setOptions(null); |
jjg@1455 | 190 | } else if (arg.startsWith(XMSGS_CUSTOM_PREFIX)) { |
jjg@1455 | 191 | env.messages.setOptions(arg.substring(arg.indexOf(":") + 1)); |
jjg@1455 | 192 | } else if (arg.equals("-h") || arg.equals("-help") || arg.equals("--help") |
jjg@1455 | 193 | || arg.equals("-?") || arg.equals("-usage")) { |
jjg@1455 | 194 | needHelp = true; |
jjg@1455 | 195 | } else if (arg.startsWith("-")) { |
jjg@1455 | 196 | throw new BadArgs("dc.bad.option", arg); |
jjg@1455 | 197 | } else { |
jjg@1455 | 198 | while (i < args.length) |
jjg@1455 | 199 | javacFiles.add(new File(args[i++])); |
jjg@1455 | 200 | } |
jjg@1455 | 201 | } |
jjg@1455 | 202 | } |
jjg@1455 | 203 | |
jjg@1455 | 204 | void showHelp(PrintWriter out) { |
jjg@1455 | 205 | out.println("Usage:"); |
jjg@1455 | 206 | out.println(" doclint [options] source-files..."); |
jjg@1455 | 207 | out.println(""); |
jjg@1455 | 208 | out.println("Options:"); |
jjg@1455 | 209 | out.println(" -Xmsgs "); |
jjg@1455 | 210 | out.println(" Same as -Xmsgs:all"); |
jjg@1455 | 211 | out.println(" -Xmsgs:values"); |
jjg@1455 | 212 | out.println(" Specify categories of issues to be checked, where 'values'"); |
jjg@1455 | 213 | out.println(" is a comma-separated list of any of the following:"); |
jjg@1455 | 214 | out.println(" reference show places where comments contain incorrect"); |
jjg@1455 | 215 | out.println(" references to Java source code elements"); |
jjg@1455 | 216 | out.println(" syntax show basic syntax errors within comments"); |
jjg@1455 | 217 | out.println(" html show issues with HTML tags and attributes"); |
jjg@1455 | 218 | out.println(" accessibility show issues for accessibility"); |
jjg@1455 | 219 | out.println(" missing show issues with missing documentation"); |
jjg@1455 | 220 | out.println(" all all of the above"); |
jjg@1455 | 221 | out.println(" Precede a value with '-' to negate it"); |
jjg@1455 | 222 | out.println(" Categories may be qualified by one of:"); |
jjg@1455 | 223 | out.println(" /public /protected /package /private"); |
jjg@1455 | 224 | out.println(" For positive categories (not beginning with '-')"); |
jjg@1455 | 225 | out.println(" the qualifier applies to that access level and above."); |
jjg@1455 | 226 | out.println(" For negative categories (beginning with '-')"); |
jjg@1455 | 227 | out.println(" the qualifier applies to that access level and below."); |
jjg@1455 | 228 | out.println(" If a qualifier is missing, the category applies to"); |
jjg@1455 | 229 | out.println(" all access levels."); |
jjg@1455 | 230 | out.println(" For example, -Xmsgs:all,-syntax/private"); |
jjg@1455 | 231 | out.println(" This will enable all messages, except syntax errors"); |
jjg@1455 | 232 | out.println(" in the doc comments of private methods."); |
jjg@1455 | 233 | out.println(" If no -Xmsgs options are provided, the default is"); |
jjg@1455 | 234 | out.println(" equivalent to -Xmsgs:all/protected, meaning that"); |
jjg@1455 | 235 | out.println(" all messages are reported for protected and public"); |
jjg@1455 | 236 | out.println(" declarations only. "); |
jjg@1455 | 237 | out.println(" -h -help --help -usage -?"); |
jjg@1455 | 238 | out.println(" Show this message."); |
jjg@1455 | 239 | out.println(""); |
jjg@1455 | 240 | out.println("The following javac options are also supported"); |
jjg@1455 | 241 | out.println(" -bootclasspath, -classpath, -sourcepath, -Xmaxerrs, -Xmaxwarns"); |
jjg@1455 | 242 | out.println(""); |
jjg@1455 | 243 | out.println("To run doclint on part of a project, put the compiled classes for your"); |
jjg@1455 | 244 | out.println("project on the classpath (or bootclasspath), then specify the source files"); |
jjg@1455 | 245 | out.println("to be checked on the command line."); |
jjg@1455 | 246 | } |
jjg@1455 | 247 | |
jjg@1455 | 248 | List<File> splitPath(String path) { |
jjg@1455 | 249 | List<File> files = new ArrayList<File>(); |
jjg@1455 | 250 | for (String f: path.split(File.separator)) { |
jjg@1455 | 251 | if (f.length() > 0) |
jjg@1455 | 252 | files.add(new File(f)); |
jjg@1455 | 253 | } |
jjg@1455 | 254 | return files; |
jjg@1455 | 255 | } |
jjg@1455 | 256 | |
jjg@1455 | 257 | List<File> javacBootClassPath; |
jjg@1455 | 258 | List<File> javacClassPath; |
jjg@1455 | 259 | List<File> javacSourcePath; |
jjg@1455 | 260 | List<String> javacOpts; |
jjg@1455 | 261 | List<File> javacFiles; |
jjg@1455 | 262 | boolean needHelp = false; |
jjg@1455 | 263 | |
jjg@1455 | 264 | // </editor-fold> |
jjg@1455 | 265 | |
jjg@1455 | 266 | // <editor-fold defaultstate="collapsed" desc="javac Plugin"> |
jjg@1455 | 267 | |
jjg@1455 | 268 | @Override |
jjg@1455 | 269 | public String getName() { |
jjg@1455 | 270 | return "doclint"; |
jjg@1455 | 271 | } |
jjg@1455 | 272 | |
jjg@1455 | 273 | @Override |
mchung@1458 | 274 | public void init(JavacTask task, String... args) { |
jjg@1455 | 275 | init(task, args, true); |
jjg@1455 | 276 | } |
jjg@1455 | 277 | |
jjg@1455 | 278 | // </editor-fold> |
jjg@1455 | 279 | |
jjg@1455 | 280 | // <editor-fold defaultstate="collapsed" desc="Embedding API"> |
jjg@1455 | 281 | |
jjg@1455 | 282 | public void init(JavacTask task, String[] args, boolean addTaskListener) { |
jjg@1455 | 283 | env = new Env(); |
jjg@1455 | 284 | for (int i = 0; i < args.length; i++) { |
jjg@1455 | 285 | String arg = args[i]; |
jjg@1455 | 286 | if (arg.equals(XMSGS_OPTION)) { |
jjg@1455 | 287 | env.messages.setOptions(null); |
jjg@1455 | 288 | } else if (arg.startsWith(XMSGS_CUSTOM_PREFIX)) { |
jjg@1455 | 289 | env.messages.setOptions(arg.substring(arg.indexOf(":") + 1)); |
jjg@1455 | 290 | } else |
jjg@1455 | 291 | throw new IllegalArgumentException(arg); |
jjg@1455 | 292 | } |
jjg@1455 | 293 | env.init(task); |
jjg@1455 | 294 | |
jjg@1455 | 295 | checker = new Checker(env); |
jjg@1455 | 296 | |
jjg@1455 | 297 | if (addTaskListener) { |
jjg@1455 | 298 | final DeclScanner ds = new DeclScanner() { |
jjg@1455 | 299 | @Override |
jjg@1455 | 300 | void visitDecl(Tree tree, Name name) { |
jjg@1455 | 301 | TreePath p = getCurrentPath(); |
jjg@1455 | 302 | DocCommentTree dc = env.trees.getDocCommentTree(p); |
jjg@1455 | 303 | |
jjg@1455 | 304 | checker.scan(dc, p); |
jjg@1455 | 305 | } |
jjg@1455 | 306 | }; |
jjg@1455 | 307 | |
jjg@1455 | 308 | TaskListener tl = new TaskListener() { |
jjg@1455 | 309 | @Override |
jjg@1455 | 310 | public void started(TaskEvent e) { |
jjg@1455 | 311 | return; |
jjg@1455 | 312 | } |
jjg@1455 | 313 | |
jjg@1455 | 314 | @Override |
jjg@1455 | 315 | public void finished(TaskEvent e) { |
jjg@1455 | 316 | switch (e.getKind()) { |
jjg@1455 | 317 | case ENTER: |
jjg@1455 | 318 | ds.scan(e.getCompilationUnit(), null); |
jjg@1455 | 319 | } |
jjg@1455 | 320 | } |
jjg@1455 | 321 | }; |
jjg@1455 | 322 | |
jjg@1455 | 323 | task.addTaskListener(tl); |
jjg@1455 | 324 | } |
jjg@1455 | 325 | } |
jjg@1455 | 326 | |
jjg@1455 | 327 | public void scan(TreePath p) { |
jjg@1455 | 328 | DocCommentTree dc = env.trees.getDocCommentTree(p); |
jjg@1455 | 329 | checker.scan(dc, p); |
jjg@1455 | 330 | } |
jjg@1455 | 331 | |
jjg@1455 | 332 | public void reportStats(PrintWriter out) { |
jjg@1455 | 333 | env.messages.reportStats(out); |
jjg@1455 | 334 | } |
jjg@1455 | 335 | |
jjg@1455 | 336 | // </editor-fold> |
jjg@1455 | 337 | |
jjg@1455 | 338 | Env env; |
jjg@1455 | 339 | Checker checker; |
jjg@1455 | 340 | |
jjg@1455 | 341 | public static boolean isValidOption(String opt) { |
jjg@1455 | 342 | if (opt.equals(XMSGS_OPTION)) |
jjg@1455 | 343 | return true; |
jjg@1455 | 344 | if (opt.startsWith(XMSGS_CUSTOM_PREFIX)) |
jjg@1455 | 345 | return Messages.Options.isValidOptions(opt.substring(XMSGS_CUSTOM_PREFIX.length())); |
jjg@1455 | 346 | return false; |
jjg@1455 | 347 | } |
jjg@1455 | 348 | |
jjg@1455 | 349 | // <editor-fold defaultstate="collapsed" desc="DeclScanner"> |
jjg@1455 | 350 | |
jjg@1455 | 351 | static abstract class DeclScanner extends TreePathScanner<Void, Void> { |
jjg@1455 | 352 | abstract void visitDecl(Tree tree, Name name); |
jjg@1455 | 353 | |
jjg@1455 | 354 | @Override |
jjg@1455 | 355 | public Void visitClass(ClassTree tree, Void ignore) { |
jjg@1455 | 356 | visitDecl(tree, tree.getSimpleName()); |
jjg@1455 | 357 | return super.visitClass(tree, ignore); |
jjg@1455 | 358 | } |
jjg@1455 | 359 | |
jjg@1455 | 360 | @Override |
jjg@1455 | 361 | public Void visitMethod(MethodTree tree, Void ignore) { |
jjg@1455 | 362 | visitDecl(tree, tree.getName()); |
jjg@1455 | 363 | //return super.visitMethod(tree, ignore); |
jjg@1455 | 364 | return null; |
jjg@1455 | 365 | } |
jjg@1455 | 366 | |
jjg@1455 | 367 | @Override |
jjg@1455 | 368 | public Void visitVariable(VariableTree tree, Void ignore) { |
jjg@1455 | 369 | visitDecl(tree, tree.getName()); |
jjg@1455 | 370 | return super.visitVariable(tree, ignore); |
jjg@1455 | 371 | } |
jjg@1455 | 372 | } |
jjg@1455 | 373 | |
jjg@1455 | 374 | // </editor-fold> |
jjg@1455 | 375 | |
jjg@1455 | 376 | } |