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.
org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension.kt Maven / Gradle / Ivy
/*
* 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.gradle.dsl
import org.gradle.api.Action
import org.gradle.api.InvalidUserCodeException
import org.gradle.api.NamedDomainObjectCollection
import org.gradle.api.Project
import org.jetbrains.kotlin.gradle.DeprecatedTargetPresetApi
import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
import org.jetbrains.kotlin.gradle.InternalKotlinGradlePluginApi
import org.jetbrains.kotlin.gradle.PRESETS_API_IS_DEPRECATED_MESSAGE
import org.jetbrains.kotlin.gradle.internal.dsl.KotlinMultiplatformSourceSetConventionsImpl
import org.jetbrains.kotlin.gradle.internal.syncCommonMultiplatformOptions
import org.jetbrains.kotlin.gradle.plugin.*
import org.jetbrains.kotlin.gradle.plugin.KotlinPluginLifecycle.Stage.AfterFinaliseDsl
import org.jetbrains.kotlin.gradle.plugin.diagnostics.KotlinToolingDiagnostics
import org.jetbrains.kotlin.gradle.plugin.diagnostics.reportDiagnostic
import org.jetbrains.kotlin.gradle.plugin.hierarchy.KotlinHierarchyDslImpl
import org.jetbrains.kotlin.gradle.plugin.hierarchy.redundantDependsOnEdgesTracker
import org.jetbrains.kotlin.gradle.plugin.mpp.*
import org.jetbrains.kotlin.gradle.targets.android.internal.InternalKotlinTargetPreset
import org.jetbrains.kotlin.gradle.targets.android.internal.internal
import org.jetbrains.kotlin.gradle.utils.KotlinCommonCompilerOptionsDefault
import javax.inject.Inject
@Suppress("DEPRECATION")
@KotlinGradlePluginPublicDsl
abstract class KotlinMultiplatformExtension
@InternalKotlinGradlePluginApi constructor(project: Project) :
KotlinProjectExtension(project),
KotlinTargetContainerWithPresetFunctions,
KotlinTargetContainerWithJsPresetFunctions,
KotlinTargetContainerWithWasmPresetFunctions,
KotlinTargetContainerWithNativeShortcuts,
KotlinHierarchyDsl,
HasConfigurableKotlinCompilerOptions,
KotlinMultiplatformSourceSetConventions by KotlinMultiplatformSourceSetConventionsImpl {
@Deprecated(
PRESETS_API_IS_DEPRECATED_MESSAGE,
level = DeprecationLevel.ERROR,
)
override val presets: NamedDomainObjectCollection> = project.container(KotlinTargetPreset::class.java)
final override val targets: NamedDomainObjectCollection = project.container(KotlinTarget::class.java)
@Deprecated("Because only IR compiler is left, no more necessary to know about compiler type in properties")
override val compilerTypeFromProperties: KotlinJsCompilerType? = null
internal suspend fun awaitTargets(): NamedDomainObjectCollection {
AfterFinaliseDsl.await()
return targets
}
private val presetExtension = project.objects.newInstance(
DefaultTargetsFromPresetExtension::class.java,
{ this },
targets,
project,
)
fun targets(configure: Action) {
configure.execute(presetExtension)
}
fun targets(configure: TargetsFromPresetExtension.() -> Unit) {
configure(presetExtension)
}
internal val hierarchy by lazy { KotlinHierarchyDslImpl(targets, sourceSets, redundantDependsOnEdgesTracker) }
/**
* Sets up a 'natural'/'default' hierarchy withing [KotlinTarget]'s in the project.
*
* #### Example
*
* ```kotlin
* kotlin {
* applyDefaultHierarchyTemplate() // <- position of this call is not relevant!
*
* iosX64()
* iosArm64()
* linuxX64()
* linuxArm64()
* }
* ```
*
* Will create the following SourceSets:
* `[iosMain, iosTest, appleMain, appleTest, linuxMain, linuxTest, nativeMain, nativeTest]
*
*
* Hierarchy:
* ```
* common
* |
* +-----------------+-------------------+
* | |
*
* native ...
*
* |
* |
* |
* +----------------------+--------------------+-----------------------+
* | | | |
*
* apple linux mingw androidNative
*
* |
* +-----------+------------+------------+
* | | | |
*
* macos ios tvos watchos
* ```
*
* @see KotlinHierarchyTemplate.extend
*/
fun applyDefaultHierarchyTemplate() = applyHierarchyTemplate(KotlinHierarchyTemplate.default)
/**
* @see applyDefaultHierarchyTemplate
* @see applyHierarchyTemplate
* @param extension: Additionally extend the default hierarchy with additional groups
*
*/
@ExperimentalKotlinGradlePluginApi
fun applyDefaultHierarchyTemplate(extension: KotlinHierarchyBuilder.Root.() -> Unit) {
hierarchy.applyHierarchyTemplate(KotlinHierarchyTemplate.default, extension)
}
@ExperimentalKotlinGradlePluginApi
override fun applyHierarchyTemplate(template: KotlinHierarchyTemplate) {
hierarchy.applyHierarchyTemplate(template)
}
@ExperimentalKotlinGradlePluginApi
override fun applyHierarchyTemplate(template: KotlinHierarchyTemplate, extension: KotlinHierarchyBuilder.Root.() -> Unit) {
hierarchy.applyHierarchyTemplate(template, extension)
}
@ExperimentalKotlinGradlePluginApi
override fun applyHierarchyTemplate(template: KotlinHierarchyBuilder.Root.() -> Unit) {
hierarchy.applyHierarchyTemplate(template)
}
@ExperimentalKotlinGradlePluginApi
val targetHierarchy: DeprecatedKotlinTargetHierarchyDsl get() = DeprecatedKotlinTargetHierarchyDsl(this)
@Suppress("unused") // DSL
val testableTargets: NamedDomainObjectCollection>
get() = targets.withType(KotlinTargetWithTests::class.java)
fun metadata(configure: KotlinOnlyTarget>.() -> Unit = { }): KotlinOnlyTarget> =
@Suppress("UNCHECKED_CAST")
(targets.getByName(KotlinMetadataTarget.METADATA_TARGET_NAME) as KotlinOnlyTarget>).also(configure)
fun metadata(configure: Action>>) = metadata { configure.execute(this) }
fun withSourcesJar(publish: Boolean = true) {
targets.all { it.withSourcesJar(publish) }
}
private fun warnAboutTargetFromPresetDeprecation() {
project.reportDiagnostic(KotlinToolingDiagnostics.TargetFromPreset())
}
@DeprecatedTargetPresetApi
@Deprecated(
KotlinToolingDiagnostics.TargetFromPreset.DEPRECATION_MESSAGE,
level = DeprecationLevel.ERROR
)
fun targetFromPreset(
preset: KotlinTargetPreset,
name: String = preset.name,
configure: T.() -> Unit = { },
): T {
warnAboutTargetFromPresetDeprecation()
return targetFromPresetInternal(
preset = preset,
name = name,
configure = configure,
)
}
@DeprecatedTargetPresetApi
@Deprecated(
KotlinToolingDiagnostics.TargetFromPreset.DEPRECATION_MESSAGE,
level = DeprecationLevel.ERROR
)
fun targetFromPreset(
preset: KotlinTargetPreset,
name: String,
configure: Action,
): T {
warnAboutTargetFromPresetDeprecation()
return targetFromPresetInternal(
preset = preset,
name = name,
configure = configure,
)
}
@DeprecatedTargetPresetApi
@Deprecated(
KotlinToolingDiagnostics.TargetFromPreset.DEPRECATION_MESSAGE,
level = DeprecationLevel.ERROR
)
fun targetFromPreset(preset: KotlinTargetPreset): T {
warnAboutTargetFromPresetDeprecation()
return targetFromPresetInternal(
preset = preset
)
}
@DeprecatedTargetPresetApi
@Deprecated(
KotlinToolingDiagnostics.TargetFromPreset.DEPRECATION_MESSAGE,
level = DeprecationLevel.ERROR
)
fun targetFromPreset(preset: KotlinTargetPreset, name: String): T {
warnAboutTargetFromPresetDeprecation()
return targetFromPresetInternal(
preset = preset,
name = name
)
}
@DeprecatedTargetPresetApi
@Deprecated(
KotlinToolingDiagnostics.TargetFromPreset.DEPRECATION_MESSAGE,
level = DeprecationLevel.ERROR
)
fun targetFromPreset(preset: KotlinTargetPreset, configure: Action): T {
warnAboutTargetFromPresetDeprecation()
return targetFromPresetInternal(
preset = preset,
configure = configure
)
}
internal val rootSoftwareComponent: KotlinSoftwareComponent by lazy {
KotlinSoftwareComponentWithCoordinatesAndPublication(project, "kotlin", targets)
}
override val compilerOptions: KotlinCommonCompilerOptions =
project.objects.KotlinCommonCompilerOptionsDefault(project)
.also {
syncCommonMultiplatformOptions(it)
}
}
@KotlinGradlePluginPublicDsl
interface TargetsFromPresetExtension : NamedDomainObjectCollection {
@Deprecated(
KotlinToolingDiagnostics.FromPreset.DEPRECATION_MESSAGE,
level = DeprecationLevel.ERROR,
)
fun fromPreset(
preset: KotlinTargetPreset,
name: String,
configureAction: T.() -> Unit = {},
): T
@Suppress("DeprecatedCallableAddReplaceWith")
@Deprecated(
KotlinToolingDiagnostics.FromPreset.DEPRECATION_MESSAGE,
level = DeprecationLevel.ERROR,
)
fun fromPreset(
preset: KotlinTargetPreset,
name: String,
): T = @Suppress("DEPRECATION_ERROR") fromPreset(preset, name) {}
@Deprecated(
KotlinToolingDiagnostics.FromPreset.DEPRECATION_MESSAGE,
level = DeprecationLevel.ERROR,
)
fun fromPreset(
preset: KotlinTargetPreset,
name: String,
configureAction: Action,
): T
}
@Suppress("OVERRIDE_DEPRECATION")
internal abstract class DefaultTargetsFromPresetExtension @Inject constructor(
private val targetsContainer: () -> KotlinTargetsContainerWithPresets,
val targets: NamedDomainObjectCollection,
val project: Project,
) : TargetsFromPresetExtension,
NamedDomainObjectCollection by targets {
private fun warnAboutFromPresetDeprecation() {
project.reportDiagnostic(KotlinToolingDiagnostics.FromPreset())
}
override fun fromPreset(
preset: KotlinTargetPreset,
name: String,
configureAction: T.() -> Unit,
): T {
warnAboutFromPresetDeprecation()
return targetsContainer().configureOrCreate(name, preset.internal, configureAction)
}
override fun fromPreset(
preset: KotlinTargetPreset,
name: String,
configureAction: Action,
) = @Suppress("DEPRECATION_ERROR") fromPreset(preset, name) {
configureAction.execute(this)
}
}
private fun KotlinTarget.isProducedFromPreset(kotlinTargetPreset: KotlinTargetPreset<*>): Boolean =
internal._preset == kotlinTargetPreset
internal fun KotlinTargetsContainerWithPresets.configureOrCreate(
targetName: String,
targetPreset: InternalKotlinTargetPreset,
configure: T.() -> Unit,
): T {
val existingTarget = targets.findByName(targetName)
when {
existingTarget?.isProducedFromPreset(targetPreset) ?: false -> {
@Suppress("UNCHECKED_CAST")
configure(existingTarget as T)
return existingTarget
}
existingTarget == null -> {
val newTarget = targetPreset.createTargetInternal(targetName)
targets.add(newTarget)
configure(newTarget)
return newTarget
}
else -> {
// FIXME: KT-71529 - check if this diagnostic is actually reachable and cover with tests or remove
throw InvalidUserCodeException(
"The target '$targetName' already exists, but it was not created with the '${targetPreset.name}' preset. " +
"To configure it, access it using targets API: https://kotl.in/target-configuration"
)
}
}
}
internal val KotlinMultiplatformExtension.metadataTarget get() = metadata() as KotlinMetadataTarget
internal val Iterable.platformTargets: List get() = filter { it !is KotlinMetadataTarget }
internal suspend fun KotlinMultiplatformExtension.awaitMetadataTarget(): KotlinMetadataTarget {
awaitTargets()
return metadataTarget
}
internal fun KotlinMultiplatformExtension.supportedAppleTargets() = targets
.withType(KotlinNativeTarget::class.java)
.matching { it.konanTarget.family.isAppleFamily }
