From ceba1109ea589b6fb9799ab7a00d5a0df9a7f7e5 Mon Sep 17 00:00:00 2001 From: makamys Date: Thu, 16 Feb 2023 22:46:13 +0100 Subject: [PATCH] Refactor config parsing to only write if config is dirty --- .../unimixins/all/AllConfig.java | 2 +- .../unimixins/all/AllCore.java | 2 +- .../unimixins/common/AnnotatedProperties.java | 146 ------------------ .../common/config/AnnotatedProperties.java | 68 ++++++++ .../common/{ => config}/ConfigUtil.java | 2 +- .../common/config/PropertyCollection.java | 86 +++++++++++ .../common/config/PropertyToken.java | 81 ++++++++++ .../unimixins/compat/CompatConfig.java | 2 +- .../unimixins/compat/CompatCore.java | 2 +- .../gasstation/GasStationConfig.java | 2 +- .../gasstation/GasStationModule.java | 2 +- .../gtnhmixins/GTNHMixinsConfig.java | 2 +- .../gtnhmixins/GTNHMixinsModule.java | 2 +- 13 files changed, 244 insertions(+), 155 deletions(-) delete mode 100644 module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/AnnotatedProperties.java create mode 100644 module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/AnnotatedProperties.java rename module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/{ => config}/ConfigUtil.java (89%) create mode 100644 module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/PropertyCollection.java create mode 100644 module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/PropertyToken.java diff --git a/module-all/src/main/java/io/github/legacymoddingmc/unimixins/all/AllConfig.java b/module-all/src/main/java/io/github/legacymoddingmc/unimixins/all/AllConfig.java index ebfbefb..9a3bc7c 100644 --- a/module-all/src/main/java/io/github/legacymoddingmc/unimixins/all/AllConfig.java +++ b/module-all/src/main/java/io/github/legacymoddingmc/unimixins/all/AllConfig.java @@ -1,6 +1,6 @@ package io.github.legacymoddingmc.unimixins.all; -import io.github.legacymoddingmc.unimixins.common.AnnotatedProperties; +import io.github.legacymoddingmc.unimixins.common.config.AnnotatedProperties; public class AllConfig { @AnnotatedProperties.ConfigString(def = "true", com = "Throw an error if an invalid combination of modules is detected. Only disable this if you know what you're doing.", cat = "_common") diff --git a/module-all/src/main/java/io/github/legacymoddingmc/unimixins/all/AllCore.java b/module-all/src/main/java/io/github/legacymoddingmc/unimixins/all/AllCore.java index 8f4690f..6380236 100644 --- a/module-all/src/main/java/io/github/legacymoddingmc/unimixins/all/AllCore.java +++ b/module-all/src/main/java/io/github/legacymoddingmc/unimixins/all/AllCore.java @@ -7,7 +7,7 @@ import java.util.regex.Pattern; import cpw.mods.fml.relauncher.IFMLLoadingPlugin; import cpw.mods.fml.relauncher.IFMLLoadingPlugin.MCVersion; -import io.github.legacymoddingmc.unimixins.common.ConfigUtil; +import io.github.legacymoddingmc.unimixins.common.config.ConfigUtil; import net.minecraft.launchwrapper.Launch; import org.apache.commons.io.IOUtils; import org.apache.logging.log4j.LogManager; diff --git a/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/AnnotatedProperties.java b/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/AnnotatedProperties.java deleted file mode 100644 index c1002bf..0000000 --- a/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/AnnotatedProperties.java +++ /dev/null @@ -1,146 +0,0 @@ -package io.github.legacymoddingmc.unimixins.common; - -import java.io.*; -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; -import java.lang.reflect.Field; -import java.util.*; - -public class AnnotatedProperties { - public static void load(File file, Class cls) { - Map propertyTokens = readPropertyTokens(file); - - try { - for (Field f : cls.getFields()) { - if (f.isAnnotationPresent(ConfigString.class)) { - ConfigString ann = f.getAnnotation(ConfigString.class); - List comment = Arrays.asList(ann.com().split("\n")); - String def = ann.def(); - String cat = ann.cat(); - - String key = cat + "." + f.getName(); - - PropertyToken prop = propertyTokens.get(key); - if (prop == null) { - prop = new PropertyToken(comment, key, def); - } - - prop.defaultValue = def; - - prop.comment.removeIf(s -> s.startsWith("[default:")); - prop.comment.add("[default: " + prop.defaultValue + "]"); - - setFieldValue(f, prop.value); - - propertyTokens.put(key, prop); - } - } - } catch(Exception e) { - e.printStackTrace(); - } - - writePropertyTokens(file, propertyTokens); - } - - private static void setFieldValue(Field f, String value) throws Exception { - if(f.getType() == boolean.class) { - f.set(null, Boolean.parseBoolean(value)); - } else { - throw new UnsupportedOperationException(); - } - } - - private static void writePropertyTokens(File file, Map propertyTokens) { - List keys = new ArrayList<>(); - keys.addAll(propertyTokens.keySet()); - Collections.sort(keys); - - try(BufferedWriter bw = new BufferedWriter(new FileWriter(file))) { - for(String k : keys) { - PropertyToken token = propertyTokens.get(k); - - for(String commentLine : token.comment) { - bw.write("# " + commentLine + "\n"); - } - bw.write(token.key + "=" + token.value + "\n\n"); - } - } catch(Exception e) { - e.printStackTrace(); - } - } - - private static Map readPropertyTokens(File file) { - List comment = new ArrayList<>(); - String prop = ""; - - Map tokens = new HashMap<>(); - - if(file.exists()) { - try (BufferedReader br = new BufferedReader(new FileReader(file))) { - while (true) { - String line = br.readLine(); - if (line == null) break; - if (line.isEmpty()) continue; - - line = line.trim(); - - if (line.startsWith("#")) { - comment.add(line.substring(1).trim()); - } else { - prop = line; - - PropertyToken token = new PropertyToken(comment, prop); - tokens.put(token.key, token); - - comment.clear(); - } - } - } catch (Exception e) { - e.printStackTrace(); - } - } - - return tokens; - } - - private static class PropertyToken { - - public List comment; - public String key; - public String value; - public String defaultValue; - - public PropertyToken(List comment, String propertyString) { - this.comment = new ArrayList<>(comment); - String[] pair = propertyString.split("="); - if(pair.length != 2) { - throw new RuntimeException(); - } else { - key = pair[0]; - value = pair[1]; - } - } - - public PropertyToken(List comment, String key, String value) { - this.comment = new ArrayList<>(comment); - this.key = key; - this.value = value; - } - - } - - @Retention(RetentionPolicy.RUNTIME) - @Target(ElementType.FIELD) - public @interface ConfigString { - - /** Default value */ - String def(); - /** Comment */ - String com() default ""; - /** Category (the property name gets prefixed with this) */ - String cat(); - - } -} diff --git a/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/AnnotatedProperties.java b/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/AnnotatedProperties.java new file mode 100644 index 0000000..5989aa1 --- /dev/null +++ b/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/AnnotatedProperties.java @@ -0,0 +1,68 @@ +package io.github.legacymoddingmc.unimixins.common.config; + +import java.io.*; +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; +import java.lang.reflect.Field; +import java.util.*; + +public class AnnotatedProperties { + public static void load(File file, Class cls) { + PropertyCollection properties = PropertyCollection.fromFile(file); + + try { + for (Field f : cls.getFields()) { + if (f.isAnnotationPresent(ConfigString.class)) { + ConfigString ann = f.getAnnotation(ConfigString.class); + List comment = new ArrayList<>(Arrays.asList(ann.com().split("\n"))); + String def = ann.def(); + String cat = ann.cat(); + + comment.removeIf(s -> s.startsWith("[default:")); + comment.add("[default: " + def + "]"); + + String key = cat + "." + f.getName(); + + PropertyToken prop = properties.get(key); + if (prop == null) { + prop = new PropertyToken(comment, key, def); + prop.setDirty(); + } else { + prop.setComment(comment); + } + + setFieldValue(f, prop.getValue()); + + properties.put(key, prop); + } + } + } catch(Exception e) { + e.printStackTrace(); + } + + properties.writeToFile(file); + } + + private static void setFieldValue(Field f, String value) throws Exception { + if(f.getType() == boolean.class) { + f.set(null, Boolean.parseBoolean(value)); + } else { + throw new UnsupportedOperationException(); + } + } + + @Retention(RetentionPolicy.RUNTIME) + @Target(ElementType.FIELD) + public @interface ConfigString { + + /** Default value */ + String def(); + /** Comment */ + String com() default ""; + /** Category (the property name gets prefixed with this) */ + String cat(); + + } +} diff --git a/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/ConfigUtil.java b/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/ConfigUtil.java similarity index 89% rename from module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/ConfigUtil.java rename to module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/ConfigUtil.java index 8fb029f..234e1e5 100644 --- a/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/ConfigUtil.java +++ b/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/ConfigUtil.java @@ -1,4 +1,4 @@ -package io.github.legacymoddingmc.unimixins.common; +package io.github.legacymoddingmc.unimixins.common.config; import net.minecraft.launchwrapper.Launch; diff --git a/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/PropertyCollection.java b/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/PropertyCollection.java new file mode 100644 index 0000000..9365c11 --- /dev/null +++ b/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/PropertyCollection.java @@ -0,0 +1,86 @@ +package io.github.legacymoddingmc.unimixins.common.config; + +import java.io.*; +import java.util.*; +import java.util.stream.Collectors; + +class PropertyCollection { + + // We use a TreeMap so keys are automatically sorted + private Map properties = new TreeMap<>(); + + public static PropertyCollection fromFile(File file) { + PropertyCollection coll = new PropertyCollection(); + coll.readPropertyTokens(file); + return coll; + } + + private void readPropertyTokens(File file) { + List comment = new ArrayList<>(); + String prop = ""; + + List keyOrder = new ArrayList<>(); + + if (file.exists()) { + try (BufferedReader br = new BufferedReader(new FileReader(file))) { + while (true) { + String line = br.readLine(); + if (line == null) break; + if (line.isEmpty()) continue; + + line = line.trim(); + + if (line.startsWith("#")) { + comment.add(line.substring(1).trim()); + } else { + prop = line; + + PropertyToken token = new PropertyToken(comment, prop); + properties.put(token.getKey(), token); + + keyOrder.add(token.getKey()); + + comment.clear(); + } + } + } catch (Exception e) { + e.printStackTrace(); + } + } + } + + public void writeToFile(File file) { + writePropertyTokens(file); + } + + private void writePropertyTokens(File file) { + boolean dirty = properties.values().stream().anyMatch(PropertyToken::isDirty); + + if(dirty) { + try (BufferedWriter bw = new BufferedWriter(new FileWriter(file))) { + for (Map.Entry e : properties.entrySet()) { + PropertyToken token = e.getValue(); + + for (String commentLine : token.getComment()) { + bw.write("# " + commentLine + "\n"); + } + bw.write(token.getKey() + "=" + token.getValue() + "\n\n"); + } + } catch (Exception e) { + e.printStackTrace(); + } + } + } + + public PropertyToken get(String key) { + return properties.get(key); + } + + public void put(String key, PropertyToken token) { + PropertyToken old = properties.get(key); + if (!token.equals(old)) { + properties.put(key, token); + token.setDirty(); + } + } +} diff --git a/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/PropertyToken.java b/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/PropertyToken.java new file mode 100644 index 0000000..403da22 --- /dev/null +++ b/module-common/src/main/java/io/github/legacymoddingmc/unimixins/common/config/PropertyToken.java @@ -0,0 +1,81 @@ +package io.github.legacymoddingmc.unimixins.common.config; + +import com.google.common.collect.ImmutableList; + +import java.util.ArrayList; +import java.util.List; + +public class PropertyToken { + + private List comment; + private String key; + private String value; + private boolean dirty; + + public PropertyToken(List comment, String propertyString) { + this.comment = ImmutableList.copyOf(comment); + String[] pair = propertyString.split("="); + if (pair.length != 2) { + throw new RuntimeException(); + } else { + key = pair[0]; + value = pair[1]; + } + } + + public PropertyToken(List comment, String key, String value) { + this.comment = new ArrayList<>(comment); + this.key = key; + this.value = value; + } + + public List getComment() { + return comment; + } + + public void setComment(List comment) { + if(!comment.equals(this.comment)) { + this.comment = ImmutableList.copyOf(comment); + this.dirty = true; + } + } + + public String getKey() { + return key; + } + + public void setKey(String key) { + if(!key.equals(this.key)) { + this.key = key; + this.dirty = true; + } + } + + public String getValue() { + return value; + } + + public void setValue(String value) { + if(!value.equals(this.value)) { + this.value = value; + this.dirty = true; + } + } + + public boolean isDirty() { + return dirty; + } + + public void setDirty() { + dirty = true; + } + + @Override + public boolean equals(Object obj) { + if (obj instanceof PropertyToken) { + PropertyToken o = (PropertyToken) obj; + return comment.equals(o.comment) && key.equals(o.key) && value.equals(o.value); + } + return super.equals(obj); + } +} diff --git a/module-compat/src/main/java/io/github/legacymoddingmc/unimixins/compat/CompatConfig.java b/module-compat/src/main/java/io/github/legacymoddingmc/unimixins/compat/CompatConfig.java index e1910ba..45e915b 100644 --- a/module-compat/src/main/java/io/github/legacymoddingmc/unimixins/compat/CompatConfig.java +++ b/module-compat/src/main/java/io/github/legacymoddingmc/unimixins/compat/CompatConfig.java @@ -1,6 +1,6 @@ package io.github.legacymoddingmc.unimixins.compat; -import io.github.legacymoddingmc.unimixins.common.AnnotatedProperties; +import io.github.legacymoddingmc.unimixins.common.config.AnnotatedProperties; public class CompatConfig { @AnnotatedProperties.ConfigString(def = "true", com = "Remap references to Mixin's shaded ASM.", cat = "compat") diff --git a/module-compat/src/main/java/io/github/legacymoddingmc/unimixins/compat/CompatCore.java b/module-compat/src/main/java/io/github/legacymoddingmc/unimixins/compat/CompatCore.java index bd9f00a..f584830 100644 --- a/module-compat/src/main/java/io/github/legacymoddingmc/unimixins/compat/CompatCore.java +++ b/module-compat/src/main/java/io/github/legacymoddingmc/unimixins/compat/CompatCore.java @@ -4,7 +4,7 @@ import java.util.*; import cpw.mods.fml.relauncher.IFMLLoadingPlugin; import cpw.mods.fml.relauncher.IFMLLoadingPlugin.MCVersion; -import io.github.legacymoddingmc.unimixins.common.ConfigUtil; +import io.github.legacymoddingmc.unimixins.common.config.ConfigUtil; import net.minecraft.launchwrapper.Launch; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; diff --git a/module-gasstation/src/main/java/io/github/legacymoddingmc/unimixins/gasstation/GasStationConfig.java b/module-gasstation/src/main/java/io/github/legacymoddingmc/unimixins/gasstation/GasStationConfig.java index b00ffec..72fa991 100644 --- a/module-gasstation/src/main/java/io/github/legacymoddingmc/unimixins/gasstation/GasStationConfig.java +++ b/module-gasstation/src/main/java/io/github/legacymoddingmc/unimixins/gasstation/GasStationConfig.java @@ -1,6 +1,6 @@ package io.github.legacymoddingmc.unimixins.gasstation; -import io.github.legacymoddingmc.unimixins.common.AnnotatedProperties; +import io.github.legacymoddingmc.unimixins.common.config.AnnotatedProperties; public class GasStationConfig { @AnnotatedProperties.ConfigString(def = "true", com = "Throw an error if an invalid combination of modules is detected. Only disable this if you know what you're doing.", cat = "_common") diff --git a/module-gasstation/src/main/java/io/github/legacymoddingmc/unimixins/gasstation/GasStationModule.java b/module-gasstation/src/main/java/io/github/legacymoddingmc/unimixins/gasstation/GasStationModule.java index dc529e4..0a83522 100644 --- a/module-gasstation/src/main/java/io/github/legacymoddingmc/unimixins/gasstation/GasStationModule.java +++ b/module-gasstation/src/main/java/io/github/legacymoddingmc/unimixins/gasstation/GasStationModule.java @@ -1,6 +1,6 @@ package io.github.legacymoddingmc.unimixins.gasstation; -import io.github.legacymoddingmc.unimixins.common.ConfigUtil; +import io.github.legacymoddingmc.unimixins.common.config.ConfigUtil; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; diff --git a/module-gtnhmixins/src/main/java/io/github/legacymoddingmc/unimixins/gtnhmixins/GTNHMixinsConfig.java b/module-gtnhmixins/src/main/java/io/github/legacymoddingmc/unimixins/gtnhmixins/GTNHMixinsConfig.java index 1b0073e..4f9c753 100644 --- a/module-gtnhmixins/src/main/java/io/github/legacymoddingmc/unimixins/gtnhmixins/GTNHMixinsConfig.java +++ b/module-gtnhmixins/src/main/java/io/github/legacymoddingmc/unimixins/gtnhmixins/GTNHMixinsConfig.java @@ -1,6 +1,6 @@ package io.github.legacymoddingmc.unimixins.gtnhmixins; -import io.github.legacymoddingmc.unimixins.common.AnnotatedProperties; +import io.github.legacymoddingmc.unimixins.common.config.AnnotatedProperties; public class GTNHMixinsConfig { @AnnotatedProperties.ConfigString(def = "true", com = "Throw an error if an invalid combination of modules is detected. Only disable this if you know what you're doing.", cat = "_common") diff --git a/module-gtnhmixins/src/main/java/io/github/legacymoddingmc/unimixins/gtnhmixins/GTNHMixinsModule.java b/module-gtnhmixins/src/main/java/io/github/legacymoddingmc/unimixins/gtnhmixins/GTNHMixinsModule.java index b4ed943..339c93b 100644 --- a/module-gtnhmixins/src/main/java/io/github/legacymoddingmc/unimixins/gtnhmixins/GTNHMixinsModule.java +++ b/module-gtnhmixins/src/main/java/io/github/legacymoddingmc/unimixins/gtnhmixins/GTNHMixinsModule.java @@ -4,7 +4,7 @@ import java.util.ArrayList; import java.util.List; import cpw.mods.fml.common.versioning.ComparableVersion; -import io.github.legacymoddingmc.unimixins.common.ConfigUtil; +import io.github.legacymoddingmc.unimixins.common.config.ConfigUtil; import net.minecraft.launchwrapper.Launch; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger;