src/share/classes/com/sun/tools/javac/util/Log.java

Tue, 23 Feb 2010 18:43:02 -0800

author
jjg
date
Tue, 23 Feb 2010 18:43:02 -0800
changeset 504
6eca0895a644
parent 464
d02e99d31cc0
child 554
9d9f26857129
permissions
-rw-r--r--

6511613: javac unexpectedly doesn't fail in some cases if an annotation processor specified
Reviewed-by: darcy

duke@1 1 /*
xdono@229 2 * Copyright 1999-2009 Sun Microsystems, Inc. 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
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun 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 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.tools.javac.util;
duke@1 27
duke@1 28 import java.io.*;
jjg@194 29 import java.util.Arrays;
duke@1 30 import java.util.HashSet;
duke@1 31 import java.util.Map;
duke@1 32 import java.util.Set;
duke@1 33 import javax.tools.DiagnosticListener;
duke@1 34 import javax.tools.JavaFileObject;
jjg@50 35
duke@1 36 import com.sun.tools.javac.tree.JCTree;
mcimadamore@83 37 import com.sun.tools.javac.api.DiagnosticFormatter;
duke@1 38 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
duke@1 39 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticType;
duke@1 40
duke@1 41 /** A class for error logs. Reports errors and warnings, and
duke@1 42 * keeps track of error numbers and positions.
duke@1 43 *
duke@1 44 * <p><b>This is NOT part of any API supported by Sun Microsystems. If
duke@1 45 * you write code that depends on this, you do so at your own risk.
duke@1 46 * This code and its internal interfaces are subject to change or
duke@1 47 * deletion without notice.</b>
duke@1 48 */
jjg@73 49 public class Log extends AbstractLog {
duke@1 50 /** The context key for the log. */
duke@1 51 public static final Context.Key<Log> logKey
duke@1 52 = new Context.Key<Log>();
duke@1 53
duke@1 54 /** The context key for the output PrintWriter. */
duke@1 55 public static final Context.Key<PrintWriter> outKey =
duke@1 56 new Context.Key<PrintWriter>();
duke@1 57
duke@1 58 //@Deprecated
duke@1 59 public final PrintWriter errWriter;
duke@1 60
duke@1 61 //@Deprecated
duke@1 62 public final PrintWriter warnWriter;
duke@1 63
duke@1 64 //@Deprecated
duke@1 65 public final PrintWriter noticeWriter;
duke@1 66
duke@1 67 /** The maximum number of errors/warnings that are reported.
duke@1 68 */
duke@1 69 public final int MaxErrors;
duke@1 70 public final int MaxWarnings;
duke@1 71
duke@1 72 /** Switch: prompt user on each error.
duke@1 73 */
duke@1 74 public boolean promptOnError;
duke@1 75
duke@1 76 /** Switch: emit warning messages.
duke@1 77 */
duke@1 78 public boolean emitWarnings;
duke@1 79
jjg@376 80 /** Switch: suppress note messages.
jjg@376 81 */
jjg@376 82 public boolean suppressNotes;
jjg@376 83
duke@1 84 /** Print stack trace on errors?
duke@1 85 */
duke@1 86 public boolean dumpOnError;
duke@1 87
duke@1 88 /** Print multiple errors for same source locations.
duke@1 89 */
duke@1 90 public boolean multipleErrors;
duke@1 91
duke@1 92 /**
duke@1 93 * Diagnostic listener, if provided through programmatic
duke@1 94 * interface to javac (JSR 199).
duke@1 95 */
duke@1 96 protected DiagnosticListener<? super JavaFileObject> diagListener;
jjg@73 97
duke@1 98 /**
mcimadamore@221 99 * Formatter for diagnostics.
duke@1 100 */
mcimadamore@83 101 private DiagnosticFormatter<JCDiagnostic> diagFormatter;
duke@1 102
mcimadamore@136 103 /**
mcimadamore@221 104 * Keys for expected diagnostics.
jjg@194 105 */
jjg@194 106 public Set<String> expectDiagKeys;
jjg@194 107
jjg@194 108 /**
mcimadamore@221 109 * JavacMessages object used for localization.
mcimadamore@136 110 */
mcimadamore@136 111 private JavacMessages messages;
mcimadamore@136 112
duke@1 113 /** Construct a log with given I/O redirections.
duke@1 114 */
duke@1 115 @Deprecated
duke@1 116 protected Log(Context context, PrintWriter errWriter, PrintWriter warnWriter, PrintWriter noticeWriter) {
jjg@73 117 super(JCDiagnostic.Factory.instance(context));
duke@1 118 context.put(logKey, this);
duke@1 119 this.errWriter = errWriter;
duke@1 120 this.warnWriter = warnWriter;
duke@1 121 this.noticeWriter = noticeWriter;
duke@1 122
duke@1 123 Options options = Options.instance(context);
duke@1 124 this.dumpOnError = options.get("-doe") != null;
duke@1 125 this.promptOnError = options.get("-prompt") != null;
duke@1 126 this.emitWarnings = options.get("-Xlint:none") == null;
jjg@376 127 this.suppressNotes = options.get("suppressNotes") != null;
duke@1 128 this.MaxErrors = getIntOption(options, "-Xmaxerrs", 100);
duke@1 129 this.MaxWarnings = getIntOption(options, "-Xmaxwarns", 100);
duke@1 130
mcimadamore@83 131 boolean rawDiagnostics = options.get("rawDiagnostics") != null;
mcimadamore@136 132 messages = JavacMessages.instance(context);
mcimadamore@137 133 this.diagFormatter = rawDiagnostics ? new RawDiagnosticFormatter(options) :
mcimadamore@136 134 new BasicDiagnosticFormatter(options, messages);
duke@1 135 @SuppressWarnings("unchecked") // FIXME
jjg@194 136 DiagnosticListener<? super JavaFileObject> dl =
duke@1 137 context.get(DiagnosticListener.class);
jjg@194 138 this.diagListener = dl;
jjg@194 139
jjg@194 140 String ek = options.get("expectKeys");
jjg@194 141 if (ek != null)
jjg@194 142 expectDiagKeys = new HashSet<String>(Arrays.asList(ek.split(", *")));
duke@1 143 }
duke@1 144 // where
duke@1 145 private int getIntOption(Options options, String optionName, int defaultValue) {
duke@1 146 String s = options.get(optionName);
duke@1 147 try {
jjg@464 148 if (s != null) {
jjg@464 149 int n = Integer.parseInt(s);
jjg@464 150 return (n <= 0 ? Integer.MAX_VALUE : n);
jjg@464 151 }
duke@1 152 } catch (NumberFormatException e) {
duke@1 153 // silently ignore ill-formed numbers
duke@1 154 }
duke@1 155 return defaultValue;
duke@1 156 }
duke@1 157
duke@1 158 /** The default writer for diagnostics
duke@1 159 */
duke@1 160 static final PrintWriter defaultWriter(Context context) {
duke@1 161 PrintWriter result = context.get(outKey);
duke@1 162 if (result == null)
duke@1 163 context.put(outKey, result = new PrintWriter(System.err));
duke@1 164 return result;
duke@1 165 }
duke@1 166
duke@1 167 /** Construct a log with default settings.
duke@1 168 */
duke@1 169 protected Log(Context context) {
duke@1 170 this(context, defaultWriter(context));
duke@1 171 }
duke@1 172
duke@1 173 /** Construct a log with all output redirected.
duke@1 174 */
duke@1 175 protected Log(Context context, PrintWriter defaultWriter) {
duke@1 176 this(context, defaultWriter, defaultWriter, defaultWriter);
duke@1 177 }
duke@1 178
duke@1 179 /** Get the Log instance for this context. */
duke@1 180 public static Log instance(Context context) {
duke@1 181 Log instance = context.get(logKey);
duke@1 182 if (instance == null)
duke@1 183 instance = new Log(context);
duke@1 184 return instance;
duke@1 185 }
duke@1 186
duke@1 187 /** The number of errors encountered so far.
duke@1 188 */
duke@1 189 public int nerrors = 0;
duke@1 190
duke@1 191 /** The number of warnings encountered so far.
duke@1 192 */
duke@1 193 public int nwarnings = 0;
duke@1 194
jjg@504 195 /**
jjg@504 196 * Whether or not an unrecoverable error has been seen.
jjg@504 197 * Unrecoverable errors prevent subsequent annotation processing.
jjg@504 198 */
jjg@504 199 public boolean unrecoverableError;
jjg@504 200
duke@1 201 /** A set of all errors generated so far. This is used to avoid printing an
duke@1 202 * error message more than once. For each error, a pair consisting of the
duke@1 203 * source file name and source code position of the error is added to the set.
duke@1 204 */
duke@1 205 private Set<Pair<JavaFileObject, Integer>> recorded = new HashSet<Pair<JavaFileObject,Integer>>();
duke@1 206
duke@1 207 public boolean hasDiagnosticListener() {
duke@1 208 return diagListener != null;
duke@1 209 }
duke@1 210
duke@1 211 public void setEndPosTable(JavaFileObject name, Map<JCTree, Integer> table) {
jjg@73 212 name.getClass(); // null check
jjg@73 213 getSource(name).setEndPosTable(table);
duke@1 214 }
duke@1 215
mcimadamore@168 216 /** Return current sourcefile.
duke@1 217 */
mcimadamore@168 218 public JavaFileObject currentSourceFile() {
duke@1 219 return source == null ? null : source.getFile();
duke@1 220 }
duke@1 221
mcimadamore@221 222 /** Get the current diagnostic formatter.
mcimadamore@221 223 */
mcimadamore@221 224 public DiagnosticFormatter<JCDiagnostic> getDiagnosticFormatter() {
mcimadamore@221 225 return diagFormatter;
mcimadamore@221 226 }
mcimadamore@221 227
mcimadamore@221 228 /** Set the current diagnostic formatter.
mcimadamore@221 229 */
mcimadamore@221 230 public void setDiagnosticFormatter(DiagnosticFormatter<JCDiagnostic> diagFormatter) {
mcimadamore@221 231 this.diagFormatter = diagFormatter;
mcimadamore@221 232 }
mcimadamore@221 233
duke@1 234 /** Flush the logs
duke@1 235 */
duke@1 236 public void flush() {
duke@1 237 errWriter.flush();
duke@1 238 warnWriter.flush();
duke@1 239 noticeWriter.flush();
duke@1 240 }
duke@1 241
duke@1 242 /** Returns true if an error needs to be reported for a given
duke@1 243 * source name and pos.
duke@1 244 */
duke@1 245 protected boolean shouldReport(JavaFileObject file, int pos) {
duke@1 246 if (multipleErrors || file == null)
duke@1 247 return true;
duke@1 248
duke@1 249 Pair<JavaFileObject,Integer> coords = new Pair<JavaFileObject,Integer>(file, pos);
duke@1 250 boolean shouldReport = !recorded.contains(coords);
duke@1 251 if (shouldReport)
duke@1 252 recorded.add(coords);
duke@1 253 return shouldReport;
duke@1 254 }
duke@1 255
duke@1 256 /** Prompt user after an error.
duke@1 257 */
duke@1 258 public void prompt() {
duke@1 259 if (promptOnError) {
duke@1 260 System.err.println(getLocalizedString("resume.abort"));
duke@1 261 char ch;
duke@1 262 try {
duke@1 263 while (true) {
duke@1 264 switch (System.in.read()) {
duke@1 265 case 'a': case 'A':
duke@1 266 System.exit(-1);
duke@1 267 return;
duke@1 268 case 'r': case 'R':
duke@1 269 return;
duke@1 270 case 'x': case 'X':
duke@1 271 throw new AssertionError("user abort");
duke@1 272 default:
duke@1 273 }
duke@1 274 }
duke@1 275 } catch (IOException e) {}
duke@1 276 }
duke@1 277 }
duke@1 278
duke@1 279 /** Print the faulty source code line and point to the error.
duke@1 280 * @param pos Buffer index of the error position, must be on current line
duke@1 281 */
duke@1 282 private void printErrLine(int pos, PrintWriter writer) {
jjg@73 283 String line = (source == null ? null : source.getLine(pos));
jjg@73 284 if (line == null)
duke@1 285 return;
mcimadamore@100 286 int col = source.getColumnNumber(pos, false);
duke@1 287
jjg@73 288 printLines(writer, line);
jjg@73 289 for (int i = 0; i < col - 1; i++) {
jjg@73 290 writer.print((line.charAt(i) == '\t') ? "\t" : " ");
duke@1 291 }
duke@1 292 writer.println("^");
duke@1 293 writer.flush();
duke@1 294 }
duke@1 295
duke@1 296 /** Print the text of a message, translating newlines appropriately
duke@1 297 * for the platform.
duke@1 298 */
duke@1 299 public static void printLines(PrintWriter writer, String msg) {
duke@1 300 int nl;
duke@1 301 while ((nl = msg.indexOf('\n')) != -1) {
duke@1 302 writer.println(msg.substring(0, nl));
duke@1 303 msg = msg.substring(nl+1);
duke@1 304 }
duke@1 305 if (msg.length() != 0) writer.println(msg);
duke@1 306 }
duke@1 307
jjg@73 308 protected void directError(String key, Object... args) {
jjg@73 309 printLines(errWriter, getLocalizedString(key, args));
jjg@73 310 errWriter.flush();
duke@1 311 }
duke@1 312
duke@1 313 /** Report a warning that cannot be suppressed.
duke@1 314 * @param pos The source position at which to report the warning.
duke@1 315 * @param key The key for the localized warning message.
duke@1 316 * @param args Fields of the warning message.
duke@1 317 */
duke@1 318 public void strictWarning(DiagnosticPosition pos, String key, Object ... args) {
duke@1 319 writeDiagnostic(diags.warning(source, pos, key, args));
duke@1 320 nwarnings++;
duke@1 321 }
duke@1 322
duke@1 323 /**
duke@1 324 * Common diagnostic handling.
duke@1 325 * The diagnostic is counted, and depending on the options and how many diagnostics have been
duke@1 326 * reported so far, the diagnostic may be handed off to writeDiagnostic.
duke@1 327 */
duke@1 328 public void report(JCDiagnostic diagnostic) {
jjg@194 329 if (expectDiagKeys != null)
jjg@194 330 expectDiagKeys.remove(diagnostic.getCode());
jjg@194 331
duke@1 332 switch (diagnostic.getType()) {
duke@1 333 case FRAGMENT:
duke@1 334 throw new IllegalArgumentException();
duke@1 335
duke@1 336 case NOTE:
duke@1 337 // Print out notes only when we are permitted to report warnings
duke@1 338 // Notes are only generated at the end of a compilation, so should be small
duke@1 339 // in number.
jjg@376 340 if ((emitWarnings || diagnostic.isMandatory()) && !suppressNotes) {
duke@1 341 writeDiagnostic(diagnostic);
duke@1 342 }
duke@1 343 break;
duke@1 344
duke@1 345 case WARNING:
duke@1 346 if (emitWarnings || diagnostic.isMandatory()) {
duke@1 347 if (nwarnings < MaxWarnings) {
duke@1 348 writeDiagnostic(diagnostic);
duke@1 349 nwarnings++;
duke@1 350 }
duke@1 351 }
duke@1 352 break;
duke@1 353
duke@1 354 case ERROR:
duke@1 355 if (nerrors < MaxErrors
duke@1 356 && shouldReport(diagnostic.getSource(), diagnostic.getIntPosition())) {
duke@1 357 writeDiagnostic(diagnostic);
duke@1 358 nerrors++;
duke@1 359 }
duke@1 360 break;
duke@1 361 }
duke@1 362 }
duke@1 363
duke@1 364 /**
duke@1 365 * Write out a diagnostic.
duke@1 366 */
duke@1 367 protected void writeDiagnostic(JCDiagnostic diag) {
duke@1 368 if (diagListener != null) {
duke@1 369 try {
duke@1 370 diagListener.report(diag);
duke@1 371 return;
duke@1 372 }
duke@1 373 catch (Throwable t) {
duke@1 374 throw new ClientCodeException(t);
duke@1 375 }
duke@1 376 }
duke@1 377
duke@1 378 PrintWriter writer = getWriterForDiagnosticType(diag.getType());
duke@1 379
mcimadamore@136 380 printLines(writer, diagFormatter.format(diag, messages.getCurrentLocale()));
duke@1 381
duke@1 382 if (promptOnError) {
duke@1 383 switch (diag.getType()) {
duke@1 384 case ERROR:
duke@1 385 case WARNING:
duke@1 386 prompt();
duke@1 387 }
duke@1 388 }
duke@1 389
duke@1 390 if (dumpOnError)
duke@1 391 new RuntimeException().printStackTrace(writer);
duke@1 392
duke@1 393 writer.flush();
duke@1 394 }
duke@1 395
duke@1 396 @Deprecated
duke@1 397 protected PrintWriter getWriterForDiagnosticType(DiagnosticType dt) {
duke@1 398 switch (dt) {
duke@1 399 case FRAGMENT:
duke@1 400 throw new IllegalArgumentException();
duke@1 401
duke@1 402 case NOTE:
duke@1 403 return noticeWriter;
duke@1 404
duke@1 405 case WARNING:
duke@1 406 return warnWriter;
duke@1 407
duke@1 408 case ERROR:
duke@1 409 return errWriter;
duke@1 410
duke@1 411 default:
duke@1 412 throw new Error();
duke@1 413 }
duke@1 414 }
duke@1 415
duke@1 416 /** Find a localized string in the resource bundle.
duke@1 417 * @param key The key for the localized string.
duke@1 418 * @param args Fields to substitute into the string.
duke@1 419 */
duke@1 420 public static String getLocalizedString(String key, Object ... args) {
mcimadamore@136 421 return JavacMessages.getDefaultLocalizedString("compiler.misc." + key, args);
duke@1 422 }
duke@1 423
duke@1 424 /***************************************************************************
duke@1 425 * raw error messages without internationalization; used for experimentation
duke@1 426 * and quick prototyping
duke@1 427 ***************************************************************************/
duke@1 428
jjg@73 429 /** print an error or warning message:
jjg@73 430 */
duke@1 431 private void printRawError(int pos, String msg) {
jjg@73 432 if (source == null || pos == Position.NOPOS) {
duke@1 433 printLines(errWriter, "error: " + msg);
duke@1 434 } else {
jjg@73 435 int line = source.getLineNumber(pos);
mcimadamore@168 436 JavaFileObject file = source.getFile();
duke@1 437 if (file != null)
duke@1 438 printLines(errWriter,
jjg@415 439 file.getName() + ":" +
duke@1 440 line + ": " + msg);
duke@1 441 printErrLine(pos, errWriter);
duke@1 442 }
duke@1 443 errWriter.flush();
duke@1 444 }
duke@1 445
jjg@73 446 /** report an error:
jjg@73 447 */
duke@1 448 public void rawError(int pos, String msg) {
mcimadamore@168 449 if (nerrors < MaxErrors && shouldReport(currentSourceFile(), pos)) {
duke@1 450 printRawError(pos, msg);
duke@1 451 prompt();
duke@1 452 nerrors++;
duke@1 453 }
duke@1 454 errWriter.flush();
duke@1 455 }
duke@1 456
jjg@73 457 /** report a warning:
jjg@73 458 */
duke@1 459 public void rawWarning(int pos, String msg) {
duke@1 460 if (nwarnings < MaxWarnings && emitWarnings) {
duke@1 461 printRawError(pos, "warning: " + msg);
duke@1 462 }
duke@1 463 prompt();
duke@1 464 nwarnings++;
duke@1 465 errWriter.flush();
duke@1 466 }
duke@1 467
duke@1 468 public static String format(String fmt, Object... args) {
duke@1 469 return String.format((java.util.Locale)null, fmt, args);
duke@1 470 }
duke@1 471
duke@1 472 }

mercurial