Package ghidra.program.model.listing
Interface FunctionSignature
-
- All Known Subinterfaces:
FunctionDefinition
- All Known Implementing Classes:
FunctionDefinitionDataType,FunctionSignatureImpl
public interface FunctionSignatureInterface describing all the things about a function that are portable from one program to another.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringVAR_ARGS_DISPLAY_STRINGstatic java.lang.StringVOID_PARAM_DISPLAY_STRING
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ParameterDefinition[]getArguments()Return an array of parameters for the functionjava.lang.StringgetComment()Return the comment stringGenericCallingConventiongetGenericCallingConvention()Returns the generic calling convention associated with this function definition.java.lang.StringgetName()Return the name of this functionjava.lang.StringgetPrototypeString()Return a string representation of the function signature without the calling convention specified.java.lang.StringgetPrototypeString(boolean includeCallingConvention)Return a string representation of the function signatureDataTypegetReturnType()Return the return data typebooleanhasVarArgs()Returns true if this function signature has a variable argument list (VarArgs).booleanisEquivalentSignature(FunctionSignature signature)Returns true if the given signature is equivalent to this signature.
-
-
-
Field Detail
-
VAR_ARGS_DISPLAY_STRING
static final java.lang.String VAR_ARGS_DISPLAY_STRING
- See Also:
- Constant Field Values
-
VOID_PARAM_DISPLAY_STRING
static final java.lang.String VOID_PARAM_DISPLAY_STRING
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
java.lang.String getName()
Return the name of this function
-
getPrototypeString
java.lang.String getPrototypeString()
Return a string representation of the function signature without the calling convention specified.
-
getPrototypeString
java.lang.String getPrototypeString(boolean includeCallingConvention)
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
java.lang.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
boolean isEquivalentSignature(FunctionSignature signature)
Returns true if the given signature is equivalent to this signature. The precise meaning of "equivalent" is dependent upon return/parameter dataTypes.- Parameters:
dt- the dataType being tested for equivalence.- Returns:
- true if the if the given signature is equivalent to this signature.
-
-