| /* |
| * Copyright 2018 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package androidx.build |
| |
| import groovy.lang.Closure |
| import org.gradle.api.GradleException |
| import org.gradle.api.Project |
| import java.util.ArrayList |
| |
| /** |
| * Extension for [AndroidXPlugin]. |
| */ |
| open class AndroidXExtension(val project: Project) { |
| var name: String? = null |
| var mavenVersion: Version? = null |
| set(value) { |
| field = value |
| chooseProjectVersion() |
| } |
| var mavenGroup: LibraryGroup? = null |
| set(value) { |
| field = value |
| chooseProjectVersion() |
| } |
| |
| private fun chooseProjectVersion() { |
| val version: Version |
| val groupVersion: Version? = mavenGroup?.forcedVersion |
| val mavenVersion: Version? = mavenVersion |
| if (mavenVersion != null) { |
| if (groupVersion != null && !isGroupVersionOverrideAllowed()) { |
| throw GradleException("Cannot set mavenVersion (" + mavenVersion + |
| ") for a project (" + project + |
| ") whose mavenGroup already specifies forcedVersion (" + groupVersion + |
| ")") |
| } else { |
| version = mavenVersion |
| } |
| } else { |
| if (groupVersion != null) { |
| version = groupVersion |
| } else { |
| return |
| } |
| } |
| project.version = if (isSnapshotBuild()) version.copy(extra = "-SNAPSHOT") else version |
| versionIsSet = true |
| } |
| |
| private fun isGroupVersionOverrideAllowed(): Boolean { |
| // Grant an exception to the same-version-group policy for artifacts that haven't shipped a |
| // stable API surface, e.g. 1.0.0-alphaXX, to allow for rapid early-stage development. |
| val version = mavenVersion |
| return version != null && version.major == 1 && version.minor == 0 && version.patch == 0 && |
| version.isAlpha() |
| } |
| |
| private var versionIsSet = false |
| fun isVersionSet(): Boolean { |
| return versionIsSet |
| } |
| var description: String? = null |
| var inceptionYear: String? = null |
| var url = SUPPORT_URL |
| private var licenses: MutableCollection<License> = ArrayList() |
| var publish: Publish = Publish.NONE |
| var failOnDeprecationWarnings = true |
| |
| var compilationTarget: CompilationTarget = CompilationTarget.DEVICE |
| |
| /** |
| * It disables docs generation and api tracking for tooling modules like annotation processors. |
| * We don't expect such modules to be used by developers as libraries, so we don't guarantee |
| * any api stability and don't expose any docs about them. |
| */ |
| var toolingProject = false |
| |
| fun license(closure: Closure<*>): License { |
| val license = project.configure(License(), closure) as License |
| licenses.add(license) |
| return license |
| } |
| |
| fun getLicenses(): Collection<License> { |
| return licenses |
| } |
| |
| companion object { |
| @JvmField |
| val ARCHITECTURE_URL = |
| "https://developer.android.com/topic/libraries/architecture/index.html" |
| @JvmField |
| val SUPPORT_URL = "https://developer.android.com/jetpack/androidx" |
| val DEFAULT_UNSPECIFIED_VERSION = "unspecified" |
| } |
| } |
| |
| enum class CompilationTarget { |
| /** This library is meant to run on the host machine (like an annotation processor). */ |
| HOST, |
| /** This library is meant to run on an Android device. */ |
| DEVICE |
| } |
| |
| /** |
| * Publish Enum: |
| * Publish.NONE -> Generates no aritfacts; does not generate snapshot artifacts |
| * or releasable maven artifacts |
| * Publish.SNAPSHOT_ONLY -> Only generates snapshot artifacts |
| * Publish.SNAPSHOT_AND_RELEASE -> Generates both snapshot artifacts and releasable maven artifact |
| */ |
| enum class Publish { |
| NONE, SNAPSHOT_ONLY, SNAPSHOT_AND_RELEASE; |
| |
| fun shouldRelease() = this == SNAPSHOT_AND_RELEASE |
| fun shouldPublish() = this == SNAPSHOT_ONLY || this == SNAPSHOT_AND_RELEASE |
| } |
| |
| class License { |
| var name: String? = null |
| var url: String? = null |
| } |