Tue, 09 Oct 2012 19:10:00 -0700
8000663: clean up langtools imports
Reviewed-by: darcy
duke@1 | 1 | /* |
jjg@1357 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.javadoc; |
duke@1 | 27 | |
jjg@1357 | 28 | import java.io.PrintWriter; // Access to 'javac' output streams |
duke@1 | 29 | import java.text.MessageFormat; |
jjg@1357 | 30 | import java.util.MissingResourceException; |
duke@1 | 31 | import java.util.ResourceBundle; |
duke@1 | 32 | |
duke@1 | 33 | import com.sun.javadoc.*; |
duke@1 | 34 | import com.sun.tools.javac.util.Context; |
jjg@1357 | 35 | import com.sun.tools.javac.util.Log; |
duke@1 | 36 | |
duke@1 | 37 | /** |
duke@1 | 38 | * Utility for integrating with javadoc tools and for localization. |
duke@1 | 39 | * Handle Resources. Access to error and warning counts. |
duke@1 | 40 | * Message formatting. |
duke@1 | 41 | * <br> |
duke@1 | 42 | * Also provides implementation for DocErrorReporter. |
duke@1 | 43 | * |
duke@1 | 44 | * @see java.util.ResourceBundle |
duke@1 | 45 | * @see java.text.MessageFormat |
duke@1 | 46 | * @author Neal Gafter (rewrite) |
duke@1 | 47 | */ |
duke@1 | 48 | public class Messager extends Log implements DocErrorReporter { |
duke@1 | 49 | |
duke@1 | 50 | /** Get the current messager, which is also the compiler log. */ |
duke@1 | 51 | public static Messager instance0(Context context) { |
duke@1 | 52 | Log instance = context.get(logKey); |
duke@1 | 53 | if (instance == null || !(instance instanceof Messager)) |
duke@1 | 54 | throw new InternalError("no messager instance!"); |
duke@1 | 55 | return (Messager)instance; |
duke@1 | 56 | } |
duke@1 | 57 | |
jjg@893 | 58 | public static void preRegister(Context context, |
duke@1 | 59 | final String programName) { |
duke@1 | 60 | context.put(logKey, new Context.Factory<Log>() { |
jjg@893 | 61 | public Log make(Context c) { |
jjg@893 | 62 | return new Messager(c, |
duke@1 | 63 | programName); |
duke@1 | 64 | } |
duke@1 | 65 | }); |
duke@1 | 66 | } |
jjg@893 | 67 | public static void preRegister(Context context, |
duke@1 | 68 | final String programName, |
duke@1 | 69 | final PrintWriter errWriter, |
duke@1 | 70 | final PrintWriter warnWriter, |
duke@1 | 71 | final PrintWriter noticeWriter) { |
duke@1 | 72 | context.put(logKey, new Context.Factory<Log>() { |
jjg@893 | 73 | public Log make(Context c) { |
jjg@893 | 74 | return new Messager(c, |
duke@1 | 75 | programName, |
duke@1 | 76 | errWriter, |
duke@1 | 77 | warnWriter, |
duke@1 | 78 | noticeWriter); |
duke@1 | 79 | } |
duke@1 | 80 | }); |
duke@1 | 81 | } |
duke@1 | 82 | |
duke@1 | 83 | public class ExitJavadoc extends Error { |
duke@1 | 84 | private static final long serialVersionUID = 0; |
duke@1 | 85 | } |
duke@1 | 86 | |
jjg@584 | 87 | final String programName; |
duke@1 | 88 | |
duke@1 | 89 | private ResourceBundle messageRB = null; |
duke@1 | 90 | |
duke@1 | 91 | /** The default writer for diagnostics |
duke@1 | 92 | */ |
duke@1 | 93 | static final PrintWriter defaultErrWriter = new PrintWriter(System.err); |
duke@1 | 94 | static final PrintWriter defaultWarnWriter = new PrintWriter(System.err); |
duke@1 | 95 | static final PrintWriter defaultNoticeWriter = new PrintWriter(System.out); |
duke@1 | 96 | |
duke@1 | 97 | /** |
duke@1 | 98 | * Constructor |
duke@1 | 99 | * @param programName Name of the program (for error messages). |
duke@1 | 100 | */ |
duke@1 | 101 | protected Messager(Context context, String programName) { |
duke@1 | 102 | this(context, programName, defaultErrWriter, defaultWarnWriter, defaultNoticeWriter); |
duke@1 | 103 | } |
duke@1 | 104 | |
duke@1 | 105 | /** |
duke@1 | 106 | * Constructor |
duke@1 | 107 | * @param programName Name of the program (for error messages). |
duke@1 | 108 | * @param errWriter Stream for error messages |
duke@1 | 109 | * @param warnWriter Stream for warnings |
duke@1 | 110 | * @param noticeWriter Stream for other messages |
duke@1 | 111 | */ |
jjg@198 | 112 | @SuppressWarnings("deprecation") |
duke@1 | 113 | protected Messager(Context context, |
duke@1 | 114 | String programName, |
duke@1 | 115 | PrintWriter errWriter, |
duke@1 | 116 | PrintWriter warnWriter, |
duke@1 | 117 | PrintWriter noticeWriter) { |
duke@1 | 118 | super(context, errWriter, warnWriter, noticeWriter); |
duke@1 | 119 | this.programName = programName; |
duke@1 | 120 | } |
duke@1 | 121 | |
jjg@584 | 122 | @Override |
jjg@584 | 123 | protected int getDefaultMaxErrors() { |
jjg@584 | 124 | return Integer.MAX_VALUE; |
jjg@584 | 125 | } |
jjg@584 | 126 | |
jjg@584 | 127 | @Override |
jjg@584 | 128 | protected int getDefaultMaxWarnings() { |
jjg@584 | 129 | return Integer.MAX_VALUE; |
jjg@584 | 130 | } |
jjg@584 | 131 | |
duke@1 | 132 | /** |
duke@1 | 133 | * Reset resource bundle, eg. locale has changed. |
duke@1 | 134 | */ |
duke@1 | 135 | public void reset() { |
duke@1 | 136 | messageRB = null; |
duke@1 | 137 | } |
duke@1 | 138 | |
duke@1 | 139 | /** |
duke@1 | 140 | * Get string from ResourceBundle, initialize ResourceBundle |
duke@1 | 141 | * if needed. |
duke@1 | 142 | */ |
duke@1 | 143 | private String getString(String key) { |
duke@1 | 144 | if (messageRB == null) { |
duke@1 | 145 | try { |
jjg@912 | 146 | messageRB = ResourceBundle.getBundle( |
duke@1 | 147 | "com.sun.tools.javadoc.resources.javadoc"); |
duke@1 | 148 | } catch (MissingResourceException e) { |
duke@1 | 149 | throw new Error("Fatal: Resource for javadoc is missing"); |
duke@1 | 150 | } |
duke@1 | 151 | } |
duke@1 | 152 | return messageRB.getString(key); |
duke@1 | 153 | } |
duke@1 | 154 | |
duke@1 | 155 | /** |
duke@1 | 156 | * get and format message string from resource |
duke@1 | 157 | * |
duke@1 | 158 | * @param key selects message from resource |
duke@1 | 159 | */ |
duke@1 | 160 | String getText(String key) { |
duke@1 | 161 | return getText(key, (String)null); |
duke@1 | 162 | } |
duke@1 | 163 | |
duke@1 | 164 | /** |
duke@1 | 165 | * get and format message string from resource |
duke@1 | 166 | * |
duke@1 | 167 | * @param key selects message from resource |
duke@1 | 168 | * @param a1 first argument |
duke@1 | 169 | */ |
duke@1 | 170 | String getText(String key, String a1) { |
duke@1 | 171 | return getText(key, a1, null); |
duke@1 | 172 | } |
duke@1 | 173 | |
duke@1 | 174 | /** |
duke@1 | 175 | * get and format message string from resource |
duke@1 | 176 | * |
duke@1 | 177 | * @param key selects message from resource |
duke@1 | 178 | * @param a1 first argument |
duke@1 | 179 | * @param a2 second argument |
duke@1 | 180 | */ |
duke@1 | 181 | String getText(String key, String a1, String a2) { |
duke@1 | 182 | return getText(key, a1, a2, null); |
duke@1 | 183 | } |
duke@1 | 184 | |
duke@1 | 185 | /** |
duke@1 | 186 | * get and format message string from resource |
duke@1 | 187 | * |
duke@1 | 188 | * @param key selects message from resource |
duke@1 | 189 | * @param a1 first argument |
duke@1 | 190 | * @param a2 second argument |
duke@1 | 191 | * @param a3 third argument |
duke@1 | 192 | */ |
duke@1 | 193 | String getText(String key, String a1, String a2, String a3) { |
duke@1 | 194 | return getText(key, a1, a2, a3, null); |
duke@1 | 195 | } |
duke@1 | 196 | |
duke@1 | 197 | /** |
duke@1 | 198 | * get and format message string from resource |
duke@1 | 199 | * |
duke@1 | 200 | * @param key selects message from resource |
duke@1 | 201 | * @param a1 first argument |
duke@1 | 202 | * @param a2 second argument |
duke@1 | 203 | * @param a3 third argument |
duke@1 | 204 | * @param a4 fourth argument |
duke@1 | 205 | */ |
duke@1 | 206 | String getText(String key, String a1, String a2, String a3, |
duke@1 | 207 | String a4) { |
duke@1 | 208 | try { |
duke@1 | 209 | String message = getString(key); |
duke@1 | 210 | String[] args = new String[4]; |
duke@1 | 211 | args[0] = a1; |
duke@1 | 212 | args[1] = a2; |
duke@1 | 213 | args[2] = a3; |
duke@1 | 214 | args[3] = a4; |
duke@1 | 215 | return MessageFormat.format(message, (Object[])args); |
duke@1 | 216 | } catch (MissingResourceException e) { |
duke@1 | 217 | return "********** Resource for javadoc is broken. There is no " + |
duke@1 | 218 | key + " key in resource."; |
duke@1 | 219 | } |
duke@1 | 220 | } |
duke@1 | 221 | |
duke@1 | 222 | /** |
duke@1 | 223 | * Print error message, increment error count. |
duke@1 | 224 | * Part of DocErrorReporter. |
duke@1 | 225 | * |
duke@1 | 226 | * @param msg message to print |
duke@1 | 227 | */ |
duke@1 | 228 | public void printError(String msg) { |
duke@1 | 229 | printError(null, msg); |
duke@1 | 230 | } |
duke@1 | 231 | |
duke@1 | 232 | /** |
duke@1 | 233 | * Print error message, increment error count. |
duke@1 | 234 | * Part of DocErrorReporter. |
duke@1 | 235 | * |
duke@1 | 236 | * @param pos the position where the error occurs |
duke@1 | 237 | * @param msg message to print |
duke@1 | 238 | */ |
duke@1 | 239 | public void printError(SourcePosition pos, String msg) { |
jjg@584 | 240 | if (nerrors < MaxErrors) { |
jjg@584 | 241 | String prefix = (pos == null) ? programName : pos.toString(); |
jjg@584 | 242 | errWriter.println(prefix + ": " + getText("javadoc.error") + " - " + msg); |
jjg@584 | 243 | errWriter.flush(); |
jjg@584 | 244 | prompt(); |
jjg@584 | 245 | nerrors++; |
jjg@584 | 246 | } |
duke@1 | 247 | } |
duke@1 | 248 | |
duke@1 | 249 | /** |
duke@1 | 250 | * Print warning message, increment warning count. |
duke@1 | 251 | * Part of DocErrorReporter. |
duke@1 | 252 | * |
duke@1 | 253 | * @param msg message to print |
duke@1 | 254 | */ |
duke@1 | 255 | public void printWarning(String msg) { |
duke@1 | 256 | printWarning(null, msg); |
duke@1 | 257 | } |
duke@1 | 258 | |
duke@1 | 259 | /** |
duke@1 | 260 | * Print warning message, increment warning count. |
duke@1 | 261 | * Part of DocErrorReporter. |
duke@1 | 262 | * |
duke@1 | 263 | * @param pos the position where the error occurs |
duke@1 | 264 | * @param msg message to print |
duke@1 | 265 | */ |
duke@1 | 266 | public void printWarning(SourcePosition pos, String msg) { |
jjg@584 | 267 | if (nwarnings < MaxWarnings) { |
jjg@584 | 268 | String prefix = (pos == null) ? programName : pos.toString(); |
jjg@584 | 269 | warnWriter.println(prefix + ": " + getText("javadoc.warning") +" - " + msg); |
jjg@584 | 270 | warnWriter.flush(); |
jjg@584 | 271 | nwarnings++; |
jjg@584 | 272 | } |
duke@1 | 273 | } |
duke@1 | 274 | |
duke@1 | 275 | /** |
duke@1 | 276 | * Print a message. |
duke@1 | 277 | * Part of DocErrorReporter. |
duke@1 | 278 | * |
duke@1 | 279 | * @param msg message to print |
duke@1 | 280 | */ |
duke@1 | 281 | public void printNotice(String msg) { |
duke@1 | 282 | printNotice(null, msg); |
duke@1 | 283 | } |
duke@1 | 284 | |
duke@1 | 285 | /** |
duke@1 | 286 | * Print a message. |
duke@1 | 287 | * Part of DocErrorReporter. |
duke@1 | 288 | * |
duke@1 | 289 | * @param pos the position where the error occurs |
duke@1 | 290 | * @param msg message to print |
duke@1 | 291 | */ |
duke@1 | 292 | public void printNotice(SourcePosition pos, String msg) { |
duke@1 | 293 | if (pos == null) |
duke@1 | 294 | noticeWriter.println(msg); |
duke@1 | 295 | else |
duke@1 | 296 | noticeWriter.println(pos + ": " + msg); |
duke@1 | 297 | noticeWriter.flush(); |
duke@1 | 298 | } |
duke@1 | 299 | |
duke@1 | 300 | /** |
duke@1 | 301 | * Print error message, increment error count. |
duke@1 | 302 | * |
duke@1 | 303 | * @param key selects message from resource |
duke@1 | 304 | */ |
duke@1 | 305 | public void error(SourcePosition pos, String key) { |
duke@1 | 306 | printError(pos, getText(key)); |
duke@1 | 307 | } |
duke@1 | 308 | |
duke@1 | 309 | /** |
duke@1 | 310 | * Print error message, increment error count. |
duke@1 | 311 | * |
duke@1 | 312 | * @param key selects message from resource |
duke@1 | 313 | * @param a1 first argument |
duke@1 | 314 | */ |
duke@1 | 315 | public void error(SourcePosition pos, String key, String a1) { |
duke@1 | 316 | printError(pos, getText(key, a1)); |
duke@1 | 317 | } |
duke@1 | 318 | |
duke@1 | 319 | /** |
duke@1 | 320 | * Print error message, increment error count. |
duke@1 | 321 | * |
duke@1 | 322 | * @param key selects message from resource |
duke@1 | 323 | * @param a1 first argument |
duke@1 | 324 | * @param a2 second argument |
duke@1 | 325 | */ |
duke@1 | 326 | public void error(SourcePosition pos, String key, String a1, String a2) { |
duke@1 | 327 | printError(pos, getText(key, a1, a2)); |
duke@1 | 328 | } |
duke@1 | 329 | |
duke@1 | 330 | /** |
duke@1 | 331 | * Print error message, increment error count. |
duke@1 | 332 | * |
duke@1 | 333 | * @param key selects message from resource |
duke@1 | 334 | * @param a1 first argument |
duke@1 | 335 | * @param a2 second argument |
duke@1 | 336 | * @param a3 third argument |
duke@1 | 337 | */ |
duke@1 | 338 | public void error(SourcePosition pos, String key, String a1, String a2, String a3) { |
duke@1 | 339 | printError(pos, getText(key, a1, a2, a3)); |
duke@1 | 340 | } |
duke@1 | 341 | |
duke@1 | 342 | /** |
duke@1 | 343 | * Print warning message, increment warning count. |
duke@1 | 344 | * |
duke@1 | 345 | * @param key selects message from resource |
duke@1 | 346 | */ |
duke@1 | 347 | public void warning(SourcePosition pos, String key) { |
duke@1 | 348 | printWarning(pos, getText(key)); |
duke@1 | 349 | } |
duke@1 | 350 | |
duke@1 | 351 | /** |
duke@1 | 352 | * Print warning message, increment warning count. |
duke@1 | 353 | * |
duke@1 | 354 | * @param key selects message from resource |
duke@1 | 355 | * @param a1 first argument |
duke@1 | 356 | */ |
duke@1 | 357 | public void warning(SourcePosition pos, String key, String a1) { |
duke@1 | 358 | printWarning(pos, getText(key, a1)); |
duke@1 | 359 | } |
duke@1 | 360 | |
duke@1 | 361 | /** |
duke@1 | 362 | * Print warning message, increment warning count. |
duke@1 | 363 | * |
duke@1 | 364 | * @param key selects message from resource |
duke@1 | 365 | * @param a1 first argument |
duke@1 | 366 | * @param a2 second argument |
duke@1 | 367 | */ |
duke@1 | 368 | public void warning(SourcePosition pos, String key, String a1, String a2) { |
duke@1 | 369 | printWarning(pos, getText(key, a1, a2)); |
duke@1 | 370 | } |
duke@1 | 371 | |
duke@1 | 372 | /** |
duke@1 | 373 | * Print warning message, increment warning count. |
duke@1 | 374 | * |
duke@1 | 375 | * @param key selects message from resource |
duke@1 | 376 | * @param a1 first argument |
duke@1 | 377 | * @param a2 second argument |
duke@1 | 378 | * @param a3 third argument |
duke@1 | 379 | */ |
duke@1 | 380 | public void warning(SourcePosition pos, String key, String a1, String a2, String a3) { |
duke@1 | 381 | printWarning(pos, getText(key, a1, a2, a3)); |
duke@1 | 382 | } |
duke@1 | 383 | |
duke@1 | 384 | /** |
duke@1 | 385 | * Print warning message, increment warning count. |
duke@1 | 386 | * |
duke@1 | 387 | * @param key selects message from resource |
duke@1 | 388 | * @param a1 first argument |
duke@1 | 389 | * @param a2 second argument |
duke@1 | 390 | * @param a3 third argument |
duke@1 | 391 | */ |
duke@1 | 392 | public void warning(SourcePosition pos, String key, String a1, String a2, String a3, |
duke@1 | 393 | String a4) { |
duke@1 | 394 | printWarning(pos, getText(key, a1, a2, a3, a4)); |
duke@1 | 395 | } |
duke@1 | 396 | |
duke@1 | 397 | /** |
duke@1 | 398 | * Print a message. |
duke@1 | 399 | * |
duke@1 | 400 | * @param key selects message from resource |
duke@1 | 401 | */ |
duke@1 | 402 | public void notice(String key) { |
duke@1 | 403 | printNotice(getText(key)); |
duke@1 | 404 | } |
duke@1 | 405 | |
duke@1 | 406 | /** |
duke@1 | 407 | * Print a message. |
duke@1 | 408 | * |
duke@1 | 409 | * @param key selects message from resource |
duke@1 | 410 | * @param a1 first argument |
duke@1 | 411 | */ |
duke@1 | 412 | public void notice(String key, String a1) { |
duke@1 | 413 | printNotice(getText(key, a1)); |
duke@1 | 414 | } |
duke@1 | 415 | |
duke@1 | 416 | /** |
duke@1 | 417 | * Print a message. |
duke@1 | 418 | * |
duke@1 | 419 | * @param key selects message from resource |
duke@1 | 420 | * @param a1 first argument |
duke@1 | 421 | * @param a2 second argument |
duke@1 | 422 | */ |
duke@1 | 423 | public void notice(String key, String a1, String a2) { |
duke@1 | 424 | printNotice(getText(key, a1, a2)); |
duke@1 | 425 | } |
duke@1 | 426 | |
duke@1 | 427 | /** |
duke@1 | 428 | * Print a message. |
duke@1 | 429 | * |
duke@1 | 430 | * @param key selects message from resource |
duke@1 | 431 | * @param a1 first argument |
duke@1 | 432 | * @param a2 second argument |
duke@1 | 433 | * @param a3 third argument |
duke@1 | 434 | */ |
duke@1 | 435 | public void notice(String key, String a1, String a2, String a3) { |
duke@1 | 436 | printNotice(getText(key, a1, a2, a3)); |
duke@1 | 437 | } |
duke@1 | 438 | |
duke@1 | 439 | /** |
duke@1 | 440 | * Return total number of errors, including those recorded |
duke@1 | 441 | * in the compilation log. |
duke@1 | 442 | */ |
duke@1 | 443 | public int nerrors() { return nerrors; } |
duke@1 | 444 | |
duke@1 | 445 | /** |
duke@1 | 446 | * Return total number of warnings, including those recorded |
duke@1 | 447 | * in the compilation log. |
duke@1 | 448 | */ |
duke@1 | 449 | public int nwarnings() { return nwarnings; } |
duke@1 | 450 | |
duke@1 | 451 | /** |
duke@1 | 452 | * Print exit message. |
duke@1 | 453 | */ |
duke@1 | 454 | public void exitNotice() { |
duke@1 | 455 | if (nerrors > 0) { |
duke@1 | 456 | notice((nerrors > 1) ? "main.errors" : "main.error", |
duke@1 | 457 | "" + nerrors); |
duke@1 | 458 | } |
duke@1 | 459 | if (nwarnings > 0) { |
duke@1 | 460 | notice((nwarnings > 1) ? "main.warnings" : "main.warning", |
duke@1 | 461 | "" + nwarnings); |
duke@1 | 462 | } |
duke@1 | 463 | } |
duke@1 | 464 | |
duke@1 | 465 | /** |
duke@1 | 466 | * Force program exit, e.g., from a fatal error. |
duke@1 | 467 | * <p> |
duke@1 | 468 | * TODO: This method does not really belong here. |
duke@1 | 469 | */ |
duke@1 | 470 | public void exit() { |
duke@1 | 471 | throw new ExitJavadoc(); |
duke@1 | 472 | } |
duke@1 | 473 | |
duke@1 | 474 | } |