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

import java.util.*;

import ghidra.app.services.FunctionComparisonModel;
import ghidra.program.model.listing.Function;

/**
 * Defines the structure of a function comparison. The relationship is strictly
 * one-to-many; a single <code>source</code> function may be associated with one 
 * or more <code>target</code> functions. 
 * <p>
 * This is the basic unit for the 
 * {@link FunctionComparisonModel function comparison data model}
 */
public class FunctionComparison implements Comparable<FunctionComparison> {

	private Function source;

	/** Use a tree so functions are always kept in sorted order */
	private Set<Function> targets = new TreeSet<>(new FunctionComparator());

	/**
	 * Returns the source function
	 * 
	 * @return the source function
	 */
	public Function getSource() {
		return source;
	}

	/**
	 * Returns the set of targets, in sorted order by function name
	 * 
	 * @return the set of targets
	 */
	public Set<Function> getTargets() {
		return targets;
	}

	/**
	 * Sets a given function as the comparison source
	 * 
	 * @param function the source function
	 */
	public void setSource(Function function) {
		source = function;
	}

	/**
	 * Adds a target function to the comparison
	 * 
	 * @param function the function to add to the target list
	 */
	public void addTarget(Function function) {
		targets.add(function);
	}

	/**
	 * Adds a set of functions to the target list
	 * 
	 * @param functions the functions to add
	 */
	public void addTargets(Set<Function> functions) {
		targets.addAll(functions);
	}

	/**
	 * Removes the given function from the target list. 
	 * <p>
	 * Note that the target list is a {@link Set}, so there will only ever
	 * be at most one entry that matches the given function
	 * 
	 * @param function the function to remove
	 */
	public void removeTarget(Function function) {
		targets.remove(function);
	}

	/**
	 * Removes all targets from the comparison
	 */
	public void clearTargets() {
		targets.clear();
	}

	/**
	 * Ensures that FunctionComparison objects are always ordered according
	 * to the source program path, name and address
	 */
	@Override
	public int compareTo(FunctionComparison o) {
		if (o == null) {
			return 1;
		}

		String sourcePath = getSource().getProgram().getDomainFile().getPathname();
		String otherPath = o.getSource().getProgram().getDomainFile().getPathname();

		String sourceName = getSource().getName();
		String otherName = o.getSource().getName();
		int result = sourcePath.compareTo(otherPath);
		if (result != 0) {
			return result;
		}

		// equal paths
		result = sourceName.compareTo(otherName);
		if (result != 0) {
			return result;
		}

		// equal names
		return getSource().getEntryPoint().compareTo(o.getSource().getEntryPoint());
	}

	/**
	 * Forces an ordering on {@link Function} objects by program path, name and 
	 * address. This is to ensure that the list of targets is kept in sorted 
	 * order at all times.
	 */
	class FunctionComparator implements Comparator<Function> {

		@Override
		public int compare(Function o1, Function o2) {
			if (o2 == null) {
				return 1;
			}

			String o1Path = o1.getProgram().getDomainFile().getPathname();
			String o2Path = o2.getProgram().getDomainFile().getPathname();
			int result = o1Path.compareTo(o2Path);
			if (result != 0) {
				return result;
			}

			// equal paths
			String o1Name = o1.getName();
			String o2Name = o2.getName();
			result = o1Name.compareTo(o2Name);
			if (result != 0) {
				return result;
			}

			// equal names
			return o1.getEntryPoint().compareTo(o2.getEntryPoint());
		}
	}
}
