ghidra-master/Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/equate/RenameEquatesCmd.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.plugin.core.equate;

import ghidra.framework.cmd.Command;
import ghidra.framework.model.DomainObject;
import ghidra.program.model.listing.Program;
import ghidra.program.model.symbol.*;
import ghidra.util.exception.*;

/**
 * Command for moving all references to an equate to some other equate. If an equate
 * for the new name does not exist, it will be created and all references will be moved
 * to it before deleting the original equate.  If an equate already exists with that
 * name (it better have the correct value or we shouldn't have gotten this far!), its
 * references will be merged with the original equate references.  The undo method
 * will restore everything back to where it was when this object was created.  The
 * redo method will repeat the rename operation.
 */
class RenameEquatesCmd implements Command {

	private String newEquateName;
	private String oldEquateName;

	private String msg;

	/**
	 * Constructor
	 * @param program the current program
	 * @param equate the equate to be renamed.
	 * @param newEquateName the new name for the equate
	 */
	RenameEquatesCmd(String oldEquateName, String newEquateName) {
		this.oldEquateName = oldEquateName;
		this.newEquateName = newEquateName;
	}

	/**
	 * The name of the edit action.
	 */
	@Override
	public String getName() {
		return "Rename Equates";
	}

	/**
	 * @see ghidra.framework.cmd.Command#applyTo(ghidra.framework.plugintool.PluginTool, ghidra.framework.model.DomainObject)
	 */
	@Override
	public boolean applyTo(DomainObject obj) {
		EquateTable etable = ((Program) obj).getEquateTable();

		// See if there's an entry in the table for the old equate name.  There should be,
		// otherwise there's a problem.
		Equate fromEquate = etable.getEquate(oldEquateName);
		if (fromEquate == null) {
			msg = "Equate not found: " + oldEquateName;
			return false;
		}
		
		// Now get the entry in the Equate table for the new equate name.  If there's
		// already an entry with this name, just use that...otherwise, create a new one.
		Equate toEquate = etable.getEquate(newEquateName);
		if (toEquate == null) {
			try {
				toEquate = etable.createEquate(newEquateName, fromEquate.getValue());
			}
			catch (DuplicateNameException e) {
				throw new AssertException();
			}
			catch (InvalidInputException e) {
				msg = "Invalid equate name: " + newEquateName;
				return false;
			}
		}

		// Finally, move all references to the old equate to the new one.
		EquateReference[] refList = fromEquate.getReferences();
		etable.removeEquate(oldEquateName);
		for (EquateReference element : refList) {
			toEquate.addReference(element.getAddress(), element.getOpIndex());
		}
		return true;
	}

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

}
