/*

 * Copyright (c) 2003, 2008, 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.Locale;

import java.util.Map;

import javax.tools.Diagnostic;

import javax.tools.JavaFileObject;

import com.sun.tools.javac.api.DiagnosticFormatter;

import com.sun.tools.javac.code.Lint.LintCategory;

import com.sun.tools.javac.tree.JCTree;

import static com.sun.tools.javac.util.JCDiagnostic.DiagnosticType.*;

/** An abstraction of a diagnostic message generated by the compiler.

 *

 *  <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 class JCDiagnostic implements Diagnostic<JavaFileObject> {

    /** A factory for creating diagnostic objects. */

    public static class Factory {

        /** The context key for the diagnostic factory. */

        protected static final Context.Key<JCDiagnostic.Factory> diagnosticFactoryKey =

            new Context.Key<JCDiagnostic.Factory>();

        /** Get the Factory instance for this context. */

        public static Factory instance(Context context) {

            Factory instance = context.get(diagnosticFactoryKey);

            if (instance == null)

                instance = new Factory(context);

            return instance;

        }

        DiagnosticFormatter<JCDiagnostic> formatter;

        final String prefix;

        /** Create a new diagnostic factory. */

        protected Factory(Context context) {

            this(JavacMessages.instance(context), "compiler");

            context.put(diagnosticFactoryKey, this);

        }

        /** Create a new diagnostic factory. */

        public Factory(JavacMessages messages, String prefix) {

            this.prefix = prefix;

            this.formatter = new BasicDiagnosticFormatter(messages);

        }

        /**

         * Create an error diagnostic.

         *  @param source The source of the compilation unit, if any, in which to report the error.

         *  @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 JCDiagnostic error(

                DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {

        }

        /**

         * Create a warning diagnostic that will not be hidden by the -nowarn or -Xlint:none options.

         *  @param source The source of the compilation unit, if any, in which to report the 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.

         *  @see MandatoryWarningHandler

         */

        public JCDiagnostic mandatoryWarning(

                DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {

        }

        /**

         * Create a warning diagnostic that will not be hidden by the -nowarn or -Xlint:none options.

         *  @param lc     The lint category for the diagnostic

         *  @param source The source of the compilation unit, if any, in which to report the 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.

         *  @see MandatoryWarningHandler

         */

        public JCDiagnostic mandatoryWarning(

                LintCategory lc,

                DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {

        }

        /**

         * Create a warning diagnostic.

         *  @param lc     The lint category for the diagnostic

         *  @param key    The key for the localized error message.

         *  @param args   Fields of the warning message.

         *  @see MandatoryWarningHandler

         */

        public JCDiagnostic warning(

                 LintCategory lc, String key, Object... args) {

        }

        /**

         * Create a warning diagnostic.

         *  @param source The source of the compilation unit, if any, in which to report the 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 JCDiagnostic warning(

                DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {

        }

        /**

         * Create a warning diagnostic.

         *  @param lc     The lint category for the diagnostic

         *  @param source The source of the compilation unit, if any, in which to report the 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.

         *  @see MandatoryWarningHandler

         */

        public JCDiagnostic warning(

                 LintCategory lc, DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {

        }

        /**

         * Create a note diagnostic that will not be hidden by the -nowarn or -Xlint:none options.

         *  @param key    The key for the localized message.

         *  @param args   Fields of the message.

         *  @see MandatoryWarningHandler

         */

        public JCDiagnostic mandatoryNote(DiagnosticSource source, String key, Object... args) {

        }

        /**

         * Create a note diagnostic.

         *  @param key    The key for the localized error message.

         *  @param args   Fields of the message.

         */

        public JCDiagnostic note(String key, Object... args) {

        }

        /**

         * Create a note diagnostic.

         *  @param source The source of the compilation unit, if any, in which to report the note.

         *  @param pos    The source position at which to report the note.

         *  @param key    The key for the localized message.

         *  @param args   Fields of the message.

         */

        public JCDiagnostic note(

                DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {

        }

        /**

         * Create a fragment diagnostic, for use as an argument in other diagnostics

         *  @param key    The key for the localized message.

         *  @param args   Fields of the message.

         */

        public JCDiagnostic fragment(String key, Object... args) {

        }

        /**

         * Create a new diagnostic of the given kind, which is not mandatory and which has

         * no lint category.

         *  @param kind        The diagnostic kind

         *  @param ls          The lint category, if applicable, or null

         *  @param source      The source of the compilation unit, if any, in which to report the message.

         *  @param pos         The source position at which to report the message.

         *  @param key         The key for the localized message.

         *  @param args        Fields of the message.

         */

        public JCDiagnostic create(

                DiagnosticType kind, DiagnosticSource source, DiagnosticPosition pos, String key, Object... args) {

        }

        /**

         * Create a new diagnostic of the given kind.

         *  @param kind        The diagnostic kind

         *  @param lc          The lint category, if applicable, or null

         *  @param isMandatory is diagnostic mandatory?

         *  @param source      The source of the compilation unit, if any, in which to report the message.

         *  @param pos         The source position at which to report the message.

         *  @param key         The key for the localized message.

         *  @param args        Fields of the message.

         */

        public JCDiagnostic create(

        }

        protected String qualify(DiagnosticType t, String key) {

            return prefix + "." + t.key + "." + key;

        }

    }

    /**

     * Create a fragment diagnostic, for use as an argument in other diagnostics

     *  @param key    The key for the localized error message.

     *  @param args   Fields of the error message.

     *

     */

    @Deprecated

    public static JCDiagnostic fragment(String key, Object... args) {

        return new JCDiagnostic(getFragmentFormatter(),

                              FRAGMENT,

                              null,

                              null,

                              null,

                              "compiler." + FRAGMENT.key + "." + key,

                              args);

    }

    //where

    @Deprecated

    public static DiagnosticFormatter<JCDiagnostic> getFragmentFormatter() {

        if (fragmentFormatter == null) {

            fragmentFormatter = new BasicDiagnosticFormatter(JavacMessages.getDefaultMessages());

        }

        return fragmentFormatter;

    }

    /**

     * A DiagnosticType defines the type of the diagnostic.

     **/

    public enum DiagnosticType {

        /** A fragment of an enclosing diagnostic. */

        FRAGMENT("misc"),

        /** A note: similar to, but less serious than, a warning. */

        NOTE("note"),

        /** A warning. */

        WARNING("warn"),

        /** An error. */

        ERROR("err");

        final String key;

        /** Create a DiagnosticType.

         * @param key A string used to create the resource key for the diagnostic.

         */

        DiagnosticType(String key) {

            this.key = key;

        }

    };

    /**

     * A DiagnosticPosition provides information about the positions in a file

     * that gave rise to a diagnostic. It always defines a "preferred" position

     * that most accurately defines the location of the diagnostic, it may also

     * provide a related tree node that spans that location.

     */

    public static interface DiagnosticPosition {

        /** Gets the tree node, if any, to which the diagnostic applies. */

        JCTree getTree();

        /** If there is a tree node, get the start position of the tree node.

         *  Otherwise, just returns the same as getPreferredPosition(). */

        int getStartPosition();

        /** Get the position within the file that most accurately defines the

         *  location for the diagnostic. */

        int getPreferredPosition();

        /** If there is a tree node, and if endPositions are available, get

         *  the end position of the tree node. Otherwise, just returns the

         *  same as getPreferredPosition(). */

        int getEndPosition(Map<JCTree, Integer> endPosTable);

    }

    /**

     * A DiagnosticPosition that simply identifies a position, but no related

     * tree node, as the location for a diagnostic. Used for scanner and parser

     * diagnostics. */

    public static class SimpleDiagnosticPosition implements DiagnosticPosition {

        public SimpleDiagnosticPosition(int pos) {

            this.pos = pos;

        }

        public JCTree getTree() {

            return null;

        }

        public int getStartPosition() {

            return pos;

        }

        public int getPreferredPosition() {

            return pos;

        }

        public int getEndPosition(Map<JCTree, Integer> endPosTable) {

            return pos;

        }

        private final int pos;

    }

    private final DiagnosticType type;

    private final DiagnosticSource source;

    private final DiagnosticPosition position;

    private final int line;

    private final int column;

    private final String key;

    protected final Object[] args;

    private final LintCategory lintCategory;

    /**

     * Create a diagnostic object.

     * @param fomatter the formatter to use for the diagnostic

     * @param dt the type of diagnostic

     * @param lc     the lint category for the diagnostic

     * @param source the name of the source file, or null if none.

     * @param pos the character offset within the source file, if given.

     * @param key a resource key to identify the text of the diagnostic

     * @param args arguments to be included in the text of the diagnostic

     */

    protected JCDiagnostic(DiagnosticFormatter<JCDiagnostic> formatter,

                       DiagnosticType dt,

                       LintCategory lc,

                       DiagnosticSource source,

                       DiagnosticPosition pos,

                       String key,

                       Object... args) {

        if (source == null && pos != null && pos.getPreferredPosition() != Position.NOPOS)

            throw new IllegalArgumentException();

        this.defaultFormatter = formatter;

        this.type = dt;

        this.lintCategory = lc;

        this.source = source;

        this.position = pos;

        this.key = key;

            this.args = args;

        int n = (pos == null ? Position.NOPOS : pos.getPreferredPosition());

        if (n == Position.NOPOS || source == null)

            line = column = -1;

        else {

            line = source.getLineNumber(n);

            column = source.getColumnNumber(n, true);

        }

    }

    /**

     * Get the type of this diagnostic.

     * @return the type of this diagnostic

     */

    public DiagnosticType getType() {

        return type;

    }

    /**

     * Get the subdiagnostic list

     * @return subdiagnostic list

     */

    public List<JCDiagnostic> getSubdiagnostics() {

        return List.nil();

    }

    public boolean isMultiline() {

        return false;

    }

    /**

     * Check whether or not this diagnostic is required to be shown.

     * @return true if this diagnostic is required to be shown.

     */

    public boolean isMandatory() {

    }

    /**

     * Check whether this diagnostic has an associated lint category.

     */

    public boolean hasLintCategory() {

        return (lintCategory != null);

    }

    /**

     * Get the associated lint category, or null if none.

     */

    public LintCategory getLintCategory() {

        return lintCategory;

    }

    /**

     * Get the name of the source file referred to by this diagnostic.

     * @return the name of the source referred to with this diagnostic, or null if none

     */

    public JavaFileObject getSource() {

        if (source == null)

            return null;

        else

            return source.getFile();

    }

    /**

     * Get the source referred to by this diagnostic.

     * @return the source referred to with this diagnostic, or null if none

     */

    public DiagnosticSource getDiagnosticSource() {

        return source;

    }

    protected int getIntStartPosition() {

        return (position == null ? Position.NOPOS : position.getStartPosition());

    }

    protected int getIntPosition() {

        return (position == null ? Position.NOPOS : position.getPreferredPosition());

    }

    protected int getIntEndPosition() {

        return (position == null ? Position.NOPOS : position.getEndPosition(source.getEndPosTable()));

    }

    public long getStartPosition() {

        return getIntStartPosition();

    }

    public long getPosition() {

        return getIntPosition();

    }

    public long getEndPosition() {

        return getIntEndPosition();

    }

    /**

     * Get the line number within the source referred to by this diagnostic.

     * @return  the line number within the source referred to by this diagnostic

     */

    public long getLineNumber() {

        return line;

    }

    /**

     * Get the column number within the line of source referred to by this diagnostic.

     * @return  the column number within the line of source referred to by this diagnostic

     */

    public long getColumnNumber() {

        return column;

    }

    /**

     * Get the arguments to be included in the text of the diagnostic.

     * @return  the arguments to be included in the text of the diagnostic

     */

    public Object[] getArgs() {

        return args;

    }

    /**

     * Get the prefix string associated with this type of diagnostic.

     * @return the prefix string associated with this type of diagnostic

     */

    public String getPrefix() {

        return getPrefix(type);

    }

    /**

     * Get the prefix string associated with a particular type of diagnostic.

     * @return the prefix string associated with a particular type of diagnostic

     */

    public String getPrefix(DiagnosticType dt) {

        return defaultFormatter.formatKind(this, Locale.getDefault());

    }