Structured Message

mirai-api-http/src/main/kotlin/net/mamoe/mirai/api/http/data/common/MessageDTO.kt

@@ -17,6 +17,7 @@ import net.mamoe.mirai.message.FriendMessage
 import net.mamoe.mirai.message.GroupMessage
 import net.mamoe.mirai.message.MessagePacket
 import net.mamoe.mirai.message.data.*
+import net.mamoe.mirai.utils.MiraiExperimentalAPI
 import net.mamoe.mirai.utils.MiraiInternalAPI
 
 /*
@@ -99,7 +100,7 @@ fun MessageChain.toDTOChain() = mutableListOf(this[MessageSource].toDTO()).apply
 fun MessageChainDTO.toMessageChain(contact: Contact) =
     buildMessageChain { this@toMessageChain.forEach { add(it.toMessage(contact)) } }
 
-@UseExperimental(ExperimentalUnsignedTypes::class)
+@UseExperimental(ExperimentalUnsignedTypes::class, MiraiExperimentalAPI::class)
 fun Message.toDTO() = when (this) {
     is MessageSource -> MessageSourceDTO(id)
     is At -> AtDTO(target, display)
@@ -111,7 +112,7 @@ fun Message.toDTO() = when (this) {
     else -> UnknownMessageDTO
 }
 
-@UseExperimental(ExperimentalUnsignedTypes::class, MiraiInternalAPI::class)
+@UseExperimental(ExperimentalUnsignedTypes::class, MiraiInternalAPI::class, MiraiExperimentalAPI::class)
 fun MessageDTO.toMessage(contact: Contact) = when (this) {
     is AtDTO -> At((contact as Group)[target])
     is AtAllDTO -> AtAll

mirai-core-qqandroid/src/commonMain/kotlin/net/mamoe/mirai/qqandroid/message/messages.kt

@@ -326,7 +326,7 @@ internal class NotOnlineImageFromServer(
 internal fun MsgComm.Msg.toMessageChain(): MessageChain {
     val elements = this.msgBody.richText.elems
 
-    val message = ArrayList<Message>(elements.size + 1)
+    val message = MessageChainBuilder(elements.size + 1)
     message.add(MessageSourceFromMsg(delegate = this))
     elements.joinToMessageChain(message)
     return message.asMessageChain()
@@ -338,7 +338,7 @@ internal fun MsgComm.Msg.toMessageChain(): MessageChain {
 internal fun ImMsgBody.SourceMsg.toMessageChain(): MessageChain {
     val elements = this.elems!!
 
-    val message = ArrayList<Message>(elements.size + 1)
+    val message = MessageChainBuilder(elements.size + 1)
     message.add(MessageSourceFromServer(delegate = this))
     elements.joinToMessageChain(message)
     return message.asMessageChain()
@@ -346,7 +346,7 @@ internal fun ImMsgBody.SourceMsg.toMessageChain(): MessageChain {
 
 
 @UseExperimental(MiraiInternalAPI::class, ExperimentalUnsignedTypes::class, MiraiDebugAPI::class)
-internal fun List<ImMsgBody.Elem>.joinToMessageChain(message: MutableList<Message>) {
+internal fun List<ImMsgBody.Elem>.joinToMessageChain(message: MessageChainBuilder) {
     this.forEach {
         when {
             it.srcMsg != null -> message.add(QuoteReply(MessageSourceFromServer(it.srcMsg)))

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/contact/Contact.kt

@@ -138,9 +138,5 @@ suspend inline fun <C : Contact> C.sendMessage(message: Message): MessageReceipt
 /**
  * @see Contact.sendMessage
  */
-suspend inline fun <C : Contact> C.sendMessage(plain: String): MessageReceipt<C> = sendMessage(plain.toMessage())
-
-/**
+@Suppress("UNCHECKED_CAST")
+suspend inline fun <C : Contact> C.sendMessage(plain: String): MessageReceipt<C> = sendMessage(plain.toMessage()) as MessageReceipt<C>
\ No newline at end of file
- * @see Contact.sendMessage
- */
-suspend inline fun <C : Contact> C.sendMessage(plain: CombinedMessage): MessageReceipt<C> = sendMessage(MessageChain(plain as Message)) as MessageReceipt<C>
\ No newline at end of file

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/At.kt

@@ -26,7 +26,8 @@ import kotlin.jvm.JvmName
  *
  * @see AtAll 全体成员
  */
-class At @MiraiInternalAPI constructor(val target: Long, val display: String) : Message {
+class At
+@MiraiInternalAPI constructor(val target: Long, val display: String) : Message, MessageContent {
     @UseExperimental(MiraiInternalAPI::class)
     constructor(member: Member) : this(member.id, "@${member.nameCardOrNick}")
 
@@ -38,9 +39,9 @@ class At @MiraiInternalAPI constructor(val target: Long, val display: String) :
 
     override fun followedBy(tail: Message): CombinedMessage {
         if (tail is PlainText && tail.stringValue.startsWith(' ')) {
-            return super.followedBy(tail)
+            return super<MessageContent>.followedBy(tail)
         }
-        return super.followedBy(PlainText(" ")) + tail
+        return super<MessageContent>.followedBy(PlainText(" ")) + tail
     }
 }
 

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/AtAll.kt

@@ -22,15 +22,15 @@ import kotlin.jvm.JvmName
  *
  * @see At at 单个群成员
  */
-object AtAll : Message, Message.Key<AtAll> {
+object AtAll : Message, Message.Key<AtAll>, MessageContent {
     override fun toString(): String = "@全体成员"
 
     // 自动为消息补充 " "
 
     override fun followedBy(tail: Message): CombinedMessage {
         if (tail is PlainText && tail.stringValue.startsWith(' ')) {
-            return super.followedBy(tail)
+            return super<MessageContent>.followedBy(tail)
         }
-        return super.followedBy(PlainText(" ")) + tail
+        return super<MessageContent>.followedBy(PlainText(" ")) + tail
     }
 }
\ No newline at end of file

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/CombinedMessage.kt

@@ -7,8 +7,14 @@
  * https://github.com/mamoe/mirai/blob/master/LICENSE
  */
 
+@file:JvmMultifileClass
+@file:JvmName("MessageUtils")
+
 package net.mamoe.mirai.message.data
 
+import kotlin.jvm.JvmMultifileClass
+import kotlin.jvm.JvmName
+
 /**
  * Left-biased list
  */
@@ -16,6 +22,8 @@ class CombinedMessage(
     val left: Message,
     val element: Message
 ) : Iterable<Message>, Message {
+
+    // 不要把它用作 local function, 会编译错误
     private suspend fun SequenceScope<Message>.yieldCombinedOrElements(message: Message) {
         when (message) {
             is CombinedMessage -> {
@@ -36,6 +44,6 @@ class CombinedMessage(
     }
 
     override fun toString(): String {
-        return left.toString() + element.toString()
+        return element.toString() + left.toString()
     }
 }
\ No newline at end of file

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Face.kt

@@ -18,7 +18,7 @@ import kotlin.jvm.JvmName
 /**
  * QQ 自带表情
  */
-class Face(val id: Int) : Message {
+class Face(val id: Int) : Message, MessageContent {
     override fun toString(): String = "[mirai:face$id]"
 
     /**

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Image.kt

@@ -25,7 +25,7 @@ import kotlin.jvm.JvmStatic
 /**
  * 自定义表情 (收藏的表情), 图片
  */
-sealed class Image : Message {
+sealed class Image : Message, MessageContent {
     companion object Key : Message.Key<Image> {
         @JvmStatic
         @JsName("fromId")

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/Message.kt

@@ -20,6 +20,12 @@ import kotlin.jvm.JvmSynthetic
  * 可发送的或从服务器接收的消息.
  * 采用这样的消息模式是因为 QQ 的消息多元化, 一条消息中可包含 [纯文本][PlainText], [图片][Image] 等.
  *
+ * [消息][Message] 分为
+ * - [MessageMetadata] 消息元数据, 包括: [消息来源][MessageSource]
+ * - [MessageContent] 单个消息, 包括: [纯文本][PlainText], [@群员][At], [@全体成员][AtAll] 等.
+ * - [CombinedMessage] 通过 [plus] 连接的两个消息. 可通过 [asMessageChain] 转换为 [MessageChain]
+ * - [MessageChain] 不可变消息链, 即 [List] 形式链接的多个 [Message] 实例.
+ *
  * **在 Kotlin 使用 [Message]**
  * 这与使用 [String] 的使用非常类似.
  *
@@ -44,6 +50,10 @@ import kotlin.jvm.JvmSynthetic
  * @see PlainText 纯文本
  * @see Image 图片
  * @see Face 表情
+ * @see At 引用一个群成员
+ * @see AtAll 引用全体成员
+ * @see QuoteReply 引用一条消息
+ *
  * @see MessageChain 消息链(即 `List<Message>`)
  *
  * @see Contact.sendMessage 发送消息
@@ -86,8 +96,6 @@ interface Message {
      */
     @JvmSynthetic // in java they should use `plus` instead
     fun followedBy(tail: Message): CombinedMessage {
-        require(tail !is SingleOnly) { "SingleOnly Message cannot follow another message" }
-        require(this !is SingleOnly) { "SingleOnly Message cannot be followed" }
         return CombinedMessage(tail, this)
     }
 
@@ -100,12 +108,35 @@ interface Message {
     operator fun plus(another: CharSequence): CombinedMessage = this.followedBy(another.toString().toMessage())
 }
 
+suspend fun <C : Contact> Message.sendTo(contact: C): MessageReceipt<C> {
+    return contact.sendMessage(this)
+}
+
+/**
+ * 消息元数据, 即不含内容的元素.
+ * 包括: [MessageSource]
+ */
+interface MessageMetadata : Message {
+    /*
+    fun iterator(): Iterator<Message> {
+        return object : Iterator<Message> {
+            var visited: Boolean = false
+            override fun hasNext(): Boolean = !visited
+            override fun next(): Message {
+                if (visited) throw NoSuchElementException()
+                return this@MessageMetadata.also { visited = true }
+            }
+        }
+    }*/
+}
+
 /**
- * 表示这个 [Message] 仅能单个存在, 无法被连接.
+ * 消息内容
  */
-interface SingleOnly : Message
+interface MessageContent : Message
 
 /**
  * 将 [this] 发送给指定联系人
  */
-suspend inline fun <C : Contact> Message.sendTo(contact: C): MessageReceipt<C> = contact.sendMessage(this)
+@Suppress("UNCHECKED_CAST")
\ No newline at end of file
+suspend inline fun <C : Contact> MessageChain.sendTo(contact: C): MessageReceipt<C> = contact.sendMessage(this) as MessageReceipt<C>
\ No newline at end of file

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/MessageChain.kt

@@ -16,27 +16,19 @@ import net.mamoe.mirai.message.data.NullMessageChain.toString
 import kotlin.js.JsName
 import kotlin.jvm.JvmMultifileClass
 import kotlin.jvm.JvmName
+import kotlin.jvm.JvmSynthetic
 import kotlin.reflect.KProperty
 
 /**
- * 消息链. 即 MutableList<Message>.
+ * 消息链.
  * 它的一般实现为 [MessageChainImpl], `null` 实现为 [NullMessageChain]
  *
- * 有关 [MessageChain] 的创建和连接:
- * - 当任意两个不是 [MessageChain] 的 [Message] 相连接后, 将会产生一个 [MessageChain].
- * - 若两个 [MessageChain] 连接, 后一个将会被合并到第一个内.
- * - 若一个 [MessageChain] 与一个其他 [Message] 连接, [Message] 将会被添加入 [MessageChain].
- * - 若一个 [Message] 与一个 [MessageChain] 连接, [Message] 将会被添加入 [MessageChain].
- *
  * 要获取更多信息, 请查看 [Message]
  *
- * @see buildMessageChain
+ * @see buildMessageChain 构造一个 [MessageChain]
  */
-interface MessageChain : Message, List<Message> {
-    // region Message override
+interface MessageChain : Message, Iterable<Message> {
     override operator fun contains(sub: String): Boolean
-    // endregion
-
     override fun toString(): String
 
     /**
@@ -51,29 +43,16 @@ interface MessageChain : Message, List<Message> {
  * 遍历每一个有内容的消息, 即 [At], [AtAll], [PlainText], [Image], [Face], [XMLMessage]
  */
 inline fun MessageChain.foreachContent(block: (Message) -> Unit) {
-    this.forEachIndexed { index: Int, message: Message ->
+    var last: Message? = null
+    this.forEach { message: Message ->
         if (message is At) {
-            if (index == 0 || this[index - 1] !is QuoteReply) {
+            if (last != null || last !is QuoteReply) {
                 block(message)
             }
-        } else if (message.hasContent()) {
+        } else if (message is MessageContent) {
             block(message)
         }
-    }
-}
-
-/**
- * 判断这个 [Message] 是否含有内容, 即是否为 [At], [AtAll], [PlainText], [Image], [Face], [XMLMessage]
- */
-fun Message.hasContent(): Boolean {
-    return when (this) {
-        is At,
-        is AtAll,
-        is PlainText,
-        is Image,
-        is Face,
-        is XMLMessage -> true
-        else -> false
+        last = message
     }
 }
 
@@ -109,7 +88,7 @@ fun MessageChain(vararg messages: Message): MessageChain =
 @JsName("newChain")
 @Suppress("FunctionName")
 fun MessageChain(message: Message): MessageChain =
-    MessageChainImpl(listOf(message))
+    SingleMessageChainImpl(message)
 
 /**
  * 构造 [MessageChain]
@@ -136,13 +115,19 @@ fun MessageChain(messages: List<Message>): MessageChain =
  * 否则将调用 [MessageChain] 构造一个 [MessageChainImpl]
  */
 @Suppress("NOTHING_TO_INLINE")
-inline fun Message.toChain(): MessageChain = if (this is MessageChain) this else MessageChain(this)
+@JvmSynthetic
+fun Message.toChain(): MessageChain = when (this) {
+    is MessageChain -> this
+    is CombinedMessage -> MessageChainImpl(this)
+    else -> SingleMessageChainImpl(this)
+}
 
 /**
  * 构造 [MessageChain]
  */
+@JvmSynthetic
 @Suppress("unused", "NOTHING_TO_INLINE")
-inline fun List<Message>.asMessageChain(): MessageChain = MessageChain(this)
+fun Iterable<Message>.asMessageChain(): MessageChain = MessageChainImpl(this)
 
 /**
  * 获取第一个 [M] 类型的 [Message] 实例
@@ -200,45 +185,25 @@ object EmptyMessageChain : MessageChain by {
  * 除 [toString] 外, 其他方法均 [error]
  */
 object NullMessageChain : MessageChain {
-    override fun subList(fromIndex: Int, toIndex: Int): MutableList<Message> = error("accessing NullMessageChain")
-
     override fun toString(): String = "null"
-
     override fun contains(sub: String): Boolean = error("accessing NullMessageChain")
-    override fun contains(element: Message): Boolean = error("accessing NullMessageChain")
     override fun followedBy(tail: Message): CombinedMessage = CombinedMessage(left = EmptyMessageChain, element = tail)
-
-    override val size: Int get() = error("accessing NullMessageChain")
-    override fun containsAll(elements: Collection<Message>): Boolean = error("accessing NullMessageChain")
-    override fun get(index: Int): Message = error("accessing NullMessageChain")
-    override fun indexOf(element: Message): Int = error("accessing NullMessageChain")
-    override fun isEmpty(): Boolean = error("accessing NullMessageChain")
     override fun iterator(): MutableIterator<Message> = error("accessing NullMessageChain")
-
-    override fun lastIndexOf(element: Message): Int = error("accessing NullMessageChain")
-    override fun listIterator(): MutableListIterator<Message> = error("accessing NullMessageChain")
-
-    override fun listIterator(index: Int): MutableListIterator<Message> = error("accessing NullMessageChain")
 }
 
-/**
- * [MessageChain] 实现
- * 它是一个特殊的 [Message], 实现 [MutableList] 接口, 但将所有的接口调用都转到内部维护的另一个 [MutableList].
- */
+@PublishedApi
 internal class MessageChainImpl constructor(
-    /**
-     * Elements will not be instances of [MessageChain]
-     */
-    private val delegate: List<Message>
-) : Message, List<Message> by delegate, MessageChain {
+    private val delegate: Iterable<Message>
+) : Message, Iterable<Message> by delegate, MessageChain {
     override fun toString(): String = this.delegate.joinToString("") { it.toString() }
-
     override operator fun contains(sub: String): Boolean = delegate.any { it.contains(sub) }
-    override fun followedBy(tail: Message): CombinedMessage {
-        require(tail !is SingleOnly) { "SingleOnly Message cannot follow another message" }
-        // if (tail is MessageChain) tail.forEach { child -> this.followedBy(child) }
-        // else this.delegate.add(tail)
-        return CombinedMessage(tail, this)
-    }
 }
 
+@PublishedApi
+internal class SingleMessageChainImpl constructor(
+    private val delegate: Message
+) : Message, Iterable<Message> by listOf(delegate), MessageChain {
+    override fun toString(): String = this.delegate.toString()
+
+    override operator fun contains(sub: String): Boolean = sub in delegate
+}
\ No newline at end of file

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/MessageSource.kt

@@ -23,7 +23,7 @@ import kotlin.jvm.JvmName
  *
  * @see MessageSource.quote 引用这条消息, 创建 [MessageChain]
  */
-interface MessageSource : Message {
+interface MessageSource : Message, MessageMetadata {
     companion object Key : Message.Key<MessageSource>
 
     /**

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/PlainText.kt

@@ -21,7 +21,7 @@ import kotlin.jvm.JvmStatic
  *
  * 一般不需要主动构造 [PlainText], [Message] 可直接与 [String] 相加. Java 用户请使用 [MessageChain.plus]
  */
-inline class PlainText(val stringValue: String) : Message {
+inline class PlainText(val stringValue: String) : Message, MessageContent {
     constructor(charSequence: CharSequence) : this(charSequence.toString())
 
     override operator fun contains(sub: String): Boolean = sub in stringValue

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/QuoteReply.kt

@@ -21,25 +21,27 @@ import kotlin.jvm.JvmName
 
 
 /**
- * 群内的或好友的引用回复.
+ * 从服务器接收的或客户端构造用来发送的群内的或好友的引用回复.
  *
  * 可以引用一条群消息并发送给一个好友, 或是引用好友消息发送给群.
  * 可以引用自己发出的消息. 详见 [MessageReceipt.quote]
  *
  * 总是使用 [quote] 来构造这个实例.
  */
-open class QuoteReply @MiraiInternalAPI constructor(val source: MessageSource) : Message {
+open class QuoteReply
+@MiraiInternalAPI constructor(val source: MessageSource) : Message, MessageContent {
     companion object Key : Message.Key<QuoteReply>
 
     override fun toString(): String = ""
 }
 
 /**
- * 群内的引用回复.
+ * 用于发送的引用回复.
  * 总是使用 [quote] 来构造实例.
  */
 @UseExperimental(MiraiInternalAPI::class)
-class QuoteReplyToSend @MiraiInternalAPI constructor(source: MessageSource, val sender: QQ) : QuoteReply(source) {
+class QuoteReplyToSend
+@MiraiInternalAPI constructor(source: MessageSource, val sender: QQ) : QuoteReply(source) {
     fun createAt(): At = At(sender as Member)
 }
 

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/XML.kt

@@ -23,8 +23,8 @@ import kotlin.jvm.JvmName
  *
  * @see buildXMLMessage
  */
-inline class XMLMessage(val stringValue: String) : Message,
-    SingleOnly {
+@MiraiExperimentalAPI
+inline class XMLMessage(val stringValue: String) : Message, MessageContent {
     override fun followedBy(tail: Message): Nothing = error("XMLMessage Message cannot be followed")
     override fun toString(): String = stringValue
 }

mirai-core/src/commonMain/kotlin/net.mamoe.mirai/message/data/builder.kt

@@ -22,8 +22,10 @@ inline fun buildMessageChain(block: MessageChainBuilder.() -> Unit): MessageChai
 }
 
 class MessageChainBuilder @JvmOverloads constructor(
-    private val container: MutableList<Message> = mutableListOf()
-) : MutableList<Message> by container, Appendable {
+    private val container: MutableCollection<Message> = mutableListOf()
+) : MutableCollection<Message> by container, Appendable {
+    constructor(initialSize: Int) : this(ArrayList<Message>(initialSize))
+
     operator fun Message.unaryPlus() {
         add(this)
     }