Skip to content

Commit

Permalink
Refactor Custom Formatting Patterns, write tests and fix a translation (
Browse files Browse the repository at this point in the history 
#162)
  • Loading branch information
@shartte
shartte authored Jun 14, 2024
1 parent 70ec5b1 commit 31cff41
Show file tree
Hide file tree
Showing 7 changed files with 444 additions and 87 deletions.
127 changes: 85 additions & 42 deletions loader/src/main/java/net/neoforged/fml/i18n/FMLTranslations.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,80 +5,62 @@

package net.neoforged.fml.i18n;

import com.google.common.base.CharMatcher;
import java.nio.file.Path;
import java.text.FieldPosition;
import java.text.Format;
import java.text.ParsePosition;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.BiConsumer;
import java.util.function.Supplier;
import java.util.regex.Pattern;
import net.neoforged.fml.Logging;
import net.neoforged.fml.ModLoadingIssue;
import net.neoforged.fml.loading.FMLLoader;
import net.neoforged.fml.loading.StringUtils;
import net.neoforged.neoforgespi.language.IModInfo;
import net.neoforged.neoforgespi.locating.ForgeFeature;
import org.apache.commons.lang3.text.ExtendedMessageFormat;
import org.apache.commons.lang3.text.FormatFactory;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.maven.artifact.versioning.VersionRange;
import org.jetbrains.annotations.ApiStatus;

@ApiStatus.Internal
@SuppressWarnings("deprecation")
public class FMLTranslations {
private static final Logger LOGGER = LogManager.getLogger();
private static final String ALLOWED_CHARS = "\u00c0\u00c1\u00c2\u00c8\u00ca\u00cb\u00cd\u00d3\u00d4\u00d5\u00da\u00df\u00e3\u00f5\u011f\u0130\u0131\u0152\u0153\u015e\u015f\u0174\u0175\u017e\u0207\u0000\u0000\u0000\u0000\u0000\u0000\u0000 !\"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~\u0000\u00c7\u00fc\u00e9\u00e2\u00e4\u00e0\u00e5\u00e7\u00ea\u00eb\u00e8\u00ef\u00ee\u00ec\u00c4\u00c5\u00c9\u00e6\u00c6\u00f4\u00f6\u00f2\u00fb\u00f9\u00ff\u00d6\u00dc\u00f8\u00a3\u00d8\u00d7\u0192\u00e1\u00ed\u00f3\u00fa\u00f1\u00d1\u00aa\u00ba\u00bf\u00ae\u00ac\u00bd\u00bc\u00a1\u00ab\u00bb\u2591\u2592\u2593\u2502\u2524\u2561\u2562\u2556\u2555\u2563\u2551\u2557\u255d\u255c\u255b\u2510\u2514\u2534\u252c\u251c\u2500\u253c\u255e\u255f\u255a\u2554\u2569\u2566\u2560\u2550\u256c\u2567\u2568\u2564\u2565\u2559\u2558\u2552\u2553\u256b\u256a\u2518\u250c\u2588\u2584\u258c\u2590\u2580\u03b1\u03b2\u0393\u03c0\u03a3\u03c3\u03bc\u03c4\u03a6\u0398\u03a9\u03b4\u221e\u2205\u2208\u2229\u2261\u00b1\u2265\u2264\u2320\u2321\u00f7\u2248\u00b0\u2219\u00b7\u221a\u207f\u00b2\u25a0\u0000";
private static final CharMatcher DISALLOWED_CHAR_MATCHER = CharMatcher.anyOf(ALLOWED_CHARS).negate();
private static final Map<String, FormatFactory> CUSTOM_FACTORIES;
private static final Pattern PATTERN_CONTROL_CODE = Pattern.compile("(?i)\\u00A7[0-9A-FK-OR]");
private static final Pattern FORMAT_PATTERN = Pattern.compile("%(?:(\\d+)\\$)?([A-Za-z%]|$)");

static {
CUSTOM_FACTORIES = new HashMap<>();
// {0,modinfo,id} -> modid from ModInfo object; {0,modinfo,name} -> displayname from ModInfo object
CUSTOM_FACTORIES.put("modinfo", (name, formatString, locale) -> new CustomReadOnlyFormat((stringBuffer, objectToParse) -> parseModInfo(formatString, stringBuffer, objectToParse)));
CUSTOM_FACTORIES.put("modinfo", new CustomFormat<>(IModInfo.class, FMLTranslations::formatModInfo));
// {0,lower} -> lowercase supplied string
CUSTOM_FACTORIES.put("lower", (name, formatString, locale) -> new CustomReadOnlyFormat((stringBuffer, objectToParse) -> stringBuffer.append(StringUtils.toLowerCase(String.valueOf(objectToParse)))));
CUSTOM_FACTORIES.put("lower", new CustomFormat<>(Object.class, (stringBuffer, value) -> stringBuffer.append(StringUtils.toLowerCase(String.valueOf(value)))));
// {0,upper> -> uppercase supplied string
CUSTOM_FACTORIES.put("upper", (name, formatString, locale) -> new CustomReadOnlyFormat((stringBuffer, objectToParse) -> stringBuffer.append(StringUtils.toUpperCase(String.valueOf(objectToParse)))));
CUSTOM_FACTORIES.put("upper", new CustomFormat<>(Object.class, (stringBuffer, value) -> stringBuffer.append(StringUtils.toUpperCase(String.valueOf(value)))));
// {0,exc,cls} -> class of exception; {0,exc,msg} -> message from exception
CUSTOM_FACTORIES.put("exc", (name, formatString, locale) -> new CustomReadOnlyFormat((stringBuffer, objectToParse) -> parseException(formatString, stringBuffer, objectToParse)));
CUSTOM_FACTORIES.put("exc", new CustomFormat<>(Throwable.class, FMLTranslations::formatException));
// {0,vr} -> transform VersionRange into cleartext string using fml.messages.version.restriction.* strings
CUSTOM_FACTORIES.put("vr", (name, formatString, locale) -> new CustomReadOnlyFormat(MavenVersionTranslator::parseVersionRange));
CUSTOM_FACTORIES.put("vr", new CustomFormat<>(VersionRange.class, FMLTranslations::formatVersionRange));
// {0,featurebound} -> transform feature bound to cleartext string
CUSTOM_FACTORIES.put("featurebound", (name, formatString, locale) -> new CustomReadOnlyFormat(MavenVersionTranslator::parseFeatureBoundValue));
CUSTOM_FACTORIES.put("featurebound", new CustomFormat<>(ForgeFeature.Bound.class, FMLTranslations::formatFeatureBoundValue));
// {0,i18n,fml.message} -> pass object to i18n string 'fml.message'
CUSTOM_FACTORIES.put("i18n", (name, formatString, locale) -> new CustomReadOnlyFormat((stringBuffer, o) -> stringBuffer.append(parseMessage(formatString, o))));
CUSTOM_FACTORIES.put("i18n", new CustomFormat<>(Object.class, (stringBuffer, o, args) -> stringBuffer.append(parseMessage(args, o))));
// {0,i18ntranslate} -> attempt to use the argument as a translation key
CUSTOM_FACTORIES.put("i18ntranslate", (name, formatString, locale) -> new CustomReadOnlyFormat((stringBuffer, o) -> stringBuffer.append(parseMessage((String) o))));
CUSTOM_FACTORIES.put("i18ntranslate", new CustomFormat<>(String.class, (stringBuffer, o) -> stringBuffer.append(parseMessage(o))));
// {0,ornull,fml.absent} -> append String value of o, or i18n string 'fml.absent' (message format transforms nulls into the string literal "null")
CUSTOM_FACTORIES.put("ornull", ((name, formatString, locale) -> new CustomReadOnlyFormat((stringBuffer, o) -> stringBuffer.append(Objects.equals(String.valueOf(o), "null") ? parseMessage(formatString) : String.valueOf(o)))));
CUSTOM_FACTORIES.put("ornull", new CustomFormat<>(Object.class, FMLTranslations::formatOrNull));
// {0,optional,[prefix]} -> append String value of o if the optional is present, with an optional prefix at the start
CUSTOM_FACTORIES.put("optional", (name, formatString, locale) -> new CustomReadOnlyFormat((stringBuffer, o) -> ((Optional<?>) o).ifPresent(val -> stringBuffer.append(formatString == null ? "" : formatString).append(val))));
}

private static void parseException(final String formatString, final StringBuffer stringBuffer, final Object objectToParse) {
Throwable t = (Throwable) objectToParse;
if (Objects.equals(formatString, "msg")) {
stringBuffer.append(t.getClass().getName()).append(": ").append(t.getMessage());
} else if (Objects.equals(formatString, "cls")) {
stringBuffer.append(t.getClass().getName());
}
}

private static void parseModInfo(final String formatString, final StringBuffer stringBuffer, final Object modInfo) {
final IModInfo info = (IModInfo) modInfo;
if (Objects.equals(formatString, "id")) {
stringBuffer.append(info.getModId());
} else if (Objects.equals(formatString, "name")) {
stringBuffer.append(info.getDisplayName());
}
CUSTOM_FACTORIES.put("optional", new CustomFormat<>(Optional.class, FMLTranslations::formatOptional));
}

public static String getPattern(final String patternName, final Supplier<String> fallback) {
Expand Down Expand Up @@ -176,22 +158,83 @@ public static String stripControlCodes(String text) {
return PATTERN_CONTROL_CODE.matcher(text).replaceAll("");
}

public static class CustomReadOnlyFormat extends Format {
private final BiConsumer<StringBuffer, Object> formatter;
private static void formatException(final StringBuffer stringBuffer, final Throwable t, final String args) {
if (Objects.equals(args, "msg")) {
stringBuffer.append(t.getClass().getName()).append(": ").append(t.getMessage());
} else if (Objects.equals(args, "cls")) {
stringBuffer.append(t.getClass().getName());
}
}

private static void formatModInfo(final StringBuffer stringBuffer, final IModInfo info, final String args) {
if (Objects.equals(args, "id")) {
stringBuffer.append(info.getModId());
} else if (Objects.equals(args, "name")) {
stringBuffer.append(info.getDisplayName());
} else {
LOGGER.warn("Cannot format unknown mod info property in translation: {}", args);
}
}

private static void formatVersionRange(final StringBuffer stringBuffer, final VersionRange range) {
stringBuffer.append(MavenVersionTranslator.versionRangeToString(range));
}

CustomReadOnlyFormat(final BiConsumer<StringBuffer, Object> formatter) {
this.formatter = formatter;
private static void formatFeatureBoundValue(final StringBuffer stringBuffer, final ForgeFeature.Bound bound) {
stringBuffer.append(bound.featureName());
if (bound.bound() instanceof Boolean b) {
stringBuffer.append("=").append(b);
} else if (bound.bound() instanceof VersionRange vr) {
stringBuffer.append(" ").append(MavenVersionTranslator.versionRangeToString(vr));
} else {
stringBuffer.append("=\"").append(bound.featureBound()).append("\"");
}
}

@Override
public StringBuffer format(final Object obj, final StringBuffer toAppendTo, final FieldPosition pos) {
formatter.accept(toAppendTo, obj);
return toAppendTo;
private static void formatOrNull(StringBuffer stringBuffer, Object o, String args) {
stringBuffer.append(Objects.equals(String.valueOf(o), "null") ? parseMessage(args) : String.valueOf(o));
}

private static void formatOptional(StringBuffer stringBuffer, Optional<?> value, String args) {
args = Objects.requireNonNullElse(args, "");
if (value.isPresent()) {
stringBuffer.append(args).append(value.get());
}
}

private record CustomFormat<T>(Class<T> valueClass, FormatFunctionWithArgs<T> formatter) implements FormatFactory {

public CustomFormat(Class<T> valueClass, FormatFunction<T> formatter) {
this(valueClass, (toAppendTo, value, args) -> formatter.format(toAppendTo, value));
}

@Override
public Object parseObject(final String source, final ParsePosition pos) {
throw new UnsupportedOperationException("Parsing is not supported");
public Format getFormat(String name, String arguments, Locale locale) {
return new Format() {
@Override
public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos) {
if (valueClass.isInstance(obj)) {
formatter.format(toAppendTo, valueClass.cast(obj), arguments);
} else if (obj != null) {
LOGGER.warn("Translation format {} expected type {}, but got: {}", name, valueClass, obj.getClass());
}
return toAppendTo;
}

@Override
public Object parseObject(String source, ParsePosition pos) {
throw new UnsupportedOperationException("Parsing is not supported");
}
};
}
@FunctionalInterface
interface FormatFunction<T> {
void format(StringBuffer toAppendTo, T value);
}

@FunctionalInterface
interface FormatFunctionWithArgs<T> {
void format(StringBuffer toAppendTo, T value, String args);
}
}
}
18 changes: 0 additions & 18 deletions loader/src/main/java/net/neoforged/fml/i18n/MavenVersionTranslator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

import java.util.Objects;
import java.util.stream.Collectors;
import net.neoforged.neoforgespi.locating.ForgeFeature;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.artifact.versioning.Restriction;
import org.apache.maven.artifact.versioning.VersionRange;
Expand Down Expand Up @@ -52,21 +51,4 @@ public static String restrictionToString(final Restriction restriction) {
}
}
}

public static void parseVersionRange(final StringBuffer stringBuffer, final Object range) {
stringBuffer.append(versionRangeToString((VersionRange) range));
}

public static void parseFeatureBoundValue(final StringBuffer stringBuffer, final Object range) {
if (range instanceof ForgeFeature.Bound bound) {
stringBuffer.append(bound.featureName());
if (bound.bound() instanceof Boolean b) {
stringBuffer.append("=").append(b);
} else if (bound.bound() instanceof VersionRange vr) {
stringBuffer.append(" ").append(versionRangeToString(vr));
} else {
stringBuffer.append("=\"").append(bound.featureBound()).append("\"");
}
}
}
}
2 changes: 1 addition & 1 deletion loader/src/main/resources/lang/en_us.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"fml.messages.version.restriction.bounded.inclusive": "between {0} and {1} (inclusive)",
"fml.messages.version.restriction.bounded.exclusive": "between {0} and {1} (exclusive)",
"fml.messages.version.restriction.bounded.lowerexclusive": "above {0}, and {1} or below",
"fml.messages.version.restriction.bounded.upperexclusive": "{3} or above, and below {4}",
"fml.messages.version.restriction.bounded.upperexclusive": "{0} or above, and below {1}",
"fml.modloading.enumextender.file_not_found": "Enum extender file {3}, provided by mod {0,modinfo,id}, does not exist",
"fml.modloading.enumextender.invalid_enum_name": "Enum {3}, specified by mod {0,modinfo,id}, is not a valid class descriptor",
"fml.modloading.enumextender.field_name.missing_prefix": "Enum constant name {3} for enum {4}, specified by mod {0,modinfo,id},must be prefixed with the mod ID",
Expand Down
Loading

0 comments on commit 31cff41

Please sign in to comment.