IASTBinaryExpression.java

/*******************************************************************************
 * Copyright (c) 2004, 2012 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Doug Schaefer (IBM) - Initial API and implementation
 *     Markus Schorn (Wind River Systems)
 *******************************************************************************/
package org.eclipse.cdt.core.dom.ast;

/**
 * This interface represents a binary expression.
 *
 * @noextend This interface is not intended to be extended by clients.
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IASTBinaryExpression extends IASTExpression {
	/**
	 * Node property that describes the relationship between an
	 * <code>IASTBinaryExpression</code> and an <code>IASTExpression</code>
	 * representing the lhs.
	 */
	public static final ASTNodeProperty OPERAND_ONE = new ASTNodeProperty(
			"IASTBinaryExpression.OPERAND_ONE - IASTExpression for LHS"); //$NON-NLS-1$

	/**
	 * Node property that describes the relationship between an
	 * <code>IASTBinaryExpression</code> and an <code>IASTExpression</code>
	 * representing the rhs.
	 */
	public static final ASTNodeProperty OPERAND_TWO = new ASTNodeProperty(
			"IASTBinaryExpression.OPERAND_TWO - IASTExpression for RHS"); //$NON-NLS-1$

	/**
	 * Sets the operator.
	 *
	 * @param op value to set.
	 */
	public void setOperator(int op);

	/**
	 * Returns the operator.
	 *
	 * @return int value as operator
	 */
	public int getOperator();

	/**
	 * multiply *
	 */
	public static final int op_multiply = 1;

	/**
	 * divide /
	 */
	public static final int op_divide = 2;

	/**
	 * modulo %
	 */
	public static final int op_modulo = 3;

	/**
	 * plus +
	 */
	public static final int op_plus = 4;

	/**
	 * minus -
	 */
	public static final int op_minus = 5;

	/**
	 * shift left &lt;&lt;
	 */
	public static final int op_shiftLeft = 6;

	/**
	 * shift right &gt;&gt;
	 */
	public static final int op_shiftRight = 7;

	/**
	 * less than &lt;
	 */
	public static final int op_lessThan = 8;

	/**
	 * greater than &gt;
	 */
	public static final int op_greaterThan = 9;

	/**
	 * less than or equals &lt;=
	 */
	public static final int op_lessEqual = 10;

	/**
	 * greater than or equals &gt;=
	 */
	public static final int op_greaterEqual = 11;

	/**
	 * binary and &amp;
	 */
	public static final int op_binaryAnd = 12;

	/**
	 * binary Xor ^
	 */
	public static final int op_binaryXor = 13;

	/**
	 * binary Or |
	 */
	public static final int op_binaryOr = 14;

	/**
	 * logical and &amp;&amp;
	 */
	public static final int op_logicalAnd = 15;

	/**
	 * logical or ||
	 */
	public static final int op_logicalOr = 16;

	/**
	 * assignment =
	 */
	public static final int op_assign = 17;

	/**
	 * multiply assignment *=
	 */
	public static final int op_multiplyAssign = 18;

	/**
	 * divide assignemnt /=
	 */
	public static final int op_divideAssign = 19;

	/**
	 * modulo assignment %=
	 */
	public static final int op_moduloAssign = 20;

	/**
	 * plus assignment +=
	 */
	public static final int op_plusAssign = 21;

	/**
	 * minus assignment -=
	 */
	public static final int op_minusAssign = 22;

	/**
	 * shift left assignment &lt;&lt;=
	 */
	public static final int op_shiftLeftAssign = 23;

	/**
	 * shift right assign &gt;&gt;=
	 */
	public static final int op_shiftRightAssign = 24;

	/**
	 * binary and assign &amp;=
	 */
	public static final int op_binaryAndAssign = 25;

	/**
	 * binary Xor assign ^=
	 */
	public static final int op_binaryXorAssign = 26;

	/**
	 * binary Or assign |=
	 */
	public static final int op_binaryOrAssign = 27;

	/**
	 * equals ==
	 */
	public static final int op_equals = 28;

	/**
	 * not equals !=
	 */
	public static final int op_notequals = 29;

	/**
	 * For c==, only.
	 * <code>op_pmdot</code> pointer-to-member field dereference.
	 */
	public static final int op_pmdot = 30;

	/**
	 * For c++, only.
	 * <code>op_pmarrow</code> pointer-to-member pointer dereference.
	 */
	public static final int op_pmarrow = 31;

	/**
	 * For g++, only.
	 * <code>op_max</code> represents &gt;?
	 */
	public static final int op_max = 32;

	/**
	 * For g++, only.
	 * <code>op_min</code> represents &lt;?
	 */
	public static final int op_min = 33;

	/**
	 * For gcc compilers, only.
	 * <code>op_ellipses</code> represents ... as used for case ranges.
	 */
	public static final int op_ellipses = 34;

	/**
	 * For c++, only.
	 * <code>op_threewaycompare</code> represents <code><=></code> three-way comparison operator.
	 * @since 8.1
	 */
	public static final int op_threewaycomparison = 35;

	/**
	 * Get the first operand.
	 *
	 * @return <code>IASTExpression</code> representing operand 1.
	 */
	public IASTExpression getOperand1();

	/**
	 * Set the first operand.
	 *
	 * @param expression
	 *            <code>IASTExpression</code> value.
	 */
	public void setOperand1(IASTExpression expression);

	/**
	 * Get the second operand.
	 *
	 * @return <code>IASTExpression</code> representing operand 2.
	 */
	public IASTExpression getOperand2();

	/**
	 * Returns the second operand of the expression. For c++ assignment expressions this can be
	 * a braced list initializer.
	 * @since 5.2
	 */
	public IASTInitializerClause getInitOperand2();

	/**
	 * @param expression
	 *            <code>IASTExpression</code> value
	 */
	public void setOperand2(IASTExpression expression);

	/**
	 * @since 5.1
	 */
	@Override
	public IASTBinaryExpression copy();

	/**
	 * @since 5.3
	 */
	@Override
	public IASTBinaryExpression copy(CopyStyle style);
}