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

Tue, 16 Jun 2009 10:46:37 +0100

author
mcimadamore
date
Tue, 16 Jun 2009 10:46:37 +0100
changeset 299
22872b24d38c
parent 288
d402db1005ad
child 333
7c2d6da61646
permissions
-rw-r--r--

6638712: Inference with wildcard types causes selection of inapplicable method
Summary: Added global sanity check in order to make sure that return type inference does not violate bounds constraints
Reviewed-by: jjg

mcimadamore@83 1 /*
xdono@229 2 * Copyright 2005-2009 Sun Microsystems, Inc. All Rights Reserved.
mcimadamore@83 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
mcimadamore@83 4 *
mcimadamore@83 5 * This code is free software; you can redistribute it and/or modify it
mcimadamore@83 6 * under the terms of the GNU General Public License version 2 only, as
mcimadamore@83 7 * published by the Free Software Foundation. Sun designates this
mcimadamore@83 8 * particular file as subject to the "Classpath" exception as provided
mcimadamore@83 9 * by Sun in the LICENSE file that accompanied this code.
mcimadamore@83 10 *
mcimadamore@83 11 * This code is distributed in the hope that it will be useful, but WITHOUT
mcimadamore@83 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
mcimadamore@83 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
mcimadamore@83 14 * version 2 for more details (a copy is included in the LICENSE file that
mcimadamore@83 15 * accompanied this code).
mcimadamore@83 16 *
mcimadamore@83 17 * You should have received a copy of the GNU General Public License version
mcimadamore@83 18 * 2 along with this work; if not, write to the Free Software Foundation,
mcimadamore@83 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
mcimadamore@83 20 *
mcimadamore@83 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
mcimadamore@83 22 * CA 95054 USA or visit www.sun.com if you need additional information or
mcimadamore@83 23 * have any questions.
mcimadamore@83 24 */
mcimadamore@83 25
mcimadamore@83 26 package com.sun.tools.javac.util;
mcimadamore@83 27
mcimadamore@221 28 import java.util.Collection;
mcimadamore@221 29 import java.util.EnumSet;
mcimadamore@83 30 import java.util.HashMap;
mcimadamore@83 31 import java.util.Locale;
mcimadamore@83 32 import java.util.Map;
mcimadamore@221 33 import java.util.regex.Matcher;
mcimadamore@83 34 import javax.tools.JavaFileObject;
mcimadamore@83 35
mcimadamore@221 36 import com.sun.tools.javac.util.AbstractDiagnosticFormatter.SimpleConfiguration;
mcimadamore@221 37 import com.sun.tools.javac.util.BasicDiagnosticFormatter.BasicConfiguration;
mcimadamore@221 38
mcimadamore@83 39 import static com.sun.tools.javac.api.DiagnosticFormatter.PositionKind.*;
mcimadamore@221 40 import static com.sun.tools.javac.util.BasicDiagnosticFormatter.BasicConfiguration.*;
mcimadamore@221 41 import static com.sun.tools.javac.util.LayoutCharacters.*;
mcimadamore@83 42
mcimadamore@83 43 /**
mcimadamore@83 44 * A basic formatter for diagnostic messages.
mcimadamore@83 45 * The basic formatter will format a diagnostic according to one of three format patterns, depending on whether
mcimadamore@83 46 * or not the source name and position are set. The formatter supports a printf-like string for patterns
mcimadamore@83 47 * with the following special characters:
mcimadamore@83 48 * <ul>
mcimadamore@83 49 * <li>%b: the base of the source name
mcimadamore@83 50 * <li>%f: the source name (full absolute path)
mcimadamore@83 51 * <li>%l: the line number of the diagnostic, derived from the character offset
mcimadamore@83 52 * <li>%c: the column number of the diagnostic, derived from the character offset
mcimadamore@83 53 * <li>%o: the character offset of the diagnostic if set
mcimadamore@83 54 * <li>%p: the prefix for the diagnostic, derived from the diagnostic type
mcimadamore@83 55 * <li>%t: the prefix as it normally appears in standard diagnostics. In this case, no prefix is
mcimadamore@83 56 * shown if the type is ERROR and if a source name is set
mcimadamore@83 57 * <li>%m: the text or the diagnostic, including any appropriate arguments
mcimadamore@83 58 * <li>%_: space delimiter, useful for formatting purposes
mcimadamore@83 59 * </ul>
mcimadamore@83 60 */
mcimadamore@83 61 public class BasicDiagnosticFormatter extends AbstractDiagnosticFormatter {
mcimadamore@83 62
mcimadamore@221 63 protected int currentIndentation = 0;
mcimadamore@83 64
mcimadamore@83 65 /**
mcimadamore@83 66 * Create a basic formatter based on the supplied options.
mcimadamore@83 67 *
mcimadamore@83 68 * @param opts list of command-line options
mcimadamore@136 69 * @param msgs JavacMessages object used for i18n
mcimadamore@83 70 */
jjg@198 71 @SuppressWarnings("fallthrough")
mcimadamore@221 72 public BasicDiagnosticFormatter(Options options, JavacMessages msgs) {
mcimadamore@221 73 super(msgs, new BasicConfiguration(options));
mcimadamore@83 74 }
mcimadamore@83 75
mcimadamore@83 76 /**
mcimadamore@83 77 * Create a standard basic formatter
mcimadamore@83 78 *
mcimadamore@136 79 * @param msgs JavacMessages object used for i18n
mcimadamore@83 80 */
mcimadamore@136 81 public BasicDiagnosticFormatter(JavacMessages msgs) {
mcimadamore@221 82 super(msgs, new BasicConfiguration());
mcimadamore@83 83 }
mcimadamore@83 84
mcimadamore@238 85 public String formatDiagnostic(JCDiagnostic d, Locale l) {
mcimadamore@136 86 if (l == null)
mcimadamore@136 87 l = messages.getCurrentLocale();
mcimadamore@83 88 String format = selectFormat(d);
mcimadamore@83 89 StringBuilder buf = new StringBuilder();
mcimadamore@83 90 for (int i = 0; i < format.length(); i++) {
mcimadamore@83 91 char c = format.charAt(i);
mcimadamore@83 92 boolean meta = false;
mcimadamore@83 93 if (c == '%' && i < format.length() - 1) {
mcimadamore@83 94 meta = true;
mcimadamore@83 95 c = format.charAt(++i);
mcimadamore@83 96 }
mcimadamore@83 97 buf.append(meta ? formatMeta(c, d, l) : String.valueOf(c));
mcimadamore@83 98 }
mcimadamore@221 99 if (depth == 0)
mcimadamore@221 100 return addSourceLineIfNeeded(d, buf.toString());
mcimadamore@221 101 else
mcimadamore@221 102 return buf.toString();
mcimadamore@221 103 }
mcimadamore@221 104
mcimadamore@221 105 public String formatMessage(JCDiagnostic d, Locale l) {
mcimadamore@221 106 int prevIndentation = currentIndentation;
mcimadamore@221 107 try {
mcimadamore@221 108 StringBuilder buf = new StringBuilder();
mcimadamore@221 109 Collection<String> args = formatArguments(d, l);
mcimadamore@221 110 String msg = localize(l, d.getCode(), args.toArray());
mcimadamore@221 111 String[] lines = msg.split("\n");
mcimadamore@221 112 if (getConfiguration().getVisible().contains(DiagnosticPart.SUMMARY)) {
mcimadamore@221 113 currentIndentation += getConfiguration().getIndentation(DiagnosticPart.SUMMARY);
mcimadamore@221 114 buf.append(indent(lines[0], currentIndentation)); //summary
mcimadamore@221 115 }
mcimadamore@221 116 if (lines.length > 1 && getConfiguration().getVisible().contains(DiagnosticPart.DETAILS)) {
mcimadamore@221 117 currentIndentation += getConfiguration().getIndentation(DiagnosticPart.DETAILS);
mcimadamore@221 118 for (int i = 1;i < lines.length; i++) {
mcimadamore@221 119 buf.append("\n" + indent(lines[i], currentIndentation));
mcimadamore@221 120 }
mcimadamore@221 121 }
mcimadamore@221 122 if (d.isMultiline() && getConfiguration().getVisible().contains(DiagnosticPart.SUBDIAGNOSTICS)) {
mcimadamore@221 123 currentIndentation += getConfiguration().getIndentation(DiagnosticPart.SUBDIAGNOSTICS);
mcimadamore@221 124 for (String sub : formatSubdiagnostics(d, l)) {
mcimadamore@221 125 buf.append("\n" + sub);
mcimadamore@221 126 }
mcimadamore@221 127 }
mcimadamore@221 128 return buf.toString();
mcimadamore@137 129 }
mcimadamore@221 130 finally {
mcimadamore@221 131 currentIndentation = prevIndentation;
mcimadamore@221 132 }
mcimadamore@221 133 }
mcimadamore@221 134
mcimadamore@221 135 protected String addSourceLineIfNeeded(JCDiagnostic d, String msg) {
mcimadamore@221 136 if (!displaySource(d))
mcimadamore@221 137 return msg;
mcimadamore@221 138 else {
mcimadamore@221 139 BasicConfiguration conf = getConfiguration();
mcimadamore@221 140 int indentSource = conf.getIndentation(DiagnosticPart.SOURCE);
mcimadamore@221 141 String sourceLine = "\n" + formatSourceLine(d, indentSource);
mcimadamore@221 142 boolean singleLine = msg.indexOf("\n") == -1;
mcimadamore@221 143 if (singleLine || getConfiguration().getSourcePosition() == SourcePosition.BOTTOM)
mcimadamore@221 144 return msg + sourceLine;
mcimadamore@221 145 else
mcimadamore@221 146 return msg.replaceFirst("\n", Matcher.quoteReplacement(sourceLine) + "\n");
mcimadamore@221 147 }
mcimadamore@83 148 }
mcimadamore@83 149
mcimadamore@83 150 protected String formatMeta(char c, JCDiagnostic d, Locale l) {
mcimadamore@83 151 switch (c) {
mcimadamore@83 152 case 'b':
mcimadamore@100 153 return formatSource(d, false, l);
mcimadamore@83 154 case 'e':
mcimadamore@83 155 return formatPosition(d, END, l);
mcimadamore@83 156 case 'f':
mcimadamore@100 157 return formatSource(d, true, l);
mcimadamore@83 158 case 'l':
mcimadamore@83 159 return formatPosition(d, LINE, l);
mcimadamore@83 160 case 'c':
mcimadamore@83 161 return formatPosition(d, COLUMN, l);
mcimadamore@83 162 case 'o':
mcimadamore@83 163 return formatPosition(d, OFFSET, l);
mcimadamore@83 164 case 'p':
mcimadamore@83 165 return formatKind(d, l);
mcimadamore@83 166 case 's':
mcimadamore@83 167 return formatPosition(d, START, l);
mcimadamore@83 168 case 't': {
mcimadamore@83 169 boolean usePrefix;
mcimadamore@83 170 switch (d.getType()) {
mcimadamore@83 171 case FRAGMENT:
mcimadamore@83 172 usePrefix = false;
mcimadamore@83 173 break;
mcimadamore@83 174 case ERROR:
mcimadamore@83 175 usePrefix = (d.getIntPosition() == Position.NOPOS);
mcimadamore@83 176 break;
mcimadamore@83 177 default:
mcimadamore@83 178 usePrefix = true;
mcimadamore@83 179 }
mcimadamore@83 180 if (usePrefix)
mcimadamore@83 181 return formatKind(d, l);
mcimadamore@83 182 else
mcimadamore@83 183 return "";
mcimadamore@83 184 }
mcimadamore@83 185 case 'm':
mcimadamore@83 186 return formatMessage(d, l);
mcimadamore@83 187 case '_':
mcimadamore@83 188 return " ";
mcimadamore@83 189 case '%':
mcimadamore@83 190 return "%";
mcimadamore@83 191 default:
mcimadamore@83 192 return String.valueOf(c);
mcimadamore@83 193 }
mcimadamore@83 194 }
mcimadamore@83 195
mcimadamore@83 196 private String selectFormat(JCDiagnostic d) {
mcimadamore@83 197 DiagnosticSource source = d.getDiagnosticSource();
mcimadamore@221 198 String format = getConfiguration().getFormat(BasicFormatKind.DEFAULT_NO_POS_FORMAT);
mcimadamore@83 199 if (source != null) {
mcimadamore@83 200 if (d.getIntPosition() != Position.NOPOS) {
mcimadamore@221 201 format = getConfiguration().getFormat(BasicFormatKind.DEFAULT_POS_FORMAT);
mcimadamore@83 202 } else if (source.getFile() != null &&
mcimadamore@83 203 source.getFile().getKind() == JavaFileObject.Kind.CLASS) {
mcimadamore@221 204 format = getConfiguration().getFormat(BasicFormatKind.DEFAULT_CLASS_FORMAT);
mcimadamore@83 205 }
mcimadamore@83 206 }
mcimadamore@83 207 return format;
mcimadamore@83 208 }
mcimadamore@83 209
mcimadamore@221 210 @Override
mcimadamore@221 211 public BasicConfiguration getConfiguration() {
mcimadamore@288 212 //the following cast is always safe - see init
mcimadamore@221 213 return (BasicConfiguration)super.getConfiguration();
mcimadamore@221 214 }
mcimadamore@221 215
mcimadamore@221 216 static public class BasicConfiguration extends SimpleConfiguration {
mcimadamore@221 217
mcimadamore@221 218 protected Map<DiagnosticPart, Integer> indentationLevels;
mcimadamore@221 219 protected Map<BasicFormatKind, String> availableFormats;
mcimadamore@221 220 protected SourcePosition sourcePosition;
mcimadamore@221 221
mcimadamore@221 222 @SuppressWarnings("fallthrough")
mcimadamore@221 223 public BasicConfiguration(Options options) {
mcimadamore@221 224 super(options, EnumSet.of(DiagnosticPart.SUMMARY,
mcimadamore@221 225 DiagnosticPart.DETAILS,
mcimadamore@221 226 DiagnosticPart.SUBDIAGNOSTICS,
mcimadamore@221 227 DiagnosticPart.SOURCE));
mcimadamore@221 228 initFormat();
mcimadamore@221 229 initIndentation();
mcimadamore@221 230 String fmt = options.get("diagsFormat");
mcimadamore@221 231 if (fmt != null) {
mcimadamore@221 232 String[] formats = fmt.split("\\|");
mcimadamore@221 233 switch (formats.length) {
mcimadamore@221 234 case 3:
mcimadamore@221 235 setFormat(BasicFormatKind.DEFAULT_CLASS_FORMAT, formats[2]);
mcimadamore@221 236 case 2:
mcimadamore@221 237 setFormat(BasicFormatKind.DEFAULT_NO_POS_FORMAT, formats[1]);
mcimadamore@221 238 default:
mcimadamore@221 239 setFormat(BasicFormatKind.DEFAULT_POS_FORMAT, formats[0]);
mcimadamore@221 240 }
mcimadamore@221 241 }
mcimadamore@221 242 String sourcePosition = null;
mcimadamore@221 243 if ((((sourcePosition = options.get("sourcePosition")) != null)) &&
mcimadamore@221 244 sourcePosition.equals("bottom"))
mcimadamore@221 245 setSourcePosition(SourcePosition.BOTTOM);
mcimadamore@221 246 else
mcimadamore@221 247 setSourcePosition(SourcePosition.AFTER_SUMMARY);
mcimadamore@221 248 String indent = options.get("diagsIndentation");
mcimadamore@221 249 if (indent != null) {
mcimadamore@221 250 String[] levels = indent.split("\\|");
mcimadamore@221 251 try {
mcimadamore@221 252 switch (levels.length) {
mcimadamore@221 253 case 5:
mcimadamore@221 254 setIndentation(DiagnosticPart.JLS,
mcimadamore@221 255 Integer.parseInt(levels[4]));
mcimadamore@221 256 case 4:
mcimadamore@221 257 setIndentation(DiagnosticPart.SUBDIAGNOSTICS,
mcimadamore@221 258 Integer.parseInt(levels[3]));
mcimadamore@221 259 case 3:
mcimadamore@221 260 setIndentation(DiagnosticPart.SOURCE,
mcimadamore@221 261 Integer.parseInt(levels[2]));
mcimadamore@221 262 case 2:
mcimadamore@221 263 setIndentation(DiagnosticPart.DETAILS,
mcimadamore@221 264 Integer.parseInt(levels[1]));
mcimadamore@221 265 default:
mcimadamore@221 266 setIndentation(DiagnosticPart.SUMMARY,
mcimadamore@221 267 Integer.parseInt(levels[0]));
mcimadamore@221 268 }
mcimadamore@221 269 }
mcimadamore@221 270 catch (NumberFormatException ex) {
mcimadamore@221 271 initIndentation();
mcimadamore@221 272 }
mcimadamore@221 273 }
mcimadamore@221 274 }
mcimadamore@221 275
mcimadamore@221 276 public BasicConfiguration() {
mcimadamore@221 277 super(EnumSet.of(DiagnosticPart.SUMMARY,
mcimadamore@221 278 DiagnosticPart.DETAILS,
mcimadamore@221 279 DiagnosticPart.SUBDIAGNOSTICS,
mcimadamore@221 280 DiagnosticPart.SOURCE));
mcimadamore@221 281 initFormat();
mcimadamore@221 282 initIndentation();
mcimadamore@221 283 }
mcimadamore@221 284 //where
mcimadamore@221 285 private void initFormat() {
mcimadamore@221 286 availableFormats = new HashMap<BasicFormatKind, String>();
mcimadamore@221 287 setFormat(BasicFormatKind.DEFAULT_POS_FORMAT, "%f:%l:%_%t%m");
mcimadamore@221 288 setFormat(BasicFormatKind.DEFAULT_NO_POS_FORMAT, "%p%m");
mcimadamore@221 289 setFormat(BasicFormatKind.DEFAULT_CLASS_FORMAT, "%f:%_%t%m");
mcimadamore@221 290 }
mcimadamore@221 291 //where
mcimadamore@221 292 private void initIndentation() {
mcimadamore@221 293 indentationLevels = new HashMap<DiagnosticPart, Integer>();
mcimadamore@221 294 setIndentation(DiagnosticPart.SUMMARY, 0);
mcimadamore@221 295 setIndentation(DiagnosticPart.DETAILS, DetailsInc);
mcimadamore@221 296 setIndentation(DiagnosticPart.SUBDIAGNOSTICS, DiagInc);
mcimadamore@221 297 setIndentation(DiagnosticPart.SOURCE, 0);
mcimadamore@221 298 }
mcimadamore@221 299
mcimadamore@83 300 /**
mcimadamore@221 301 * Get the amount of spaces for a given indentation kind
mcimadamore@221 302 * @param diagPart the diagnostic part for which the indentation is
mcimadamore@221 303 * to be retrieved
mcimadamore@221 304 * @return the amount of spaces used for the specified indentation kind
mcimadamore@221 305 */
mcimadamore@221 306 public int getIndentation(DiagnosticPart diagPart) {
mcimadamore@221 307 return indentationLevels.get(diagPart);
mcimadamore@221 308 }
mcimadamore@221 309
mcimadamore@83 310 /**
mcimadamore@221 311 * Set the indentation level for various element of a given diagnostic -
mcimadamore@221 312 * this might lead to more readable diagnostics
mcimadamore@221 313 *
mcimadamore@221 314 * @param indentationKind kind of indentation to be set
mcimadamore@221 315 * @param nSpaces amount of spaces for the specified diagnostic part
mcimadamore@221 316 */
mcimadamore@221 317 public void setIndentation(DiagnosticPart diagPart, int nSpaces) {
mcimadamore@221 318 indentationLevels.put(diagPart, nSpaces);
mcimadamore@221 319 }
mcimadamore@221 320
mcimadamore@83 321 /**
mcimadamore@221 322 * Set the source line positioning used by this formatter
mcimadamore@221 323 *
mcimadamore@221 324 * @param sourcePos a positioning value for source line
mcimadamore@221 325 */
mcimadamore@221 326 public void setSourcePosition(SourcePosition sourcePos) {
mcimadamore@221 327 sourcePosition = sourcePos;
mcimadamore@221 328 }
mcimadamore@221 329
mcimadamore@221 330 /**
mcimadamore@221 331 * Get the source line positioning used by this formatter
mcimadamore@221 332 *
mcimadamore@221 333 * @return the positioning value used by this formatter
mcimadamore@221 334 */
mcimadamore@221 335 public SourcePosition getSourcePosition() {
mcimadamore@221 336 return sourcePosition;
mcimadamore@221 337 }
mcimadamore@221 338 //where
mcimadamore@221 339 /**
mcimadamore@221 340 * A source positioning value controls the position (within a given
mcimadamore@221 341 * diagnostic message) in which the source line the diagnostic refers to
mcimadamore@221 342 * should be displayed (if applicable)
mcimadamore@221 343 */
mcimadamore@221 344 public enum SourcePosition {
mcimadamore@221 345 /**
mcimadamore@221 346 * Source line is displayed after the diagnostic message
mcimadamore@221 347 */
mcimadamore@221 348 BOTTOM,
mcimadamore@221 349 /**
mcimadamore@221 350 * Source line is displayed after the first line of the diagnostic
mcimadamore@221 351 * message
mcimadamore@221 352 */
mcimadamore@221 353 AFTER_SUMMARY;
mcimadamore@221 354 }
mcimadamore@221 355
mcimadamore@221 356 /**
mcimadamore@221 357 * Set a metachar string for a specific format
mcimadamore@221 358 *
mcimadamore@221 359 * @param kind the format kind to be set
mcimadamore@221 360 * @param s the metachar string specifying the format
mcimadamore@221 361 */
mcimadamore@221 362 public void setFormat(BasicFormatKind kind, String s) {
mcimadamore@221 363 availableFormats.put(kind, s);
mcimadamore@221 364 }
mcimadamore@221 365
mcimadamore@221 366 /**
mcimadamore@221 367 * Get a metachar string for a specific format
mcimadamore@221 368 *
mcimadamore@221 369 * @param sourcePos a positioning value for source line
mcimadamore@221 370 */
mcimadamore@221 371 public String getFormat(BasicFormatKind kind) {
mcimadamore@221 372 return availableFormats.get(kind);
mcimadamore@221 373 }
mcimadamore@221 374 //where
mcimadamore@221 375 /**
mcimadamore@221 376 * This enum contains all the kinds of formatting patterns supported
mcimadamore@221 377 * by a basic diagnostic formatter.
mcimadamore@221 378 */
mcimadamore@221 379 public enum BasicFormatKind {
mcimadamore@221 380 /**
mcimadamore@221 381 * A format string to be used for diagnostics with a given position.
mcimadamore@221 382 */
mcimadamore@221 383 DEFAULT_POS_FORMAT,
mcimadamore@221 384 /**
mcimadamore@221 385 * A format string to be used for diagnostics without a given position.
mcimadamore@221 386 */
mcimadamore@221 387 DEFAULT_NO_POS_FORMAT,
mcimadamore@221 388 /**
mcimadamore@221 389 * A format string to be used for diagnostics regarding classfiles
mcimadamore@221 390 */
mcimadamore@221 391 DEFAULT_CLASS_FORMAT;
mcimadamore@221 392 }
mcimadamore@83 393 }
mcimadamore@83 394 }

mercurial