Script canceling cleanup

Author: Col-E

recaf-core/src/main/java/software/coley/recaf/services/plugin/CdiClassAllocator.java

@@ -35,8 +35,10 @@ public <T> T instance(@Nonnull Class<T> cls) throws AllocationException {
 		try {
 			// Create bean
 			Bean<T> bean = (Bean<T>) classBeanMap.computeIfAbsent(cls, c -> {
-				// TODO bugged.
-				// Equivalence check is based on the class name and does not include the loader.
+				// TODO something here is bugged
+				//  bean.create(creationalContext).getClass().getClassLoader() == cls.getClassLoader()
+				//   - Evaluates to false
+				//   - In AnnotatedTypeIdentifier#forBackedAnnotatedType the ClassLoader is not considered, just the class's name
 				AnnotatedType<T> annotatedClass = beanManager.createAnnotatedType((Class<T>) c);
 				BeanAttributes<T> attributes = beanManager.createBeanAttributes(annotatedClass);
 				InjectionTargetFactory<T> factory = beanManager.getInjectionTargetFactory(annotatedClass);

recaf-core/src/main/java/software/coley/recaf/services/script/CancellationSingleton.java

@@ -4,27 +4,41 @@
 
 /**
  * Cancellation singleton.
+ * <p>
  * Injected into generated scripts.
- * Do not use in normal code.
+ * <b>Do not use in normal code</b>.
  *
  * @author xDark
+ * @see InsertCancelSignalVisitor
+ * @see GenerateResult#requestStop()
  */
 public final class CancellationSingleton {
 	private static volatile boolean shouldStop;
 
-	private CancellationSingleton() {
-	}
+	private CancellationSingleton() {}
 
-	// Names and descriptors are known to the visitor/runtime.
-	// See InsertCancelSignalVisitor.
-	// See GenerateResult.
+	/**
+	 * Schedules cancellation of the script.
+	 */
 	public static void stop() {
 		shouldStop = true;
 	}
 
+	/**
+	 * Clears any prior cancellation request.
+	 */
+	public static void reset() {
+		shouldStop = false;
+	}
+
+	/**
+	 * Polls for cancellation.
+	 *
+	 * @throws CancelSignal
+	 * 		If cancellation has been requested.
+	 */
 	public static void poll() {
-		if (shouldStop) {
+		if (shouldStop)
 			throw CancelSignal.get();
-		}
 	}
 }

recaf-core/src/main/java/software/coley/recaf/services/script/GenerateResult.java

@@ -26,21 +26,40 @@ public boolean wasSuccess() {
 	}
 
 	/**
-	 * Attempts to stop the script. If the generation failed,
-	 * this method will do nothing.
+	 * Attempts to stop the script. If the generation failed, this method will do nothing.
+	 * <p>
+	 * Cancellation is scoped to the generated class loader that owns {@link #cls()}.
+	 * Callers that wish to stop running scripts must use {@link ScriptEngine#run(GenerateResult)}
+	 * and track the returned instance for stopping.
 	 *
-	 * @throws IllegalStateException If something went wrong.
+	 * @throws IllegalStateException
+	 * 		If something went wrong.
 	 */
 	public void requestStop() {
+		invokeCancellationSingleton("stop");
+	}
+
+	/**
+	 * Clears any prior request to stop the script. If the generation failed, this method will do nothing.
+	 *
+	 * @throws IllegalStateException
+	 * 		If something went wrong.
+	 */
+	public void resetStop() {
+		invokeCancellationSingleton("reset");
+	}
+
+	private void invokeCancellationSingleton(@Nonnull String methodName) {
 		Class<?> cls = this.cls;
-		if (cls == null) return;
+		if (cls == null)
+			return;
 		try {
 			Class<?> cancellationSingleton = cls.getClassLoader().loadClass(CancellationSingleton.class.getName());
-			cancellationSingleton.getDeclaredMethod("stop").invoke(null);
+			cancellationSingleton.getDeclaredMethod(methodName).invoke(null);
 		} catch (InvocationTargetException ex) {
 			throw new IllegalStateException(ex.getTargetException());
 		} catch (Exception ex) {
 			throw new IllegalStateException(ex);
 		}
 	}
-}
+}