Merge remote-tracking branch 'origin/GT-3338-dragonmacher-key-binding-warning'

Author: ryanmkurtz

Ghidra/Framework/Docking/src/main/java/docking/action/DockingAction.java

@@ -92,10 +92,6 @@ public DockingAction(String name, String owner, boolean supportsKeyBindings) {
 			supportsKeyBindings ? KeyBindingType.INDIVIDUAL : KeyBindingType.UNSUPPORTED;
 	}
 
-	protected KeyBindingType getPreferredKeyBindingType() {
-		return KeyBindingType.INDIVIDUAL;
-	}
-
 	@Override
 	public abstract void actionPerformed(ActionContext context);
 
@@ -286,6 +282,11 @@ public KeyBindingData getDefaultKeyBindingData() {
 
 	@Override
 	public void setKeyBindingData(KeyBindingData newKeyBindingData) {
+
+		if (!supportsKeyBinding(newKeyBindingData)) {
+			return;
+		}
+
 		KeyBindingData oldData = keyBindingData;
 		keyBindingData = KeyBindingData.validateKeyBindingData(newKeyBindingData);
 
@@ -296,6 +297,22 @@ public void setKeyBindingData(KeyBindingData newKeyBindingData) {
 		firePropertyChanged(KEYBINDING_DATA_PROPERTY, oldData, keyBindingData);
 	}
 
+	private boolean supportsKeyBinding(KeyBindingData kbData) {
+
+		KeyBindingType type = getKeyBindingType();
+		if (type.supportsKeyBindings()) {
+			return true;
+		}
+
+		if (kbData.getKeyBindingPrecedence() == KeyBindingPrecedence.ReservedActionsLevel) {
+			return true; // reserved actions are special
+		}
+
+		// log a trace message instead of throwing an exception, as to not break any legacy code
+		Msg.error(this, "Action does not support key bindings: " + getFullName(), new Throwable());
+		return false;
+	}
+
 	@Override
 	public void setUnvalidatedKeyBindingData(KeyBindingData newKeyBindingData) {
 		KeyBindingData oldData = keyBindingData;

Ghidra/Framework/Docking/src/main/java/docking/action/KeyBindingType.java

@@ -45,7 +45,6 @@ public enum KeyBindingType {
 	 * <p>Most actions will not be shared.  If you are unsure if your action
 	 * should use a shared keybinding, then do not do so.
 	 */
-	
 	SHARED;
 	//@formatter:on
 

Ghidra/Framework/Docking/src/test.slow/java/docking/actions/SharedKeyBindingDockingActionTest.java

@@ -390,6 +390,21 @@ public void testNonSharedKeyBinding_DifferentActionsWithSameFullName() {
 		assertActionNotInTool(action1Copy);
 	}
 
+	@Test
+	public void testNonKeyBindingAction_CannotSetKeyBinding() {
+
+		DockingAction action = new DockingAction("Test Action", "Test Action Owner", false) {
+			@Override
+			public void actionPerformed(ActionContext context) {
+				// stub
+			}
+		};
+
+		action.setKeyBindingData(new KeyBindingData(DEFAULT_KS_1));
+		assertNull(action.getKeyBindingData());
+		spyLogger.assertLogMessage("does", "not", "support", "bindings");
+	}
+
 //==================================================================================================
 // Private Methods
 //==================================================================================================