262 lines
10 KiB
Java
262 lines
10 KiB
Java
/*
|
|
* Copyright (c) 1999, 2012, 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.util.HashMap;
|
|
import java.util.Map;
|
|
import javax.tools.JavaFileObject;
|
|
|
|
import com.sun.tools.javac.code.Lint.LintCategory;
|
|
import com.sun.tools.javac.util.JCDiagnostic.DiagnosticFlag;
|
|
import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition;
|
|
import com.sun.tools.javac.util.JCDiagnostic.SimpleDiagnosticPosition;
|
|
|
|
|
|
/**
|
|
* A base 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 abstract class AbstractLog {
|
|
AbstractLog(JCDiagnostic.Factory diags) {
|
|
this.diags = diags;
|
|
sourceMap = new HashMap<JavaFileObject, DiagnosticSource>();
|
|
}
|
|
|
|
/** Re-assign source, returning previous setting.
|
|
*/
|
|
public JavaFileObject useSource(JavaFileObject file) {
|
|
JavaFileObject prev = (source == null ? null : source.getFile());
|
|
source = getSource(file);
|
|
return prev;
|
|
}
|
|
|
|
protected DiagnosticSource getSource(JavaFileObject file) {
|
|
if (file == null)
|
|
return DiagnosticSource.NO_SOURCE;
|
|
DiagnosticSource s = sourceMap.get(file);
|
|
if (s == null) {
|
|
s = new DiagnosticSource(file, this);
|
|
sourceMap.put(file, s);
|
|
}
|
|
return s;
|
|
}
|
|
|
|
/** Return the underlying diagnostic source
|
|
*/
|
|
public DiagnosticSource currentSource() {
|
|
return source;
|
|
}
|
|
|
|
/** Report an error, unless another error was already reported at same
|
|
* source position.
|
|
* @param key The key for the localized error message.
|
|
* @param args Fields of the error message.
|
|
*/
|
|
public void error(String key, Object ... args) {
|
|
report(diags.error(source, null, key, args));
|
|
}
|
|
|
|
/** Report an error, unless another error was already reported at same
|
|
* source position.
|
|
* @param pos The source position at which to report the error.
|
|
* @param key The key for the localized error message.
|
|
* @param args Fields of the error message.
|
|
*/
|
|
public void error(DiagnosticPosition pos, String key, Object ... args) {
|
|
report(diags.error(source, pos, key, args));
|
|
}
|
|
|
|
/** Report an error, unless another error was already reported at same
|
|
* source position.
|
|
* @param flag A flag to set on the diagnostic
|
|
* @param pos The source position at which to report the error.
|
|
* @param key The key for the localized error message.
|
|
* @param args Fields of the error message.
|
|
*/
|
|
public void error(DiagnosticFlag flag, DiagnosticPosition pos, String key, Object ... args) {
|
|
JCDiagnostic d = diags.error(source, pos, key, args);
|
|
d.setFlag(flag);
|
|
report(d);
|
|
}
|
|
|
|
/** Report an error, unless another error was already reported at same
|
|
* source position.
|
|
* @param pos The source position at which to report the error.
|
|
* @param key The key for the localized error message.
|
|
* @param args Fields of the error message.
|
|
*/
|
|
public void error(int pos, String key, Object ... args) {
|
|
report(diags.error(source, wrap(pos), key, args));
|
|
}
|
|
|
|
/** Report an error, unless another error was already reported at same
|
|
* source position.
|
|
* @param flag A flag to set on the diagnostic
|
|
* @param pos The source position at which to report the error.
|
|
* @param key The key for the localized error message.
|
|
* @param args Fields of the error message.
|
|
*/
|
|
public void error(DiagnosticFlag flag, int pos, String key, Object ... args) {
|
|
JCDiagnostic d = diags.error(source, wrap(pos), key, args);
|
|
d.setFlag(flag);
|
|
report(d);
|
|
}
|
|
|
|
/** Report a warning, unless suppressed by the -nowarn option or the
|
|
* maximum number of warnings has been reached.
|
|
* @param key The key for the localized warning message.
|
|
* @param args Fields of the warning message.
|
|
*/
|
|
public void warning(String key, Object ... args) {
|
|
report(diags.warning(source, null, key, args));
|
|
}
|
|
|
|
/** Report a lint warning, unless suppressed by the -nowarn option or the
|
|
* maximum number of warnings has been reached.
|
|
* @param lc The lint category for the diagnostic
|
|
* @param key The key for the localized warning message.
|
|
* @param args Fields of the warning message.
|
|
*/
|
|
public void warning(LintCategory lc, String key, Object ... args) {
|
|
report(diags.warning(lc, key, args));
|
|
}
|
|
|
|
/** Report a warning, unless suppressed by the -nowarn option or the
|
|
* maximum number of warnings has been reached.
|
|
* @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 warning(DiagnosticPosition pos, String key, Object ... args) {
|
|
report(diags.warning(source, pos, key, args));
|
|
}
|
|
|
|
/** Report a lint warning, unless suppressed by the -nowarn option or the
|
|
* maximum number of warnings has been reached.
|
|
* @param lc The lint category for the diagnostic
|
|
* @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 warning(LintCategory lc, DiagnosticPosition pos, String key, Object ... args) {
|
|
report(diags.warning(lc, source, pos, key, args));
|
|
}
|
|
|
|
/** Report a warning, unless suppressed by the -nowarn option or the
|
|
* maximum number of warnings has been reached.
|
|
* @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 warning(int pos, String key, Object ... args) {
|
|
report(diags.warning(source, wrap(pos), key, args));
|
|
}
|
|
|
|
/** Report a warning.
|
|
* @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 mandatoryWarning(DiagnosticPosition pos, String key, Object ... args) {
|
|
report(diags.mandatoryWarning(source, pos, key, args));
|
|
}
|
|
|
|
/** Report a warning.
|
|
* @param lc The lint category for the diagnostic
|
|
* @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 mandatoryWarning(LintCategory lc, DiagnosticPosition pos, String key, Object ... args) {
|
|
report(diags.mandatoryWarning(lc, source, pos, key, args));
|
|
}
|
|
|
|
/** Provide a non-fatal notification, unless suppressed by the -nowarn option.
|
|
* @param key The key for the localized notification message.
|
|
* @param args Fields of the notint an error or warning message:
|
|
*/
|
|
public void note(String key, Object ... args) {
|
|
report(diags.note(source, null, key, args));
|
|
}
|
|
|
|
/** Provide a non-fatal notification, unless suppressed by the -nowarn option.
|
|
* @param key The key for the localized notification message.
|
|
* @param args Fields of the notification message.
|
|
*/
|
|
public void note(DiagnosticPosition pos, String key, Object ... args) {
|
|
report(diags.note(source, pos, key, args));
|
|
}
|
|
|
|
/** Provide a non-fatal notification, unless suppressed by the -nowarn option.
|
|
* @param key The key for the localized notification message.
|
|
* @param args Fields of the notification message.
|
|
*/
|
|
public void note(int pos, String key, Object ... args) {
|
|
report(diags.note(source, wrap(pos), key, args));
|
|
}
|
|
|
|
/** Provide a non-fatal notification, unless suppressed by the -nowarn option.
|
|
* @param key The key for the localized notification message.
|
|
* @param args Fields of the notification message.
|
|
*/
|
|
public void note(JavaFileObject file, String key, Object ... args) {
|
|
report(diags.note(getSource(file), null, key, args));
|
|
}
|
|
|
|
/** Provide a non-fatal notification, unless suppressed by the -nowarn option.
|
|
* @param key The key for the localized notification message.
|
|
* @param args Fields of the notification message.
|
|
*/
|
|
public void mandatoryNote(final JavaFileObject file, String key, Object ... args) {
|
|
report(diags.mandatoryNote(getSource(file), key, args));
|
|
}
|
|
|
|
protected abstract void report(JCDiagnostic diagnostic);
|
|
|
|
protected abstract void directError(String key, Object... args);
|
|
|
|
private DiagnosticPosition wrap(int pos) {
|
|
return (pos == Position.NOPOS ? null : new SimpleDiagnosticPosition(pos));
|
|
}
|
|
|
|
/** Factory for diagnostics
|
|
*/
|
|
protected JCDiagnostic.Factory diags;
|
|
|
|
/** The file that's currently being translated.
|
|
*/
|
|
protected DiagnosticSource source;
|
|
|
|
/** A cache of lightweight DiagnosticSource objects.
|
|
*/
|
|
protected Map<JavaFileObject, DiagnosticSource> sourceMap;
|
|
}
|