Method PerformLoopWhile

source/script.cpp:10793–10831

Lexikos: ACT_WHILE

// Lexikos: ACT_WHILE
ResultType Line::PerformLoopWhile(ResultToken *aResultToken, Line *&aJumpToLine)
{
	ResultType result = CONDITION_FALSE;
	Line *jump_to_line = nullptr;
	global_struct &g = *::g; // Might slightly speed up the loop below.

	for (;; ++g.mLoopIteration)
	{
		g_script.mCurrLine = this; // For error-reporting purposes.
#ifdef CONFIG_DEBUGGER
		// L31: Let the debugger break at the 'While' line each iteration. Before this change,
		// a While loop with empty body such as While FuncWithSideEffect() {} would be "hit"
		// (via breakpoint or step) only once even if the loop had multiple iterations.
		// A_Index was also reported as "0"; it will now be reported correctly.
		if (g_Debugger.IsConnected())
			g_Debugger.PreExecLine(this);
#endif
		// Evaluate the expression only now that A_Index has been set.
		auto args_result = ExpandArgs();
		if (args_result != OK)
			return args_result;

		// Unlike if(expression), performance isn't significantly improved to make cases like
		// "while x" and "while %x%" into non-expressions (the latter actually performs much
		// better as an expression).  That is why the following check is much simpler than the
		// one used at ACT_IF in EvaluateCondition():
		if (!ResultToBOOL(ARG1))
			break;

		PERFORMLOOP_EXECUTE_BODY

		// Before re-evaluating the condition, add it to the ListLines log again.  This is done
		// at the end of the loop rather than the beginning because ExecUntil already added the
		// line once immediately before the first iteration.
		if (g.ListLinesIsEnabled)
			LOG_LINE(this)
	} // for()
	return result; // The script's loop is now over.
}