ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/cmd/refs/RemoveAllReferencesCmd.java
/* ###
 * IP: GHIDRA
 * REVIEWED: YES
 *
 * 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.cmd.refs;

import ghidra.framework.cmd.Command;
import ghidra.framework.model.DomainObject;
import ghidra.program.model.address.Address;
import ghidra.program.model.listing.Program;
import ghidra.program.model.symbol.*;

/**
 * Command to remove all references at an address or for a particular operand 
 * index at an address.
 */
public class RemoveAllReferencesCmd implements Command {

	private Address fromAddr;
	private int opIndex;
	private boolean useOpIndex;
	
	/**
     * Constructs a new command for removing all references.
	 * @param fromAddr the address of the codeunit making the reference.
     */
    public RemoveAllReferencesCmd(Address fromAddr) {
		this.fromAddr = fromAddr;
		this.useOpIndex = false;
    }
    
    /**
     * Constructs a new command for removing all references.
 	 * @param fromAddr the address of the codeunit making the reference.
	 * @param opIndex the operand index.
     */
    public RemoveAllReferencesCmd(Address fromAddr, int opIndex) {
		this.fromAddr = fromAddr;
		this.opIndex = opIndex;
		this.useOpIndex = true;
    }

	/**
	 * 
	 * @see ghidra.framework.cmd.Command#applyTo(ghidra.framework.model.DomainObject)
	 */
    public boolean applyTo(DomainObject obj) {
    	Program program = (Program)obj;
    	ReferenceManager refMgr = program.getReferenceManager();

    	if (!useOpIndex) {
    		refMgr.removeAllReferencesFrom(fromAddr);
    		return true;
    	}
    	
    	Reference[] refs = refMgr.getReferencesFrom(fromAddr, opIndex);
		for (int i = 0; i < refs.length; i++) {
			refMgr.delete(refs[i]);
			RemoveReferenceCmd.fixupReferencedVariable(program, refs[i]);
		}
 		return true;
    }

    /**
     * @see ghidra.framework.cmd.Command#getStatusMsg()
     */
    public String getStatusMsg() {
        return null;
    }

    /**
     * @see ghidra.framework.cmd.Command#getName()
     */
    public String getName() {
        return "Remove References";
    }

}

