Flatten nested string concatenation expressions into a single IrStringConcatenation, in a separate lowering phase.

Consolidating these into IrStringConcatenations allows the backend to produce efficient code for string concatenations (e.g., using StringBuilder for JVM).
2019-02-22 11:31:24 -08:00
parent ae22bdee15
commit d4d5a6011c
8 changed files with 212 additions and 14 deletions
@@ -0,0 +1,143 @@
+/*
+ * Copyright 2010-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
+ * that can be found in the license/LICENSE.txt file.
+ */
+
+package org.jetbrains.kotlin.backend.common.lower
+
+import org.jetbrains.kotlin.backend.common.CommonBackendContext
+import org.jetbrains.kotlin.backend.common.FileLoweringPass
+import org.jetbrains.kotlin.backend.common.phaser.makeIrFilePhase
+import org.jetbrains.kotlin.ir.IrElement
+import org.jetbrains.kotlin.ir.declarations.IrFile
+import org.jetbrains.kotlin.ir.expressions.IrCall
+import org.jetbrains.kotlin.ir.expressions.IrExpression
+import org.jetbrains.kotlin.ir.expressions.IrStringConcatenation
+import org.jetbrains.kotlin.ir.expressions.impl.IrStringConcatenationImpl
+import org.jetbrains.kotlin.ir.types.isString
+import org.jetbrains.kotlin.ir.visitors.IrElementTransformerVoid
+import org.jetbrains.kotlin.ir.visitors.IrElementVisitorVoid
+import org.jetbrains.kotlin.ir.visitors.acceptChildrenVoid
+import org.jetbrains.kotlin.ir.visitors.transformChildrenVoid
+import org.jetbrains.kotlin.name.Name
+
+val flattenStringConcatenationPhase = makeIrFilePhase(
+    ::FlattenStringConcatenationLowering,
+    name = "FlattenStringConcatenationLowering",
+    description = "Flatten nested string concatenation expressions into a single IrStringConcatenation"
+)
+
+/**
+ * Flattens nested string concatenation expressions into a single [IrStringConcatenation]. Consolidating these into IrStringConcatenations
+ * allows the backend to produce efficient code for string concatenations (e.g., using StringBuilder for JVM).
+ *
+ * Example expression:
+ *
+ *   val s = "1" + 2 + ("s1: '$s1'" + 3.0 + null)
+ *
+ * IR before lowering:
+ *
+ *   VAR name:s type:kotlin.String flags:val
+ *     CALL 'plus(Any?): String' type=kotlin.String origin=PLUS
+ *       $this: CALL 'plus(Any?): String' type=kotlin.String origin=PLUS
+ *         $this: CONST String type=kotlin.String value="1"
+ *         other: CONST Int type=kotlin.Int value=2
+ *       other: CALL 'plus(Any?): String' type=kotlin.String origin=PLUS
+ *         $this: CALL 'plus(Any?): String' type=kotlin.String origin=PLUS
+ *           $this: STRING_CONCATENATION type=kotlin.String
+ *             CONST String type=kotlin.String value="s1: '"
+ *             GET_VAR 's1: String' type=kotlin.String origin=null
+ *             CONST String type=kotlin.String value="'"
+ *           other: CONST Double type=kotlin.Double value=3.0
+ *         other: CONST Null type=kotlin.Nothing? value=null
+ *
+ * IR after lowering:
+ *
+ *   VAR name:s type:kotlin.String flags:val
+ *     STRING_CONCATENATION type=kotlin.String
+ *       CONST String type=kotlin.String value="1"
+ *       CONST Int type=kotlin.Int value=2
+ *       CONST String type=kotlin.String value="s1: '"
+ *       GET_VAR 's1: String' type=kotlin.String origin=null
+ *       CONST String type=kotlin.String value="'"
+ *       CONST Double type=kotlin.Double value=3.0
+ *       CONST Null type=kotlin.Nothing? value=null
+ */
+class FlattenStringConcatenationLowering(val context: CommonBackendContext) : FileLoweringPass, IrElementTransformerVoid() {
+
+    companion object {
+        private val PLUS_NAME = Name.identifier("plus")
+
+        /** @return true if the given expression is a [IrStringConcatenation] or [String.plus] [IrCall]. */
+        private fun isStringConcatenationExpression(expression: IrExpression): Boolean {
+            return when (expression) {
+                is IrStringConcatenation -> true
+                is IrCall -> {
+                    val dispatchReceiver = expression.dispatchReceiver
+                    dispatchReceiver != null &&
+                            dispatchReceiver.type.isString() &&
+                            expression.symbol.owner.name == PLUS_NAME &&
+                            expression.type.isString() &&
+                            expression.valueArgumentsCount == 1
+                }
+                else -> false
+            }
+        }
+
+        /** Recursively collects string concatenation arguments from the given expression. */
+        private fun collectStringConcatenationArguments(expression: IrExpression): List<IrExpression> {
+            val arguments = mutableListOf<IrExpression>()
+            expression.acceptChildrenVoid(object : IrElementVisitorVoid {
+
+                override fun visitElement(element: IrElement) {
+                    // Theoretically this is unreachable code since all descendants of IrExpressions are IrExpressions.
+                    element.acceptChildrenVoid(this)
+                }
+
+                override fun visitCall(expression: IrCall) {
+                    if (isStringConcatenationExpression(expression)) {
+                        // Recursively collect from call arguments.
+                        expression.acceptChildrenVoid(this)
+                    } else {
+                        // Add call itself as an argument.
+                        arguments.add(expression)
+                    }
+                }
+
+                override fun visitStringConcatenation(expression: IrStringConcatenation) {
+                    // Recursively collect from concatenation arguments.
+                    expression.acceptChildrenVoid(this)
+                }
+
+                override fun visitExpression(expression: IrExpression) {
+                    // These IrExpressions are neither IrCalls nor IrStringConcatenations and should be added as an argument.
+                    arguments.add(expression)
+                }
+            })
+
+            return arguments
+        }
+    }
+
+    override fun lower(irFile: IrFile) {
+        irFile.transformChildrenVoid(this)
+    }
+
+    override fun visitExpression(expression: IrExpression): IrExpression {
+        // Only modify/flatten string concatenation expressions.
+        val transformedExpression =
+            if (isStringConcatenationExpression(expression))
+                expression.run {
+                    IrStringConcatenationImpl(
+                        startOffset,
+                        endOffset,
+                        type,
+                        collectStringConcatenationArguments(this)
+                    )
+                }
+            else expression
+
+        transformedExpression.transformChildrenVoid(this)
+        return transformedExpression
+    }
+}