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

Thu, 29 Jan 2009 12:19:14 +0000

author
mcimadamore
date
Thu, 29 Jan 2009 12:19:14 +0000
changeset 212
79f2f2c7d846
parent 194
d0b33fe8e710
child 221
6ada6122dd4f
permissions
-rw-r--r--

6729401: Compiler error when using F-bounded generics with free type variables
Summary: Javac applies wrong substitution to recursive type-variable bounds
Reviewed-by: jjg

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

mercurial