Mercurial > jdk8-mips64-public > langtools / file revision
src/share/classes/com/sun/tools/javac/util/JCDiagnostic.java@c75be5bc5283
src/share/classes/com/sun/tools/javac/util/JCDiagnostic.java
Tue, 09 Oct 2012 19:10:00 -0700
- author
- jjg
- date
- Tue, 09 Oct 2012 19:10:00 -0700
- changeset 1357
- c75be5bc5283
- parent 1280
- 5c0b3faeb0b0
- child 1358
- fc123bdeddb8
- permissions
- -rw-r--r--
8000663: clean up langtools imports
Reviewed-by: darcy
1 /*
2 * Copyright (c) 2003, 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.util.EnumSet;
29 import java.util.Locale;
30 import java.util.Set;
32 import javax.tools.Diagnostic;
33 import javax.tools.JavaFileObject;
35 import com.sun.tools.javac.api.DiagnosticFormatter;
36 import com.sun.tools.javac.code.Lint.LintCategory;
37 import com.sun.tools.javac.tree.EndPosTable;
38 import com.sun.tools.javac.tree.JCTree;
40 import static com.sun.tools.javac.util.JCDiagnostic.DiagnosticType.*;
42 /** An abstraction of a diagnostic message generated by the compiler.
43 *
44 * <p><b>This is NOT part of any supported API.
45 * If you write code that depends on this, you do so at your own risk.
46 * This code and its internal interfaces are subject to change or
47 * deletion without notice.</b>
48 */
49 public class JCDiagnostic implements Diagnostic<JavaFileObject> {
50 /** A factory for creating diagnostic objects. */
51 public static class Factory {
52 /** The context key for the diagnostic factory. */
53 protected static final Context.Key<JCDiagnostic.Factory> diagnosticFactoryKey =
54 new Context.Key<JCDiagnostic.Factory>();
56 /** Get the Factory instance for this context. */
57 public static Factory instance(Context context) {
58 Factory instance = context.get(diagnosticFactoryKey);
59 if (instance == null)
60 instance = new Factory(context);
61 return instance;
62 }
64 DiagnosticFormatter<JCDiagnostic> formatter;
65 final String prefix;
66 final Set<DiagnosticFlag> defaultErrorFlags;
68 /** Create a new diagnostic factory. */
69 protected Factory(Context context) {
70 this(JavacMessages.instance(context), "compiler");
71 context.put(diagnosticFactoryKey, this);
73 final Options options = Options.instance(context);
74 initOptions(options);
75 options.addListener(new Runnable() {
76 public void run() {
77 initOptions(options);
78 }
79 });
80 }
82 private void initOptions(Options options) {
83 if (options.isSet("onlySyntaxErrorsUnrecoverable"))
84 defaultErrorFlags.add(DiagnosticFlag.RECOVERABLE);
85 }
87 /** Create a new diagnostic factory. */
88 public Factory(JavacMessages messages, String prefix) {
89 this.prefix = prefix;
90 this.formatter = new BasicDiagnosticFormatter(messages);
91 defaultErrorFlags = EnumSet.of(DiagnosticFlag.MANDATORY);
92 }
94 /**
95 * Create an error diagnostic.
96 * @param source The source of the compilation unit, if any, in which to report the error.
97 * @param pos The source position at which to report the error.
98 * @param key The key for the localized error message.
99 * @param args Fields of the error message.
100 */
101 public JCDiagnostic error(
102 DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {
103 return create(ERROR, null, defaultErrorFlags, source, pos, key, args);
104 }
106 /**
107 * Create a warning diagnostic that will not be hidden by the -nowarn or -Xlint:none options.
108 * @param source The source of the compilation unit, if any, in which to report the warning.
109 * @param pos The source position at which to report the warning.
110 * @param key The key for the localized warning message.
111 * @param args Fields of the warning message.
112 * @see MandatoryWarningHandler
113 */
114 public JCDiagnostic mandatoryWarning(
115 DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {
116 return create(WARNING, null, EnumSet.of(DiagnosticFlag.MANDATORY), source, pos, key, args);
117 }
119 /**
120 * Create a warning diagnostic that will not be hidden by the -nowarn or -Xlint:none options.
121 * @param lc The lint category for the diagnostic
122 * @param source The source of the compilation unit, if any, in which to report the warning.
123 * @param pos The source position at which to report the warning.
124 * @param key The key for the localized warning message.
125 * @param args Fields of the warning message.
126 * @see MandatoryWarningHandler
127 */
128 public JCDiagnostic mandatoryWarning(
129 LintCategory lc,
130 DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {
131 return create(WARNING, lc, EnumSet.of(DiagnosticFlag.MANDATORY), source, pos, key, args);
132 }
134 /**
135 * Create a warning diagnostic.
136 * @param lc The lint category for the diagnostic
137 * @param key The key for the localized error message.
138 * @param args Fields of the warning message.
139 * @see MandatoryWarningHandler
140 */
141 public JCDiagnostic warning(
142 LintCategory lc, String key, Object... args) {
143 return create(WARNING, lc, EnumSet.noneOf(DiagnosticFlag.class), null, null, key, args);
144 }
146 /**
147 * Create a warning diagnostic.
148 * @param source The source of the compilation unit, if any, in which to report the warning.
149 * @param pos The source position at which to report the warning.
150 * @param key The key for the localized warning message.
151 * @param args Fields of the warning message.
152 */
153 public JCDiagnostic warning(
154 DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {
155 return create(WARNING, null, EnumSet.noneOf(DiagnosticFlag.class), source, pos, key, args);
156 }
158 /**
159 * Create a warning diagnostic.
160 * @param lc The lint category for the diagnostic
161 * @param source The source of the compilation unit, if any, in which to report the warning.
162 * @param pos The source position at which to report the warning.
163 * @param key The key for the localized warning message.
164 * @param args Fields of the warning message.
165 * @see MandatoryWarningHandler
166 */
167 public JCDiagnostic warning(
168 LintCategory lc, DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {
169 return create(WARNING, lc, EnumSet.noneOf(DiagnosticFlag.class), source, pos, key, args);
170 }
172 /**
173 * Create a note diagnostic that will not be hidden by the -nowarn or -Xlint:none options.
174 * @param key The key for the localized message.
175 * @param args Fields of the message.
176 * @see MandatoryWarningHandler
177 */
178 public JCDiagnostic mandatoryNote(DiagnosticSource source, String key, Object... args) {
179 return create(NOTE, null, EnumSet.of(DiagnosticFlag.MANDATORY), source, null, key, args);
180 }
182 /**
183 * Create a note diagnostic.
184 * @param key The key for the localized error message.
185 * @param args Fields of the message.
186 */
187 public JCDiagnostic note(String key, Object... args) {
188 return create(NOTE, null, EnumSet.noneOf(DiagnosticFlag.class), null, null, key, args);
189 }
191 /**
192 * Create a note diagnostic.
193 * @param source The source of the compilation unit, if any, in which to report the note.
194 * @param pos The source position at which to report the note.
195 * @param key The key for the localized message.
196 * @param args Fields of the message.
197 */
198 public JCDiagnostic note(
199 DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {
200 return create(NOTE, null, EnumSet.noneOf(DiagnosticFlag.class), source, pos, key, args);
201 }
203 /**
204 * Create a fragment diagnostic, for use as an argument in other diagnostics
205 * @param key The key for the localized message.
206 * @param args Fields of the message.
207 */
208 public JCDiagnostic fragment(String key, Object... args) {
209 return create(FRAGMENT, null, EnumSet.noneOf(DiagnosticFlag.class), null, null, key, args);
210 }
212 /**
213 * Create a new diagnostic of the given kind, which is not mandatory and which has
214 * no lint category.
215 * @param kind The diagnostic kind
216 * @param ls The lint category, if applicable, or null
217 * @param source The source of the compilation unit, if any, in which to report the message.
218 * @param pos The source position at which to report the message.
219 * @param key The key for the localized message.
220 * @param args Fields of the message.
221 */
222 public JCDiagnostic create(
223 DiagnosticType kind, DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {
224 return create(kind, null, EnumSet.noneOf(DiagnosticFlag.class), source, pos, key, args);
225 }
227 /**
228 * Create a new diagnostic of the given kind.
229 * @param kind The diagnostic kind
230 * @param lc The lint category, if applicable, or null
231 * @param isMandatory is diagnostic mandatory?
232 * @param source The source of the compilation unit, if any, in which to report the message.
233 * @param pos The source position at which to report the message.
234 * @param key The key for the localized message.
235 * @param args Fields of the message.
236 */
237 public JCDiagnostic create(
238 DiagnosticType kind, LintCategory lc, Set<DiagnosticFlag> flags, DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {
239 return new JCDiagnostic(formatter, kind, lc, flags, source, pos, qualify(kind, key), args);
240 }
242 protected String qualify(DiagnosticType t, String key) {
243 return prefix + "." + t.key + "." + key;
244 }
245 }
249 /**
250 * Create a fragment diagnostic, for use as an argument in other diagnostics
251 * @param key The key for the localized error message.
252 * @param args Fields of the error message.
253 *
254 */
255 @Deprecated
256 public static JCDiagnostic fragment(String key, Object... args) {
257 return new JCDiagnostic(getFragmentFormatter(),
258 FRAGMENT,
259 null,
260 EnumSet.noneOf(DiagnosticFlag.class),
261 null,
262 null,
263 "compiler." + FRAGMENT.key + "." + key,
264 args);
265 }
266 //where
267 @Deprecated
268 public static DiagnosticFormatter<JCDiagnostic> getFragmentFormatter() {
269 if (fragmentFormatter == null) {
270 fragmentFormatter = new BasicDiagnosticFormatter(JavacMessages.getDefaultMessages());
271 }
272 return fragmentFormatter;
273 }
275 /**
276 * A DiagnosticType defines the type of the diagnostic.
277 **/
278 public enum DiagnosticType {
279 /** A fragment of an enclosing diagnostic. */
280 FRAGMENT("misc"),
281 /** A note: similar to, but less serious than, a warning. */
282 NOTE("note"),
283 /** A warning. */
284 WARNING("warn"),
285 /** An error. */
286 ERROR("err");
288 final String key;
290 /** Create a DiagnosticType.
291 * @param key A string used to create the resource key for the diagnostic.
292 */
293 DiagnosticType(String key) {
294 this.key = key;
295 }
296 };
298 /**
299 * A DiagnosticPosition provides information about the positions in a file
300 * that gave rise to a diagnostic. It always defines a "preferred" position
301 * that most accurately defines the location of the diagnostic, it may also
302 * provide a related tree node that spans that location.
303 */
304 public static interface DiagnosticPosition {
305 /** Gets the tree node, if any, to which the diagnostic applies. */
306 JCTree getTree();
307 /** If there is a tree node, get the start position of the tree node.
308 * Otherwise, just returns the same as getPreferredPosition(). */
309 int getStartPosition();
310 /** Get the position within the file that most accurately defines the
311 * location for the diagnostic. */
312 int getPreferredPosition();
313 /** If there is a tree node, and if endPositions are available, get
314 * the end position of the tree node. Otherwise, just returns the
315 * same as getPreferredPosition(). */
316 int getEndPosition(EndPosTable endPosTable);
317 }
319 /**
320 * A DiagnosticPosition that simply identifies a position, but no related
321 * tree node, as the location for a diagnostic. Used for scanner and parser
322 * diagnostics. */
323 public static class SimpleDiagnosticPosition implements DiagnosticPosition {
324 public SimpleDiagnosticPosition(int pos) {
325 this.pos = pos;
326 }
328 public JCTree getTree() {
329 return null;
330 }
332 public int getStartPosition() {
333 return pos;
334 }
336 public int getPreferredPosition() {
337 return pos;
338 }
340 public int getEndPosition(EndPosTable endPosTable) {
341 return pos;
342 }
344 private final int pos;
345 }
347 public enum DiagnosticFlag {
348 MANDATORY,
349 RESOLVE_ERROR,
350 SYNTAX,
351 RECOVERABLE
352 }
354 private final DiagnosticType type;
355 private final DiagnosticSource source;
356 private final DiagnosticPosition position;
357 private final int line;
358 private final int column;
359 private final String key;
360 protected final Object[] args;
361 private final Set<DiagnosticFlag> flags;
362 private final LintCategory lintCategory;
364 /**
365 * Create a diagnostic object.
366 * @param fomatter the formatter to use for the diagnostic
367 * @param dt the type of diagnostic
368 * @param lc the lint category for the diagnostic
369 * @param source the name of the source file, or null if none.
370 * @param pos the character offset within the source file, if given.
371 * @param key a resource key to identify the text of the diagnostic
372 * @param args arguments to be included in the text of the diagnostic
373 */
374 protected JCDiagnostic(DiagnosticFormatter<JCDiagnostic> formatter,
375 DiagnosticType dt,
376 LintCategory lc,
377 Set<DiagnosticFlag> flags,
378 DiagnosticSource source,
379 DiagnosticPosition pos,
380 String key,
381 Object... args) {
382 if (source == null && pos != null && pos.getPreferredPosition() != Position.NOPOS)
383 throw new IllegalArgumentException();
385 this.defaultFormatter = formatter;
386 this.type = dt;
387 this.lintCategory = lc;
388 this.flags = flags;
389 this.source = source;
390 this.position = pos;
391 this.key = key;
392 this.args = args;
394 int n = (pos == null ? Position.NOPOS : pos.getPreferredPosition());
395 if (n == Position.NOPOS || source == null)
396 line = column = -1;
397 else {
398 line = source.getLineNumber(n);
399 column = source.getColumnNumber(n, true);
400 }
401 }
403 /**
404 * Get the type of this diagnostic.
405 * @return the type of this diagnostic
406 */
407 public DiagnosticType getType() {
408 return type;
409 }
411 /**
412 * Get the subdiagnostic list
413 * @return subdiagnostic list
414 */
415 public List<JCDiagnostic> getSubdiagnostics() {
416 return List.nil();
417 }
419 public boolean isMultiline() {
420 return false;
421 }
423 /**
424 * Check whether or not this diagnostic is required to be shown.
425 * @return true if this diagnostic is required to be shown.
426 */
427 public boolean isMandatory() {
428 return flags.contains(DiagnosticFlag.MANDATORY);
429 }
431 /**
432 * Check whether this diagnostic has an associated lint category.
433 */
434 public boolean hasLintCategory() {
435 return (lintCategory != null);
436 }
438 /**
439 * Get the associated lint category, or null if none.
440 */
441 public LintCategory getLintCategory() {
442 return lintCategory;
443 }
445 /**
446 * Get the name of the source file referred to by this diagnostic.
447 * @return the name of the source referred to with this diagnostic, or null if none
448 */
449 public JavaFileObject getSource() {
450 if (source == null)
451 return null;
452 else
453 return source.getFile();
454 }
456 /**
457 * Get the source referred to by this diagnostic.
458 * @return the source referred to with this diagnostic, or null if none
459 */
460 public DiagnosticSource getDiagnosticSource() {
461 return source;
462 }
464 protected int getIntStartPosition() {
465 return (position == null ? Position.NOPOS : position.getStartPosition());
466 }
468 protected int getIntPosition() {
469 return (position == null ? Position.NOPOS : position.getPreferredPosition());
470 }
472 protected int getIntEndPosition() {
473 return (position == null ? Position.NOPOS : position.getEndPosition(source.getEndPosTable()));
474 }
476 public long getStartPosition() {
477 return getIntStartPosition();
478 }
480 public long getPosition() {
481 return getIntPosition();
482 }
484 public long getEndPosition() {
485 return getIntEndPosition();
486 }
488 /**
489 * Get the line number within the source referred to by this diagnostic.
490 * @return the line number within the source referred to by this diagnostic
491 */
492 public long getLineNumber() {
493 return line;
494 }
496 /**
497 * Get the column number within the line of source referred to by this diagnostic.
498 * @return the column number within the line of source referred to by this diagnostic
499 */
500 public long getColumnNumber() {
501 return column;
502 }
504 /**
505 * Get the arguments to be included in the text of the diagnostic.
506 * @return the arguments to be included in the text of the diagnostic
507 */
508 public Object[] getArgs() {
509 return args;
510 }
512 /**
513 * Get the prefix string associated with this type of diagnostic.
514 * @return the prefix string associated with this type of diagnostic
515 */
516 public String getPrefix() {
517 return getPrefix(type);
518 }
520 /**
521 * Get the prefix string associated with a particular type of diagnostic.
522 * @return the prefix string associated with a particular type of diagnostic
523 */
524 public String getPrefix(DiagnosticType dt) {
525 return defaultFormatter.formatKind(this, Locale.getDefault());
526 }
528 /**
529 * Return the standard presentation of this diagnostic.
530 */
531 @Override
532 public String toString() {
533 return defaultFormatter.format(this,Locale.getDefault());
534 }
536 private DiagnosticFormatter<JCDiagnostic> defaultFormatter;
537 @Deprecated
538 private static DiagnosticFormatter<JCDiagnostic> fragmentFormatter;
540 // Methods for javax.tools.Diagnostic
542 public Diagnostic.Kind getKind() {
543 switch (type) {
544 case NOTE:
545 return Diagnostic.Kind.NOTE;
546 case WARNING:
547 return flags.contains(DiagnosticFlag.MANDATORY)
548 ? Diagnostic.Kind.MANDATORY_WARNING
549 : Diagnostic.Kind.WARNING;
550 case ERROR:
551 return Diagnostic.Kind.ERROR;
552 default:
553 return Diagnostic.Kind.OTHER;
554 }
555 }
557 public String getCode() {
558 return key;
559 }
561 public String getMessage(Locale locale) {
562 return defaultFormatter.formatMessage(this, locale);
563 }
565 public void setFlag(DiagnosticFlag flag) {
566 flags.add(flag);
568 if (type == DiagnosticType.ERROR) {
569 switch (flag) {
570 case SYNTAX:
571 flags.remove(DiagnosticFlag.RECOVERABLE);
572 break;
573 case RESOLVE_ERROR:
574 flags.add(DiagnosticFlag.RECOVERABLE);
575 break;
576 }
577 }
578 }
580 public boolean isFlagSet(DiagnosticFlag flag) {
581 return flags.contains(flag);
582 }
584 public static class MultilineDiagnostic extends JCDiagnostic {
586 private final List<JCDiagnostic> subdiagnostics;
588 public MultilineDiagnostic(JCDiagnostic other, List<JCDiagnostic> subdiagnostics) {
589 super(other.defaultFormatter,
590 other.getType(),
591 other.getLintCategory(),
592 other.flags,
593 other.getDiagnosticSource(),
594 other.position,
595 other.getCode(),
596 other.getArgs());
597 this.subdiagnostics = subdiagnostics;
598 }
600 @Override
601 public List<JCDiagnostic> getSubdiagnostics() {
602 return subdiagnostics;
603 }
605 @Override
606 public boolean isMultiline() {
607 return true;
608 }
609 }
610 }
