org.jetbrains.kotlin.gradle.targets.native.internal.NativeDistributionType.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.1.0-Beta1
/*
 * Copyright 2010-2020 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.targets.native.internal

import org.gradle.api.Project
import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider
import org.jetbrains.kotlin.gradle.plugin.mpp.isAtLeast
import org.jetbrains.kotlin.gradle.targets.native.internal.NativeDistributionType.*
import org.jetbrains.kotlin.gradle.utils.SingleWarningPerBuild
import org.jetbrains.kotlin.konan.CompilerVersion
import org.jetbrains.kotlin.konan.target.HostManager

internal enum class NativeDistributionType(val suffix: String?, val mustGeneratePlatformLibs: Boolean) {
    LIGHT(null, true),
    PREBUILT("prebuilt", false),

    // Distribution types for 1.3:
    LIGHT_1_3("restricted", false), // aka "restricted" distribution without platform libs for Apple targets.
    PREBUILT_1_3(null, false)
}

internal class NativeDistributionTypeProvider(private val project: Project) {
    private val propertiesProvider = PropertiesProvider(project)

    private fun warning(message: String) = SingleWarningPerBuild.show(project, "Warning: $message")

    private fun chooseDistributionType(
        prebuiltType: NativeDistributionType,
        lightType: NativeDistributionType,
        defaultType: NativeDistributionType
    ): NativeDistributionType {
        val requestedByUser = propertiesProvider.nativeDistributionType?.toLowerCase()
        val deprecatedRestricted = propertiesProvider.nativeDeprecatedRestricted

        // A case when a deprecated property (kotlin.native.restrictedDistribution) is used to choose the restricted distribution.
        // Effectively the restricted distribution from 1.3 and the light distribution from 1.4 are the same,
        // so we allow user to specify kotlin.native.restrictedDistribution in both 1.3 and 1.4
        if (requestedByUser == null && deprecatedRestricted != null) {
            return if (deprecatedRestricted) {
                lightType
            } else {
                defaultType
            }
        }

        // A normal path: no deprecated properties, only kotlin.native.distribution.type.
        return when (requestedByUser) {
            null -> defaultType
            "prebuilt" -> prebuiltType
            "light" -> lightType
            else -> {
                warning("Unknown Kotlin/Native distribution type: $requestedByUser. Available values: prebuilt, light")
                defaultType
            }
        }
    }

    fun getDistributionType(version: CompilerVersion): NativeDistributionType {
        if (propertiesProvider.nativeDeprecatedRestricted != null) {
            warning("Project property 'kotlin.native.restrictedDistribution' is deprecated. Please use 'kotlin.native.distribution.type=light' instead")
        }

        return if (version.isAtLeast(1, 4, 0)) {
            chooseDistributionType(prebuiltType = PREBUILT, lightType = LIGHT, defaultType = PREBUILT)
        } else {
            // In 1.3, the distribution type can be chosen for Mac hosts only.
            if (!HostManager.hostIsMac) {
                return PREBUILT_1_3
            }
            chooseDistributionType(prebuiltType = PREBUILT_1_3, lightType = LIGHT_1_3, defaultType = PREBUILT_1_3)
        }
    }
}