ChromaGaming/Chroma-Chat
1
0
Fork 0
Code Issues 15 Pull requests 1 Packages Projects Releases 8 Wiki Activity

Small formatter fixes, docs

Browse source
This commit is contained in:
Norbi Peti 2020-03-04 23:07:56 +01:00
parent aad65e0222
commit 0421cc6d16
No known key found for this signature in database
GPG key ID: DBA4C4549A927E56
3 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/main/java/buttondevteam/chat/components/formatter/formatting/ChatFormatter.java
View file

@ -10,12 +10,12 @@ import java.util.function.Predicate;
import java.util.stream.Collectors; import java.util.stream.Collectors;
/** /**
* A {@link ChatFormatter} shows what formatting to use based on regular expressions. {@link ChatFormatter#Combine(List, String, TellrawPart, IHaveConfig, FormatSettings)}} is used to turn it into a {@link TellrawPart}, combining * A {@link MatchProvider} finds where the given {@link FormatSettings} need to be applied. {@link ChatFormatter#Combine(List, String, TellrawPart, IHaveConfig, FormatSettings)}} is used to turn it into a {@link TellrawPart}, combining
* intersecting parts found, for example when {@code _abc*def*ghi_} is said in chat, it'll turn it into an underlined part, then an underlined <i>and italics</i> part, finally an underlined part * intersecting parts found, for example when {@code _abc*def*ghi_} is said in chat, it'll turn it into an underlined part, then an underlined <i>and italics</i> part, finally an underlined part
* again. * again.
* *
* @author NorbiPeti * @author NorbiPeti
*/ //TODO: Update doc */
public final class ChatFormatter { public final class ChatFormatter {
private ChatFormatter() { private ChatFormatter() {
} }
@ -25,7 +25,8 @@ public final class ChatFormatter {
R apply(T1 x1, T2 x2, T3 x3); R apply(T1 x1, T2 x2, T3 x3);
} }
public static void Combine(List<MatchProviderBase> formatters, String str, TellrawPart tp, IHaveConfig config, FormatSettings defaults) { //synchronized: Some of the formatters are reused, see createSections(...)
public static synchronized void Combine(List<MatchProviderBase> formatters, String str, TellrawPart tp, IHaveConfig config, FormatSettings defaults) {
/* /*
* A global formatter is no longer needed * A global formatter is no longer needed
*/ */
@ -44,11 +45,11 @@ public final class ChatFormatter {
sections.add(new FormattedSection(defaults, 0, str.length() - 1, Collections.emptyList())); //Add entire message sections.add(new FormattedSection(defaults, 0, str.length() - 1, Collections.emptyList())); //Add entire message
var providers = formatters.stream().filter(mp -> mp instanceof RegexMatchProvider).collect(Collectors.toList()); var providers = formatters.stream().filter(mp -> mp instanceof RegexMatchProvider).collect(Collectors.toList());
createSections(providers, str, sections, excluded, remchars, defaults); createSections(providers, str, sections, excluded, remchars);
providers = formatters.stream().filter(mp -> mp instanceof StringMatchProvider).collect(Collectors.toList()); providers = formatters.stream().filter(mp -> mp instanceof StringMatchProvider).collect(Collectors.toList());
createSections(providers, str, sections, excluded, remchars, defaults); createSections(providers, str, sections, excluded, remchars);
providers = formatters.stream().filter(mp -> mp instanceof RangeMatchProvider).collect(Collectors.toList()); providers = formatters.stream().filter(mp -> mp instanceof RangeMatchProvider).collect(Collectors.toList());
createSections(providers, str, sections, excluded, remchars, defaults); createSections(providers, str, sections, excluded, remchars);
sortSections(sections); sortSections(sections);
header("Section combining"); header("Section combining");
@ -71,7 +72,7 @@ public final class ChatFormatter {
} }
private static void createSections(List<MatchProviderBase> formatters, String str, ArrayList<FormattedSection> sections, private static void createSections(List<MatchProviderBase> formatters, String str, ArrayList<FormattedSection> sections,
ArrayList<int[]> excludedAreas, ArrayList<int[]> removedCharacters, FormatSettings defaults) { ArrayList<int[]> excludedAreas, ArrayList<int[]> removedCharacters) {
formatters.forEach(MatchProviderBase::reset); //Reset state information, as we aren't doing deep cloning formatters.forEach(MatchProviderBase::reset); //Reset state information, as we aren't doing deep cloning
while (formatters.size() > 0) { while (formatters.size() > 0) {
for (var iterator = formatters.iterator(); iterator.hasNext(); ) { for (var iterator = formatters.iterator(); iterator.hasNext(); ) {

3
src/main/java/buttondevteam/chat/components/formatter/formatting/FormatSettings.java
View file

@ -4,6 +4,9 @@ import buttondevteam.lib.chat.Color;
import lombok.Builder; import lombok.Builder;
import lombok.Data; import lombok.Data;
/**
* Describes how a matched section of the message should look. May be combined with other format settings.
*/
@Data @Data
@Builder @Builder
public class FormatSettings { public class FormatSettings {

3
src/main/java/buttondevteam/chat/components/formatter/formatting/MatchProvider.java
View file

@ -3,6 +3,9 @@ package buttondevteam.chat.components.formatter.formatting;
import javax.annotation.Nullable; import javax.annotation.Nullable;
import java.util.ArrayList; import java.util.ArrayList;
/**
* Attempts to find a match for the provided message, returning null if none was found.
*/
public interface MatchProvider { public interface MatchProvider {
@Nullable @Nullable
FormattedSection getNextSection(String message, ArrayList<int[]> ignoredAreas, ArrayList<int[]> removedCharacters); FormattedSection getNextSection(String message, ArrayList<int[]> ignoredAreas, ArrayList<int[]> removedCharacters);