Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2010-2024 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.internal.properties
import org.gradle.api.Project
import org.gradle.api.logging.Logging
import org.gradle.api.plugins.ExtraPropertiesExtension
import org.gradle.api.provider.MapProperty
import org.gradle.api.provider.Provider
import org.gradle.api.provider.ProviderFactory
import org.gradle.api.services.BuildService
import org.gradle.api.services.BuildServiceParameters
import org.jetbrains.kotlin.gradle.plugin.diagnostics.KotlinToolingDiagnostics
import org.jetbrains.kotlin.gradle.plugin.diagnostics.reportDiagnosticOncePerBuild
import org.jetbrains.kotlin.gradle.plugin.extraProperties
import org.jetbrains.kotlin.gradle.plugin.getOrNull
import org.jetbrains.kotlin.gradle.utils.localProperties
import org.jetbrains.kotlin.gradle.utils.mapOrNull
import org.jetbrains.kotlin.gradle.utils.registerClassLoaderScopedBuildService
import java.util.concurrent.Callable
import java.util.concurrent.ConcurrentHashMap
import javax.inject.Inject
/**
* [BuildService] that looks up properties in the following precedence order:
* 1. Project's extra properties ([org.gradle.api.plugins.ExtensionContainer.getExtraProperties])
* 2. Project's Gradle properties ([org.gradle.api.provider.ProviderFactory.gradleProperty])
* 3. Root project's `local.properties` file ([Project.localProperties])
*
* Note that extra and Gradle properties may differ across projects, whereas `local.properties` is shared across all projects.
*/
internal abstract class PropertiesBuildService @Inject constructor(
private val providerFactory: ProviderFactory
) : BuildService {
interface Params : BuildServiceParameters {
val localProperties: MapProperty
}
/**
* Key should be `project.path/propertyName`.
*/
private val propertiesPerProject = ConcurrentHashMap>()
private val localProperties by lazy { parameters.localProperties.get() }
private val logger = Logging.getLogger(this::class.java)
/**
* Returns a [Provider] of the value of the property with the given [propertyName] either from project [extraPropertiesExtension],
* or from configured project properties or from root project `local.properties` file.
*/
fun property(
propertyName: String,
projectPath: String,
extraPropertiesExtension: ExtraPropertiesExtension,
): Provider {
// Note: The same property may be read many times (KT-62496).
// Therefore,
// - Use a map to create only one Provider per property.
// - Use MemoizedCallable to resolve the Provider only once.
return propertiesPerProject.computeIfAbsent("$projectPath/$propertyName") {
// We need to create the MemoizedCallable instance up front so that each time the Provider is resolved, it will reuse the same
// MemoizedCallable.
val valueFromGradleAndLocalProperties = MemoizedCallable {
extraPropertiesExtension.getOrNull(propertyName)?.toString()
?: providerFactory.gradleProperty(propertyName).orNull
?: localProperties[propertyName]
}
providerFactory.provider { valueFromGradleAndLocalProperties.call() }
}
}
/**
* Returns a [Provider] of the value of the property with the given [propertyName] either from project extra properties,
* or from configured project properties or from root project `local.properties` file.
*/
fun property(
propertyName: String,
project: Project,
) = property(propertyName, project.path, project.extraProperties)
fun > property(
property: PROP,
project: Project
): Provider {
return property(property.name, project.path, project.extraProperties)
.mapOrNull(providerFactory) {
val result = when (property) {
is BooleanGradleProperty -> property.toBooleanFromString(it)
is NullableBooleanGradleProperty -> property.toNullableBooleanFromString(it)
is StringGradleProperty, is NullableStringGradleProperty -> it
is IntGradleProperty -> property.toIntFromString(it)
else -> throw IllegalStateException("Unknown Gradle property type $property")
}
@Suppress("UNCHECKED_CAST")
result as T?
}
.run {
val propDefaultValue = property.defaultValue
@Suppress("NULLABILITY_MISMATCH_BASED_ON_JAVA_ANNOTATIONS")
if (propDefaultValue != null) orElse(propDefaultValue) else this
}
}
private fun BooleanGradleProperty.toBooleanFromString(
value: String?
): Boolean = parseBoolean(value, defaultValue, name)
private fun NullableBooleanGradleProperty.toNullableBooleanFromString(
value: String?
): Boolean? = parseBoolean(value, defaultValue, name)
private fun parseBoolean(
value: String?,
defaultValue: T,
propName: String,
): T = when {
value.equals("true", ignoreCase = true) -> {
@Suppress("UNCHECKED_CAST")
true as T
}
value.equals("false", ignoreCase = true) -> {
@Suppress("UNCHECKED_CAST")
false as T
}
else -> {
warnInvalidPropertyValue("Boolean", propName, value, defaultValue)
defaultValue
}
}
private fun IntGradleProperty.toIntFromString(value: String?): Int {
return value?.toIntOrNull() ?: run {
warnInvalidPropertyValue("Int", name, value, defaultValue)
defaultValue
}
}
private fun warnInvalidPropertyValue(
propertyType: String,
name: String,
value: String?,
defaultValue: Any?,
) = logger.warn(
"$propertyType option '$name' was set to an invalid value: `$value`." +
" Using default value '$defaultValue' instead."
)
/** Returns the value of the property with the given [propertyName] in the given [project]. */
fun get(propertyName: String, project: Project): String? {
return property(propertyName, project).orNull
}
companion object {
fun registerIfAbsent(project: Project): Provider =
project.gradle.registerClassLoaderScopedBuildService(PropertiesBuildService::class) {
it.parameters.localProperties.set(project.localProperties)
}
}
private class MemoizedCallable(valueResolver: Callable) : Callable {
private val value: T? by lazy { valueResolver.call() }
override fun call(): T? = value
}
internal sealed interface GradleProperty {
val name: String
val defaultValue: T
}
internal class BooleanGradleProperty(
override val name: String,
override val defaultValue: Boolean
) : GradleProperty
internal class NullableBooleanGradleProperty(
override val name: String,
) : GradleProperty {
override val defaultValue: Boolean? = null
}
internal class StringGradleProperty(
override val name: String,
override val defaultValue: String
) : GradleProperty
internal class NullableStringGradleProperty(
override val name: String,
) : GradleProperty {
override val defaultValue: String? = null
}
internal class IntGradleProperty(
override val name: String,
override val defaultValue: Int
) : GradleProperty
}
internal val Project.propertiesService: Provider
get() = PropertiesBuildService.registerIfAbsent(this)
internal fun PropertiesBuildService.propertyWithDeprecatedName(
nonDeprecatedProperty: PropertiesBuildService.GradleProperty,
deprecatedProperty: PropertiesBuildService.GradleProperty,
project: Project,
): Provider = property(nonDeprecatedProperty, project)
.orElse(
property(deprecatedProperty, project)
.map {
project.reportDiagnosticOncePerBuild(
KotlinToolingDiagnostics.DeprecatedPropertyWithReplacement(
deprecatedProperty.name,
nonDeprecatedProperty.name
)
)
it!!
}
)
