GP-1514 - Find References to - Added support for finding usage of enum

fields

Closes #1967

Ghidra/Features/Base/src/main/java/ghidra/app/actions/AbstractFindReferencesDataTypeAction.java

@@ -27,7 +27,6 @@ import ghidra.app.plugin.core.navigation.FindAppliedDataTypesService;
 import ghidra.app.plugin.core.navigation.locationreferences.ReferenceUtils;
 import ghidra.app.util.HelpTopics;
 import ghidra.framework.plugintool.PluginTool;
-import ghidra.program.model.data.Composite;
 import ghidra.program.model.data.DataType;
 import ghidra.util.*;
 
@@ -56,7 +55,7 @@ public abstract class AbstractFindReferencesDataTypeAction extends DockingAction
 
 	protected abstract DataType getDataType(ActionContext context);
 
-	protected String getDataTypeField() {
+	protected String getDataTypeField(DataType baseDataType) {
 		// The base implementation only searches for references to the data type, not specific
 		// fields.  Subclasses can change this behavior
 		return null;
@@ -89,23 +88,8 @@ public abstract class AbstractFindReferencesDataTypeAction extends DockingAction
 
 		DataType dataType = getDataType(context);
 		DataType baseDataType = ReferenceUtils.getBaseDataType(dataType);
-		String field = getDataTypeField();
-
-		// sanity check - should not happen
-		if (field != null && !(baseDataType instanceof Composite)) {
-			Msg.error(this, "Somehow have a field without a Composite parent--searching " +
-				"only for the parent type '" + dataType + "'; field '" + field + "'");
-			Swing.runLater(() -> service.findAndDisplayAppliedDataTypeAddresses(dataType));
-			return;
-		}
-
-		if (field == null) {
-			Swing.runLater(() -> service.findAndDisplayAppliedDataTypeAddresses(dataType));
-		}
-		else {
-			Swing.runLater(() -> service.findAndDisplayAppliedDataTypeAddresses(
-				(Composite) baseDataType, field));
-		}
+		String field = getDataTypeField(baseDataType);
+		Swing.runLater(() -> service.findAndDisplayAppliedDataTypeAddresses(baseDataType, field));
 	}
 
 }

Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/datamgr/actions/FindReferencesToFieldAction.java

@@ -18,7 +18,6 @@ package ghidra.app.plugin.core.datamgr.actions;
 import java.util.ArrayList;
 import java.util.List;
 
-import javax.swing.SwingUtilities;
 import javax.swing.tree.TreePath;
 
 import org.apache.commons.lang3.StringUtils;
@@ -35,8 +34,8 @@ import ghidra.app.plugin.core.datamgr.tree.DataTypeNode;
 import ghidra.app.plugin.core.navigation.FindAppliedDataTypesService;
 import ghidra.framework.plugintool.PluginTool;
 import ghidra.program.model.data.*;
-import ghidra.util.HelpLocation;
-import ghidra.util.Msg;
+import ghidra.program.model.data.Enum;
+import ghidra.util.*;
 
 public class FindReferencesToFieldAction extends DockingAction {
 
@@ -72,7 +71,7 @@ public class FindReferencesToFieldAction extends DockingAction {
 		}
 		DataTypeNode dtNode = (DataTypeNode) node;
 		DataType dataType = dtNode.getDataType();
-		return dataType instanceof Composite;
+		return dataType instanceof Composite || dataType instanceof Enum;
 	}
 
 	@Override
@@ -83,7 +82,6 @@ public class FindReferencesToFieldAction extends DockingAction {
 
 		PluginTool tool = plugin.getTool();
 		FindAppliedDataTypesService service = tool.getService(FindAppliedDataTypesService.class);
-
 		if (service == null) {
 			Msg.showError(this, null, "Missing Plugin",
 				"The FindAppliedDataTypesService is not installed.\n" +
@@ -91,7 +89,27 @@ public class FindReferencesToFieldAction extends DockingAction {
 			return;
 		}
 
-		Composite composite = (Composite) dataTypeNode.getDataType();
+		DataType dt = dataTypeNode.getDataType();
+		String[] choices = null;
+		if (dt instanceof Composite) {
+			choices = getCompisiteFieldNames((Composite) dt);
+		}
+		else if (dt instanceof Enum) {
+			choices = ((Enum) dt).getNames();
+		}
+
+		String userChoice = OptionDialog.showInputChoiceDialog(null, "Choose Field",
+			"Find uses of '" + dt.getName() + "' field", choices, null,
+			OptionDialog.QUESTION_MESSAGE);
+		if (userChoice == null) {
+			return;
+		}
+
+		Swing.runLater(
+			() -> service.findAndDisplayAppliedDataTypeAddresses(dt, userChoice));
+	}
+
+	private String[] getCompisiteFieldNames(Composite composite) {
 		DataTypeComponent[] components = composite.getDefinedComponents();
 		List<String> names = new ArrayList<>();
 		for (DataTypeComponent dataTypeComponent : components) {
@@ -105,17 +123,7 @@ public class FindReferencesToFieldAction extends DockingAction {
 			names.add(fieldName);
 		}
 
-		String[] array = names.toArray(new String[names.size()]);
-		String userChoice = OptionDialog.showInputChoiceDialog(null, "Choose Field",
-			"Find uses of '" + composite.getName() + "' field", array, null,
-			OptionDialog.QUESTION_MESSAGE);
-
-		if (userChoice == null) {
-			return;
-		}
-
-		SwingUtilities.invokeLater(
-			() -> service.findAndDisplayAppliedDataTypeAddresses(composite, userChoice));
+		return names.toArray(String[]::new);
 	}
 
 }

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

@@ -15,7 +15,6 @@
  */
 package ghidra.app.plugin.core.navigation;
 
-import ghidra.program.model.data.Composite;
 import ghidra.program.model.data.DataType;
 
 /**
@@ -24,7 +23,7 @@ import ghidra.program.model.data.DataType;
 public interface FindAppliedDataTypesService {
 
 	/**
-	 * Tells this service to find all places where the given datatype is defined <b>and</b> will
+	 * Tells this service to find all places where the given datatype is applied <b>and</b> will
 	 * display the results of the search.
 	 * 
 	 * @param dataType The datatype which to base the search upon.
@@ -32,11 +31,11 @@ public interface FindAppliedDataTypesService {
 	public void findAndDisplayAppliedDataTypeAddresses(DataType dataType);
 
 	/**
-	 * Tells this service to find all places where the given datatype is defined <b>and</b> will
+	 * Tells this service to find all places where the given datatype is applied <b>and</b> will
 	 * display the results of the search.
 	 * 
 	 * @param dataType The datatype which to base the search upon.
 	 * @param fieldName the sub-field for which to search
 	 */
-	public void findAndDisplayAppliedDataTypeAddresses(Composite dataType, String fieldName);
+	public void findAndDisplayAppliedDataTypeAddresses(DataType dataType, String fieldName);
 }

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

@@ -22,7 +22,6 @@ import org.apache.commons.lang3.StringUtils;
 import docking.widgets.fieldpanel.support.Highlight;
 import ghidra.app.util.viewer.field.*;
 import ghidra.program.model.address.Address;
-import ghidra.program.model.data.Composite;
 import ghidra.program.model.listing.Data;
 import ghidra.program.model.listing.Program;
 import ghidra.util.datastruct.Accumulator;
@@ -30,8 +29,8 @@ import ghidra.util.exception.CancelledException;
 import ghidra.util.task.TaskMonitor;
 
 /**
- * A data type location descriptor that allows you to represent a location for a member field of
- * a composite.
+ * A data type location descriptor that allows you to represent a location for a member field of a
+ * data type, such as a composite or an enum
  */
 public class GenericCompositeDataTypeLocationDescriptor extends GenericDataTypeLocationDescriptor {
 
@@ -50,9 +49,7 @@ public class GenericCompositeDataTypeLocationDescriptor extends GenericDataTypeL
 	@Override
 	protected void doGetReferences(Accumulator<LocationReference> accumulator, TaskMonitor monitor)
 			throws CancelledException {
-
-		Composite currentDataType = (Composite) getDataType();
-		ReferenceUtils.findDataTypeReferences(accumulator, currentDataType, fieldName, program,
+		ReferenceUtils.findDataTypeReferences(accumulator, getDataType(), fieldName, program,
 			useDynamicSearching, monitor);
 	}
 
@@ -102,13 +99,13 @@ public class GenericCompositeDataTypeLocationDescriptor extends GenericDataTypeL
 			// the parent's name and not the field's name.
 		}
 		else if (LabelFieldFactory.class.isAssignableFrom(fieldFactoryClass)) {
-			// It would be nice to highlight the label that points into data structures.  
+			// It would be nice to highlight the label that points into data structures.
 			// However, the label is on the parent address, which is not in our list of matches
-			// when we are offcut.  Further, using the program to lookup each address that 
+			// when we are offcut.  Further, using the program to lookup each address that
 			// comes in to see if it is our paren't address seems too expensive, as highlighting
 			// code is called for every paint operation.
 			//
-			// We could add the parent match to the list of known addresses and then use that 
+			// We could add the parent match to the list of known addresses and then use that
 			// to lookup in real-time later.  To do this we would need the current list of
 			// reference addresses and a new list of parent data addresses.  That seems a bit
 			// involved just for highlighting a label.

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

@@ -18,12 +18,13 @@ package ghidra.app.plugin.core.navigation.locationreferences;
 import java.util.Objects;
 
 import ghidra.program.model.data.Composite;
+import ghidra.program.model.data.DataType;
 import ghidra.program.model.listing.Program;
 
 /**
- * A class to signal that the ProgramLocation is used for data types and is not really 
- * connected to the listing.  This is a subclass specifically for {@link Composite} types and a
- * particular field name of the given composite.
+ * A class to signal that the ProgramLocation is used for data types and is not really
+ * connected to the listing.  This is a subclass is designed for data types that have fields, such
+ * as {@link Composite} types and {@link Enum} types.
  * 
  * @see GenericCompositeDataTypeLocationDescriptor
  */
@@ -31,7 +32,7 @@ public class GenericCompositeDataTypeProgramLocation extends GenericDataTypeProg
 
 	private String fieldName;
 
-	GenericCompositeDataTypeProgramLocation(Program program, Composite dataType, String fieldName) {
+	GenericCompositeDataTypeProgramLocation(Program program, DataType dataType, String fieldName) {
 		super(program, dataType);
 		this.fieldName = Objects.requireNonNull(fieldName);
 	}

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

@@ -33,7 +33,6 @@ import ghidra.app.util.query.TableService;
 import ghidra.framework.options.ToolOptions;
 import ghidra.framework.plugintool.*;
 import ghidra.framework.plugintool.util.PluginStatus;
-import ghidra.program.model.data.Composite;
 import ghidra.program.model.data.DataType;
 import ghidra.program.model.listing.Program;
 import ghidra.program.model.symbol.Reference;
@@ -102,10 +101,10 @@ public class LocationReferencesPlugin extends Plugin
 		tool.addAction(referencesToAddressAction);
 
 		//
-		// Unusual Code: This plugin does not use the delete action directly, but our transient 
-		//               tables do. We need a way to have keybindings shared for this action.  
+		// Unusual Code: This plugin does not use the delete action directly, but our transient
+		//               tables do. We need a way to have keybindings shared for this action.
 		//               Further, we need to register it now, not when the transient
-		//               providers are created, as they would only appear in the options at 
+		//               providers are created, as they would only appear in the options at
 		//               that point.
 		//
 		DeleteTableRowAction.registerDummy(tool, getName());
@@ -173,7 +172,7 @@ public class LocationReferencesPlugin extends Plugin
 
 		tool.showComponentProvider(provider, true);
 
-// REFS: is the following statement true???...it seems that the loading is off the swing thread, 
+// REFS: is the following statement true???...it seems that the loading is off the swing thread,
 // so it still may not be done at this point!
 
 		// we add the provider here instead of where it is created above to allow the provider to
@@ -311,7 +310,7 @@ public class LocationReferencesPlugin extends Plugin
 	}
 
 	@Override
-	public void findAndDisplayAppliedDataTypeAddresses(Composite dataType, String fieldName) {
+	public void findAndDisplayAppliedDataTypeAddresses(DataType dataType, String fieldName) {
 		ProgramManager programManagerService = tool.getService(ProgramManager.class);
 		GoToService goToService = tool.getService(GoToService.class);
 		Program program = programManagerService.getCurrentProgram();

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

@@ -31,7 +31,6 @@ import ghidra.program.util.*;
 import ghidra.util.*;
 import ghidra.util.classfinder.ClassSearcher;
 import ghidra.util.datastruct.*;
-import ghidra.util.exception.AssertException;
 import ghidra.util.exception.CancelledException;
 import ghidra.util.task.TaskMonitor;
 
@@ -210,11 +209,6 @@ public final class ReferenceUtils {
 		// Note: none of the params can be null, but this one gets used much later, so check now
 		Objects.requireNonNull(dataType, () -> "Data Type cannot be null");
 
-		// sanity check
-		if (fieldName != null && !(dataType instanceof Composite)) {
-			throw new IllegalArgumentException("Can only search for a field with a Composite type");
-		}
-
 		if (monitor == null) {
 			monitor = TaskMonitor.DUMMY;
 		}
@@ -283,12 +277,6 @@ public final class ReferenceUtils {
 			accumulator.add(locationReference);
 		};
 
-		if (fieldName != null && !(dataType instanceof Composite)) {
-			throw new AssertException(
-				"Must have a Composite data type to perform a field search.  Found " + dataType +
-					"; field '" + fieldName + "'");
-		}
-
 		if (finders.isEmpty()) {
 			Msg.debug(ReferenceUtils.class, "Unable to find any implementations of " +
 				DataTypeReferenceFinder.class.getSimpleName());
@@ -300,7 +288,7 @@ public final class ReferenceUtils {
 				finder.findReferences(program, dataType, callback, monitor);
 			}
 			else {
-				finder.findReferences(program, (Composite) dataType, fieldName, callback, monitor);
+				finder.findReferences(program, dataType, fieldName, callback, monitor);
 			}
 		}
 	}

Ghidra/Features/Base/src/main/java/ghidra/app/services/DataTypeReference.java

@@ -68,7 +68,7 @@ public class DataTypeReference {
 			fieldNameText +
 			"\tfunction: " + function.getName() + "\n" +
 			"\taddress: " + address + "\n" +
-			"\tcontext: " + context + "\n" +
+			"\tcontext: " + context.getPlainText() + "\n" +
 		"}";
 		//@formatter:on
 	}

Ghidra/Features/Base/src/main/java/ghidra/app/services/DataTypeReferenceFinder.java

@@ -33,10 +33,10 @@ import ghidra.util.task.TaskMonitor;
 public interface DataTypeReferenceFinder extends ExtensionPoint {
 
 	/**
-	 * Finds references in the current program in a manner appropriate with the given 
+	 * Finds references in the current program in a manner appropriate with the given
 	 * implementation.
 	 * <p>
-	 * Note that this operation is multi-threaded and that results will be delivered as they 
+	 * Note that this operation is multi-threaded and that results will be delivered as they
 	 * are found via the <code>callback</code>.
 	 * 
 	 * @param program the program to search
@@ -53,16 +53,16 @@ public interface DataTypeReferenceFinder extends ExtensionPoint {
 	 * Finds references in the current program to specific field of the given {@link Composite} type
 	 * in a manner appropriate with the given implementation.
 	 * <p>
-	 * Note that this operation is multi-threaded and that results will be delivered as they 
+	 * Note that this operation is multi-threaded and that results will be delivered as they
 	 * are found via the <code>callback</code>.
 	 * 
 	 * @param program the program to search
-	 * @param composite the type containing the field for which to search
+	 * @param dataType the type containing the field for which to search
 	 * @param fieldName the name of the composite's field for which to search
 	 * @param callback the callback to be called when a reference is found
 	 * @param monitor the monitor that allows for progress and cancellation
 	 * @throws CancelledException if the operation was cancelled
 	 */
-	public void findReferences(Program program, Composite composite, String fieldName,
+	public void findReferences(Program program, DataType dataType, String fieldName,
 			Consumer<DataTypeReference> callback, TaskMonitor monitor) throws CancelledException;
 }