Skip to content

Commit

Permalink
Report diagnostic on virtual tailrec function
Browse files Browse the repository at this point in the history
 #KT-18541 Fixed
  • Loading branch information
Mikhael Bogdanov committed Oct 16, 2019
1 parent 8305baa commit adae629
Show file tree
Hide file tree
Showing 14 changed files with 671 additions and 8 deletions.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,8 @@ public interface Errors {
DiagnosticFactory0<KtParameter> VALUE_PARAMETER_WITH_NO_TYPE_ANNOTATION = DiagnosticFactory0.create(ERROR);

DiagnosticFactory0<KtNamedFunction> NO_TAIL_CALLS_FOUND = DiagnosticFactory0.create(WARNING, DECLARATION_SIGNATURE);
DiagnosticFactory0<KtNamedFunction> TAILREC_ON_VIRTUAL_MEMBER = DiagnosticFactory0.create(WARNING, DECLARATION_SIGNATURE);
DiagnosticFactory0<KtNamedFunction> TAILREC_ON_VIRTUAL_MEMBER_ERROR = DiagnosticFactory0.create(ERROR, DECLARATION_SIGNATURE);

DiagnosticFactory0<KtParameter>
ANONYMOUS_FUNCTION_PARAMETER_WITH_DEFAULT_VALUE = DiagnosticFactory0.create(ERROR, PARAMETER_DEFAULT_VALUE);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,9 @@ public static DiagnosticRenderer getRendererForDiagnostic(@NotNull Diagnostic di
MAP.put(ILLEGAL_SELECTOR, "The expression cannot be a selector (occur after a dot)");

MAP.put(NO_TAIL_CALLS_FOUND, "A function is marked as tail-recursive but no tail calls are found");
MAP.put(TAILREC_ON_VIRTUAL_MEMBER, "Tailrec on open members is deprecated");
MAP.put(TAILREC_ON_VIRTUAL_MEMBER_ERROR, "Tailrec is not allowed on open members");

MAP.put(VALUE_PARAMETER_WITH_NO_TYPE_ANNOTATION, "A type annotation is required on a value parameter");
MAP.put(BREAK_OR_CONTINUE_OUTSIDE_A_LOOP, "'break' and 'continue' are only allowed inside a loop");
MAP.put(BREAK_OR_CONTINUE_IN_WHEN, "'break' and 'continue' are not allowed in 'when' statements. Consider using labels to continue/break from the outer loop");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ private val DEFAULT_DECLARATION_CHECKERS = listOf(
AnnotationClassTargetAndRetentionChecker(),
ReservedMembersAndConstructsForInlineClass(),
ResultClassInReturnTypeChecker(),
LocalVariableTypeParametersChecker()
LocalVariableTypeParametersChecker(),
TailrecFunctionChecker
)

private val DEFAULT_CALL_CHECKERS = listOf(
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* Copyright 2010-2019 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.resolve.checkers

import org.jetbrains.kotlin.config.LanguageFeature
import org.jetbrains.kotlin.descriptors.DeclarationDescriptor
import org.jetbrains.kotlin.descriptors.FunctionDescriptor
import org.jetbrains.kotlin.diagnostics.Errors
import org.jetbrains.kotlin.psi.KtDeclaration
import org.jetbrains.kotlin.psi.KtNamedFunction
import org.jetbrains.kotlin.resolve.isEffectivelyFinal

object TailrecFunctionChecker : DeclarationChecker {
override fun check(declaration: KtDeclaration, descriptor: DeclarationDescriptor, context: DeclarationCheckerContext) {
if (declaration !is KtNamedFunction || descriptor !is FunctionDescriptor || !descriptor.isTailrec) return

if (descriptor.isEffectivelyFinal(false)) return

if (!context.languageVersionSettings.supportsFeature(LanguageFeature.ProhibitTailrecOnVirtualMember)) {
context.trace.report(Errors.TAILREC_ON_VIRTUAL_MEMBER.on(declaration))
} else {
context.trace.report(Errors.TAILREC_ON_VIRTUAL_MEMBER_ERROR.on(declaration))
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import org.jetbrains.kotlin.resolve.BindingContext
import org.jetbrains.kotlin.resolve.BindingTrace
import org.jetbrains.kotlin.resolve.calls.components.hasDefaultValue
import org.jetbrains.kotlin.resolve.descriptorUtil.declaresOrInheritsDefaultValue
import org.jetbrains.kotlin.resolve.isEffectivelyFinal

class InlineAnalyzerExtension(
private val reasonableInlineRules: Iterable<ReasonableInlineRule>,
Expand Down Expand Up @@ -159,7 +160,8 @@ class InlineAnalyzerExtension(
}
}

if (callableDescriptor.isEffectivelyFinal()) {
//TODO: actually it should be isEffectivelyFinal(false), but looks like it requires committee decision: KT-34372)
if (callableDescriptor.isEffectivelyFinal(true)) {
if (overridesAnything) {
trace.report(Errors.OVERRIDE_BY_INLINE.on(functionOrProperty))
}
Expand All @@ -168,12 +170,6 @@ class InlineAnalyzerExtension(
trace.report(Errors.DECLARATION_CANT_BE_INLINED.on(functionOrProperty))
}

private fun CallableMemberDescriptor.isEffectivelyFinal(): Boolean =
modality == Modality.FINAL ||
containingDeclaration.let { containingDeclaration ->
containingDeclaration is ClassDescriptor && containingDeclaration.modality == Modality.FINAL
}

private fun checkHasInlinableAndNullability(functionDescriptor: FunctionDescriptor, function: KtFunction, trace: BindingTrace) {
var hasInlineArgs = false
function.valueParameters.zip(functionDescriptor.valueParameters).forEach { (parameter, descriptor) ->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@

package org.jetbrains.kotlin.resolve

import org.jetbrains.kotlin.descriptors.CallableMemberDescriptor
import org.jetbrains.kotlin.descriptors.ClassDescriptor
import org.jetbrains.kotlin.descriptors.FunctionDescriptor
import org.jetbrains.kotlin.descriptors.Modality
import org.jetbrains.kotlin.types.DeferredType
import org.jetbrains.kotlin.types.KotlinType
import org.jetbrains.kotlin.types.typeUtil.contains
Expand All @@ -24,3 +27,11 @@ fun FunctionDescriptor.isFunctionForExpectTypeFromCastFeature(): Boolean {

return true
}


internal fun CallableMemberDescriptor.isEffectivelyFinal(ignoreEnumClassFinality: Boolean): Boolean =
modality == Modality.FINAL ||
containingDeclaration.let { parent ->
(ignoreEnumClassFinality || !DescriptorUtils.isEnumClass(parent)) &&
parent is ClassDescriptor && parent.modality == Modality.FINAL
}
171 changes: 171 additions & 0 deletions compiler/testData/diagnostics/tests/tailRecOnVirtualMember.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
//!LANGUAGE: -ProhibitTailrecOnVirtualMember

open class A {
<!TAILREC_ON_VIRTUAL_MEMBER!>tailrec open fun foo(x: Int)<!> {
foo(x)
}

<!TAILREC_ON_VIRTUAL_MEMBER!>internal tailrec open fun bar(y: Int)<!> {
bar(y)
}

<!TAILREC_ON_VIRTUAL_MEMBER!>protected tailrec open fun baz(y: Int)<!> {
baz(y)
}

private tailrec fun boo(y: Int) {
boo(y)
}

internal tailrec fun baa(y: Int) {
baa(y)
}
}

open class B : A() {
final tailrec override fun foo(x: Int) {
foo(x)
}

final tailrec override fun bar(y: Int) {
bar(y)
}

final tailrec override fun baz(y: Int) {
baz(y)
}
}


open class C : A() {
<!TAILREC_ON_VIRTUAL_MEMBER!>tailrec override fun foo(x: Int)<!> {
foo(x)
}

<!TAILREC_ON_VIRTUAL_MEMBER!>tailrec override fun bar(y: Int)<!> {
bar(y)
}

<!TAILREC_ON_VIRTUAL_MEMBER!>tailrec override fun baz(y: Int)<!> {
baz(y)
}
}

object D : A() {
tailrec override fun foo(x: Int) {
foo(x)
}

tailrec override fun bar(y: Int) {
bar(y - 1)
}

tailrec override fun baz(y: Int) {
baz(y)
}
}

sealed class E : A() {
<!TAILREC_ON_VIRTUAL_MEMBER!>tailrec override fun foo(x: Int)<!> {
foo(x)
}

<!TAILREC_ON_VIRTUAL_MEMBER!>tailrec override fun bar(y: Int)<!> {
bar(y)
}

<!TAILREC_ON_VIRTUAL_MEMBER!>tailrec override fun baz(y: Int)<!> {
baz(y)
}

class E1 : E() {
tailrec override fun foo(x: Int) {
foo(x)
}

tailrec override fun bar(y: Int) {
bar(y)
}

tailrec override fun baz(y: Int) {
baz(y)
}
}
}

enum class F {
F0,
F1() {
tailrec override fun foo(x: Int) {
foo(x)
}

tailrec override fun bar(y: Int) {
bar(y)
}

tailrec override fun baz(y: Int) {
baz(y)
}
};

<!TAILREC_ON_VIRTUAL_MEMBER!>tailrec open fun foo(x: Int)<!> {
foo(x)
}

<!TAILREC_ON_VIRTUAL_MEMBER!>internal tailrec open fun bar(y: Int)<!> {
bar(y)
}

<!TAILREC_ON_VIRTUAL_MEMBER!>protected tailrec open fun baz(y: Int)<!> {
baz(y)
}

private tailrec fun boo(y: Int) {
boo(y)
}

internal tailrec fun baa(y: Int) {
baa(y)
}
}

enum class G {

G1;

<!TAILREC_ON_VIRTUAL_MEMBER!>tailrec open fun foo(x: Int)<!> {
foo(x)
}

<!TAILREC_ON_VIRTUAL_MEMBER!>internal tailrec open fun bar(y: Int)<!> {
bar(y)
}

<!TAILREC_ON_VIRTUAL_MEMBER!>protected tailrec open fun baz(y: Int)<!> {
baz(y)
}

private tailrec fun boo(y: Int) {
boo(y)
}

internal tailrec fun baa(y: Int) {
baa(y)
}
}


val z = object : A() {
tailrec override fun foo(x: Int) {
foo(x)
}

tailrec override fun bar(y: Int) {
bar(y)
}

tailrec override fun baz(y: Int) {
baz(y)
}
}
Loading

0 comments on commit adae629

Please sign in to comment.