/* ###
 * 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.trace.model.symbol;

import ghidra.program.model.listing.*;
import ghidra.program.model.symbol.SourceType;
import ghidra.util.exception.DuplicateNameException;
import ghidra.util.exception.InvalidInputException;

public interface TraceFunctionSymbol
		extends TraceNamespaceSymbol, TraceSymbolWithLifespan, Function {

	// TODO: If possible, remove the DuplicateNameException on these three methods.
	/*
	@Override
	void setName(String newName, SourceType source) throws InvalidInputException;
	
	@Override
	void setNameAndNamespace(String newName, Namespace newNamespace, SourceType source)
			throws InvalidInputException, CircularDependencyException;
	
	@Override
	void setNamespace(Namespace newNamespace)
			throws InvalidInputException, CircularDependencyException;
	*/

	@Override
	TraceParameterSymbol getReturn();

	@Override
	TraceParameterSymbol addParameter(Variable var, SourceType source)
			throws DuplicateNameException, InvalidInputException;

	@Override
	TraceParameterSymbol insertParameter(int ordinal, Variable var, SourceType source)
			throws DuplicateNameException, InvalidInputException;

	@Override
	Parameter getParameter(int ordinal);

	@Override
	Parameter moveParameter(int fromOrdinal, int toOrdinal) throws InvalidInputException;

	@Override
	Parameter[] getParameters();

	@Override
	Parameter[] getParameters(VariableFilter filter);

	@Override
	TraceLocalVariableSymbol[] getLocalVariables();

	@Override
	TraceLocalVariableSymbol[] getLocalVariables(VariableFilter filter);

	@Override
	Variable[] getAllVariables();

	@Override
	Variable[] getVariables(VariableFilter filter);

	@Override
	TraceLocalVariableSymbol addLocalVariable(Variable var, SourceType source)
			throws DuplicateNameException, InvalidInputException;

	@Override
	TraceFunctionSymbol getThunkedFunction(boolean recursive);
}
