-
-
Notifications
You must be signed in to change notification settings - Fork 104
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
feature: MiniMessageTranslator #972
Draft
kezz
wants to merge
2
commits into
main/4
Choose a base branch
from
feature/minimessage-translator
base: main/4
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
39 changes: 39 additions & 0 deletions
39
...nimessage/src/main/java/net/kyori/adventure/text/minimessage/translation/ArgumentTag.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,39 @@ | ||
package net.kyori.adventure.text.minimessage.translation; | ||
|
||
import java.util.List; | ||
import java.util.Objects; | ||
import net.kyori.adventure.text.ComponentLike; | ||
import net.kyori.adventure.text.minimessage.Context; | ||
import net.kyori.adventure.text.minimessage.ParsingException; | ||
import net.kyori.adventure.text.minimessage.tag.Tag; | ||
import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue; | ||
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver; | ||
import org.jetbrains.annotations.NotNull; | ||
import org.jetbrains.annotations.Nullable; | ||
|
||
public class ArgumentTag implements TagResolver { | ||
private static final String NAME = "argument"; | ||
private static final String NAME_1 = "arg"; | ||
|
||
private final List<? extends ComponentLike> argumentComponents; | ||
|
||
public ArgumentTag(final @NotNull List<? extends ComponentLike> argumentComponents) { | ||
this.argumentComponents = Objects.requireNonNull(argumentComponents, "argumentComponents"); | ||
} | ||
|
||
@Override | ||
public @Nullable Tag resolve(final @NotNull String name, final @NotNull ArgumentQueue arguments, final @NotNull Context ctx) throws ParsingException { | ||
final int index = arguments.popOr("No argument number provided").asInt().orElseThrow(() -> ctx.newException("Invalid argument number", arguments)); | ||
|
||
if (index < 0 || index >= argumentComponents.size()) { | ||
throw ctx.newException("Invalid argument number", arguments); | ||
} | ||
|
||
return Tag.inserting(argumentComponents.get(index)); | ||
} | ||
|
||
@Override | ||
public boolean has(final @NotNull String name) { | ||
return name.equals(NAME) || name.equals(NAME_1); | ||
} | ||
} |
77 changes: 77 additions & 0 deletions
77
...src/main/java/net/kyori/adventure/text/minimessage/translation/MiniMessageTranslator.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,77 @@ | ||
/* | ||
* This file is part of adventure, licensed under the MIT License. | ||
* | ||
* Copyright (c) 2017-2022 KyoriPowered | ||
* | ||
* 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 net.kyori.adventure.text.minimessage.translation; | ||
|
||
import java.text.MessageFormat; | ||
import java.util.Locale; | ||
import java.util.Objects; | ||
import net.kyori.adventure.text.Component; | ||
import net.kyori.adventure.text.TranslatableComponent; | ||
import net.kyori.adventure.text.minimessage.MiniMessage; | ||
import net.kyori.adventure.translation.Translator; | ||
import org.jetbrains.annotations.NotNull; | ||
import org.jetbrains.annotations.Nullable; | ||
|
||
public abstract class MiniMessageTranslator implements Translator { | ||
|
||
final MiniMessage miniMessage; | ||
|
||
public MiniMessageTranslator() { | ||
this(MiniMessage.miniMessage()); | ||
} | ||
|
||
public MiniMessageTranslator(final @NotNull MiniMessage miniMessage) { | ||
this.miniMessage = Objects.requireNonNull(miniMessage, "miniMessage"); | ||
} | ||
|
||
protected abstract @Nullable String getMiniMessageString(final @NotNull String key, final @NotNull Locale locale); | ||
|
||
@Override | ||
public final @Nullable MessageFormat translate(final @NotNull String key, final @NotNull Locale locale) { | ||
return null; | ||
} | ||
|
||
@Override | ||
public @Nullable Component translate(final @NotNull TranslatableComponent component, final @NotNull Locale locale) { | ||
final String miniMessageString = getMiniMessageString(component.key(), locale); | ||
|
||
if (miniMessageString == null) { | ||
return null; | ||
} | ||
|
||
final Component resultingComponent; | ||
|
||
if (component.args().isEmpty()) { | ||
resultingComponent = MiniMessage.miniMessage().deserialize(miniMessageString); | ||
} else { | ||
resultingComponent = MiniMessage.miniMessage().deserialize(miniMessageString, new ArgumentTag(component.args())); | ||
} | ||
kezz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
if (component.children().isEmpty()) { | ||
return resultingComponent; | ||
} else { | ||
return resultingComponent.children(component.children()); | ||
} | ||
} | ||
} |
27 changes: 27 additions & 0 deletions
27
...imessage/src/main/java/net/kyori/adventure/text/minimessage/translation/package-info.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,27 @@ | ||
/* | ||
* This file is part of adventure, licensed under the MIT License. | ||
* | ||
* Copyright (c) 2017-2022 KyoriPowered | ||
* | ||
* 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. | ||
*/ | ||
/** | ||
* Tools for working with Adventure's translation API. | ||
*/ | ||
package net.kyori.adventure.text.minimessage.translation; |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.