Gui and setting boilerplate code for filters

rcx · rcx · commit 3f774b5b75ff · 2018-05-31T12:45:47.000-04:00
diff --git a/mapleir/src/main/java/org/mapleir/jdaplugin/DeobfuscateFilter.java b/mapleir/src/main/java/org/mapleir/jdaplugin/DeobfuscateFilter.java
@@ -0,0 +1,16 @@
+package org.mapleir.jdaplugin;
+
+import club.bytecode.the.jda.decompilers.filter.DecompileFilter;
+import org.objectweb.asm.tree.ClassNode;
+
+public class DeobfuscateFilter implements DecompileFilter, MapleComponent {
+    @Override
+    public void process(ClassNode cn) {
+        
+    }
+
+    @Override
+    public String getName() {
+        return "Deobfuscator";
+    }
+}
diff --git a/mapleir/src/main/java/org/mapleir/jdaplugin/ILDecompiler.java b/mapleir/src/main/java/org/mapleir/jdaplugin/ILDecompiler.java
@@ -15,7 +15,7 @@
 import org.objectweb.asm.tree.ClassNode;
 import org.objectweb.asm.tree.MethodNode;
 
-public class ILDecompiler extends JDADecompiler {
+public class ILDecompiler extends JDADecompiler implements MapleComponent {
     @Override
     public String decompileClassNode(FileContainer container, ClassNode cn) {
         TabbedStringWriter sw = new TabbedStringWriter();
diff --git a/mapleir/src/main/java/org/mapleir/jdaplugin/IRDecompiler.java b/mapleir/src/main/java/org/mapleir/jdaplugin/IRDecompiler.java
@@ -1,6 +1,5 @@
 package org.mapleir.jdaplugin;
 
-import club.bytecode.the.jda.api.JDANamespace;
 import club.bytecode.the.jda.decompilers.bytecode.*;
 import org.mapleir.ir.algorithms.BoissinotDestructor;
 import org.mapleir.ir.cfg.ControlFlowGraph;
@@ -12,7 +11,7 @@
 import java.util.Arrays;
 import java.util.Iterator;
 
-public class IRDecompiler extends BytecodeDecompiler {
+public class IRDecompiler extends BytecodeDecompiler implements MapleComponent {
     @Override
     protected MethodNodeDecompiler getMethodNodeDecompiler(PrefixedStringBuilder sb, ClassNode cn, Iterator<MethodNode> it) {
         return new IRMethodDecompiler(this, sb, it.next(), cn);
@@ -22,11 +21,6 @@ protected MethodNodeDecompiler getMethodNodeDecompiler(PrefixedStringBuilder sb,
     public String getName() {
         return "MapleIR";
     }
-    
-    @Override
-    public JDANamespace getNamespace() {
-        return MaplePlugin.getInstance().getNamespace();
-    }
 }
 
 class IRMethodDecompiler extends MethodNodeDecompiler {
diff --git a/mapleir/src/main/java/org/mapleir/jdaplugin/MapleComponent.java b/mapleir/src/main/java/org/mapleir/jdaplugin/MapleComponent.java
@@ -0,0 +1,12 @@
+package org.mapleir.jdaplugin;
+
+import club.bytecode.the.jda.api.JDANamespace;
+import club.bytecode.the.jda.api.JDANamespacedComponent;
+
+// Is this bad design...?
+public interface MapleComponent extends JDANamespacedComponent {
+    @Override
+    default JDANamespace getNamespace() {
+        return MaplePlugin.getInstance().getNamespace();
+    }
+}
diff --git a/mapleir/src/main/java/org/mapleir/jdaplugin/MaplePlugin.java b/mapleir/src/main/java/org/mapleir/jdaplugin/MaplePlugin.java
@@ -4,7 +4,7 @@
 import club.bytecode.the.jda.api.JDAPlugin;
 import club.bytecode.the.jda.api.JDAPluginNamespace;
 import club.bytecode.the.jda.decompilers.Decompilers;
-import club.bytecode.the.jda.decompilers.JDADecompiler;
+import club.bytecode.the.jda.decompilers.filter.DecompileFilters;
 import org.mapleir.DefaultInvocationResolver;
 import org.mapleir.app.client.SimpleApplicationContext;
 import org.mapleir.app.service.ApplicationClassSource;
@@ -22,8 +22,6 @@ public class MaplePlugin implements JDAPlugin {
 	private static MaplePlugin instance;
 	
 	public final Map<FileContainer, AnalysisContext> cxts = new HashMap<>();
-	private final JDADecompiler MAPLEIR = new IRDecompiler();
-	private final JDADecompiler MAPLEIL = new ILDecompiler();
 	public final JDAPluginNamespace namespace = new JDAPluginNamespace(this);
 	
 	public MaplePlugin() {
@@ -50,8 +48,9 @@ public JDAPluginNamespace getNamespace() {
 
 	@Override
 	public void onLoad() {
-		Decompilers.BY_NAME.put("MapleIR", MAPLEIR);
-		Decompilers.BY_NAME.put("MapleIL", MAPLEIL);
+		Decompilers.registerDecompiler(new IRDecompiler());
+		Decompilers.registerDecompiler(new ILDecompiler());
+		DecompileFilters.registerFilter(new DeobfuscateFilter());
 		System.out.println("MapleIR plugin loaded");
 	}
 	
diff --git a/src/main/java/club/bytecode/the/jda/api/JDANamespacedComponent.java b/src/main/java/club/bytecode/the/jda/api/JDANamespacedComponent.java
@@ -6,6 +6,6 @@ public interface JDANamespacedComponent {
     JDANamespace getNamespace();
     
     default String getFullName() {
-        return getName() + ":" + getNamespace();
+        return getNamespace() + ":" + getName();
     }
 }
diff --git a/src/main/java/club/bytecode/the/jda/decompilers/Decompilers.java b/src/main/java/club/bytecode/the/jda/decompilers/Decompilers.java
@@ -8,27 +8,34 @@
 import java.util.Map;
 
 public class Decompilers {
-    public static final Map<String, JDADecompiler> BY_NAME = new LinkedHashMap<>();
+    private static final Map<String, JDADecompiler> BY_NAME = new LinkedHashMap<>();
 
     public final static JDADecompiler PROCYON = new ProcyonDecompiler();
     public final static JDADecompiler CFR = new CFRDecompiler();
     public final static JDADecompiler FERNFLOWER = new FernflowerDecompiler();
     public final static JDADecompiler BYTECODE = new BytecodeDecompiler();
 
+    public static void registerDecompiler(JDADecompiler decompiler) {
+        BY_NAME.put(decompiler.getFullName(), decompiler);
+    }
 
     public static Collection<JDADecompiler> getAllDecompilers() {
         return Collections.unmodifiableCollection(BY_NAME.values());
     }
     
+    /**
+     * @param name the FULL name of the decompiler
+     * @return the decompiler, if found
+     */
     public static JDADecompiler getByName(String name) {
         return BY_NAME.get(name);
     }
     
     static
     {
-        Decompilers.BY_NAME.put(PROCYON.getName(), PROCYON);
-        Decompilers.BY_NAME.put(CFR.getName(), CFR);
-        Decompilers.BY_NAME.put(FERNFLOWER.getName(), FERNFLOWER);
-        Decompilers.BY_NAME.put(BYTECODE.getName(), BYTECODE);
+        registerDecompiler(PROCYON);
+        registerDecompiler(CFR);
+        registerDecompiler(FERNFLOWER);
+        registerDecompiler(BYTECODE);
     }
 }
diff --git a/src/main/java/club/bytecode/the/jda/decompilers/filter/DecompileFilters.java b/src/main/java/club/bytecode/the/jda/decompilers/filter/DecompileFilters.java
@@ -8,10 +8,18 @@
 public class DecompileFilters {
     public static final Map<String, DecompileFilter> BY_NAME = new LinkedHashMap<>();
     
+    public static void registerFilter(DecompileFilter filter) {
+        BY_NAME.put(filter.getFullName(), filter);
+    }
+    
     public static Collection<DecompileFilter> getAllFilters() {
         return Collections.unmodifiableCollection(BY_NAME.values());
     }
-    
+
+    /**
+     * @param name the FULL name of the decompile filter
+     * @return the filter, if found
+     */
     public static DecompileFilter getByName(String name) {
         return BY_NAME.get(name);
     }
diff --git a/src/main/java/club/bytecode/the/jda/gui/MainViewerGUI.java b/src/main/java/club/bytecode/the/jda/gui/MainViewerGUI.java
@@ -7,10 +7,10 @@
 import club.bytecode.the.jda.api.JDAPlugin;
 import club.bytecode.the.jda.decompilers.Decompilers;
 import club.bytecode.the.jda.decompilers.JDADecompiler;
+import club.bytecode.the.jda.gui.components.TabbedPane;
 import club.bytecode.the.jda.gui.dialogs.AboutWindow;
 import club.bytecode.the.jda.gui.dialogs.FontOptionsDialog;
 import club.bytecode.the.jda.gui.dialogs.IntroWindow;
-import club.bytecode.the.jda.gui.dialogs.TabbedPane;
 import club.bytecode.the.jda.gui.fileviewer.FileViewerPane;
 import club.bytecode.the.jda.gui.fileviewer.Viewer;
 import club.bytecode.the.jda.gui.fileviewer.ViewerFile;
@@ -400,7 +400,7 @@ private JMenu generatePane(int id) {
 
         for (JDADecompiler decompiler : Decompilers.getAllDecompilers()) {
             JRadioButtonMenuItem button = new JRadioButtonMenuItem(decompiler.getName());
-            button.addActionListener((e) -> Settings.PANE_DECOMPILERS[id].set(decompiler.getName()));
+            button.addActionListener((e) -> Settings.PANE_DECOMPILERS[id].set(decompiler.getFullName()));
             allDecompilers.get(group).put(button, decompiler);
             allDecompilersRev.get(group).put(decompiler, button);
             group.add(button);
diff --git a/src/main/java/club/bytecode/the/jda/gui/components/TabbedPane.java b/src/main/java/club/bytecode/the/jda/gui/components/TabbedPane.java
@@ -1,4 +1,4 @@
-package club.bytecode.the.jda.gui.dialogs;
+package club.bytecode.the.jda.gui.components;
 
 import javax.swing.*;
 import javax.swing.plaf.basic.BasicButtonUI;
@@ -196,4 +196,4 @@ public void mouseExited(final MouseEvent e) {
         }
     };
 
-}
+}
diff --git a/src/main/java/club/bytecode/the/jda/gui/fileviewer/FileViewerPane.java b/src/main/java/club/bytecode/the/jda/gui/fileviewer/FileViewerPane.java
@@ -5,7 +5,7 @@
 import club.bytecode.the.jda.Resources;
 import club.bytecode.the.jda.gui.JDAWindow;
 import club.bytecode.the.jda.gui.MainViewerGUI;
-import club.bytecode.the.jda.gui.dialogs.TabbedPane;
+import club.bytecode.the.jda.gui.components.TabbedPane;
 import club.bytecode.the.jda.gui.navigation.FileNavigationPane;
 import org.mapleir.stdlib.util.IndexedList;
 import org.objectweb.asm.tree.ClassNode;
diff --git a/src/main/java/club/bytecode/the/jda/settings/JDADecompilerSettings.java b/src/main/java/club/bytecode/the/jda/settings/JDADecompilerSettings.java
@@ -1,13 +1,21 @@
 package club.bytecode.the.jda.settings;
 
 import club.bytecode.the.jda.decompilers.JDADecompiler;
+import club.bytecode.the.jda.decompilers.filter.DecompileFilter;
+import club.bytecode.the.jda.decompilers.filter.DecompileFilters;
+import club.bytecode.the.jda.gui.components.CheckboxList;
+import com.eclipsesource.json.JsonArray;
 import com.eclipsesource.json.JsonObject;
+import com.eclipsesource.json.JsonValue;
 import net.miginfocom.swing.MigLayout;
 
 import javax.swing.*;
 import java.awt.*;
 import java.util.*;
 
+/**
+ * This is a really nasty hack, and must be rewritten to split up the actual settings code, and GUI code
+ */
 public class JDADecompilerSettings {
     private final JDADecompiler decompiler;
 
@@ -22,6 +30,13 @@ public class JDADecompilerSettings {
     private Map<SettingsEntry, JCheckBox> booleanSettings = new HashMap<>();
     private Map<SettingsEntry, JTextArea> stringSettings = new HashMap<>();
     private Map<SettingsEntry, JSpinner> intSettings = new HashMap<>();
+    
+    private static final String PIPELINE_KEY = "_pipeline";
+    private Set<DecompileFilter> enabledFilters = new HashSet<>();
+    private Map<DecompileFilter, JCheckBox> filterCheckboxes = new HashMap<>();
+    private JPanel pipelinePanel;
+    private JScrollPane pipelineListbox;
+    private CheckboxList availFilters;
 
     public JDADecompilerSettings(JDADecompiler decompiler) {
         this.decompiler = decompiler;
@@ -97,7 +112,32 @@ public void registerSetting(SettingsEntry entry) {
         dialog.add(new JLabel(entry.name), "wrap");
     }
 
+    /**
+     * This must be called OUTSIDE the constructor, because otherwise it will get called BEFORE any plugins load.
+     */
+    private void initPipelineGui() {
+        pipelinePanel = new JPanel(new MigLayout("gap rel 0", "grow"));
+        pipelinePanel.add(new JLabel("Preprocessing Pipeline"), "wrap");
+        availFilters = new CheckboxList();
+        for (DecompileFilter filter : DecompileFilters.getAllFilters()) {
+            JCheckBox checkbox = new JCheckBox(filter.getFullName());
+            checkbox.addItemListener((e) -> {
+                if (checkbox.isEnabled())
+                    enabledFilters.add(filter);
+                else
+                    enabledFilters.remove(filter);
+            });
+            filterCheckboxes.put(filter, checkbox);
+            availFilters.addCheckbox(checkbox);
+        }
+        pipelineListbox = new JScrollPane(availFilters);
+        pipelinePanel.add(pipelineListbox, "spanx, grow");
+        dialog.add(pipelinePanel, "align center, spanx, grow, wrap");
+    }
+
     public void loadFrom(JsonObject rootSettings) {
+        initPipelineGui();
+        
         if (rootSettings.get("decompilers") != null) {
             JsonObject decompilerSection = rootSettings.get("decompilers").asObject();
             if (decompilerSection.get(decompiler.getName()) != null) {
@@ -120,6 +160,19 @@ public void loadFrom(JsonObject rootSettings) {
                         entry.getValue().setValue(thisDecompiler.get(entry.getKey().key).asInt());
                     }
                 }
+                
+                if (thisDecompiler.get(PIPELINE_KEY) != null) {
+                    JsonArray array = thisDecompiler.get(PIPELINE_KEY).asArray();
+                    for (JsonValue value : array) {
+                        if (!value.isString())
+                            continue;
+                        DecompileFilter filter = DecompileFilters.getByName(value.asString());
+                        if (filter != null) {
+                            enabledFilters.add(filter);
+                            filterCheckboxes.get(filter).setSelected(true);
+                        }
+                    }
+                }
             }
         }
     }
@@ -142,6 +195,12 @@ public void saveTo(JsonObject rootSettings) {
         for (Map.Entry<SettingsEntry, JSpinner> entry : intSettings.entrySet()) {
             thisDecompiler.add(entry.getKey().key, (Integer)entry.getValue().getValue());
         }
+        
+        JsonArray pipelineArray = new JsonArray();
+        for (DecompileFilter filter : enabledFilters) {
+            pipelineArray.add(filter.getFullName());
+        }
+        thisDecompiler.add(PIPELINE_KEY, pipelineArray);
     }
 
     // TODO: Refactor to have a default entry class for each type of entry, etc.
diff --git a/src/main/java/club/bytecode/the/jda/settings/Settings.java b/src/main/java/club/bytecode/the/jda/settings/Settings.java
@@ -39,8 +39,8 @@ public class Settings {
     static
     {
         PANE_DECOMPILERS = new Setting[MainViewerGUI.NUM_PANEL_GROUPS]; // bleh
-        PANE_DECOMPILERS[0] = new Setting("panedecompiler0", Decompilers.FERNFLOWER.getName());
-        PANE_DECOMPILERS[1] = new Setting("panedecompiler1", Decompilers.BYTECODE.getName());
+        PANE_DECOMPILERS[0] = new Setting("panedecompiler0", Decompilers.FERNFLOWER.getFullName());
+        PANE_DECOMPILERS[1] = new Setting("panedecompiler1", Decompilers.BYTECODE.getFullName());
         for (int i = 2; i < PANE_DECOMPILERS.length; i++)
             PANE_DECOMPILERS[i] = new Setting("panedecompiler" + i, "None");
         

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@ public interface JDANamespacedComponent {`
`6`	`6`	`JDANamespace getNamespace();`
`7`	`7`
`8`	`8`	`default String getFullName() {`
`9`		`- return getName() + ":" + getNamespace();`
	`9`	`+ return getNamespace() + ":" + getName();`
`10`	`10`	`}`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package club.bytecode.the.jda.gui.dialogs;`
	`1`	`+package club.bytecode.the.jda.gui.components;`
`2`	`2`
`3`	`3`	`import javax.swing.*;`
`4`	`4`	`import javax.swing.plaf.basic.BasicButtonUI;`
`@@ -196,4 +196,4 @@ public void mouseExited(final MouseEvent e) {`
`196`	`196`	`}`
`197`	`197`	`};`
`198`	`198`
`199`		`-}`
	`199`	`+}`