org.jetbrains.kotlin.fir.declarations.OperatorFunctionChecks.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.fir.declarations
import org.jetbrains.kotlin.config.LanguageFeature
import org.jetbrains.kotlin.fir.FirSession
import org.jetbrains.kotlin.fir.containingClassLookupTag
import org.jetbrains.kotlin.fir.declarations.utils.isInline
import org.jetbrains.kotlin.fir.declarations.utils.isSuspend
import org.jetbrains.kotlin.fir.languageVersionSettings
import org.jetbrains.kotlin.fir.resolve.ScopeSession
import org.jetbrains.kotlin.fir.resolve.defaultType
import org.jetbrains.kotlin.fir.resolve.fullyExpandedType
import org.jetbrains.kotlin.fir.resolve.toRegularClassSymbol
import org.jetbrains.kotlin.fir.scopes.overriddenFunctions
import org.jetbrains.kotlin.fir.types.*
import org.jetbrains.kotlin.fir.types.impl.ConeClassLikeTypeImpl
import org.jetbrains.kotlin.name.Name
import org.jetbrains.kotlin.name.StandardClassIds
import org.jetbrains.kotlin.util.OperatorNameConventions
sealed class CheckResult(val isSuccess: Boolean) {
class IllegalSignature(val error: String) : CheckResult(false)
object IllegalFunctionName : CheckResult(false)
object SuccessCheck : CheckResult(true)
}
object OperatorFunctionChecks {
fun isOperator(function: FirSimpleFunction, session: FirSession, scopeSession: ScopeSession?): CheckResult {
val checks = checksByName.getOrElse(function.name) {
regexChecks.find { it.first.matches(function.name.asString()) }?.second
} ?: return CheckResult.IllegalFunctionName
for (check in checks) {
check.check(function, session, scopeSession)?.let { return CheckResult.IllegalSignature(it) }
}
return CheckResult.SuccessCheck
}
//reimplementation of org.jetbrains.kotlin.util.OperatorChecks for FIR
private val checksByName: Map> = buildMap {
checkFor(OperatorNameConventions.GET, Checks.memberOrExtension, Checks.ValueParametersCount.atLeast(1))
checkFor(
OperatorNameConventions.SET,
Checks.memberOrExtension, Checks.ValueParametersCount.atLeast(2),
Checks.simple("last parameter should not have a default value or be a vararg") { it, _ ->
it.valueParameters.lastOrNull()?.let { param ->
param.defaultValue == null && !param.isVararg
} == true
}
)
checkFor(
OperatorNameConventions.GET_VALUE,
Checks.memberOrExtension,
Checks.noDefaultAndVarargs, Checks.ValueParametersCount.atLeast(2),
Checks.isKProperty,
Checks.nonSuspend,
)
checkFor(
OperatorNameConventions.SET_VALUE,
Checks.memberOrExtension,
Checks.noDefaultAndVarargs, Checks.ValueParametersCount.atLeast(3),
Checks.isKProperty,
Checks.nonSuspend,
)
checkFor(
OperatorNameConventions.PROVIDE_DELEGATE,
Checks.memberOrExtension,
Checks.noDefaultAndVarargs, Checks.ValueParametersCount.exactly(2),
Checks.isKProperty,
Checks.nonSuspend,
)
checkFor(OperatorNameConventions.INVOKE, Checks.memberOrExtension)
checkFor(
OperatorNameConventions.CONTAINS,
Checks.memberOrExtension, Checks.ValueParametersCount.single,
Checks.noDefaultAndVarargs, Checks.Returns.boolean
)
checkFor(OperatorNameConventions.ITERATOR, Checks.memberOrExtension, Checks.ValueParametersCount.none)
checkFor(OperatorNameConventions.NEXT, Checks.memberOrExtension, Checks.ValueParametersCount.none)
checkFor(OperatorNameConventions.HAS_NEXT, Checks.memberOrExtension, Checks.ValueParametersCount.none, Checks.Returns.boolean)
checkFor(OperatorNameConventions.RANGE_TO, Checks.memberOrExtension, Checks.ValueParametersCount.single, Checks.noDefaultAndVarargs)
checkFor(
OperatorNameConventions.RANGE_UNTIL,
Checks.memberOrExtension, Checks.ValueParametersCount.single,
Checks.noDefaultAndVarargs
)
checkFor(
OperatorNameConventions.EQUALS,
Checks.member,
object : Check() {
override fun check(function: FirSimpleFunction, session: FirSession, scopeSession: ScopeSession?): String? {
if (scopeSession == null) return null
val containingClassSymbol = function.containingClassLookupTag()?.toRegularClassSymbol(session) ?: return null
val customEqualsSupported = session.languageVersionSettings.supportsFeature(LanguageFeature.CustomEqualsInValueClasses)
if (function.symbol.overriddenFunctions(containingClassSymbol, session, scopeSession)
.any { it.containingClassLookupTag()?.classId == StandardClassIds.Any }
|| (customEqualsSupported && function.isTypedEqualsInValueClass(session))
|| containingClassSymbol.classId == StandardClassIds.Any
) {
return null
}
return buildString {
append("must override 'equals()' in Any")
if (customEqualsSupported && containingClassSymbol.isInline) {
val expectedParameterTypeRendered =
containingClassSymbol.defaultType().replaceArgumentsWithStarProjections().renderReadable()
append(" or define 'equals(other: ${expectedParameterTypeRendered}): Boolean'")
}
}
}
}
)
checkFor(
OperatorNameConventions.COMPARE_TO,
Checks.memberOrExtension, Checks.Returns.int, Checks.ValueParametersCount.single,
Checks.noDefaultAndVarargs
)
checkFor(
OperatorNameConventions.BINARY_OPERATION_NAMES,
Checks.memberOrExtension, Checks.ValueParametersCount.single,
Checks.noDefaultAndVarargs
)
checkFor(OperatorNameConventions.SIMPLE_UNARY_OPERATION_NAMES, Checks.memberOrExtension, Checks.ValueParametersCount.none)
checkFor(
setOf(OperatorNameConventions.INC, OperatorNameConventions.DEC),
Checks.memberOrExtension,
Checks.full("receiver must be a supertype of the return type") { session, function ->
val receiver = function.dispatchReceiverType ?: function.receiverParameter?.typeRef?.coneType ?: return@full false
function.returnTypeRef.coneType.isSubtypeOf(session.typeContext, receiver)
}
)
checkFor(
OperatorNameConventions.ASSIGNMENT_OPERATIONS,
Checks.memberOrExtension, Checks.Returns.unit, Checks.ValueParametersCount.single,
Checks.noDefaultAndVarargs
)
}
private val regexChecks: List>> = buildList {
checkFor(OperatorNameConventions.COMPONENT_REGEX, Checks.memberOrExtension, Checks.ValueParametersCount.none)
}
private fun MutableMap>.checkFor(name: Name, vararg checks: Check) {
put(name, checks.asList())
}
private fun MutableMap>.checkFor(names: Set, vararg checks: Check) {
names.forEach { put(it, checks.asList()) }
}
private fun MutableList>>.checkFor(regex: Regex, vararg checks: Check) {
add(regex to checks.asList())
}
}
private abstract class Check {
abstract fun check(function: FirSimpleFunction, session: FirSession, scopeSession: ScopeSession?): String?
}
private object Checks {
fun simple(message: String, predicate: (FirSimpleFunction, FirSession) -> Boolean) = object : Check() {
override fun check(function: FirSimpleFunction, session: FirSession, scopeSession: ScopeSession?): String? =
message.takeIf { !predicate(function, session) }
}
fun full(message: String, predicate: (FirSession, FirSimpleFunction) -> Boolean) = object : Check() {
override fun check(function: FirSimpleFunction, session: FirSession, scopeSession: ScopeSession?): String? =
message.takeIf { !predicate(session, function) }
}
val memberOrExtension = simple("must be a member or an extension function") { it, _ ->
it.dispatchReceiverType != null || it.receiverParameter != null
}
val member = simple("must be a member function") { it, _ ->
it.dispatchReceiverType != null
}
val nonSuspend = simple("must not be suspend") { it, _ ->
!it.isSuspend
}
object ValueParametersCount {
fun atLeast(n: Int) = simple("must have at least $n value parameter" + (if (n > 1) "s" else "")) { it, _ ->
it.valueParameters.size >= n
}
fun exactly(n: Int) = simple("must have exactly $n value parameters") { it, _ ->
it.valueParameters.size == n
}
val single = simple("must have a single value parameter") { it, _ ->
it.valueParameters.size == 1
}
val none = simple("must have no value parameters") { it, _ ->
it.valueParameters.isEmpty()
}
}
object Returns {
val boolean = simple("must return 'Boolean'") { it, session ->
it.returnTypeRef.coneType.fullyExpandedType(session).isBoolean
}
val int = simple("must return 'Int'") { it, session ->
it.returnTypeRef.coneType.fullyExpandedType(session).isInt
}
val unit = simple("must return 'Unit'") { it, session ->
it.returnTypeRef.coneType.fullyExpandedType(session).isUnit
}
}
val noDefaultAndVarargs = simple("should not have varargs or parameters with default values") { it, _ ->
it.valueParameters.all { param ->
param.defaultValue == null && !param.isVararg
}
}
private val kPropertyType = ConeClassLikeTypeImpl(
StandardClassIds.KProperty.toLookupTag(),
arrayOf(ConeStarProjection),
isNullable = false
)
val isKProperty = full("second parameter must be of type KProperty<*> or its supertype") { session, function ->
val paramType = function.valueParameters.getOrNull(1)?.returnTypeRef?.coneType ?: return@full false
kPropertyType.isSubtypeOf(paramType, session, errorTypesEqualToAnything = true)
}
}