org.jetbrains.kotlin.backend.common.FunctionsFromAnyGenerator.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-compiler Show documentation
the Kotlin compiler
There is a newer version: 2.1.0-RC
/*
 * Copyright 2010-2018 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.backend.common

import org.jetbrains.kotlin.builtins.KotlinBuiltIns
import org.jetbrains.kotlin.descriptors.ClassDescriptor
import org.jetbrains.kotlin.descriptors.FunctionDescriptor
import org.jetbrains.kotlin.descriptors.PropertyDescriptor
import org.jetbrains.kotlin.descriptors.ValueParameterDescriptor
import org.jetbrains.kotlin.psi.KtClass
import org.jetbrains.kotlin.psi.KtClassOrObject
import org.jetbrains.kotlin.psi.KtParameter
import org.jetbrains.kotlin.resolve.BindingContext
import org.jetbrains.kotlin.resolve.BindingContextUtils

abstract class FunctionsFromAnyGenerator(protected val declaration: KtClassOrObject, protected val bindingContext: BindingContext) {
    protected val classDescriptor: ClassDescriptor = BindingContextUtils.getNotNull(bindingContext, BindingContext.CLASS, declaration)

    open fun generate() {
        val properties = primaryConstructorProperties
        generateToStringIfNeeded(properties)
        generateHashCodeIfNeeded(properties)
        generateEqualsIfNeeded(properties)
    }

    protected abstract fun generateToStringMethod(function: FunctionDescriptor, properties: List)

    protected abstract fun generateHashCodeMethod(function: FunctionDescriptor, properties: List)

    protected abstract fun generateEqualsMethod(function: FunctionDescriptor, properties: List)

    private fun generateToStringIfNeeded(properties: List) {
        val function = CodegenUtil.getMemberToGenerate(
            classDescriptor, "toString",
            KotlinBuiltIns::isString, List::isEmpty
        ) ?: return
        generateToStringMethod(function, properties)
    }

    private fun generateHashCodeIfNeeded(properties: List) {
        val function = CodegenUtil.getMemberToGenerate(
            classDescriptor, "hashCode",
            KotlinBuiltIns::isInt, List::isEmpty
        ) ?: return
        generateHashCodeMethod(function, properties)
    }

    private fun generateEqualsIfNeeded(properties: List) {
        val function = CodegenUtil.getMemberToGenerate(
            classDescriptor, "equals",
            KotlinBuiltIns::isBoolean
        ) { parameters ->
            parameters.size == 1 && KotlinBuiltIns.isNullableAny(parameters.first().type)
        } ?: return
        generateEqualsMethod(function, properties)
    }

    protected val primaryConstructorProperties: List
        get() = primaryConstructorParameters
            .filter { it.hasValOrVar() }
            .map { bindingContext.get(BindingContext.PRIMARY_CONSTRUCTOR_PARAMETER, it)!! }

    protected val primaryConstructorParameters: List
        get() = (declaration as? KtClass)?.primaryConstructorParameters.orEmpty()
}