ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/context/ProgramLocationActionContext.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.ComponentProvider;
import ghidra.program.model.address.Address;
import ghidra.program.model.listing.*;
import ghidra.program.util.ProgramLocation;
import ghidra.program.util.ProgramSelection;

public class ProgramLocationActionContext extends ProgramActionContext {

	private final ProgramLocation location;
	private final ProgramSelection selection;
	private final ProgramSelection highlight;

	private CodeUnit cu;
	private boolean codeUnitInitialized = false;

	public ProgramLocationActionContext(ComponentProvider provider, Program program,
			ProgramLocation location, ProgramSelection selection, ProgramSelection highlight) {
		super(provider, program);
		this.location = location;
		this.selection = selection;
		this.highlight = highlight;
	}

	/**
	 * @return Returns the program location.
	 */
	public ProgramLocation getLocation() {
		return location;
	}

	/**
	 * @return Returns the program selection.
	 */
	public ProgramSelection getSelection() {
		return selection == null ? new ProgramSelection() : selection;
	}

	public ProgramSelection getHighlight() {
		return highlight == null ? new ProgramSelection() : highlight;

	}

	/**
	 * @return address corresponding to the action's program location or null
	 * if program location is null.
	 */
	public Address getAddress() {
		if (location != null) {
			return location.getAddress();
		}
		return 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) {
			Address addr = getAddress();
			if (addr != null) {
				cu = program.getListing().getCodeUnitContaining(addr);
				if (cu instanceof Data && location.getComponentPath() != null) {
					Data data = (Data) cu;
					cu = data.getComponent(location.getComponentPath());
				}
			}
			codeUnitInitialized = true;
		}
		return cu;
	}

	public boolean hasSelection() {
		return (selection != null && !selection.isEmpty());
	}

	public boolean hasHighlight() {
		return (highlight != null && !highlight.isEmpty());
	}
}
