🚀 Add loop-counter & Improve loops

src/main/java/ch/njol/skript/expressions/ExprLoopIteration.java

@@ -0,0 +1,131 @@
+/**
+ *   This file is part of Skript.
+ *
+ *  Skript is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Skript is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright Peter Güttinger, SkriptLang team and contributors
+ */
+package ch.njol.skript.expressions;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.ExpressionType;
+import ch.njol.skript.lang.Loop;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.lang.TriggerSection;
+import ch.njol.skript.lang.util.SimpleExpression;
+import ch.njol.skript.sections.SecLoop;
+import ch.njol.skript.sections.SecWhile;
+import ch.njol.skript.util.Utils;
+import ch.njol.util.Kleenean;
+import org.bukkit.event.Event;
+import org.eclipse.jdt.annotation.Nullable;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+@Name("Loop Iteration")
+@Description("Returns the loop's current iteration count (for both normal and while loop).")
+@Examples({
+	"while player is online:",
+		"\tgive player 1 stone",
+		"\twait 5 ticks",
+		"\tif loop-counter > 30:",
+			"\t\tstop loop",
+	"",
+	"loop {top-balances::*}:",
+		"\tif loop-iteration <= 10:",
+		"\t\tbroadcast \"##%loop-iteration% %loop-index% has $%loop-value%\"",
+})
+@Since("INSERT VERSION")
+public class ExprLoopIteration extends SimpleExpression<Number> {
+
+	static {
+		Skript.registerExpression(ExprLoopIteration.class, Number.class, ExpressionType.SIMPLE, "[the] loop-<.+>");
+	}
+
+	@SuppressWarnings("NotNullFieldNotInitialized")
+	Loop loop;
+
+	private Pattern LOOP_PATTERN = Pattern.compile("^(.+)-(\\d+)$");
+
+	@Override
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		String s = "" + parseResult.regexes.get(0).group();
+		int i = -1;
+		Matcher m = LOOP_PATTERN.matcher(s);
+		if (m.matches()) {
+			s = m.group(1);
+			i = Utils.parseInt("" + m.group(2));
+		}
+
+		if (!("iteration".equals(s) || "counter".equals(s))) {
+			return false;
+		}
+
+		int j = 1;
+		Loop loop = null;
+
+		for (TriggerSection l : getParser().getCurrentSections()) {
+			if (!(l instanceof SecWhile) && !(l instanceof SecLoop))
+				continue;
+
+			if (j < i) {
+				j++;
+				continue;
+			}
+			if (loop != null) {
+				Skript.error("There are multiple loops that match loop-" + s + ". Use loop-" + s + "-1/2/3/etc. to specify which loop's " + s + " you want.");
+				return false;
+			}
+			loop = (Loop) l;
+
+			if (j == i)
+				break;
+		}
+
+		if (loop == null) {
+			Skript.error("There's no loop that matches 'loop-" + s + "-" + i + "'");
+			return false;
+		}
+
+		this.loop = loop;
+		return true;
+	}
+
+	@Override
+	protected Number[] get(Event e) {
+		return new Number[] { loop.getLoopCounter() };
+	}
+
+	@Override
+	public Class<? extends Number> getReturnType() {
+		return Number.class;
+	}
+
+	@Override
+	public boolean isSingle() {
+		return true;
+	}
+
+	@Override
+	public String toString(@Nullable Event e, boolean debug) {
+		return "loop counter of " + loop.toString(e, debug);
+	}
+
+}

src/main/java/ch/njol/skript/expressions/ExprLoopValue.java

@@ -31,7 +31,6 @@
 import ch.njol.skript.lang.Variable;
 import ch.njol.skript.lang.util.ConvertedExpression;
 import ch.njol.skript.lang.util.SimpleExpression;
-import ch.njol.skript.log.ErrorQuality;
 import ch.njol.skript.registrations.Classes;
 import ch.njol.skript.registrations.Converters;
 import ch.njol.skript.sections.SecLoop;
@@ -47,22 +46,26 @@
 
 /**
  * Used to access a loop's current value.
- * <p>
- * TODO expression to get the current # of execution (e.g. loop-index/number/count/etc (not number though));
- * 
  * @author Peter Güttinger
  */
 @Name("Loop value")
 @Description("The currently looped value.")
-@Examples({"# countdown:",
-		"loop 10 times:",
-		"	message \"%11 - loop-number%\"",
-		"	wait a second",
-		"# generate a 10x10 floor made of randomly coloured wool below the player:",
-		"loop blocks from the block below the player to the block 10 east of the block below the player:",
-		"	loop blocks from the loop-block to the block 10 north of the loop-block:",
-		"		set loop-block-2 to any wool"})
-@Since("1.0")
+@Examples({
+	"# Countdown",
+	"loop 10 times:",
+		"\tmessage \"%11 - loop-number%\"",
+		"\twait a second",
+	"",
+	"# Generate a 10x10 floor made of randomly colored wool below the player",
+	"loop blocks from the block below the player to the block 10 east of the block below the player:",
+		"\tloop blocks from the loop-block to the block 10 north of the loop-block:",
+			"\t\tset loop-block-2 to any wool",
+	"",
+	"loop {top-balances::*}:",
+		"\tloop-iteration <= 10",
+		"\tsend \"##%loop-iteration% %loop-index% has $%loop-value%\"",
+})
+@Since("1.0, INSERT VERSION (loop-counter)")
 public class ExprLoopValue extends SimpleExpression<Object> {
 	static {
 		Skript.registerExpression(ExprLoopValue.class, Object.class, ExpressionType.SIMPLE, "[the] loop-<.+>");
@@ -78,17 +81,23 @@ public class ExprLoopValue extends SimpleExpression<Object> {
 	boolean isVariableLoop = false;
 	// if this loops a variable and isIndex is true, return the index of the variable instead of the value
 	boolean isIndex = false;
-
+
+	private Pattern LOOP_PATTERN = Pattern.compile("^(.+)-(\\d+)$");
+
 	@Override
 	public boolean init(Expression<?>[] vars, int matchedPattern, Kleenean isDelayed, ParseResult parser) {
 		name = parser.expr;
 		String s = "" + parser.regexes.get(0).group();
 		int i = -1;
-		Matcher m = Pattern.compile("^(.+)-(\\d+)$").matcher(s);
+		Matcher m = LOOP_PATTERN.matcher(s);
 		if (m.matches()) {
 			s = "" + m.group(1);
 			i = Utils.parseInt("" + m.group(2));
 		}
+
+		if ("counter".equals(s) || "iteration".equals(s)) // ExprLoopIteration - in case of classinfo conflicts
+			return false;
+
 		Class<?> c = Classes.getClassFromUserInput(s);
 		int j = 1;
 		SecLoop loop = null;
@@ -100,7 +109,7 @@ public boolean init(Expression<?>[] vars, int matchedPattern, Kleenean isDelayed
 					continue;
 				}
 				if (loop != null) {
-					Skript.error("There are multiple loops that match loop-" + s + ". Use loop-" + s + "-1/2/3/etc. to specify which loop's value you want.", ErrorQuality.SEMANTIC_ERROR);
+					Skript.error("There are multiple loops that match loop-" + s + ". Use loop-" + s + "-1/2/3/etc. to specify which loop's value you want.");
 					return false;
 				}
 				loop = l;
@@ -109,7 +118,7 @@ public boolean init(Expression<?>[] vars, int matchedPattern, Kleenean isDelayed
 			}
 		}
 		if (loop == null) {
-			Skript.error("There's no loop that matches 'loop-" + s + "'", ErrorQuality.SEMANTIC_ERROR);
+			Skript.error("There's no loop that matches 'loop-" + s + "'");
 			return false;
 		}
 		if (loop.getLoopedExpression() instanceof Variable) {
@@ -126,9 +135,9 @@ public boolean isSingle() {
 		return true;
 	}
 
-	@SuppressWarnings("unchecked")
 	@Override
 	@Nullable
+	@SuppressWarnings("unchecked")
 	protected <R> ConvertedExpression<Object, ? extends R> getConvertedExpr(Class<R>... to) {
 		if (isVariableLoop && !isIndex) {
 			Class<R> superType = (Class<R>) Utils.getSuperType(to);
@@ -165,6 +174,9 @@ protected Object[] get(Event e) {
 			one[0] = current.getValue();
 			return one;
 		}
+//		else if (isWhileLoop) {
+//		}
+
 		Object[] one = (Object[]) Array.newInstance(getReturnType(), 1);
 		one[0] = loop.getCurrent(e);
 		return one;

src/main/java/ch/njol/skript/lang/Loop.java

@@ -0,0 +1,34 @@
+/**
+ *   This file is part of Skript.
+ *
+ *  Skript is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Skript is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright Peter Güttinger, SkriptLang team and contributors
+ */
+package ch.njol.skript.lang;
+
+/**
+ * Represents a loop section.
+ * 
+ * @see ch.njol.skript.sections.SecWhile
+ * @see ch.njol.skript.sections.SecLoop
+ */
+public interface Loop extends Debuggable {
+
+	/**
+	 * @return The current loop counter
+	 */
+	long getLoopCounter();
+
+}

src/main/java/ch/njol/skript/sections/SecLoop.java

@@ -22,6 +22,7 @@
 import ch.njol.skript.SkriptAPIException;
 import ch.njol.skript.config.SectionNode;
 import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.Loop;
 import ch.njol.skript.lang.Section;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.skript.lang.TriggerItem;
@@ -39,7 +40,7 @@
 import java.util.Map;
 import java.util.WeakHashMap;
 
-public class SecLoop extends Section {
+public class SecLoop extends Section implements Loop {
 
 	static {
 		Skript.registerSection(SecLoop.class, "loop %objects%");
@@ -53,6 +54,7 @@ public class SecLoop extends Section {
 
 	@Nullable
 	private TriggerItem actualNext;
+	private long loopCounter = 0;
 
 	@Override
 	public boolean init(Expression<?>[] exprs,
@@ -101,8 +103,10 @@ protected TriggerItem walk(Event e) {
 		if (iter == null || !iter.hasNext()) {
 			exit(e);
 			debug(e, false);
+			loopCounter = 0;
 			return actualNext;
 		} else {
+			loopCounter++;
 			current.put(e, iter.next());
 			return walk(e, true);
 		}
@@ -137,4 +141,9 @@ public void exit(Event event) {
 		current.remove(event);
 		currentIter.remove(event);
 	}
+
+	@Override
+	public long getLoopCounter() {
+		return loopCounter;
+	}
 }

src/main/java/ch/njol/skript/sections/SecWhile.java

@@ -22,6 +22,7 @@
 import ch.njol.skript.config.SectionNode;
 import ch.njol.skript.lang.Condition;
 import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.Loop;
 import ch.njol.skript.lang.Section;
 import ch.njol.skript.lang.SkriptParser.ParseResult;
 import ch.njol.skript.lang.TriggerItem;
@@ -31,10 +32,10 @@
 
 import java.util.List;
 
-public class SecWhile extends Section {
+public class SecWhile extends Section implements Loop {
 
 	static {
-		Skript.registerSection(SecWhile.class, "[(1¦do)] while <.+>");
+		Skript.registerSection(SecWhile.class, "[(:do)] while <.+>");
 	}
 
 	@SuppressWarnings("NotNullFieldNotInitialized")
@@ -45,8 +46,10 @@ public class SecWhile extends Section {
 
 	private boolean doWhile;
 	private boolean ranDoWhile = false;
+	private int loopCounter = 0;
 
 	@Override
+	@SuppressWarnings("unchecked")
 	public boolean init(Expression<?>[] exprs,
 						int matchedPattern,
 						Kleenean isDelayed,
@@ -58,23 +61,24 @@ public boolean init(Expression<?>[] exprs,
 		condition = Condition.parse(expr, "Can't understand this condition: " + expr);
 		if (condition == null)
 			return false;
-		doWhile = parseResult.mark == 1;
-		loadOptionalCode(sectionNode);
 
+		doWhile = parseResult.hasTag("do");
+		loadOptionalCode(sectionNode);
 		super.setNext(this);
-
 		return true;
 	}
 
 	@Nullable
 	@Override
 	protected TriggerItem walk(Event e) {
-		if ((doWhile && !ranDoWhile) || condition.check(e)) {
+		if (((doWhile && !ranDoWhile) || condition.check(e))) {
 			ranDoWhile = true;
+			loopCounter++;
 			return walk(e, true);
 		} else {
 			reset();
 			debug(e, false);
+			loopCounter = 0;
 			return actualNext;
 		}
 	}
@@ -99,4 +103,8 @@ public void reset() {
 		ranDoWhile = false;
 	}
 
+	@Override
+	public long getLoopCounter() {
+		return loopCounter;
+	}
 }