Merge branch 'master' into debugger

Author: LadyCailin

src/main/java/com/laytonsmith/core/Script.java

@@ -661,6 +661,28 @@ private static Mixed evalLoop(EvalStack stack, Mixed lastResult, boolean hasResu
 							return pauseResult;
 						}
 					}
+					frame.setKeepIVariable(false);
+					result = ((FlowFunction<Object>) frame.getFlowFunction()).childCompleted(
+							t, frame.getFunctionState(), lastResult, frame.getEnv());
+					hasResult = false;
+				} else {
+					throw ConfigRuntimeException.CreateUncatchableException(
+							"Flow function in invalid state for " + data.val(), data.getTarget());
+				}
+
+				frame.setFunctionState(result.getState());
+				StepAction action = result.getAction();
+				if(action instanceof StepAction.Evaluate e) {
+					frame.setKeepIVariable(e.keepIVariable());
+					Environment evalEnv = e.getEnv() != null ? e.getEnv() : frame.getEnv();
+					stack.push(new StackFrame(e.getNode(), evalEnv, null, null));
+				} else if(action instanceof StepAction.Complete c) {
+					lastResult = c.getResult();
+					hasResult = true;
+					cleanupAndPop(stack, frame);
+				} else if(action instanceof StepAction.FlowControl fc) {
+					pendingFlowControl = fc;
+					cleanupAndPop(stack, frame);
 				}
 				continue;
 			}
@@ -771,6 +793,33 @@ private static Mixed debugPause(DebugContext debugCtx, EvalStack stack,
 			debugCtx.getListener().onPaused(snapshot);
 			return DEBUGGER_PAUSED;
 		}
+
+		return lastResult;
+	}
+
+	/**
+	 * Calls {@link FlowFunction#cleanup} if the frame has a FlowFunction that has begun,
+	 * then pops the frame from the stack.
+	 */
+	@SuppressWarnings("unchecked")
+	private static void cleanupAndPop(EvalStack stack, StackFrame frame) {
+		if(frame.hasFlowFunction() && frame.hasBegun()) {
+			((FlowFunction<Object>) frame.getFlowFunction()).cleanup(
+					frame.getNode().getTarget(), frame.getFunctionState(), frame.getEnv());
+		}
+		stack.pop();
+	}
+
+	/**
+	 * Given the parse tree and environment, executes the tree.
+	 *
+	 * @param c
+	 * @param env
+	 * @return
+	 * @throws CancelCommandException
+	 */
+	public Mixed eval(ParseTree c, final Environment env) throws CancelCommandException {
+		return iterativeEval(c, env);
 	}
 
 	/**

src/main/java/com/laytonsmith/core/StackFrame.java

@@ -29,7 +29,7 @@ public class StackFrame {
 	private final Environment env;
 	private final Function function;
 	private final FlowFunction<?> flowFunction;
-	private List<Mixed> args;
+	private final List<Mixed> args;
 	private int childIndex;
 	private boolean begun;
 	private Object functionState;
@@ -48,6 +48,7 @@ public StackFrame(ParseTree node, Environment env, Function function, FlowFuncti
 		this.env = env;
 		this.function = function;
 		this.flowFunction = flowFunction;
+		this.args = new ArrayList<>();
 		this.childIndex = 0;
 		this.begun = false;
 		this.functionState = null;
@@ -157,19 +158,13 @@ public ParseTree nextChild() {
 	 * Adds an evaluated child result to the args list (for simple mode).
 	 */
 	public void addArg(Mixed result) {
-		if(args == null) {
-			args = new ArrayList<>();
-		}
 		args.add(result);
 	}
 
 	/**
 	 * Returns the accumulated evaluated arguments (for simple mode).
 	 */
 	public Mixed[] getArgs() {
-		if(args == null) {
-			return new Mixed[0];
-		}
 		return args.toArray(new Mixed[0]);
 	}
 

src/main/java/com/laytonsmith/core/constructs/CClosure.java

@@ -275,6 +275,8 @@ public synchronized Environment getEnv() {
 	 * @throws CancelCommandException
 	 * @deprecated Use {@link #executeCallable(Environment, Target, Mixed...)} instead, which
 	 * provides the caller's environment and target for proper error reporting.
+	 * Functions that call closures should also consider extending {@link CallbackYield}
+	 * instead of calling this directly, which re-enters eval() and defeats the iterative interpreter.
 	 */
 	@Deprecated
 	public Mixed executeCallable(Mixed... values) {
@@ -311,7 +313,10 @@ public Mixed executeCallable(Mixed... values) {
 	 * @return The return value of the closure, or VOID if nothing was returned
 	 * @throws ConfigRuntimeException If any call inside the closure causes a CRE
 	 * @throws CancelCommandException If die() is called within the closure
+	 * @deprecated Functions that call closures should extend {@link CallbackYield}
+	 * instead of calling this directly, which re-enters eval() and defeats the iterative interpreter.
 	 */
+	@Deprecated
 	@Override
 	public Mixed executeCallable(Environment env, Target t, Mixed... values)
 			throws ConfigRuntimeException, CancelCommandException {

src/main/java/com/laytonsmith/core/environments/GlobalEnv.java

@@ -399,8 +399,7 @@ public List<Iterator> GetArrayAccessIteratorsFor(ArrayAccess array) {
 	 */
 	public StackTraceManager GetStackTraceManager() {
 		Thread currentThread = Thread.currentThread();
-		if(this.stackTraceManager == null
-				|| currentThread != this.stackTraceManagerThread) {
+		if(this.stackTraceManager == null || currentThread != this.stackTraceManagerThread) {
 			this.stackTraceManager = new StackTraceManager(this);
 			this.stackTraceManagerThread = currentThread;
 		}

src/main/java/com/laytonsmith/core/natives/interfaces/Callable.java

@@ -36,7 +36,10 @@ public interface Callable extends Mixed {
 	 * @return The return value of the callable, or VOID if nothing was returned
 	 * @throws ConfigRuntimeException If any call inside the callable causes a CRE
 	 * @throws CancelCommandException If die() is called within the callable
+	 * @deprecated Functions that call closures should extend {@link CallbackYield}
+	 * instead of calling this directly, which re-enters eval() and defeats the iterative interpreter.
 	 */
+	@Deprecated
 	Mixed executeCallable(Environment env, Target t, Mixed... values)
 			throws ConfigRuntimeException, CancelCommandException;
 

src/main/java/com/laytonsmith/tools/debugger/DebugSecurity.java

@@ -0,0 +1,17 @@
+package com.laytonsmith.tools.debugger;
+
+/**
+ * Specifies the security mode for the DAP debug server.
+ */
+public enum DebugSecurity {
+	/**
+	 * No authentication. Suitable for localhost-only debugging.
+	 */
+	NONE,
+
+	/**
+	 * SSH-style keypair authentication with TLS transport encryption.
+	 * Required for remote debugging.
+	 */
+	KEYPAIR
+}

src/main/resources/docs/LLVM_Development

@@ -329,4 +329,4 @@ Now %1 is a pointer to memory, which contains the value 0. To get 0 back, we hav
 for the various IR commands. Note that this is not necessarily the authoritative source though, reverse engineering \
 clang output is.
 * [https://borretti.me/article/compiling-llvm-ir-binary Compiling hand written LLVM, for test purposes.]
-* [https://mapping-high-level-constructs-to-llvm-ir.readthedocs.io/en/latest/README.html Guide for mapping high level language concepts to LLVM.]
+* [https://mapping-high-level-constructs-to-llvm-ir.readthedocs.io/en/latest/ Guide for mapping high level language concepts to LLVM.]