Use dispel magic + a little polish

README.md

@@ -15,6 +15,7 @@ Enigma includes the following open-source libraries:
  - [FlatLaf](https://github.com/JFormDesigner/FlatLaf) (Apache-2.0)
  - [jopt-simple](https://github.com/jopt-simple/jopt-simple) (MIT)
  - [ASM](https://asm.ow2.io/) (BSD-3-Clause)
+ - [JavaParser](https://javaparser.org/) (Apache-2.0)
 
 ## Usage
 

enigma-swing/build.gradle

@@ -32,6 +32,7 @@ dependencies {
 	implementation libs.bundles.quilt.config
 	implementation libs.swing.dpi
 	implementation libs.fontchooser
+	implementation libs.javaparser
 	testImplementation(testFixtures(project(':enigma')))
 }
 

enigma-swing/src/main/java/org/quiltmc/enigma/gui/Gui.java

@@ -28,6 +28,7 @@
 import org.quiltmc.enigma.gui.element.EditorTabbedPane;
 import org.quiltmc.enigma.gui.element.MainWindow;
 import org.quiltmc.enigma.gui.element.menu_bar.MenuBar;
+import org.quiltmc.enigma.gui.panel.BaseEditorPanel;
 import org.quiltmc.enigma.gui.panel.EditorPanel;
 import org.quiltmc.enigma.gui.panel.IdentifierPanel;
 import org.quiltmc.enigma.gui.renderer.MessageListCellRenderer;
@@ -170,8 +171,8 @@ private void setupDockers() {
 		this.dockerManager.registerDocker(new AllClassesDocker(this));
 		this.dockerManager.registerDocker(new DeobfuscatedClassesDocker(this));
 
-		if (Config.dockers().buttonLocations.value().isEmpty()) {
-			Config.dockers().updateButtonLocations(this.dockerManager);
+		if (Config.docker().buttonLocations.value().isEmpty()) {
+			Config.docker().updateButtonLocations(this.dockerManager);
 		}
 
 		// set default docker sizes
@@ -402,7 +403,7 @@ public void setMappingsFile(Path path) {
 		this.updateUiState();
 	}
 
-	public void showTokens(EditorPanel editor, List<Token> tokens) {
+	public void showTokens(BaseEditorPanel editor, List<Token> tokens) {
 		if (tokens.size() > 1) {
 			this.openDocker(CallsTreeDocker.class);
 			this.controller.setTokenHandle(editor.getClassHandle().copy());

enigma-swing/src/main/java/org/quiltmc/enigma/gui/NestedPackages.java

@@ -12,6 +12,7 @@
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Optional;
 
 public class NestedPackages {
 	private final SortedMutableTreeNode root;
@@ -75,9 +76,16 @@ public SortedMutableTreeNode getRoot() {
 		return this.root;
 	}
 
+	/**
+	 * @return the path to the passed {@code packageName} if present, or the path the {@link #root} otherwise
+	 */
 	public TreePath getPackagePath(String packageName) {
-		var node = this.packageToNode.getOrDefault(packageName, this.root);
-		return new TreePath(node.getPath());
+		return this.getPackagePathOrEmpty(packageName).orElseGet(() -> new TreePath(this.root.getPath()));
+	}
+
+	public Optional<TreePath> getPackagePathOrEmpty(String packageName) {
+		return Optional.ofNullable(this.packageToNode.get(packageName))
+				.map(node -> new TreePath(node.getPath()));
 	}
 
 	public ClassSelectorClassNode getClassNode(ClassEntry entry) {

enigma-swing/src/main/java/org/quiltmc/enigma/gui/config/Config.java

@@ -24,7 +24,6 @@
 import org.quiltmc.enigma.gui.config.theme.properties.SystemThemeProperties;
 import org.quiltmc.enigma.gui.config.theme.properties.composite.SyntaxPaneProperties;
 import org.quiltmc.enigma.util.I18n;
-import org.quiltmc.syntaxpain.SyntaxpainConfiguration;
 
 import javax.annotation.Nullable;
 import javax.swing.UnsupportedLookAndFeelException;
@@ -34,9 +33,18 @@
 import java.nio.file.Paths;
 
 /**
- * The Enigma config is separated into five different files: {@link Config the main config (this one)},
- * {@link NetConfig the networking configuration}, {@link KeyBindConfig the keybinding configuration},
- * {@link DockerConfig the docker configuration}, and {@link DecompilerConfig the decompiler configuration}.
+ * Enigma config is separated into several {@value #FORMAT} files with names matching the methods used to access them:
+ * <ul>
+ *     <li> {@link #main()} (this one)
+ *     <li> {@link #net()} (networking)
+ *     <li> {@link #keybind()}
+ *     <li> {@link #docker()}
+ *     <li> {@link #decompiler()}
+ *     <li> {@link #editor()}
+ * </ul>
+ *
+ * {@value #THEME_FAMILY} also holds a config file for each theme;
+ * the active theme is accessible via {@link #currentTheme()}.
  */
 @SerializedNameConvention(NamingSchemes.SNAKE_CASE)
 @Processor("processChange")
@@ -52,6 +60,7 @@ public final class Config extends ReflectiveConfig {
 	private static final NetConfig NET = ConfigFactory.create(ENVIRONMENT, FAMILY, "net", NetConfig.class);
 	private static final DockerConfig DOCKER = ConfigFactory.create(ENVIRONMENT, FAMILY, "docker", DockerConfig.class);
 	private static final DecompilerConfig DECOMPILER = ConfigFactory.create(ENVIRONMENT, FAMILY, "decompiler", DecompilerConfig.class);
+	private static final EditorConfig EDITOR = ConfigFactory.create(ENVIRONMENT, FAMILY, "editor", EditorConfig.class);
 
 	@Comment("The currently assigned UI language. This will be an ISO-639 two-letter language code, followed by an underscore and an ISO 3166-1 alpha-2 two-letter country code.")
 	@Processor("grabPossibleLanguages")
@@ -77,9 +86,6 @@ public final class Config extends ReflectiveConfig {
 	@Comment("You shouldn't enable options in this section unless you know what you're doing!")
 	public final DevSection development = new DevSection();
 
-	@Comment("Whether editors' quick find toolbars should remain visible when they lose focus.")
-	public final TrackedValue<Boolean> persistentEditorQuickFind = this.value(true);
-
 	/**
 	 * The look and feel stored in the config: do not use this unless setting! Use {@link #activeThemeChoice} instead,
 	 * since look and feel is final once loaded.
@@ -115,11 +121,11 @@ public static StatsSection stats() {
 		return main().stats;
 	}
 
-	public static DockerConfig dockers() {
+	public static DockerConfig docker() {
 		return DOCKER;
 	}
 
-	public static KeyBindConfig keyBinds() {
+	public static KeyBindConfig keybind() {
 		return KEYBIND;
 	}
 
@@ -131,6 +137,10 @@ public static DecompilerConfig decompiler() {
 		return DECOMPILER;
 	}
 
+	public static EditorConfig editor() {
+		return EDITOR;
+	}
+
 	public static Theme currentTheme() {
 		return activeThemeChoice.theme;
 	}
@@ -246,32 +256,6 @@ public ComplexConfigValue copy() {
 		}
 	}
 
-	/**
-	 * Updates the backend library Syntaxpain, used for code highlighting and other editor things.
-	 */
-	public static void updateSyntaxpain() {
-		Theme.Fonts fonts = currentFonts();
-		SyntaxPaneProperties.Colors colors = getCurrentSyntaxPaneColors();
-
-		SyntaxpainConfiguration.setEditorFont(fonts.editor.value());
-		// disable dialog; EditorPanel uses a tool bar component instead
-		SyntaxpainConfiguration.setQuickFindDialogFactory(null);
-
-		SyntaxpainConfiguration.setLineRulerPrimaryColor(colors.lineNumbersForeground.value());
-		SyntaxpainConfiguration.setLineRulerSecondaryColor(colors.lineNumbersBackground.value());
-		SyntaxpainConfiguration.setLineRulerSelectionColor(colors.lineNumbersSelected.value());
-
-		SyntaxpainConfiguration.setHighlightColor(colors.highlight.value());
-		SyntaxpainConfiguration.setStringColor(colors.string.value());
-		SyntaxpainConfiguration.setNumberColor(colors.number.value());
-		SyntaxpainConfiguration.setOperatorColor(colors.operator.value());
-		SyntaxpainConfiguration.setDelimiterColor(colors.delimiter.value());
-		SyntaxpainConfiguration.setTypeColor(colors.type.value());
-		SyntaxpainConfiguration.setIdentifierColor(colors.identifier.value());
-		SyntaxpainConfiguration.setCommentColour(colors.comment.value());
-		SyntaxpainConfiguration.setTextColor(colors.text.value());
-	}
-
 	public enum ThemeChoice implements ConfigSerializableObject<String> {
 		DEFAULT(
 			Theme.create(ENVIRONMENT, THEME_FAMILY, "default", new DefaultThemeProperties())

enigma-swing/src/main/java/org/quiltmc/enigma/gui/config/EditorConfig.java

@@ -0,0 +1,16 @@
+package org.quiltmc.enigma.gui.config;
+
+import org.quiltmc.config.api.ReflectiveConfig;
+import org.quiltmc.config.api.annotations.Comment;
+import org.quiltmc.config.api.annotations.SerializedNameConvention;
+import org.quiltmc.config.api.metadata.NamingSchemes;
+import org.quiltmc.config.api.values.TrackedValue;
+
+@SerializedNameConvention(NamingSchemes.SNAKE_CASE)
+public class EditorConfig extends ReflectiveConfig {
+	@Comment("Whether editors' quick find toolbars should remain visible when they lose focus.")
+	public final TrackedValue<Boolean> persistentQuickFind = this.value(true);
+
+	@Comment("Settings for editors' entry tooltips.")
+	public final EntryTooltipsSection entryTooltips = new EntryTooltipsSection();
+}

enigma-swing/src/main/java/org/quiltmc/enigma/gui/config/EntryTooltipsSection.java

@@ -0,0 +1,16 @@
+package org.quiltmc.enigma.gui.config;
+
+import org.quiltmc.config.api.ReflectiveConfig;
+import org.quiltmc.config.api.annotations.Comment;
+import org.quiltmc.config.api.annotations.SerializedNameConvention;
+import org.quiltmc.config.api.metadata.NamingSchemes;
+import org.quiltmc.config.api.values.TrackedValue;
+
+@SerializedNameConvention(NamingSchemes.SNAKE_CASE)
+public class EntryTooltipsSection extends ReflectiveConfig.Section {
+	@Comment("Whether tooltips are enabled.")
+	public final TrackedValue<Boolean> enable = this.value(true);
+
+	@Comment("Whether tooltips can be clicked and interacted with to navigate their content.")
+	public final TrackedValue<Boolean> interactable = this.value(true);
+}

enigma-swing/src/main/java/org/quiltmc/enigma/gui/config/keybind/KeyBinds.java

@@ -95,7 +95,7 @@ public static Map<String, List<KeyBind>> getEditableKeyBindsByCategory() {
 
 	public static void loadConfig() {
 		for (KeyBind keyBind : CONFIGURABLE_KEY_BINDS) {
-			keyBind.deserializeCombinations(Config.keyBinds().getKeyCodes(keyBind));
+			keyBind.deserializeCombinations(Config.keybind().getKeyCodes(keyBind));
 		}
 
 		resetEditableKeyBinds();
@@ -107,7 +107,7 @@ public static void saveConfig() {
 			KeyBind editedKeyBind = editableKeyBinds.get(i);
 			if (!editedKeyBind.equals(keyBind)) {
 				keyBind.setFrom(editedKeyBind);
-				Config.keyBinds().setBind(editedKeyBind);
+				Config.keybind().setBind(editedKeyBind);
 			}
 		}
 	}

enigma-swing/src/main/java/org/quiltmc/enigma/gui/config/theme/ThemeUtil.java

@@ -2,6 +2,7 @@
 
 import org.quiltmc.config.api.values.TrackedValue;
 import org.quiltmc.enigma.gui.config.Config;
+import org.quiltmc.enigma.gui.config.theme.properties.composite.SyntaxPaneProperties;
 import org.quiltmc.enigma.gui.highlight.BoxHighlightPainter;
 import org.quiltmc.enigma.gui.util.ScaleUtil;
 import org.quiltmc.syntaxpain.JavaSyntaxKit;
@@ -24,9 +25,24 @@ public static void setupTheme() {
 		Config.configureTheme();
 		Config.setGlobalLaf();
 		ThemeUtil.setFonts();
-		Config.updateSyntaxpain();
 		UIManager.put("ScrollBar.showButtons", true);
-		JEditorPane.registerEditorKitForContentType("text/enigma-sources", JavaSyntaxKit.class.getName());
+
+		final SyntaxPaneProperties.Colors syntaxColors = Config.getCurrentSyntaxPaneColors();
+		JavaSyntaxKit.setSyntaxColors(
+				syntaxColors.highlight.value(),
+				syntaxColors.string.value(),
+				syntaxColors.number.value(),
+				syntaxColors.operator.value(),
+				syntaxColors.delimiter.value(),
+				syntaxColors.type.value(),
+				syntaxColors.identifier.value(),
+				syntaxColors.comment.value(),
+				syntaxColors.text.value(),
+				new Color(0xcc6600)
+		);
+
+		JEditorPane.registerEditorKitForContentType(JavaSyntaxKit.CONTENT_TYPE, JavaSyntaxKit.class.getName());
+
 		ScaleUtil.applyScaling();
 	}
 

enigma-swing/src/main/java/org/quiltmc/enigma/gui/config/theme/properties/DarcerulaThemeProperties.java

@@ -27,6 +27,9 @@ public Colors.Builder buildSyntaxPaneColors(Colors.Builder colors) {
 				.lineNumbersBackground(new SerializableColor(0xFF252729))
 				.lineNumbersSelected(new SerializableColor(0xFF353739))
 
+				.selection(new SerializableColor(0xFF003658))
+				.pairsMarker(new SerializableColor(0xBF9F7B47))
+
 				.obfuscated(new SerializableColor(0x31FF5555))
 				.obfuscatedOutline(new SerializableColor(0x89FF5555))
 

enigma-swing/src/main/java/org/quiltmc/enigma/gui/config/theme/properties/DarculaThemeProperties.java

@@ -45,6 +45,9 @@ public Colors.Builder buildSyntaxPaneColors(Colors.Builder colors) {
 				.lineNumbersBackground(new SerializableColor(0xFF313335))
 				.lineNumbersSelected(new SerializableColor(0xFF606366))
 
+				.selection(new SerializableColor(0xFF14587A))
+				.pairsMarker(new SerializableColor(0xBFAF8B57))
+
 				.obfuscated(new SerializableColor(0x4DFF5555))
 				.obfuscatedOutline(new SerializableColor(0x80FF5555))
 
@@ -54,8 +57,8 @@ public Colors.Builder buildSyntaxPaneColors(Colors.Builder colors) {
 				.deobfuscated(new SerializableColor(0x4D50FA7B))
 				.deobfuscatedOutline(new SerializableColor(0x8050FA7B))
 
-				.fallback(new SerializableColor(0x4Daa5500))
-				.fallbackOutline(new SerializableColor(0x80d86f06))
+				.fallback(new SerializableColor(0x4DAA5500))
+				.fallbackOutline(new SerializableColor(0x80D86F06))
 
 				.editorBackground(new SerializableColor(0xFF282A36))
 				.highlight(new SerializableColor(0xFFFF79C6))

enigma-swing/src/main/java/org/quiltmc/enigma/gui/config/theme/properties/composite/SyntaxPaneProperties.java

@@ -29,17 +29,22 @@ protected Colors.Builder buildSyntaxPaneColors(Colors.Builder colors) {
 		return colors;
 	}
 
+	@Override
 	public void configure() {
 		this.colors.configure();
 	}
 
 	/**
 	 * Default values are for light themes.
 	 */
-	public static class Colors implements Consumer<Config.SectionBuilder> {
+	public static final class Colors implements Consumer<Config.SectionBuilder> {
 		public final TrackedValue<ThemeProperties.SerializableColor> lineNumbersForeground;
 		public final TrackedValue<ThemeProperties.SerializableColor> lineNumbersBackground;
 		public final TrackedValue<ThemeProperties.SerializableColor> lineNumbersSelected;
+
+		public final TrackedValue<ThemeProperties.SerializableColor> selection;
+		public final TrackedValue<ThemeProperties.SerializableColor> pairsMarker;
+
 		public final TrackedValue<ThemeProperties.SerializableColor> obfuscated;
 		public final TrackedValue<ThemeProperties.SerializableColor> obfuscatedOutline;
 
@@ -72,6 +77,10 @@ private Colors(
 				ThemeProperties.SerializableColor lineNumbersForeground,
 				ThemeProperties.SerializableColor lineNumbersBackground,
 				ThemeProperties.SerializableColor lineNumbersSelected,
+
+				ThemeProperties.SerializableColor selection,
+				ThemeProperties.SerializableColor pairsMarker,
+
 				ThemeProperties.SerializableColor obfuscated,
 				ThemeProperties.SerializableColor obfuscatedOutline,
 
@@ -103,6 +112,10 @@ private Colors(
 			this.lineNumbersForeground = TrackedValue.create(lineNumbersForeground, "line_numbers_foreground");
 			this.lineNumbersBackground = TrackedValue.create(lineNumbersBackground, "line_numbers_background");
 			this.lineNumbersSelected = TrackedValue.create(lineNumbersSelected, "line_numbers_selected");
+
+			this.selection = TrackedValue.create(selection, "selection");
+			this.pairsMarker = TrackedValue.create(pairsMarker, "pairs_marker");
+
 			this.obfuscated = TrackedValue.create(obfuscated, "obfuscated");
 			this.obfuscatedOutline = TrackedValue.create(obfuscatedOutline, "obfuscated_outline");
 
@@ -142,6 +155,9 @@ public Stream<TrackedValue<ThemeProperties.SerializableColor>> stream() {
 				this.lineNumbersBackground,
 				this.lineNumbersSelected,
 
+				this.selection,
+				this.pairsMarker,
+
 				this.obfuscated,
 				this.obfuscatedOutline,
 
@@ -180,6 +196,10 @@ public static class Builder {
 			private ThemeProperties.SerializableColor lineNumbersForeground = new ThemeProperties.SerializableColor(0xFF333300);
 			private ThemeProperties.SerializableColor lineNumbersBackground = new ThemeProperties.SerializableColor(0xFFEEEEFF);
 			private ThemeProperties.SerializableColor lineNumbersSelected = new ThemeProperties.SerializableColor(0xFFCCCCEE);
+
+			private ThemeProperties.SerializableColor selection = new ThemeProperties.SerializableColor(0xFF1F2E5A);
+			private ThemeProperties.SerializableColor pairsMarker = new ThemeProperties.SerializableColor(0xFFFFBB77);
+
 			private ThemeProperties.SerializableColor obfuscated = new ThemeProperties.SerializableColor(0xFFFFDCDC);
 			private ThemeProperties.SerializableColor obfuscatedOutline = new ThemeProperties.SerializableColor(0xFFA05050);
 
@@ -213,6 +233,10 @@ public Colors build() {
 					this.lineNumbersForeground,
 					this.lineNumbersBackground,
 					this.lineNumbersSelected,
+
+					this.selection,
+					this.pairsMarker,
+
 					this.obfuscated,
 					this.obfuscatedOutline,
 
@@ -258,6 +282,16 @@ public Builder lineNumbersSelected(ThemeProperties.SerializableColor lineNumbers
 				return this;
 			}
 
+			public Builder selection(ThemeProperties.SerializableColor selection) {
+				this.selection = selection;
+				return this;
+			}
+
+			public Builder pairsMarker(ThemeProperties.SerializableColor pairsMarker) {
+				this.pairsMarker = pairsMarker;
+				return this;
+			}
+
 			public Builder obfuscated(ThemeProperties.SerializableColor obfuscated) {
 				this.obfuscated = obfuscated;
 				return this;