Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@Quoted annotation for string arguments in annotated methods #239

Merged
merged 2 commits into from
Mar 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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 {

}
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -93,6 +94,10 @@ public StandardParserRegistry() {
/* 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 ->
Expand Down Expand Up @@ -130,9 +135,20 @@ public StandardParserRegistry() {
/* 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);
if (greedy && quoted) {
throw new IllegalArgumentException(
"Don't know whether to create GREEDY or QUOTED StringArgument.StringParser, both specified."
);
}
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]))
Expand Down