Mercurial > jdk8-mips64-public > langtools / file revision
src/share/classes/com/sun/tools/javac/util/Log.java@bdcef2ef52d2
src/share/classes/com/sun/tools/javac/util/Log.java
Thu, 15 Nov 2012 23:07:24 -0800
- author
- jjg
- date
- Thu, 15 Nov 2012 23:07:24 -0800
- changeset 1413
- bdcef2ef52d2
- parent 1406
- 2901c7b5339e
- child 1521
- 71f35e4b93a5
- permissions
- -rw-r--r--
6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
Reviewed-by: darcy
1 /*
2 * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 package com.sun.tools.javac.util;
28 import java.io.*;
29 import java.util.Arrays;
30 import java.util.EnumSet;
31 import java.util.HashSet;
32 import java.util.Queue;
33 import java.util.Set;
34 import javax.tools.DiagnosticListener;
35 import javax.tools.JavaFileObject;
37 import com.sun.tools.javac.api.DiagnosticFormatter;
38 import com.sun.tools.javac.main.Main;
39 import com.sun.tools.javac.main.Option;
40 import com.sun.tools.javac.tree.EndPosTable;
41 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
42 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticType;
44 import static com.sun.tools.javac.main.Option.*;
46 /** A class for error logs. Reports errors and warnings, and
47 * keeps track of error numbers and positions.
48 *
49 * <p><b>This is NOT part of any supported API.
50 * If you write code that depends on this, you do so at your own risk.
51 * This code and its internal interfaces are subject to change or
52 * deletion without notice.</b>
53 */
54 public class Log extends AbstractLog {
55 /** The context key for the log. */
56 public static final Context.Key<Log> logKey
57 = new Context.Key<Log>();
59 /** The context key for the output PrintWriter. */
60 public static final Context.Key<PrintWriter> outKey =
61 new Context.Key<PrintWriter>();
63 /* TODO: Should unify this with prefix handling in JCDiagnostic.Factory. */
64 public enum PrefixKind {
65 JAVAC("javac."),
66 COMPILER_MISC("compiler.misc.");
67 PrefixKind(String v) {
68 value = v;
69 }
70 public String key(String k) {
71 return value + k;
72 }
73 final String value;
74 }
76 /**
77 * DiagnosticHandler's provide the initial handling for diagnostics.
78 * When a diagnostic handler is created and has been initialized, it
79 * should install itself as the current diagnostic handler. When a
80 * client has finished using a handler, the client should call
81 * {@code log.removeDiagnosticHandler();}
82 *
83 * Note that javax.tools.DiagnosticListener (if set) is called later in the
84 * diagnostic pipeline.
85 */
86 public static abstract class DiagnosticHandler {
87 /**
88 * The previously installed diagnostic handler.
89 */
90 protected DiagnosticHandler prev;
92 /**
93 * Install this diagnostic handler as the current one,
94 * recording the previous one.
95 */
96 protected void install(Log log) {
97 prev = log.diagnosticHandler;
98 log.diagnosticHandler = this;
99 }
101 /**
102 * Handle a diagnostic.
103 */
104 public abstract void report(JCDiagnostic diag);
105 }
107 /**
108 * A DiagnosticHandler that discards all diagnostics.
109 */
110 public static class DiscardDiagnosticHandler extends DiagnosticHandler {
111 public DiscardDiagnosticHandler(Log log) {
112 install(log);
113 }
115 public void report(JCDiagnostic diag) { }
116 }
118 /**
119 * A DiagnosticHandler that can defer some or all diagnostics,
120 * by buffering them for later examination and/or reporting.
121 * If a diagnostic is not deferred, or is subsequently reported
122 * with reportAllDiagnostics(), it will be reported to the previously
123 * active diagnostic handler.
124 */
125 public static class DeferredDiagnosticHandler extends DiagnosticHandler {
126 private Queue<JCDiagnostic> deferred = ListBuffer.lb();
127 private final Filter<JCDiagnostic> filter;
129 public DeferredDiagnosticHandler(Log log) {
130 this(log, null);
131 }
133 public DeferredDiagnosticHandler(Log log, Filter<JCDiagnostic> filter) {
134 this.filter = filter;
135 install(log);
136 }
138 public void report(JCDiagnostic diag) {
139 if (filter == null || filter.accepts(diag))
140 deferred.add(diag);
141 else
142 prev.report(diag);
143 }
145 public Queue<JCDiagnostic> getDiagnostics() {
146 return deferred;
147 }
149 /** Report all deferred diagnostics. */
150 public void reportDeferredDiagnostics() {
151 reportDeferredDiagnostics(EnumSet.allOf(JCDiagnostic.Kind.class));
152 }
154 /** Report selected deferred diagnostics. */
155 public void reportDeferredDiagnostics(Set<JCDiagnostic.Kind> kinds) {
156 JCDiagnostic d;
157 while ((d = deferred.poll()) != null) {
158 if (kinds.contains(d.getKind()))
159 prev.report(d);
160 }
161 deferred = null; // prevent accidental ongoing use
162 }
163 }
165 public enum WriterKind { NOTICE, WARNING, ERROR };
167 protected PrintWriter errWriter;
169 protected PrintWriter warnWriter;
171 protected PrintWriter noticeWriter;
173 /** The maximum number of errors/warnings that are reported.
174 */
175 protected int MaxErrors;
176 protected int MaxWarnings;
178 /** Switch: prompt user on each error.
179 */
180 public boolean promptOnError;
182 /** Switch: emit warning messages.
183 */
184 public boolean emitWarnings;
186 /** Switch: suppress note messages.
187 */
188 public boolean suppressNotes;
190 /** Print stack trace on errors?
191 */
192 public boolean dumpOnError;
194 /** Print multiple errors for same source locations.
195 */
196 public boolean multipleErrors;
198 /**
199 * Diagnostic listener, if provided through programmatic
200 * interface to javac (JSR 199).
201 */
202 protected DiagnosticListener<? super JavaFileObject> diagListener;
204 /**
205 * Formatter for diagnostics.
206 */
207 private DiagnosticFormatter<JCDiagnostic> diagFormatter;
209 /**
210 * Keys for expected diagnostics.
211 */
212 public Set<String> expectDiagKeys;
214 /**
215 * JavacMessages object used for localization.
216 */
217 private JavacMessages messages;
219 /**
220 + * Handler for initial dispatch of diagnostics.
221 */
222 private DiagnosticHandler diagnosticHandler;
224 /** Construct a log with given I/O redirections.
225 */
226 protected Log(Context context, PrintWriter errWriter, PrintWriter warnWriter, PrintWriter noticeWriter) {
227 super(JCDiagnostic.Factory.instance(context));
228 context.put(logKey, this);
229 this.errWriter = errWriter;
230 this.warnWriter = warnWriter;
231 this.noticeWriter = noticeWriter;
233 @SuppressWarnings("unchecked") // FIXME
234 DiagnosticListener<? super JavaFileObject> dl =
235 context.get(DiagnosticListener.class);
236 this.diagListener = dl;
238 diagnosticHandler = new DefaultDiagnosticHandler();
240 messages = JavacMessages.instance(context);
241 messages.add(Main.javacBundleName);
243 final Options options = Options.instance(context);
244 initOptions(options);
245 options.addListener(new Runnable() {
246 public void run() {
247 initOptions(options);
248 }
249 });
250 }
251 // where
252 private void initOptions(Options options) {
253 this.dumpOnError = options.isSet(DOE);
254 this.promptOnError = options.isSet(PROMPT);
255 this.emitWarnings = options.isUnset(XLINT_CUSTOM, "none");
256 this.suppressNotes = options.isSet("suppressNotes");
257 this.MaxErrors = getIntOption(options, XMAXERRS, getDefaultMaxErrors());
258 this.MaxWarnings = getIntOption(options, XMAXWARNS, getDefaultMaxWarnings());
260 boolean rawDiagnostics = options.isSet("rawDiagnostics");
261 this.diagFormatter = rawDiagnostics ? new RawDiagnosticFormatter(options) :
262 new BasicDiagnosticFormatter(options, messages);
264 String ek = options.get("expectKeys");
265 if (ek != null)
266 expectDiagKeys = new HashSet<String>(Arrays.asList(ek.split(", *")));
267 }
269 private int getIntOption(Options options, Option option, int defaultValue) {
270 String s = options.get(option);
271 try {
272 if (s != null) {
273 int n = Integer.parseInt(s);
274 return (n <= 0 ? Integer.MAX_VALUE : n);
275 }
276 } catch (NumberFormatException e) {
277 // silently ignore ill-formed numbers
278 }
279 return defaultValue;
280 }
282 /** Default value for -Xmaxerrs.
283 */
284 protected int getDefaultMaxErrors() {
285 return 100;
286 }
288 /** Default value for -Xmaxwarns.
289 */
290 protected int getDefaultMaxWarnings() {
291 return 100;
292 }
294 /** The default writer for diagnostics
295 */
296 static PrintWriter defaultWriter(Context context) {
297 PrintWriter result = context.get(outKey);
298 if (result == null)
299 context.put(outKey, result = new PrintWriter(System.err));
300 return result;
301 }
303 /** Construct a log with default settings.
304 */
305 protected Log(Context context) {
306 this(context, defaultWriter(context));
307 }
309 /** Construct a log with all output redirected.
310 */
311 protected Log(Context context, PrintWriter defaultWriter) {
312 this(context, defaultWriter, defaultWriter, defaultWriter);
313 }
315 /** Get the Log instance for this context. */
316 public static Log instance(Context context) {
317 Log instance = context.get(logKey);
318 if (instance == null)
319 instance = new Log(context);
320 return instance;
321 }
323 /** The number of errors encountered so far.
324 */
325 public int nerrors = 0;
327 /** The number of warnings encountered so far.
328 */
329 public int nwarnings = 0;
331 /** A set of all errors generated so far. This is used to avoid printing an
332 * error message more than once. For each error, a pair consisting of the
333 * source file name and source code position of the error is added to the set.
334 */
335 private Set<Pair<JavaFileObject, Integer>> recorded = new HashSet<Pair<JavaFileObject,Integer>>();
337 public boolean hasDiagnosticListener() {
338 return diagListener != null;
339 }
341 public void setEndPosTable(JavaFileObject name, EndPosTable endPosTable) {
342 name.getClass(); // null check
343 getSource(name).setEndPosTable(endPosTable);
344 }
346 /** Return current sourcefile.
347 */
348 public JavaFileObject currentSourceFile() {
349 return source == null ? null : source.getFile();
350 }
352 /** Get the current diagnostic formatter.
353 */
354 public DiagnosticFormatter<JCDiagnostic> getDiagnosticFormatter() {
355 return diagFormatter;
356 }
358 /** Set the current diagnostic formatter.
359 */
360 public void setDiagnosticFormatter(DiagnosticFormatter<JCDiagnostic> diagFormatter) {
361 this.diagFormatter = diagFormatter;
362 }
364 public PrintWriter getWriter(WriterKind kind) {
365 switch (kind) {
366 case NOTICE: return noticeWriter;
367 case WARNING: return warnWriter;
368 case ERROR: return errWriter;
369 default: throw new IllegalArgumentException();
370 }
371 }
373 public void setWriter(WriterKind kind, PrintWriter pw) {
374 pw.getClass();
375 switch (kind) {
376 case NOTICE: noticeWriter = pw; break;
377 case WARNING: warnWriter = pw; break;
378 case ERROR: errWriter = pw; break;
379 default: throw new IllegalArgumentException();
380 }
381 }
383 public void setWriters(PrintWriter pw) {
384 pw.getClass();
385 noticeWriter = warnWriter = errWriter = pw;
386 }
388 public void setWriters(Log other) {
389 this.noticeWriter = other.noticeWriter;
390 this.warnWriter = other.warnWriter;
391 this.errWriter = other.errWriter;
392 }
394 public void setSourceMap(Log other) {
395 this.sourceMap = other.sourceMap;
396 }
398 /**
399 * Replace the specified diagnostic handler with the
400 * handler that was current at the time this handler was created.
401 * The given handler must be the currently installed handler;
402 * it must be specified explicitly for clarity and consistency checking.
403 */
404 public void popDiagnosticHandler(DiagnosticHandler h) {
405 Assert.check(diagnosticHandler == h);
406 diagnosticHandler = h.prev;
407 }
409 /** Flush the logs
410 */
411 public void flush() {
412 errWriter.flush();
413 warnWriter.flush();
414 noticeWriter.flush();
415 }
417 public void flush(WriterKind kind) {
418 getWriter(kind).flush();
419 }
421 /** Returns true if an error needs to be reported for a given
422 * source name and pos.
423 */
424 protected boolean shouldReport(JavaFileObject file, int pos) {
425 if (multipleErrors || file == null)
426 return true;
428 Pair<JavaFileObject,Integer> coords = new Pair<JavaFileObject,Integer>(file, pos);
429 boolean shouldReport = !recorded.contains(coords);
430 if (shouldReport)
431 recorded.add(coords);
432 return shouldReport;
433 }
435 /** Prompt user after an error.
436 */
437 public void prompt() {
438 if (promptOnError) {
439 System.err.println(localize("resume.abort"));
440 try {
441 while (true) {
442 switch (System.in.read()) {
443 case 'a': case 'A':
444 System.exit(-1);
445 return;
446 case 'r': case 'R':
447 return;
448 case 'x': case 'X':
449 throw new AssertionError("user abort");
450 default:
451 }
452 }
453 } catch (IOException e) {}
454 }
455 }
457 /** Print the faulty source code line and point to the error.
458 * @param pos Buffer index of the error position, must be on current line
459 */
460 private void printErrLine(int pos, PrintWriter writer) {
461 String line = (source == null ? null : source.getLine(pos));
462 if (line == null)
463 return;
464 int col = source.getColumnNumber(pos, false);
466 printRawLines(writer, line);
467 for (int i = 0; i < col - 1; i++) {
468 writer.print((line.charAt(i) == '\t') ? "\t" : " ");
469 }
470 writer.println("^");
471 writer.flush();
472 }
474 public void printNewline() {
475 noticeWriter.println();
476 }
478 public void printNewline(WriterKind wk) {
479 getWriter(wk).println();
480 }
482 public void printLines(String key, Object... args) {
483 printRawLines(noticeWriter, localize(key, args));
484 }
486 public void printLines(PrefixKind pk, String key, Object... args) {
487 printRawLines(noticeWriter, localize(pk, key, args));
488 }
490 public void printLines(WriterKind wk, String key, Object... args) {
491 printRawLines(getWriter(wk), localize(key, args));
492 }
494 public void printLines(WriterKind wk, PrefixKind pk, String key, Object... args) {
495 printRawLines(getWriter(wk), localize(pk, key, args));
496 }
498 /** Print the text of a message, translating newlines appropriately
499 * for the platform.
500 */
501 public void printRawLines(String msg) {
502 printRawLines(noticeWriter, msg);
503 }
505 /** Print the text of a message, translating newlines appropriately
506 * for the platform.
507 */
508 public void printRawLines(WriterKind kind, String msg) {
509 printRawLines(getWriter(kind), msg);
510 }
512 /** Print the text of a message, translating newlines appropriately
513 * for the platform.
514 */
515 public static void printRawLines(PrintWriter writer, String msg) {
516 int nl;
517 while ((nl = msg.indexOf('\n')) != -1) {
518 writer.println(msg.substring(0, nl));
519 msg = msg.substring(nl+1);
520 }
521 if (msg.length() != 0) writer.println(msg);
522 }
524 /**
525 * Print the localized text of a "verbose" message to the
526 * noticeWriter stream.
527 */
528 public void printVerbose(String key, Object... args) {
529 printRawLines(noticeWriter, localize("verbose." + key, args));
530 }
532 protected void directError(String key, Object... args) {
533 printRawLines(errWriter, localize(key, args));
534 errWriter.flush();
535 }
537 /** Report a warning that cannot be suppressed.
538 * @param pos The source position at which to report the warning.
539 * @param key The key for the localized warning message.
540 * @param args Fields of the warning message.
541 */
542 public void strictWarning(DiagnosticPosition pos, String key, Object ... args) {
543 writeDiagnostic(diags.warning(source, pos, key, args));
544 nwarnings++;
545 }
547 /**
548 * Primary method to report a diagnostic.
549 * @param diagnostic
550 */
551 public void report(JCDiagnostic diagnostic) {
552 diagnosticHandler.report(diagnostic);
553 }
555 /**
556 * Common diagnostic handling.
557 * The diagnostic is counted, and depending on the options and how many diagnostics have been
558 * reported so far, the diagnostic may be handed off to writeDiagnostic.
559 */
560 private class DefaultDiagnosticHandler extends DiagnosticHandler {
561 public void report(JCDiagnostic diagnostic) {
562 if (expectDiagKeys != null)
563 expectDiagKeys.remove(diagnostic.getCode());
565 switch (diagnostic.getType()) {
566 case FRAGMENT:
567 throw new IllegalArgumentException();
569 case NOTE:
570 // Print out notes only when we are permitted to report warnings
571 // Notes are only generated at the end of a compilation, so should be small
572 // in number.
573 if ((emitWarnings || diagnostic.isMandatory()) && !suppressNotes) {
574 writeDiagnostic(diagnostic);
575 }
576 break;
578 case WARNING:
579 if (emitWarnings || diagnostic.isMandatory()) {
580 if (nwarnings < MaxWarnings) {
581 writeDiagnostic(diagnostic);
582 nwarnings++;
583 }
584 }
585 break;
587 case ERROR:
588 if (nerrors < MaxErrors
589 && shouldReport(diagnostic.getSource(), diagnostic.getIntPosition())) {
590 writeDiagnostic(diagnostic);
591 nerrors++;
592 }
593 break;
594 }
595 }
596 }
598 /**
599 * Write out a diagnostic.
600 */
601 protected void writeDiagnostic(JCDiagnostic diag) {
602 if (diagListener != null) {
603 diagListener.report(diag);
604 return;
605 }
607 PrintWriter writer = getWriterForDiagnosticType(diag.getType());
609 printRawLines(writer, diagFormatter.format(diag, messages.getCurrentLocale()));
611 if (promptOnError) {
612 switch (diag.getType()) {
613 case ERROR:
614 case WARNING:
615 prompt();
616 }
617 }
619 if (dumpOnError)
620 new RuntimeException().printStackTrace(writer);
622 writer.flush();
623 }
625 @Deprecated
626 protected PrintWriter getWriterForDiagnosticType(DiagnosticType dt) {
627 switch (dt) {
628 case FRAGMENT:
629 throw new IllegalArgumentException();
631 case NOTE:
632 return noticeWriter;
634 case WARNING:
635 return warnWriter;
637 case ERROR:
638 return errWriter;
640 default:
641 throw new Error();
642 }
643 }
645 /** Find a localized string in the resource bundle.
646 * Because this method is static, it ignores the locale.
647 * Use localize(key, args) when possible.
648 * @param key The key for the localized string.
649 * @param args Fields to substitute into the string.
650 */
651 public static String getLocalizedString(String key, Object ... args) {
652 return JavacMessages.getDefaultLocalizedString(PrefixKind.COMPILER_MISC.key(key), args);
653 }
655 /** Find a localized string in the resource bundle.
656 * @param key The key for the localized string.
657 * @param args Fields to substitute into the string.
658 */
659 public String localize(String key, Object... args) {
660 return localize(PrefixKind.COMPILER_MISC, key, args);
661 }
663 /** Find a localized string in the resource bundle.
664 * @param key The key for the localized string.
665 * @param args Fields to substitute into the string.
666 */
667 public String localize(PrefixKind pk, String key, Object... args) {
668 if (useRawMessages)
669 return pk.key(key);
670 else
671 return messages.getLocalizedString(pk.key(key), args);
672 }
673 // where
674 // backdoor hook for testing, should transition to use -XDrawDiagnostics
675 private static boolean useRawMessages = false;
677 /***************************************************************************
678 * raw error messages without internationalization; used for experimentation
679 * and quick prototyping
680 ***************************************************************************/
682 /** print an error or warning message:
683 */
684 private void printRawError(int pos, String msg) {
685 if (source == null || pos == Position.NOPOS) {
686 printRawLines(errWriter, "error: " + msg);
687 } else {
688 int line = source.getLineNumber(pos);
689 JavaFileObject file = source.getFile();
690 if (file != null)
691 printRawLines(errWriter,
692 file.getName() + ":" +
693 line + ": " + msg);
694 printErrLine(pos, errWriter);
695 }
696 errWriter.flush();
697 }
699 /** report an error:
700 */
701 public void rawError(int pos, String msg) {
702 if (nerrors < MaxErrors && shouldReport(currentSourceFile(), pos)) {
703 printRawError(pos, msg);
704 prompt();
705 nerrors++;
706 }
707 errWriter.flush();
708 }
710 /** report a warning:
711 */
712 public void rawWarning(int pos, String msg) {
713 if (nwarnings < MaxWarnings && emitWarnings) {
714 printRawError(pos, "warning: " + msg);
715 }
716 prompt();
717 nwarnings++;
718 errWriter.flush();
719 }
721 public static String format(String fmt, Object... args) {
722 return String.format((java.util.Locale)null, fmt, args);
723 }
725 }
