Merge pull request #179 from ponder-lab/issue_80

Some work on #80.

Author: khatchad

edu.cuny.hunter.streamrefactoring.core/src/edu/cuny/hunter/streamrefactoring/core/safe/Util.java

@@ -19,14 +19,27 @@
 
 public class Util {
 
-	private Util() {
-	}
+	/**
+	 * The {@link TypeName} of the type {@link java.util.Arrays}.
+	 */
+	private static final TypeName ARRAYS_TYPE_NAME = TypeName.string2TypeName("Ljava/util/Arrays");
+
+	/**
+	 * {@link Atom} corresponding the the stream() method.
+	 */
+	private static final Atom STREAM_METHOD_NAME_ATOM = Atom.findOrCreateAsciiAtom("stream");
+
+	/**
+	 * The {@link TypeName} for the type {@link java.util.stream.StreamSupport}.
+	 */
+	private static final TypeName STREAM_SUPPORT_TYPE_NAME = TypeName
+			.string2TypeName("Ljava/util/stream/StreamSupport");
 
 	/**
 	 * True iff the given {@link InstanceKey} corresponds with the given
 	 * {@link SSAInvokeInstruction} in the given {@link CallGraph}. In other words,
 	 * the result is true iff the instruction is used to create the instance.
-	 * 
+	 *
 	 * @param instanceKey
 	 *            An instance in question.
 	 * @param instruction
@@ -75,19 +88,24 @@ public static boolean instanceKeyCorrespondsWithInstantiationInstruction(Instanc
 				else if (callSiteReference.getProgramCounter() == instructionCallSite.getProgramCounter()) {
 					// compare declared targets.
 					MethodReference callSiteDeclaredTarget = callSiteReference.getDeclaredTarget();
+					TypeName callSiteTargetDeclaringClassName = callSiteDeclaredTarget.getDeclaringClass().getName();
+
 					MethodReference instructionCallDeclaredTarget = instructionCallSite.getDeclaredTarget();
+					TypeName instructionTargetDeclaringClassName = instructionCallDeclaredTarget.getDeclaringClass()
+							.getName();
 
-					if (callSiteDeclaredTarget.getDeclaringClass().getName()
-							.equals(instructionCallDeclaredTarget.getDeclaringClass().getName())
-							&& callSiteDeclaredTarget.getDeclaringClass().getName()
-									.equals(TypeName.string2TypeName("Ljava/util/Arrays"))
+					if (callSiteTargetDeclaringClassName.equals(instructionTargetDeclaringClassName)
+							&& (callSiteTargetDeclaringClassName.equals(ARRAYS_TYPE_NAME)
+									|| callSiteTargetDeclaringClassName.equals(STREAM_SUPPORT_TYPE_NAME))
 							&& callSiteDeclaredTarget.getName().equals(instructionCallDeclaredTarget.getName())
-							&& callSiteDeclaredTarget.getName().equals(Atom.findOrCreateAsciiAtom("stream")))
+							&& callSiteDeclaredTarget.getName().equals(STREAM_METHOD_NAME_ATOM))
 						return true;
 				}
 			}
 		}
 		return false;
 	}
 
+	private Util() {
+	}
 }

edu.cuny.hunter.streamrefactoring.core/src/edu/cuny/hunter/streamrefactoring/core/wala/Util.java

@@ -23,21 +23,13 @@
 
 public final class Util {
 
-	private Util() {
-	}
-	
-	public static String getOSName() {	
-		return System.getProperty("os.name");
-	}
-
-	public static boolean isWindows() {
-		return getOSName().startsWith("Windows");
-	}
+	private static final String OS_NAME = "os.name";
+	private static final String WINDOWS = "Windows";
 
 	/**
-	 * Enhance an {@link AnalysisScope} to include in a particular loader,
-	 * elements from a set of Eclipse projects
-	 * 
+	 * Enhance an {@link AnalysisScope} to include in a particular loader, elements
+	 * from a set of Eclipse projects
+	 *
 	 * @param loader
 	 *            the class loader in which new {@link Module}s will live
 	 * @param projectPaths
@@ -46,22 +38,52 @@ public static boolean isWindows() {
 	 *            the {@link AnalysisScope} under construction. This will be
 	 *            mutated.
 	 * @param seen
-	 *            set of {@link Module}s which have already been seen, and
-	 *            should not be added to the analysis scope
+	 *            set of {@link Module}s which have already been seen, and should
+	 *            not be added to the analysis scope
 	 */
 	private static void buildScope(ClassLoaderReference loader, Collection<EclipseProjectPath> projectPaths,
 			AnalysisScope scope, Collection<Module> seen) throws IOException {
 		for (EclipseProjectPath path : projectPaths) {
 			AnalysisScope pScope = path.toAnalysisScope((File) null);
-			for (Module m : pScope.getModules(loader)) {
+			for (Module m : pScope.getModules(loader))
 				if (!seen.contains(m)) {
 					seen.add(m);
 					scope.addToScope(loader, m);
 				}
-			}
 		}
 	}
 
+	public static String getOSName() {
+		return System.getProperty(OS_NAME);
+	}
+
+	public static boolean isWindows() {
+		return getOSName().startsWith(WINDOWS);
+	}
+
+	/**
+	 * make a {@link CallGraphBuilder} that uses call-string context sensitivity,
+	 * with call-string length limited to n, and a context-sensitive
+	 * allocation-site-based heap abstraction.
+	 */
+	public static SSAPropagationCallGraphBuilder makeNCFABuilder(int n, AnalysisOptions options, AnalysisCache cache,
+			IClassHierarchy cha, AnalysisScope scope) {
+		if (options == null)
+			throw new IllegalArgumentException("options is null");
+		addDefaultSelectors(options, cha);
+		addDefaultBypassLogic(options, scope, Util.class.getClassLoader(), cha);
+		ContextSelector appSelector = null;
+		SSAContextInterpreter appInterpreter = null;
+		SSAPropagationCallGraphBuilder result = new nCFABuilderWithActualParametersInContext(n, cha, options, cache,
+				appSelector, appInterpreter);
+		// nCFABuilder uses type-based heap abstraction by default, but we want
+		// allocation sites
+		result.setInstanceKeys(new ZeroXInstanceKeys(options, cha, result.getContextInterpreter(),
+				ZeroXInstanceKeys.ALLOCATIONS | ZeroXInstanceKeys.SMUSH_MANY | ZeroXInstanceKeys.SMUSH_PRIMITIVE_HOLDERS
+						| ZeroXInstanceKeys.SMUSH_STRINGS | ZeroXInstanceKeys.SMUSH_THROWABLES));
+		return result;
+	}
+
 	/**
 	 * create an analysis scope as the union of a bunch of EclipseProjectPath
 	 */
@@ -77,26 +99,7 @@ public static AnalysisScope mergeProjectPaths(Collection<EclipseProjectPath> pro
 		buildScope(ClassLoaderReference.Primordial, projectPaths, scope, seen);
 		return scope;
 	}
-	
-	/**
-	   * make a {@link CallGraphBuilder} that uses call-string context sensitivity,
-	   * with call-string length limited to n, and a context-sensitive
-	   * allocation-site-based heap abstraction.
-	   */
-	  public static SSAPropagationCallGraphBuilder makeNCFABuilder(int n, AnalysisOptions options, AnalysisCache cache,
-	      IClassHierarchy cha, AnalysisScope scope) {
-	    if (options == null) {
-	      throw new IllegalArgumentException("options is null");
-	    }
-	    addDefaultSelectors(options, cha);
-	    addDefaultBypassLogic(options, scope, Util.class.getClassLoader(), cha);
-	    ContextSelector appSelector = null;
-	    SSAContextInterpreter appInterpreter = null;
-	    SSAPropagationCallGraphBuilder result = new nCFABuilderWithActualParametersInContext(n, cha, options, cache, appSelector, appInterpreter);
-	    // nCFABuilder uses type-based heap abstraction by default, but we want allocation sites
-	    result.setInstanceKeys(new ZeroXInstanceKeys(options, cha, result.getContextInterpreter(), ZeroXInstanceKeys.ALLOCATIONS
-						| ZeroXInstanceKeys.SMUSH_MANY | ZeroXInstanceKeys.SMUSH_PRIMITIVE_HOLDERS | ZeroXInstanceKeys.SMUSH_STRINGS
-	        | ZeroXInstanceKeys.SMUSH_THROWABLES));
-	    return result;
-	  }
+
+	private Util() {
+	}
 }

edu.cuny.hunter.streamrefactoring.core/src/edu/cuny/hunter/streamrefactoring/core/wala/nCFABuilderWithActualParametersInContext.java

@@ -19,25 +19,23 @@ public class nCFABuilderWithActualParametersInContext extends SSAPropagationCall
 	public nCFABuilderWithActualParametersInContext(int n, IClassHierarchy cha, AnalysisOptions options,
 			AnalysisCache cache, ContextSelector appContextSelector, SSAContextInterpreter appContextInterpreter) {
 		super(cha, options, cache, new DefaultPointerKeyFactory());
-		if (options == null) {
+		if (options == null)
 			throw new IllegalArgumentException("options is null");
-		}
 
-		setInstanceKeys(new ClassBasedInstanceKeys(options, cha));
+		this.setInstanceKeys(new ClassBasedInstanceKeys(options, cha));
 
 		ContextSelector def = new DefaultContextSelector(options, cha);
 		ContextSelector contextSelector = appContextSelector == null ? def
 				: new DelegatingContextSelector(appContextSelector, def);
 		contextSelector = new nCFAContextWithReceiversSelector(n, contextSelector);
-		setContextSelector(contextSelector);
+		this.setContextSelector(contextSelector);
 
 		SSAContextInterpreter defI = new DefaultSSAInterpreter(options, cache);
 		defI = new DelegatingSSAContextInterpreter(
-				ReflectionContextInterpreter.createReflectionContextInterpreter(cha, options, getAnalysisCache()),
+				ReflectionContextInterpreter.createReflectionContextInterpreter(cha, options, this.getAnalysisCache()),
 				defI);
 		SSAContextInterpreter contextInterpreter = appContextInterpreter == null ? defI
 				: new DelegatingSSAContextInterpreter(appContextInterpreter, defI);
-		setContextInterpreter(contextInterpreter);
+		this.setContextInterpreter(contextInterpreter);
 	}
-
 }

edu.cuny.hunter.streamrefactoring.core/src/edu/cuny/hunter/streamrefactoring/core/wala/nCFAContextWithReceiversSelector.java

@@ -21,15 +21,25 @@ public class nCFAContextWithReceiversSelector extends nCFAContextSelector {
 
 	protected class CallStringTriple {
 
+		CGNode node;
+
+		CallSiteReference site;
+		IMethod target;
+
 		public CallStringTriple(CGNode node, CallSiteReference site, IMethod target) {
 			this.node = node;
 			this.site = site;
 			this.target = target;
 		}
 
-		CGNode node;
-		CallSiteReference site;
-		IMethod target;
+		@Override
+		public boolean equals(Object obj) {
+			if (obj instanceof CallStringTriple) {
+				CallStringTriple rhs = (CallStringTriple) obj;
+				return this.node.equals(rhs.node) && this.site.equals(rhs.site) && this.target.equals(rhs.target);
+			} else
+				return false;
+		}
 
 		@Override
 		public int hashCode() {
@@ -41,17 +51,13 @@ public int hashCode() {
 
 			return builder.toString().hashCode();
 		}
-
-		@Override
-		public boolean equals(Object obj) {
-			if (obj instanceof CallStringTriple) {
-				CallStringTriple rhs = (CallStringTriple) obj;
-				return this.node.equals(rhs.node) && this.site.equals(rhs.site) && this.target.equals(rhs.target);
-			} else
-				return false;
-		}
 	}
 
+	/**
+	 * The N to use if the instance implements BaseStream.
+	 */
+	public static final int CONTEXT_LENGTH_FOR_STREAMS = 2;
+
 	protected Map<CallStringTriple, CallStringWithReceivers> callStringWithReceiversMap = new HashMap<>();
 
 	public nCFAContextWithReceiversSelector(int n, ContextSelector base) {
@@ -61,15 +67,14 @@ public nCFAContextWithReceiversSelector(int n, ContextSelector base) {
 	@Override
 	public Context getCalleeTarget(CGNode caller, CallSiteReference site, IMethod callee,
 			InstanceKey[] actualParameters) {
-		Context baseContext = base.getCalleeTarget(caller, site, callee, actualParameters);
-		CallStringWithReceivers cs = getCallString(caller, site, callee, actualParameters);
-		if (cs == null) {
+		Context baseContext = this.base.getCalleeTarget(caller, site, callee, actualParameters);
+		CallStringWithReceivers cs = this.getCallString(caller, site, callee, actualParameters);
+		if (cs == null)
 			return baseContext;
-		} else if (baseContext == Everywhere.EVERYWHERE) {
+		else if (baseContext == Everywhere.EVERYWHERE)
 			return new CallStringContext(cs);
-		} else {
+		else
 			return new CallStringContextPair(cs, baseContext);
-		}
 	}
 
 	protected CallStringWithReceivers getCallString(CGNode caller, CallSiteReference site, IMethod target,
@@ -89,17 +94,15 @@ protected CallStringWithReceivers getCallString(CGNode caller, CallSiteReference
 			// not found. Compute it.
 			CallStringWithReceivers ret = null;
 
-			int length = getLength(caller, site, target);
+			int length = this.getLength(caller, site, target);
 			if (length > 0) {
-				if (caller.getContext().get(CALL_STRING) != null) {
+				if (caller.getContext().get(CALL_STRING) != null)
 					ret = new CallStringWithReceivers(site, caller.getMethod(), length,
 							(CallString) caller.getContext().get(CALL_STRING));
-				} else {
+				else
 					ret = new CallStringWithReceivers(site, caller.getMethod());
-				}
-			} else {
+			} else
 				ret = null;
-			}
 
 			// if we have a receiver.
 			if (ret != null && actualParameters != null && actualParameters.length > 0)
@@ -112,21 +115,21 @@ protected CallStringWithReceivers getCallString(CGNode caller, CallSiteReference
 	}
 
 	protected Map<CallStringTriple, CallStringWithReceivers> getCallStringWithReceiversMap() {
-		return callStringWithReceiversMap;
+		return this.callStringWithReceiversMap;
 	}
 
 	/**
 	 * {@inheritDoc}
-	 * 
-	 * @return 2 if the target's return type implements {@link BaseStream},
-	 *         otherwise, return the original value.
+	 *
+	 * @return CONTEXT_LENGTH_FOR_STREAMS if the target's return type implements
+	 *         {@link BaseStream}, otherwise, return the original value.
 	 */
 	@Override
 	protected int getLength(CGNode caller, CallSiteReference site, IMethod target) {
 		boolean implementsBaseStream = Util.implementsBaseStream(target.getReturnType(), target.getClassHierarchy());
 
 		if (implementsBaseStream)
-			return 2;
+			return CONTEXT_LENGTH_FOR_STREAMS;
 		else
 			return super.getLength(caller, site, target);
 	}