Document #navigateToNextObfuscatedToken async requirements

Author: Geolykt

enigma-swing/src/main/java/cuchaz/enigma/gui/panels/EditorPanel.java

@@ -125,7 +125,7 @@ public EditorPanel(Gui gui) {
 		customizeEditor(this.editor);
 		this.editor.addCaretListener(event -> onCaretMove(event.getDot(), this.mouseIsPressed));
 
-		// Remove tabulator from focus traversal keys (we give it a different meaning)
+		// Remove the tab key from focus traversal keys (we give it a different meaning)
 		Set<AWTKeyStroke> focusTraversalKeys = new HashSet<>(this.editor.getFocusTraversalKeys(KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS));
 		focusTraversalKeys.removeIf(key -> key.getKeyCode() == KeyEvent.VK_TAB);
 		this.editor.setFocusTraversalKeys(KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, focusTraversalKeys);
@@ -681,28 +681,34 @@ private void showReference0(EntryReference<Entry<?>, Entry<?>> reference) {
 		}
 	}
 
+	/**
+	 * Navigate to the next obfuscated token that can be renamed.
+	 *
+	 * <p>If the tokens are damaged, then this method should not be called
+	 * synchronously. Instead, the call should be wrapped in a
+	 * {@link SwingUtilities#invokeLater(Runnable)}. Failing to do so
+	 * will induce invalid token highlighting regions.
+	 */
 	public void navigateToNextObfuscatedToken() {
-		SwingUtilities.invokeLater(() -> {
-			int caretPos = this.getEditor().getCaretPosition();
-			Token token = this.getToken(this.getEditor().getCaretPosition());
-			NavigableSet<Token> obfuscatedTokens = this.getSource().getTokenStore().getByType().get(RenamableTokenType.OBFUSCATED);
-			Token next;
-
-			if (token == null) {
-				next = obfuscatedTokens.higher(new Token(caretPos, caretPos, null));
-			} else {
-				next = obfuscatedTokens.higher(token);
-			}
+		int caretPos = this.getEditor().getCaretPosition();
+		Token token = this.getToken(this.getEditor().getCaretPosition());
+		NavigableSet<Token> obfuscatedTokens = this.getSource().getTokenStore().getByType().get(RenamableTokenType.OBFUSCATED);
+		Token next;
 
-			if (next == null) {
-				// Wrap to start of document
-				next = obfuscatedTokens.pollFirst();
-			}
+		if (token == null) {
+			next = obfuscatedTokens.higher(new Token(caretPos, caretPos, null));
+		} else {
+			next = obfuscatedTokens.higher(token);
+		}
 
-			if (next != null) {
-				this.navigateToToken(next);
-			}
-		});
+		if (next == null) {
+			// Wrap to start of document
+			next = obfuscatedTokens.pollFirst();
+		}
+
+		if (next != null) {
+			this.navigateToToken(next);
+		}
 	}
 
 	public void navigateToToken(Token token) {

enigma-swing/src/main/java/cuchaz/enigma/gui/panels/IdentifierPanel.java

@@ -13,6 +13,7 @@
 import javax.swing.JComboBox;
 import javax.swing.JLabel;
 import javax.swing.JPanel;
+import javax.swing.SwingUtilities;
 
 import cuchaz.enigma.EnigmaProject;
 import cuchaz.enigma.gui.EditableType;
@@ -202,7 +203,8 @@ public void onStopEditing(ConvertingTextField field, StopEditingCause cause) {
 						doRename(field.getText());
 
 						if (cause == StopEditingCause.TAB && e != null) {
-							e.navigateToNextObfuscatedToken();
+							// invokeLater as per the method's javadocs
+							SwingUtilities.invokeLater(e::navigateToNextObfuscatedToken);
 						}
 					}