/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.codehaus.groovy.control.messages;

import org.codehaus.groovy.control.Janitor;
import org.codehaus.groovy.control.ProcessingUnit;

import java.io.PrintWriter;
import java.util.Objects;

/**
 * A class for error messages produced by the parser system.
 */
public class ExceptionMessage extends Message {

    private final Exception cause;
    /**
     * Indicates whether debug output is enabled for this message.
     */
    protected final boolean debug;
    /**
     * Processing unit that reported the exception.
     */
    protected final ProcessingUnit owner;

    /**
     * Creates an exception-backed compilation message.
     *
     * @param cause the underlying exception
     * @param debug whether debug output is enabled
     * @param owner the owning processing unit
     */
    public ExceptionMessage(final Exception cause, final boolean debug, final ProcessingUnit owner) {
        this.cause = Objects.requireNonNull(cause);
        this.debug = debug;
        this.owner = owner;
    }

    /**
     * Returns the underlying Exception.
     */
    public Exception getCause() {
        return cause;
    }

    /**
     * Writes out a nicely formatted summary of the exception.
     */
    @Override
    public void write(final PrintWriter output, final Janitor janitor) {
        String description = "General error during " + owner.getPhaseDescription() + ": ";

        String message = cause.getMessage();
        output.println(description + Objects.requireNonNullElse(message, cause));
        output.println();

        /*if (debug)*/ cause.printStackTrace(output);
    }
}
