jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/javac/util/Log.java@6ada6122dd4f (annotated)

src/share/classes/com/sun/tools/javac/util/Log.java@6ada6122dd4f (annotated)

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

Fri, 13 Feb 2009 11:57:33 +0000

author: mcimadamore
date: Fri, 13 Feb 2009 11:57:33 +0000
changeset 221: 6ada6122dd4f
parent 194: d0b33fe8e710
child 229: 03bcd66bd8e7
permissions: -rw-r--r--

6769027: Source line should be displayed immediately after the first diagnostic line
Summary: Added support for customizing diagnostic output via API/command line flags
Reviewed-by: jjg

 /*
  * Copyright 1999-2008 Sun Microsystems, Inc.  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.  Sun designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  * CA 95054 USA or visit www.sun.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.HashSet;
 import java.util.Map;
 import java.util.Set;
 import javax.tools.DiagnosticListener;
 import javax.tools.JavaFileObject;
 import com.sun.tools.javac.file.JavacFileManager;
 import com.sun.tools.javac.tree.JCTree;
 import com.sun.tools.javac.api.DiagnosticFormatter;
 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
 import com.sun.tools.javac.util.JCDiagnostic.DiagnosticType;
 /** 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 API supported by Sun Microsystems.  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>();
     //@Deprecated
     public final PrintWriter errWriter;
     //@Deprecated
     public final PrintWriter warnWriter;
     //@Deprecated
     public final PrintWriter noticeWriter;
     /** The maximum number of errors/warnings that are reported.
      */
     public final int MaxErrors;
     public final int MaxWarnings;
     /** Switch: prompt user on each error.
      */
     public boolean promptOnError;
     /** Switch: emit warning messages.
      */
     public boolean emitWarnings;
     /** 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;
     /** Construct a log with given I/O redirections.
      */
     @Deprecated
     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;
         Options options = Options.instance(context);
         this.dumpOnError = options.get("-doe") != null;
         this.promptOnError = options.get("-prompt") != null;
         this.emitWarnings = options.get("-Xlint:none") == null;
         this.MaxErrors = getIntOption(options, "-Xmaxerrs", 100);
         this.MaxWarnings = getIntOption(options, "-Xmaxwarns", 100);
         boolean rawDiagnostics = options.get("rawDiagnostics") != null;
         messages = JavacMessages.instance(context);
         this.diagFormatter = rawDiagnostics ? new RawDiagnosticFormatter(options) :
                                               new BasicDiagnosticFormatter(options, messages);
         @SuppressWarnings("unchecked") // FIXME
         DiagnosticListener<? super JavaFileObject> dl =
             context.get(DiagnosticListener.class);
         this.diagListener = dl;
         String ek = options.get("expectKeys");
         if (ek != null)
             expectDiagKeys = new HashSet<String>(Arrays.asList(ek.split(", *")));
     }
     // where
         private int getIntOption(Options options, String optionName, int defaultValue) {
             String s = options.get(optionName);
             try {
                 if (s != null) return Integer.parseInt(s);
             } catch (NumberFormatException e) {
                 // silently ignore ill-formed numbers
             }
             return defaultValue;
         }
     /** The default writer for diagnostics
      */
     static final 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, Map<JCTree, Integer> table) {
         name.getClass(); // null check
         getSource(name).setEndPosTable(table);
     }
     /** 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;
     }
     /** Flush the logs
      */
     public void flush() {
         errWriter.flush();
         warnWriter.flush();
         noticeWriter.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(getLocalizedString("resume.abort"));
             char ch;
             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);
         printLines(writer, line);
         for (int i = 0; i < col - 1; i++) {
             writer.print((line.charAt(i) == '\t') ? "\t" : " ");
         }
         writer.println("^");
         writer.flush();
     }
     /** Print the text of a message, translating newlines appropriately
      *  for the platform.
      */
     public static void printLines(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);
     }
     protected void directError(String key, Object... args) {
         printLines(errWriter, getLocalizedString(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++;
     }
     /**
      * 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.
      */
     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()) {
                 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) {
             try {
                 diagListener.report(diag);
                 return;
             }
             catch (Throwable t) {
                 throw new ClientCodeException(t);
             }
         }
         PrintWriter writer = getWriterForDiagnosticType(diag.getType());
         printLines(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.
      *  @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("compiler.misc." + key, args);
     }
 /***************************************************************************
  * 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) {
             printLines(errWriter, "error: " + msg);
         } else {
             int line = source.getLineNumber(pos);
             JavaFileObject file = source.getFile();
             if (file != null)
                 printLines(errWriter,
                            JavacFileManager.getJavacFileName(file) + ":" +
                            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);
     }
 }

Mercurial > jdk8-mips64-public > langtools / annotate

src/share/classes/com/sun/tools/javac/util/Log.java@6ada6122dd4f (annotated)

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