ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/context/NavigatableContextAction.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.context;

import docking.ActionContext;
import docking.action.DockingAction;
import docking.action.KeyBindingType;

public abstract class NavigatableContextAction extends DockingAction {
	// means this action is applicable on navigable providers that restrict the program view such
	// as the FunctionGraph or the Decompiler views.
	private final boolean supportsRestrictedAddressSetContext;

	/**
	 * Constructor for actions that can work on any Navigatable
	 * 
	 * @param name the action's name
	 * @param owner the action's owner
	 */
	public NavigatableContextAction(String name, String owner) {
		this(name, owner, true);
	}

	/**
	 * Constructor for specifying if that the context works on {@link RestrictedAddressSetContext}
	 * 
	 * @param name the action's name
	 * @param owner the action's owner
	 * @param supportsRestrictedAddressSetContext true if this action can work on
	 *  {@link RestrictedAddressSetContext}
	 */
	public NavigatableContextAction(String name, String owner,
			boolean supportsRestrictedAddressSetContext) {
		super(name, owner);
		setContextClass(NavigatableActionContext.class, true);
		this.supportsRestrictedAddressSetContext = supportsRestrictedAddressSetContext;
	}

	/**
	 * Constructor when using a non-standard {@link KeyBindingType}
	 * 
	 * @param name the action's name
	 * @param owner the action's owner
	 * @param type the KeybindingType
	 */
	public NavigatableContextAction(String name, String owner, KeyBindingType type) {
		super(name, owner, type);
		setContextClass(NavigatableActionContext.class, true);
		this.supportsRestrictedAddressSetContext = true;
	}

	@Override
	public boolean isEnabledForContext(ActionContext context) {
		if (context instanceof NavigatableActionContext) {
			return isEnabledForContext((NavigatableActionContext) context);
		}
		return false;
	}

	@Override
	public void actionPerformed(ActionContext context) {
		if (context instanceof NavigatableActionContext) {
			actionPerformed((NavigatableActionContext) context);
		}
	}

	@Override
	public final boolean isValidContext(ActionContext context) {
		// If this method returns false, then when the user is in a restricted view, the action
		// will be passed the global context instead of the current local context
		if (!supportsRestrictedAddressSetContext &&
			context instanceof RestrictedAddressSetContext) {
			return false;
		}
		return context instanceof NavigatableActionContext;
	}

	@Override
	public boolean isAddToPopup(ActionContext context) {
		if (!(context instanceof NavigatableActionContext)) {
			return false;
		}
		return isAddToPopup((NavigatableActionContext) context);
	}

	protected boolean isEnabledForContext(NavigatableActionContext context) {
		// assume that all Navigatable context actions require a valid program location
		return context.getLocation() != null;
	}

	protected boolean isAddToPopup(NavigatableActionContext context) {
		return isEnabledForContext(context);
	}

	protected abstract void actionPerformed(NavigatableActionContext context);
}
