Manage step return values (#226)

* Fix missing support of return values in steps

* Make return value of a step optional

* Add missing "Optional" uses for step returns

Co-authored-by: Didier Vojtisek <[email protected]>

Author: ebousse

framework/execution_framework/plugins/org.eclipse.gemoc.executionframework.engine/src/org/eclipse/gemoc/executionframework/engine/core/AbstractCommandBasedSequentialExecutionEngine.xtend

@@ -4,16 +4,18 @@
  * 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:
  *     Inria - initial API and implementation
  *******************************************************************************/
- package org.eclipse.gemoc.executionframework.engine.core
+package org.eclipse.gemoc.executionframework.engine.core
 
+import java.util.Arrays
+import java.util.concurrent.Callable
 import org.eclipse.emf.transaction.RecordingCommand
-import org.eclipse.gemoc.xdsmlframework.api.core.IRunConfiguration
 import org.eclipse.gemoc.xdsmlframework.api.core.IExecutionContext
-import java.util.Arrays
+import org.eclipse.gemoc.xdsmlframework.api.core.IRunConfiguration
+import java.util.Optional
 
 abstract class AbstractCommandBasedSequentialExecutionEngine<C extends IExecutionContext<R, ?, ?>, R extends IRunConfiguration> extends AbstractSequentialExecutionEngine<C, R> {
 
@@ -25,23 +27,28 @@ abstract class AbstractCommandBasedSequentialExecutionEngine<C extends IExecutio
 	 * @param operationName
 	 * @param operation
 	 */
-	protected def void executeOperation(Object caller, String className, String operationName, Runnable operation) {
+	protected def void executeOperation(Object caller, String className, String operationName,
+		Callable<Optional<Object>> operation) {
 		executeOperation(caller, #{}, className, operationName, operation);
 	}
-	
-	protected def void executeOperation(Object caller, Object[] parameters, String className, String operationName, Runnable operation) {
+
+	var Optional<Object> lastResult = null
+
+	protected def void executeOperation(Object caller, Object[] parameters, String className, String operationName,
+		Callable<Optional<Object>> operation) {
 		val RecordingCommand rc = new RecordingCommand(editingDomain) {
 			override doExecute() {
-				operation.run()
+				AbstractCommandBasedSequentialExecutionEngine.this.lastResult = operation.call()
 			}
 		}
 		try {
 			beforeExecutionStep(caller, className, operationName, rc, Arrays.asList(parameters))
 			rc.execute
-			afterExecutionStep
+			afterExecutionStep(lastResult)
+			lastResult = null
 		} finally {
 			// Important to remove notifiers.
 			rc.dispose
 		}
 	}
-}
+}

framework/execution_framework/plugins/org.eclipse.gemoc.executionframework.engine/src/org/eclipse/gemoc/executionframework/engine/core/AbstractExecutionEngine.java

@@ -18,6 +18,7 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Set;
 
 import org.eclipse.emf.ecore.resource.ResourceSet;
@@ -517,14 +518,17 @@ private boolean isInStep() {
 	/**
 	 * To be called just after each execution step by an implementing engine.
 	 */
-	protected void afterExecutionStep() {
+	protected void afterExecutionStep(Optional<Object> returnValue) {
 
 		RecordingCommand emptyrc = null;
 
 		try {
 
 			Step<?> step = currentSteps.pop();
-
+			if (returnValue.isPresent()) {
+				step.getMseoccurrence().getResult().add(returnValue.get());
+			}
+			
 			// We commit the transaction (which might be a different one
 			// than the one created earlier, or null if two operations
 			// end successively)

framework/execution_framework/plugins/org.eclipse.gemoc.executionframework.engine/src/org/eclipse/gemoc/executionframework/engine/core/AbstractSequentialExecutionEngine.java

@@ -12,12 +12,12 @@
 
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.Set;
 
 import org.eclipse.emf.ecore.EClass;
@@ -91,8 +91,8 @@ protected final void performStart() {
 	}
 
 	@Override
-	protected final void afterExecutionStep() {
-		super.afterExecutionStep();
+	protected final void afterExecutionStep(Optional<Object> returnValue) {
+		super.afterExecutionStep(returnValue);
 	}
 
 	/**
@@ -151,7 +151,6 @@ private Step<?> createStep(EObject caller, String className, String methodName,
 		} else {
 			result = traceAddon.getFactory().createStep(mse, args, new ArrayList<Object>());
 		}
-		result.getMseoccurrence().getParameters().addAll(Arrays.asList(args));
 		return result;
 	}