/*
 *  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.apache.groovy.ginq.dsl;

import org.codehaus.groovy.control.SourceUnit;
import org.codehaus.groovy.control.messages.SyntaxErrorMessage;
import org.codehaus.groovy.syntax.SyntaxException;

/**
 * Supports reporting the syntax error of GINQ
 *
 * @since 4.0.0
 */
public interface SyntaxErrorReportable {
    /**
     * Returns the source unit collecting syntax errors.
     *
     * @return the source unit used for reporting
     */
    SourceUnit getSourceUnit();

    /**
     * Adds the supplied GINQ syntax error to the current source unit.
     *
     * @param ginqSyntaxError the error to report
     */
    default void collectSyntaxError(GinqSyntaxError ginqSyntaxError) {
        SourceUnit sourceUnit = getSourceUnit();

        SyntaxException e = new SyntaxException(
                ginqSyntaxError.getMessage(),
                ginqSyntaxError,
                ginqSyntaxError.getLine(),
                ginqSyntaxError.getColumn());
        sourceUnit.getErrorCollector().addFatalError(new SyntaxErrorMessage(e, sourceUnit));
    }
}
