GT-3446 - Added key binding to trigger the Show Xrefs dialog

Author: dragonmacher

Ghidra/Features/Base/src/main/help/help/topics/CodeBrowserPlugin/CodeBrowser.htm

@@ -111,21 +111,27 @@ <H2><A name="Navigation"></A>Navigation</H2>
       "help/topics/Tool/ToolOptions_Dialog.htm">Edit Tool Options</A> dialog for control over
       certain Navigation behaviors.</P>
 
+		
+	  <A name="Show_Xrefs"></A>
       <P>In the XRef field, sometimes there are too many addresses to display so the the field will
       display "[more]" to indicate that one or more cross-reference addresses are not shown.</P>
 
       <BLOCKQUOTE>
         <P><IMG border="0" src="../../shared/tip.png" alt=""> Double-clicking on the "<FONT color=
-        "green"><TT>[more]</TT></FONT>" text will cause a <A href=
-        "help/topics/LocationReferencesPlugin/Location_References.html#LocationReferencesPlugin">Location
-        References Dialog</A> to appear. Also, double-clicking on the XREF header text (<FONT
-        color="green"><TT>XREF[n]:</TT></FONT>) will too show this dialog.</P>
+        "green"><TT>XREF[n]:</TT></FONT> or <FONT><TT>[more]</TT></FONT>" text will cause a 
+        dialog containing all the Xrefs to appear.</P>
+        <P>
+        This differs from the <A href=
+        "help/topics/LocationReferencesPlugin/Location_References.html#LocationReferencesPlugin">
+        <B>Show References to ...</B></A> feature in that the Xrefs dialog is simply a display
+        of what already exists in the database, whereas <B>Show References to ...</B> will
+        perform a search to find references additional to what is in the database.
+        </P>
       </BLOCKQUOTE>
 
       <P align="left">This dialog lists all the Xref addresses, any labels that are at that address
       and a preview of the instruction at that address. Clicking on any row in the table will cause
-      the browser to navigate to that address. Double-clicking will navigate and dismiss the
-      dialog.</P>
+      the browser to navigate to that address</P>
     </BLOCKQUOTE>
 
     <H2><A NAME="Keyboard_Controls">Keyboard Controls</H2>

Ghidra/Features/Base/src/main/java/ghidra/app/context/ProgramLocationActionContext.java

@@ -69,7 +69,8 @@ public Address getAddress() {
 	}
 
 	/**
-	 * @return the code unit at the action's program location or null
+	 * Returns the code unit containing the action's program location or null
+	 * @return the code unit containing the action's program location or null
 	 */
 	public CodeUnit getCodeUnit() {
 		if (!codeUnitInitialized) {

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/codebrowser/CodeBrowserPlugin.java

@@ -21,6 +21,7 @@
 import java.math.BigInteger;
 import java.util.*;
 import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.function.Supplier;
 
 import javax.swing.ImageIcon;
 import javax.swing.JComponent;
@@ -32,12 +33,14 @@
 import docking.ActionContext;
 import docking.action.DockingAction;
 import docking.action.MenuData;
+import docking.action.builder.ActionBuilder;
 import docking.tool.ToolConstants;
 import docking.widgets.fieldpanel.*;
 import docking.widgets.fieldpanel.field.Field;
 import docking.widgets.fieldpanel.support.*;
 import ghidra.GhidraOptions;
 import ghidra.app.CorePluginPackage;
+import ghidra.app.context.ListingActionContext;
 import ghidra.app.events.*;
 import ghidra.app.nav.Navigatable;
 import ghidra.app.plugin.PluginCategoryNames;
@@ -60,6 +63,7 @@
 import ghidra.framework.plugintool.util.PluginStatus;
 import ghidra.program.model.address.*;
 import ghidra.program.model.listing.*;
+import ghidra.program.model.symbol.Reference;
 import ghidra.program.util.ProgramLocation;
 import ghidra.program.util.ProgramSelection;
 import ghidra.util.*;
@@ -121,6 +125,8 @@ public class CodeBrowserPlugin extends Plugin
 	private FocusingMouseListener focusingMouseListener = new FocusingMouseListener();
 
 	private DockingAction tableFromSelectionAction;
+	private DockingAction showXrefsAction;
+
 	private Color cursorHighlightColor;
 	private boolean isHighlightCursorLine;
 	private ProgramDropProvider dndProvider;
@@ -440,6 +446,7 @@ void removeProvider(CodeViewerProvider provider) {
 	public void serviceAdded(Class<?> interfaceClass, Object service) {
 		if (interfaceClass == TableService.class) {
 			tool.addAction(tableFromSelectionAction);
+			tool.addAction(showXrefsAction);
 		}
 		if (interfaceClass == ViewManagerService.class && viewManager == null) {
 			viewManager = (ViewManagerService) service;
@@ -471,6 +478,7 @@ public void serviceRemoved(Class<?> interfaceClass, Object service) {
 		if (interfaceClass == TableService.class) {
 			if (tool != null) {
 				tool.removeAction(tableFromSelectionAction);
+				tool.removeAction(showXrefsAction);
 			}
 		}
 		if ((service == viewManager) && (currentProgram != null)) {
@@ -902,6 +910,9 @@ private void initMiscellaneousOptions() {
 	}
 
 	public void initActions() {
+
+		// note: these actions gets added later when the TableService is added
+
 		tableFromSelectionAction = new DockingAction("Create Table From Selection", getName()) {
 			ImageIcon markerIcon = ResourceManager.loadImage("images/searchm_obj.gif");
 
@@ -932,13 +943,35 @@ public boolean isEnabledForContext(ActionContext context) {
 			}
 		};
 
-		// note: this action gets added later when the TableService is added
 		tableFromSelectionAction.setEnabled(false);
 		tableFromSelectionAction.setMenuBarData(new MenuData(
 			new String[] { ToolConstants.MENU_SELECTION, "Create Table From Selection" }, null,
 			"SelectUtils"));
 		tableFromSelectionAction
 				.setHelpLocation(new HelpLocation("CodeBrowserPlugin", "Selection_Table"));
+
+		showXrefsAction = new ActionBuilder("Show Xrefs", getName())
+				.description("Show the Xrefs to the code unit containing the cursor")
+				.validContextWhen(context -> context instanceof ListingActionContext)
+				.onAction(context -> showXrefs(context))
+				.build();
+	}
+
+	private void showXrefs(ActionContext context) {
+
+		TableService service = tool.getService(TableService.class);
+		if (service == null) {
+			return;
+		}
+
+		ListingActionContext lac = (ListingActionContext) context;
+		ProgramLocation location = lac.getLocation();
+		if (location == null) {
+			return; // not sure if this can happen
+		}
+
+		Supplier<Set<Reference>> refs = () -> XReferenceUtil.getAllXrefs(location);
+		XReferenceUtil.showAllXrefs(connectedProvider, tool, service, location, refs);
 	}
 
 	private GhidraProgramTableModel<Address> createTableModel(CodeUnitIterator iterator,

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/codebrowser/CodeViewerProvider.java

@@ -449,6 +449,7 @@ private void createActions() {
 
 		action = new GotoNextFunctionAction(tool, plugin.getName());
 		tool.addAction(action);
+
 	}
 
 	void fieldOptionChanged(String fieldName, Object newValue) {

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/navigation/locationreferences/LocationReferencesPanel.java

@@ -22,7 +22,6 @@
 
 import javax.swing.JPanel;
 import javax.swing.ListSelectionModel;
-import javax.swing.border.TitledBorder;
 import javax.swing.event.TableModelListener;
 
 import ghidra.app.services.GoToService;
@@ -57,7 +56,6 @@ private void buildPanel() {
 		table.setSelectionMode(ListSelectionModel.MULTIPLE_INTERVAL_SELECTION);
 
 		setLayout(new BorderLayout(10, 10));
-		setBorder(new TitledBorder("Reference(s)"));
 
 		PluginTool tool = locationReferencesProvider.getTool();
 		GoToService goToService = tool.getService(GoToService.class);