jeb.api.ast

Class Assignment

java.lang.Object

jeb.api.ast.Statement

jeb.api.ast.Assignment

All Implemented Interfaces:

IElement

public class Assignment
extends Statement

This AST element represents an assignment.

Example of a simple assignment: left = right

A simple assignment can be modified to represent non-standard assignments:

• A combined-operator assignment
• A unary-operator assignment

Since:

1.4.201309040

See Also:

ILeftExpression, IExpression

Method Summary

Modifier and Type	Method and Description
static Assignment	build(ILeftExpression left, IExpression right) Create a new assignment.
Operator	getCombinedOperator() Retrieve the combined operator of a combined assignment.
Operator	getCompinedOperator() Deprecated.
ILeftExpression	getLeft() Get the left part of the assignment.
IExpression	getRight() Get the right part of the assignment.
void	getUnaryOperator(boolean[] r) Retrieve the unary operator of a unary operator assignment.
boolean	isCombinedOperatorAssignment() Determine if the assignment is a combined assignment.
boolean	isCompinedOperatorAssignment() Deprecated.
boolean	isSimpleAssignment() Determine if the assignment is a simple assignment.
boolean	isUnaryOperatorAssignment() Determine if the assignment is a unary-operator assignment.
void	setCombinedOperator(Operator operator) Transform a simple assignment into a combined operator assignment.
void	setLeft(ILeftExpression left) Set the left part of the assignment.
void	setRight(IExpression right) Set the right part of the assignment.
void	setUnaryOperator(boolean is_increment, boolean is_prefixed) Transform the non-unary assignment into one of the four unary assignments: ++e, e++, --e, or e--.

Methods inherited from class jeb.api.ast.Statement

attachTag, getSubElements, isCompound, replaceSubElement, retrieveTag

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

public static Assignment build(ILeftExpression left,
                               IExpression right)

Create a new assignment.

Parameters:

left - mandatory left operand, being assigned to

right - mandatory right operand, being assigned from

Returns:

the new assignment

Since:

1.4.201309040

getLeft

public ILeftExpression getLeft()

Get the left part of the assignment.

Returns:

the left expression, never null

Since:

1.4.201309040

getRight

public IExpression getRight()

Get the right part of the assignment.

Returns:

the right expression, null in the case of unary-operator assignments

Since:

1.4.201309040

setLeft

public void setLeft(ILeftExpression left)

Set the left part of the assignment.

Parameters:

left - mandatory left expression

Since:

1.4.201309040

setRight

public void setRight(IExpression right)

Set the right part of the assignment. The assignment cannot be a unary assignment.

Parameters:

right - mandatory right expression

Since:

1.4.201309040

isSimpleAssignment

public boolean isSimpleAssignment()

Determine if the assignment is a simple assignment.

Example: a = b

Returns:

true if the assignment is a simple assignment

Since:

1.4.201309040

isCombinedOperatorAssignment

public boolean isCombinedOperatorAssignment()

Determine if the assignment is a combined assignment.

Example: a += b

Returns:

true if the assignment is a combined assignment

Since:

1.5.201501110

isCompinedOperatorAssignment

public boolean isCompinedOperatorAssignment()

Deprecated.

Typo, left for legacy purpose. Use isCombinedOperatorAssignment().

Returns:

a boolean indicating whether or not the operator is a combined one

Since:

1.4.201309040

setCombinedOperator

public void setCombinedOperator(Operator operator)

Transform a simple assignment into a combined operator assignment.

The current assignment cannot be a unary assignment, else the method will throw.

Parameters:

operator - mandatory combined operator, there are eleven possibilities:
MUL, DIV, ADD, SUB, REM, SHL, SHR, USHR, AND, XOR, OR

Since:

1.4.201309040

getCombinedOperator

public Operator getCombinedOperator()

Retrieve the combined operator of a combined assignment.

Example: for "a += b", the operator returned would be "+"

Returns:

the operator that augments the simple assignment

Since:

1.5.201501110

getCompinedOperator

public Operator getCompinedOperator()

Deprecated.

Typo, left for legacy purpose. Use getCombinedOperator().

Returns:

the operator

Since:

1.4.201309040

isUnaryOperatorAssignment

public boolean isUnaryOperatorAssignment()

Determine if the assignment is a unary-operator assignment.

Example: i++ or --j

Returns:

true if the assignment is a unary-operator assignment

Since:

1.4.201309040

setUnaryOperator

public void setUnaryOperator(boolean is_increment,
                             boolean is_prefixed)

Transform the non-unary assignment into one of the four unary assignments: ++e, e++, --e, or e--.

Parameters:

is_increment - true for increment, false for decrement

is_prefixed - true for prefixed, false for postfixed

Since:

1.4.201309040

getUnaryOperator

public void getUnaryOperator(boolean[] r)

Retrieve the unary operator of a unary operator assignment.

Parameters:

r - mandatory 2-element array, will be set to {is_increment, is_prefixed}

Since:

1.4.201309040