Package ghidra.app.util.demangler
Class DemangledFunction
- java.lang.Object
-
- ghidra.app.util.demangler.DemangledObject
-
- ghidra.app.util.demangler.DemangledFunction
-
- All Implemented Interfaces:
ParameterReceiver
- Direct Known Subclasses:
DemangledMethod
public class DemangledFunction extends DemangledObject implements ParameterReceiver
A class to represent a demangled function.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.StringcallingConventionstatic java.lang.StringCONSTprotected booleanisOverloadedOperatorprotected java.util.List<DemangledDataType>parametersstatic java.lang.StringPTR64static java.lang.StringRESTRICTprotected DemangledDataTypereturnTypeprotected DemangledTemplatetemplateprotected booleanthisPassedOnStackstatic java.lang.StringUNALIGNEDstatic java.lang.StringVOLATILE-
Fields inherited from class ghidra.app.util.demangler.DemangledObject
basedName, EMPTY_STRING, isRestrict, isStatic, isThunk, isUnaligned, isVirtual, memberScope, namespace, NAMESPACE_SEPARATOR, originalMangled, SPACE, SPACE_PATTERN, specialMidfix, specialPrefix, specialSuffix, storageClass, utilDemangled, visibility
-
-
Constructor Summary
Constructors Constructor Description DemangledFunction(java.lang.String name)Constructs a new demangled function.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddParameter(DemangledDataType parameter)Adds the specified parameter to this object.booleanapplyTo(Program program, Address address, DemanglerOptions options, TaskMonitor monitor)java.lang.StringgetCallingConvention()Returns the calling convention or null, if unspecified.java.util.List<DemangledDataType>getParameters()Returns the parameters added to this object.java.lang.StringgetParameterString()DemangledDataTypegetReturnType()Returns the return type or null, if unspecified.java.lang.StringgetSignature(boolean format)Returns a complete signature for the demangled symbol.DemangledTemplategetTemplate()protected booleanisAlreadyDemangled(Program program, Address address)Determine if the symbol at address has already been demangled.booleanisTrailingConst()booleanisTrailingPointer64()booleanisTrailingRestrict()booleanisTrailingUnaligned()booleanisTrailingVolatile()booleanisTypeCast()voidsetCallingConvention(java.lang.String callingConvention)Sets the function calling convention.voidsetOverloadedOperator(boolean isOverloadedOperator)Sets whether this demangled function represents an overloaded operator.voidsetReturnType(DemangledDataType returnType)Sets the function return type.voidsetTemplate(DemangledTemplate template)voidsetTemplatedConstructorType(java.lang.String type)Special constructor where it has a templated type before the parameter listvoidsetThrowAttribute(java.lang.String throwAttribute)voidsetTrailingConst()voidsetTrailingPointer64()voidsetTrailingRestrict()voidsetTrailingUnaligned()voidsetTrailingVolatile()voidsetTypeCast()-
Methods inherited from class ghidra.app.util.demangler.DemangledObject
applyDemangledName, applyDemangledName, createClassStructure, createNamespace, ensureNameLength, generatePlateComment, getBasedName, getDemangledName, getMemberScope, getName, getNamespace, getSpecialMidfix, getSpecialPrefix, getSpecialSuffix, getStorageClass, getUtilDemangled, getVisibility, isConst, isPointer64, isRestrict, isStatic, isThunk, isUnaligned, isVirtual, isVolatile, pad, setBasedName, setConst, setMemberScope, setName, setNamespace, setOriginalMangled, setPointer64, setRestrict, setSignature, setSpecialMidfix, setSpecialPrefix, setSpecialSuffix, setStatic, setStorageClass, setThunk, setUnaligned, setUtilDemangled, 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)
Description copied from interface:ParameterReceiverAdds the specified parameter to this object.- Specified by:
addParameterin interfaceParameterReceiver- Parameters:
parameter- the parameter to add- See Also:
ParameterReceiver
-
getParameters
public java.util.List<DemangledDataType> getParameters()
Description copied from interface:ParameterReceiverReturns the parameters added to this object.- Specified by:
getParametersin interfaceParameterReceiver- Returns:
- the parameters added to this object
- See Also:
ParameterReceiver
-
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
-
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:DemangledObjectReturns 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:
getSignaturein classDemangledObject- Parameters:
format- true if signature should be pretty printed- Returns:
- a complete signature for the demangled symbol
-
getParameterString
public java.lang.String getParameterString()
-
isAlreadyDemangled
protected boolean isAlreadyDemangled(Program program, Address address)
Description copied from class:DemangledObjectDetermine 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:
isAlreadyDemangledin 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:
applyToin classDemangledObject- Throws:
java.lang.Exception
-
-