• Home
• net.mamoe
• mirai-console
• 2.5-RC-dev-1
• source code
• Value.kt

×

Project download

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.

data.Value.kt Maven / Gradle / Ivy

/*
 * Copyright 2019-2020 Mamoe Technologies and contributors.
 *
 * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
 * Use of this source code is governed by the GNU AFFERO GENERAL PUBLIC LICENSE version 3 license that can be found through the following link.
 *
 * https://github.com/mamoe/mirai/blob/master/LICENSE
 */

@file:Suppress("INVISIBLE_REFERENCE", "INVISIBLE_MEMBER", "unused", "NOTHING_TO_INLINE", "INAPPLICABLE_JVM_NAME")

package net.mamoe.mirai.console.data

import kotlinx.serialization.BinaryFormat
import kotlinx.serialization.KSerializer
import kotlinx.serialization.StringFormat
import net.mamoe.mirai.console.internal.data.map
import net.mamoe.mirai.console.internal.data.setValueBySerializer
import net.mamoe.mirai.console.util.ConsoleExperimentalApi
import kotlin.properties.ReadWriteProperty
import kotlin.reflect.KProperty

/**
 * 表示一个值代理.
 *
 * [Value.value] 可以像 Kotlin 的 `var` 一样被修改, 然而它也可能被用户修改, 如通过 UI 前端, 或通过自动重载.
 *
 * 一些常用的基础类型实现由代码生成创建特性的优化.
 *
 * @see PluginData 容纳 [Value] 的数据对象
 *
 * @see PrimitiveValue 基础数据类型实现
 * @see CompositeValue 复合数据类型实现
 */
public interface Value : ReadWriteProperty {
    @get:JvmName("get")
    @set:JvmName("set")
    public var value: T

    @JvmSynthetic // avoid ambiguity with property `value`
    public override operator fun getValue(thisRef: Any?, property: KProperty<*>): T = value

    @JvmSynthetic
    public override operator fun setValue(thisRef: Any?, property: KProperty<*>, value: T) {
        this.value = value
    }
}

/**
 * 可被序列化的 [Value].
 */
public class SerializableValue(
    @JvmField internal val delegate: Value,
    /**
     * 用于更新和保存 [delegate] 的序列化器
     */
    public override val serializer: KSerializer
) : Value by delegate, SerializerAwareValue {
    public override fun toString(): String = delegate.toString()

    public override fun equals(other: Any?): Boolean {
        if (other === this) return true
        if (other?.javaClass != this.javaClass) return false

        @Suppress("UNCHECKED_CAST")
        other as SerializableValue
        if (other.delegate != this.delegate) return false
        // if (other.serializer != this.serializer) return false
        // TODO: 2020/9/9 serializers should be checked here, but it will cause incomparable issue when putting a SerializableValue as a Key
        return true
    }

    override fun hashCode(): Int {
        @Suppress("UnnecessaryVariable", "CanBeVal")
        var result = delegate.hashCode()
        // result = 31 * result + serializer.hashCode()
        // TODO: 2020/9/9 serializers should be checked here, but it will cause incomparable issue when putting a SerializableValue as a Key
        return result
    }

    public companion object {
        @JvmStatic
        @JvmName("create")
        public fun  Value.serializableValueWith(
            serializer: KSerializer
        ): SerializableValue {
            return SerializableValue(
                this,
                serializer.map(serializer = {
                    this.value
                }, deserializer = { this.setValueBySerializer(it) })
            )
        }
    }
}

/**
 * 带有显式 [序列化器][serializer] 的 [Value].
 *
 * @see SerializableValue 简单实现
 * @see PluginData.value 创建一个这样的 [SerializerAwareValue]
 */
public interface SerializerAwareValue : Value {
    /**
     * 用于更新 [value] 的序列化器. 在反序列化时不会创建新的 [T] 对象实例.
     *
     * - 序列化: `val text: String = Yaml.default.encodeToString(serializer, Unit)`
     * - 反序列化 (本质上是更新 [value], 不创建新的 [T] 实例): `Yaml.default.decodeFromString(serializer, text)`
     */
    public val serializer: KSerializer

    public companion object {
        /**
         * 使用 [指定格式格式][format] 序列化一个 [SerializerAwareValue]
         */
        @JvmStatic
        public fun  SerializerAwareValue.serialize(format: StringFormat): String {
            return format.encodeToString(this.serializer, Unit)
        }

        /**
         * 使用 [指定格式格式][format] 序列化一个 [SerializerAwareValue]
         */
        @JvmStatic
        public fun  SerializerAwareValue.serialize(format: BinaryFormat): ByteArray {
            return format.encodeToByteArray(this.serializer, Unit)
        }

        /**
         * 使用 [指定格式格式][format] 反序列化 (更新) 一个 [SerializerAwareValue]
         */
        @JvmStatic
        public fun  SerializerAwareValue.deserialize(format: StringFormat, string: String) {
            format.decodeFromString(this.serializer, string)
        }

        /**
         * 使用 [指定格式格式][format] 反序列化 (更新) 一个 [SerializerAwareValue]
         */
        @JvmStatic
        public fun  SerializerAwareValue.deserialize(format: BinaryFormat, bytes: ByteArray) {
            format.decodeFromByteArray(this.serializer, bytes)
        }
    }
}

/**
 * 基础数据类型 [Value]
 *
 * 9 个被认为是 *基础类型* 的类型:
 * - 整数: [Byte], [Short], [Int], [Long]
 * - 浮点: [Float], [Double]
 * - [Boolean]
 * - [Char], [String]
 *
 * 注意: 目前这些类型都会被装箱, 由于泛型 T. 在将来可能会有优化处理.
 * *Primitive* 仅表示一个类型是上面 9 种类型之一.
 */
@ConsoleExperimentalApi
public interface PrimitiveValue : Value


//// region PrimitiveValues CODEGEN ////

/**
 * 表示一个不可空 [Byte] [Value].
 */
@ConsoleExperimentalApi
public interface ByteValue : PrimitiveValue

/**
 * 表示一个不可空 [Short] [Value].
 */
@ConsoleExperimentalApi
public interface ShortValue : PrimitiveValue

/**
 * 表示一个不可空 [Int] [Value].
 */
@ConsoleExperimentalApi
public interface IntValue : PrimitiveValue

/**
 * 表示一个不可空 [Long] [Value].
 */
@ConsoleExperimentalApi
public interface LongValue : PrimitiveValue

/**
 * 表示一个不可空 [Float] [Value].
 */
@ConsoleExperimentalApi
public interface FloatValue : PrimitiveValue

/**
 * 表示一个不可空 [Double] [Value].
 */
@ConsoleExperimentalApi
public interface DoubleValue : PrimitiveValue

/**
 * 表示一个不可空 [Char] [Value].
 */
@ConsoleExperimentalApi
public interface CharValue : PrimitiveValue

/**
 * 表示一个不可空 [Boolean] [Value].
 */
@ConsoleExperimentalApi
public interface BooleanValue : PrimitiveValue

/**
 * 表示一个不可空 [String] [Value].
 */
@ConsoleExperimentalApi
public interface StringValue : PrimitiveValue

//// endregion PrimitiveValues CODEGEN ////


/**
 * 复合数据类型实现
 */
@ConsoleExperimentalApi
public interface CompositeValue : Value


/**
 * @see [CompositeListValue]
 * @see [PrimitiveListValue]
 */
public interface ListValue : CompositeValue>

/**
 * 复合数据类型的 [List]
 *
 * @param E 不是基础数据类型
 */
@ConsoleExperimentalApi
public interface CompositeListValue : ListValue

/**
 * 针对基础类型优化的 [List]
 *
 * @param E 是基础类型
 */
@ConsoleExperimentalApi
public interface PrimitiveListValue : ListValue


//// region PrimitiveListValue CODEGEN ////

@ConsoleExperimentalApi
public interface PrimitiveIntListValue : PrimitiveListValue

@ConsoleExperimentalApi
public interface PrimitiveLongListValue : PrimitiveListValue
// TODO + codegen

//// endregion PrimitiveListValue CODEGEN ////


/**
 * @see [CompositeSetValue]
 * @see [PrimitiveSetValue]
 */
@ConsoleExperimentalApi
public interface SetValue : CompositeValue>

/**
 * 复合数据类型 [Set]
 * @param E 是基础数据类型
 */
@ConsoleExperimentalApi
public interface CompositeSetValue : SetValue

/**
 * 基础数据类型 [Set]
 * @param E 是基础数据类型
 */
@ConsoleExperimentalApi
public interface PrimitiveSetValue : SetValue


//// region PrimitiveSetValue CODEGEN ////

@ConsoleExperimentalApi
public interface PrimitiveIntSetValue : PrimitiveSetValue

@ConsoleExperimentalApi
public interface PrimitiveLongSetValue : PrimitiveSetValue
// TODO + codegen

//// endregion PrimitiveSetValue CODEGEN ////


/**
 * @see [CompositeMapValue]
 * @see [PrimitiveMapValue]
 */
@ConsoleExperimentalApi
public interface MapValue : CompositeValue>

@ConsoleExperimentalApi
public interface CompositeMapValue : MapValue

@ConsoleExperimentalApi
public interface PrimitiveMapValue : MapValue


//// region PrimitiveMapValue CODEGEN ////

@ConsoleExperimentalApi
public interface PrimitiveIntIntMapValue : PrimitiveMapValue

@ConsoleExperimentalApi
public interface PrimitiveIntLongMapValue : PrimitiveMapValue
// TODO + codegen

//// endregion PrimitiveSetValue CODEGEN ////


@ConsoleExperimentalApi
public interface ReferenceValue : Value