---

VInvokeCallBack.java

package edu.ksu.cis.bandera.bofa;

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Bandera, a Java(TM) analysis and transformation toolkit           *
 * Copyright (C) 1998, 1999                                          *
 * John Hatcliff (hatcliff@cis.ksu.edu)
 * All rights reserved.                                              *
 *                                                                   *
 * This work was done as a project in the SAnToS Laboratory,         *
 * Department of Computing and Information Sciences, Kansas State    *
 * University, USA (http://www.cis.ksu.edu/santos).                  *
 * It is understood that any modification not identified as such is  *
 * not covered by the preceding statement.                           *
 *                                                                   *
 * This work is free software; you can redistribute it and/or        *
 * modify it under the terms of the GNU Library General Public       *
 * License as published by the Free Software Foundation; either      *
 * version 2 of the License, or (at your option) any later version.  *
 *                                                                   *
 * This work 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 *
 * Library General Public License for more details.                  *
 *                                                                   *
 * You should have received a copy of the GNU Library General Public *
 * License along with this toolkit; if not, write to the             *
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,      *
 * Boston, MA  02111-1307, USA.                                      *
 *                                                                   *
 * Java is a trademark of Sun Microsystems, Inc.                     *
 *                                                                   *
 * To submit a bug report, send a comment, or get the latest news on *
 * this project and other SAnToS projects, please visit the web-site *
 *                http://www.cis.ksu.edu/santos                      *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

import java.util.Collection;
import java.util.List;

import ca.mcgill.sable.soot.NoSuchMethodException;
import ca.mcgill.sable.soot.SootClass;
import ca.mcgill.sable.soot.SootMethod;
import ca.mcgill.sable.soot.Type;
import ca.mcgill.sable.soot.jimple.Expr;
import ca.mcgill.sable.soot.jimple.Jimple;
import ca.mcgill.sable.soot.jimple.Local;
import ca.mcgill.sable.soot.jimple.VirtualInvokeExpr;
import ca.mcgill.sable.util.VectorList;

import org.apache.log4j.Category;

/*
 * VInvokeCallBack.java
 * $Id: VInvokeCallBack.java,v 1.1.1.1 2002/01/24 03:42:08 pserver Exp $
 */

/**
 *
 * This class provides the call back method to be invoked when method X is
 * encountered during the flow analysis.
 *
 * @author <a href="mailto:rvprasad@cis.ksu.edu">Venkatesh Prasad Ranganath</a>
 * @version $Name:  $($Revision: 1.1.1.1 $)
 */

public class VInvokeCallBack implements CallBack {
    /**
     * <code>jimple</code> is used to create jimple expression AST nodes.
     *
     */
    static private Jimple jimple;

    /**
     * <code>declClass</code> is the class in which the method being registered 
     * should be declared in the class hierarchy for the callback to occur.
     */
    private final String declClass;
        
    /**
     * <code>mname</code> is the name of the method when encountered the new
     * method is plugged in.  By default it is "start".
     */
    private final String mname;

    /**
     * <code>pmname</code> is the name of the plug-in method.  By default it is
     * "run". 
     */
    private final String pmname;

    static {
        jimple = Jimple.v();
    }

    /**
     * Provides logging through log4j.
     *
     */
    private Category cat;

    /**
     * Creates a new <code>VInvokeCallBack</code> instance.
     */
    public VInvokeCallBack() {
        cat = Category.getInstance(getClass().getName());
        declClass = "java.lang.Thread";
        mname = "start";
        pmname = "run";
    }
    /**
     * Creates a new <code>VInvokeCallBack</code> instance.
     *
     * @param declClass Name of the class declaring the method
     * <code>mname</code>. 
     * @param mname Name of the method that will trigger the inclusion.
     * @param pmname Name of the method to be included into the flow graph.
     */
    public VInvokeCallBack(String declClass, String mname, String pmname) {
        cat = Category.getInstance(getClass().getName());
        this.declClass = declClass;
        this.mname = mname;
        this.pmname = pmname;
    }
    /**
     * <code>callback</code> will be called by BOFA when java.lang.Thread.start
     * method invocation is encountered during flow analysis.
     *
     * @param e <code>Expr</code> object respresenting the expression which
     * triggered the callback.
     * @param o <code>Object</code> object representing the FGExpr object which
     * was processing the expression. 
     * @throw <code>ca.mcgill.sable.soot.NoSuchMethodException</code> is thrown
     * when run method is undefined in the given hierarchy.
     */
    public void callback(Expr e, Object o) {
        
        VirtualInvokeExpr v = (VirtualInvokeExpr) e;
        SootMethod sm = v.getMethod();

        if (Util.isAncestorOf(sm.getDeclaringClass(), declClass) 
            && sm.getName().equals(mname)) {
            SootClass runClass = Util.getDeclaringClass(BOFA.sootClassManager
                                                        .getClass(v.getBase()
                                                                  .getType()
                                                                  .toString()),
                                                        pmname);
            VirtualInvokeExpr v1 = 
                jimple.newVirtualInvokeExpr(
                   (ca.mcgill.sable.soot.jimple.Local)v.getBase(), 
                   runClass.getMethod(pmname), 
                   new VectorList());
            ((FGExpr)o).caseVirtualInvokeExpr(v1);
            cat.debug("Plugging a call to run method of class" 
                     + v.getBase().getType().toString() + ".");
        }
    }
}// VInvokeCallBack

---