azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Gradle] Cover SingleAction hierarchy by KDoc

Browse Source
This commit is contained in:
Alexander Likhachev
2022-09-13 18:58:54 +02:00
committed by Space
parent 3d45bcf08d
commit 6bc9c43952
1 changed files with 48 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/utils/singleAction.kt
+48 -8
View File
@@ -9,11 +9,22 @@ import org.gradle.api.Project
import org.gradle.api.logging.Logger
import java.util.*
/**
* Base implementation of an actions executor that executes them once.
*/
internal abstract class SingleAction {
private val performedActions = WeakHashMap<Project, MutableSet<String>>()
/**
* Calculates a part of a key that is used to determine whether an action from [run] was already executed
*/
protected abstract fun selectKey(project: Project): Project
/**
* Runs an [action] once per key value which is being calculated as a combination of a [selectKey] value and an [actionId]
*
* Warning: if KGP is loaded multiple times by different classloaders, actions with the same [actionId] may be executed more than once
*/
fun run(project: Project, actionId: String, action: () -> Unit) {
val performedActions = performedActions.computeIfAbsent(selectKey(project)) { mutableSetOf() }
if (performedActions.add(actionId)) {
@@ -22,28 +33,57 @@ internal abstract class SingleAction {
}
}
// Warning: if KGP is loaded multiple times by different classloaders, actions may be executed more than once
/**
* Object that allows to run actions once per build
*
* Warning: if KGP is loaded multiple times by different classloaders, actions with the same id may be executed more than once
*/
internal object SingleActionPerBuild : SingleAction() {
override fun selectKey(project: Project): Project = project.rootProject
}
// Warning: if KGP is loaded multiple times by different classloaders, actions may be executed more than once
/**
* Object that allows to run actions once per project
*
* Warning: if KGP is loaded multiple times by different classloaders, actions with the same id may be executed more than once
*/
internal object SingleActionPerProject : SingleAction() {
override fun selectKey(project: Project) = project
}
// Warning: if KGP is loaded multiple times by different classloaders, messages may be shown more than once
/**
* Object that allows to display warning once per build
*
* Warning: if KGP is loaded multiple times by different classloaders, warnings with the same id may be shown more than once
*/
internal object SingleWarningPerBuild {
private const val ACTION_ID_SHOW_WARNING = "show-warning:"
/**
* Prints a warning with [warningText] using logger of [project]
*
* Warning: if KGP is loaded multiple times by different classloaders, warnings with the same id may be shown more than once
*/
fun show(project: Project, warningText: String) = show(project, project.logger, warningText)
fun show(project: Project, logger: Logger, warningText: String) = SingleActionPerBuild.run(project, ACTION_ID_SHOW_WARNING + warningText) {
logger.warn(warningText)
}
/**
* Prints a warning with [warningText] using [logger]
*
* Warning: if KGP is loaded multiple times by different classloaders, warnings with the same id may be shown more than once
*/
fun show(project: Project, logger: Logger, warningText: String) =
SingleActionPerBuild.run(project, ACTION_ID_SHOW_WARNING + warningText) {
logger.warn(warningText)
}
fun deprecation(project: Project, context: String, target: String, replacement: String?) {
/**
* Prints a deprecation warning for [target] of type [type] using logger of [project].
* If there's a replacement for it, you could specify [replacement]
*
* Warning: if KGP is loaded multiple times by different classloaders, warnings with the same id may be shown more than once
*/
fun deprecation(project: Project, type: String, target: String, replacement: String? = null) {
val replacementMessage = replacement?.let { " Please, use '$replacement' instead." } ?: ""
show(project, "Warning: $context '$target' is deprecated and will be removed in next major releases.$replacementMessage\n")
show(project, "Warning: $type '$target' is deprecated and will be removed in next major releases.$replacementMessage\n")
}
}