Add built-in user interface with randomize & legality options (#9 & #16)

Author: kuroppoi

build.gradle

@@ -30,6 +30,8 @@ dependencies {
     implementation 'com.formdev:flatlaf:3.1.1'
     implementation 'com.formdev:flatlaf-extras:3.1.1'
     implementation 'com.formdev:flatlaf-intellij-themes:3.1.1'
+    implementation 'com.miglayout:miglayout-swing:4.2' // Finally, a good fucking layout manager.
+    implementation 'org.swinglabs.swingx:swingx-autocomplete:1.6.5-1'
 }
 
 sourceSets {

src/main/java/entralinked/Entralinked.java

@@ -14,7 +14,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 
-import entralinked.gui.MainView;
+import entralinked.gui.view.MainView;
 import entralinked.model.dlc.DlcList;
 import entralinked.model.player.PlayerManager;
 import entralinked.model.user.UserManager;
@@ -119,7 +119,6 @@ public Entralinked(String[] args) {
 
             if(mainView != null) {
                 SwingUtilities.invokeLater(() -> {
-                    mainView.setDashboardButtonEnabled(true);
                     mainView.setStatusLabelText("Configure your DS to use the following DNS server: %s".formatted(hostIpAddress));
                 });
             }

src/main/java/entralinked/GameVersion.java

@@ -4,7 +4,7 @@
 import java.util.Map;
 
 public enum GameVersion {
-        
+    
     // ==================================
     // Black Version & White Version
     // ==================================
@@ -29,21 +29,35 @@ public enum GameVersion {
     // Black Version 2 & White Version 2
     // ==================================
 
-    BLACK_2_JAPANESE(23, 1, "IREJ", "ブラック2", true),
-    BLACK_2_ENGLISH(23, 2, "IREO", "Black Version 2", true),
-    BLACK_2_FRENCH(23, 3, "IREF", "Version Noire 2", true),
-    BLACK_2_ITALIAN(23, 4, "IREI", "Versione Nera 2", true),
-    BLACK_2_GERMAN(23, 5, "IRED", "Schwarze Edition 2", true),
-    BLACK_2_SPANISH(23, 7, "IRES", "Edicion Negra 2", true),
-    BLACK_2_KOREAN(23, 8, "IREK", "블랙2", true),
-    
-    WHITE_2_JAPANESE(22, 1, "IRDJ", "ホワイト2", true),
-    WHITE_2_ENGLISH(22, 2, "IRDO", "White Version 2", true),
-    WHITE_2_FRENCH(22, 3, "IRDF", "Version Blanche 2", true),
-    WHITE_2_ITALIAN(22, 4, "IRDI", "Versione Bianca 2", true),
-    WHITE_2_GERMAN(22, 5, "IRDD", "Weisse Edition 2", true),
-    WHITE_2_SPANISH(22, 7, "IRDS", "Edicion Blanca 2", true),
-    WHITE_2_KOREAN(22, 8, "IRDK", "화이트2", true);
+    BLACK_2_JAPANESE(23, 1, "IREJ", "ブラック2"),
+    BLACK_2_ENGLISH(23, 2, "IREO", "Black Version 2"),
+    BLACK_2_FRENCH(23, 3, "IREF", "Version Noire 2"),
+    BLACK_2_ITALIAN(23, 4, "IREI", "Versione Nera 2"),
+    BLACK_2_GERMAN(23, 5, "IRED", "Schwarze Edition 2"),
+    BLACK_2_SPANISH(23, 7, "IRES", "Edicion Negra 2"),
+    BLACK_2_KOREAN(23, 8, "IREK", "블랙2"),
+    
+    WHITE_2_JAPANESE(22, 1, "IRDJ", "ホワイト2"),
+    WHITE_2_ENGLISH(22, 2, "IRDO", "White Version 2"),
+    WHITE_2_FRENCH(22, 3, "IRDF", "Version Blanche 2"),
+    WHITE_2_ITALIAN(22, 4, "IRDI", "Versione Bianca 2"),
+    WHITE_2_GERMAN(22, 5, "IRDD", "Weisse Edition 2"),
+    WHITE_2_SPANISH(22, 7, "IRDS", "Edicion Blanca 2"),
+    WHITE_2_KOREAN(22, 8, "IRDK", "화이트2");
+    
+    // Masks
+    public static final int BW_MASK = 0b110011111111;
+    public static final int B2W2_MASK = 0b001111111111;
+    public static final int ALL_MASK = BW_MASK | B2W2_MASK;
+    public static final int JAP_MASK = 0b111100000001;
+    public static final int ENG_MASK = 0b111100000010;
+    public static final int FRE_MASK = 0b111100000100;
+    public static final int ITA_MASK = 0b111100001000;
+    public static final int GER_MASK = 0b111100010000;
+    public static final int SPA_MASK = 0b111101000000;
+    public static final int KOR_MASK = 0b111110000000;
+    public static final int JAP_KOR_MASK = JAP_MASK | KOR_MASK;
+    public static final int NA_EUR_MASK = ENG_MASK | FRE_MASK | ITA_MASK | GER_MASK | SPA_MASK;
 
     // Lookup maps
     private static final Map<String, GameVersion> mapBySerial = new HashMap<>();
@@ -52,34 +66,32 @@ public enum GameVersion {
     static {
         for(GameVersion version : values()) {
             mapBySerial.put(version.getSerial(), version);
-            mapByCodes.put(version.getRomCode() << version.getLanguageCode(), version);
+            mapByCodes.put(version.getBits(), version);
         }
     }
 
     private final int romCode;
     private final int languageCode; // Values are not tested
     private final String serial;
     private final String displayName;
-    private final boolean isVersion2;
 
-    private GameVersion(int romCode, int languageCode, String serial, String displayName, boolean isVersion2) {
+    private GameVersion(int romCode, int languageCode, String serial, String displayName) {
         this.romCode = romCode;
         this.languageCode = languageCode;
         this.serial = serial;
         this.displayName = displayName;
-        this.isVersion2 = isVersion2;
-    }
-    
-    private GameVersion(int romCode, int languageCode, String serial, String displayName) {
-        this(romCode, languageCode, serial, displayName, false);
     }
 
     public static GameVersion lookup(String serial) {
         return mapBySerial.get(serial);
     }
 
     public static GameVersion lookup(int romCode, int languageCode) {
-        return mapByCodes.get(romCode << languageCode);
+        return mapByCodes.get(getBits(romCode, languageCode));
+    }
+    
+    private static int getBits(int romCode, int languageCode) {
+        return (1 << (8 - (romCode - 23))) | (1 << languageCode - 1) & 0b111111111111;
     }
 
     public int getRomCode() {
@@ -99,6 +111,15 @@ public String getDisplayName() {
     }
 
     public boolean isVersion2() {
-        return isVersion2;
+        return checkMask(B2W2_MASK);
+    }
+    
+    public boolean checkMask(int mask) {
+        int bits = getBits();
+        return (bits & mask) == bits;
+    }
+    
+    public int getBits() {
+        return getBits(romCode, languageCode);
     }
 }

src/main/java/entralinked/gui/FileChooser.java

@@ -0,0 +1,55 @@
+package entralinked.gui;
+
+import java.awt.Component;
+import java.io.File;
+import java.util.Collections;
+import java.util.List;
+import java.util.function.Consumer;
+import java.util.function.Function;
+
+import javax.swing.JFileChooser;
+import javax.swing.filechooser.FileFilter;
+
+public class FileChooser {
+    
+    private static final JFileChooser fileChooser = new JFileChooser(".");
+    
+    public static void showFileOpenDialog(Component parent, Consumer<FileSelection> handler) {
+        showFileOpenDialog(parent, Collections.emptyList(), handler);
+    }
+    
+    public static void showFileOpenDialog(Component parent, FileFilter fileFilter, Consumer<FileSelection> handler) {
+        showFileOpenDialog(parent, List.of(fileFilter), handler);
+    }
+    
+    public static void showFileOpenDialog(Component parent, List<FileFilter> fileFilters, Consumer<FileSelection> handler) {
+        showDialog(parent, fileFilters, fileChooser::showOpenDialog, handler);
+    }
+    
+    private static void showDialog(Component parent, List<FileFilter> fileFilters, Function<Component, Integer> dialogFunction, Consumer<FileSelection> handler) {
+        FileFilter currentFilter = fileChooser.getFileFilter();
+        fileChooser.resetChoosableFileFilters();
+        fileChooser.setAcceptAllFileFilterUsed(fileFilters.isEmpty());
+        fileFilters.forEach(fileChooser::addChoosableFileFilter);
+        
+        if(fileFilters.contains(currentFilter)) {
+            fileChooser.setFileFilter(currentFilter);
+        }
+        
+        if(dialogFunction.apply(parent) == JFileChooser.APPROVE_OPTION) {
+            File file = fileChooser.getSelectedFile();
+            handler.accept(new FileSelection(file, fileChooser.getFileFilter(), getFileExtension(file)));
+        }
+    }
+    
+    public static String getFileExtension(File file) {
+        String name = file.getName();
+        int index = name.lastIndexOf('.');
+        
+        if(index == -1 || index + 1 == name.length()) {
+            return null;
+        }
+        
+        return name.substring(index + 1).toLowerCase();
+    }
+}

src/main/java/entralinked/gui/FileSelection.java

@@ -0,0 +1,7 @@
+package entralinked.gui;
+
+import java.io.File;
+
+import javax.swing.filechooser.FileFilter;
+
+public record FileSelection(File file, FileFilter filter, String extension) {}

src/main/java/entralinked/gui/ImageLoader.java

@@ -0,0 +1,60 @@
+package entralinked.gui;
+
+import java.awt.FontMetrics;
+import java.awt.Graphics2D;
+import java.awt.RenderingHints;
+import java.awt.image.BufferedImage;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.imageio.ImageIO;
+
+import entralinked.gui.data.DataManager;
+
+public class ImageLoader {
+    
+    private static final Map<String, BufferedImage> cache = new HashMap<>();
+    
+    public static BufferedImage getImage(String path) {
+        return cache.computeIfAbsent(path, ImageLoader::loadImage);
+    }
+    
+    private static BufferedImage loadImage(String path) {        
+        try {
+            return ImageIO.read(DataManager.class.getResource(path));
+        } catch(Exception e) {
+            BufferedImage image = new BufferedImage(128, 128, BufferedImage.TYPE_INT_ARGB);
+            Graphics2D graphics = image.createGraphics();
+            graphics.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
+            graphics.drawString("IMAGE LOAD ERROR", 0, 16);
+            graphics.drawString("Please report this!", 0, 124);
+            drawWrappedString(graphics, path, 0, 32, image.getWidth());
+            drawWrappedString(graphics, e.getMessage(), 0, 80, image.getWidth());
+            graphics.dispose();
+            return image;
+        }
+    }
+    
+    private static void drawWrappedString(Graphics2D graphics, String string, int x, int y, int width) {
+        int length = string.length();
+        FontMetrics metrics = graphics.getFontMetrics();
+        String line = "";
+        int currentY = y;
+        
+        for(int i = 0; i < length; i++) {
+            char next = string.charAt(i);
+            
+            if((!line.isEmpty() && x + metrics.stringWidth(line + next) >= width)) {
+                graphics.drawString(line, x, currentY);
+                line = "";
+                currentY += metrics.getHeight();
+            }
+            
+            line += next;
+            
+            if(i + 1 == length) {
+                graphics.drawString(line, x, currentY);
+            }
+        }
+    }
+}

src/main/java/entralinked/gui/InputVerifierCellEditor.java

@@ -0,0 +1,25 @@
+package entralinked.gui;
+
+import javax.swing.DefaultCellEditor;
+import javax.swing.InputVerifier;
+import javax.swing.JTextField;
+
+@SuppressWarnings("serial")
+public class InputVerifierCellEditor extends DefaultCellEditor {
+
+    private final InputVerifier verifier;
+    
+    public InputVerifierCellEditor(InputVerifier verifier) {
+        this(verifier, new JTextField());
+    }
+    
+    public InputVerifierCellEditor(InputVerifier verifier, JTextField textField) {
+        super(textField);
+        this.verifier = verifier;
+    }
+    
+    @Override
+    public boolean stopCellEditing() {
+        return verifier.verify(editorComponent) && super.stopCellEditing();
+    }
+}

src/main/java/entralinked/gui/ModelListCellRenderer.java

@@ -0,0 +1,38 @@
+package entralinked.gui;
+
+import java.awt.Component;
+import java.awt.Font;
+import java.util.function.Function;
+
+import javax.swing.DefaultListCellRenderer;
+import javax.swing.JList;
+
+import entralinked.utility.SwingUtility;
+
+@SuppressWarnings({"serial", "unchecked"})
+public class ModelListCellRenderer<T> extends DefaultListCellRenderer {
+    
+    private final Class<T> type;
+    private final Function<T, String> textSupplier;
+    private final String nullValue;
+    
+    public ModelListCellRenderer(Class<T> type, Function<T, String> textSupplier, String nullValue) {
+        this.type = type;
+        this.textSupplier = textSupplier;
+        this.nullValue = nullValue;
+    }
+    
+    @Override
+    public Component getListCellRendererComponent(JList<?> list, Object value, int index, boolean isSelected, boolean cellHasFocus) {
+        Component component = super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
+        setText(value == null ? String.valueOf(nullValue) : type.isAssignableFrom(value.getClass()) ? textSupplier.apply((T)value) : String.valueOf(value));
+        Font font = component.getFont();
+        String text = getText();
+        
+        if(font.canDisplayUpTo(text) != -1) {
+            component.setFont(SwingUtility.findSupportingFont(text, font));
+        }
+        
+        return component;
+    }
+}

src/main/java/entralinked/gui/ModelTableCellRenderer.java

@@ -0,0 +1,38 @@
+package entralinked.gui;
+
+import java.awt.Component;
+import java.awt.Font;
+import java.util.function.Function;
+
+import javax.swing.JTable;
+import javax.swing.table.DefaultTableCellRenderer;
+
+import entralinked.utility.SwingUtility;
+
+@SuppressWarnings({"serial", "unchecked"})
+public class ModelTableCellRenderer<T> extends DefaultTableCellRenderer {
+    
+    private final Class<T> type;
+    private final Function<T, String> textSupplier;
+    private final String nullValue;
+    
+    public ModelTableCellRenderer(Class<T> type, Function<T, String> textSupplier, String nullValue) {
+        this.type = type;
+        this.textSupplier = textSupplier;
+        this.nullValue = nullValue;
+    }
+    
+    @Override
+    public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
+        Component component = super.getTableCellRendererComponent(table, value, isSelected, hasFocus, row, column);
+        setText(value == null ? String.valueOf(nullValue) : type.isAssignableFrom(value.getClass()) ? textSupplier.apply((T)value) : String.valueOf(value));
+        Font font = component.getFont();
+        String text = getText();
+        
+        if(font.canDisplayUpTo(text) != -1) {
+            component.setFont(SwingUtility.findSupportingFont(text, font));
+        }
+        
+        return component;
+    }
+}