kotlin.reflect.jvm.internal.impl.resolve.DescriptorUtils.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-reflect Show documentation
Show all versions of kotlin-reflect Show documentation
Kotlin Full Reflection Library
/*
* Copyright 2010-2016 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package kotlin.reflect.jvm.internal.impl.resolve.descriptorUtil
import kotlin.reflect.jvm.internal.impl.builtins.KotlinBuiltIns
import kotlin.reflect.jvm.internal.impl.descriptors.*
import kotlin.reflect.jvm.internal.impl.descriptors.ClassKind.*
import kotlin.reflect.jvm.internal.impl.descriptors.annotations.Annotated
import kotlin.reflect.jvm.internal.impl.descriptors.annotations.AnnotationDescriptor
import kotlin.reflect.jvm.internal.impl.descriptors.annotations.KotlinRetention
import kotlin.reflect.jvm.internal.impl.descriptors.impl.TypeAliasConstructorDescriptor
import kotlin.reflect.jvm.internal.impl.incremental.components.LookupLocation
import kotlin.reflect.jvm.internal.impl.name.ClassId
import kotlin.reflect.jvm.internal.impl.name.FqName
import kotlin.reflect.jvm.internal.impl.name.FqNameUnsafe
import kotlin.reflect.jvm.internal.impl.name.Name
import kotlin.reflect.jvm.internal.impl.resolve.DescriptorUtils
import kotlin.reflect.jvm.internal.impl.resolve.DescriptorUtils.getContainingClass
import kotlin.reflect.jvm.internal.impl.resolve.constants.EnumValue
import kotlin.reflect.jvm.internal.impl.resolve.scopes.DescriptorKindFilter
import kotlin.reflect.jvm.internal.impl.resolve.scopes.MemberScope
import kotlin.reflect.jvm.internal.impl.types.KotlinType
import kotlin.reflect.jvm.internal.impl.types.TypeProjection
import kotlin.reflect.jvm.internal.impl.types.TypeSubstitutor
import kotlin.reflect.jvm.internal.impl.types.Variance
import kotlin.reflect.jvm.internal.impl.types.checker.KotlinTypeChecker
import kotlin.reflect.jvm.internal.impl.types.typeUtil.isAnyOrNullableAny
import kotlin.reflect.jvm.internal.impl.types.typeUtil.makeNullable
import kotlin.reflect.jvm.internal.impl.utils.DFS
import kotlin.reflect.jvm.internal.impl.utils.SmartList
fun ClassDescriptor.getClassObjectReferenceTarget(): ClassDescriptor = companionObjectDescriptor ?: this
fun DeclarationDescriptor.getImportableDescriptor(): DeclarationDescriptor {
return when {
this is TypeAliasConstructorDescriptor -> containingDeclaration
this is ConstructorDescriptor -> containingDeclaration
this is PropertyAccessorDescriptor -> correspondingProperty
else -> this
}
}
val DeclarationDescriptor.fqNameUnsafe: FqNameUnsafe
get() = DescriptorUtils.getFqName(this)
val DeclarationDescriptor.fqNameSafe: FqName
get() = DescriptorUtils.getFqNameSafe(this)
val DeclarationDescriptor.isExtension: Boolean
get() = this is CallableDescriptor && extensionReceiverParameter != null
val DeclarationDescriptor.module: ModuleDescriptor
get() = DescriptorUtils.getContainingModule(this)
fun ModuleDescriptor.resolveTopLevelClass(topLevelClassFqName: FqName, location: LookupLocation): ClassDescriptor? {
assert(!topLevelClassFqName.isRoot)
return getPackage(topLevelClassFqName.parent()).memberScope.getContributedClassifier(topLevelClassFqName.shortName(), location) as? ClassDescriptor
}
val ClassifierDescriptorWithTypeParameters.denotedClassDescriptor: ClassDescriptor?
get() = when (this) {
is ClassDescriptor -> this
is TypeAliasDescriptor -> classDescriptor
else -> throw UnsupportedOperationException("Unexpected descriptor kind: $this")
}
val ClassifierDescriptorWithTypeParameters.classId: ClassId?
get() = containingDeclaration.let { owner ->
when (owner) {
is PackageFragmentDescriptor -> ClassId(owner.fqName, name)
is ClassifierDescriptorWithTypeParameters -> owner.classId?.createNestedClassId(name)
else -> null
}
}
val ClassifierDescriptorWithTypeParameters.hasCompanionObject: Boolean
get() = denotedClassDescriptor?.companionObjectDescriptor != null
val ClassDescriptor.hasClassValueDescriptor: Boolean get() = classValueDescriptor != null
val ClassifierDescriptorWithTypeParameters.classValueDescriptor: ClassDescriptor?
get() = denotedClassDescriptor?.let {
if (it.kind.isSingleton)
it
else
it.companionObjectDescriptor
}
val ClassifierDescriptorWithTypeParameters.classValueTypeDescriptor: ClassDescriptor?
get() = denotedClassDescriptor?.let {
when (it.kind) {
OBJECT -> it
ENUM_ENTRY -> {
// enum entry has the type of enum class
val container = this.containingDeclaration
assert(container is ClassDescriptor && container.kind == ENUM_CLASS)
container as ClassDescriptor
}
else -> it.companionObjectDescriptor
}
}
/** If a literal of this class can be used as a value, returns the type of this value */
val ClassDescriptor.classValueType: KotlinType?
get() = classValueTypeDescriptor?.defaultType
val DeclarationDescriptorWithVisibility.isEffectivelyPublicApi: Boolean
get() = effectiveVisibility().publicApi
val DeclarationDescriptorWithVisibility.isEffectivelyPrivateApi: Boolean
get() = effectiveVisibility().privateApi
val DeclarationDescriptor.isInsidePrivateClass: Boolean
get() {
val parent = containingDeclaration as? ClassDescriptor
return parent != null && Visibilities.isPrivate(parent.visibility)
}
fun ClassDescriptor.getSuperClassNotAny(): ClassDescriptor? {
for (supertype in defaultType.constructor.supertypes) {
if (!KotlinBuiltIns.isAnyOrNullableAny(supertype)) {
val superClassifier = supertype.constructor.declarationDescriptor
if (DescriptorUtils.isClassOrEnumClass(superClassifier)) {
return superClassifier as ClassDescriptor
}
}
}
return null
}
fun ClassDescriptor.getSuperClassOrAny(): ClassDescriptor = getSuperClassNotAny() ?: builtIns.any
fun ClassDescriptor.getSuperInterfaces(): List =
defaultType.constructor.supertypes
.filterNot { KotlinBuiltIns.isAnyOrNullableAny(it) }
.mapNotNull {
val superClassifier = it.constructor.declarationDescriptor
if (DescriptorUtils.isInterface(superClassifier)) superClassifier as ClassDescriptor
else null
}
val ClassDescriptor.secondaryConstructors: List
get() = constructors.filterNot { it.isPrimary }
val DeclarationDescriptor.builtIns: KotlinBuiltIns
get() = module.builtIns
/**
* Returns containing declaration of dispatch receiver for callable adjusted to fake-overridden cases
*
* open class A {
* fun foo() = 1
* }
* class B : A()
*
* for A.foo -> returns A (dispatch receiver parameter is A)
* for B.foo -> returns B (dispatch receiver parameter is still A, but it's fake-overridden in B, so it's containing declaration is B)
*
* class Outer {
* inner class Inner()
* }
*
* for constructor of Outer.Inner -> returns Outer (dispatch receiver parameter is Outer, but it's containing declaration is Inner)
*
*/
fun CallableDescriptor.getOwnerForEffectiveDispatchReceiverParameter(): DeclarationDescriptor? {
if (this is CallableMemberDescriptor && kind == CallableMemberDescriptor.Kind.FAKE_OVERRIDE) {
return getContainingDeclaration()
}
return dispatchReceiverParameter?.containingDeclaration
}
/**
* @return `true` iff the parameter has a default value, i.e. declares it or inherits by overriding a parameter which has a default value.
*/
fun ValueParameterDescriptor.hasDefaultValue(): Boolean {
return DFS.ifAny(
listOf(this),
DFS.Neighbors { current ->
current.overriddenDescriptors.map(ValueParameterDescriptor::getOriginal)
},
ValueParameterDescriptor::declaresDefaultValue
)
}
fun FunctionDescriptor.hasOrInheritsParametersWithDefaultValue(): Boolean = DFS.ifAny(
listOf(this),
{ current -> current.overriddenDescriptors.map { it.original } },
{ it.hasOwnParametersWithDefaultValue() }
)
fun FunctionDescriptor.hasOwnParametersWithDefaultValue() = original.valueParameters.any { it.declaresDefaultValue() }
fun Annotated.isRepeatableAnnotation(): Boolean =
annotations.findAnnotation(KotlinBuiltIns.FQ_NAMES.repeatable) != null
fun Annotated.isDocumentedAnnotation(): Boolean =
annotations.findAnnotation(KotlinBuiltIns.FQ_NAMES.mustBeDocumented) != null
fun Annotated.getAnnotationRetention(): KotlinRetention? {
val retentionArgumentValue = annotations.findAnnotation(KotlinBuiltIns.FQ_NAMES.retention)
?.allValueArguments
?.get(Name.identifier("value"))
as? EnumValue ?: return null
return KotlinRetention.valueOf(retentionArgumentValue.value.name.asString())
}
val DeclarationDescriptor.parentsWithSelf: Sequence
get() = generateSequence(this, { it.containingDeclaration })
val DeclarationDescriptor.parents: Sequence
get() = parentsWithSelf.drop(1)
val CallableMemberDescriptor.propertyIfAccessor: CallableMemberDescriptor
get() = if (this is PropertyAccessorDescriptor) correspondingProperty else this
fun CallableDescriptor.fqNameOrNull(): FqName? = fqNameUnsafe.takeIf { it.isSafe }?.toSafe()
fun CallableMemberDescriptor.firstOverridden(
useOriginal: Boolean = false,
predicate: (CallableMemberDescriptor) -> Boolean
): CallableMemberDescriptor? {
var result: CallableMemberDescriptor? = null
return DFS.dfs(listOf(this),
{ current ->
val descriptor = if (useOriginal) current?.original else current
descriptor?.overriddenDescriptors ?: emptyList()
},
object : DFS.AbstractNodeHandler() {
override fun beforeChildren(current: CallableMemberDescriptor) = result == null
override fun afterChildren(current: CallableMemberDescriptor) {
if (result == null && predicate(current)) {
result = current
}
}
override fun result(): CallableMemberDescriptor? = result
}
)
}
fun CallableMemberDescriptor.setSingleOverridden(overridden: CallableMemberDescriptor) {
overriddenDescriptors = listOf(overridden)
}
fun CallableMemberDescriptor.overriddenTreeAsSequence(useOriginal: Boolean): Sequence =
with(if (useOriginal) original else this) {
sequenceOf(this) + overriddenDescriptors.asSequence().flatMap { it.overriddenTreeAsSequence(useOriginal) }
}
fun D.overriddenTreeUniqueAsSequence(useOriginal: Boolean): Sequence {
val set = hashSetOf()
@Suppress("UNCHECKED_CAST")
fun D.doBuildOverriddenTreeAsSequence(): Sequence {
return with(if (useOriginal) original as D else this) {
if (original in set)
emptySequence()
else {
set += original as D
sequenceOf(this) + (overriddenDescriptors as Collection).asSequence().flatMap { it.doBuildOverriddenTreeAsSequence() }
}
}
}
return doBuildOverriddenTreeAsSequence()
}
fun CallableDescriptor.varargParameterPosition() =
valueParameters.indexOfFirst { it.varargElementType != null }
/**
* When `Inner` is used as type outside of `Outer` class all type arguments should be specified, e.g. `Outer.Inner`
* However, it's not necessary inside Outer's members, only the last one should be specified there.
* So this function return a list of arguments that should be used if relevant arguments weren't specified explicitly inside the [scopeOwner].
*
* Examples:
* for `Outer` class the map will contain: Outer -> (X, Y) (i.e. defaultType mapping)
* for `Derived` class the map will contain: Derived -> (E), Outer -> (E, String)
* for `A.B` class the map will contain: B -> (), Outer -> (Int, CharSequence), A -> ()
*
* open class Outer {
* inner class Inner
* }
*
* class Derived : Outer()
*
* class A : Outer() {
* inner class B : Outer()
* }
*/
fun findImplicitOuterClassArguments(scopeOwner: ClassDescriptor, outerClass: ClassDescriptor): List? {
for (current in scopeOwner.classesFromInnerToOuter()) {
for (supertype in current.getAllSuperClassesTypesIncludeItself()) {
val classDescriptor = supertype.constructor.declarationDescriptor as ClassDescriptor
if (classDescriptor == outerClass) return supertype.arguments
}
}
return null
}
private fun ClassDescriptor.classesFromInnerToOuter() = generateSequence(this) {
if (it.isInner)
it.containingDeclaration.original as? ClassDescriptor
else
null
}
private fun ClassDescriptor.getAllSuperClassesTypesIncludeItself(): List {
val result = arrayListOf()
var current: KotlinType = defaultType
while (!current.isAnyOrNullableAny()) {
result.add(current)
val next = DescriptorUtils.getSuperClassType(current.constructor.declarationDescriptor as ClassDescriptor)
current = TypeSubstitutor.create(current).substitute(next, Variance.INVARIANT) ?: break
}
return result
}
fun FunctionDescriptor.isEnumValueOfMethod(): Boolean {
val methodTypeParameters = valueParameters
val nullableString = builtIns.stringType.makeNullable()
return DescriptorUtils.ENUM_VALUE_OF == name
&& methodTypeParameters.size == 1
&& KotlinTypeChecker.DEFAULT.isSubtypeOf(methodTypeParameters[0].type, nullableString)
}
val DeclarationDescriptor.isExtensionProperty: Boolean
get() = this is PropertyDescriptor && extensionReceiverParameter != null
fun ClassDescriptor.getAllSuperclassesWithoutAny() =
generateSequence(getSuperClassNotAny(), ClassDescriptor::getSuperClassNotAny).toCollection(SmartList())
fun ClassifierDescriptor.getAllSuperClassifiers(): Sequence {
val set = hashSetOf()
fun ClassifierDescriptor.doGetAllSuperClassesAndInterfaces(): Sequence =
if (original in set) {
emptySequence()
}
else {
set += original
sequenceOf(original) + typeConstructor.supertypes.asSequence().flatMap { it.constructor.declarationDescriptor?.doGetAllSuperClassesAndInterfaces() ?: sequenceOf() }
}
return doGetAllSuperClassesAndInterfaces()
}
// Note this is a generic and slow implementation which would work almost for any subclass of ClassDescriptor.
// Please avoid using it in new code.
// TODO: do something more clever instead at call sites of this function
fun computeSealedSubclasses(sealedClass: ClassDescriptor): Collection {
if (sealedClass.modality != Modality.SEALED) return emptyList()
val result = linkedSetOf()
fun collectSubclasses(scope: MemberScope, collectNested: Boolean) {
for (descriptor in scope.getContributedDescriptors(DescriptorKindFilter.CLASSIFIERS)) {
if (descriptor !is ClassDescriptor) continue
if (DescriptorUtils.isDirectSubclass(descriptor, sealedClass)) {
result.add(descriptor)
}
if (collectNested) {
collectSubclasses(descriptor.unsubstitutedInnerClassesScope, collectNested)
}
}
}
val container = sealedClass.containingDeclaration
if (container is PackageFragmentDescriptor) {
collectSubclasses(container.getMemberScope(), collectNested = false)
}
collectSubclasses(sealedClass.unsubstitutedInnerClassesScope, collectNested = true)
return result
}
fun ClassDescriptor.getNoArgsConstructor(): ClassConstructorDescriptor? =
constructors.find { it.valueParameters.isEmpty() }
fun ClassDescriptor.getConstructorForEmptyArgumentsList(): List =
constructors.filter { it.valueParameters.all { it.hasDefaultValue() || it.varargElementType != null } }
fun DeclarationDescriptor.isPublishedApi(): Boolean {
val descriptor = if (this is CallableMemberDescriptor) DescriptorUtils.getDirectMember(this) else this
return descriptor.annotations.hasAnnotation(KotlinBuiltIns.FQ_NAMES.publishedApi)
}
fun DeclarationDescriptor.isAncestorOf(descriptor: DeclarationDescriptor, strict: Boolean): Boolean
= DescriptorUtils.isAncestor(this, descriptor, strict)
fun DeclarationDescriptor.isCompanionObject(): Boolean = DescriptorUtils.isCompanionObject(this)
fun ClassDescriptor.isSubclassOf(superclass: ClassDescriptor): Boolean = DescriptorUtils.isSubclass(this, superclass)
val AnnotationDescriptor.annotationClass: ClassDescriptor?
get() = type.constructor.declarationDescriptor as? ClassDescriptor
fun AnnotationDescriptor.firstArgumentValue() = allValueArguments.values.firstOrNull()?.value
fun MemberDescriptor.isEffectivelyExternal(): Boolean {
if (isExternal) return true
if (this is PropertyAccessorDescriptor) {
val variableDescriptor = correspondingProperty
if (variableDescriptor.isEffectivelyExternal()) return true
}
if (this is PropertyDescriptor) {
if (getter?.isExternal == true &&
(!isVar || setter?.isExternal == true)) return true
}
val containingClass = getContainingClass(this)
return containingClass != null && containingClass.isEffectivelyExternal()
}