Package ghidra.app.util.demangler
Class DemangledFunction
java.lang.Object
ghidra.app.util.demangler.DemangledObject
ghidra.app.util.demangler.DemangledFunction
- All Implemented Interfaces:
Demangled
- Direct Known Subclasses:
DemangledLambda
A class to represent a demangled function.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
static final String
protected boolean
protected List<DemangledDataType>
static final String
static final String
protected DemangledDataType
protected DemangledTemplate
protected boolean
static final String
static final String
Fields inherited from class ghidra.app.util.demangler.DemangledObject
basedName, EMPTY_STRING, isRestrict, isStatic, isThunk, isUnaligned, isVirtual, mangled, memberScope, namespace, NAMESPACE_SEPARATOR, originalDemangled, SPACE, SPACE_PATTERN, specialPrefix, storageClass, visibility
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addParameter
(DemangledDataType parameter) protected void
addParameters
(StringBuilder buffer, boolean format) boolean
applyTo
(Program program, Address address, DemanglerOptions options, TaskMonitor monitor) protected Function
createFunction
(Program prog, Address addr, boolean doDisassembly, TaskMonitor monitor) Returns the calling convention or null, if unspecified.Returns this object's namespace name without the fully-qualified parent path.Returns the return type or null, if unspecified.getSignature
(boolean format) Returns a complete signature for the demangled symbol.protected boolean
isAlreadyDemangled
(Program program, Address address) Determine if the symbol at address has already been demangled.protected boolean
check if the return/param data types were defined by better than analysis (user, import)boolean
boolean
boolean
boolean
boolean
boolean
protected Structure
maybeCreateClassStructure
(Program program, Function function, String convention) void
setCallingConvention
(String callingConvention) Sets the function calling convention.void
setOverloadedOperator
(boolean isOverloadedOperator) Sets whether this demangled function represents an overloaded operator.void
setReturnType
(DemangledDataType returnType) Sets the function return type.void
setTemplate
(DemangledTemplate template) void
Special constructor where it has a templated type before the parameter listvoid
setThrowAttribute
(String throwAttribute) void
void
void
void
void
void
Methods inherited from class ghidra.app.util.demangler.DemangledObject
applyDemangledName, applyDemangledName, applyPlateCommentOnly, createNamespace, demangledNameSuccessfully, ensureNameLength, generatePlateComment, getBasedName, getDemangledName, getErrorMessage, getMangledString, getMemberScope, getName, getNamespace, getNamespaceString, getOriginalDemangled, getSignature, getSpecialPrefix, getStorageClass, getVisibility, isConst, isPointer64, isRestrict, isStatic, isThunk, isUnaligned, isVirtual, isVolatile, setBackupPlateComment, setBasedName, setConst, setErrorMessage, setMemberScope, setName, setNamespace, setPointer64, setRestrict, setSpecialPrefix, setStatic, setStorageClass, setThunk, setUnaligned, setVirtual, setVisibilty, setVolatile, toString
-
Field Details
-
VOLATILE
- See Also:
-
CONST
- See Also:
-
PTR64
- See Also:
-
UNALIGNED
- See Also:
-
RESTRICT
- See Also:
-
returnType
-
callingConvention
-
thisPassedOnStack
protected boolean thisPassedOnStack -
parameters
-
template
-
isOverloadedOperator
protected boolean isOverloadedOperator
-
-
Constructor Details
-
DemangledFunction
-
-
Method Details
-
setReturnType
Sets the function return type.- Parameters:
returnType
- the function return type
-
setCallingConvention
Sets the function calling convention. For example, "__cdecl".- Parameters:
callingConvention
- the function calling convention
-
setTemplate
-
getTemplate
-
setOverloadedOperator
public void setOverloadedOperator(boolean isOverloadedOperator) Sets whether this demangled function represents an overloaded operator. For example, "operator+()".- Parameters:
isOverloadedOperator
- true if overloaded operator
-
addParameter
-
getParameters
-
getReturnType
Returns the return type or null, if unspecified.- Returns:
- the return type or null, if unspecified
-
getCallingConvention
Returns the calling convention or null, if unspecified.- Returns:
- the calling convention or null, if unspecified
-
setTemplatedConstructorType
Special constructor where it has a templated type before the parameter list- Parameters:
type
- the type
-
isTrailingConst
public boolean isTrailingConst() -
setTrailingConst
public void setTrailingConst() -
isTrailingVolatile
public boolean isTrailingVolatile() -
setTrailingVolatile
public void setTrailingVolatile() -
isTrailingPointer64
public boolean isTrailingPointer64() -
setTrailingPointer64
public void setTrailingPointer64() -
isTrailingUnaligned
public boolean isTrailingUnaligned() -
setTrailingUnaligned
public void setTrailingUnaligned() -
isTrailingRestrict
public boolean isTrailingRestrict() -
setTrailingRestrict
public void setTrailingRestrict() -
isTypeCast
public boolean isTypeCast() -
setTypeCast
public void setTypeCast() -
setThrowAttribute
-
getSignature
Description copied from class:DemangledObject
Returns a complete signature for the demangled symbol.
For example: "unsigned long foo" "unsigned char * ClassA::getFoo(float, short *)" "void * getBar(int **, MyStruct &)"
Note: based on the underlying mangling scheme, the return type may or may not be specified in the signature.- Specified by:
getSignature
in classDemangledObject
- Parameters:
format
- true if signature should be pretty printed- Returns:
- a complete signature for the demangled symbol
-
addParameters
-
getNamespaceName
Description copied from interface:Demangled
Returns this object's namespace name without the fully-qualified parent path. The value returned here may have had some special characters replaced, such as ' ' replaced with '_' and '::' replaced with '--'.- Specified by:
getNamespaceName
in interfaceDemangled
- Overrides:
getNamespaceName
in classDemangledObject
- Returns:
- the name
-
getParameterString
-
isAlreadyDemangled
Description copied from class:DemangledObject
Determine if the symbol at address has already been demangled. While memory symbols check for presence of demangledName, external symbols simply check if demangled/alternate name has already been assigned.- Overrides:
isAlreadyDemangled
in classDemangledObject
- Parameters:
program
- the program being modifiedaddress
- address of demangled symbol- Returns:
- true if symbol at address has already been demangled
-
applyTo
public boolean applyTo(Program program, Address address, DemanglerOptions options, TaskMonitor monitor) throws Exception - Overrides:
applyTo
in classDemangledObject
- Throws:
Exception
-
isDefinedFunctionDataTypes
check if the return/param data types were defined by better than analysis (user, import)- Parameters:
func
- the function to check- Returns:
- true if the parameters are not undefined, or are of a higher source type.
-
maybeCreateClassStructure
-
createFunction
protected Function createFunction(Program prog, Address addr, boolean doDisassembly, TaskMonitor monitor) throws DemangledException - Throws:
DemangledException
-