mcimadamore@83: /*
mcimadamore@83:  * Copyright 2008 Sun Microsystems, Inc.  All Rights Reserved.
mcimadamore@83:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
mcimadamore@83:  *
mcimadamore@83:  * This code is free software; you can redistribute it and/or modify it
mcimadamore@83:  * under the terms of the GNU General Public License version 2 only, as
mcimadamore@83:  * published by the Free Software Foundation.  Sun designates this
mcimadamore@83:  * particular file as subject to the "Classpath" exception as provided
mcimadamore@83:  * by Sun in the LICENSE file that accompanied this code.
mcimadamore@83:  *
mcimadamore@83:  * This code is distributed in the hope that it will be useful, but WITHOUT
mcimadamore@83:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
mcimadamore@83:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
mcimadamore@83:  * version 2 for more details (a copy is included in the LICENSE file that
mcimadamore@83:  * accompanied this code).
mcimadamore@83:  *
mcimadamore@83:  * You should have received a copy of the GNU General Public License version
mcimadamore@83:  * 2 along with this work; if not, write to the Free Software Foundation,
mcimadamore@83:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
mcimadamore@83:  *
mcimadamore@83:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
mcimadamore@83:  * CA 95054 USA or visit www.sun.com if you need additional information or
mcimadamore@83:  * have any questions.
mcimadamore@83:  */
mcimadamore@83: package com.sun.tools.javac.util;
mcimadamore@83: 
mcimadamore@221: import java.util.Collection;
mcimadamore@221: import java.util.EnumSet;
mcimadamore@83: import java.util.Locale;
mcimadamore@83: 
mcimadamore@221: import com.sun.tools.javac.api.DiagnosticFormatter.Configuration.*;
mcimadamore@83: import com.sun.tools.javac.api.Formattable;
mcimadamore@221: import com.sun.tools.javac.util.AbstractDiagnosticFormatter.SimpleConfiguration;
mcimadamore@221: 
mcimadamore@83: import static com.sun.tools.javac.api.DiagnosticFormatter.PositionKind.*;
mcimadamore@83: 
mcimadamore@83: /**
mcimadamore@83:  * A raw formatter for diagnostic messages.
mcimadamore@83:  * The raw formatter will format a diagnostic according to one of two format patterns, depending on whether
mcimadamore@83:  * or not the source name and position are set. This formatter provides a standardized, localize-independent
mcimadamore@83:  * implementation of a diagnostic formatter; as such, this formatter is best suited for testing purposes.
mcimadamore@83:  */
mcimadamore@221: public final class RawDiagnosticFormatter extends AbstractDiagnosticFormatter {
mcimadamore@83: 
mcimadamore@83:     /**
mcimadamore@83:      * Create a formatter based on the supplied options.
mcimadamore@83:      * @param msgs
mcimadamore@83:      */
mcimadamore@221:     public RawDiagnosticFormatter(Options options) {
mcimadamore@221:         super(null, new SimpleConfiguration(options,
mcimadamore@221:                 EnumSet.of(DiagnosticPart.SUMMARY,
mcimadamore@221:                         DiagnosticPart.DETAILS,
mcimadamore@221:                         DiagnosticPart.SUBDIAGNOSTICS)));
mcimadamore@83:     }
mcimadamore@83: 
mcimadamore@83:     //provide common default formats
mcimadamore@83:     public String format(JCDiagnostic d, Locale l) {
mcimadamore@83:         try {
mcimadamore@83:             StringBuffer buf = new StringBuffer();
mcimadamore@83:             if (d.getPosition() != Position.NOPOS) {
mcimadamore@100:                 buf.append(formatSource(d, false, null));
mcimadamore@83:                 buf.append(':');
mcimadamore@83:                 buf.append(formatPosition(d, LINE, null));
mcimadamore@83:                 buf.append(':');
mcimadamore@83:                 buf.append(formatPosition(d, COLUMN, null));
mcimadamore@83:                 buf.append(':');
mcimadamore@83:             }
mcimadamore@83:             else
mcimadamore@83:                 buf.append('-');
mcimadamore@83:             buf.append(' ');
mcimadamore@83:             buf.append(formatMessage(d, null));
mcimadamore@137:             if (displaySource(d))
mcimadamore@221:                 buf.append("\n" + formatSourceLine(d, 0));
mcimadamore@83:             return buf.toString();
mcimadamore@83:         }
mcimadamore@83:         catch (Exception e) {
mcimadamore@83:             e.printStackTrace();
mcimadamore@83:             return null;
mcimadamore@83:         }
mcimadamore@83:     }
mcimadamore@83: 
mcimadamore@221:     public String formatMessage(JCDiagnostic d, Locale l) {
mcimadamore@221:         StringBuilder buf = new StringBuilder();
mcimadamore@221:         Collection<String> args = formatArguments(d, l);
mcimadamore@221:         buf.append(d.getCode());
mcimadamore@221:         String sep = ": ";
mcimadamore@221:         for (Object o : args) {
mcimadamore@221:             buf.append(sep);
mcimadamore@221:             buf.append(o);
mcimadamore@221:             sep = ", ";
mcimadamore@221:         }
mcimadamore@221:         if (d.isMultiline() && getConfiguration().getVisible().contains(DiagnosticPart.SUBDIAGNOSTICS)) {
mcimadamore@221:             List<String> subDiags = formatSubdiagnostics(d, null);
mcimadamore@221:             if (subDiags.nonEmpty()) {
mcimadamore@221:                 sep = "";
mcimadamore@221:                 buf.append(",{");
mcimadamore@221:                 for (String sub : formatSubdiagnostics(d, null)) {
mcimadamore@221:                     buf.append(sep);
mcimadamore@221:                     buf.append("(" + sub + ")");
mcimadamore@221:                     sep = ",";
mcimadamore@221:                 }
mcimadamore@221:                 buf.append('}');
mcimadamore@221:             }
mcimadamore@221:         }
mcimadamore@221:         return buf.toString();
mcimadamore@221:     }
mcimadamore@221: 
mcimadamore@83:     @Override
mcimadamore@83:     protected String formatArgument(JCDiagnostic diag, Object arg, Locale l) {
mcimadamore@83:         String s;
mcimadamore@83:         if (arg instanceof Formattable)
mcimadamore@83:             s = arg.toString();
mcimadamore@83:         else
mcimadamore@83:             s = super.formatArgument(diag, arg, null);
mcimadamore@83:         if (arg instanceof JCDiagnostic)
mcimadamore@83:             return "(" + s + ")";
mcimadamore@83:         else
mcimadamore@83:             return s;
mcimadamore@83:     }
mcimadamore@83: }