ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/actions/AbstractFindReferencesDataTypeAction.java
/* ###
 * IP: GHIDRA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package ghidra.app.actions;

import java.awt.event.InputEvent;
import java.awt.event.KeyEvent;

import javax.swing.KeyStroke;

import docking.ActionContext;
import docking.DockingUtils;
import docking.action.*;
import ghidra.app.plugin.core.navigation.FindAppliedDataTypesService;
import ghidra.app.plugin.core.navigation.locationreferences.ReferenceUtils;
import ghidra.app.services.FieldMatcher;
import ghidra.app.util.HelpTopics;
import ghidra.framework.plugintool.PluginTool;
import ghidra.program.model.data.*;
import ghidra.util.*;

public abstract class AbstractFindReferencesDataTypeAction extends DockingAction {

	private static final String HELP_TOPIC = HelpTopics.FIND_REFERENCES;
	public static final String NAME = "Find References To";
	public static final KeyStroke DEFAULT_KEY_STROKE = KeyStroke.getKeyStroke(KeyEvent.VK_F,
		DockingUtils.CONTROL_KEY_MODIFIER_MASK | InputEvent.SHIFT_DOWN_MASK);
	private PluginTool tool;

	protected AbstractFindReferencesDataTypeAction(PluginTool tool, String name, String owner) {
		this(tool, name, owner, null);
	}

	protected AbstractFindReferencesDataTypeAction(PluginTool tool, String name, String owner,
			KeyStroke defaultKeyStroke) {
		super(name, owner, KeyBindingType.SHARED);
		this.tool = tool;

		setHelpLocation(new HelpLocation(HELP_TOPIC, "Data_Types"));
		setDescription("Shows all uses of the selected data type");

		initKeyStroke(defaultKeyStroke);
	}

	protected abstract DataType getDataType(ActionContext context);

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

	private void initKeyStroke(KeyStroke keyStroke) {
		if (keyStroke == null) {
			return;
		}

		setKeyBindingData(new KeyBindingData(keyStroke));
	}

	@Override
	public boolean isEnabledForContext(ActionContext context) {
		DataType dataType = getDataType(context);
		return dataType != null;
	}

	@Override
	public void actionPerformed(ActionContext context) {

		FindAppliedDataTypesService service = tool.getService(FindAppliedDataTypesService.class);
		if (service == null) {
			Msg.showError(this, null, "Missing Plugin",
				"The FindAppliedDataTypesService is not installed.\n" +
					"Please add the plugin implementing this service.");
			return;
		}

		DataType dataType = getDataType(context);
		DataType baseDataType = ReferenceUtils.getBaseDataType(dataType);
		String field = getDataTypeField(baseDataType);
		Swing.runLater(() -> doFindDataTypeUsage(service, baseDataType, field));
	}

	private void doFindDataTypeUsage(FindAppliedDataTypesService service, DataType dt,
			String field) {

		if (field == null) {
			// no field specified; search for all uses of the given type
			service.findAndDisplayAppliedDataTypeAddresses(dt);
			return;
		}

		if (dt instanceof Structure) {
			Integer offset = getOffsetForDeafaultFieldName((Structure) dt, field);
			if (offset != null) {
				// The user has picked a field by it's default name.  In this case we need to
				// search by offset to ensure we find code that does not use the default name.
				FieldMatcher fieldMatcher = new FieldMatcher(dt, offset);
				service.findAndDisplayAppliedDataTypeAddresses(dt, fieldMatcher);
				return;
			}
		}

		service.findAndDisplayAppliedDataTypeAddresses(dt, field);
	}

	private Integer getOffsetForDeafaultFieldName(Structure structure, String fieldName) {
		DataTypeComponent[] components = structure.getComponents();
		for (DataTypeComponent dtc : components) {
			String defaultName = dtc.getDefaultFieldName();
			if (fieldName.equals(defaultName)) {
				return dtc.getOffset();
			}
		}
		return null;
	}
}
