Make processed option an interface

Author: lineargraph

common/src/main/java/io/github/notenoughupdates/moulconfig/gui/GuiOptionEditor.java

@@ -24,6 +24,7 @@
 import io.github.notenoughupdates.moulconfig.annotations.SearchTag;
 import io.github.notenoughupdates.moulconfig.common.IMinecraft;
 import io.github.notenoughupdates.moulconfig.common.RenderContext;
+import io.github.notenoughupdates.moulconfig.processor.HasDebugLocation;
 import io.github.notenoughupdates.moulconfig.processor.ProcessedOption;
 import lombok.var;
 import org.jetbrains.annotations.ApiStatus;
@@ -32,13 +33,18 @@
 import java.util.List;
 import java.util.Locale;
 
-public abstract class GuiOptionEditor {
+public abstract class GuiOptionEditor implements HasDebugLocation {
     private static final int HEIGHT = 45;
     protected final ProcessedOption option;
     public MoulConfigEditor<?> activeConfigGUI;
     private String searchDescNameCache;
     private String searchTags = "";
 
+    @Override
+    public String getDebugDeclarationLocation() {
+        return option != null ? option.getDebugDeclarationLocation() : null;
+    }
+
     @ApiStatus.Internal
     public ProcessedOption getOption() {
         return option;

common/src/main/java/io/github/notenoughupdates/moulconfig/gui/editors/GuiOptionEditorColour.java

@@ -44,7 +44,7 @@ public GuiOptionEditorColour(ProcessedOption option) {
         } else if (type.equals(ChromaColour.class)) {
             usesString = false;
         } else {
-            throw new IllegalArgumentException("ConfigEditorColour may only be used on a String or ChromaColour field, but is used on " + option.getCodeLocation());
+            throw new IllegalArgumentException("ConfigEditorColour may only be used on a String or ChromaColour field, but is used on " + option.getDebugDeclarationLocation());
         }
         component = wrapComponent(new GuiComponent() {
             @Override

common/src/main/java/io/github/notenoughupdates/moulconfig/gui/editors/GuiOptionEditorDraggableList.java

@@ -98,7 +98,7 @@ private String getExampleText(Object forObject) {
         String str = exampleText.get(forObject);
         if (str == null) {
             str = "<unknown " + forObject + ">";
-            Warnings.warnOnce("Could not find draggable list object for " + forObject + " on option " + option.getCodeLocation(), forObject, option);
+            Warnings.warnOnce("Could not find draggable list object for " + forObject + " on option " + option.getDebugDeclarationLocation(), forObject, option);
         }
         return str;
     }

common/src/main/java/io/github/notenoughupdates/moulconfig/gui/editors/GuiOptionEditorText.java

@@ -18,7 +18,7 @@ public GuiOptionEditorText(ProcessedOption option) {
         super(option);
 
         if (option.getType() != String.class) {
-            Warnings.warn("@ConfigEditorText " + option.getCodeLocation() + " is not a string option.");
+            Warnings.warn("@ConfigEditorText " + option.getDebugDeclarationLocation() + " is not a string option.");
         }
     }
 

common/src/main/java/io/github/notenoughupdates/moulconfig/internal/ContextAware.java

@@ -1,6 +1,5 @@
 package io.github.notenoughupdates.moulconfig.internal;
 
-import io.github.notenoughupdates.moulconfig.gui.GuiOptionEditor;
 import io.github.notenoughupdates.moulconfig.processor.HasDebugLocation;
 
 import java.lang.reflect.Field;
@@ -10,23 +9,15 @@
  */
 public class ContextAware {
 
-    public static <T> T wrapErrorWithContext(GuiOptionEditor editor, ContextAwareRunnable<T> runnable) {
-        try {
-            return runnable.run();
-        } catch (Exception e) {
-            throw new ContextualException(e, (editor != null && editor.getOption() != null) ? editor.getOption().getCodeLocation() : null);
-        }
-    }
-
     public static <T> T wrapErrorWithContext(Field field, ContextAwareRunnable<T> runnable) {
         return wrapErrorWithContext(field::toString, runnable);
     }
 
-    public static <T> T wrapErrorWithContext(HasDebugLocation field, ContextAwareRunnable<T> runnable) {
+    public static <T> T wrapErrorWithContext(HasDebugLocation debugLocation, ContextAwareRunnable<T> runnable) {
         try {
             return runnable.run();
         } catch (Exception e) {
-            throw new ContextualException(e, field.getDebugDeclarationLocation());
+            throw new ContextualException(e, debugLocation != null ? debugLocation.getDebugDeclarationLocation() : null);
         }
     }
 

common/src/main/java/io/github/notenoughupdates/moulconfig/processor/HasDebugLocation.java

@@ -1,6 +1,12 @@
 package io.github.notenoughupdates.moulconfig.processor;
 
+import org.jetbrains.annotations.Nullable;
+
 @FunctionalInterface
 public interface HasDebugLocation {
+    /**
+     * @return a string identifying the position in code where this option was declared, intended for debugging purposes only
+     */
+    @Nullable
     String getDebugDeclarationLocation();
 }

common/src/main/java/io/github/notenoughupdates/moulconfig/processor/MoulConfigProcessor.java

@@ -28,6 +28,7 @@
 import io.github.notenoughupdates.moulconfig.internal.Warnings;
 import lombok.Getter;
 import lombok.val;
+import lombok.var;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -118,7 +119,7 @@ public void endCategory() {
 
     @Override
     public void beginAccordion(Object baseObject, Field field, ConfigOption option, int id) {
-        ProcessedOption processedOption = createProcessedOption(baseObject, field, option);
+        var processedOption = createProcessedOption(baseObject, field, option);
         // TODO: expose setter in subclass
         processedOption.editor = new GuiOptionEditorAccordion(processedOption, id);
         currentCategory.options.add(processedOption);
@@ -132,7 +133,7 @@ public void endAccordion() {
 
     @Override
     public void emitOption(Object baseObject, Field field, ConfigOption option) {
-        ProcessedOption processedOption = createProcessedOption(baseObject, field, option);
+        var processedOption = createProcessedOption(baseObject, field, option);
         GuiOptionEditor optionGui = createOptionGui(processedOption, field, option);
         if (optionGui == null) {
             Warnings.warn("Could not create GUI Option Editor for " + field + " in " + baseObject.getClass());
@@ -142,8 +143,8 @@ public void emitOption(Object baseObject, Field field, ConfigOption option) {
         currentCategory.options.add(processedOption);
     }
 
-    protected ProcessedOption createProcessedOption(Object baseObject, Field field, ConfigOption option) {
-        ProcessedOption processedOption = new ProcessedOption(
+    protected ProcessedOptionImpl createProcessedOption(Object baseObject, Field field, ConfigOption option) {
+        ProcessedOptionImpl processedOption = new ProcessedOptionImpl(
             option.name(), option.desc(), String.join(".", categoryPath) + "." + field.getName(),
             field,
             currentCategory, baseObject,

common/src/main/java/io/github/notenoughupdates/moulconfig/processor/ProcessedOption.java

@@ -32,95 +32,30 @@
 import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
 
-public class ProcessedOption {// TODO: replace with interface
-    private final String name;
-    private final String desc;
-    private final Field field;
-    private final String path;
-    private final ProcessedCategory category;
-    private final Object container;
-    GuiOptionEditor editor;
-    int accordionId = -1;
-    private boolean isProperty;
-    private Config config;
-
-    /**
-     * @return a string identifying the position in code where this option was declared, intended for debugging purposes only
-     */
-    public String getCodeLocation() {
-        return field.toString();
-    }
+public interface ProcessedOption extends HasDebugLocation {
+    SearchTag[] getSearchTags();
 
-    public ProcessedOption(String name, String desc, String path, Field field, ProcessedCategory category, Object container, Config config) {
-        this.name = name;
-        this.path = path;
-        this.desc = desc;
-        this.category = category;
-        this.config = config;
-        this.field = field;
-        this.container = container;
-        this.isProperty = field.getType() == Property.class;
-    }
+    int getAccordionId();
 
-    public SearchTag[] getSearchTags() {
-        return field.getAnnotationsByType(SearchTag.class);
-    }
+    GuiOptionEditor getEditor();
 
-    private GuiOptionEditorAccordion owningAccordion;
-
-    public GuiOptionEditorAccordion getOwningAccordion() {
-        if (owningAccordion == null && getAccordionId() >= 0) {
-            owningAccordion = getCategory()
-                .getOptions()
-                .stream()
-                .map(ProcessedOption::getEditor)
-                .filter(it -> it instanceof GuiOptionEditorAccordion)
-                .map(it -> (GuiOptionEditorAccordion) it)
-                .filter(it -> it.getAccordionId() == getAccordionId())
-                .findAny()
-                .orElse(null);
-        }
-        return owningAccordion;
-    }
+    ProcessedCategory getCategory();
 
-    public int getAccordionId() {
-        return accordionId;
-    }
+    String getName();
 
-    public GuiOptionEditor getEditor() {
-        return editor;
-    }
+    String getDescription();
 
-    public ProcessedCategory getCategory() {
-        return category;
-    }
+    Config getConfig();
 
-    public String getName() {
-        return name;
-    }
+    Object get();
 
-    public String getDescription() {
-        return desc;
-    }
+    Type getType();
 
-    public Config getConfig() {
-        return config;
-    }
+    boolean set(Object value);
 
-    public Object get() {
-        try {
-            Object obj = field.get(container);
-            if (isProperty) {
-                return ((Property) obj).get();
-            } else {
-                return obj;
-            }
-        } catch (Exception e) {
-            return null;
-        }
-    }
+    void explicitNotifyChange();
 
-    public GetSetter<?> intoProperty() {
+    default GetSetter<?> intoProperty() {
         return new GetSetter<Object>() {
             @Override
             public Object get() {
@@ -134,40 +69,4 @@ public void set(Object newValue) {
         };
     }
 
-    public Type getType() {
-        if (isProperty) {
-            return ((ParameterizedType) field.getGenericType()).getActualTypeArguments()[0];
-        }
-        return field.getGenericType();
-    }
-
-    public boolean set(Object value) {
-        try {
-            Object toSet;
-            if (getType() == int.class && value instanceof Number) {
-                toSet = ((Number) value).intValue();
-            } else {
-                toSet = value;
-            }
-            if (isProperty) {
-                ((Property<Object>) field.get(container)).set(toSet);
-            } else {
-                field.set(container, toSet);
-            }
-            return true;
-        } catch (Exception e) {
-            e.printStackTrace();
-            return false;
-        }
-    }
-
-    public void explicitNotifyChange() {
-        if (isProperty) {
-            try {
-                ((Property<?>) field.get(container)).notifyObservers();
-            } catch (Exception e) {
-                e.printStackTrace();
-            }
-        }
-    }
 }