/*
 * Copyright (c) 2009-2011, IETR/INSA of Rennes
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *   * Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *   * Neither the name of the IETR/INSA of Rennes nor the names of its
 *     contributors may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
package net.sf.orcc.ir;

import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EObject;

/**
 * This class defines a boolean predicate associated with an instruction.
 * 
 * @author Matthieu Wipliez
 * @model
 */
public interface Predicate extends EObject {

	/**
	 * Adds an expression to this predicate.
	 * 
	 * @param expression
	 *            an expression
	 */
	void add(Expression expression);

	/**
	 * Clears this predicate.
	 */
	void clear();

	/**
	 * Returns the list of expressions of this predicate.
	 * 
	 * @return the list of expressions of this predicate
	 * @model containment="true"
	 */
	EList<Expression> getExpressions();

	/**
	 * Returns true if this predicate is empty.
	 * 
	 * @return true if this predicate is empty
	 */
	boolean isEmpty();

	/**
	 * Returns <code>true</code> if this predicate and the given predicate are
	 * mutually exclusive.
	 * 
	 * @param predicate
	 *            a predicate
	 * @return <code>true</code> if this predicate and the given predicate are
	 *         mutually exclusive
	 */
	boolean isMutuallyExclusive(Predicate predicate);

	/**
	 * Returns <code>true</code> if this predicate is the same as the given
	 * predicate.
	 * 
	 * @param predicate
	 *            a predicate
	 * @return <code>true</code> if this predicate is the same as the given
	 *         predicate
	 */
	boolean isSameAs(Predicate predicate);

}