zhdev/oblak
1
0
Fork 0
Code Issues Pull requests Activity

core: Add @Quoted annotation to mark string arguments as quoted in annotated methods

Browse source
This commit is contained in:
jmp 2021-03-17 20:51:00 -07:00 • committed by Jason
parent ffa17b001b
commit 1bed15ea6d
3 changed files with 61 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

41
cloud-core/src/main/java/cloud/commandframework/annotations/specifier/Quoted.java Normal file
View file

@ -0,0 +1,41 @@
//
// MIT License
//
// Copyright (c) 2021 Alexander Söderberg & Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
package cloud.commandframework.annotations.specifier;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation used to set the parsing mode of a {@link cloud.commandframework.arguments.standard.StringArgument string
* argument} to quoted.
*
* @since 1.5.0
*/
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface Quoted {
}

6
cloud-core/src/main/java/cloud/commandframework/arguments/parser/StandardParameters.java
View file

@ -59,6 +59,12 @@ public final class StandardParameters {
* Indicates that a string argument should be greedy
*/
public static final ParserParameter<Boolean> GREEDY = create("greedy", TypeToken.get(Boolean.class));
/**
* Indicates that a string argument should be quoted.
*
* @since 1.5.0
*/
public static final ParserParameter<Boolean> QUOTED = create("quoted", TypeToken.get(Boolean.class));
private StandardParameters() {
}

17
cloud-core/src/main/java/cloud/commandframework/arguments/parser/StandardParserRegistry.java
View file

@ -24,6 +24,7 @@
package cloud.commandframework.arguments.parser;
import cloud.commandframework.annotations.specifier.Greedy;
import cloud.commandframework.annotations.specifier.Quoted;
import cloud.commandframework.annotations.specifier.Range;
import cloud.commandframework.arguments.standard.BooleanArgument;
import cloud.commandframework.arguments.standard.ByteArgument;
@ -93,6 +94,10 @@ public final class StandardParserRegistry<C> implements ParserRegistry<C> {
/* Register standard mappers */
this.<Range, Number>registerAnnotationMapper(Range.class, new RangeMapper<>());
this.<Greedy, String>registerAnnotationMapper(Greedy.class, new GreedyMapper());
this.<Quoted, String>registerAnnotationMapper(
Quoted.class,
(quoted, typeToken) -> ParserParameters.single(StandardParameters.QUOTED, true)
);
/* Register standard types */
this.registerParserSupplier(TypeToken.get(Byte.class), options ->
@ -130,9 +135,15 @@ public final class StandardParserRegistry<C> implements ParserRegistry<C> {
/* Make this one less awful */
this.registerParserSupplier(TypeToken.get(String.class), options -> {
final boolean greedy = options.get(StandardParameters.GREEDY, false);
final StringArgument.StringMode stringMode = greedy
? StringArgument.StringMode.GREEDY
: StringArgument.StringMode.SINGLE;
final boolean quoted = options.get(StandardParameters.QUOTED, false);
final StringArgument.StringMode stringMode;
if (greedy) {
stringMode = StringArgument.StringMode.GREEDY;
} else if (quoted) {
stringMode = StringArgument.StringMode.QUOTED;
} else {
stringMode = StringArgument.StringMode.SINGLE;
}
return new StringArgument.StringParser<>(
stringMode,
(context, s) -> Arrays.asList(options.get(StandardParameters.COMPLETIONS, new String[0]))