Package ghidra.program.model.listing
Interface FunctionSignature
- All Known Subinterfaces:
FunctionDefinition
- All Known Implementing Classes:
FunctionDefinitionDataType
,FunctionSignatureImpl
public interface FunctionSignature
Interface describing all the things about a function that are portable
from one program to another.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionReturn an array of parameters for the functionReturn the comment stringReturns the generic calling convention associated with this function definition.getName()
Return the name of this functionReturn a string representation of the function signature without the calling convention specified.getPrototypeString
(boolean includeCallingConvention) Return a string representation of the function signatureReturn the return data typeboolean
Returns true if this function signature has a variable argument list (VarArgs).boolean
isEquivalentSignature
(FunctionSignature signature) Returns true if the given signature is equivalent to this signature.
-
Field Details
-
VAR_ARGS_DISPLAY_STRING
- See Also:
-
VOID_PARAM_DISPLAY_STRING
- See Also:
-
-
Method Details
-
getName
String getName()Return the name of this function -
getPrototypeString
String getPrototypeString()Return a string representation of the function signature without the calling convention specified. -
getPrototypeString
Return a string representation of the function signature- Parameters:
includeCallingConvention
- if true prototype will include call convention declaration if known.
-
getArguments
ParameterDefinition[] getArguments()Return an array of parameters for the function -
getReturnType
DataType getReturnType()Return the return data type -
getComment
String getComment()Return the comment string -
hasVarArgs
boolean hasVarArgs()Returns true if this function signature has a variable argument list (VarArgs). -
getGenericCallingConvention
GenericCallingConvention getGenericCallingConvention()Returns the generic calling convention associated with this function definition. The "unknown" convention should be returned instead of null. -
isEquivalentSignature
Returns true if the given signature is equivalent to this signature. The precise meaning of "equivalent" is dependent upon return/parameter dataTypes.- Parameters:
signature
- the function signature being tested for equivalence.- Returns:
- true if the if the given signature is equivalent to this signature.
-