-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(jda): add parsers for JDA types (#1)
The parsers wrap the JDA option mappings.
- Loading branch information
1 parent
2396266
commit 9ce4552
Showing
6 changed files
with
251 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
79 changes: 79 additions & 0 deletions
79
cloud-jda5/src/main/java/org/incendo/cloud/discord/jda5/JDAOptionType.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| // | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2024 Incendo | ||
| // | ||
| // 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 org.incendo.cloud.discord.jda5; | ||
|
|
||
| import io.leangen.geantyref.TypeToken; | ||
| import java.util.Arrays; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import net.dv8tion.jda.api.entities.IMentionable; | ||
| import net.dv8tion.jda.api.entities.Message; | ||
| import net.dv8tion.jda.api.entities.Role; | ||
| import net.dv8tion.jda.api.entities.User; | ||
| import net.dv8tion.jda.api.entities.channel.Channel; | ||
| import org.apiguardian.api.API; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
| import org.incendo.cloud.discord.slash.DiscordOptionType; | ||
|
|
||
| /** | ||
| * Extension of {@link DiscordOptionType} for JDA-specific classes. | ||
| * | ||
| * @since 1.0.0 | ||
| */ | ||
| @API(status = API.Status.STABLE, since = "1.0.0") | ||
| public final class JDAOptionType { | ||
|
|
||
| public static final @NonNull DiscordOptionType<User> USER = DiscordOptionType.of( | ||
| "USER", | ||
| 6, | ||
| TypeToken.get(User.class) | ||
| ); | ||
| public static final @NonNull DiscordOptionType<Channel> CHANNEL = DiscordOptionType.of( | ||
| "CHANNEL", | ||
| 7, | ||
| TypeToken.get(Channel.class) | ||
| ); | ||
| public static final @NonNull DiscordOptionType<Role> ROLE = DiscordOptionType.of( | ||
| "ROLE", | ||
| 8, | ||
| TypeToken.get(Role.class) | ||
| ); | ||
| public static final @NonNull DiscordOptionType<IMentionable> MENTIONABLE = DiscordOptionType.of( | ||
| "MENTIONABLE", | ||
| 9, | ||
| TypeToken.get(IMentionable.class) | ||
| ); | ||
| public static final @NonNull DiscordOptionType<Message.Attachment> ATTACHMENT = DiscordOptionType.of( | ||
| "ATTACHMENT", | ||
| 11, | ||
| TypeToken.get(Message.Attachment.class) | ||
| ); | ||
|
|
||
| public static final Collection<@NonNull DiscordOptionType<?>> JDA_TYPES = Collections.unmodifiableCollection( | ||
| Arrays.asList(USER, CHANNEL, ROLE, MENTIONABLE, ATTACHMENT) | ||
| ); | ||
|
|
||
| private JDAOptionType() { | ||
| } | ||
| } |
130 changes: 130 additions & 0 deletions
130
cloud-jda5/src/main/java/org/incendo/cloud/discord/jda5/JDAParser.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| // | ||
| // MIT License | ||
| // | ||
| // Copyright (c) 2024 Incendo | ||
| // | ||
| // 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 org.incendo.cloud.discord.jda5; | ||
|
|
||
| import cloud.commandframework.arguments.parser.ArgumentParseResult; | ||
| import cloud.commandframework.arguments.parser.ArgumentParser; | ||
| import cloud.commandframework.arguments.parser.ParserDescriptor; | ||
| import cloud.commandframework.context.CommandContext; | ||
| import cloud.commandframework.context.CommandInput; | ||
| import net.dv8tion.jda.api.entities.IMentionable; | ||
| import net.dv8tion.jda.api.entities.Message; | ||
| import net.dv8tion.jda.api.entities.Role; | ||
| import net.dv8tion.jda.api.entities.User; | ||
| import net.dv8tion.jda.api.entities.channel.Channel; | ||
| import net.dv8tion.jda.api.interactions.commands.OptionMapping; | ||
| import org.apiguardian.api.API; | ||
| import org.checkerframework.checker.nullness.qual.NonNull; | ||
|
|
||
| /** | ||
| * A parser which wraps a JDA {@link OptionMapping}. | ||
| * | ||
| * @param <C> command sender type | ||
| * @param <T> JDA type | ||
| * @since 1.0.0 | ||
| */ | ||
| @FunctionalInterface | ||
| @API(status = API.Status.STABLE, since = "1.0.0") | ||
| public interface JDAParser<C, T> extends ArgumentParser<C, T> { | ||
|
|
||
| /** | ||
| * Returns a parser which extracts a {@link User}. | ||
| * | ||
| * @param <C> command sender type | ||
| * @return the parser | ||
| */ | ||
| static <C> @NonNull ParserDescriptor<C, User> userParser() { | ||
| return ParserDescriptor.of((JDAParser<C, User>) mapping -> ArgumentParseResult.success(mapping.getAsUser()), User.class); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a parser which extracts a {@link Channel}. | ||
| * | ||
| * @param <C> command sender type | ||
| * @return the parser | ||
| */ | ||
| static <C> @NonNull ParserDescriptor<C, Channel> channelParser() { | ||
| return ParserDescriptor.of( | ||
| (JDAParser<C, Channel>) mapping -> ArgumentParseResult.success(mapping.getAsChannel()), | ||
| Channel.class | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a parser which extracts a {@link Role}. | ||
| * | ||
| * @param <C> command sender type | ||
| * @return the parser | ||
| */ | ||
| static <C> @NonNull ParserDescriptor<C, Role> roleParser() { | ||
| return ParserDescriptor.of( | ||
| (JDAParser<C, Role>) mapping -> ArgumentParseResult.success(mapping.getAsRole()), | ||
| Role.class | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a parser which extracts a {@link IMentionable}. | ||
| * | ||
| * @param <C> command sender type | ||
| * @return the parser | ||
| */ | ||
| static <C> @NonNull ParserDescriptor<C, IMentionable> mentionableParser() { | ||
| return ParserDescriptor.of( | ||
| (JDAParser<C, IMentionable>) mapping -> ArgumentParseResult.success(mapping.getAsMentionable()), | ||
| IMentionable.class | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a parser which extracts an {@link Message.Attachment}. | ||
| * | ||
| * @param <C> command sender type | ||
| * @return the parser | ||
| */ | ||
| static <C> @NonNull ParserDescriptor<C, Message.Attachment> attachmentParser() { | ||
| return ParserDescriptor.of( | ||
| (JDAParser<C, Message.Attachment>) mapping -> ArgumentParseResult.success(mapping.getAsAttachment()), | ||
| Message.Attachment.class | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the result of extracting the argument from the given {@code mapping}. | ||
| * | ||
| * @param mapping JDA option mapping | ||
| * @return the result | ||
| */ | ||
| @NonNull ArgumentParseResult<T> extract(@NonNull OptionMapping mapping); | ||
|
|
||
| @Override | ||
| default @NonNull ArgumentParseResult<@NonNull T> parse( | ||
| final @NonNull CommandContext<@NonNull C> commandContext, | ||
| final @NonNull CommandInput commandInput | ||
| ) { | ||
| final JDAInteraction interaction = commandContext.get(JDA5CommandManager.CONTEXT_JDA_INTERACTION); | ||
| final OptionMapping mapping = interaction.getOptionMapping(commandInput.readString()).orElse(null); | ||
| return this.extract(mapping); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters