Allow users to add comments to code

Author: rcx

src/main/java/club/bytecode/the/jda/gui/MainViewerGUI.java

@@ -58,7 +58,6 @@ public class MainViewerGUI extends JFrame implements IPersistentWindow {
     public List<ButtonGroup> allPanes = Collections.unmodifiableList(Arrays.asList(panelGroups));
     public Map<ButtonGroup, Map<JRadioButtonMenuItem, JDADecompiler>> allDecompilers = new HashMap<>();
     public Map<ButtonGroup, Map<JDADecompiler, JRadioButtonMenuItem>> allDecompilersRev = new HashMap<>();
-    public Map<ButtonGroup, Map<JDADecompiler, JCheckBoxMenuItem>> editButtons = new HashMap<>();
     public JMenu mnRecentFiles = new JMenu("Recent Files");
     private JMenuItem spinnerMenu = new JMenuItem("");
     public FontOptionsDialog fontOptionsDialog = new FontOptionsDialog();
@@ -72,7 +71,6 @@ public MainViewerGUI() {
             ButtonGroup panelGroup = new ButtonGroup();
             allDecompilers.put(panelGroup, new HashMap<>());
             allDecompilersRev.put(panelGroup, new HashMap<>());
-            editButtons.put(panelGroup, new HashMap<>());
             panelGroups[i] = panelGroup;
         }
         KeyboardFocusManager.getCurrentKeyboardFocusManager().addKeyEventDispatcher(new JDAKeybindManager());

src/main/java/club/bytecode/the/jda/gui/fileviewer/BytecodeSyntaxArea.java

@@ -12,12 +12,13 @@
 import java.util.List;
 import java.util.Map;
 
-public class BytecodeSyntaxArea extends RSyntaxTextArea {
+public class BytecodeSyntaxArea extends JDATextArea {
     public Map<Fold, List<Token>> tokenIndex;
     public final Map<Token, Fold> parentFoldCache;
     public boolean foldsBuilt;
 
-    public BytecodeSyntaxArea() {
+    public BytecodeSyntaxArea(String text) {
+        super(text);
         setSyntaxEditingStyle(BytecodeTokenizer.SYNTAX_STYLE_BYTECODE);
 
         setLinkScanningMask(0);

src/main/java/club/bytecode/the/jda/gui/fileviewer/ClassViewer.java

@@ -38,16 +38,6 @@ public void setPanes() {
         }
     }
 
-    public boolean isPaneEditable(int pane) {
-        setPanes();
-        ButtonGroup buttonGroup = JDA.viewer.allPanes.get(pane);
-        JDADecompiler selected = decompilers.get(pane);
-        if (buttonGroup != null && JDA.viewer.editButtons.get(buttonGroup) != null && JDA.viewer.editButtons.get(buttonGroup).get(selected) != null && JDA.viewer.editButtons.get(buttonGroup).get(selected).isSelected()) {
-            return true;
-        }
-        return false;
-    }
-
     public void updatePane(int pane, RSyntaxTextArea text, JDADecompiler decompiler) {
         javas.set(pane, text);
         SearchPanel search = new SearchPanel(text);

src/main/java/club/bytecode/the/jda/gui/fileviewer/DecompileThread.java

@@ -5,15 +5,13 @@
 import club.bytecode.the.jda.decompilers.JDADecompiler;
 import club.bytecode.the.jda.decompilers.bytecode.BytecodeDecompiler;
 import club.bytecode.the.jda.decompilers.filter.DecompileFilter;
-import club.bytecode.the.jda.settings.Settings;
 import com.strobel.annotations.Nullable;
 import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea;
 import org.fife.ui.rsyntaxtextarea.SyntaxConstants;
 import org.fife.ui.rtextarea.RTextScrollPane;
 import org.objectweb.asm.tree.ClassNode;
 
 import javax.swing.*;
-import java.awt.*;
 
 /**
  * Updates a pane
@@ -49,27 +47,21 @@ public void run() {
                 decompileResult = decompiler.decompileClassNode(viewer.getFile().container, cn);
             }
 
+            String text = stripUndisplayableChars(decompileResult);
             RSyntaxTextArea panelArea;
             if (decompiler instanceof BytecodeDecompiler) {
-                panelArea = new BytecodeSyntaxArea();
+                panelArea = new BytecodeSyntaxArea(text);
             } else {
-                panelArea = new RSyntaxTextArea();
+                panelArea = new JDATextArea(text);
                 panelArea.setSyntaxEditingStyle(SyntaxConstants.SYNTAX_STYLE_JAVA);
             }
-            panelArea.setCodeFoldingEnabled(true);
-            panelArea.setAntiAliasingEnabled(true);
-            
+
             final RTextScrollPane scrollPane = new RTextScrollPane(panelArea);
-            panelArea.setText(stripUndisplayableChars(decompileResult));
-            panelArea.setCaretPosition(0);
-            panelArea.setEditable(viewer.isPaneEditable(paneId));
             StringBuilder topLabelText = new StringBuilder(decompiler.getName());
             for (DecompileFilter filter : decompiler.getSettings().getEnabledFilters()) {
                 topLabelText.append(" + ").append(filter.getName());
             }
             scrollPane.setColumnHeaderView(new JLabel(topLabelText.toString()));
-            panelArea.setFont(new Font(Settings.FONT_FAMILY.getString(), Settings.FONT_OPTIONS.getInt(), Settings.FONT_SIZE.getInt()));
-
             SwingUtilities.invokeLater(() -> target.add(scrollPane));
             viewer.updatePane(paneId, panelArea, decompiler);
         } catch (Exception e) {

src/main/java/club/bytecode/the/jda/gui/fileviewer/FileViewerPane.java

@@ -5,7 +5,7 @@
 import club.bytecode.the.jda.gui.JDAWindow;
 import club.bytecode.the.jda.gui.components.TabbedPane;
 import club.bytecode.the.jda.gui.navigation.FileNavigationPane;
-import org.mapleir.stdlib.util.IndexedList;
+import org.mapleir.stdlib.collections.list.IndexedList;
 
 import javax.swing.*;
 import java.awt.*;

src/main/java/club/bytecode/the/jda/gui/fileviewer/JDATextArea.java

@@ -0,0 +1,89 @@
+package club.bytecode.the.jda.gui.fileviewer;
+
+import club.bytecode.the.jda.settings.Settings;
+import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea;
+
+import javax.swing.*;
+import javax.swing.text.BadLocationException;
+import java.awt.*;
+import java.awt.event.KeyEvent;
+import java.util.*;
+import java.util.List;
+
+public class JDATextArea extends RSyntaxTextArea {
+    private List<String> lines;
+    private Map<Integer, String> comments;
+
+    public JDATextArea(String text) {
+        lines = Collections.unmodifiableList(Arrays.asList(text.split("\n")));
+        comments = new HashMap<>();
+
+        setCodeFoldingEnabled(true);
+        setAntiAliasingEnabled(true);
+
+        setText(text);
+        setCaretPosition(0);
+        setFont(new Font(Settings.FONT_FAMILY.getString(), Settings.FONT_OPTIONS.getInt(), Settings.FONT_SIZE.getInt()));
+
+        setEditable(true);
+        addKeyListener(new JDATextAreaKeyListener());
+    }
+
+    private void addCommentDialog() {
+        setComment(getCaretLineNumber(), JOptionPane.showInputDialog("Enter a comment"));
+    }
+
+    private void setComment(int line, String comment) {
+        if (comment == null || comment.isEmpty())
+            comments.remove(line);
+        else
+            comments.put(line, comment);
+        resetLine(line);
+    }
+
+    private void resetLine(int line) {
+        String lineText = lines.get(line);
+        if (comments.containsKey(line)) {
+            lineText += " // " + comments.get(line);
+        }
+        try {
+            replaceRange(lineText, getLineStartOffset(line), getLineEndOffset(line) - 1);
+        } catch (BadLocationException e) {
+            e.printStackTrace();
+        }
+    }
+
+    public class JDATextAreaKeyListener extends NonRepeatKeyListener {
+        public JDATextAreaKeyListener() {
+        }
+
+        @Override
+        public void keyTyped(KeyEvent e) {
+            e.consume();
+        }
+
+        @Override
+        public void keyPressed(KeyEvent e) {
+            super.keyPressed(e);
+            e.consume();
+        }
+
+        @Override
+        public void keyReleased(KeyEvent e) {
+            super.keyReleased(e);
+        }
+
+        @Override
+        protected void onDown(KeyEvent e) {
+            switch (e.getKeyCode()) {
+                case KeyEvent.VK_SLASH:
+                    addCommentDialog();
+            }
+        }
+
+        @Override
+        protected void onUp(KeyEvent e) {
+
+        }
+    }
+}

src/main/java/club/bytecode/the/jda/gui/fileviewer/JDATextAreaKeyListener.java

@@ -0,0 +1,2 @@
+package club.bytecode.the.jda.gui.fileviewer;
+

src/main/java/club/bytecode/the/jda/gui/fileviewer/NonRepeatKeyListener.java

@@ -0,0 +1,26 @@
+package club.bytecode.the.jda.gui.fileviewer;
+
+import java.awt.event.KeyEvent;
+import java.awt.event.KeyListener;
+import java.util.HashSet;
+import java.util.Set;
+
+public abstract class NonRepeatKeyListener implements KeyListener {
+    Set<Integer> pressedKeys = new HashSet<>();
+
+    @Override
+    public void keyPressed(KeyEvent e) {
+        if (pressedKeys.add(e.getKeyCode())) {
+            onDown(e);
+        }
+    }
+
+    @Override
+    public void keyReleased(KeyEvent e) {
+        pressedKeys.remove(e.getKeyCode());
+        onUp(e);
+    }
+
+    protected abstract void onDown(KeyEvent e);
+    protected abstract void onUp(KeyEvent e);
+}