commonMain.message.protocol.MessageProtocol.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mirai-core-jvm Show documentation
Mirai Protocol implementation for QQ Android
There is a newer version: 2.16.0
/*
 * Copyright 2019-2022 Mamoe Technologies and contributors.
 *
 * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
 * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
 *
 * https://github.com/mamoe/mirai/blob/dev/LICENSE
 */

package net.mamoe.mirai.internal.message.protocol

import net.mamoe.mirai.internal.message.protocol.decode.MessageDecoder
import net.mamoe.mirai.internal.message.protocol.encode.MessageEncoder
import net.mamoe.mirai.internal.message.protocol.outgoing.OutgoingMessagePostprocessor
import net.mamoe.mirai.internal.message.protocol.outgoing.OutgoingMessagePreprocessor
import net.mamoe.mirai.internal.message.protocol.outgoing.OutgoingMessageSender
import net.mamoe.mirai.internal.message.protocol.outgoing.OutgoingMessageTransformer
import net.mamoe.mirai.message.data.SingleMessage
import net.mamoe.mirai.utils.MiraiLogger
import net.mamoe.mirai.utils.systemProp
import net.mamoe.mirai.utils.withSwitch
import kotlin.reflect.KClass

// Loaded by ServiceLoader
internal abstract class MessageProtocol(
    val priority: UInt = PRIORITY_CONTENT // the higher, the prior it being called
) {
    val logger: MiraiLogger by lazy {
        MiraiLogger.Factory.create(this::class).withSwitch(systemProp("mirai.message.protocol.log.full", false))
    }

    fun collectProcessors(processorCollector: ProcessorCollector) {
        processorCollector.collectProcessorsImpl()
    }

    protected abstract fun ProcessorCollector.collectProcessorsImpl()

    companion object {
        const val PRIORITY_METADATA: UInt = 10000u
        const val PRIORITY_CONTENT: UInt = 1000u
        const val PRIORITY_IGNORE: UInt = 500u
        const val PRIORITY_UNSUPPORTED: UInt = 100u
        const val PRIORITY_GENERAL_SENDER: UInt = 100u
    }

    object PriorityComparator : Comparator {
        override fun compare(o1: MessageProtocol, o2: MessageProtocol): Int {

            // Do not use o1.compareTo
            // > Task :mirai-core:checkAndroidApiLevel
            // > /Users/runner/work/mirai/mirai/mirai-core/build/classes/kotlin/android/main/net/mamoe/mirai/internal/message/protocol/MessageProtocol$PriorityComparator.class
            //    > Method compare(Lnet/mamoe/mirai/internal/message/protocol/MessageProtocol;Lnet/mamoe/mirai/internal/message/protocol/MessageProtocol;)I
            //      > Invoke method java/lang/Integer.compareUnsigned(II)I
            //          Couldn't access java/lang/Integer.compareUnsigned(II)I: java/lang/Integer.compareUnsigned(II)I since api level 26

            return uintCompare(o1.priority.toInt(), o2.priority.toInt())
        }

        private fun uintCompare(v1: Int, v2: Int): Int = (v1 xor Int.MIN_VALUE).compareTo(v2 xor Int.MIN_VALUE)
    }
}

internal abstract class ProcessorCollector {
    inline fun  add(encoder: MessageEncoder) = add(encoder, T::class)


    abstract fun  add(encoder: MessageEncoder, elementType: KClass)

    abstract fun add(decoder: MessageDecoder)


    abstract fun add(preprocessor: OutgoingMessagePreprocessor)
    abstract fun add(transformer: OutgoingMessageTransformer)
    abstract fun add(sender: OutgoingMessageSender)
    abstract fun add(postprocessor: OutgoingMessagePostprocessor)
}


///////////////////////////////////////////////////////////////////////////
// refiners
///////////////////////////////////////////////////////////////////////////


//internal interface MessageRefiner : Processor
//
//internal interface MessageRefinerContext : ProcessorPipelineContext {
//    /**
//     * Refine if possible (without suspension), returns self otherwise.
//     * @since 2.6
//     */ // see #1157
//    fun tryRefine(
//        bot: Bot,
//        context: MessageChain,
//        refineContext: RefineContext = EmptyRefineContext,
//    ): Message? = this
//
//    /**
//     * This message [RefinableMessage] will be replaced by return value of [refineLight]
//     */
//    suspend fun refine(
//        bot: Bot,
//        context: MessageChain,
//        refineContext: RefineContext = EmptyRefineContext,
//    ): Message? = tryRefine(bot, context, refineContext)
//}
//