Fix plain Jass modulo semantics (#1209)

Author: Frotty

de.peeeq.wurstscript/parserspec/jass.parseq

@@ -75,6 +75,7 @@ JassOpBinary =
 	| JassOpMinus()
 	| JassOpMult()
 	| JassOpDiv()
+	| JassOpMod()
 
 JassOpUnary = 
 	  JassOpNot()

de.peeeq.wurstscript/src/main/antlr/de/peeeq/wurstscript/antlr/Jass.g4

@@ -163,7 +163,7 @@ PLUS: '+';
 MINUS: '-';
 MULT: '*';
 DIV_REAL: '/';
-MOD_REAL: '%';
+MOD_INT: '%';
 PAREN_LEFT: '(';
 PAREN_RIGHT: ')';
 BRACKET_LEFT: '[';

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstio/jassinterpreter/JassInterpreter.java

@@ -2,6 +2,7 @@
 
 import com.google.common.collect.Maps;
 import de.peeeq.wurstscript.WLogger;
+import de.peeeq.wurstscript.WurstOperator;
 import de.peeeq.wurstscript.intermediatelang.*;
 import de.peeeq.wurstscript.intermediatelang.interpreter.AbstractInterpreter;
 import de.peeeq.wurstscript.intermediatelang.interpreter.TimerMockHandler;
@@ -310,6 +311,12 @@ public ILconst case_JassOpDiv(JassOpDiv jassOpDiv) {
                         return getLeftNum().div(getRightNum());
                     }
 
+                    @Override
+                    public ILconst case_JassOpMod(JassOpMod jassOpMod) {
+                        return new ILconstInt(WurstOperator.jassModuloInteger(
+                            ((ILconstInt) getLeft()).getVal(), ((ILconstInt) getRight()).getVal()));
+                    }
+
                     @Override
                     public ILconst case_JassOpLess(JassOpLess jassOpLess) {
                         return getLeftNum().less(getRightNum());

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstio/jassinterpreter/providers/LuaEnsureTypeProvider.java

@@ -1,5 +1,6 @@
 package de.peeeq.wurstio.jassinterpreter.providers;
 
+import de.peeeq.wurstscript.WurstOperator;
 import de.peeeq.wurstscript.intermediatelang.ILconstInt;
 import de.peeeq.wurstscript.intermediatelang.ILconstReal;
 import de.peeeq.wurstscript.intermediatelang.ILconstString;
@@ -50,7 +51,7 @@ public ILconstInt __wurst_rawFloorDivInt(ILconstInt a, ILconstInt b) {
     }
 
     public ILconstInt __wurst_rawFmodInt(ILconstInt a, ILconstInt b) {
-        return ILconstInt.create(a.getVal() % b.getVal());
+        return ILconstInt.create(WurstOperator.jassModuloInteger(a.getVal(), b.getVal()));
     }
 
     public ILconstReal __wurst_rawFmodReal(ILconstReal a, ILconstReal b) {

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/WurstOperator.java

@@ -27,6 +27,7 @@ public enum WurstOperator {
     DIV_INT("div", 2),
     MOD_REAL("%", 2),
     MOD_INT("mod", 2),
+    JASS_MOD_INT("%", 2),
     NOT("not", 1),
     UNARY_MINUS("-", 1);
 
@@ -75,6 +76,8 @@ public JassOpBinary jassTranslateBinary() {
             case MOD_INT:
             case MOD_REAL:
                 throw new Error("Cannot translate modulo");
+            case JASS_MOD_INT:
+                return JassAst.JassOpMod();
             case MULT:
                 return JassAst.JassOpMult();
             case NOTEQ:
@@ -110,6 +113,7 @@ public LuaOpBinary luaTranslateBinary() {
             case MOD_REAL:
                 return LuaAst.LuaOpMod();
             case MOD_INT:
+            case JASS_MOD_INT:
                 throw new Error("Cannot translate modulo int");
             case MULT:
                 return LuaAst.LuaOpMult();
@@ -150,6 +154,8 @@ public ILconst evaluateBinaryOperator(ILconst left,
                 return ((ILconstNum) left).sub((ILconstNum) right.get());
             case MOD_INT:
                 return new ILconstInt(moduloInteger(((ILconstInt) left).getVal(), ((ILconstInt) right.get()).getVal()));
+            case JASS_MOD_INT:
+                return new ILconstInt(jassModuloInteger(((ILconstInt) left).getVal(), ((ILconstInt) right.get()).getVal()));
             case MOD_REAL:
                 return new ILconstReal(moduloReal(getReal(left), getReal(right.get())));
             case MULT:
@@ -180,6 +186,11 @@ public static int moduloInteger(int a, int b) {
         return r;
     }
 
+    /** Native Jass {@code %}: integer-only remainder truncated toward zero. */
+    public static int jassModuloInteger(int a, int b) {
+        return a % b;
+    }
+
     /** Reference semantics for Wurst's real {@code mod}; see {@link #moduloInteger}. */
     public static float moduloReal(float a, float b) {
         float r = a % b;

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/attributes/AttrExprType.java

@@ -315,6 +315,7 @@ public static WurstType calculate(final ExprBinary term) {
                         "operands " + leftType + " and " + rightType);
                 return WurstTypeUnknown.instance();
             case MOD_INT:
+            case JASS_MOD_INT:
             case DIV_INT:
                 if (leftType.isSubtypeOf(WurstTypeInt.instance(), term) && rightType.isSubtypeOf(WurstTypeInt.instance(), term)) {
                     return leftType;

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/attributes/prettyPrint/PrettyPrinter.java

@@ -236,6 +236,7 @@ public static int precedence(WurstOperator op) {
             case DIV_REAL:
             case MOD_INT:
             case MOD_REAL:
+            case JASS_MOD_INT:
                 return 4;
 
             case PLUS:

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/intermediatelang/optimizer/ConstantAndCopyPropagation.java

@@ -486,6 +486,7 @@ private void analyzeComponent(List<Node> scc, Map<Node, Knowledge> knowledge) {
                     case MULT: return JassIm.ImIntVal(l * r);
                     case DIV_INT: if (r != 0) return JassIm.ImIntVal(l / r); break;
                     case MOD_INT: if (r != 0) return JassIm.ImIntVal(WurstOperator.moduloInteger(l, r)); break;
+                    case JASS_MOD_INT: if (r != 0) return JassIm.ImIntVal(WurstOperator.jassModuloInteger(l, r)); break;
                     // IMPORTANT: Return ImBoolVal for comparisons, not ImIntVal!
                     case EQ: return JassIm.ImBoolVal(l == r);
                     case NOTEQ: return JassIm.ImBoolVal(l != r);

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/intermediatelang/optimizer/SimpleRewrites.java

@@ -551,6 +551,12 @@ private boolean optimizeIntInt(ImOperatorCall opc, boolean wasViable, ImIntVal l
                     isArithmetic = true;
                 }
                 break;
+            case JASS_MOD_INT:
+                if (i2 != 0) {
+                    resultVal = WurstOperator.jassModuloInteger(i1, i2);
+                    isArithmetic = true;
+                }
+                break;
             case MOD_REAL: {
                 float f1 = i1;
                 float f2 = i2;

de.peeeq.wurstscript/src/main/java/de/peeeq/wurstscript/jass/AntlrJassParseTreeTransformer.java

@@ -368,8 +368,8 @@ private WurstOperator transformOp(Token op) {
                 return WurstOperator.MULT;
             case JassParser.DIV_REAL:
                 return WurstOperator.DIV_REAL;
-            case JassParser.MOD_REAL:
-                return WurstOperator.MOD_REAL;
+            case JassParser.MOD_INT:
+                return WurstOperator.JASS_MOD_INT;
             case JassParser.NOT:
                 return WurstOperator.NOT;
         }