From 65b5cdbb8df3909ca40a816f57d105072f5d0b36 Mon Sep 17 00:00:00 2001
From: Dmitry Petrov <dmitry.petrov@jetbrains.com>
Date: Wed, 13 Dec 2017 14:00:14 +0300
Subject: [PATCH] Maintain bounds evaluation order in intrinsics for 'reversed'

Makes sense for 'rangeTo', 'downTo', and 'until' with non-const bounds.
---
 .../range/DownToProgressionRangeValue.kt      |  5 ++-
 .../PrimitiveNumberRangeLiteralRangeValue.kt  |  5 ++-
 .../range/PrimitiveNumberUntilRangeValue.kt   |  5 ++-
 .../ForInSimpleProgressionLoopGenerator.kt    | 33 +++++++++++++++----
 .../forInReversedDownToEvaluationOrder.kt     | 20 +++++++++++
 ...orInReversedRangeLiteralEvaluationOrder.kt | 20 +++++++++++
 .../forInReversedUntilEvaluationOrder.kt      | 20 +++++++++++
 .../ir/IrBlackBoxCodegenTestGenerated.java    | 27 +++++++++++++++
 .../codegen/BlackBoxCodegenTestGenerated.java | 27 +++++++++++++++
 .../LightAnalysisModeTestGenerated.java       | 27 +++++++++++++++
 .../semantics/JsCodegenBoxTestGenerated.java  | 27 +++++++++++++++
 11 files changed, 206 insertions(+), 10 deletions(-)
 create mode 100644 compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedDownToEvaluationOrder.kt
 create mode 100644 compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedRangeLiteralEvaluationOrder.kt
 create mode 100644 compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedUntilEvaluationOrder.kt

diff --git a/compiler/backend/src/org/jetbrains/kotlin/codegen/range/DownToProgressionRangeValue.kt b/compiler/backend/src/org/jetbrains/kotlin/codegen/range/DownToProgressionRangeValue.kt
index 3c11fea4cd5..791af0da77e 100644
--- a/compiler/backend/src/org/jetbrains/kotlin/codegen/range/DownToProgressionRangeValue.kt
+++ b/compiler/backend/src/org/jetbrains/kotlin/codegen/range/DownToProgressionRangeValue.kt
@@ -43,7 +43,10 @@ class DownToProgressionRangeValue(rangeCall: ResolvedCall<out CallableDescriptor
 
     override fun createForInReversedLoopGenerator(codegen: ExpressionCodegen, forExpression: KtForExpression) =
             createConstBoundedForInReversedDownToGenerator(codegen, forExpression) ?:
-            ForInSimpleProgressionLoopGenerator.fromBoundedValueWithStep1(codegen, forExpression, getBoundedValue(codegen))
+            ForInSimpleProgressionLoopGenerator.fromBoundedValueWithStep1(
+                    codegen, forExpression, getBoundedValue(codegen),
+                    inverseBoundsEvaluationOrder = true
+            )
 
     private fun createConstBoundedForInDownToGenerator(
             codegen: ExpressionCodegen,
diff --git a/compiler/backend/src/org/jetbrains/kotlin/codegen/range/PrimitiveNumberRangeLiteralRangeValue.kt b/compiler/backend/src/org/jetbrains/kotlin/codegen/range/PrimitiveNumberRangeLiteralRangeValue.kt
index d07769735e3..a9b16a0b9a4 100644
--- a/compiler/backend/src/org/jetbrains/kotlin/codegen/range/PrimitiveNumberRangeLiteralRangeValue.kt
+++ b/compiler/backend/src/org/jetbrains/kotlin/codegen/range/PrimitiveNumberRangeLiteralRangeValue.kt
@@ -41,7 +41,10 @@ class PrimitiveNumberRangeLiteralRangeValue(
 
     override fun createForInReversedLoopGenerator(codegen: ExpressionCodegen, forExpression: KtForExpression): ForLoopGenerator =
             createConstBoundedRangeForInReversedRangeLiteralGenerator(codegen, forExpression) ?:
-            ForInSimpleProgressionLoopGenerator.fromBoundedValueWithStepMinus1(codegen, forExpression, getBoundedValue(codegen))
+            ForInSimpleProgressionLoopGenerator.fromBoundedValueWithStepMinus1(
+                    codegen, forExpression, getBoundedValue(codegen),
+                    inverseBoundsEvaluationOrder = true
+            )
 
     private fun createConstBoundedForInRangeLiteralGenerator(
             codegen: ExpressionCodegen,
diff --git a/compiler/backend/src/org/jetbrains/kotlin/codegen/range/PrimitiveNumberUntilRangeValue.kt b/compiler/backend/src/org/jetbrains/kotlin/codegen/range/PrimitiveNumberUntilRangeValue.kt
index 9eccd23bed2..bd307a55f77 100644
--- a/compiler/backend/src/org/jetbrains/kotlin/codegen/range/PrimitiveNumberUntilRangeValue.kt
+++ b/compiler/backend/src/org/jetbrains/kotlin/codegen/range/PrimitiveNumberUntilRangeValue.kt
@@ -36,7 +36,10 @@ class PrimitiveNumberUntilRangeValue(rangeCall: ResolvedCall<out CallableDescrip
 
     override fun createForInReversedLoopGenerator(codegen: ExpressionCodegen, forExpression: KtForExpression) =
             createConstBoundedForInReversedUntilGenerator(codegen, forExpression) ?:
-            ForInSimpleProgressionLoopGenerator.fromBoundedValueWithStepMinus1(codegen, forExpression, getBoundedValue(codegen))
+            ForInSimpleProgressionLoopGenerator.fromBoundedValueWithStepMinus1(
+                    codegen, forExpression, getBoundedValue(codegen),
+                    inverseBoundsEvaluationOrder = true
+            )
 
     private fun createConstBoundedForInReversedUntilGenerator(
             codegen: ExpressionCodegen,
diff --git a/compiler/backend/src/org/jetbrains/kotlin/codegen/range/forLoop/ForInSimpleProgressionLoopGenerator.kt b/compiler/backend/src/org/jetbrains/kotlin/codegen/range/forLoop/ForInSimpleProgressionLoopGenerator.kt
index 29a706eb214..d985ea396e0 100644
--- a/compiler/backend/src/org/jetbrains/kotlin/codegen/range/forLoop/ForInSimpleProgressionLoopGenerator.kt
+++ b/compiler/backend/src/org/jetbrains/kotlin/codegen/range/forLoop/ForInSimpleProgressionLoopGenerator.kt
@@ -30,6 +30,7 @@ class ForInSimpleProgressionLoopGenerator(
         private val isStartInclusive: Boolean,
         private val endValue: StackValue,
         private val isEndInclusive: Boolean,
+        private val inverseBoundsEvaluationOrder: Boolean,
         step: Int
 ) : AbstractForInRangeLoopGenerator(codegen, forExpression, step) {
 
@@ -37,6 +38,7 @@ class ForInSimpleProgressionLoopGenerator(
             codegen: ExpressionCodegen,
             forExpression: KtForExpression,
             boundedValue: SimpleBoundedValue,
+            inverseBoundsEvaluationOrder: Boolean,
             step: Int
     ) : this(
             codegen, forExpression,
@@ -44,23 +46,40 @@ class ForInSimpleProgressionLoopGenerator(
             isStartInclusive = if (step == 1) boundedValue.isLowInclusive else boundedValue.isHighInclusive,
             endValue = if (step == 1) boundedValue.highBound else boundedValue.lowBound,
             isEndInclusive = if (step == 1) boundedValue.isHighInclusive else boundedValue.isLowInclusive,
+            inverseBoundsEvaluationOrder = inverseBoundsEvaluationOrder,
             step = step
     )
 
     companion object {
-        fun fromBoundedValueWithStep1(codegen: ExpressionCodegen, forExpression: KtForExpression, boundedValue: SimpleBoundedValue) =
-                ForInSimpleProgressionLoopGenerator(codegen, forExpression, boundedValue, 1)
+        fun fromBoundedValueWithStep1(
+                codegen: ExpressionCodegen,
+                forExpression: KtForExpression,
+                boundedValue: SimpleBoundedValue,
+                inverseBoundsEvaluationOrder: Boolean = false
+        ) =
+                ForInSimpleProgressionLoopGenerator(codegen, forExpression, boundedValue, inverseBoundsEvaluationOrder, 1)
 
-        fun fromBoundedValueWithStepMinus1(codegen: ExpressionCodegen, forExpression: KtForExpression, boundedValue: SimpleBoundedValue) =
-                ForInSimpleProgressionLoopGenerator(codegen, forExpression, boundedValue, -1)
+        fun fromBoundedValueWithStepMinus1(
+                codegen: ExpressionCodegen,
+                forExpression: KtForExpression,
+                boundedValue: SimpleBoundedValue,
+                inverseBoundsEvaluationOrder: Boolean = false
+        ) =
+                ForInSimpleProgressionLoopGenerator(codegen, forExpression, boundedValue, inverseBoundsEvaluationOrder, -1)
     }
 
     override fun storeRangeStartAndEnd() {
-        loopParameter().store(startValue, v)
+        if (inverseBoundsEvaluationOrder) {
+            StackValue.local(endVar, asmElementType).store(endValue, v)
+            loopParameter().store(startValue, v)
+        }
+        else {
+            loopParameter().store(startValue, v)
+            StackValue.local(endVar, asmElementType).store(endValue, v)
+        }
+
         // Skip 1st element if start is not inclusive.
         if (!isStartInclusive) incrementLoopVariable()
-
-        StackValue.local(endVar, asmElementType).store(endValue, v)
     }
 
     override fun checkEmptyLoop(loopExit: Label) {
diff --git a/compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedDownToEvaluationOrder.kt b/compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedDownToEvaluationOrder.kt
new file mode 100644
index 00000000000..c85ebc7b78e
--- /dev/null
+++ b/compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedDownToEvaluationOrder.kt
@@ -0,0 +1,20 @@
+// WITH_RUNTIME
+import kotlin.test.*
+
+val log = StringBuilder()
+
+fun logged(message: String, value: Int) =
+        value.also { log.append(message) }
+
+fun box(): String {
+    var s = 0
+    for (i in (logged("start;", 2) downTo logged("end;", 1)).reversed()) {
+        s += i
+    }
+
+    assertEquals(3, s)
+
+    assertEquals("start;end;", log.toString())
+
+    return "OK"
+}
\ No newline at end of file
diff --git a/compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedRangeLiteralEvaluationOrder.kt b/compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedRangeLiteralEvaluationOrder.kt
new file mode 100644
index 00000000000..59f09a0c7bd
--- /dev/null
+++ b/compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedRangeLiteralEvaluationOrder.kt
@@ -0,0 +1,20 @@
+// WITH_RUNTIME
+import kotlin.test.*
+
+val log = StringBuilder()
+
+fun logged(message: String, value: Int) =
+        value.also { log.append(message) }
+
+fun box(): String {
+    var s = 0
+    for (i in (logged("start;", 1) .. logged("end;", 2)).reversed()) {
+        s += i
+    }
+
+    assertEquals(3, s)
+
+    assertEquals("start;end;", log.toString())
+
+    return "OK"
+}
\ No newline at end of file
diff --git a/compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedUntilEvaluationOrder.kt b/compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedUntilEvaluationOrder.kt
new file mode 100644
index 00000000000..db6c269f554
--- /dev/null
+++ b/compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedUntilEvaluationOrder.kt
@@ -0,0 +1,20 @@
+// WITH_RUNTIME
+import kotlin.test.*
+
+val log = StringBuilder()
+
+fun logged(message: String, value: Int) =
+        value.also { log.append(message) }
+
+fun box(): String {
+    var s = 0
+    for (i in (logged("start;", 1) until logged("end;", 3)).reversed()) {
+        s += i
+    }
+
+    assertEquals(3, s)
+
+    assertEquals("start;end;", log.toString())
+
+    return "OK"
+}
\ No newline at end of file
diff --git a/compiler/tests-ir-jvm/tests/org/jetbrains/kotlin/codegen/ir/IrBlackBoxCodegenTestGenerated.java b/compiler/tests-ir-jvm/tests/org/jetbrains/kotlin/codegen/ir/IrBlackBoxCodegenTestGenerated.java
index 1032ab44233..d5ef2ed97fb 100644
--- a/compiler/tests-ir-jvm/tests/org/jetbrains/kotlin/codegen/ir/IrBlackBoxCodegenTestGenerated.java
+++ b/compiler/tests-ir-jvm/tests/org/jetbrains/kotlin/codegen/ir/IrBlackBoxCodegenTestGenerated.java
@@ -15324,6 +15324,33 @@ public class IrBlackBoxCodegenTestGenerated extends AbstractIrBlackBoxCodegenTes
                 String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/forInReversedUntilWithNonConstBounds.kt");
                 doTest(fileName);
             }
+
+            @TestMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder")
+            @TestDataPath("$PROJECT_ROOT")
+            @RunWith(JUnit3RunnerWithInners.class)
+            public static class EvaluationOrder extends AbstractIrBlackBoxCodegenTest {
+                public void testAllFilesPresentInEvaluationOrder() throws Exception {
+                    KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder"), Pattern.compile("^(.+)\\.kt$"), TargetBackend.JVM, true);
+                }
+
+                @TestMetadata("forInReversedDownToEvaluationOrder.kt")
+                public void testForInReversedDownToEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedDownToEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+
+                @TestMetadata("forInReversedRangeLiteralEvaluationOrder.kt")
+                public void testForInReversedRangeLiteralEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedRangeLiteralEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+
+                @TestMetadata("forInReversedUntilEvaluationOrder.kt")
+                public void testForInReversedUntilEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedUntilEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+            }
         }
 
         @TestMetadata("compiler/testData/codegen/box/ranges/forInUntil")
diff --git a/compiler/tests/org/jetbrains/kotlin/codegen/BlackBoxCodegenTestGenerated.java b/compiler/tests/org/jetbrains/kotlin/codegen/BlackBoxCodegenTestGenerated.java
index cd3a001d67c..2136e3ef6fe 100644
--- a/compiler/tests/org/jetbrains/kotlin/codegen/BlackBoxCodegenTestGenerated.java
+++ b/compiler/tests/org/jetbrains/kotlin/codegen/BlackBoxCodegenTestGenerated.java
@@ -15324,6 +15324,33 @@ public class BlackBoxCodegenTestGenerated extends AbstractBlackBoxCodegenTest {
                 String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/forInReversedUntilWithNonConstBounds.kt");
                 doTest(fileName);
             }
+
+            @TestMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder")
+            @TestDataPath("$PROJECT_ROOT")
+            @RunWith(JUnit3RunnerWithInners.class)
+            public static class EvaluationOrder extends AbstractBlackBoxCodegenTest {
+                public void testAllFilesPresentInEvaluationOrder() throws Exception {
+                    KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder"), Pattern.compile("^(.+)\\.kt$"), TargetBackend.JVM, true);
+                }
+
+                @TestMetadata("forInReversedDownToEvaluationOrder.kt")
+                public void testForInReversedDownToEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedDownToEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+
+                @TestMetadata("forInReversedRangeLiteralEvaluationOrder.kt")
+                public void testForInReversedRangeLiteralEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedRangeLiteralEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+
+                @TestMetadata("forInReversedUntilEvaluationOrder.kt")
+                public void testForInReversedUntilEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedUntilEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+            }
         }
 
         @TestMetadata("compiler/testData/codegen/box/ranges/forInUntil")
diff --git a/compiler/tests/org/jetbrains/kotlin/codegen/LightAnalysisModeTestGenerated.java b/compiler/tests/org/jetbrains/kotlin/codegen/LightAnalysisModeTestGenerated.java
index f246e856709..a01254cb497 100644
--- a/compiler/tests/org/jetbrains/kotlin/codegen/LightAnalysisModeTestGenerated.java
+++ b/compiler/tests/org/jetbrains/kotlin/codegen/LightAnalysisModeTestGenerated.java
@@ -15324,6 +15324,33 @@ public class LightAnalysisModeTestGenerated extends AbstractLightAnalysisModeTes
                 String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/forInReversedUntilWithNonConstBounds.kt");
                 doTest(fileName);
             }
+
+            @TestMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder")
+            @TestDataPath("$PROJECT_ROOT")
+            @RunWith(JUnit3RunnerWithInners.class)
+            public static class EvaluationOrder extends AbstractLightAnalysisModeTest {
+                public void testAllFilesPresentInEvaluationOrder() throws Exception {
+                    KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder"), Pattern.compile("^(.+)\\.kt$"), TargetBackend.JVM, true);
+                }
+
+                @TestMetadata("forInReversedDownToEvaluationOrder.kt")
+                public void testForInReversedDownToEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedDownToEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+
+                @TestMetadata("forInReversedRangeLiteralEvaluationOrder.kt")
+                public void testForInReversedRangeLiteralEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedRangeLiteralEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+
+                @TestMetadata("forInReversedUntilEvaluationOrder.kt")
+                public void testForInReversedUntilEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedUntilEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+            }
         }
 
         @TestMetadata("compiler/testData/codegen/box/ranges/forInUntil")
diff --git a/js/js.tests/test/org/jetbrains/kotlin/js/test/semantics/JsCodegenBoxTestGenerated.java b/js/js.tests/test/org/jetbrains/kotlin/js/test/semantics/JsCodegenBoxTestGenerated.java
index c157a0d36db..f0ab06b49f7 100644
--- a/js/js.tests/test/org/jetbrains/kotlin/js/test/semantics/JsCodegenBoxTestGenerated.java
+++ b/js/js.tests/test/org/jetbrains/kotlin/js/test/semantics/JsCodegenBoxTestGenerated.java
@@ -16740,6 +16740,33 @@ public class JsCodegenBoxTestGenerated extends AbstractJsCodegenBoxTest {
                 String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/forInReversedUntilWithNonConstBounds.kt");
                 doTest(fileName);
             }
+
+            @TestMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder")
+            @TestDataPath("$PROJECT_ROOT")
+            @RunWith(JUnit3RunnerWithInners.class)
+            public static class EvaluationOrder extends AbstractJsCodegenBoxTest {
+                public void testAllFilesPresentInEvaluationOrder() throws Exception {
+                    KotlinTestUtils.assertAllTestsPresentByMetadata(this.getClass(), new File("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder"), Pattern.compile("^(.+)\\.kt$"), TargetBackend.JS, true);
+                }
+
+                @TestMetadata("forInReversedDownToEvaluationOrder.kt")
+                public void testForInReversedDownToEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedDownToEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+
+                @TestMetadata("forInReversedRangeLiteralEvaluationOrder.kt")
+                public void testForInReversedRangeLiteralEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedRangeLiteralEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+
+                @TestMetadata("forInReversedUntilEvaluationOrder.kt")
+                public void testForInReversedUntilEvaluationOrder() throws Exception {
+                    String fileName = KotlinTestUtils.navigationMetadata("compiler/testData/codegen/box/ranges/forInReversed/evaluationOrder/forInReversedUntilEvaluationOrder.kt");
+                    doTest(fileName);
+                }
+            }
         }
 
         @TestMetadata("compiler/testData/codegen/box/ranges/forInUntil")