author | briangoetz |
Wed, 18 Dec 2013 16:05:18 -0500 | |
changeset 22163 | 3651128c74eb |
parent 14259 | fb94a1df0d53 |
permissions | -rw-r--r-- |
867 | 1 |
/* |
14259 | 2 |
* Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. |
867 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
867 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
867 | 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 |
* |
|
5520 | 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. |
|
867 | 24 |
*/ |
25 |
||
26 |
package com.sun.tools.javac.util; |
|
27 |
||
28 |
import java.util.HashMap; |
|
29 |
import java.util.Map; |
|
30 |
import javax.tools.JavaFileObject; |
|
31 |
||
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
32 |
import com.sun.tools.javac.code.Lint.LintCategory; |
7076
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
33 |
import com.sun.tools.javac.util.JCDiagnostic.DiagnosticFlag; |
867 | 34 |
import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition; |
35 |
import com.sun.tools.javac.util.JCDiagnostic.SimpleDiagnosticPosition; |
|
36 |
||
37 |
||
38 |
/** |
|
39 |
* A base class for error logs. Reports errors and warnings, and |
|
40 |
* keeps track of error numbers and positions. |
|
41 |
* |
|
5847
1908176fd6e3
6944312: Potential rebranding issues in openjdk/langtools repository sources
jjg
parents:
5520
diff
changeset
|
42 |
* <p><b>This is NOT part of any supported API. |
1908176fd6e3
6944312: Potential rebranding issues in openjdk/langtools repository sources
jjg
parents:
5520
diff
changeset
|
43 |
* If you write code that depends on this, you do so at your own risk. |
867 | 44 |
* This code and its internal interfaces are subject to change or |
45 |
* deletion without notice.</b> |
|
46 |
*/ |
|
47 |
public abstract class AbstractLog { |
|
22163 | 48 |
/** Factory for diagnostics |
49 |
*/ |
|
50 |
protected JCDiagnostic.Factory diags; |
|
51 |
||
52 |
/** The file that's currently being translated. |
|
53 |
*/ |
|
54 |
protected DiagnosticSource source; |
|
55 |
||
56 |
/** A cache of lightweight DiagnosticSource objects. |
|
57 |
*/ |
|
58 |
protected Map<JavaFileObject, DiagnosticSource> sourceMap; |
|
59 |
||
867 | 60 |
AbstractLog(JCDiagnostic.Factory diags) { |
61 |
this.diags = diags; |
|
22163 | 62 |
sourceMap = new HashMap<>(); |
867 | 63 |
} |
64 |
||
65 |
/** Re-assign source, returning previous setting. |
|
66 |
*/ |
|
67 |
public JavaFileObject useSource(JavaFileObject file) { |
|
68 |
JavaFileObject prev = (source == null ? null : source.getFile()); |
|
69 |
source = getSource(file); |
|
70 |
return prev; |
|
71 |
} |
|
72 |
||
73 |
protected DiagnosticSource getSource(JavaFileObject file) { |
|
74 |
if (file == null) |
|
3144
202fa249dc34
6852595: Accessing scope using JSR199 API on erroneous tree causes Illegal Argument Exception
mcimadamore
parents:
1591
diff
changeset
|
75 |
return DiagnosticSource.NO_SOURCE; |
867 | 76 |
DiagnosticSource s = sourceMap.get(file); |
77 |
if (s == null) { |
|
78 |
s = new DiagnosticSource(file, this); |
|
79 |
sourceMap.put(file, s); |
|
80 |
} |
|
81 |
return s; |
|
82 |
} |
|
83 |
||
1591 | 84 |
/** Return the underlying diagnostic source |
85 |
*/ |
|
86 |
public DiagnosticSource currentSource() { |
|
87 |
return source; |
|
88 |
} |
|
89 |
||
867 | 90 |
/** Report an error, unless another error was already reported at same |
91 |
* source position. |
|
92 |
* @param key The key for the localized error message. |
|
93 |
* @param args Fields of the error message. |
|
94 |
*/ |
|
95 |
public void error(String key, Object ... args) { |
|
96 |
report(diags.error(source, null, key, args)); |
|
97 |
} |
|
98 |
||
99 |
/** Report an error, unless another error was already reported at same |
|
100 |
* source position. |
|
101 |
* @param pos The source position at which to report the error. |
|
102 |
* @param key The key for the localized error message. |
|
103 |
* @param args Fields of the error message. |
|
104 |
*/ |
|
105 |
public void error(DiagnosticPosition pos, String key, Object ... args) { |
|
106 |
report(diags.error(source, pos, key, args)); |
|
107 |
} |
|
108 |
||
109 |
/** Report an error, unless another error was already reported at same |
|
110 |
* source position. |
|
10455
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
111 |
* @param flag A flag to set on the diagnostic |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
112 |
* @param pos The source position at which to report the error. |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
113 |
* @param key The key for the localized error message. |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
114 |
* @param args Fields of the error message. |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
115 |
*/ |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
116 |
public void error(DiagnosticFlag flag, DiagnosticPosition pos, String key, Object ... args) { |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
117 |
JCDiagnostic d = diags.error(source, pos, key, args); |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
118 |
d.setFlag(flag); |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
119 |
report(d); |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
120 |
} |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
121 |
|
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
122 |
/** Report an error, unless another error was already reported at same |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
123 |
* source position. |
867 | 124 |
* @param pos The source position at which to report the error. |
125 |
* @param key The key for the localized error message. |
|
126 |
* @param args Fields of the error message. |
|
127 |
*/ |
|
128 |
public void error(int pos, String key, Object ... args) { |
|
129 |
report(diags.error(source, wrap(pos), key, args)); |
|
130 |
} |
|
131 |
||
7076
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
132 |
/** Report an error, unless another error was already reported at same |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
133 |
* source position. |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
134 |
* @param flag A flag to set on the diagnostic |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
135 |
* @param pos The source position at which to report the error. |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
136 |
* @param key The key for the localized error message. |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
137 |
* @param args Fields of the error message. |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
138 |
*/ |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
139 |
public void error(DiagnosticFlag flag, int pos, String key, Object ... args) { |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
140 |
JCDiagnostic d = diags.error(source, wrap(pos), key, args); |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
141 |
d.setFlag(flag); |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
142 |
report(d); |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
143 |
} |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
144 |
|
867 | 145 |
/** Report a warning, unless suppressed by the -nowarn option or the |
146 |
* maximum number of warnings has been reached. |
|
147 |
* @param key The key for the localized warning message. |
|
148 |
* @param args Fields of the warning message. |
|
149 |
*/ |
|
150 |
public void warning(String key, Object ... args) { |
|
151 |
report(diags.warning(source, null, key, args)); |
|
152 |
} |
|
153 |
||
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
154 |
/** Report a lint warning, unless suppressed by the -nowarn option or the |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
155 |
* maximum number of warnings has been reached. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
156 |
* @param lc The lint category for the diagnostic |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
157 |
* @param key The key for the localized warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
158 |
* @param args Fields of the warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
159 |
*/ |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
160 |
public void warning(LintCategory lc, String key, Object ... args) { |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
161 |
report(diags.warning(lc, key, args)); |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
162 |
} |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
163 |
|
867 | 164 |
/** Report a warning, unless suppressed by the -nowarn option or the |
165 |
* maximum number of warnings has been reached. |
|
166 |
* @param pos The source position at which to report the warning. |
|
167 |
* @param key The key for the localized warning message. |
|
168 |
* @param args Fields of the warning message. |
|
169 |
*/ |
|
170 |
public void warning(DiagnosticPosition pos, String key, Object ... args) { |
|
171 |
report(diags.warning(source, pos, key, args)); |
|
172 |
} |
|
173 |
||
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
174 |
/** Report a lint warning, unless suppressed by the -nowarn option or the |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
175 |
* maximum number of warnings has been reached. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
176 |
* @param lc The lint category for the diagnostic |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
177 |
* @param pos The source position at which to report the warning. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
178 |
* @param key The key for the localized warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
179 |
* @param args Fields of the warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
180 |
*/ |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
181 |
public void warning(LintCategory lc, DiagnosticPosition pos, String key, Object ... args) { |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
182 |
report(diags.warning(lc, source, pos, key, args)); |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
183 |
} |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
184 |
|
867 | 185 |
/** Report a warning, unless suppressed by the -nowarn option or the |
186 |
* maximum number of warnings has been reached. |
|
187 |
* @param pos The source position at which to report the warning. |
|
188 |
* @param key The key for the localized warning message. |
|
189 |
* @param args Fields of the warning message. |
|
190 |
*/ |
|
191 |
public void warning(int pos, String key, Object ... args) { |
|
192 |
report(diags.warning(source, wrap(pos), key, args)); |
|
193 |
} |
|
194 |
||
195 |
/** Report a warning. |
|
196 |
* @param pos The source position at which to report the warning. |
|
197 |
* @param key The key for the localized warning message. |
|
198 |
* @param args Fields of the warning message. |
|
199 |
*/ |
|
200 |
public void mandatoryWarning(DiagnosticPosition pos, String key, Object ... args) { |
|
201 |
report(diags.mandatoryWarning(source, pos, key, args)); |
|
202 |
} |
|
203 |
||
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
204 |
/** Report a warning. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
205 |
* @param lc The lint category for the diagnostic |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
206 |
* @param pos The source position at which to report the warning. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
207 |
* @param key The key for the localized warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
208 |
* @param args Fields of the warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
209 |
*/ |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
210 |
public void mandatoryWarning(LintCategory lc, DiagnosticPosition pos, String key, Object ... args) { |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
211 |
report(diags.mandatoryWarning(lc, source, pos, key, args)); |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
212 |
} |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
213 |
|
867 | 214 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
215 |
* @param key The key for the localized notification message. |
|
216 |
* @param args Fields of the notint an error or warning message: |
|
217 |
*/ |
|
218 |
public void note(String key, Object ... args) { |
|
219 |
report(diags.note(source, null, key, args)); |
|
220 |
} |
|
221 |
||
222 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
|
223 |
* @param key The key for the localized notification message. |
|
224 |
* @param args Fields of the notification message. |
|
225 |
*/ |
|
226 |
public void note(DiagnosticPosition pos, String key, Object ... args) { |
|
227 |
report(diags.note(source, pos, key, args)); |
|
228 |
} |
|
229 |
||
230 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
|
231 |
* @param key The key for the localized notification message. |
|
232 |
* @param args Fields of the notification message. |
|
233 |
*/ |
|
234 |
public void note(int pos, String key, Object ... args) { |
|
235 |
report(diags.note(source, wrap(pos), key, args)); |
|
236 |
} |
|
237 |
||
238 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
|
239 |
* @param key The key for the localized notification message. |
|
240 |
* @param args Fields of the notification message. |
|
241 |
*/ |
|
242 |
public void note(JavaFileObject file, String key, Object ... args) { |
|
243 |
report(diags.note(getSource(file), null, key, args)); |
|
244 |
} |
|
245 |
||
246 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
|
247 |
* @param key The key for the localized notification message. |
|
248 |
* @param args Fields of the notification message. |
|
249 |
*/ |
|
250 |
public void mandatoryNote(final JavaFileObject file, String key, Object ... args) { |
|
251 |
report(diags.mandatoryNote(getSource(file), key, args)); |
|
252 |
} |
|
253 |
||
254 |
protected abstract void report(JCDiagnostic diagnostic); |
|
255 |
||
256 |
protected abstract void directError(String key, Object... args); |
|
257 |
||
258 |
private DiagnosticPosition wrap(int pos) { |
|
259 |
return (pos == Position.NOPOS ? null : new SimpleDiagnosticPosition(pos)); |
|
260 |
} |
|
261 |
} |