Entry tooltips (#307)

* add POC tooltip to EditorPanel editor that shows full name of entry under cursor

* update tooltip content when mouse moves, but can't get JToolTip to resize+move

* replace EditorPanel's use of JToolTip and TooltipManager with JWindow and timers, respectively

* check if same token instead of same entry when updating tooltip

* replace complex Optional composition with consumer methods

* extract BaseEditorPanel without tooltip, navigator, or listeners

* display entries' entire outer source class in their tooltips

* always set tooltipEditor classhandle instead of setting source when it's the same class (editor bounds were 0x0 when setting source)
navigate to tooltip target entry declaration when showing tooltip

* add javaparser dep matching #308

* implement source trimming for classes using javaparser

* minor improvements

* minor cleanup

* make trimFactor a param instead of a field

* implement source trimming for methods

* match declarations only by range and extract findDeclaration

* inline variable

* implement field source trimming
stop excluding curly braces from method and class sources

* fix tooltip source trimming for static record fields
add "No source available" label when there's no classhandle

* update TODOs
centralize target name reporting

* extract TooltipEditorPanel

* trim param tooltip target source to parent method
refine error messages

* fail early when target declaration token is missing
add local source trimming

* fix tooltip source trimming for constructors

* minor refactor

* show record component parent instead of just component; matches param showing parent method

* when excluding implements from record component parent, find token instead of assuming offset

* close and destroy tooltip when source changes

* silently ignore missing declaration tokens (until #252 is fixed)

* restore quickFindToolbar to ui
stop closing tooltip's class handles as tabs may still need them; remove ClassHandleListener instead
rename TooltipEditorPanel -> DeclarationSnippetPanel
extract EditorTooltip
add test input for easier manual tooltip testing

* restore EditorPanel popupMenu functionality

* improve caret pos logic in BaseEditorPanel::setSource

* replace source with message if the declaration token could be found

* implement source snippet unindenting

* replace entry simple name label with formatted parent name label

* add 'From: ' prefix to parent label
left-align tooltip rows

* add javadocs to tooltip

* allow disabling tooltip

* make tooltip optionally interactable
implement dragging to move tooltip

* prevent hiding tooltip when cursor is over a token or the tooltip

* fix parent label for top-level classes and add missing dot separator for package
format labels
use GridBagLayout for param javadocs (currently takes up extra space)

* allow clicking entries withing tooltip to populate tooltip with that entry's information

* fix calculation for offsetting multiline snippet pos to un-trimmed pos
allow clicking parent entries in tooltips to populate tooltip
when ctrl+clicking entries in tooltips, open entry tab

* minor improvements, add TODOs

* resolve references when finding tooltip targets

* customize tooltip target highlighting

* update TODOs regarding records

* polish tooltip positioning
fix exception when consumeMousePosition... methods where passed a component that wasn't showing
fix several cases where the tooltip would hide when it shouldn't or hiden't when it should

* increase padding at outer edges of tooltip rows
add tooltip border

* use a JPanel with a GridBagLayout instead of a Box as the content pane for EditorTooltip; allows elements to expand to fill their space
double-pack in EditorTooltip's declarationSnippet source set listener to eliminate extra space, because swing </3

* reject some TODOs

* ctrl+click on parent package label to naviage to package

* fix tooltip separators
improve "No source available" message formatting

* respect tooltip ineractable config for parent package clicking
add z_ prefix to tooltip test input to avoid changing SearchMappingsTest

* use global focus listener to ensure tooltip is closed when neither it nor its editor has focus

* move consumeMousePosition... methods to GuiUtil

* rename EditorTooltip -> EntryTooltip
use GridBagConstraintsBuilder in EntryTooltip
respect scale config in EntryTooltip

* use GridBagConstraintsBuilder in initEditorPane

* make tooltip focusable; enables copying tooltip content

* fix hiding tooltip immediately after re-populating it
simplify tooltip focus and hiding logic

* remove tooltip to editor click forward as it didn't work consistently
remove unecessary insteractable tooltip click listener

* add EntryTooltip.repopulated field for workaround

* deobfuscate parent package

* focus class selector when navigating to parent package from tooltip

* scroll to class selector path when navigating from entry tooltip parent

* move Config.persistentEditorQuickFind to EditorConfig.persistentQuickFind

* rename config getter methods to match their ids and update Config javadoc

* fix another tooltip focus issue

* fix bug preventing RecordGetterFindingVisitor from finding inner records' getters
make RecordGetterFindingVisitor's getter map accessible
fix DeclarationSnippetPanel for record component getters

* rename RecordGetterFindingVisitor -> RecordIndexingVisitor
expand RecordGetterFindingVisitor to provide maps of record classes to their fields and methods
make EntryTooltip show record field javadocs for record classes
make EntryTooltip show record field javadocs for record getters if they don't have their own javadocs

* clear things in visitEnd instead of visit
clear fields and methods

* fix for java 17

* tighten RecordIndexingVisitor encapsulation

* make navigating to a record component getter with no explicit declaration navigate to its field instead

* add nullable annotation

* only set BaseEditorPanel.editor text once

* fix typo

* tweak moveMaintainingAnchor

* close entry tooltip on key press

* close tooltip on KEY_TYPED instead of KEY_PRESSED so ctrl+c can copy

* add javaparser to lib list in README

* cleanup createSnippet

* fix swapped un/bounded names

* make LineIndexer::getIndex return -1 for out-of-bounds positions, add LineIndexerTest

* rename EditorTooltipSection -> EntryTooltipSection

* limit EntryTooltip size

* put main tooltip content in a scroll pane

* focus snippet editor ui on source set
remove main content scroll pane border

* checkstyle

* replace AtomicInteger gridY's with primitive ints

* hard cap tooltip width at 600px (scaled)

* expand parent package path when navigating from tooltip

* explicitly check if source is bounded when setting 'Unable to locate declaration' message
show <init> for constructor simple names

* improve constructor name check

* use 'inherited from' label for tooltip labels for entries that resolved to a parent

* dispatch key events that close the entry tooltip to the previously focused component

* close entry tooltip with global mouse listener

* add gui for entry tooltip config

* deduplicate check box sync logic

* javadoc createSyncedCheckBox

* javadoc syncStateWithConfig override

* move tooltip management to EnitorPanel.TooltipManager
add/remove EntryTooltip's global listeners on open/close
reset TooltipManager on key presses

* minor refactor

* make 'tooltips' consistently plural in user-facing strings

* dispatch KEY_PRESSED events that close entry tooltips (with exception for ctrl+c)

* rework moveMaintainingAnchor when tooltip shrunk

* move FeaturesSection.enableClassTreeStatIcons to StatsSection
move FeaturesSection.autoSaveMappings to EditorConfig
eliminate FeaturesSection

* ensure RecordIndexingVisitor is cleared in visitEnd

* make several tooltip string translatable

* make a snippet string translatable

Author: supersaiyansubtlety

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/GuiController.java

@@ -197,7 +197,7 @@ public void openMappings(EntryTree<EntryMapping> mappings) {
 	}
 
 	public void regenerateAndUpdateStatIcons() {
-		if (Config.main().features.enableClassTreeStatIcons.value()) {
+		if (Config.stats().enableClassTreeStatIcons.value()) {
 			ProgressListener progressListener = ProgressListener.createEmpty();
 			this.gui.getMainWindow().getStatusBar().syncWith(progressListener);
 
@@ -570,7 +570,7 @@ public void applyChange(ValidationContext vc, EntryChange<?> change, boolean upd
 			return;
 		}
 
-		if (autosave && Config.main().features.autoSaveMappings.value() && this.gui.mappingsFileChooser.getSelectedFile() != null) {
+		if (autosave && Config.editor().autoSaveMappings.value() && this.gui.mappingsFileChooser.getSelectedFile() != null) {
 			this.gui.getController().saveMappings(this.gui.mappingsFileChooser.getSelectedFile().toPath(), true);
 		}
 

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

@@ -34,9 +34,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 +61,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")
@@ -71,15 +81,9 @@ public final class Config extends ReflectiveConfig {
 	@Comment("The settings for the statistics window.")
 	public final StatsSection stats = new StatsSection();
 
-	@Comment("Contains all features that can be toggled on or off.")
-	public final FeaturesSection features = new FeaturesSection();
-
 	@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 +119,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 +135,10 @@ public static DecompilerConfig decompiler() {
 		return DECOMPILER;
 	}
 
+	public static EditorConfig editor() {
+		return EDITOR;
+	}
+
 	public static Theme currentTheme() {
 		return activeThemeChoice.theme;
 	}

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

@@ -7,9 +7,13 @@
 import org.quiltmc.config.api.values.TrackedValue;
 
 @SerializedNameConvention(NamingSchemes.SNAKE_CASE)
-public class FeaturesSection extends ReflectiveConfig.Section {
-	@Comment("Enables statistic icons in the class tree. This has a major performance impact on JAR files with lots of classes.")
-	public final TrackedValue<Boolean> enableClassTreeStatIcons = this.value(true);
+public class EditorConfig extends ReflectiveConfig {
 	@Comment("Enables auto save functionality, which will automatically save mappings when a change is made.")
 	public final TrackedValue<Boolean> autoSaveMappings = this.value(false);
+
+	@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/StatsSection.java

@@ -22,6 +22,9 @@ public class StatsSection extends ReflectiveConfig.Section {
 	public final TrackedValue<Boolean> shouldIncludeSyntheticParameters = this.value(false);
 	public final TrackedValue<Boolean> shouldCountFallbackNames = this.value(false);
 
+	@Comment("Enables statistic icons in the class tree. This has a major performance impact on JAR files with lots of classes.")
+	public final TrackedValue<Boolean> enableClassTreeStatIcons = this.value(true);
+
 	public Set<StatType> getIncludedTypesForIcons(Set<StatType> editableTypes) {
 		var types = new HashSet<>(editableTypes);
 		types.removeIf(type -> !this.includedStatTypes.value().contains(type));

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);
 			}
 		}
 	}