org.jetbrains.kotlin.resolve.checkers.ClassifierUsageChecker.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler Show documentation
Kotlin Compiler
There is a newer version: 2.0.0
/*
 * 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 org.jetbrains.kotlin.resolve.checkers

import com.intellij.psi.PsiElement
import org.jetbrains.kotlin.config.LanguageVersionSettings
import org.jetbrains.kotlin.descriptors.ClassConstructorDescriptor
import org.jetbrains.kotlin.descriptors.ClassifierDescriptor
import org.jetbrains.kotlin.descriptors.DeclarationDescriptorWithSource
import org.jetbrains.kotlin.descriptors.ModuleDescriptor
import org.jetbrains.kotlin.lexer.KtTokens
import org.jetbrains.kotlin.psi.*
import org.jetbrains.kotlin.resolve.BindingContext
import org.jetbrains.kotlin.resolve.BindingTrace
import org.jetbrains.kotlin.resolve.calls.util.FakeCallableDescriptorForTypeAliasObject
import org.jetbrains.kotlin.resolve.deprecation.DeprecationResolver
import org.jetbrains.kotlin.resolve.descriptorUtil.isCompanionObject

interface ClassifierUsageChecker {
    fun check(targetDescriptor: ClassifierDescriptor, element: PsiElement, context: ClassifierUsageCheckerContext)
}

class ClassifierUsageCheckerContext(
    override val trace: BindingTrace,
    override val languageVersionSettings: LanguageVersionSettings,
    override val deprecationResolver: DeprecationResolver,
    override val moduleDescriptor: ModuleDescriptor
) : CheckerContext


fun checkClassifierUsages(
    declarations: Collection,
    checkers: Iterable,
    context: ClassifierUsageCheckerContext
) {
    val visitor = object : KtTreeVisitorVoid() {
        override fun visitReferenceExpression(expression: KtReferenceExpression) {
            super.visitReferenceExpression(expression)

            if (expression is KtNameReferenceExpression && expression.getReferencedNameElementType() == KtTokens.SUPER_KEYWORD) {
                // Do not run checkers here because super expressions is not a proper expression. For example,
                // it doesn't make sense to report deprecation on "super" in "super.foo()" if the super class is deprecated.
                return
            }

            val targets = getReferencedClassifiers(expression)
            for (target in targets) {
                runCheckersWithTarget(target, expression)
            }
        }

        override fun visitFunctionType(type: KtFunctionType) {
            super.visitFunctionType(type)

            val kotlinType = context.trace.get(BindingContext.TYPE, type.parent as? KtTypeReference ?: return)
            if (kotlinType != null) {
                val descriptor = kotlinType.constructor.declarationDescriptor
                if (descriptor is ClassifierDescriptor) {
                    runCheckersWithTarget(descriptor, type)
                }
            }
        }

        private fun runCheckersWithTarget(target: ClassifierDescriptor, expression: KtElement) {
            for (checker in checkers) {
                checker.check(target, expression, context)
            }
        }

        private fun getReferencedClassifiers(expression: KtReferenceExpression): List {
            val target = context.trace.get(BindingContext.REFERENCE_TARGET, expression)

            return when (target) {
                is ClassifierDescriptor ->
                    listOfNotNull(
                        target,
                        getClassifierUsedToReferenceCompanionObject(target, expression)
                    )

                is ClassConstructorDescriptor -> listOf(target.constructedClass)

                is FakeCallableDescriptorForTypeAliasObject -> {
                    val referencedObject = target.getReferencedObject()
                    val referencedTypeAlias = target.typeAliasDescriptor
                    if (referencedObject != referencedTypeAlias.classDescriptor)
                        listOf(referencedObject, referencedTypeAlias)
                    else
                        listOf(referencedTypeAlias)
                }

                else -> {
                    // "Comparable" in "import java.lang.Comparable" references both a class and a SAM constructor and prevents
                    // REFERENCE_TARGET from being recorded in favor of AMBIGUOUS_REFERENCE_TARGET. But we must still run checkers
                    // to report if there's something wrong with the class. We characterize this case below by the following properties:
                    // 1) Exactly one of the references is a classifier
                    // 2) All references refer to the same source element, i.e. their source is the same
                    val targets = context.trace.get(BindingContext.AMBIGUOUS_REFERENCE_TARGET, expression) ?: return emptyList()
                    if (targets.groupBy { (it as? DeclarationDescriptorWithSource)?.source }.size != 1) return emptyList()
                    val targetClassifiers = targets.filterIsInstance()
                    if (targetClassifiers.size == 1) targetClassifiers else emptyList()
                }
            }
        }

        private fun getClassifierUsedToReferenceCompanionObject(
            referencedObject: ClassifierDescriptor,
            expression: KtReferenceExpression
        ): ClassifierDescriptor? =
            if (referencedObject.isCompanionObject())
                context.trace.get(BindingContext.SHORT_REFERENCE_TO_COMPANION_OBJECT, expression)
            else
                null
    }

    for (declaration in declarations) {
        declaration.accept(visitor)
    }
}