github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2025-01-25 15:40:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

API stabilization: move provideDelegate from PluginData to AbstractPluginData

Browse Source
This commit is contained in:
Him188 2020-09-18 20:19:39 +08:00
parent 179c89b48f
commit 53890bcb5d
2 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/data/AbstractPluginData.kt
View File

@ -14,6 +14,9 @@ package net.mamoe.mirai.console.data
import kotlinx.serialization.KSerializer
import net.mamoe.mirai.console.data.PluginData.ValueNode
import net.mamoe.mirai.console.internal.data.PluginDataImpl
import net.mamoe.mirai.console.internal.data.getAnnotationListForValueSerialization
import net.mamoe.mirai.console.internal.data.valueName
import kotlin.reflect.KProperty
/**
* [PluginData] 的默认实现. 支持使用 `by value()` 等委托方法创建 [Value] 并跟踪其改动.
@ -36,6 +39,14 @@ public abstract class AbstractPluginData : PluginData, PluginDataImpl() {
public override fun <T : SerializerAwareValue<*>> T.track(valueName: String, annotations: List<Annotation>): T =
apply { valueNodes.add(ValueNode(valueName, this, annotations, this.serializer)) }
/**
* 使用 `by value()` 时自动调用此方法, 添加对 [Value] 的值修改的跟踪, 并创建 [ValueNode] 加入 [valueNodes]
*/
public operator fun <T : SerializerAwareValue<*>> T.provideDelegate(
thisRef: Any?,
property: KProperty<*>,
): T = track(property.valueName, property.getAnnotationListForValueSerialization())
/**
* 所有 [valueNodes] 更新和保存序列化器. 仅供内部使用
*/
@ -45,5 +56,14 @@ public abstract class AbstractPluginData : PluginData, PluginDataImpl() {
/**
* 当所属于这个 [PluginData] 的 [Value] 的 [值][Value.value] 被修改时被调用.
*/
public abstract override fun onValueChanged(value: Value<*>)
public override fun onValueChanged(value: Value<*>) {
// no-op by default
}
/**
* 当这个 [PluginData] 被放入一个 [PluginDataStorage] 时调用
*/
public override fun onInit(owner: PluginDataHolder, storage: PluginDataStorage) {
// no-op by default
}
}

8
backend/mirai-console/src/main/kotlin/net/mamoe/mirai/console/data/PluginData.kt
View File

@ -155,14 +155,6 @@ public interface PluginData {
val updaterSerializer: KSerializer<Unit>
)
/**
* 使用 `by value()` 时自动调用此方法, 添加对 [Value] 的值修改的跟踪, 并创建 [ValueNode] 加入 [valueNodes]
*/
public operator fun <T : SerializerAwareValue<*>> T.provideDelegate(
thisRef: Any?,
property: KProperty<*>
): T = track(property.valueName, property.getAnnotationListForValueSerialization())
/**
* 供手动实现时值跟踪使用 (如 Java 用户). 一般 Kotlin 用户需使用 [provideDelegate]
*/