org.jetbrains.kotlin.gradle.targets.native.cocoapods.CocoapodsExtension.kt Maven / Gradle / Ivy
/*
* Copyright 2010-2019 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.
*/
@file:Suppress("PackageDirectoryMismatch") // Old package for compatibility
package org.jetbrains.kotlin.gradle.plugin.cocoapods
import org.gradle.api.Action
import org.gradle.api.Named
import org.gradle.api.NamedDomainObjectSet
import org.gradle.api.Project
import org.gradle.api.provider.Provider
import org.gradle.api.tasks.*
import org.jetbrains.kotlin.gradle.dsl.multiplatformExtension
import org.jetbrains.kotlin.gradle.plugin.cocoapods.CocoapodsExtension.CocoapodsDependency.PodLocation.*
import org.jetbrains.kotlin.gradle.plugin.cocoapods.KotlinCocoapodsPlugin.Companion.POD_FRAMEWORK_PREFIX
import org.jetbrains.kotlin.gradle.plugin.diagnostics.kotlinToolingDiagnosticsCollector
import org.jetbrains.kotlin.gradle.plugin.mpp.Framework
import org.jetbrains.kotlin.gradle.plugin.mpp.NativeBuildType
import org.jetbrains.kotlin.gradle.targets.native.cocoapods.CocoapodsPluginDiagnostics
import org.jetbrains.kotlin.gradle.utils.getFile
import java.io.File
import java.net.URI
import javax.inject.Inject
@Suppress("unused", "MemberVisibilityCanBePrivate") // Public API
abstract class CocoapodsExtension @Inject constructor(private val project: Project) {
/**
* Configure version of the pod
*/
var version: String? = null
/**
* Configure authors of the pod built from this project.
*/
var authors: String? = null
/**
* Configure existing file `Podfile`.
*/
var podfile: File? = null
internal var needPodspec: Boolean = true
/**
* Setup plugin not to produce podspec file for cocoapods section
*/
fun noPodspec() {
needPodspec = false
}
/**
* Setup plugin to generate synthetic xcodeproj compatible with static libraries
*/
@Deprecated("'useLibraries' mode is removed", level = DeprecationLevel.ERROR)
fun useLibraries() {
project.kotlinToolingDiagnosticsCollector.report(project, CocoapodsPluginDiagnostics.UseLibrariesUsed())
}
/**
* Configure name of the pod built from this project.
*/
var name: String = project.name.asValidFrameworkName()
/**
* Configure license of the pod built from this project.
*/
var license: String? = null
/**
* Configure description of the pod built from this project.
*/
var summary: String? = null
/**
* Configure homepage of the pod built from this project.
*/
var homepage: String? = null
/**
* Configure location of the pod built from this project.
*/
var source: String? = null
/**
* Configure other podspec attributes
*/
var extraSpecAttributes: MutableMap = mutableMapOf()
/**
* Configure framework of the pod built from this project.
*/
fun framework(configure: Framework.() -> Unit) {
forAllPodFrameworks(configure)
}
/**
* Configure framework of the pod built from this project.
*/
fun framework(configure: Action) {
forAllPodFrameworks(configure)
}
val ios: PodspecPlatformSettings = PodspecPlatformSettings("ios")
val osx: PodspecPlatformSettings = PodspecPlatformSettings("osx")
val tvos: PodspecPlatformSettings = PodspecPlatformSettings("tvos")
val watchos: PodspecPlatformSettings = PodspecPlatformSettings("watchos")
private val anyPodFramework = project.provider {
val anyTarget = project.multiplatformExtension.supportedTargets().first()
val anyFramework = anyTarget.binaries
.matching { it.name.startsWith(POD_FRAMEWORK_PREFIX) }
.withType(Framework::class.java)
.first()
anyFramework
}
internal val podFrameworkName: Provider = anyPodFramework.map { it.baseName.asValidFrameworkName() }
internal val podFrameworkIsStatic: Provider = anyPodFramework.map { it.isStatic }
/**
* Configure custom Xcode Configurations to Native Build Types mapping
*/
val xcodeConfigurationToNativeBuildType: MutableMap = mutableMapOf(
"Debug" to NativeBuildType.DEBUG,
"Release" to NativeBuildType.RELEASE
)
/**
* Configure output directory for pod publishing
*/
var publishDir: File = CocoapodsBuildDirs(project.layout).publish.getFile()
internal val specRepos = SpecRepos()
private val _pods = project.container(CocoapodsDependency::class.java)
val podsAsTaskInput: List
get() = _pods.toList()
/**
* Returns a list of pod dependencies.
*/
val pods: NamedDomainObjectSet
get() = _pods
/**
* Add a CocoaPods dependency to the pod built from this project.
*
* @param linkOnly designates that the pod will be used only for dynamic framework linking and not for the cinterops. Code from it won't
* be accessible for referencing from Kotlin but its native symbols will be visible while linking the framework.
*/
@JvmOverloads
fun pod(
name: String,
version: String? = null,
path: File? = null,
moduleName: String = name.asModuleName(),
headers: String? = null,
linkOnly: Boolean = false,
) {
// Empty string will lead to an attempt to create two podDownload tasks.
// One is original podDownload and second is podDownload + pod.name
require(name.isNotEmpty()) { "Please provide not empty pod name to avoid ambiguity" }
addToPods(
project.objects.newInstance(
CocoapodsDependency::class.java,
name,
moduleName
).apply {
this.headers = headers
this.version = version
source = path?.let(::Path)
this.linkOnly = linkOnly
}
)
}
/**
* Add a CocoaPods dependency to the pod built from this project.
*/
fun pod(name: String, configure: CocoapodsDependency.() -> Unit) {
// Empty string will lead to an attempt to create two podDownload tasks.
// One is original podDownload and second is podDownload + pod.name
require(name.isNotEmpty()) { "Please provide not empty pod name to avoid ambiguity" }
val dependency = project.objects.newInstance(CocoapodsDependency::class.java, name, name.asModuleName())
dependency.configure()
addToPods(dependency)
}
/**
* Add a CocoaPods dependency to the pod built from this project.
*/
fun pod(name: String, configure: Action) = pod(name) {
configure.execute(this)
}
private fun addToPods(dependency: CocoapodsDependency) {
val name = dependency.name
check(_pods.findByName(name) == null) { "Project already has a CocoaPods dependency with name $name" }
_pods.add(dependency)
}
/**
* Add spec repositories (note that spec repository is different from usual git repository).
* Please refer to cocoapods documentation
* for additional information.
* Default sources (cdn.cocoapods.org) implicitly included.
*/
fun specRepos(configure: SpecRepos.() -> Unit) = specRepos.configure()
/**
* Add spec repositories (note that spec repository is different from usual git repository).
* Please refer to cocoapods documentation
* for additional information.
* Default sources (cdn.cocoapods.org) implicitly included.
*/
fun specRepos(configure: Action) = specRepos {
configure.execute(this)
}
private fun forAllPodFrameworks(action: Action) {
project.multiplatformExtension.supportedTargets().all { target ->
target.binaries
.matching { it.name.startsWith(POD_FRAMEWORK_PREFIX) }
.withType(Framework::class.java) { action.execute(it) }
}
}
abstract class CocoapodsDependency @Inject constructor(
private val name: String,
@get:Input var moduleName: String
) : Named {
@get:Optional
@get:Input
var headers: String? = null
@get:Optional
@get:Input
var version: String? = null
@get:Optional
@get:Nested
var source: PodLocation? = null
@get:Internal
var extraOpts: List = listOf()
@get:Internal
var packageName: String = "cocoapods.$moduleName"
/**
* Designates that the pod will be used only for dynamic framework linking and not for the cinterops. Code from it won't be
* accessible for referencing from Kotlin but its native symbols will be visible while linking the framework.
*
* For static frameworks adding this flag is equivalent to removing the pod dependency entirely (because pods are not used for
* static framework linking).
*/
@get:Input
var linkOnly: Boolean = false
/**
* Contains a list of dependencies to other pods. This list will be used while building an interop Kotlin-binding for the pod.
*
* @see useInteropBindingFrom
*/
@get:Input
val interopBindingDependencies: MutableList = mutableListOf()
/**
* Specify that the pod depends on another pod **podName** and a Kotlin-binding for **podName** should be used while building
* a binding for the pod. This is necessary if you need to operate entities from **podName** and from the pod together, for
* instance pass an object from **podName** to the pod in Kotlin.
*
* A pod with the exact name must be declared before calling this function.
*
* @see interopBindingDependencies
*/
fun useInteropBindingFrom(podName: String) {
interopBindingDependencies.add(podName)
}
@Input
override fun getName(): String = name
/**
* Path to local pod
*/
fun path(podspecDirectory: String): PodLocation = Path(File(podspecDirectory))
/**
* Path to local pod
*/
fun path(podspecDirectory: File): PodLocation = Path(podspecDirectory)
/**
* Configure pod from git repository. The podspec file is expected to be in the repository root.
*/
@JvmOverloads
fun git(url: String, configure: (Git.() -> Unit)? = null): PodLocation {
val git = Git(URI(url))
if (configure != null) {
git.configure()
}
return git
}
/**
* Configure pod from git repository. The podspec file is expected to be in the repository root.
*/
fun git(url: String, configure: Action) = git(url) {
configure.execute(this)
}
sealed class PodLocation {
@Internal
internal abstract fun getPodSourcePath(): String
data class Path(
@get:InputDirectory
@get:IgnoreEmptyDirectories
val dir: File
) : PodLocation() {
override fun getPodSourcePath() = ":path => '${dir.absolutePath}'"
}
data class Git(
@get:Input val url: URI,
@get:Input @get:Optional var branch: String? = null,
@get:Input @get:Optional var tag: String? = null,
@get:Input @get:Optional var commit: String? = null
) : PodLocation() {
override fun getPodSourcePath() = buildString {
append(":git => '$url'")
when {
branch != null -> append(", :branch => '$branch'")
tag != null -> append(", :tag => '$tag'")
commit != null -> append(", :commit => '$commit'")
}
}
}
}
}
data class PodspecPlatformSettings(
private val name: String,
@get:Optional @get:Input var deploymentTarget: String? = null
) : Named {
@Input
override fun getName(): String = name
}
class SpecRepos {
@get:Internal
internal val specRepos = mutableSetOf("https://cdn.cocoapods.org")
fun url(url: String) {
specRepos.add(url)
}
@Input
internal fun getAll(): Collection {
return specRepos
}
}
companion object {
private fun String.asModuleName() = this
.split("/")[0] // Pick the module name from a subspec name.
.replace('-', '_') // Support pods with dashes in names (see https://github.com/JetBrains/kotlin-native/issues/2884).
}
}