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
public class DemangledFunction extends DemangledObject
A class to represent a demangled function.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
callingConvention
static java.lang.String
CONST
protected boolean
isOverloadedOperator
protected java.util.List<DemangledDataType>
parameters
static java.lang.String
PTR64
static java.lang.String
RESTRICT
protected DemangledDataType
returnType
protected DemangledTemplate
template
protected boolean
thisPassedOnStack
static java.lang.String
UNALIGNED
static java.lang.String
VOLATILE
-
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 Constructor Description DemangledFunction(java.lang.String mangled, java.lang.String originalDemangled, java.lang.String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addParameter(DemangledDataType parameter)
protected void
addParameters(java.lang.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)
java.lang.String
getCallingConvention()
Returns the calling convention or null, if unspecified.java.lang.String
getNamespaceName()
Returns this object's namespace name without the fully-qualified parent path.java.util.List<DemangledDataType>
getParameters()
java.lang.String
getParameterString()
DemangledDataType
getReturnType()
Returns the return type or null, if unspecified.java.lang.String
getSignature(boolean format)
Returns a complete signature for the demangled symbol.DemangledTemplate
getTemplate()
protected boolean
isAlreadyDemangled(Program program, Address address)
Determine if the symbol at address has already been demangled.protected boolean
isDefinedFunctionDataTypes(Function func)
check if the return/param data types were defined by better than analysis (user, import)boolean
isTrailingConst()
boolean
isTrailingPointer64()
boolean
isTrailingRestrict()
boolean
isTrailingUnaligned()
boolean
isTrailingVolatile()
boolean
isTypeCast()
protected Structure
maybeCreateClassStructure(Program program, Function function, java.lang.String convention)
void
setCallingConvention(java.lang.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
setTemplatedConstructorType(java.lang.String type)
Special constructor where it has a templated type before the parameter listvoid
setThrowAttribute(java.lang.String throwAttribute)
void
setTrailingConst()
void
setTrailingPointer64()
void
setTrailingRestrict()
void
setTrailingUnaligned()
void
setTrailingVolatile()
void
setTypeCast()
-
Methods inherited from class ghidra.app.util.demangler.DemangledObject
applyDemangledName, applyDemangledName, applyPlateCommentOnly, createNamespace, demangledNameSuccessfully, ensureNameLength, generatePlateComment, getBasedName, getDemangledName, getMangledString, getMemberScope, getName, getNamespace, getNamespaceString, getOriginalDemangled, getSignature, getSpecialPrefix, getStorageClass, getVisibility, isConst, isPointer64, isRestrict, isStatic, isThunk, isUnaligned, isVirtual, isVolatile, setBackupPlateComment, setBasedName, setConst, setMemberScope, setName, setNamespace, setPointer64, setRestrict, setSpecialPrefix, setStatic, setStorageClass, setThunk, setUnaligned, setVirtual, setVisibilty, setVolatile, toString
-
-
-
-
Field Detail
-
VOLATILE
public static final java.lang.String VOLATILE
- See Also:
- Constant Field Values
-
CONST
public static final java.lang.String CONST
- See Also:
- Constant Field Values
-
PTR64
public static final java.lang.String PTR64
- See Also:
- Constant Field Values
-
UNALIGNED
public static final java.lang.String UNALIGNED
- See Also:
- Constant Field Values
-
RESTRICT
public static final java.lang.String RESTRICT
- See Also:
- Constant Field Values
-
returnType
protected DemangledDataType returnType
-
callingConvention
protected java.lang.String callingConvention
-
thisPassedOnStack
protected boolean thisPassedOnStack
-
parameters
protected java.util.List<DemangledDataType> parameters
-
template
protected DemangledTemplate template
-
isOverloadedOperator
protected boolean isOverloadedOperator
-
-
Method Detail
-
setReturnType
public void setReturnType(DemangledDataType returnType)
Sets the function return type.- Parameters:
returnType
- the function return type
-
setCallingConvention
public void setCallingConvention(java.lang.String callingConvention)
Sets the function calling convention. For example, "__cdecl".- Parameters:
callingConvention
- the function calling convention
-
setTemplate
public void setTemplate(DemangledTemplate template)
-
getTemplate
public DemangledTemplate 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
public void addParameter(DemangledDataType parameter)
-
getParameters
public java.util.List<DemangledDataType> getParameters()
-
getReturnType
public DemangledDataType getReturnType()
Returns the return type or null, if unspecified.- Returns:
- the return type or null, if unspecified
-
getCallingConvention
public java.lang.String getCallingConvention()
Returns the calling convention or null, if unspecified.- Returns:
- the calling convention or null, if unspecified
-
setTemplatedConstructorType
public void setTemplatedConstructorType(java.lang.String type)
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
public void setThrowAttribute(java.lang.String throwAttribute)
-
getSignature
public java.lang.String getSignature(boolean format)
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
protected void addParameters(java.lang.StringBuilder buffer, boolean format)
-
getNamespaceName
public java.lang.String 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
public java.lang.String getParameterString()
-
isAlreadyDemangled
protected boolean isAlreadyDemangled(Program program, Address address)
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 java.lang.Exception
- Overrides:
applyTo
in classDemangledObject
- Throws:
java.lang.Exception
-
isDefinedFunctionDataTypes
protected boolean isDefinedFunctionDataTypes(Function func)
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
protected Structure maybeCreateClassStructure(Program program, Function function, java.lang.String convention)
-
createFunction
protected Function createFunction(Program prog, Address addr, boolean doDisassembly, TaskMonitor monitor) throws DemangledException
- Throws:
DemangledException
-
-