org.jetbrains.kotlin.analysis.api.components.KtReferenceResolveMixIn.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kotlin-annotation-processing Show documentation

Annotation Processor for Kotlin

There is a newer version: 2.1.0-Beta1

Show newest version

/*
 * Copyright 2010-2021 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.analysis.api.components

import org.jetbrains.kotlin.analysis.api.lifetime.withValidityAssertion
import org.jetbrains.kotlin.analysis.api.symbols.KtSymbol
import org.jetbrains.kotlin.idea.references.KtReference

public interface KtReferenceResolveMixIn : KtAnalysisSessionMixIn {
    public fun KtReference.resolveToSymbols(): Collection = withValidityAssertion {
        return analysisSession.referenceResolveProvider.resolveToSymbols(this)
    }

    public fun KtReference.resolveToSymbol(): KtSymbol? = withValidityAssertion {
        return resolveToSymbols().singleOrNull()
    }

    /**
     * Checks if the reference is an implicit reference to a companion object via the containing class.
     *
     * Example:
     * ```
     * class A {
     *    companion object {
     *       fun foo() {}
     *    }
     * }
     * ```
     *
     * For the case provided, inside the call `A.foo()`,
     * the `A` is an implicit reference to the companion object, so `isImplicitReferenceToCompanion` returns `true`
     *
     * @return `true` if the reference is an implicit reference to a companion object, `false` otherwise.
     */
    public fun KtReference.isImplicitReferenceToCompanion(): Boolean = withValidityAssertion {
        analysisSession.referenceResolveProvider.isImplicitReferenceToCompanion(this)
    }
}