org.jetbrains.kotlin.gradle.plugin.internal.AttributesConfigurationHelper.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of kotlin-gradle-plugin Show documentation

Kotlin Gradle Plugin

There is a newer version: 2.0.0-RC2

/*
 * 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.gradle.plugin.internal

import org.gradle.api.Project
import org.gradle.api.attributes.Attribute
import org.gradle.api.attributes.HasAttributes
import org.gradle.api.provider.ProviderFactory
import org.jetbrains.kotlin.gradle.plugin.VariantImplementationFactories
import org.jetbrains.kotlin.gradle.plugin.variantImplementationFactory

/**
 * Gradle 7.4 introduced a way of configuring attribute values using a [org.gradle.api.provider.Provider].
 * In Gradle 8.3+ using a non-Provider value caused eager task realization (see KT-60664).
 */
internal interface AttributesConfigurationHelper {
    fun  setAttribute(
        attributesContainer: HasAttributes,
        key: Attribute,
        value: () -> T
    )

    interface AttributeConfigurationHelperVariantFactory : VariantImplementationFactories.VariantImplementationFactory {
        fun getInstance(providerFactory: ProviderFactory): AttributesConfigurationHelper
    }
}

internal class DefaultAttributesConfigurationHelper(
    private val providerFactory: ProviderFactory
) : AttributesConfigurationHelper {
    override fun  setAttribute(
        attributesContainer: HasAttributes,
        key: Attribute,
        value: () -> T
    ) {
        attributesContainer.attributes.attributeProvider(
            key,
            providerFactory.provider { value() }
        )
    }
}

internal class DefaultAttributeConfigurationHelperVariantFactory :
    AttributesConfigurationHelper.AttributeConfigurationHelperVariantFactory {
    override fun getInstance(
        providerFactory: ProviderFactory
    ): AttributesConfigurationHelper = DefaultAttributesConfigurationHelper(providerFactory)
}

internal val Project.attributesConfigurationHelper
    get() = variantImplementationFactory()
        .getInstance(providers)