soot.jimple.internal.AbstractBinopExpr Maven / Gradle / Ivy

package soot.jimple.internal;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 1999 Patrick Lam
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 2.1 of the
 * License, or (at your option) any later version.
 * 
 * This program 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 Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.util.ArrayList;
import java.util.List;

import soot.UnitPrinter;
import soot.Value;
import soot.ValueBox;
import soot.grimp.PrecedenceTest;
import soot.jimple.Expr;

@SuppressWarnings("serial")
public abstract class AbstractBinopExpr implements Expr {
  protected ValueBox op1Box;
  protected ValueBox op2Box;

  public Value getOp1() {
    return op1Box.getValue();
  }

  public Value getOp2() {
    return op2Box.getValue();
  }

  public ValueBox getOp1Box() {
    return op1Box;
  }

  public ValueBox getOp2Box() {
    return op2Box;
  }

  public void setOp1(Value op1) {
    op1Box.setValue(op1);
  }

  public void setOp2(Value op2) {
    op2Box.setValue(op2);
  }

  @Override
  public final List getUseBoxes() {
    List list = new ArrayList();

    list.addAll(op1Box.getValue().getUseBoxes());
    list.add(op1Box);
    list.addAll(op2Box.getValue().getUseBoxes());
    list.add(op2Box);

    return list;
  }

  public boolean equivTo(Object o) {
    if (o instanceof AbstractBinopExpr) {
      AbstractBinopExpr abe = (AbstractBinopExpr) o;
      return op1Box.getValue().equivTo(abe.op1Box.getValue()) && op2Box.getValue().equivTo(abe.op2Box.getValue())
          && getSymbol().equals(abe.getSymbol());
    }
    return false;
  }

  /** Returns a hash code for this object, consistent with structural equality. */
  public int equivHashCode() {
    return op1Box.getValue().equivHashCode() * 101 + op2Box.getValue().equivHashCode() + 17 ^ getSymbol().hashCode();
  }

  /** Returns the unique symbol for an operator. */
  abstract protected String getSymbol();

  abstract public Object clone();

  public String toString() {
    Value op1 = op1Box.getValue(), op2 = op2Box.getValue();
    String leftOp = op1.toString(), rightOp = op2.toString();

    return leftOp + getSymbol() + rightOp;
  }

  public void toString(UnitPrinter up) {
    // Value val1 = op1Box.getValue();
    // Value val2 = op2Box.getValue();

    if (PrecedenceTest.needsBrackets(op1Box, this)) {
      up.literal("(");
    }
    op1Box.toString(up);
    if (PrecedenceTest.needsBrackets(op1Box, this)) {
      up.literal(")");
    }

    up.literal(getSymbol());

    if (PrecedenceTest.needsBracketsRight(op2Box, this)) {
      up.literal("(");
    }
    op2Box.toString(up);
    if (PrecedenceTest.needsBracketsRight(op2Box, this)) {
      up.literal(")");
    }
  }
}