Skip to content

Commit

Permalink
Trick the compiler into thinking SpeakingFlags is no value class
Browse files Browse the repository at this point in the history 
This way, a ClassGeneratorExtension is not needed.
  • Loading branch information
@lukellmann
lukellmann committed Jun 9, 2024
1 parent e7581b9 commit f8c3a47
Showing 1 changed file with 24 additions and 84 deletions.
108 changes: 24 additions & 84 deletions compiler-plugins/src/main/kotlin/ValueClassesBinaryCompatibilityPlugin.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,34 @@ import org.jetbrains.kotlin.backend.common.ClassLoweringPass
import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension
import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext
import org.jetbrains.kotlin.backend.common.lower.DeclarationIrBuilder
import org.jetbrains.kotlin.backend.common.lower.irIfThen
import org.jetbrains.kotlin.backend.common.lower.irThrow
import org.jetbrains.kotlin.backend.jvm.extensions.ClassGenerator
import org.jetbrains.kotlin.backend.jvm.extensions.ClassGeneratorExtension
import org.jetbrains.kotlin.cli.common.CLIConfigurationKeys
import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity.ERROR
import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity.INFO
import org.jetbrains.kotlin.cli.common.messages.MessageCollector
import org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar
import org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi
import org.jetbrains.kotlin.config.CompilerConfiguration
import org.jetbrains.kotlin.descriptors.DescriptorVisibilities.PRIVATE
import org.jetbrains.kotlin.descriptors.DescriptorVisibilities.PUBLIC
import org.jetbrains.kotlin.ir.builders.*
import org.jetbrains.kotlin.ir.builders.declarations.addConstructor
import org.jetbrains.kotlin.ir.builders.declarations.addFunction
import org.jetbrains.kotlin.ir.builders.declarations.addValueParameter
import org.jetbrains.kotlin.ir.declarations.*
import org.jetbrains.kotlin.ir.expressions.IrExpression
import org.jetbrains.kotlin.ir.builders.declarations.buildClass
import org.jetbrains.kotlin.ir.declarations.IrClass
import org.jetbrains.kotlin.ir.declarations.IrDeclarationOriginImpl
import org.jetbrains.kotlin.ir.declarations.IrModuleFragment
import org.jetbrains.kotlin.ir.symbols.IrSymbol
import org.jetbrains.kotlin.ir.symbols.UnsafeDuringIrConstructionAPI
import org.jetbrains.kotlin.ir.types.defaultType
import org.jetbrains.kotlin.ir.types.isNullable
import org.jetbrains.kotlin.ir.types.isNullableString
import org.jetbrains.kotlin.ir.types.makeNullable
import org.jetbrains.kotlin.ir.symbols.impl.IrClassSymbolImpl
import org.jetbrains.kotlin.ir.types.SimpleTypeNullability.DEFINITELY_NOT_NULL
import org.jetbrains.kotlin.ir.types.impl.IrSimpleTypeImpl
import org.jetbrains.kotlin.ir.util.*
import org.jetbrains.kotlin.name.ClassId
import org.jetbrains.kotlin.name.Name
import org.jetbrains.kotlin.platform.jvm.isJvm
import org.jetbrains.org.objectweb.asm.Opcodes.ACC_PRIVATE
import org.jetbrains.org.objectweb.asm.Opcodes.ACC_PUBLIC

private val DEFAULT_FRAME_INTERCEPTOR_DATA = ClassId.fromString("dev/kord/voice/DefaultFrameInterceptorData")
private val SPEAKING_FLAGS = ClassId.fromString("dev/kord/voice/SpeakingFlags")
private val NULL_POINTER_EXCEPTION = ClassId.fromString("java/lang/NullPointerException")
private val VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN =
IrDeclarationOriginImpl("VALUE_CLASSES_BINARY_COMPATIBILITY", isSynthetic = true)

Expand All @@ -49,9 +42,6 @@ class ValueClassesBinaryCompatibilityCompilerPluginRegistrar : CompilerPluginReg
override fun ExtensionStorage.registerExtensions(configuration: CompilerConfiguration) {
val messageCollector = configuration.get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, MessageCollector.NONE)
IrGenerationExtension.registerExtension(ValueClassesBinaryCompatibilityIrGenerationExtension(messageCollector))
ClassGeneratorExtension.registerExtension(
ValueClassesBinaryCompatibilityClassGeneratorExtension(messageCollector),
)
}
}

Expand All @@ -73,31 +63,25 @@ private class ValueClassesBinaryCompatibilityClassLoweringPass(
private val messageCollector: MessageCollector,
private val context: IrPluginContext,
) : ClassLoweringPass {
private val speakingFlags = context.referenceClass(SPEAKING_FLAGS)!!.defaultType.makeNullable()
private val nullPointerException = context.referenceClass(NULL_POINTER_EXCEPTION)!!
private val speakingFlags = IrSimpleTypeImpl(
classifier = IrClassSymbolImpl().apply {
bind(
owner = context.irFactory
.buildClass { name = SPEAKING_FLAGS.shortClassName }
.apply { parent = context.referenceClass(SPEAKING_FLAGS)!!.owner.parent }
)
},
nullability = DEFINITELY_NOT_NULL,
arguments = emptyList(),
annotations = emptyList(),
)

private val speakingState = Name.identifier("speakingState")
private val component1 = Name.identifier("component1")
private val copy = Name.identifier("copy")

private fun IrSymbol.builder() = DeclarationIrBuilder(context, symbol = this)

private fun IrBuilderWithScope.nullCheck(arg: IrExpression) = irIfThen(
condition = irEqualsNull(arg),
thenPart = irThrow(
irCallConstructor(
callee = nullPointerException.constructors.single {
it.owner.valueParameters.singleOrNull()?.type?.isNullableString() == true
},
typeArguments = emptyList(),
).apply {
putValueArgument(
index = 0,
irString("Null was passed as a parameter that was previously non-nullable."),
)
}
),
)

override fun lower(irClass: IrClass) {
if (irClass.classId != DEFAULT_FRAME_INTERCEPTOR_DATA) {
return
Expand All @@ -123,9 +107,7 @@ private class ValueClassesBinaryCompatibilityClassLoweringPass(
.addValueParameter("speakingState", speakingFlags, VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN)
.apply { defaultValue = primaryCtor.valueParameters.first().defaultValue }
ctor2.body = ctor2.symbol.builder().irBlockBody {
val arg = irGet(param)
+nullCheck(arg)
+irDelegatingConstructorCall(primaryCtor).apply { putValueArgument(index = 0, arg) }
+irDelegatingConstructorCall(primaryCtor).apply { putValueArgument(index = 0, irGet(param)) }
}
messageCollector.report(INFO, "ctor2: ${ctor2.render()}")

Expand All @@ -143,7 +125,7 @@ private class ValueClassesBinaryCompatibilityClassLoweringPass(
messageCollector.report(INFO, "speakingState: ${speakingState.render()}")

val inlineComponent1 = irClass.functions.single { it.name == component1 }
val component1 = inlineComponent1.deepCopyWithSymbols().apply {
val component1 = inlineComponent1.deepCopyWithSymbols(irClass).apply {
origin = VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN
returnType = speakingFlags
body = with(symbol.builder()) {
Expand All @@ -154,61 +136,19 @@ private class ValueClassesBinaryCompatibilityClassLoweringPass(
messageCollector.report(INFO, "component1: ${component1.render()}")

val inlineCopy = irClass.functions.single { it.name == copy }
val copy = inlineCopy.deepCopyWithSymbols().apply {
val copy = inlineCopy.deepCopyWithSymbols(irClass).apply {
origin = VALUE_CLASSES_BINARY_COMPATIBILITY_ORIGIN
val copyParam = valueParameters.single().apply {
type = speakingFlags
}
body = symbol.builder().irBlockBody {
val arg = irGet(copyParam)
+nullCheck(arg)
+irReturn(irCall(inlineCopy).apply {
dispatchReceiver = irGet(dispatchReceiverParameter!!)
putValueArgument(index = 0, arg)
putValueArgument(index = 0, irGet(copyParam))
})
}
}
irClass.declarations.add(copy)
messageCollector.report(INFO, "copy: ${copy.render()}")
}
}

private class ValueClassesBinaryCompatibilityClassGeneratorExtension(
private val messageCollector: MessageCollector,
) : ClassGeneratorExtension {
override fun generateClass(generator: ClassGenerator, declaration: IrClass?): ClassGenerator {
if (declaration?.classId != DEFAULT_FRAME_INTERCEPTOR_DATA) {
return generator
}
return object : ClassGenerator by generator {
override fun newMethod(
declaration: IrFunction?,
access: Int,
name: String,
desc: String,
signature: String?,
exceptions: Array<out String>?,
) = generator.newMethod(
declaration = declaration, name = name, desc = desc, signature = signature, exceptions = exceptions,
access = when (declaration) {
is IrConstructor -> {
val visibility = declaration.visibility
val params = declaration.valueParameters
when {
visibility == PUBLIC && params.size == 2 && params[0].type.isNullable() -> {
messageCollector.report(INFO, "changing visibility to private: ${declaration.render()}")
(access and ACC_PUBLIC.inv()) or ACC_PRIVATE
}
visibility == PRIVATE && params.size == 1 && params[0].type.isNullable() -> {
messageCollector.report(INFO, "changing visibility to public: ${declaration.render()}")
(access and ACC_PRIVATE.inv()) or ACC_PUBLIC
}
else -> access
}
}
else -> access
},
)
}
}
}

0 comments on commit f8c3a47

Please sign in to comment.