Merge pull request #331 from YanisBft/structure-panel

Structure panel

8 files changed, 202 insertions, 15 deletions

diff --git a/enigma/src/main/java/cuchaz/enigma/EnigmaProject.java b/enigma/src/main/java/cuchaz/enigma/EnigmaProject.java
index fcd2c96..a01eca1 100644
--- a/enigma/src/main/java/cuchaz/enigma/EnigmaProject.java
+++ b/enigma/src/main/java/cuchaz/enigma/EnigmaProject.java
@@ -18,6 +18,7 @@ import java.util.stream.Stream;
 
 import com.google.common.base.Functions;
 import com.google.common.base.Preconditions;
+import cuchaz.enigma.api.service.ObfuscationTestService;
 import cuchaz.enigma.classprovider.ObfuscationFixClassProvider;
 import org.objectweb.asm.ClassWriter;
 import org.objectweb.asm.tree.ClassNode;
@@ -158,6 +159,35 @@ public class EnigmaProject {
                 return obfReference.isNamed() && isRenamable(obfReference.getNameableEntry());
         }
 
+        public boolean isObfuscated(Entry<?> entry) {
+                String name = entry.getName();
+
+                List<ObfuscationTestService> obfuscationTestServices = this.getEnigma().getServices().get(ObfuscationTestService.TYPE);
+                if (!obfuscationTestServices.isEmpty()) {
+                        for (ObfuscationTestService service : obfuscationTestServices) {
+                                if (service.testDeobfuscated(entry)) {
+                                        return false;
+                                }
+                        }
+                }
+
+                List<NameProposalService> nameProposalServices = this.getEnigma().getServices().get(NameProposalService.TYPE);
+                if (!nameProposalServices.isEmpty()) {
+                        for (NameProposalService service : nameProposalServices) {
+                                if (service.proposeName(entry, mapper).isPresent()) {
+                                        return false;
+                                }
+                        }
+                }
+
+                String mappedName = mapper.deobfuscate(entry).getName();
+                if (mappedName != null && !mappedName.isEmpty() && !mappedName.equals(name)) {
+                        return false;
+                }
+
+                return true;
+        }
+
         public JarExport exportRemappedJar(ProgressListener progress) {
                 Collection<ClassEntry> classEntries = jarIndex.getEntryIndex().getClasses();
                 ClassProvider fixingClassProvider = new ObfuscationFixClassProvider(classProvider, jarIndex);
diff --git a/enigma/src/main/java/cuchaz/enigma/analysis/StructureTreeNode.java b/enigma/src/main/java/cuchaz/enigma/analysis/StructureTreeNode.java
new file mode 100644
index 0000000..f310aa7
--- /dev/null
+++ b/enigma/src/main/java/cuchaz/enigma/analysis/StructureTreeNode.java
@@ -0,0 +1,123 @@
+package cuchaz.enigma.analysis;
+
+import cuchaz.enigma.EnigmaProject;
+import cuchaz.enigma.api.service.NameProposalService;
+import cuchaz.enigma.translation.TranslateResult;
+import cuchaz.enigma.translation.mapping.EntryRemapper;
+import cuchaz.enigma.translation.representation.TypeDescriptor;
+import cuchaz.enigma.translation.representation.entry.*;
+
+import javax.swing.tree.DefaultMutableTreeNode;
+import java.util.List;
+
+public class StructureTreeNode extends DefaultMutableTreeNode {
+    private final List<NameProposalService> nameProposalServices;
+    private final EntryRemapper mapper;
+    private final ClassEntry parentEntry;
+    private final ParentedEntry entry;
+
+    public StructureTreeNode(EnigmaProject project, ClassEntry parentEntry, ParentedEntry entry) {
+        this.nameProposalServices = project.getEnigma().getServices().get(NameProposalService.TYPE);
+        this.mapper = project.getMapper();
+        this.parentEntry = parentEntry;
+        this.entry = entry;
+    }
+
+    /**
+     * Returns the parented entry corresponding to this tree node.
+     */
+    public ParentedEntry getEntry() {
+        return this.entry;
+    }
+
+    public void load(EnigmaProject project, boolean hideDeobfuscated) {
+        List<ParentedEntry> children = project.getJarIndex().getChildrenByClass().get(this.parentEntry);
+
+        for (ParentedEntry child : children) {
+            StructureTreeNode childNode = new StructureTreeNode(project, this.parentEntry, child);
+
+            if (child instanceof ClassEntry) {
+                childNode = new StructureTreeNode(project, (ClassEntry) child, child);
+                childNode.load(project, hideDeobfuscated);
+            }
+
+            // don't add deobfuscated members if hideDeobfuscated is true, unless it's an inner class
+            if (hideDeobfuscated && !project.isObfuscated(child) && !(child instanceof ClassEntry)) {
+                continue;
+            }
+
+            // don't add constructor methods if hideDeobfuscated is true
+            if (hideDeobfuscated && (child instanceof MethodEntry) && ((MethodEntry) child).isConstructor()) {
+                continue;
+            }
+
+            this.add(childNode);
+        }
+    }
+
+    @Override
+    public String toString() {
+        TranslateResult<ParentedEntry> translateResult = this.mapper.extendedDeobfuscate(this.entry);
+        String result = translateResult.getValue().getName();
+
+        if (translateResult.isObfuscated()) {
+            if (!this.nameProposalServices.isEmpty()) {
+                for (NameProposalService service : this.nameProposalServices) {
+                    if (service.proposeName(this.entry, this.mapper).isPresent()) {
+                        result = service.proposeName(this.entry, this.mapper).get();
+                    }
+                }
+            }
+        }
+
+        if (this.entry instanceof FieldDefEntry) {
+            FieldDefEntry field = (FieldDefEntry) translateResult.getValue();
+            String returnType = this.parseDesc(field.getDesc());
+
+            result = result + ": " + returnType;
+        } else if (this.entry instanceof MethodDefEntry) {
+            MethodDefEntry method = (MethodDefEntry) translateResult.getValue();
+            String args = this.parseArgs(method.getDesc().getArgumentDescs());
+            String returnType = this.parseDesc(method.getDesc().getReturnDesc());
+
+            if (method.isConstructor()) {
+                result = method.getParent().getSimpleName() + args;
+            } else {
+                result = result + args + ": " + returnType;
+            }
+        }
+
+        return result;
+    }
+
+    private String parseArgs(List<TypeDescriptor> args) {
+        if (args.size() > 0) {
+            String result = "(";
+
+            for (int i = 0; i < args.size(); i++) {
+                if (i > 0) {
+                    result += ", ";
+                }
+
+                result += this.parseDesc(args.get(i));
+            }
+
+            return result + ")";
+        }
+
+        return "()";
+    }
+
+    private String parseDesc(TypeDescriptor desc) {
+        if (desc.isVoid()) return "void";
+        if (desc.isPrimitive()) return desc.getPrimitive().getKeyword();
+        if (desc.isType()) return desc.getTypeEntry().getSimpleName();
+
+        if (desc.isArray()) {
+            if (desc.getArrayType().isPrimitive()) return desc.getArrayType().getPrimitive().getKeyword() + "[]";
+            if (desc.getArrayType().isType()) return desc.getArrayType().getTypeEntry().getSimpleName() + "[]";
+        }
+
+        return null;
+    }
+}
diff --git a/enigma/src/main/java/cuchaz/enigma/analysis/index/JarIndex.java b/enigma/src/main/java/cuchaz/enigma/analysis/index/JarIndex.java
index b5ad91a..aa360cf 100644
--- a/enigma/src/main/java/cuchaz/enigma/analysis/index/JarIndex.java
+++ b/enigma/src/main/java/cuchaz/enigma/analysis/index/JarIndex.java
@@ -11,8 +11,7 @@
 
 package cuchaz.enigma.analysis.index;
 
-import com.google.common.collect.HashMultimap;
-import com.google.common.collect.Multimap;
+import com.google.common.collect.*;
 import cuchaz.enigma.Enigma;
 import cuchaz.enigma.ProgressListener;
 import cuchaz.enigma.analysis.ReferenceTargetType;
@@ -23,10 +22,7 @@ import cuchaz.enigma.translation.representation.Lambda;
 import cuchaz.enigma.translation.representation.entry.*;
 import cuchaz.enigma.utils.I18n;
 
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.HashSet;
-import java.util.Set;
+import java.util.*;
 
 public class JarIndex implements JarIndexer {
         private final Set<String> indexedClasses = new HashSet<>();
@@ -40,6 +36,7 @@ public class JarIndex implements JarIndexer {
         private final Collection<JarIndexer> indexers;
 
         private final Multimap<String, MethodDefEntry> methodImplementations = HashMultimap.create();
+        private final ListMultimap<ClassEntry, ParentedEntry> childrenByClass;
 
         public JarIndex(EntryIndex entryIndex, InheritanceIndex inheritanceIndex, ReferenceIndex referenceIndex, BridgeMethodIndex bridgeMethodIndex, PackageVisibilityIndex packageVisibilityIndex) {
                 this.entryIndex = entryIndex;
@@ -49,6 +46,7 @@ public class JarIndex implements JarIndexer {
                 this.packageVisibilityIndex = packageVisibilityIndex;
                 this.indexers = Arrays.asList(entryIndex, inheritanceIndex, referenceIndex, bridgeMethodIndex, packageVisibilityIndex);
                 this.entryResolver = new IndexEntryResolver(this);
+                this.childrenByClass = ArrayListMultimap.create();
         }
 
         public static JarIndex empty() {
@@ -101,6 +99,9 @@ public class JarIndex implements JarIndexer {
                 }
 
                 indexers.forEach(indexer -> indexer.indexClass(classEntry));
+                if (classEntry.isInnerClass() && !classEntry.getAccess().isSynthetic()) {
+                        childrenByClass.put(classEntry.getParent(), classEntry);
+                }
         }
 
         @Override
@@ -110,6 +111,9 @@ public class JarIndex implements JarIndexer {
                 }
 
                 indexers.forEach(indexer -> indexer.indexField(fieldEntry));
+                if (!fieldEntry.getAccess().isSynthetic()) {
+                        childrenByClass.put(fieldEntry.getParent(), fieldEntry);
+                }
         }
 
         @Override
@@ -119,6 +123,9 @@ public class JarIndex implements JarIndexer {
                 }
 
                 indexers.forEach(indexer -> indexer.indexMethod(methodEntry));
+                if (!methodEntry.getAccess().isSynthetic() && !methodEntry.getName().equals("<clinit>")) {
+                        childrenByClass.put(methodEntry.getParent(), methodEntry);
+                }
 
                 if (!methodEntry.isConstructor()) {
                         methodImplementations.put(methodEntry.getParent().getFullName(), methodEntry);
@@ -176,6 +183,10 @@ public class JarIndex implements JarIndexer {
                 return entryResolver;
         }
 
+        public ListMultimap<ClassEntry, ParentedEntry> getChildrenByClass() {
+                return this.childrenByClass;
+        }
+
         public boolean isIndexed(String internalName) {
                 return indexedClasses.contains(internalName);
         }
diff --git a/enigma/src/main/java/cuchaz/enigma/translation/representation/TypeDescriptor.java b/enigma/src/main/java/cuchaz/enigma/translation/representation/TypeDescriptor.java
index a7dccfc..6a1b82f 100644
--- a/enigma/src/main/java/cuchaz/enigma/translation/representation/TypeDescriptor.java
+++ b/enigma/src/main/java/cuchaz/enigma/translation/representation/TypeDescriptor.java
@@ -235,14 +235,14 @@ public class TypeDescriptor implements Translatable {
         }
 
         public enum Primitive {
-                BYTE('B'),
-                CHARACTER('C'),
-                SHORT('S'),
-                INTEGER('I'),
-                LONG('J'),
-                FLOAT('F'),
-                DOUBLE('D'),
-                BOOLEAN('Z');
+                BYTE('B', "byte"),
+                CHARACTER('C', "char"),
+                SHORT('S', "short"),
+                INTEGER('I', "int"),
+                LONG('J', "long"),
+                FLOAT('F', "float"),
+                DOUBLE('D', "double"),
+                BOOLEAN('Z', "boolean");
 
                 private static final Map<Character, Primitive> lookup;
 
@@ -254,9 +254,11 @@ public class TypeDescriptor implements Translatable {
                 }
 
                 private char code;
+                private String keyword;
 
-                Primitive(char code) {
+                Primitive(char code, String keyword) {
                         this.code = code;
+                        this.keyword = keyword;
                 }
 
                 public static Primitive get(char code) {
@@ -266,5 +268,12 @@ public class TypeDescriptor implements Translatable {
                 public char getCode() {
                         return this.code;
                 }
+
+                /**
+                 * Returns the Java keyword corresponding to this primitive.
+                 */
+                public String getKeyword() {
+                        return this.keyword;
+                }
         }
 }
diff --git a/enigma/src/main/java/cuchaz/enigma/translation/representation/entry/ClassEntry.java b/enigma/src/main/java/cuchaz/enigma/translation/representation/entry/ClassEntry.java
index 4a50021..b4a22f1 100644
--- a/enigma/src/main/java/cuchaz/enigma/translation/representation/entry/ClassEntry.java
+++ b/enigma/src/main/java/cuchaz/enigma/translation/representation/entry/ClassEntry.java
@@ -134,6 +134,9 @@ public class ClassEntry extends ParentedEntry<ClassEntry> implements Comparable<
                 return name;
         }
 
+        /**
+         * Returns whether this class entry has a parent, and therefore is an inner class.
+         */
         public boolean isInnerClass() {
                 return parent != null;
         }
diff --git a/enigma/src/main/java/cuchaz/enigma/translation/representation/entry/Entry.java b/enigma/src/main/java/cuchaz/enigma/translation/representation/entry/Entry.java
index ff392fe..6fd412a 100644
--- a/enigma/src/main/java/cuchaz/enigma/translation/representation/entry/Entry.java
+++ b/enigma/src/main/java/cuchaz/enigma/translation/representation/entry/Entry.java
@@ -29,6 +29,13 @@ public interface Entry<P extends Entry<?>> extends Translatable {
                 return getName();
         }
 
+        /**
+         * Returns the parent entry of this entry.
+         *
+         * <p>The parent entry should be a {@linkplain MethodEntry method} for local variables,
+         * a {@linkplain ClassEntry class} for methods, fields and inner classes, and {@code null}
+         * for other classes.</p>
+         */
         @Nullable
         P getParent();
 
diff --git a/enigma/src/main/resources/lang/en_us.json b/enigma/src/main/resources/lang/en_us.json
index 9db4e1f..8195bb1 100644
--- a/enigma/src/main/resources/lang/en_us.json
+++ b/enigma/src/main/resources/lang/en_us.json
@@ -101,6 +101,8 @@
         "info_panel.identifier.index": "Index",
         "info_panel.editor.class.decompiling": "(decompiling...)",
         "info_panel.editor.class.not_found": "Unable to find class:",
+        "info_panel.tree.structure": "Structure",
+        "info_panel.tree.structure.hide_deobfuscated": "Hide deobfuscated members",
         "info_panel.tree.inheritance": "Inheritance",
         "info_panel.tree.implementations": "Implementations",
         "info_panel.tree.calls": "Call Graph",
diff --git a/enigma/src/main/resources/lang/fr_fr.json b/enigma/src/main/resources/lang/fr_fr.json
index 127b9c8..43bea4d 100644
--- a/enigma/src/main/resources/lang/fr_fr.json
+++ b/enigma/src/main/resources/lang/fr_fr.json
@@ -101,6 +101,8 @@
         "info_panel.identifier.index": "Index",
         "info_panel.editor.class.decompiling": "(décompilation...)",
         "info_panel.editor.class.not_found": "Impossible de trouver la classe :",
+        "info_panel.tree.structure": "Structure",
+        "info_panel.tree.structure.hide_deobfuscated": "Masquer les membres déobfusqués",
         "info_panel.tree.inheritance": "Héritage",
         "info_panel.tree.implementations": "Implémentations",
         "info_panel.tree.calls": "Graphique des appels",