Mon, 03 Jun 2013 17:09:26 -0700
8006615: [doclint] move remaining messages into resource bundle
Reviewed-by: mcimadamore, vromero
jjg@1455 | 1 | /* |
jjg@1506 | 2 | * Copyright (c) 2012, 2013, 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@1668 | 33 | import java.util.regex.Pattern; |
jjg@1455 | 34 | |
jjg@1455 | 35 | import javax.lang.model.element.Name; |
jjg@1455 | 36 | import javax.tools.StandardLocation; |
jjg@1455 | 37 | |
jjg@1455 | 38 | import com.sun.source.doctree.DocCommentTree; |
jjg@1455 | 39 | import com.sun.source.tree.ClassTree; |
jjg@1455 | 40 | import com.sun.source.tree.CompilationUnitTree; |
jjg@1455 | 41 | import com.sun.source.tree.MethodTree; |
jjg@1455 | 42 | import com.sun.source.tree.Tree; |
jjg@1455 | 43 | import com.sun.source.tree.VariableTree; |
jjg@1455 | 44 | import com.sun.source.util.JavacTask; |
jjg@1455 | 45 | import com.sun.source.util.Plugin; |
jjg@1455 | 46 | import com.sun.source.util.TaskEvent; |
jjg@1455 | 47 | import com.sun.source.util.TaskListener; |
jjg@1455 | 48 | import com.sun.source.util.TreePath; |
jjg@1455 | 49 | import com.sun.source.util.TreePathScanner; |
jjg@1455 | 50 | import com.sun.tools.javac.api.JavacTaskImpl; |
jjg@1455 | 51 | import com.sun.tools.javac.api.JavacTool; |
jjg@1455 | 52 | import com.sun.tools.javac.file.JavacFileManager; |
jjg@1455 | 53 | import com.sun.tools.javac.main.JavaCompiler; |
jjg@1455 | 54 | import com.sun.tools.javac.util.Context; |
jjg@1455 | 55 | |
jjg@1455 | 56 | /** |
jjg@1455 | 57 | * Multi-function entry point for the doc check utility. |
jjg@1455 | 58 | * |
jjg@1455 | 59 | * This class can be invoked in the following ways: |
jjg@1455 | 60 | * <ul> |
jjg@1455 | 61 | * <li>From the command line |
jjg@1455 | 62 | * <li>From javac, as a plugin |
jjg@1455 | 63 | * <li>Directly, via a simple API |
jjg@1455 | 64 | * </ul> |
jjg@1455 | 65 | * |
jjg@1455 | 66 | * <p><b>This is NOT part of any supported API. |
jjg@1455 | 67 | * If you write code that depends on this, you do so at your own |
jjg@1455 | 68 | * risk. This code and its internal interfaces are subject to change |
jjg@1455 | 69 | * or deletion without notice.</b></p> |
jjg@1455 | 70 | */ |
jjg@1455 | 71 | public class DocLint implements Plugin { |
jjg@1455 | 72 | |
jjg@1455 | 73 | public static final String XMSGS_OPTION = "-Xmsgs"; |
jjg@1455 | 74 | public static final String XMSGS_CUSTOM_PREFIX = "-Xmsgs:"; |
jjg@1455 | 75 | private static final String STATS = "-stats"; |
jjg@1668 | 76 | public static final String XIMPLICIT_HEADERS = "-XimplicitHeaders:"; |
jjg@1455 | 77 | |
jjg@1455 | 78 | // <editor-fold defaultstate="collapsed" desc="Command-line entry point"> |
jjg@1455 | 79 | public static void main(String... args) { |
jjg@1796 | 80 | DocLint dl = new DocLint(); |
jjg@1455 | 81 | try { |
jjg@1796 | 82 | dl.run(args); |
jjg@1455 | 83 | } catch (BadArgs e) { |
jjg@1455 | 84 | System.err.println(e.getMessage()); |
jjg@1455 | 85 | System.exit(1); |
jjg@1455 | 86 | } catch (IOException e) { |
jjg@1796 | 87 | System.err.println(dl.localize("dc.main.ioerror", e.getLocalizedMessage())); |
jjg@1455 | 88 | System.exit(2); |
jjg@1455 | 89 | } |
jjg@1455 | 90 | } |
jjg@1455 | 91 | |
jjg@1455 | 92 | // </editor-fold> |
jjg@1455 | 93 | |
jjg@1455 | 94 | // <editor-fold defaultstate="collapsed" desc="Simple API"> |
jjg@1455 | 95 | |
jjg@1796 | 96 | public class BadArgs extends Exception { |
jjg@1455 | 97 | private static final long serialVersionUID = 0; |
jjg@1455 | 98 | BadArgs(String code, Object... args) { |
jjg@1796 | 99 | super(localize(code, args)); |
jjg@1455 | 100 | this.code = code; |
jjg@1455 | 101 | this.args = args; |
jjg@1455 | 102 | } |
jjg@1455 | 103 | |
jjg@1455 | 104 | final String code; |
jjg@1455 | 105 | final Object[] args; |
jjg@1455 | 106 | } |
jjg@1455 | 107 | |
jjg@1455 | 108 | /** |
jjg@1455 | 109 | * Simple API entry point. |
jjg@1455 | 110 | */ |
jjg@1455 | 111 | public void run(String... args) throws BadArgs, IOException { |
jjg@1455 | 112 | PrintWriter out = new PrintWriter(System.out); |
jjg@1455 | 113 | try { |
jjg@1455 | 114 | run(out, args); |
jjg@1455 | 115 | } finally { |
jjg@1455 | 116 | out.flush(); |
jjg@1455 | 117 | } |
jjg@1455 | 118 | } |
jjg@1455 | 119 | |
jjg@1455 | 120 | public void run(PrintWriter out, String... args) throws BadArgs, IOException { |
jjg@1455 | 121 | env = new Env(); |
jjg@1455 | 122 | processArgs(args); |
jjg@1455 | 123 | |
jjg@1455 | 124 | if (needHelp) |
jjg@1455 | 125 | showHelp(out); |
jjg@1455 | 126 | |
jjg@1455 | 127 | if (javacFiles.isEmpty()) { |
jjg@1455 | 128 | if (!needHelp) |
jjg@1796 | 129 | out.println(localize("dc.main.no.files.given")); |
jjg@1455 | 130 | } |
jjg@1455 | 131 | |
jjg@1455 | 132 | JavacTool tool = JavacTool.create(); |
jjg@1455 | 133 | |
jjg@1455 | 134 | JavacFileManager fm = new JavacFileManager(new Context(), false, null); |
jjg@1455 | 135 | fm.setSymbolFileEnabled(false); |
jjg@1455 | 136 | fm.setLocation(StandardLocation.PLATFORM_CLASS_PATH, javacBootClassPath); |
jjg@1455 | 137 | fm.setLocation(StandardLocation.CLASS_PATH, javacClassPath); |
jjg@1455 | 138 | fm.setLocation(StandardLocation.SOURCE_PATH, javacSourcePath); |
jjg@1455 | 139 | |
jjg@1455 | 140 | JavacTask task = tool.getTask(out, fm, null, javacOpts, null, |
jjg@1455 | 141 | fm.getJavaFileObjectsFromFiles(javacFiles)); |
jjg@1455 | 142 | Iterable<? extends CompilationUnitTree> units = task.parse(); |
jjg@1455 | 143 | ((JavacTaskImpl) task).enter(); |
jjg@1455 | 144 | |
jjg@1455 | 145 | env.init(task); |
jjg@1455 | 146 | checker = new Checker(env); |
jjg@1455 | 147 | |
jjg@1455 | 148 | DeclScanner ds = new DeclScanner() { |
jjg@1455 | 149 | @Override |
jjg@1455 | 150 | void visitDecl(Tree tree, Name name) { |
jjg@1455 | 151 | TreePath p = getCurrentPath(); |
jjg@1455 | 152 | DocCommentTree dc = env.trees.getDocCommentTree(p); |
jjg@1455 | 153 | |
jjg@1455 | 154 | checker.scan(dc, p); |
jjg@1455 | 155 | } |
jjg@1455 | 156 | }; |
jjg@1455 | 157 | |
jjg@1455 | 158 | ds.scan(units, null); |
jjg@1455 | 159 | |
jjg@1455 | 160 | reportStats(out); |
jjg@1455 | 161 | |
jjg@1455 | 162 | Context ctx = ((JavacTaskImpl) task).getContext(); |
jjg@1455 | 163 | JavaCompiler c = JavaCompiler.instance(ctx); |
jjg@1455 | 164 | c.printCount("error", c.errorCount()); |
jjg@1455 | 165 | c.printCount("warn", c.warningCount()); |
jjg@1455 | 166 | } |
jjg@1455 | 167 | |
jjg@1455 | 168 | void processArgs(String... args) throws BadArgs { |
jjg@1455 | 169 | javacOpts = new ArrayList<String>(); |
jjg@1455 | 170 | javacFiles = new ArrayList<File>(); |
jjg@1455 | 171 | |
jjg@1455 | 172 | if (args.length == 0) |
jjg@1455 | 173 | needHelp = true; |
jjg@1455 | 174 | |
jjg@1455 | 175 | for (int i = 0; i < args.length; i++) { |
jjg@1455 | 176 | String arg = args[i]; |
jjg@1455 | 177 | if (arg.matches("-Xmax(errs|warns)") && i + 1 < args.length) { |
jjg@1455 | 178 | if (args[++i].matches("[0-9]+")) { |
jjg@1455 | 179 | javacOpts.add(arg); |
jjg@1455 | 180 | javacOpts.add(args[i]); |
jjg@1455 | 181 | } else { |
jjg@1455 | 182 | throw new BadArgs("dc.bad.value.for.option", arg, args[i]); |
jjg@1455 | 183 | } |
jjg@1455 | 184 | } else if (arg.equals(STATS)) { |
jjg@1455 | 185 | env.messages.setStatsEnabled(true); |
jjg@1506 | 186 | } else if (arg.equals("-bootclasspath") && i + 1 < args.length) { |
jjg@1455 | 187 | javacBootClassPath = splitPath(args[++i]); |
jjg@1506 | 188 | } else if (arg.equals("-classpath") && i + 1 < args.length) { |
jjg@1455 | 189 | javacClassPath = splitPath(args[++i]); |
jjg@1506 | 190 | } else if (arg.equals("-sourcepath") && i + 1 < args.length) { |
jjg@1455 | 191 | javacSourcePath = splitPath(args[++i]); |
jjg@1455 | 192 | } else if (arg.equals(XMSGS_OPTION)) { |
jjg@1455 | 193 | env.messages.setOptions(null); |
jjg@1455 | 194 | } else if (arg.startsWith(XMSGS_CUSTOM_PREFIX)) { |
jjg@1455 | 195 | env.messages.setOptions(arg.substring(arg.indexOf(":") + 1)); |
jjg@1455 | 196 | } else if (arg.equals("-h") || arg.equals("-help") || arg.equals("--help") |
jjg@1455 | 197 | || arg.equals("-?") || arg.equals("-usage")) { |
jjg@1455 | 198 | needHelp = true; |
jjg@1455 | 199 | } else if (arg.startsWith("-")) { |
jjg@1455 | 200 | throw new BadArgs("dc.bad.option", arg); |
jjg@1455 | 201 | } else { |
jjg@1455 | 202 | while (i < args.length) |
jjg@1455 | 203 | javacFiles.add(new File(args[i++])); |
jjg@1455 | 204 | } |
jjg@1455 | 205 | } |
jjg@1455 | 206 | } |
jjg@1455 | 207 | |
jjg@1455 | 208 | void showHelp(PrintWriter out) { |
jjg@1796 | 209 | String msg = localize("dc.main.usage"); |
jjg@1796 | 210 | for (String line: msg.split("\n")) |
jjg@1796 | 211 | out.println(line); |
jjg@1455 | 212 | } |
jjg@1455 | 213 | |
jjg@1455 | 214 | List<File> splitPath(String path) { |
jjg@1455 | 215 | List<File> files = new ArrayList<File>(); |
jjg@1506 | 216 | for (String f: path.split(File.pathSeparator)) { |
jjg@1455 | 217 | if (f.length() > 0) |
jjg@1455 | 218 | files.add(new File(f)); |
jjg@1455 | 219 | } |
jjg@1455 | 220 | return files; |
jjg@1455 | 221 | } |
jjg@1455 | 222 | |
jjg@1455 | 223 | List<File> javacBootClassPath; |
jjg@1455 | 224 | List<File> javacClassPath; |
jjg@1455 | 225 | List<File> javacSourcePath; |
jjg@1455 | 226 | List<String> javacOpts; |
jjg@1455 | 227 | List<File> javacFiles; |
jjg@1455 | 228 | boolean needHelp = false; |
jjg@1455 | 229 | |
jjg@1455 | 230 | // </editor-fold> |
jjg@1455 | 231 | |
jjg@1455 | 232 | // <editor-fold defaultstate="collapsed" desc="javac Plugin"> |
jjg@1455 | 233 | |
jjg@1455 | 234 | @Override |
jjg@1455 | 235 | public String getName() { |
jjg@1455 | 236 | return "doclint"; |
jjg@1455 | 237 | } |
jjg@1455 | 238 | |
jjg@1455 | 239 | @Override |
mchung@1458 | 240 | public void init(JavacTask task, String... args) { |
jjg@1455 | 241 | init(task, args, true); |
jjg@1455 | 242 | } |
jjg@1455 | 243 | |
jjg@1455 | 244 | // </editor-fold> |
jjg@1455 | 245 | |
jjg@1455 | 246 | // <editor-fold defaultstate="collapsed" desc="Embedding API"> |
jjg@1455 | 247 | |
jjg@1455 | 248 | public void init(JavacTask task, String[] args, boolean addTaskListener) { |
jjg@1455 | 249 | env = new Env(); |
jjg@1455 | 250 | for (int i = 0; i < args.length; i++) { |
jjg@1455 | 251 | String arg = args[i]; |
jjg@1455 | 252 | if (arg.equals(XMSGS_OPTION)) { |
jjg@1455 | 253 | env.messages.setOptions(null); |
jjg@1455 | 254 | } else if (arg.startsWith(XMSGS_CUSTOM_PREFIX)) { |
jjg@1455 | 255 | env.messages.setOptions(arg.substring(arg.indexOf(":") + 1)); |
jjg@1668 | 256 | } else if (arg.matches(XIMPLICIT_HEADERS + "[1-6]")) { |
jjg@1668 | 257 | char ch = arg.charAt(arg.length() - 1); |
jjg@1668 | 258 | env.setImplicitHeaders(Character.digit(ch, 10)); |
jjg@1455 | 259 | } else |
jjg@1455 | 260 | throw new IllegalArgumentException(arg); |
jjg@1455 | 261 | } |
jjg@1455 | 262 | env.init(task); |
jjg@1455 | 263 | |
jjg@1455 | 264 | checker = new Checker(env); |
jjg@1455 | 265 | |
jjg@1455 | 266 | if (addTaskListener) { |
jjg@1455 | 267 | final DeclScanner ds = new DeclScanner() { |
jjg@1455 | 268 | @Override |
jjg@1455 | 269 | void visitDecl(Tree tree, Name name) { |
jjg@1455 | 270 | TreePath p = getCurrentPath(); |
jjg@1455 | 271 | DocCommentTree dc = env.trees.getDocCommentTree(p); |
jjg@1455 | 272 | |
jjg@1455 | 273 | checker.scan(dc, p); |
jjg@1455 | 274 | } |
jjg@1455 | 275 | }; |
jjg@1455 | 276 | |
jjg@1455 | 277 | TaskListener tl = new TaskListener() { |
jjg@1455 | 278 | @Override |
jjg@1455 | 279 | public void started(TaskEvent e) { |
jjg@1455 | 280 | return; |
jjg@1455 | 281 | } |
jjg@1455 | 282 | |
jjg@1455 | 283 | @Override |
jjg@1455 | 284 | public void finished(TaskEvent e) { |
jjg@1455 | 285 | switch (e.getKind()) { |
jjg@1455 | 286 | case ENTER: |
jjg@1455 | 287 | ds.scan(e.getCompilationUnit(), null); |
jjg@1455 | 288 | } |
jjg@1455 | 289 | } |
jjg@1455 | 290 | }; |
jjg@1455 | 291 | |
jjg@1455 | 292 | task.addTaskListener(tl); |
jjg@1455 | 293 | } |
jjg@1455 | 294 | } |
jjg@1455 | 295 | |
jjg@1455 | 296 | public void scan(TreePath p) { |
jjg@1455 | 297 | DocCommentTree dc = env.trees.getDocCommentTree(p); |
jjg@1455 | 298 | checker.scan(dc, p); |
jjg@1455 | 299 | } |
jjg@1455 | 300 | |
jjg@1455 | 301 | public void reportStats(PrintWriter out) { |
jjg@1455 | 302 | env.messages.reportStats(out); |
jjg@1455 | 303 | } |
jjg@1455 | 304 | |
jjg@1455 | 305 | // </editor-fold> |
jjg@1455 | 306 | |
jjg@1455 | 307 | Env env; |
jjg@1455 | 308 | Checker checker; |
jjg@1455 | 309 | |
jjg@1455 | 310 | public static boolean isValidOption(String opt) { |
jjg@1455 | 311 | if (opt.equals(XMSGS_OPTION)) |
jjg@1455 | 312 | return true; |
jjg@1455 | 313 | if (opt.startsWith(XMSGS_CUSTOM_PREFIX)) |
jjg@1455 | 314 | return Messages.Options.isValidOptions(opt.substring(XMSGS_CUSTOM_PREFIX.length())); |
jjg@1455 | 315 | return false; |
jjg@1455 | 316 | } |
jjg@1455 | 317 | |
jjg@1796 | 318 | private String localize(String code, Object... args) { |
jjg@1796 | 319 | Messages m = (env != null) ? env.messages : new Messages(null); |
jjg@1796 | 320 | return m.localize(code, args); |
jjg@1796 | 321 | } |
jjg@1796 | 322 | |
jjg@1455 | 323 | // <editor-fold defaultstate="collapsed" desc="DeclScanner"> |
jjg@1455 | 324 | |
jjg@1455 | 325 | static abstract class DeclScanner extends TreePathScanner<Void, Void> { |
jjg@1455 | 326 | abstract void visitDecl(Tree tree, Name name); |
jjg@1455 | 327 | |
jjg@1455 | 328 | @Override |
jjg@1455 | 329 | public Void visitClass(ClassTree tree, Void ignore) { |
jjg@1455 | 330 | visitDecl(tree, tree.getSimpleName()); |
jjg@1455 | 331 | return super.visitClass(tree, ignore); |
jjg@1455 | 332 | } |
jjg@1455 | 333 | |
jjg@1455 | 334 | @Override |
jjg@1455 | 335 | public Void visitMethod(MethodTree tree, Void ignore) { |
jjg@1455 | 336 | visitDecl(tree, tree.getName()); |
jjg@1455 | 337 | //return super.visitMethod(tree, ignore); |
jjg@1455 | 338 | return null; |
jjg@1455 | 339 | } |
jjg@1455 | 340 | |
jjg@1455 | 341 | @Override |
jjg@1455 | 342 | public Void visitVariable(VariableTree tree, Void ignore) { |
jjg@1455 | 343 | visitDecl(tree, tree.getName()); |
jjg@1455 | 344 | return super.visitVariable(tree, ignore); |
jjg@1455 | 345 | } |
jjg@1455 | 346 | } |
jjg@1455 | 347 | |
jjg@1455 | 348 | // </editor-fold> |
jjg@1455 | 349 | |
jjg@1455 | 350 | } |