org.jetbrains.kotlin.ir.util.DescriptorSymbolTableExtension.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler-embeddable Show documentation
Show all versions of kotlin-compiler-embeddable Show documentation
the Kotlin compiler embeddable
/*
* 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.ir.util
import org.jetbrains.kotlin.descriptors.*
import org.jetbrains.kotlin.ir.ObsoleteDescriptorBasedAPI
import org.jetbrains.kotlin.ir.declarations.*
import org.jetbrains.kotlin.ir.declarations.impl.IrExternalPackageFragmentImpl
import org.jetbrains.kotlin.ir.declarations.impl.IrScriptImpl
import org.jetbrains.kotlin.ir.declarations.impl.IrVariableImpl
import org.jetbrains.kotlin.ir.descriptors.IrBasedClassDescriptor
import org.jetbrains.kotlin.ir.expressions.IrExpression
import org.jetbrains.kotlin.ir.symbols.*
import org.jetbrains.kotlin.ir.symbols.impl.*
import org.jetbrains.kotlin.ir.types.IrType
import org.jetbrains.kotlin.name.Name
import org.jetbrains.kotlin.resolve.descriptorUtil.isEffectivelyExternal
import org.jetbrains.kotlin.utils.threadLocal
@ObsoleteDescriptorBasedAPI
typealias DescriptorBasedReferenceSymbolTableExtension = ReferenceSymbolTableExtension<
ClassDescriptor, TypeAliasDescriptor, ScriptDescriptor, FunctionDescriptor, ClassConstructorDescriptor,
PropertyDescriptor, ParameterDescriptor, TypeParameterDescriptor
>
@ObsoleteDescriptorBasedAPI
open class DescriptorSymbolTableExtension(table: SymbolTable) : SymbolTableExtension<
DeclarationDescriptor, ClassDescriptor, TypeAliasDescriptor, ScriptDescriptor, FunctionDescriptor,
ClassConstructorDescriptor, PropertyDescriptor, ParameterDescriptor, TypeParameterDescriptor>(table)
{
private val irFactory: IrFactory
get() = table.irFactory
private val nameProvider: NameProvider
get() = table.nameProvider
private val signatureComposer: IdSignatureComposer
get() = table.signaturer!!
private val externalPackageFragmentSlice: SymbolTableSlice = SymbolTableSlice.Flat(lock)
private val valueParameterSlice: SymbolTableSlice.Scoped by threadLocal {
SymbolTableSlice.Scoped(lock)
}
private val variableSlice: SymbolTableSlice.Scoped by threadLocal {
SymbolTableSlice.Scoped(lock)
}
private val localDelegatedPropertySlice: SymbolTableSlice.Scoped by threadLocal {
SymbolTableSlice.Scoped(lock)
}
override fun MutableList>.initializeScopedSlices() {
add(valueParameterSlice)
add(variableSlice)
add(localDelegatedPropertySlice)
}
// ------------------------------------ signature ------------------------------------
override fun calculateSignature(declaration: DeclarationDescriptor): IdSignature? {
return signatureComposer.composeSignature(declaration)
}
override fun calculateEnumEntrySignature(declaration: ClassDescriptor): IdSignature? {
return signatureComposer.composeEnumEntrySignature(declaration)
}
override fun calculateFieldSignature(declaration: PropertyDescriptor): IdSignature? {
return signatureComposer.composeFieldSignature(declaration)
}
// ------------------------------------ script ------------------------------------
override fun defaultScriptFactory(startOffset: Int, endOffset: Int, script: ScriptDescriptor, symbol: IrScriptSymbol): IrScript {
return IrScriptImpl(symbol, nameProvider.nameForDeclaration(script), irFactory, startOffset, endOffset)
}
override fun createScriptSymbol(declaration: ScriptDescriptor, signature: IdSignature?): IrScriptSymbol {
return IrScriptSymbolImpl(declaration)
}
// ------------------------------------ class ------------------------------------
override fun referenceClass(declaration: ClassDescriptor): IrClassSymbol {
return if (declaration is IrBasedClassDescriptor) {
declaration.owner.symbol
} else {
super.referenceClass(declaration)
}
}
fun declareClassFromLinker(descriptor: ClassDescriptor, signature: IdSignature, classFactory: (IrClassSymbol) -> IrClass): IrClass {
return declareFromLinker(
descriptor,
signature,
SymbolTable::declareClass,
::declareClass,
::createClassSymbol,
classFactory
)
}
override fun createPublicClassSymbol(declaration: ClassDescriptor, signature: IdSignature): IrClassSymbol {
return IrClassSymbolImpl(declaration, signature)
}
override fun createPrivateClassSymbol(descriptor: ClassDescriptor): IrClassSymbol {
return IrClassSymbolImpl(descriptor)
}
// ------------------------------------ constructor ------------------------------------
fun declareConstructorFromLinker(
descriptor: ClassConstructorDescriptor,
signature: IdSignature,
constructorFactory: (IrConstructorSymbol) -> IrConstructor,
): IrConstructor {
return declareFromLinker(
descriptor,
signature,
SymbolTable::declareConstructor,
::declareConstructor,
::createConstructorSymbol,
constructorFactory
)
}
override fun createPublicConstructorSymbol(declaration: ClassConstructorDescriptor, signature: IdSignature): IrConstructorSymbol {
return IrConstructorSymbolImpl(declaration, signature)
}
override fun createPrivateConstructorSymbol(declaration: ClassConstructorDescriptor): IrConstructorSymbol {
return IrConstructorSymbolImpl(declaration)
}
// ------------------------------------ enum entry ------------------------------------
fun declareEnumEntryFromLinker(
descriptor: ClassDescriptor,
signature: IdSignature,
factory: (IrEnumEntrySymbol) -> IrEnumEntry,
): IrEnumEntry {
return declareFromLinker(
descriptor,
signature,
SymbolTable::declareEnumEntry,
::declareEnumEntry,
::createEnumEntrySymbol,
factory
)
}
override fun createPublicEnumEntrySymbol(declaration: ClassDescriptor, signature: IdSignature): IrEnumEntrySymbol {
return IrEnumEntrySymbolImpl(declaration, signature)
}
override fun createPrivateEnumEntrySymbol(declaration: ClassDescriptor): IrEnumEntrySymbol {
return IrEnumEntrySymbolImpl(declaration)
}
override fun defaultEnumEntryFactory(
startOffset: Int,
endOffset: Int,
origin: IrDeclarationOrigin,
enumEntry: ClassDescriptor,
symbol: IrEnumEntrySymbol,
): IrEnumEntry {
return irFactory.createEnumEntry(startOffset, endOffset, origin, nameProvider.nameForDeclaration(enumEntry), symbol)
}
// ------------------------------------ field ------------------------------------
override fun createPublicFieldSymbol(declaration: PropertyDescriptor, signature: IdSignature): IrFieldSymbol {
return IrFieldSymbolImpl(declaration, signature)
}
override fun createPrivateFieldSymbol(declaration: PropertyDescriptor): IrFieldSymbol {
return IrFieldSymbolImpl(declaration)
}
override fun defaultFieldFactory(
startOffset: Int,
endOffset: Int,
origin: IrDeclarationOrigin,
declaration: PropertyDescriptor,
type: IrType,
visibility: DescriptorVisibility?,
symbol: IrFieldSymbol,
): IrField {
return irFactory.createField(
startOffset = startOffset,
endOffset = endOffset,
origin = origin,
name = nameProvider.nameForDeclaration(declaration),
visibility = visibility ?: symbol.descriptor.visibility,
symbol = symbol,
type = type,
isFinal = !symbol.descriptor.isVar,
isStatic = symbol.descriptor.dispatchReceiverParameter == null,
isExternal = symbol.descriptor.isEffectivelyExternal(),
).apply {
metadata = DescriptorMetadataSource.Property(symbol.descriptor)
}
}
// ------------------------------------ property ------------------------------------
fun declarePropertyFromLinker(
descriptor: PropertyDescriptor,
signature: IdSignature,
propertyFactory: (IrPropertySymbol) -> IrProperty,
): IrProperty {
return declareFromLinker(
descriptor,
signature,
SymbolTable::declareProperty,
::declareProperty,
::createPropertySymbol,
propertyFactory
)
}
override fun createPublicPropertySymbol(declaration: PropertyDescriptor, signature: IdSignature): IrPropertySymbol {
return IrPropertySymbolImpl(declaration, signature)
}
override fun createPrivatePropertySymbol(declaration: PropertyDescriptor): IrPropertySymbol {
return IrPropertySymbolImpl(declaration)
}
override fun defaultPropertyFactory(
startOffset: Int,
endOffset: Int,
origin: IrDeclarationOrigin,
declaration: PropertyDescriptor,
isDelegated: Boolean,
symbol: IrPropertySymbol,
): IrProperty {
return irFactory.createProperty(
startOffset = startOffset,
endOffset = endOffset,
origin = origin,
name = nameProvider.nameForDeclaration(declaration),
visibility = declaration.visibility,
modality = declaration.modality,
symbol = symbol,
isVar = declaration.isVar,
isConst = declaration.isConst,
isLateinit = declaration.isLateInit,
isDelegated = isDelegated,
isExternal = declaration.isEffectivelyExternal(),
isExpect = declaration.isExpect,
isFakeOverride = declaration.kind == CallableMemberDescriptor.Kind.FAKE_OVERRIDE,
).apply {
metadata = DescriptorMetadataSource.Property(symbol.descriptor)
}
}
// ------------------------------------ typealias ------------------------------------
override fun createPublicTypeAliasSymbol(declaration: TypeAliasDescriptor, signature: IdSignature): IrTypeAliasSymbol {
return IrTypeAliasSymbolImpl(declaration, signature)
}
override fun createPrivateTypeAliasSymbol(declaration: TypeAliasDescriptor): IrTypeAliasSymbol {
return IrTypeAliasSymbolImpl(declaration)
}
// ------------------------------------ function ------------------------------------
fun declareSimpleFunctionFromLinker(
descriptor: FunctionDescriptor,
signature: IdSignature,
functionFactory: (IrSimpleFunctionSymbol) -> IrSimpleFunction,
): IrSimpleFunction {
return declareFromLinker(
descriptor,
signature,
SymbolTable::declareSimpleFunction,
::declareSimpleFunction,
::createFunctionSymbol,
functionFactory
)
}
override fun createPublicFunctionSymbol(declaration: FunctionDescriptor, signature: IdSignature): IrSimpleFunctionSymbol {
return IrSimpleFunctionSymbolImpl(declaration, signature)
}
override fun createPrivateFunctionSymbol(declaration: FunctionDescriptor): IrSimpleFunctionSymbol {
return IrSimpleFunctionSymbolImpl(declaration)
}
// ------------------------------------ type parameter ------------------------------------
override fun createPublicTypeParameterSymbol(declaration: TypeParameterDescriptor, signature: IdSignature): IrTypeParameterSymbol {
return IrTypeParameterSymbolImpl(declaration, signature)
}
override fun createPrivateTypeParameterSymbol(declaration: TypeParameterDescriptor): IrTypeParameterSymbol {
return IrTypeParameterSymbolImpl(declaration)
}
override fun defaultTypeParameterFactory(
startOffset: Int,
endOffset: Int,
origin: IrDeclarationOrigin,
declaration: TypeParameterDescriptor,
symbol: IrTypeParameterSymbol,
): IrTypeParameter {
return irFactory.createTypeParameter(
startOffset = startOffset,
endOffset = endOffset,
origin = origin,
name = nameProvider.nameForDeclaration(declaration),
symbol = symbol,
variance = symbol.descriptor.variance,
index = symbol.descriptor.index,
isReified = symbol.descriptor.isReified
)
}
// ------------------------------------ package fragment ------------------------------------
fun referenceExternalPackageFragment(descriptor: PackageFragmentDescriptor): IrExternalPackageFragmentSymbol =
externalPackageFragmentSlice.referenced(descriptor) { IrExternalPackageFragmentSymbolImpl(descriptor) }
fun declareExternalPackageFragment(descriptor: PackageFragmentDescriptor): IrExternalPackageFragment {
return externalPackageFragmentSlice.declare(
descriptor,
{ IrExternalPackageFragmentSymbolImpl(descriptor) },
{ IrExternalPackageFragmentImpl(it, descriptor.fqName) }
)
}
fun declareExternalPackageFragmentIfNotExists(descriptor: PackageFragmentDescriptor): IrExternalPackageFragment {
return externalPackageFragmentSlice.declareIfNotExists(
descriptor,
{ IrExternalPackageFragmentSymbolImpl(descriptor) },
{ IrExternalPackageFragmentImpl(it, descriptor.fqName) }
)
}
// ------------------------------------ anonymous initializer ------------------------------------
fun declareAnonymousInitializer(
startOffset: Int,
endOffset: Int,
origin: IrDeclarationOrigin,
descriptor: ClassDescriptor
): IrAnonymousInitializer =
irFactory.createAnonymousInitializer(
startOffset, endOffset, origin,
IrAnonymousInitializerSymbolImpl(descriptor)
)
// ------------------------------------ value parameter ------------------------------------
fun declareValueParameter(
startOffset: Int,
endOffset: Int,
origin: IrDeclarationOrigin,
descriptor: ParameterDescriptor,
type: IrType,
varargElementType: IrType? = null,
name: Name? = null,
isAssignable: Boolean = false,
valueParameterFactory: (IrValueParameterSymbol) -> IrValueParameter = {
irFactory.createValueParameter(
startOffset = startOffset,
endOffset = endOffset,
origin = origin,
name = name ?: nameProvider.nameForDeclaration(descriptor),
type = type,
isAssignable = isAssignable,
symbol = it,
varargElementType = varargElementType,
isCrossinline = descriptor.isCrossinline,
isNoinline = descriptor.isNoinline,
isHidden = false,
)
}
): IrValueParameter =
valueParameterSlice.declareLocal(
descriptor,
{ IrValueParameterSymbolImpl(descriptor) },
valueParameterFactory
)
@OptIn(ObsoleteDescriptorBasedAPI::class)
fun introduceValueParameter(irValueParameter: IrValueParameter) {
valueParameterSlice.introduceLocal(irValueParameter.descriptor, irValueParameter.symbol)
}
override fun referenceValueParameter(declaration: ParameterDescriptor): IrValueParameterSymbol {
return valueParameterSlice.referenced(declaration) {
error("Undefined parameter referenced: $declaration\n${valueParameterSlice.dump()}")
}
}
open fun referenceValue(value: ValueDescriptor): IrValueSymbol {
return when (value) {
is ParameterDescriptor -> valueParameterSlice.referenced(value) { error("Undefined parameter referenced: $value") }
is VariableDescriptor -> variableSlice.referenced(value) { error("Undefined variable referenced: $value") }
else -> error("Unexpected value descriptor: $value")
}
}
// ------------------------------------ variable ------------------------------------
fun declareVariable(
startOffset: Int,
endOffset: Int,
origin: IrDeclarationOrigin,
descriptor: VariableDescriptor,
type: IrType,
): IrVariable =
variableSlice.declareLocal(
descriptor,
{ IrVariableSymbolImpl(descriptor) }
) {
IrVariableImpl(
startOffset, endOffset, origin, it, nameProvider.nameForDeclaration(descriptor), type,
descriptor.isVar, descriptor.isConst, descriptor.isLateInit
)
}
fun declareVariable(
startOffset: Int,
endOffset: Int,
origin: IrDeclarationOrigin,
descriptor: VariableDescriptor,
type: IrType,
irInitializerExpression: IrExpression?
): IrVariable =
declareVariable(startOffset, endOffset, origin, descriptor, type).apply {
initializer = irInitializerExpression
}
// ------------------------------------ local delegated property ------------------------------------
fun declareLocalDelegatedProperty(
startOffset: Int,
endOffset: Int,
origin: IrDeclarationOrigin,
descriptor: VariableDescriptorWithAccessors,
type: IrType
): IrLocalDelegatedProperty {
return localDelegatedPropertySlice.declareLocal(
descriptor,
{ IrLocalDelegatedPropertySymbolImpl(descriptor) },
) {
irFactory.createLocalDelegatedProperty(
startOffset = startOffset,
endOffset = endOffset,
origin = origin,
name = nameProvider.nameForDeclaration(descriptor),
symbol = it,
type = type,
isVar = descriptor.isVar
)
}.apply {
metadata = DescriptorMetadataSource.LocalDelegatedProperty(descriptor)
}
}
fun referenceLocalDelegatedProperty(descriptor: VariableDescriptorWithAccessors): IrLocalDelegatedPropertySymbol =
localDelegatedPropertySlice.referenced(descriptor) {
error("Undefined local delegated property referenced: $descriptor")
}
// ------------------------------------ utilities ------------------------------------
private inline fun , SymbolOwner : IrSymbolOwner> declareFromLinker(
descriptor: D,
signature: IdSignature,
declareBySignature: SymbolTable.(IdSignature, () -> Symbol, OwnerFactory) -> SymbolOwner,
declareByDescriptor: (D, OwnerFactory) -> SymbolOwner,
crossinline symbolFactory: SymbolFactory,
noinline ownerFactory: OwnerFactory
): SymbolOwner {
return if (signature.isPubliclyVisible) {
table.declareBySignature(signature, { symbolFactory(descriptor, signature) }, ownerFactory)
} else {
declareByDescriptor(descriptor, ownerFactory)
}
}
}