/*******************************************************************************
* Copyright (c) 2002 - 2006 IBM Corporation.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package com.ibm.wala.ipa.callgraph;
import com.ibm.wala.classLoader.CallSiteReference;
import com.ibm.wala.classLoader.IClass;
import com.ibm.wala.classLoader.IMethod;
/**
* This interface represents policies for selecting a method to call at a given invocation site. The most obvious such policy would
* be to look at the relevant class hierarchy and lookup the appropriate method based on the type reference and name and descriptor
* at the call site. However, other policies are possible for purposes such as providing an abstraction of unanalyzed libraries or
* specialized J2EE functionality.
*
* Such policies are consulted by the different analysis mechanisms, both the flow-based and non-flow algorithms. The current
* mechanism is that the policy object are registered with the AnalysisOptions object, and all analyses that need to analyze
* invocations ask that object for the method selector to use.
*
* In general, for specialized selectors, it is good practice to build selectors that handle the special case of interest, and
* otherwise delegate to a child selector. When registering with the AnalysisOptions object, make the child selector be whatever the
* options object had before.
*/
public interface MethodTargetSelector {
/**
* Given a calling node, a call site and (optionally) a dispatch type, return the target method to be called.
*
* @param caller the GCNode in the call graph containing the call
* @param site the call site reference of the call site
* @param receiver the type of the target object or null
* @return the method to be called.
*/
IMethod getCalleeTarget(CGNode caller, CallSiteReference site, IClass receiver);
}