All Downloads are FREE. Search and download functionalities are using the official Maven repository.
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.
command.descriptor.CommandArgumentContext.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("NOTHING_TO_INLINE", "INVISIBLE_MEMBER", "INVISIBLE_REFERENCE", "unused", "MemberVisibilityCanBePrivate")
package net.mamoe.mirai.console.command.descriptor
import net.mamoe.mirai.Bot
import net.mamoe.mirai.console.command.CommandSender
import net.mamoe.mirai.console.command.CompositeCommand
import net.mamoe.mirai.console.command.SimpleCommand
import net.mamoe.mirai.console.command.descriptor.CommandArgumentContext.ParserPair
import net.mamoe.mirai.console.permission.PermissionId
import net.mamoe.mirai.console.permission.PermitteeId
import net.mamoe.mirai.console.util.ConsoleExperimentalApi
import net.mamoe.mirai.contact.*
import net.mamoe.mirai.message.data.Image
import net.mamoe.mirai.message.data.MessageContent
import net.mamoe.mirai.message.data.PlainText
import java.util.*
import kotlin.collections.ArrayList
import kotlin.collections.HashSet
import kotlin.contracts.InvocationKind.EXACTLY_ONCE
import kotlin.contracts.contract
import kotlin.internal.LowPriorityInOverloadResolution
import kotlin.reflect.KClass
import kotlin.reflect.full.isSubclassOf
/**
* 指令参数环境, 即 [CommandValueArgumentParser] 的集合, 用于 [CompositeCommand] 和 [SimpleCommand].
*
* 在指令解析时, 总是从 [CommandArgumentContextAware.context] 搜索相关解析器
*
* 要构造 [CommandArgumentContext], 参考 [buildCommandArgumentContext]
*
* @see SimpleCommandArgumentContext 简单实现
* @see EmptyCommandArgumentContext 空实现, 类似 [emptyList]
*
* @see CommandArgumentContext.Builtins 内建 [CommandValueArgumentParser]
*
* @see buildCommandArgumentContext DSL 构造
*/
public interface CommandArgumentContext {
/**
* [KClass] 到 [CommandValueArgumentParser] 的匹配
*/
public data class ParserPair(
val klass: KClass,
val parser: CommandValueArgumentParser,
) {
public companion object {
@JvmStatic
public fun ParserPair.toPair(): Pair, CommandValueArgumentParser> = klass to parser
}
}
/**
* 获取一个 [kClass] 类型的解析器.
*/
public operator fun get(kClass: KClass): CommandValueArgumentParser?
public fun toList(): List>
public companion object {
/**
* For Java callers.
*
* @see EmptyCommandArgumentContext
*/
@JvmField // public static final CommandArgumentContext EMPTY;
public val EMPTY: CommandArgumentContext = EmptyCommandArgumentContext
}
private object EnumCommandArgumentContext : CommandArgumentContext {
private val cache = WeakHashMap, CommandValueArgumentParser<*>>()
private val enumKlass = Enum::class
override fun get(kClass: KClass): CommandValueArgumentParser? {
return if (kClass.isSubclassOf(enumKlass)) {
val jclass = kClass.java.asSubclass(Enum::class.java)
@Suppress("UNCHECKED_CAST")
(cache[jclass] ?: kotlin.run {
EnumValueArgumentParser(jclass).also { cache[jclass] = it }
}) as CommandValueArgumentParser
} else null
}
override fun toList(): List> = emptyList()
}
/**
* 内建的默认 [CommandValueArgumentParser]
*/
public object Builtins : CommandArgumentContext by listOf(
EnumCommandArgumentContext,
buildCommandArgumentContext {
Int::class with IntValueArgumentParser
Byte::class with ByteValueArgumentParser
Short::class with ShortValueArgumentParser
Boolean::class with BooleanValueArgumentParser
String::class with StringValueArgumentParser
Long::class with LongValueArgumentParser
Double::class with DoubleValueArgumentParser
Float::class with FloatValueArgumentParser
Image::class with ImageValueArgumentParser
PlainText::class with PlainTextValueArgumentParser
Contact::class with ExistingContactValueArgumentParser
User::class with ExistingUserValueArgumentParser
Member::class with ExistingMemberValueArgumentParser
Group::class with ExistingGroupValueArgumentParser
Friend::class with ExistingFriendValueArgumentParser
Bot::class with ExistingBotValueArgumentParser
PermissionId::class with PermissionIdValueArgumentParser
PermitteeId::class with PermitteeIdValueArgumentParser
MessageContent::class with RawContentValueArgumentParser
},
).fold(EmptyCommandArgumentContext, CommandArgumentContext::plus)
}
/**
* 拥有 [buildCommandArgumentContext] 的类
*
* @see SimpleCommand
* @see CompositeCommand
*/
public interface CommandArgumentContextAware {
/**
* [CommandValueArgumentParser] 的集合
*/
public val context: CommandArgumentContext
}
/**
* @see CommandArgumentContext.EMPTY
*/
public object EmptyCommandArgumentContext : CommandArgumentContext by SimpleCommandArgumentContext(listOf())
/**
* 合并两个 [buildCommandArgumentContext], [replacer] 将会替换 [this] 中重复的 parser.
*/
public operator fun CommandArgumentContext.plus(replacer: CommandArgumentContext): CommandArgumentContext {
if (replacer === EmptyCommandArgumentContext) return this
if (this == EmptyCommandArgumentContext) return replacer
return object : CommandArgumentContext {
override fun get(kClass: KClass): CommandValueArgumentParser? =
replacer[kClass] ?: this@plus[kClass]
override fun toList(): List> = replacer.toList() + [email protected] ()
}
}
/**
* 合并 [this] 与 [replacer], [replacer] 将会替换 [this] 中重复的 parser.
*/
public operator fun CommandArgumentContext.plus(replacer: List>): CommandArgumentContext {
if (replacer.isEmpty()) return this
if (this === EmptyCommandArgumentContext) return SimpleCommandArgumentContext(replacer)
return object : CommandArgumentContext {
@Suppress("UNCHECKED_CAST")
override fun get(kClass: KClass): CommandValueArgumentParser? =
replacer.firstOrNull { kClass.isSubclassOf(it.klass) }?.parser as CommandValueArgumentParser?
?: this@plus[kClass]
override fun toList(): List> = replacer.toList() + [email protected] ()
}
}
/**
* 自定义 [buildCommandArgumentContext]
*
* @see buildCommandArgumentContext
*/
@Suppress("UNCHECKED_CAST")
public class SimpleCommandArgumentContext(
public val list: List>,
) : CommandArgumentContext {
override fun get(kClass: KClass): CommandValueArgumentParser? =
(this.list.firstOrNull { kClass == it.klass }?.parser
?: this.list.firstOrNull { kClass.isSubclassOf(it.klass) }?.parser) as CommandValueArgumentParser?
override fun toList(): List> = list
}
/**
* 构建一个 [buildCommandArgumentContext].
*
* Kotlin 实现:
* ```
* val context = buildCommandArgumentContext {
* Int::class with IntArgParser
* Member::class with ExistingMemberArgParser
* Group::class with { s: String, sender: CommandSender ->
* Bot.getInstance(s.toLong()).getGroup(s.toLong())
* }
* Bot::class with { s: String ->
* Bot.getInstance(s.toLong())
* }
* }
* ```
*
* Java 实现:
* ```java
* CommandArgumentContext context =
* new CommandArgumentContextBuilder()
* .add(clazz1, parser1)
* .add(String.class, new CommandArgumentParser() {
* public String parse(String raw, CommandSender sender) {
* // ...
* }
* })
* // 更多 add
* .build()
* ```
*
* @see CommandArgumentContextBuilder
* @see buildCommandArgumentContext
*/
@JvmSynthetic
public fun buildCommandArgumentContext(block: CommandArgumentContextBuilder.() -> Unit): CommandArgumentContext {
contract {
callsInPlace(block, EXACTLY_ONCE)
}
return CommandArgumentContextBuilder().apply(block).build()
}
/**
* 参考 [buildCommandArgumentContext]
*/
public class CommandArgumentContextBuilder : MutableList> by mutableListOf() {
/**
* 添加一个指令解析器.
*/
@JvmName("add")
public infix fun Class.with(parser: CommandValueArgumentParser): CommandArgumentContextBuilder =
this.kotlin with parser
/**
* 添加一个指令解析器
*/
@JvmName("add")
public inline infix fun KClass.with(parser: CommandValueArgumentParser): CommandArgumentContextBuilder {
add(ParserPair(this, parser))
return this@CommandArgumentContextBuilder
}
/**
* 添加一个指令解析器
*/
@JvmSynthetic
@LowPriorityInOverloadResolution
public inline infix fun KClass.with(
crossinline parser: CommandValueArgumentParser.(s: String, sender: CommandSender) -> T,
): CommandArgumentContextBuilder {
add(ParserPair(this, object : CommandValueArgumentParser {
override fun parse(raw: String, sender: CommandSender): T = parser(raw, sender)
}))
return this@CommandArgumentContextBuilder
}
/**
* 添加一个指令解析器
*/
@JvmSynthetic
public inline infix fun KClass.with(
crossinline parser: CommandValueArgumentParser.(s: String) -> T,
): CommandArgumentContextBuilder {
add(ParserPair(this, object : CommandValueArgumentParser {
override fun parse(raw: String, sender: CommandSender): T = parser(raw)
}))
return this@CommandArgumentContextBuilder
}
@JvmSynthetic
public inline fun add(parser: CommandValueArgumentParser): CommandArgumentContextBuilder {
add(ParserPair(T::class, parser))
return this@CommandArgumentContextBuilder
}
/**
* 添加一个指令解析器
*/
@ConsoleExperimentalApi
@JvmSynthetic
public inline infix fun add(
crossinline parser: CommandValueArgumentParser<*>.(s: String) -> T,
): CommandArgumentContextBuilder = T::class with object : CommandValueArgumentParser {
override fun parse(raw: String, sender: CommandSender): T = parser(raw)
}
/**
* 添加一个指令解析器
*/
@ConsoleExperimentalApi
@JvmSynthetic
@LowPriorityInOverloadResolution
public inline infix fun add(
crossinline parser: CommandValueArgumentParser<*>.(s: String, sender: CommandSender) -> T,
): CommandArgumentContextBuilder = T::class with object : CommandValueArgumentParser {
override fun parse(raw: String, sender: CommandSender): T = parser(raw, sender)
}
/**
* 完成构建, 得到 [CommandArgumentContext]
*/
public fun build(): CommandArgumentContext = SimpleCommandArgumentContext(this.distinctByReversed { it.klass })
}
internal inline fun List.distinctByReversed(selector: (T) -> K): List {
val set = HashSet()
val list = ArrayList()
for (i in this.indices.reversed()) {
val element = this[i]
if (set.add(element.let(selector))) {
list.add(element)
}
}
return list
}
