├── settings.gradle.kts ├── .gitignore ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── src └── main │ └── kotlin │ └── com │ └── github │ └── noonmaru │ └── kommand │ ├── KommandSyntaxException.kt │ ├── CommandSender.kt │ ├── argument │ ├── MapArgument.kt │ ├── BooleanArgument.kt │ ├── PlayerArgument.kt │ ├── StringArgument.kt │ ├── IntegerArgument.kt │ ├── DoubleArgument.kt │ ├── TargetArgument.kt │ └── KommandArgument.kt │ ├── LiteralKommand.kt │ ├── ArgumentKommand.kt │ ├── KommandContext.kt │ ├── Kommand.kt │ └── KommandDispatcher.kt ├── README.md ├── gradlew.bat ├── gradlew └── LICENSE.md /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "kommand" 2 | 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Intellij 2 | .idea/ 3 | out/ 4 | 5 | # Gradle 6 | .gradle 7 | build/ 8 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | kotlin.code.style=official 2 | group=com.github.noonmaru 3 | version=0.6.4 -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/noonmaru/kommand/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/KommandSyntaxException.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand 18 | 19 | class KommandSyntaxException(val syntaxMessage: String) : Exception(syntaxMessage) -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | # 2 | # Copyright (c) 2020 Noonmaru 3 | # 4 | # Licensed under the General Public License, Version 3.0 (the "License"); 5 | # you may not use this file except in compliance with the License. 6 | # You may obtain a copy of the License at 7 | # 8 | # https://opensource.org/licenses/gpl-3.0 9 | # 10 | # Unless required by applicable law or agreed to in writing, software 11 | # distributed under the License is distributed on an "AS IS" BASIS, 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | # 16 | distributionBase=GRADLE_USER_HOME 17 | distributionPath=wrapper/dists 18 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.6-bin.zip 19 | zipStoreBase=GRADLE_USER_HOME 20 | zipStorePath=wrapper/dists 21 | -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/CommandSender.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand 18 | 19 | import org.bukkit.GameRule 20 | import org.bukkit.command.CommandSender 21 | import org.bukkit.entity.Player 22 | 23 | fun CommandSender.sendFeedback(message: String) { 24 | if (this is Player) { 25 | world.getGameRuleValue(GameRule.SEND_COMMAND_FEEDBACK)?.let { r -> 26 | if (!r) 27 | return 28 | } 29 | } 30 | 31 | sendMessage(message) 32 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/argument/MapArgument.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand.argument 18 | 19 | import com.github.noonmaru.kommand.KommandContext 20 | 21 | class MapArgument internal constructor( 22 | private val map: Map 23 | ) : KommandArgument { 24 | override fun parse(context: KommandContext, param: String): T? { 25 | return map[param] 26 | } 27 | 28 | override fun listSuggestion(context: KommandContext, target: String): Collection { 29 | return map.keys.suggestions(target) 30 | } 31 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/argument/BooleanArgument.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand.argument 18 | 19 | import com.github.noonmaru.kommand.KommandContext 20 | 21 | object BooleanArgument : KommandArgument { 22 | override val parseFailMessage: String 23 | get() = "${KommandArgument.TOKEN} <-- true 혹은 false를 입력하세요." 24 | 25 | override fun parse(context: KommandContext, param: String): Boolean { 26 | return param.toBoolean() 27 | } 28 | 29 | override fun listSuggestion(context: KommandContext, target: String): Collection { 30 | return listOf("true", "false") 31 | } 32 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/argument/PlayerArgument.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand.argument 18 | 19 | import com.github.noonmaru.kommand.KommandContext 20 | import org.bukkit.Bukkit 21 | import org.bukkit.entity.Player 22 | 23 | object PlayerArgument : KommandArgument { 24 | override val parseFailMessage: String 25 | get() = "${KommandArgument.TOKEN} 플레이어를 찾지 못했습니다." 26 | 27 | override fun parse(context: KommandContext, param: String): Player? { 28 | return Bukkit.getPlayerExact(param) 29 | } 30 | 31 | override fun listSuggestion(context: KommandContext, target: String): Collection { 32 | return Bukkit.getOnlinePlayers().suggestions(target) { it.name } 33 | } 34 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/argument/StringArgument.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand.argument 18 | 19 | import com.github.noonmaru.kommand.KommandContext 20 | import com.google.common.collect.ImmutableList 21 | 22 | class StringArgument internal constructor( 23 | private val values: () -> Collection 24 | ) : KommandArgument { 25 | override fun parse(context: KommandContext, param: String): String? { 26 | val values = values() 27 | 28 | return param.takeIf { values.isEmpty() || param in values } 29 | } 30 | 31 | override fun listSuggestion(context: KommandContext, target: String): Collection { 32 | return values().suggestions(target) 33 | } 34 | 35 | companion object { 36 | internal val emptyStringArgument = StringArgument { ImmutableList.of() } 37 | } 38 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/LiteralKommand.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand 18 | 19 | import org.bukkit.command.CommandSender 20 | 21 | class LiteralKommand( 22 | name: String, 23 | permission: (() -> String)?, 24 | requirement: (CommandSender.() -> Boolean)?, 25 | executor: ((KommandContext) -> Unit)?, 26 | children: Collection 27 | ) : Kommand(name, permission, requirement, executor, children) 28 | 29 | class LiteralKommandBuilder(name: String) : KommandBuilder(name) { 30 | override fun build(): LiteralKommand { 31 | return LiteralKommand(name, permission, requirement, executor, children.map { it.build() }.toSet()) 32 | } 33 | 34 | override fun hashCode() = name.hashCode() 35 | 36 | override fun equals(other: Any?): Boolean { 37 | if (other === this) return true 38 | 39 | if (other is LiteralKommandBuilder) { 40 | if (name == other.name) return true 41 | } 42 | 43 | return false 44 | } 45 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/argument/IntegerArgument.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand.argument 18 | 19 | import com.github.noonmaru.kommand.KommandContext 20 | 21 | class IntegerArgument internal constructor() : KommandArgument { 22 | override val parseFailMessage: String 23 | get() = "${KommandArgument.TOKEN} <-- $minimum ~ $maximum 사이의 정수(${radix}진수)가 아닙니다." 24 | var maximum = Int.MAX_VALUE 25 | set(value) { 26 | require(value >= minimum) { "maximum $value was not more than minimum $minimum." } 27 | field = value 28 | } 29 | 30 | var minimum = Int.MIN_VALUE 31 | set(value) { 32 | require(value <= maximum) { "minimum $value was not less than maximum $maximum." } 33 | field = value 34 | } 35 | var radix = 10 36 | set(value) { 37 | require(value in 2..36) { "radix $value was not in valid range 2..36" } 38 | field = value 39 | } 40 | 41 | override fun parse(context: KommandContext, param: String): Int? { 42 | return param.toIntOrNull(radix)?.coerceIn(minimum, maximum) 43 | } 44 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/argument/DoubleArgument.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand.argument 18 | 19 | import com.github.noonmaru.kommand.KommandContext 20 | 21 | class DoubleArgument internal constructor() : KommandArgument { 22 | override val parseFailMessage: String 23 | get() = "${KommandArgument.TOKEN} <-- $minimum ~ $maximum 사이의 실수가 아닙니다." 24 | 25 | var maximum = Double.MAX_VALUE 26 | set(value) { 27 | require(value >= minimum) { "maximum $value was not more than minimum $minimum." } 28 | field = value 29 | } 30 | var minimum = -Double.MIN_VALUE 31 | set(value) { 32 | require(value <= maximum) { "minimum $value was not less than maximum $maximum." } 33 | field = value 34 | } 35 | var allowInfinite = false 36 | var allowNaN = false 37 | 38 | override fun parse(context: KommandContext, param: String): Double? { 39 | return param.toDoubleOrNull()?.coerceIn(minimum, maximum)?.takeIf { 40 | when { 41 | it.isInfinite() -> allowInfinite 42 | it.isNaN() -> allowNaN 43 | else -> true 44 | } 45 | } 46 | } 47 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/ArgumentKommand.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand 18 | 19 | import com.github.noonmaru.kommand.argument.KommandArgument 20 | import org.bukkit.command.CommandSender 21 | 22 | class ArgumentKommand( 23 | name: String, 24 | permission: (() -> String)?, 25 | requirement: (CommandSender.() -> Boolean)?, 26 | executor: ((KommandContext) -> Unit)?, 27 | children: Collection, 28 | internal val argument: KommandArgument<*> 29 | ) : Kommand(name, permission, requirement, executor, children) 30 | 31 | internal class ArgumentKommandBuilder( 32 | name: String, 33 | val argument: KommandArgument<*> 34 | ) : KommandBuilder(name) { 35 | 36 | override fun build(): Kommand { 37 | return ArgumentKommand(name, permission, requirement, executor, children.map { it.build() }, argument) 38 | } 39 | 40 | override fun hashCode() = name.hashCode().inv() 41 | 42 | override fun equals(other: Any?): Boolean { 43 | if (other == this) return true 44 | 45 | if (other is ArgumentKommandBuilder) { 46 | if (name == other.name && argument == other.argument) 47 | return true 48 | } 49 | 50 | return false 51 | } 52 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/argument/TargetArgument.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand.argument 18 | 19 | import com.github.noonmaru.kommand.KommandContext 20 | import com.google.common.collect.ImmutableList 21 | import org.bukkit.Bukkit 22 | import org.bukkit.entity.Entity 23 | import org.bukkit.entity.Player 24 | import java.util.function.Predicate 25 | 26 | class TargetArgument( 27 | filter: Predicate? = null 28 | ) : KommandArgument> { 29 | companion object { 30 | private val targetSelectors = ImmutableList.copyOf( 31 | "aeprs".map { "@$it" } 32 | ) 33 | 34 | val instance = TargetArgument() 35 | 36 | val player = TargetArgument { it is Player } 37 | } 38 | 39 | private val filter = filter?.negate() 40 | 41 | override fun parse(context: KommandContext, param: String): List? { 42 | Bukkit.getServer().runCatching { 43 | selectEntities(context.sender, param) 44 | }.onSuccess { list -> 45 | filter?.let { list.removeIf(it) } 46 | return list 47 | } 48 | 49 | return null 50 | } 51 | 52 | override fun listSuggestion(context: KommandContext, target: String): Collection { 53 | return (targetSelectors + Bukkit.getOnlinePlayers().map { it.name }).suggestions(target) 54 | } 55 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/KommandContext.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand 18 | 19 | import com.github.noonmaru.kommand.argument.KommandArgument 20 | import org.bukkit.command.Command 21 | import org.bukkit.command.CommandSender 22 | 23 | class KommandContext( 24 | val command: Command, 25 | val rawArguments: Array, 26 | val nodes: List 27 | ) { 28 | internal lateinit var executor: (KommandContext) -> Unit 29 | 30 | lateinit var sender: CommandSender 31 | internal set 32 | lateinit var alias: String 33 | internal set 34 | 35 | private val argumentsByName: Map>> 36 | 37 | init { 38 | val arguments = HashMap>>() 39 | 40 | nodes.forEachIndexed { index, kommand -> 41 | if (kommand is ArgumentKommand) { 42 | arguments[kommand.name] = rawArguments[index - 1] to kommand.argument 43 | } 44 | } 45 | 46 | this.argumentsByName = arguments 47 | } 48 | 49 | private fun argumentBy(name: String): Pair> { 50 | return argumentsByName[name] ?: throw IllegalArgumentException("[$name] is unknown argument name") 51 | } 52 | 53 | fun getArgument(name: String) = argumentBy(name).first 54 | 55 | @Suppress("UNCHECKED_CAST") 56 | fun parseOrNullArgument(name: String): T? { 57 | val pair = argumentBy(name) 58 | val param = pair.first 59 | val argument = pair.second 60 | 61 | return argument.parse(this, param) as T 62 | } 63 | 64 | @Suppress("UNCHECKED_CAST") 65 | fun parseArgument(name: String): T { 66 | val pair = argumentBy(name) 67 | val param = pair.first 68 | val argument = pair.second 69 | 70 | return argument.parse(this, param) as T 71 | ?: throw KommandSyntaxException(argument.parseFailMessage.replace(KommandArgument.TOKEN, param)) 72 | } 73 | } -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/Kommand.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand 18 | 19 | import com.github.noonmaru.kommand.argument.KommandArgument 20 | import com.google.common.collect.ImmutableList 21 | import org.bukkit.command.CommandSender 22 | import org.bukkit.plugin.java.JavaPlugin 23 | 24 | 25 | abstract class Kommand( 26 | val name: String, 27 | val permission: (() -> String)?, 28 | val requirement: (CommandSender.() -> Boolean)?, 29 | val executor: ((KommandContext) -> Unit)?, 30 | children: Collection 31 | ) { 32 | internal val children: List = ImmutableList.copyOf(children) 33 | 34 | fun getChild(arg: String): Kommand? { 35 | for (child in children) { 36 | if (child is ArgumentKommand 37 | || (child is LiteralKommand && child.name == arg) 38 | ) { 39 | return child 40 | } 41 | } 42 | 43 | return null 44 | } 45 | } 46 | 47 | abstract class KommandBuilder(val name: String) { 48 | internal var permission: (() -> String)? = null 49 | internal var requirement: (CommandSender.() -> Boolean)? = null 50 | internal var executor: ((KommandContext) -> Unit)? = null 51 | internal val children = LinkedHashSet() 52 | 53 | fun permission(permission: (() -> String)?) { 54 | this.permission = permission 55 | } 56 | 57 | fun require(requirement: CommandSender.() -> Boolean) { 58 | this.requirement = requirement 59 | } 60 | 61 | fun executes(executor: (context: KommandContext) -> Unit) { 62 | this.executor = executor 63 | } 64 | 65 | fun then(name: String, init: KommandBuilder.() -> Unit) { 66 | children += LiteralKommandBuilder(name).apply(init) 67 | } 68 | 69 | fun then( 70 | argument: Pair>, 71 | vararg subArguments: Pair>, 72 | init: KommandBuilder.() -> Unit 73 | ) { 74 | var child = ArgumentKommandBuilder(argument.first, argument.second) 75 | this.children += child 76 | 77 | for ((name, arg) in subArguments) { 78 | val grandChild = ArgumentKommandBuilder(name, arg) 79 | child.children += grandChild 80 | child = grandChild 81 | } 82 | 83 | child.apply(init) 84 | } 85 | 86 | internal abstract fun build(): Kommand 87 | } 88 | 89 | fun JavaPlugin.kommand(init: KommandDispatcherBuilder.() -> Unit): KommandDispatcher { 90 | return KommandDispatcherBuilder(this).apply(init).build() 91 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Kommand 2 | 3 | [![](https://jitpack.io/v/noonmaru/kommand.svg)](https://jitpack.io/#noonmaru/kommand) 4 | 5 | 6 | ### Kotlin으로 작성된 spigot command library 7 | --- 8 | * #### Features 9 | * 명령어 분기 지원 10 | * 인수 분석(Parsing) 11 | * 명령어 제안 지원 (TabComplete) 12 | --- 13 | 14 | Spigot에는 명령어 실행을 위한 프레임워크가 없습니다. 15 | 다른 프레임워크를 사용하지 않고 독립형으로 명령어 실행 코드를 작성시 다음과 같은 패턴으로 작성하게 됩니다. 16 | ```kotlin 17 | class CommandDispatcher: CommandExecutor { 18 | ... 19 | override fun onCommand(...) { 20 | val commandName = args[0] 21 | 22 | if ("first".equals(commandName, true)) { 23 | // first 명령 처리 24 | } else if ("second".equals(commandName, true)) { 25 | // second 명령 처리 26 | } else { 27 | // Error 28 | } 29 | //when 문으로도 구현 가능 30 | } 31 | } 32 | ... 33 | ``` 34 | 35 | 위와 같은 코드는 명령문이 적을땐 간결하지만, 36 | 따라붙는 인수나 상수가 늘어나면 코드가 매우 지저분해지고 디버깅에도 어려움을 겪게됩니다. 37 | 그래서 명령 처리는 신경쓰지 않고 최종 실행코드만 작성 할 수 있는 프레임워크가 필요해졌습니다. 38 | 39 | *Kommand*는 위와 같은 문제를 해결하고 명령문을 보다 직관적인 코드작성을 위한 DSL을 제공합니다. 40 | 41 | --- 42 | 아래와 같은 명령 체계가 있다고 생각해봅시다. 43 | * user 44 | * create \ 45 | * modify \ 46 | * name \ 47 | * tag \ 48 | 49 | 다음 코드는 Kommand의 DSL을 사용한 코드입니다. 50 | ```kotlin 51 | //in JavaPlugin 52 | kommand { 53 | register("user") { 54 | then("create") { 55 | then("name" to string()) { //"name"이라는 이름의 String을 요청합니다. 56 | executes { //it = KommandContext 57 | val name = it.getArgument("name") 58 | createUser(name) //명령어 실행 함수를 통해 실행 59 | } 60 | } 61 | } 62 | then("modify") { 63 | then("user" to user()) { //Custom 유저 인수 64 | then("name") { 65 | then("newName" to string()) { 66 | executes { //블록 내에서 실행 67 | val user = it.parseArgument("user") //User 인스턴스를 user()를 통해 생성했던 Custom유저 인수를 통해 가져옵니다. 68 | val newName = it.getArgument("newName") 69 | setUserName(user, newName) 70 | } 71 | } 72 | } 73 | then("tag") { 74 | then("newTag" to string()) { 75 | executes { 76 | setUserTag(it.parseArgument("user"), it.getArgument("newTag")) 77 | } 78 | } 79 | } 80 | } 81 | } 82 | } 83 | } 84 | ``` 85 | 분기문을 직접 작성하지 않고도 명령어를 실행 할 수 있는 코드가 완성되었습니다. 86 | 87 | 사용자가 명령문을 알맞게 작성하면 *executes*블록 내의 코드가 실행됩니다. 88 | **KommandContext.parseArgument(String)** 함수는 등록한 인수에 따라 결과값을 반환하며, 89 | **Null**값을 반환하게 되는 경우 예외를 던져서 탈출합니다. 90 | 91 | --- 92 | ### Gradle 93 | ```groovy 94 | allprojects { 95 | repositories { 96 | ... 97 | maven { url 'https://jitpack.io' } 98 | } 99 | } 100 | ``` 101 | 102 | ```groovy 103 | dependencies { 104 | implementation 'com.github.noonmaru:kommand:' 105 | } 106 | ``` 107 | 108 | --- 109 | ### 추가정보 110 | * 라이센스는 GPL-3.0이며 변경 혹은 삭제를 금합니다. 111 | * 등록되어있는 명령어, 인수를 통해 자동으로 TabComplete를 지원합니다. 112 | * 인수의 TabComplete를 지원하기 위해선 PlayerArgument.kt 코드를 참고하세요 113 | * Mojang 에서공개한 [**Brigadier**](https://github.com/Mojang/brigadier) 코드를 참고하여 작성했습니다. 114 | * **Kommand**는 플러그인이 아니므로 FatJar를 만들어서 사용하세요 (참고: [ShadowJar](https://github.com/johnrengelman/shadow)) 115 | -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/argument/KommandArgument.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand.argument 18 | 19 | import com.github.noonmaru.kommand.KommandContext 20 | import com.google.common.collect.ImmutableList 21 | import org.bukkit.entity.Entity 22 | import org.bukkit.entity.Player 23 | import java.util.function.Predicate 24 | 25 | interface KommandArgument { 26 | companion object { 27 | const val TOKEN = "" 28 | } 29 | 30 | val parseFailMessage: String 31 | get() = "$TOKEN <-- 알 수 없는 인수입니다." 32 | 33 | fun parse(context: KommandContext, param: String): T? 34 | 35 | fun listSuggestion(context: KommandContext, target: String): Collection = emptyList() 36 | } 37 | 38 | fun string(): StringArgument { 39 | return StringArgument.emptyStringArgument 40 | } 41 | 42 | fun string(vararg names: String): StringArgument { 43 | val list = ImmutableList.copyOf(names) 44 | return string { list } 45 | } 46 | 47 | fun string(names: Collection): StringArgument { 48 | return string { names } 49 | } 50 | 51 | fun string(supplier: () -> Collection): StringArgument { 52 | return StringArgument(supplier) 53 | } 54 | 55 | fun bool(): BooleanArgument { 56 | return BooleanArgument 57 | } 58 | 59 | fun integer(): IntegerArgument { 60 | return IntegerArgument() 61 | } 62 | 63 | fun double(): DoubleArgument { 64 | return DoubleArgument() 65 | } 66 | 67 | fun player(): PlayerArgument { 68 | return PlayerArgument 69 | } 70 | 71 | fun target(filter: Predicate? = null): TargetArgument { 72 | return if (filter == null) TargetArgument.instance else TargetArgument(filter) 73 | } 74 | 75 | fun playerTarget(filter: Predicate? = null): TargetArgument { 76 | return if (filter == null) TargetArgument.player else TargetArgument { it is Player && filter.test(it) } 77 | } 78 | 79 | fun map(map: Map): MapArgument { 80 | return MapArgument(map) 81 | } 82 | 83 | fun Collection.suggestions(target: String): Collection { 84 | if (isEmpty()) return emptyList() 85 | if (target.isEmpty()) return this 86 | 87 | return filter { it.startsWith(target, true) } 88 | } 89 | 90 | fun Collection.suggestions(target: String, transform: (T) -> String = { it.toString() }): Collection { 91 | if (isEmpty()) return emptyList() 92 | if (target.isEmpty()) return map(transform) 93 | 94 | val list = ArrayList() 95 | 96 | for (element in this) { 97 | transform(element).let { name -> 98 | if (name.startsWith(target, true)) 99 | list += name 100 | } 101 | } 102 | 103 | return list 104 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto init 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto init 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :init 68 | @rem Get command-line arguments, handling Windows variants 69 | 70 | if not "%OS%" == "Windows_NT" goto win9xME_args 71 | 72 | :win9xME_args 73 | @rem Slurp the command line arguments. 74 | set CMD_LINE_ARGS= 75 | set _SKIP=2 76 | 77 | :win9xME_args_slurp 78 | if "x%~1" == "x" goto execute 79 | 80 | set CMD_LINE_ARGS=%* 81 | 82 | :execute 83 | @rem Setup the command line 84 | 85 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 86 | 87 | 88 | @rem Execute Gradle 89 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 90 | 91 | :end 92 | @rem End local scope for the variables with windows NT shell 93 | if "%ERRORLEVEL%"=="0" goto mainEnd 94 | 95 | :fail 96 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 97 | rem the _cmd.exe /c_ return code! 98 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 99 | exit /b 1 100 | 101 | :mainEnd 102 | if "%OS%"=="Windows_NT" endlocal 103 | 104 | :omega 105 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright (c) 2020 Noonmaru 5 | # 6 | # Licensed under the General Public License, Version 3.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://opensource.org/licenses/gpl-3.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ]; do 30 | ls=$(ls -ld "$PRG") 31 | link=$(expr "$ls" : '.*-> \(.*\)$') 32 | if expr "$link" : '/.*' >/dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=$(dirname "$PRG")"/$link" 36 | fi 37 | done 38 | SAVED="$(pwd)" 39 | cd "$(dirname \"$PRG\")/" >/dev/null 40 | APP_HOME="$(pwd -P)" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=$(basename "$0") 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn() { 53 | echo "$*" 54 | } 55 | 56 | die() { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "$(uname)" in 69 | CYGWIN*) 70 | cygwin=true 71 | ;; 72 | Darwin*) 73 | darwin=true 74 | ;; 75 | MINGW*) 76 | msys=true 77 | ;; 78 | NONSTOP*) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | # Determine the Java command to use to start the JVM. 86 | if [ -n "$JAVA_HOME" ]; then 87 | if [ -x "$JAVA_HOME/jre/sh/java" ]; then 88 | # IBM's JDK on AIX uses strange locations for the executables 89 | JAVACMD="$JAVA_HOME/jre/sh/java" 90 | else 91 | JAVACMD="$JAVA_HOME/bin/java" 92 | fi 93 | if [ ! -x "$JAVACMD" ]; then 94 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 95 | 96 | Please set the JAVA_HOME variable in your environment to match the 97 | location of your Java installation." 98 | fi 99 | else 100 | JAVACMD="java" 101 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 102 | 103 | Please set the JAVA_HOME variable in your environment to match the 104 | location of your Java installation." 105 | fi 106 | 107 | # Increase the maximum file descriptors if we can. 108 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ]; then 109 | MAX_FD_LIMIT=$(ulimit -H -n) 110 | if [ $? -eq 0 ]; then 111 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ]; then 112 | MAX_FD="$MAX_FD_LIMIT" 113 | fi 114 | ulimit -n $MAX_FD 115 | if [ $? -ne 0 ]; then 116 | warn "Could not set maximum file descriptor limit: $MAX_FD" 117 | fi 118 | else 119 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 120 | fi 121 | fi 122 | 123 | # For Darwin, add options to specify how the application appears in the dock 124 | if $darwin; then 125 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 126 | fi 127 | 128 | # For Cygwin or MSYS, switch paths to Windows format before running java 129 | if [ "$cygwin" = "true" -o "$msys" = "true" ]; then 130 | APP_HOME=$(cygpath --path --mixed "$APP_HOME") 131 | CLASSPATH=$(cygpath --path --mixed "$CLASSPATH") 132 | 133 | JAVACMD=$(cygpath --unix "$JAVACMD") 134 | 135 | # We build the pattern for arguments to be converted via cygpath 136 | ROOTDIRSRAW=$(find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null) 137 | SEP="" 138 | for dir in $ROOTDIRSRAW; do 139 | ROOTDIRS="$ROOTDIRS$SEP$dir" 140 | SEP="|" 141 | done 142 | OURCYGPATTERN="(^($ROOTDIRS))" 143 | # Add a user-defined pattern to the cygpath arguments 144 | if [ "$GRADLE_CYGPATTERN" != "" ]; then 145 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 146 | fi 147 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 148 | i=0 149 | for arg in "$@"; do 150 | CHECK=$(echo "$arg" | egrep -c "$OURCYGPATTERN" -) 151 | CHECK2=$(echo "$arg" | egrep -c "^-") ### Determine if an option 152 | 153 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ]; then ### Added a condition 154 | eval $(echo args$i)=$(cygpath --path --ignore --mixed "$arg") 155 | else 156 | eval $(echo args$i)="\"$arg\"" 157 | fi 158 | i=$(expr $i + 1) 159 | done 160 | case $i in 161 | 0) set -- ;; 162 | 1) set -- "$args0" ;; 163 | 2) set -- "$args0" "$args1" ;; 164 | 3) set -- "$args0" "$args1" "$args2" ;; 165 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 166 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 167 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 168 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 169 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 170 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 171 | esac 172 | fi 173 | 174 | # Escape application args 175 | save() { 176 | for i; do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/"; done 177 | echo " " 178 | } 179 | APP_ARGS=$(save "$@") 180 | 181 | # Collect all arguments for the java command, following the shell quoting and substitution rules 182 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 183 | 184 | exec "$JAVACMD" "$@" 185 | -------------------------------------------------------------------------------- /src/main/kotlin/com/github/noonmaru/kommand/KommandDispatcher.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020 Noonmaru 3 | * 4 | * Licensed under the General Public License, Version 3.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://opensource.org/licenses/gpl-3.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.github.noonmaru.kommand 18 | 19 | import com.google.common.collect.ImmutableMap 20 | import org.bukkit.ChatColor 21 | import org.bukkit.command.Command 22 | import org.bukkit.command.CommandSender 23 | import org.bukkit.command.PluginCommand 24 | import org.bukkit.command.TabExecutor 25 | import org.bukkit.entity.Player 26 | import org.bukkit.plugin.java.JavaPlugin 27 | 28 | class KommandDispatcher(children: Map) { 29 | companion object { 30 | private const val unknownCommandErrorMessage = "알 수 없는 명령입니다." 31 | private const val permissionDenied = "권한이 없습니다." 32 | 33 | private fun Kommand.ensure(sender: CommandSender) { 34 | permission?.let { if (!sender.hasPermission(it())) throw KommandSyntaxException(permissionDenied) } 35 | requirement?.let { if (!sender.it()) throw KommandSyntaxException(unknownCommandErrorMessage) } 36 | } 37 | 38 | private fun Kommand.test(sender: CommandSender): Boolean { 39 | permission?.let { if (!sender.hasPermission(it())) return false } 40 | requirement?.let { if (!sender.it()) return false } 41 | return true 42 | } 43 | } 44 | 45 | private val children: Map 46 | 47 | init { 48 | val builds = HashMap() 49 | 50 | for ((command, builder) in children) { 51 | if (builder.executor == null) { 52 | builder.executes { 53 | val sender = it.sender 54 | sender.sendMessage(getUsage(sender, it.command).toTypedArray()) 55 | } 56 | } 57 | 58 | builds[command] = builder.build() 59 | } 60 | 61 | this.children = ImmutableMap.copyOf(builds) 62 | 63 | val adapter = KommandAdapter(this) 64 | 65 | for (command in children.keys) { 66 | command.setExecutor(adapter) 67 | command.tabCompleter = adapter 68 | } 69 | } 70 | 71 | 72 | private fun parse(sender: CommandSender, command: Command, args: Array): KommandContext { 73 | return children[command]?.let { root -> 74 | root.ensure(sender) 75 | 76 | val nodes = ArrayList() 77 | nodes.add(root) 78 | var last: Kommand = root 79 | 80 | for (i in 0 until args.count()) { 81 | if (last.children.isEmpty()) throw KommandSyntaxException("인수를 끝내는 공백이 필요하지만, 후행 데이터가 입력되었습니다") 82 | 83 | val arg = args[i] 84 | val child = last.getChild(arg) ?: throw KommandSyntaxException(unknownCommandErrorMessage) 85 | child.ensure(sender) 86 | 87 | nodes += child 88 | last = child 89 | } 90 | 91 | val executor = last.executor ?: throw KommandSyntaxException(unknownCommandErrorMessage) 92 | 93 | KommandContext(command, args, nodes).apply { 94 | this.executor = executor 95 | } 96 | } ?: throw KommandSyntaxException(unknownCommandErrorMessage) 97 | } 98 | 99 | internal fun dispatch( 100 | sender: CommandSender, 101 | command: Command, 102 | alias: String, 103 | args: Array 104 | ) { 105 | runCatching { 106 | val context = parse(sender, command, args).apply { 107 | this.sender = sender 108 | this.alias = alias 109 | } 110 | context.executor.invoke(context) 111 | }.onFailure { throwable -> 112 | if (throwable is KommandSyntaxException) { 113 | //Syntax 에러 114 | sender.sendFeedback("${ChatColor.RED}${throwable.syntaxMessage}") 115 | } else { 116 | //예외 메시지 출력 117 | throwable.printStackTrace() 118 | 119 | if (sender is Player) { 120 | sender.sendMessage("${ChatColor.YELLOW}${throwable.javaClass.name}: ${throwable.message}") 121 | for (stackTraceElement in throwable.stackTrace) { 122 | sender.sendMessage("${ChatColor.YELLOW} at $stackTraceElement") 123 | } 124 | } 125 | } 126 | } 127 | } 128 | 129 | internal fun computeSuggestion( 130 | sender: CommandSender, 131 | command: Command, 132 | alias: String, 133 | args: Array 134 | ): List { 135 | return this.children[command]?.let { root -> 136 | if (!root.test(sender)) return emptyList() 137 | val nodes = ArrayList() 138 | nodes.add(root) 139 | var last: Kommand = root 140 | 141 | for (i in 0 until args.count() - 1) { 142 | if (last.children.isEmpty()) 143 | return emptyList() 144 | 145 | val arg = args[i] 146 | val child = last.getChild(arg) ?: return emptyList() 147 | if (!child.test(sender)) return emptyList() 148 | 149 | nodes += child 150 | last = child 151 | } 152 | 153 | val context = KommandContext(command, args, nodes).apply { 154 | this.sender = sender 155 | this.alias = alias 156 | } 157 | val target = args.last() 158 | val list = ArrayList() 159 | 160 | for (child in last.children) { 161 | if (!child.test(sender)) continue 162 | 163 | if (child is ArgumentKommand) 164 | list += child.argument.listSuggestion(context, target) 165 | else { 166 | val name = child.name 167 | 168 | if (name.startsWith(target, true)) 169 | list += name 170 | } 171 | } 172 | 173 | list 174 | } ?: emptyList() 175 | } 176 | 177 | private fun getUsage(sender: CommandSender, command: Command): List { 178 | return children[command]?.usages(sender) ?: emptyList() 179 | } 180 | } 181 | 182 | internal fun LiteralKommand.usages(sender: CommandSender): List { 183 | val list = ArrayList() 184 | val prefix = "/$name" 185 | 186 | for (child in children) { 187 | val requirement = child.requirement 188 | 189 | if (requirement == null || sender.requirement()) 190 | child.computeUsages(sender, this, list, StringBuilder(prefix)) 191 | } 192 | 193 | return list 194 | } 195 | 196 | internal fun Kommand.computeUsages( 197 | sender: CommandSender, 198 | parent: Kommand, 199 | list: MutableList, 200 | builder: StringBuilder 201 | ) { 202 | builder.append(' ') 203 | if (this is ArgumentKommand) { 204 | val brace = if (executor != null && parent.executor != null && children.isEmpty()) "[]" else "<>" 205 | builder.append(brace[0]).append(name).append(brace[1]) 206 | } else { 207 | builder.append(name) 208 | } 209 | 210 | for (child in children) { 211 | val requirement = child.requirement 212 | 213 | if (requirement == null || sender.requirement()) 214 | child.computeUsages(sender, this, list, StringBuilder(builder)) 215 | } 216 | 217 | if (executor != null && children.isEmpty()) { 218 | list += builder.toString() 219 | } 220 | } 221 | 222 | //인수명령어 223 | //현재 명령에 executor 존재 224 | //상위 명령에 executor가 존재 225 | //하위 명령어 없음 226 | 227 | class KommandDispatcherBuilder( 228 | private val plugin: JavaPlugin 229 | ) { 230 | private val buildersByName = LinkedHashMap() 231 | 232 | fun register(name: String, init: KommandBuilder.() -> Unit) { 233 | val command = plugin.getCommand(name) ?: throw IllegalArgumentException("[$name] is unknown command") 234 | 235 | buildersByName[command] = LiteralKommandBuilder(name).apply(init) 236 | } 237 | 238 | fun build(): KommandDispatcher { 239 | return KommandDispatcher(buildersByName) 240 | } 241 | } 242 | 243 | internal class KommandAdapter(private val dispatcher: KommandDispatcher) : TabExecutor { 244 | override fun onCommand( 245 | sender: CommandSender, 246 | command: Command, 247 | alias: String, 248 | args: Array 249 | ): Boolean { 250 | dispatcher.dispatch(sender, command, alias, args) 251 | return true 252 | } 253 | 254 | override fun onTabComplete( 255 | sender: CommandSender, 256 | command: Command, 257 | alias: String, 258 | args: Array 259 | ): List { 260 | return dispatcher.computeSuggestion(sender, command, alias, args) 261 | } 262 | } -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------