theme builder & drawable to json

Author: brachy84

TODO.md

@@ -1,37 +1,33 @@
 # ModularUI TODO's
 
-:boom: = Potential breaking changes
-
 ## Widgets
 
-* [ ]  Trackpad 
-* [X]  improve List (column but scrollable) :boom:
-* [X]  improve Sortable List (for bogosorter) :boom:
-* [X]  improve Slot Group (Builder, sorting) :boom:
-* [X]  improve Dialog :boom:
-* [X]  improve Popup menu :boom:
+* [ ]  Context Menu
 * [ ]  Dropdown menu
+* [ ]  Trackpad
 * [ ]  Pie menu
 
+## High Priority
+- [ ]  merge animations with NEA
+- [ ]  check JEI click interactions
+
 ## Medium Priority
 
-- [ ]  texture json registry improvements :boom:
 - [ ]  Entity drawable
-- [ ]  Fake world drawable
-- [ ]  Text editor :boom:
+- [ ]  Text editor
 - [ ]  Json Guis
-- [ ]  Inject to any mc gui :boom:
+- [ ]  Inject to any mc gui
 - [ ]  Error handling with on-screen reports
 
 ## Low Priority
 
 - [ ]  Config lib
 - [ ]  Keybind api
 - [ ]  create JEI UIs (?)
-- [ ]  properly add modularui elements to any gui screen
+- [x]  properly add modularui elements to any gui screen (possible with overlays currently)
 - [ ]  a gui to create guis
 - [ ]  sounds ?
 
-## HoloUI :boom:
+## HoloUI
 - [ ] Fix/Remove current rotations
 - [ ] Implement interactions

src/main/java/com/cleanroommc/modularui/api/IThemeApi.java

@@ -17,6 +17,31 @@
  */
 public interface IThemeApi {
 
+    // widget themes
+    String FALLBACK = "default";
+    String PANEL = "panel";
+    String BUTTON = "button";
+    String ITEM_SLOT = "itemSlot";
+    String FLUID_SLOT = "fluidSlot";
+    String TEXT_FIELD = "textField";
+    String TOGGLE_BUTTON = "toggleButton";
+
+    // properties
+    String PARENT = "parent";
+    String BACKGROUND = "background";
+    String HOVER_BACKGROUND = "hoverBackground";
+    String COLOR = "color";
+    String TEXT_COLOR = "textColor";
+    String TEXT_SHADOW = "textShadow";
+    String SLOT_HOVER_COLOR = "slotHoverColor";
+    String MARKED_COLOR = "markedColor";
+    String HINT_COLOR = "hintColor";
+    String SELECTED_BACKGROUND = "selectedBackground";
+    String SELECTED_HOVER_BACKGROUND = "selectedHoverBackground";
+    String SELECTED_COLOR = "selectedColor";
+    String SELECTED_TEXT_COLOR = "selectedTextColor";
+    String SELECTED_TEXT_SHADOW = "selectedTextShadow";
+
     /**
      * @return the default api implementation
      */

src/main/java/com/cleanroommc/modularui/api/drawable/IDrawable.java

@@ -33,11 +33,11 @@ static IDrawable of(IDrawable... drawables) {
     /**
      * Draws this drawable at the given position with the given size.
      *
-     * @param context current context to draw with
-     * @param x       x position
-     * @param y       y position
-     * @param width   draw width
-     * @param height  draw height
+     * @param context     current context to draw with
+     * @param x           x position
+     * @param y           y position
+     * @param width       draw width
+     * @param height      draw height
      * @param widgetTheme current theme
      */
     @SideOnly(Side.CLIENT)
@@ -86,8 +86,8 @@ default void draw(GuiContext context, Area area) {
     /**
      * Draws this drawable in a given area.
      *
-     * @param context current context to draw with
-     * @param area    draw area
+     * @param context     current context to draw with
+     * @param area        draw area
      * @param widgetTheme current theme
      */
     @SideOnly(Side.CLIENT)
@@ -107,8 +107,8 @@ default void drawAtZero(GuiContext context, Area area) {
     /**
      * Draws this drawable at the current (0|0) with the given area's size.
      *
-     * @param context gui context
-     * @param area    draw area
+     * @param context     gui context
+     * @param area        draw area
      * @param widgetTheme current theme
      */
     @SideOnly(Side.CLIENT)
@@ -144,6 +144,16 @@ default Icon asIcon() {
      */
     default void loadFromJson(JsonObject json) {}
 
+    /**
+     * Writes all json data necessary so that deserializing it results in the same drawable.
+     *
+     * @param json json to write to
+     * @return if the drawable was serialized
+     */
+    default boolean saveToJson(JsonObject json) {
+        return false;
+    }
+
     /**
      * An empty drawable. Does nothing.
      */

src/main/java/com/cleanroommc/modularui/drawable/AdaptableUITexture.java

@@ -4,6 +4,8 @@
 import net.minecraft.client.renderer.GlStateManager;
 import net.minecraft.util.ResourceLocation;
 
+import com.google.gson.JsonObject;
+
 public class AdaptableUITexture extends UITexture {
 
     private final int imageWidth, imageHeight, bl, bt, br, bb;
@@ -153,4 +155,18 @@ public void drawTiled(float x, float y, float width, float height) {
         GlStateManager.disableBlend();
         GlStateManager.enableAlpha();
     }
+
+    @Override
+    public boolean saveToJson(JsonObject json) {
+        super.saveToJson(json);
+        if (json.entrySet().size() == 1) return true;
+        json.addProperty("imageWidth", this.imageWidth);
+        json.addProperty("imageHeight", this.imageHeight);
+        json.addProperty("bl", this.bl);
+        json.addProperty("br", this.br);
+        json.addProperty("bt", this.bt);
+        json.addProperty("bb", this.bb);
+        json.addProperty("tiled", this.tiled);
+        return true;
+    }
 }

src/main/java/com/cleanroommc/modularui/drawable/Circle.java

@@ -22,24 +22,44 @@ public Circle() {
         this.segments = 40;
     }
 
-    @Contract("_ -> this")
     public Circle setColorInner(int colorInner) {
+        return colorInner(colorInner);
+    }
+
+    public Circle setColorOuter(int colorOuter) {
+        return colorOuter(colorOuter);
+    }
+
+    public Circle setColor(int inner, int outer) {
+        return color(inner, outer);
+    }
+
+    public Circle setSegments(int segments) {
+        return segments(segments);
+    }
+
+    @Contract("_ -> this")
+    public Circle colorInner(int colorInner) {
         this.colorInner = colorInner;
         return this;
     }
 
-    public Circle setColorOuter(int colorOuter) {
+    public Circle colorOuter(int colorOuter) {
         this.colorOuter = colorOuter;
         return this;
     }
 
-    public Circle setColor(int inner, int outer) {
+    public Circle color(int inner, int outer) {
         this.colorInner = inner;
         this.colorOuter = outer;
         return this;
     }
 
-    public Circle setSegments(int segments) {
+    public Circle color(int color) {
+        return color(color, color);
+    }
+
+    public Circle segments(int segments) {
         this.segments = segments;
         return this;
     }
@@ -56,4 +76,12 @@ public void loadFromJson(JsonObject json) {
         this.colorOuter = JsonHelper.getColor(json, Color.WHITE.main, "colorOuter", "color");
         this.segments = JsonHelper.getInt(json, 40, "segments");
     }
+
+    @Override
+    public boolean saveToJson(JsonObject json) {
+        json.addProperty("colorInner", this.colorInner);
+        json.addProperty("colorOuter", this.colorOuter);
+        json.addProperty("segments", this.segments);
+        return true;
+    }
 }

src/main/java/com/cleanroommc/modularui/drawable/DrawableArray.java

@@ -4,6 +4,8 @@
 import com.cleanroommc.modularui.screen.viewport.GuiContext;
 import com.cleanroommc.modularui.theme.WidgetTheme;
 
+import com.google.gson.JsonObject;
+
 import net.minecraftforge.fml.relauncher.Side;
 import net.minecraftforge.fml.relauncher.SideOnly;
 
@@ -38,4 +40,11 @@ public boolean canApplyTheme() {
     public IDrawable[] getDrawables() {
         return this.drawables;
     }
+
+    @Override
+    public boolean saveToJson(JsonObject json) {
+        // serialized as special case
+        // this method should never be called
+        throw new IllegalStateException();
+    }
 }

src/main/java/com/cleanroommc/modularui/drawable/DrawableSerialization.java

@@ -19,43 +19,69 @@
 
 public class DrawableSerialization implements JsonSerializer<IDrawable>, JsonDeserializer<IDrawable> {
 
-    private static final Map<String, Function<JsonObject, IDrawable>> DRAWABLE_TYPES = new Object2ObjectOpenHashMap<>();
+    private static final Map<String, Function<JsonObject, ? extends IDrawable>> DRAWABLE_TYPES = new Object2ObjectOpenHashMap<>();
+    private static final Map<Class<? extends IDrawable>, String> REVERSE_DRAWABLE_TYPES = new Object2ObjectOpenHashMap<>();
     private static final Map<String, UITexture> TEXTURES = new Object2ObjectOpenHashMap<>();
+    private static final Map<UITexture, String> REVERSE_TEXTURES = new Object2ObjectOpenHashMap<>();
 
     public static void registerTexture(String s, UITexture texture) {
         TEXTURES.put(s, texture);
+        REVERSE_TEXTURES.put(texture, s);
     }
 
     public static UITexture getTexture(String s) {
         return TEXTURES.get(s);
     }
 
-    public static void registerDrawableType(String id, Function<@NotNull JsonObject, @NotNull IDrawable> creator) {
+    public static String getTextureId(UITexture texture) {
+        return REVERSE_TEXTURES.get(texture);
+    }
+
+    public static <T extends IDrawable> void registerDrawableType(String id, Class<T> type, Function<@NotNull JsonObject, @NotNull T> creator) {
         if (DRAWABLE_TYPES.containsKey(id)) {
             throw new IllegalArgumentException("Drawable type '" + id + "' already exists!");
         }
         DRAWABLE_TYPES.put(id, creator);
+        if (type != null) {
+            REVERSE_DRAWABLE_TYPES.put(type, id);
+        }
     }
 
     @ApiStatus.Internal
     public static void init() {
-        registerDrawableType("empty", json -> IDrawable.EMPTY);
-        registerDrawableType("null", json -> IDrawable.EMPTY);
-        registerDrawableType("none", json -> IDrawable.NONE);
-        registerDrawableType("texture", UITexture::parseFromJson);
-        registerDrawableType("color", json -> new Rectangle());
-        registerDrawableType("rectangle", json -> new Rectangle());
-        registerDrawableType("ellipse", json -> new Circle());
-        registerDrawableType("text", DrawableSerialization::parseText);
-        registerDrawableType("item", ItemDrawable::ofJson);
-        registerDrawableType("icon", Icon::ofJson);
+        registerDrawableType("empty", IDrawable.class, json -> IDrawable.EMPTY);
+        registerDrawableType("null", null, json -> IDrawable.EMPTY);
+        registerDrawableType("none", null, json -> IDrawable.NONE);
+        registerDrawableType("texture", UITexture.class, UITexture::parseFromJson);
+        registerDrawableType("color", null, json -> new Rectangle());
+        registerDrawableType("rectangle", Rectangle.class, json -> new Rectangle());
+        registerDrawableType("ellipse", Circle.class, json -> new Circle());
+        registerDrawableType("text", IKey.class, DrawableSerialization::parseText);
+        registerDrawableType("item", ItemDrawable.class, ItemDrawable::ofJson);
+        registerDrawableType("icon", Icon.class, Icon::ofJson);
+    }
+
+    public static IDrawable deserialize(JsonElement json) {
+        return JsonHelper.deserialize(json, IDrawable.class);
+    }
+
+    public static JsonElement serialize(IDrawable drawable) {
+        return JsonHelper.serialize(drawable);
     }
 
     @Override
     public IDrawable deserialize(JsonElement element, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
         if (element.isJsonNull()) {
             return IDrawable.EMPTY;
         }
+        if (element.isJsonPrimitive()) {
+            if ("empty".equals(element.getAsString()) || "null".equals(element.getAsString())) {
+                return IDrawable.EMPTY;
+            }
+            if ("none".equals(element.getAsString())) {
+                return IDrawable.NONE;
+            }
+        }
         if (element.isJsonArray()) {
             List<IDrawable> list = new ArrayList<>();
             for (JsonElement element1 : element.getAsJsonArray()) {
@@ -92,7 +118,36 @@ public IDrawable deserialize(JsonElement element, Type typeOfT, JsonDeserializat
 
     @Override
     public JsonElement serialize(IDrawable src, Type typeOfSrc, JsonSerializationContext context) {
-        throw new UnsupportedOperationException();
+        if (src == IDrawable.EMPTY) return JsonNull.INSTANCE;
+        if (src == IDrawable.NONE) return new JsonPrimitive("none");
+        if (src instanceof DrawableArray drawableArray) {
+            JsonArray jsonArray = new JsonArray();
+            for (IDrawable drawable : drawableArray.getDrawables()) {
+                jsonArray.add(JsonHelper.serialize(drawable));
+            }
+            return jsonArray;
+        }
+        JsonObject json = new JsonObject();
+        if (src instanceof IKey) {
+            json.addProperty("type", "text");
+        } else {
+            Class<?> type = src.getClass();
+            String key = REVERSE_DRAWABLE_TYPES.get(type);
+            while (key == null && type != null && type != Object.class) {
+                type = type.getSuperclass();
+                key = REVERSE_DRAWABLE_TYPES.get(type);
+            }
+            if (key == null) {
+                ModularUI.LOGGER.error("Serialization of drawable {} failed, because a key for the type could not be found!", src.getClass().getSimpleName());
+                return JsonNull.INSTANCE;
+            }
+            json.addProperty("type", key);
+        }
+
+        if (!src.saveToJson(json)) {
+            ModularUI.LOGGER.error("Serialization of drawable {} failed!", src.getClass().getSimpleName());
+        }
+        return json;
     }
 
     private static IKey parseText(JsonObject json) throws JsonParseException {

src/main/java/com/cleanroommc/modularui/drawable/Icon.java

@@ -159,6 +159,19 @@ public static Icon ofJson(JsonObject json) {
         return JsonHelper.deserialize(json, IDrawable.class, IDrawable.EMPTY, "drawable", "icon").asIcon();
     }
 
+    @Override
+    public boolean saveToJson(JsonObject json) {
+        json.add("drawable", JsonHelper.serialize(this.drawable));
+        json.addProperty("width", this.width);
+        json.addProperty("height", this.height);
+        json.add("alignment", JsonHelper.serialize(this.alignment));
+        json.addProperty("marginTop", this.margin.top);
+        json.addProperty("marginBottom", this.margin.bottom);
+        json.addProperty("marginLeft", this.margin.left);
+        json.addProperty("marginRight", this.margin.right);
+        return true;
+    }
+
     @Override
     public String toString() {
         return getClass().getSimpleName() + "(" + this.drawable.getClass().getSimpleName() + ")";