Mercurial > jdk8-mips64-public > langtools / file revision

 /*

  * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.

  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

  *

  * This code is free software; you can redistribute it and/or modify it

  * under the terms of the GNU General Public License version 2 only, as

  * published by the Free Software Foundation.  Oracle designates this

  * particular file as subject to the "Classpath" exception as provided

  * by Oracle in the LICENSE file that accompanied this code.

  *

  * This code is distributed in the hope that it will be useful, but WITHOUT

  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

  * version 2 for more details (a copy is included in the LICENSE file that

  * accompanied this code).

  *

  * You should have received a copy of the GNU General Public License version

  * 2 along with this work; if not, write to the Free Software Foundation,

  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

  *

  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

  * or visit www.oracle.com if you need additional information or have any

  * questions.

  */

 package com.sun.tools.javac.util;

 import java.io.*;

 import java.util.Arrays;

 import java.util.EnumSet;

 import java.util.HashSet;

 import java.util.Queue;

 import java.util.Set;

 import javax.tools.DiagnosticListener;

 import javax.tools.JavaFileObject;

 import com.sun.tools.javac.api.DiagnosticFormatter;

 import com.sun.tools.javac.main.Main;

 import com.sun.tools.javac.main.Option;

 import com.sun.tools.javac.tree.EndPosTable;

 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;

 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticType;

 import static com.sun.tools.javac.main.Option.*;

 /** A class for error logs. Reports errors and warnings, and

  *  keeps track of error numbers and positions.

  *

  *  <p><b>This is NOT part of any supported API.

  *  If you write code that depends on this, you do so at your own risk.

  *  This code and its internal interfaces are subject to change or

  *  deletion without notice.</b>

  */

 public class Log extends AbstractLog {

     /** The context key for the log. */

     public static final Context.Key<Log> logKey

         = new Context.Key<Log>();

     /** The context key for the output PrintWriter. */

     public static final Context.Key<PrintWriter> outKey =

         new Context.Key<PrintWriter>();

     /* TODO: Should unify this with prefix handling in JCDiagnostic.Factory. */

     public enum PrefixKind {

         JAVAC("javac."),

         COMPILER_MISC("compiler.misc.");

         PrefixKind(String v) {

             value = v;

         }

         public String key(String k) {

             return value + k;

         }

         final String value;

     }

     /**

      * DiagnosticHandler's provide the initial handling for diagnostics.

      * When a diagnostic handler is created and has been initialized, it

      * should install itself as the current diagnostic handler. When a

      * client has finished using a handler, the client should call

      * {@code log.removeDiagnosticHandler();}

      *

      * Note that javax.tools.DiagnosticListener (if set) is called later in the

      * diagnostic pipeline.

      */

     public static abstract class DiagnosticHandler {

         /**

          * The previously installed diagnostic handler.

          */

         protected DiagnosticHandler prev;

         /**

          * Install this diagnostic handler as the current one,

          * recording the previous one.

          */

         protected void install(Log log) {

             prev = log.diagnosticHandler;

             log.diagnosticHandler = this;

         }

         /**

          * Handle a diagnostic.

          */

         public abstract void report(JCDiagnostic diag);

     }

     /**

      * A DiagnosticHandler that discards all diagnostics.

      */

     public static class DiscardDiagnosticHandler extends DiagnosticHandler {

         public DiscardDiagnosticHandler(Log log) {

             install(log);

         }

         public void report(JCDiagnostic diag) { }

     }

     /**

      * A DiagnosticHandler that can defer some or all diagnostics,

      * by buffering them for later examination and/or reporting.

      * If a diagnostic is not deferred, or is subsequently reported

      * with reportAllDiagnostics(), it will be reported to the previously

      * active diagnostic handler.

      */

     public static class DeferredDiagnosticHandler extends DiagnosticHandler {

         private Queue<JCDiagnostic> deferred = ListBuffer.lb();

         private final Filter<JCDiagnostic> filter;

         public DeferredDiagnosticHandler(Log log) {

             this(log, null);

         }

         public DeferredDiagnosticHandler(Log log, Filter<JCDiagnostic> filter) {

             this.filter = filter;

             install(log);

         }

         public void report(JCDiagnostic diag) {

             if (!diag.isFlagSet(JCDiagnostic.DiagnosticFlag.NON_DEFERRABLE) &&

                 (filter == null || filter.accepts(diag))) {

                 deferred.add(diag);

             } else {

                 prev.report(diag);

             }

         }

         public Queue<JCDiagnostic> getDiagnostics() {

             return deferred;

         }

         /** Report all deferred diagnostics. */

         public void reportDeferredDiagnostics() {

             reportDeferredDiagnostics(EnumSet.allOf(JCDiagnostic.Kind.class));

         }

         /** Report selected deferred diagnostics. */

         public void reportDeferredDiagnostics(Set<JCDiagnostic.Kind> kinds) {

             JCDiagnostic d;

             while ((d = deferred.poll()) != null) {

                 if (kinds.contains(d.getKind()))

                     prev.report(d);

             }

             deferred = null; // prevent accidental ongoing use

         }

     }

     public enum WriterKind { NOTICE, WARNING, ERROR };

     protected PrintWriter errWriter;

     protected PrintWriter warnWriter;

     protected PrintWriter noticeWriter;

     /** The maximum number of errors/warnings that are reported.

      */

     protected int MaxErrors;

     protected int MaxWarnings;

     /** Switch: prompt user on each error.

      */

     public boolean promptOnError;

     /** Switch: emit warning messages.

      */

     public boolean emitWarnings;

     /** Switch: suppress note messages.

      */

     public boolean suppressNotes;

     /** Print stack trace on errors?

      */

     public boolean dumpOnError;

     /** Print multiple errors for same source locations.

      */

     public boolean multipleErrors;

     /**

      * Diagnostic listener, if provided through programmatic

      * interface to javac (JSR 199).

      */

     protected DiagnosticListener<? super JavaFileObject> diagListener;

     /**

      * Formatter for diagnostics.

      */

     private DiagnosticFormatter<JCDiagnostic> diagFormatter;

     /**

      * Keys for expected diagnostics.

      */

     public Set<String> expectDiagKeys;

     /**

      * JavacMessages object used for localization.

      */

     private JavacMessages messages;

     /**

      * Handler for initial dispatch of diagnostics.

      */

     private DiagnosticHandler diagnosticHandler;

     /** Construct a log with given I/O redirections.

      */

     protected Log(Context context, PrintWriter errWriter, PrintWriter warnWriter, PrintWriter noticeWriter) {

         super(JCDiagnostic.Factory.instance(context));

         context.put(logKey, this);

         this.errWriter = errWriter;

         this.warnWriter = warnWriter;

         this.noticeWriter = noticeWriter;

         @SuppressWarnings("unchecked") // FIXME

         DiagnosticListener<? super JavaFileObject> dl =

             context.get(DiagnosticListener.class);

         this.diagListener = dl;

         diagnosticHandler = new DefaultDiagnosticHandler();

         messages = JavacMessages.instance(context);

         messages.add(Main.javacBundleName);

         final Options options = Options.instance(context);

         initOptions(options);

         options.addListener(new Runnable() {

             public void run() {

                 initOptions(options);

             }

         });

     }

     // where

         private void initOptions(Options options) {

             this.dumpOnError = options.isSet(DOE);

             this.promptOnError = options.isSet(PROMPT);

             this.emitWarnings = options.isUnset(XLINT_CUSTOM, "none");

             this.suppressNotes = options.isSet("suppressNotes");

             this.MaxErrors = getIntOption(options, XMAXERRS, getDefaultMaxErrors());

             this.MaxWarnings = getIntOption(options, XMAXWARNS, getDefaultMaxWarnings());

             boolean rawDiagnostics = options.isSet("rawDiagnostics");

             this.diagFormatter = rawDiagnostics ? new RawDiagnosticFormatter(options) :

                                                   new BasicDiagnosticFormatter(options, messages);

             String ek = options.get("expectKeys");

             if (ek != null)

                 expectDiagKeys = new HashSet<String>(Arrays.asList(ek.split(", *")));

         }

         private int getIntOption(Options options, Option option, int defaultValue) {

             String s = options.get(option);

             try {

                 if (s != null) {

                     int n = Integer.parseInt(s);

                     return (n <= 0 ? Integer.MAX_VALUE : n);

                 }

             } catch (NumberFormatException e) {

                 // silently ignore ill-formed numbers

             }

             return defaultValue;

         }

         /** Default value for -Xmaxerrs.

          */

         protected int getDefaultMaxErrors() {

             return 100;

         }

         /** Default value for -Xmaxwarns.

          */

         protected int getDefaultMaxWarnings() {

             return 100;

         }

     /** The default writer for diagnostics

      */

     static PrintWriter defaultWriter(Context context) {

         PrintWriter result = context.get(outKey);

         if (result == null)

             context.put(outKey, result = new PrintWriter(System.err));

         return result;

     }

     /** Construct a log with default settings.

      */

     protected Log(Context context) {

         this(context, defaultWriter(context));

     }

     /** Construct a log with all output redirected.

      */

     protected Log(Context context, PrintWriter defaultWriter) {

         this(context, defaultWriter, defaultWriter, defaultWriter);

     }

     /** Get the Log instance for this context. */

     public static Log instance(Context context) {

         Log instance = context.get(logKey);

         if (instance == null)

             instance = new Log(context);

         return instance;

     }

     /** The number of errors encountered so far.

      */

     public int nerrors = 0;

     /** The number of warnings encountered so far.

      */

     public int nwarnings = 0;

     /** A set of all errors generated so far. This is used to avoid printing an

      *  error message more than once. For each error, a pair consisting of the

      *  source file name and source code position of the error is added to the set.

      */

     private Set<Pair<JavaFileObject, Integer>> recorded = new HashSet<Pair<JavaFileObject,Integer>>();

     public boolean hasDiagnosticListener() {

         return diagListener != null;

     }

     public void setEndPosTable(JavaFileObject name, EndPosTable endPosTable) {

         name.getClass(); // null check

         getSource(name).setEndPosTable(endPosTable);

     }

     /** Return current sourcefile.

      */

     public JavaFileObject currentSourceFile() {

         return source == null ? null : source.getFile();

     }

     /** Get the current diagnostic formatter.

      */

     public DiagnosticFormatter<JCDiagnostic> getDiagnosticFormatter() {

         return diagFormatter;

     }

     /** Set the current diagnostic formatter.

      */

     public void setDiagnosticFormatter(DiagnosticFormatter<JCDiagnostic> diagFormatter) {

         this.diagFormatter = diagFormatter;

     }

     public PrintWriter getWriter(WriterKind kind) {

         switch (kind) {

             case NOTICE:    return noticeWriter;

             case WARNING:   return warnWriter;

             case ERROR:     return errWriter;

             default:        throw new IllegalArgumentException();

         }

     }

     public void setWriter(WriterKind kind, PrintWriter pw) {

         pw.getClass();

         switch (kind) {

             case NOTICE:    noticeWriter = pw;  break;

             case WARNING:   warnWriter = pw;    break;

             case ERROR:     errWriter = pw;     break;

             default:        throw new IllegalArgumentException();

         }

     }

     public void setWriters(PrintWriter pw) {

         pw.getClass();

         noticeWriter = warnWriter = errWriter = pw;

     }

     /**

      * Propagate the previous log's information.

      */

     public void initRound(Log other) {

         this.noticeWriter = other.noticeWriter;

         this.warnWriter = other.warnWriter;

         this.errWriter = other.errWriter;

         this.sourceMap = other.sourceMap;

         this.recorded = other.recorded;

         this.nerrors = other.nerrors;

         this.nwarnings = other.nwarnings;

     }

     /**

      * Replace the specified diagnostic handler with the

      * handler that was current at the time this handler was created.

      * The given handler must be the currently installed handler;

      * it must be specified explicitly for clarity and consistency checking.

      */

     public void popDiagnosticHandler(DiagnosticHandler h) {

         Assert.check(diagnosticHandler == h);

         diagnosticHandler = h.prev;

     }

     /** Flush the logs

      */

     public void flush() {

         errWriter.flush();

         warnWriter.flush();

         noticeWriter.flush();

     }

     public void flush(WriterKind kind) {

         getWriter(kind).flush();

     }

     /** Returns true if an error needs to be reported for a given

      * source name and pos.

      */

     protected boolean shouldReport(JavaFileObject file, int pos) {

         if (multipleErrors || file == null)

             return true;

         Pair<JavaFileObject,Integer> coords = new Pair<JavaFileObject,Integer>(file, pos);

         boolean shouldReport = !recorded.contains(coords);

         if (shouldReport)

             recorded.add(coords);

         return shouldReport;

     }

     /** Prompt user after an error.

      */

     public void prompt() {

         if (promptOnError) {

             System.err.println(localize("resume.abort"));

             try {

                 while (true) {

                     switch (System.in.read()) {

                     case 'a': case 'A':

                         System.exit(-1);

                         return;

                     case 'r': case 'R':

                         return;

                     case 'x': case 'X':

                         throw new AssertionError("user abort");

                     default:

                     }

                 }

             } catch (IOException e) {}

         }

     }

     /** Print the faulty source code line and point to the error.

      *  @param pos   Buffer index of the error position, must be on current line

      */

     private void printErrLine(int pos, PrintWriter writer) {

         String line = (source == null ? null : source.getLine(pos));

         if (line == null)

             return;

         int col = source.getColumnNumber(pos, false);

         printRawLines(writer, line);

         for (int i = 0; i < col - 1; i++) {

             writer.print((line.charAt(i) == '\t') ? "\t" : " ");

         }

         writer.println("^");

         writer.flush();

     }

     public void printNewline() {

         noticeWriter.println();

     }

     public void printNewline(WriterKind wk) {

         getWriter(wk).println();

     }

     public void printLines(String key, Object... args) {

         printRawLines(noticeWriter, localize(key, args));

     }

     public void printLines(PrefixKind pk, String key, Object... args) {

         printRawLines(noticeWriter, localize(pk, key, args));

     }

     public void printLines(WriterKind wk, String key, Object... args) {

         printRawLines(getWriter(wk), localize(key, args));

     }

     public void printLines(WriterKind wk, PrefixKind pk, String key, Object... args) {

         printRawLines(getWriter(wk), localize(pk, key, args));

     }

     /** Print the text of a message, translating newlines appropriately

      *  for the platform.

      */

     public void printRawLines(String msg) {

         printRawLines(noticeWriter, msg);

     }

     /** Print the text of a message, translating newlines appropriately

      *  for the platform.

      */

     public void printRawLines(WriterKind kind, String msg) {

         printRawLines(getWriter(kind), msg);

     }

     /** Print the text of a message, translating newlines appropriately

      *  for the platform.

      */

     public static void printRawLines(PrintWriter writer, String msg) {

         int nl;

         while ((nl = msg.indexOf('\n')) != -1) {

             writer.println(msg.substring(0, nl));

             msg = msg.substring(nl+1);

         }

         if (msg.length() != 0) writer.println(msg);

     }

     /**

      * Print the localized text of a "verbose" message to the

      * noticeWriter stream.

      */

     public void printVerbose(String key, Object... args) {

         printRawLines(noticeWriter, localize("verbose." + key, args));

     }

     protected void directError(String key, Object... args) {

         printRawLines(errWriter, localize(key, args));

         errWriter.flush();

     }

     /** Report a warning that cannot be suppressed.

      *  @param pos    The source position at which to report the warning.

      *  @param key    The key for the localized warning message.

      *  @param args   Fields of the warning message.

      */

     public void strictWarning(DiagnosticPosition pos, String key, Object ... args) {

         writeDiagnostic(diags.warning(source, pos, key, args));

         nwarnings++;

     }

     /**

      * Primary method to report a diagnostic.

      * @param diagnostic

      */

     public void report(JCDiagnostic diagnostic) {

         diagnosticHandler.report(diagnostic);

      }

     /**

      * Common diagnostic handling.

      * The diagnostic is counted, and depending on the options and how many diagnostics have been

      * reported so far, the diagnostic may be handed off to writeDiagnostic.

      */

     private class DefaultDiagnosticHandler extends DiagnosticHandler {

         public void report(JCDiagnostic diagnostic) {

             if (expectDiagKeys != null)

                 expectDiagKeys.remove(diagnostic.getCode());

             switch (diagnostic.getType()) {

             case FRAGMENT:

                 throw new IllegalArgumentException();

             case NOTE:

                 // Print out notes only when we are permitted to report warnings

                 // Notes are only generated at the end of a compilation, so should be small

                 // in number.

                 if ((emitWarnings || diagnostic.isMandatory()) && !suppressNotes) {

                     writeDiagnostic(diagnostic);

                 }

                 break;

             case WARNING:

                 if (emitWarnings || diagnostic.isMandatory()) {

                     if (nwarnings < MaxWarnings) {

                         writeDiagnostic(diagnostic);

                         nwarnings++;

                     }

                 }

                 break;

             case ERROR:

                 if (nerrors < MaxErrors

                     && shouldReport(diagnostic.getSource(), diagnostic.getIntPosition())) {

                     writeDiagnostic(diagnostic);

                     nerrors++;

                 }

                 break;

             }

         }

     }

     /**

      * Write out a diagnostic.

      */

     protected void writeDiagnostic(JCDiagnostic diag) {

         if (diagListener != null) {

             diagListener.report(diag);

             return;

         }

         PrintWriter writer = getWriterForDiagnosticType(diag.getType());

         printRawLines(writer, diagFormatter.format(diag, messages.getCurrentLocale()));

         if (promptOnError) {

             switch (diag.getType()) {

             case ERROR:

             case WARNING:

                 prompt();

             }

         }

         if (dumpOnError)

             new RuntimeException().printStackTrace(writer);

         writer.flush();

     }

     @Deprecated

     protected PrintWriter getWriterForDiagnosticType(DiagnosticType dt) {

         switch (dt) {

         case FRAGMENT:

             throw new IllegalArgumentException();

         case NOTE:

             return noticeWriter;

         case WARNING:

             return warnWriter;

         case ERROR:

             return errWriter;

         default:

             throw new Error();

         }

     }

     /** Find a localized string in the resource bundle.

      *  Because this method is static, it ignores the locale.

      *  Use localize(key, args) when possible.

      *  @param key    The key for the localized string.

      *  @param args   Fields to substitute into the string.

      */

     public static String getLocalizedString(String key, Object ... args) {

         return JavacMessages.getDefaultLocalizedString(PrefixKind.COMPILER_MISC.key(key), args);

     }

     /** Find a localized string in the resource bundle.

      *  @param key    The key for the localized string.

      *  @param args   Fields to substitute into the string.

      */

     public String localize(String key, Object... args) {

         return localize(PrefixKind.COMPILER_MISC, key, args);

     }

     /** Find a localized string in the resource bundle.

      *  @param key    The key for the localized string.

      *  @param args   Fields to substitute into the string.

      */

     public String localize(PrefixKind pk, String key, Object... args) {

         if (useRawMessages)

             return pk.key(key);

         else

             return messages.getLocalizedString(pk.key(key), args);

     }

     // where

         // backdoor hook for testing, should transition to use -XDrawDiagnostics

         private static boolean useRawMessages = false;

 /***************************************************************************

  * raw error messages without internationalization; used for experimentation

  * and quick prototyping

  ***************************************************************************/

     /** print an error or warning message:

      */

     private void printRawError(int pos, String msg) {

         if (source == null || pos == Position.NOPOS) {

             printRawLines(errWriter, "error: " + msg);

         } else {

             int line = source.getLineNumber(pos);

             JavaFileObject file = source.getFile();

             if (file != null)

                 printRawLines(errWriter,

                            file.getName() + ":" +

                            line + ": " + msg);

             printErrLine(pos, errWriter);

         }

         errWriter.flush();

     }

     /** report an error:

      */

     public void rawError(int pos, String msg) {

         if (nerrors < MaxErrors && shouldReport(currentSourceFile(), pos)) {

             printRawError(pos, msg);

             prompt();

             nerrors++;

         }

         errWriter.flush();

     }

     /** report a warning:

      */

     public void rawWarning(int pos, String msg) {

         if (nwarnings < MaxWarnings && emitWarnings) {

             printRawError(pos, "warning: " + msg);

         }

         prompt();

         nwarnings++;

         errWriter.flush();

     }

     public static String format(String fmt, Object... args) {

         return String.format((java.util.Locale)null, fmt, args);

     }

 }