[SIR] Add SirTransformerVoid class
This is convenient for cases when the transformer has no context to pass to each method
This commit is contained in:
Sergej Jaskiewicz
committed by
Space Team
Space Team
parent
1bc2ac2c87
commit
1bed6a063f
+84
@@ -0,0 +1,84 @@
|
||||
/*
|
||||
* Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors.
|
||||
* 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.generators.tree
|
||||
|
||||
import org.jetbrains.kotlin.descriptors.Modality
|
||||
import org.jetbrains.kotlin.generators.tree.printer.FunctionParameter
|
||||
import org.jetbrains.kotlin.generators.tree.printer.printFunctionDeclaration
|
||||
import org.jetbrains.kotlin.utils.SmartPrinter
|
||||
import org.jetbrains.kotlin.utils.withIndent
|
||||
|
||||
abstract class AbstractTransformerVoidPrinter<Element : AbstractElement<Element, Field, *>, Field : AbstractField<Field>>(
|
||||
printer: SmartPrinter
|
||||
) : AbstractTransformerPrinter<Element, Field>(printer) {
|
||||
|
||||
final override val visitorTypeParameters: List<TypeVariable>
|
||||
get() = emptyList()
|
||||
|
||||
final override val visitorDataType: TypeRef
|
||||
get() = StandardTypes.nothing.copy(nullable = true)
|
||||
|
||||
abstract val transformerSuperClass: ClassRef<PositionTypeParameterRef>
|
||||
|
||||
override val visitorSuperType: ClassRef<PositionTypeParameterRef>?
|
||||
get() = transformerSuperClass.withArgs(visitorDataType)
|
||||
|
||||
context(ImportCollector)
|
||||
override fun printMethodsForElement(element: Element) {
|
||||
printer.run {
|
||||
val elementParameterName = element.visitorParameterName
|
||||
val dataParameter = FunctionParameter("data", visitorDataType)
|
||||
val methodName = "transform" + element.name
|
||||
if (element.isRootElement) {
|
||||
println()
|
||||
val elementTP = TypeVariable("E", listOf(element))
|
||||
printFunctionDeclaration(
|
||||
name = methodName,
|
||||
parameters = listOf(FunctionParameter(elementParameterName, elementTP)),
|
||||
returnType = elementTP,
|
||||
typeParameters = listOf(elementTP),
|
||||
modality = Modality.ABSTRACT,
|
||||
)
|
||||
println()
|
||||
println()
|
||||
printFunctionDeclaration(
|
||||
name = methodName,
|
||||
parameters = listOf(FunctionParameter(elementParameterName, elementTP), dataParameter),
|
||||
returnType = elementTP,
|
||||
typeParameters = listOf(elementTP),
|
||||
modality = Modality.FINAL,
|
||||
override = true,
|
||||
)
|
||||
} else {
|
||||
val parentInVisitor = parentInVisitor(element) ?: return
|
||||
val returnType = visitMethodReturnType(element)
|
||||
println()
|
||||
printFunctionDeclaration(
|
||||
name = methodName,
|
||||
parameters = listOf(FunctionParameter(elementParameterName, element)),
|
||||
returnType = returnType,
|
||||
modality = Modality.OPEN,
|
||||
)
|
||||
println(" =")
|
||||
withIndent {
|
||||
println("transform", parentInVisitor.name, "(", elementParameterName, ")")
|
||||
}
|
||||
println()
|
||||
printFunctionDeclaration(
|
||||
name = methodName,
|
||||
parameters = listOf(FunctionParameter(elementParameterName, element), dataParameter),
|
||||
returnType = returnType,
|
||||
modality = Modality.FINAL,
|
||||
override = true,
|
||||
)
|
||||
}
|
||||
println(" =")
|
||||
withIndent {
|
||||
println(methodName, "(", elementParameterName, ")")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+83
-21
@@ -237,6 +237,27 @@ fun SmartPrinter.printAcceptMethod(
|
||||
println()
|
||||
}
|
||||
|
||||
private fun transformMethodKDoc(
|
||||
transformerParameter: FunctionParameter,
|
||||
dataParameter: FunctionParameter?,
|
||||
treeName: String,
|
||||
) = buildString {
|
||||
append("Runs the provided [")
|
||||
append(transformerParameter.name)
|
||||
append("] on the $treeName subtree with the root at this node.\n\n")
|
||||
append("@param ")
|
||||
append(transformerParameter.name)
|
||||
append(" The transformer to use.")
|
||||
if (dataParameter != null) {
|
||||
append("\n@param ")
|
||||
append(dataParameter.name)
|
||||
append(" An arbitrary context to pass to each invocation of [")
|
||||
append(transformerParameter.name)
|
||||
append("]'s methods.")
|
||||
}
|
||||
append("\n@return The transformed node.")
|
||||
}
|
||||
|
||||
context(ImportCollector)
|
||||
fun SmartPrinter.printTransformMethod(
|
||||
element: AbstractElement<*, *, *>,
|
||||
@@ -249,15 +270,7 @@ fun SmartPrinter.printTransformMethod(
|
||||
println()
|
||||
val transformerParameter = FunctionParameter("transformer", transformerClass.withArgs(dataTP))
|
||||
if (element.isRootElement) {
|
||||
printKDoc(
|
||||
"""
|
||||
Runs the provided [${transformerParameter.name}] on the $treeName subtree with the root at this node.
|
||||
|
||||
@param ${transformerParameter.name} The transformer to use.
|
||||
@param ${dataParameter.name} An arbitrary context to pass to each invocation of [${transformerParameter.name}]'s methods.
|
||||
@return The transformed node.
|
||||
""".trimIndent()
|
||||
)
|
||||
printKDoc(transformMethodKDoc(transformerParameter, dataParameter, treeName))
|
||||
}
|
||||
if (returnType is TypeParameterRef && implementation != null) {
|
||||
println("@Suppress(\"UNCHECKED_CAST\")")
|
||||
@@ -313,6 +326,36 @@ fun SmartPrinter.printAcceptChildrenMethod(
|
||||
)
|
||||
}
|
||||
|
||||
private fun transformChildrenMethodKDoc(transformerParameter: FunctionParameter, dataParameter: FunctionParameter?, returnType: TypeRef) =
|
||||
buildString {
|
||||
append("Recursively transforms this node's children *in place* using [")
|
||||
append(transformerParameter.name)
|
||||
append("].\n\n")
|
||||
append("Basically, executes `this.child = this.child.transform(")
|
||||
append(transformerParameter.name)
|
||||
if (dataParameter != null) {
|
||||
append(", ")
|
||||
append(dataParameter.name)
|
||||
}
|
||||
append(")` for each child of this node.\n\n")
|
||||
append("Does **not** run [")
|
||||
append(transformerParameter.name)
|
||||
append("] on this node itself.\n\n")
|
||||
append("@param ")
|
||||
append(transformerParameter.name)
|
||||
append(" The transformer to use for transforming the children.")
|
||||
if (dataParameter != null) {
|
||||
append("\n@param ")
|
||||
append(dataParameter.name)
|
||||
append(" An arbitrary context to pass to each invocation of [")
|
||||
append(transformerParameter.name)
|
||||
append("]'s methods.")
|
||||
}
|
||||
if (returnType != StandardTypes.unit) {
|
||||
append("\n@return `this`")
|
||||
}
|
||||
}
|
||||
|
||||
context(ImportCollector)
|
||||
fun SmartPrinter.printTransformChildrenMethod(
|
||||
element: FieldContainer<*>,
|
||||
@@ -325,18 +368,7 @@ fun SmartPrinter.printTransformChildrenMethod(
|
||||
println()
|
||||
val transformerParameter = FunctionParameter("transformer", transformerClass.withArgs(dataTP))
|
||||
if (!override) {
|
||||
printKDoc(
|
||||
"""
|
||||
Recursively transforms this node's children *in place* using [${transformerParameter.name}].
|
||||
|
||||
Basically, executes `this.child = this.child.transform(${transformerParameter.name}, ${dataParameter.name})` for each child of this node.
|
||||
|
||||
Does **not** run [${transformerParameter.name}] on this node itself.
|
||||
|
||||
@param ${transformerParameter.name} The transformer to use for transforming the children.
|
||||
@param ${dataParameter.name} An arbitrary context to pass to each invocation of [${transformerParameter.name}]'s methods.
|
||||
""".trimIndent() + (if (returnType == StandardTypes.unit) "" else "\n@return `this`")
|
||||
)
|
||||
printKDoc(transformChildrenMethodKDoc(transformerParameter, dataParameter, returnType))
|
||||
}
|
||||
printFunctionDeclaration(
|
||||
name = "transformChildren",
|
||||
@@ -362,4 +394,34 @@ fun SmartPrinter.printAcceptChildrenVoidMethod(visitorType: ClassRef<*>) {
|
||||
println(" = acceptChildren(", visitorParameter.name, ", null)")
|
||||
}
|
||||
|
||||
context(ImportCollector)
|
||||
fun SmartPrinter.printTransformVoidMethod(element: AbstractElement<*, *, *>, transformerType: ClassRef<*>, treeName: String) {
|
||||
assert(element.isRootElement) { "Expected root element" }
|
||||
val transformerParameter = FunctionParameter("transformer", transformerType)
|
||||
val elementTP = TypeVariable("E", listOf(element))
|
||||
printKDoc(transformMethodKDoc(transformerParameter, null, treeName))
|
||||
printFunctionDeclaration(
|
||||
name = "transform",
|
||||
parameters = listOf(transformerParameter),
|
||||
returnType = elementTP,
|
||||
typeParameters = listOf(elementTP)
|
||||
)
|
||||
println(" =")
|
||||
withIndent {
|
||||
println("transform(", transformerParameter.name, ", null)")
|
||||
}
|
||||
}
|
||||
|
||||
context(ImportCollector)
|
||||
fun SmartPrinter.printTransformChildrenVoidMethod(element: AbstractElement<*, *, *>, visitorType: ClassRef<*>, returnType: TypeRef) {
|
||||
assert(element.isRootElement) { "Expected root element" }
|
||||
val transformerParameter = FunctionParameter("transformer", visitorType)
|
||||
printKDoc(transformChildrenMethodKDoc(transformerParameter, null, returnType))
|
||||
printFunctionDeclaration("transformChildren", listOf(transformerParameter), returnType)
|
||||
println(" =")
|
||||
withIndent {
|
||||
println("transformChildren(", transformerParameter.name, ", null)")
|
||||
}
|
||||
}
|
||||
|
||||
fun AbstractField<*>.call(): String = if (nullable) "?." else "."
|
||||
|
||||
Reference in New Issue
Block a user