soot.jimple.spark.geom.dataRep.CallsiteContextVar Maven / Gradle / Ivy

package soot.jimple.spark.geom.dataRep;

/*-
 * #%L
 * Soot - a J*va Optimization Framework
 * %%
 * Copyright (C) 2012 Richard Xiao
 * %%
 * 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 soot.jimple.spark.pag.Node;

/**
 * A general interface for generating the traditional context sensitive variable representation.
 *
 * @author xiao
 *
 */
public class CallsiteContextVar extends ContextVar {
  /*
   * If var is a local pointer or object, context is the callsite for the creation of the pointer or object. If var is a
   * instance field, context is the callsite for the creation of its base object.
   */
  public CgEdge context = null;

  public CallsiteContextVar() {
  }

  public CallsiteContextVar(CgEdge c, Node v) {
    context = c;
    var = v;
  }

  public CallsiteContextVar(CallsiteContextVar o) {
    context = o.context;
    var = o.var;
  }

  @Override
  public String toString() {
    return "<" + context.toString() + ", " + var.toString() + ">";
  }

  @Override
  public boolean equals(Object o) {
    CallsiteContextVar other = (CallsiteContextVar) o;
    return (other.context == context) && (other.var == var);
  }

  @Override
  public int hashCode() {
    int ch = 0;
    if (context != null) {
      ch = context.hashCode();
    }

    int ans = var.hashCode() + ch;
    if (ans < 0) {
      ans = -ans;
    }
    return ans;
  }

  @Override
  public boolean contains(ContextVar cv) {
    CallsiteContextVar ccv = (CallsiteContextVar) cv;
    if (context == ccv.context) {
      return true;
    }
    return false;
  }

  @Override
  public boolean merge(ContextVar cv) {
    // The behavior of merging callsite context sensitive variables is undefined.
    return false;
  }

  @Override
  public boolean intersect(ContextVar cv) {
    return contains(cv);
  }
}