From 57742fc75a76ff5069ffa53a4440c86227f0f2ec Mon Sep 17 00:00:00 2001 From: dolby-oss Date: Fri, 27 Apr 2007 14:35:49 +0000 Subject: [PATCH] add comments git-svn-id: https://wala.svn.sourceforge.net/svnroot/wala/trunk@1021 f5eafffb-2e1d-0410-98e4-8ec43c5233c4 --- .../src/com/ibm/wala/ssa/SSAInstruction.java | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/com.ibm.wala.core/src/com/ibm/wala/ssa/SSAInstruction.java b/com.ibm.wala.core/src/com/ibm/wala/ssa/SSAInstruction.java index fed885b60..b898a778a 100644 --- a/com.ibm.wala.core/src/com/ibm/wala/ssa/SSAInstruction.java +++ b/com.ibm.wala.core/src/com/ibm/wala/ssa/SSAInstruction.java @@ -31,7 +31,23 @@ public abstract class SSAInstruction implements IInstruction { } /** - * TODO: document me ... what do my parameters mean? (Julian?) + * This method is meant to be used during SSA conversion for an IR + * that is not in SSA form. It creates a new SSAInstruction of the + * same type as the receiver, with a combination of the receiver's + * uses and defs and those from the method parameters. + * + * In particular, if the 'defs' parameter is null, then the new + * instruction has the same defs as the receiver. If 'defs' is not + * null, it must be an array with a size equal to the number of + * defs that the receiver instruction has. In this case, the new + * instruction has defs taken from the array. The uses of the new + * instruction work in the same way with the 'uses' parameter. + * + * Note that this only applies to CAst-based IR translation, since + * Java bytecode-based IR generation uses a different SSA + * construction mechanism. + * + * @see com.ibm.wala.cast.ir.ssa.SSAConversion */ public abstract SSAInstruction copyForSSA(int[] defs, int[] uses);