/*
 * Copyright (c) 2022, 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.
 *
 * 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 compiler.lib.ir_framework.driver.irmatching;

import compiler.lib.ir_framework.driver.irmatching.visitor.AcceptChildren;
import compiler.lib.ir_framework.driver.irmatching.visitor.MatchResultVisitor;

/**
 * This interface is implemented by all classes which represent an IR match result of a {@link Matchable} class.
 * A match result class accepts a {@link MatchResultVisitor} to visit the result (i.e. for reporting etc.).
 * The visitor is responsible to call {@link #accept(MatchResultVisitor)} of the children match results by using
 * {@link AcceptChildren#accept(MatchResultVisitor)}.
 */
public interface MatchResult {
    /**
     * Does this match result represent an IR match failure?
     */
    boolean fail();

    /**
     * Allow a {@link MatchResultVisitor} to visit the match result which in turn invokes the visit methods of the
     * visitor.
     */
    void accept(MatchResultVisitor visitor);
}