Package ghidra.app.util.demangler

Class DemangledObject

java.lang.Object

ghidra.app.util.demangler.DemangledObject

Direct Known Subclasses:

DemangledAddressTable, DemangledFunction, DemangledString, DemangledThunk, DemangledUnknown, DemangledVariable

public abstract class DemangledObject
extends java.lang.Object

A class to represent a demangled object.

Field Summary

Fields

Change	Modifier and Type	Field	Description
NEW	protected java.lang.String	basedName
NEW	protected static java.lang.String	EMPTY_STRING
NEW	protected boolean	isRestrict
NEW	protected boolean	isStatic
NEW	protected boolean	isThunk
NEW	protected boolean	isUnaligned
NEW	protected boolean	isVirtual
NEW	protected java.lang.String	memberScope
NEW	protected DemangledType	namespace
NEW	protected static java.lang.String	NAMESPACE_SEPARATOR
NEW	protected java.lang.String	originalMangled
NEW	protected static java.lang.String	SPACE
NEW	protected static java.util.regex.Pattern	SPACE_PATTERN
NEW	protected java.lang.String	specialMidfix
NEW	protected java.lang.String	specialPrefix
NEW	protected java.lang.String	specialSuffix
NEW	protected java.lang.String	storageClass
NEW	protected java.lang.String	utilDemangled
NEW	protected java.lang.String	visibility

Method Summary

Change	Modifier and Type	Method	Description
NEW	protected Symbol	applyDemangledName(Address addr, boolean setPrimary, boolean functionNamespacePermitted, Program prog)
NEW	protected Symbol	applyDemangledName(java.lang.String symbolName, Address addr, boolean setPrimary, boolean functionNamespacePermitted, Program prog)
	boolean	applyTo(Program program, Address address, DemanglerOptions options, TaskMonitor monitor)
NEW	protected Structure	createClassStructure(Program prog, Function func)
	static Namespace	createNamespace(Program program, DemangledType typeNamespace, Namespace parentNamespace, boolean functionPermitted)	Get or create the specified typeNamespace.
NEW	protected static java.lang.String	ensureNameLength(java.lang.String name)	Ensure name does not pass the limit defined by Ghidra
NEW	protected java.lang.String	generatePlateComment()
	java.lang.String	getBasedName()
	java.lang.String	getDemangledName()	Returns the unmodified demangled name of this object.
	java.lang.String	getMemberScope()
	java.lang.String	getName()	Returns the demangled name of this object.
	DemangledType	getNamespace()	Returns the namespace containing this demangled object.
	abstract java.lang.String	getSignature(boolean format)	Returns a complete signature for the demangled symbol.
	java.lang.String	getSpecialMidfix()
	java.lang.String	getSpecialPrefix()
	java.lang.String	getSpecialSuffix()
	java.lang.String	getStorageClass()
	java.lang.String	getUtilDemangled()	Gets the demangled output from a supplemental utility.
	java.lang.String	getVisibility()
NEW	protected boolean	isAlreadyDemangled(Program program, Address address)	Determine if the symbol at address has already been demangled.
	boolean	isConst()
	boolean	isPointer64()
	boolean	isRestrict()
	boolean	isStatic()
	boolean	isThunk()
	boolean	isUnaligned()
	boolean	isVirtual()
	boolean	isVolatile()
NEW	protected java.lang.String	pad(int len)
	void	setBasedName(java.lang.String basedName)
	void	setConst(boolean isConst)
	void	setMemberScope(java.lang.String memberScope)
	void	setName(java.lang.String name)	Sets the name of the demangled object
	void	setNamespace(DemangledType namespace)
	void	setOriginalMangled(java.lang.String mangled)	Sets the original mangled name
	void	setPointer64(boolean isPointer64)
	void	setRestrict()
	void	setSignature(java.lang.String signature)	Sets the signature.
	void	setSpecialMidfix(java.lang.String chargeType)
	void	setSpecialPrefix(java.lang.String special)
	void	setSpecialSuffix(java.lang.String specialSuffix)
	void	setStatic(boolean isStatic)
	void	setStorageClass(java.lang.String storageClass)
	void	setThunk(boolean isThunk)
	void	setUnaligned()
	void	setUtilDemangled(java.lang.String utilDemangled)	Sets the demangled output from a supplemental utility.
	void	setVirtual(boolean isVirtual)
	void	setVisibilty(java.lang.String visibility)
	void	setVolatile(boolean isVolatile)
	java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SPACE NEW

protected static final java.lang.String SPACE

See Also:

Constant Field Values

SPACE_PATTERN NEW

protected static final java.util.regex.Pattern SPACE_PATTERN

NAMESPACE_SEPARATOR NEW

protected static final java.lang.String NAMESPACE_SEPARATOR

See Also:

Constant Field Values

EMPTY_STRING NEW

protected static final java.lang.String EMPTY_STRING

See Also:

Constant Field Values

originalMangled NEW

protected java.lang.String originalMangled

utilDemangled NEW

protected java.lang.String utilDemangled

specialPrefix NEW

protected java.lang.String specialPrefix

specialMidfix NEW

protected java.lang.String specialMidfix

specialSuffix NEW

protected java.lang.String specialSuffix

namespace NEW

protected DemangledType namespace

visibility NEW

protected java.lang.String visibility

storageClass NEW

protected java.lang.String storageClass

isStatic NEW

protected boolean isStatic

isVirtual NEW

protected boolean isVirtual

isThunk NEW

protected boolean isThunk

isUnaligned NEW

protected boolean isUnaligned

isRestrict NEW

protected boolean isRestrict

basedName NEW

protected java.lang.String basedName

memberScope NEW

protected java.lang.String memberScope

Method Detail

getDemangledName

public java.lang.String getDemangledName()

Returns the unmodified demangled name of this object. This name may contain whitespace and other characters not supported for symbol or data type creation. See getName() for the same name modified for use within Ghidra.

Returns:

name of this DemangledObject

getName

public java.lang.String getName()

Returns the demangled name of this object. NOTE: unsupported symbol characters, like whitespace, will be converted to an underscore.

Returns:

name of this DemangledObject with unsupported characters converted to underscore

isConst

public boolean isConst()

setConst

public void setConst(boolean isConst)

isVolatile

public boolean isVolatile()

setVolatile

public void setVolatile(boolean isVolatile)

isPointer64

public boolean isPointer64()

setPointer64

public void setPointer64(boolean isPointer64)

isStatic

public boolean isStatic()

setStatic

public void setStatic(boolean isStatic)

isVirtual

public boolean isVirtual()

setVirtual

public void setVirtual(boolean isVirtual)

isThunk

public boolean isThunk()

setThunk

public void setThunk(boolean isThunk)

setUnaligned

public void setUnaligned()

isUnaligned

public boolean isUnaligned()

setRestrict

public void setRestrict()

isRestrict

public boolean isRestrict()

getBasedName

public java.lang.String getBasedName()

setBasedName

public void setBasedName(java.lang.String basedName)

getMemberScope

public java.lang.String getMemberScope()

setMemberScope

public void setMemberScope(java.lang.String memberScope)

setName

public void setName(java.lang.String name)

Sets the name of the demangled object

Parameters:

name - the new name

setOriginalMangled

public void setOriginalMangled(java.lang.String mangled)

Sets the original mangled name

Parameters:

mangled - the original mangled name

setUtilDemangled

public void setUtilDemangled(java.lang.String utilDemangled)

Sets the demangled output from a supplemental utility.

Parameters:

utilDemangled - the demangled string

getUtilDemangled

public java.lang.String getUtilDemangled()

Gets the demangled output from a supplemental utility.

Returns:

the demangled String created for this object.

getNamespace

public DemangledType getNamespace()

Returns the namespace containing this demangled object.

Returns:

the namespace containing this demangled object

setNamespace

public void setNamespace(DemangledType namespace)

getVisibility

public java.lang.String getVisibility()

setVisibilty

public void setVisibilty(java.lang.String visibility)

getStorageClass

public java.lang.String getStorageClass()

setStorageClass

public void setStorageClass(java.lang.String storageClass)

getSpecialPrefix

public java.lang.String getSpecialPrefix()

setSpecialPrefix

public void setSpecialPrefix(java.lang.String special)

getSpecialMidfix

public java.lang.String getSpecialMidfix()

setSpecialMidfix

public void setSpecialMidfix(java.lang.String chargeType)

getSpecialSuffix

public java.lang.String getSpecialSuffix()

setSpecialSuffix

public void setSpecialSuffix(java.lang.String specialSuffix)

getSignature

public abstract java.lang.String getSignature(boolean format)

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.

Parameters:

format - true if signature should be pretty printed

Returns:

a complete signature for the demangled symbol

setSignature

public void setSignature(java.lang.String signature)

Sets the signature. Calling this method will override the auto-generated signature.

Parameters:

signature - the signature

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isAlreadyDemangled NEW

protected boolean isAlreadyDemangled(Program program,
                                     Address address)

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.

Parameters:

program - the program being modified

address - 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

Throws:

java.lang.Exception

generatePlateComment NEW

protected java.lang.String generatePlateComment()

pad NEW

protected java.lang.String pad(int len)

applyDemangledName NEW

protected Symbol applyDemangledName(Address addr,
                                    boolean setPrimary,
                                    boolean functionNamespacePermitted,
                                    Program prog)
                             throws InvalidInputException

Throws:

InvalidInputException

applyDemangledName NEW

protected Symbol applyDemangledName(java.lang.String symbolName,
                                    Address addr,
                                    boolean setPrimary,
                                    boolean functionNamespacePermitted,
                                    Program prog)
                             throws InvalidInputException

Throws:

InvalidInputException

createNamespace

public static Namespace createNamespace(Program program,
                                        DemangledType typeNamespace,
                                        Namespace parentNamespace,
                                        boolean functionPermitted)

Get or create the specified typeNamespace. The returned namespace may only be a partial namespace if errors occurred. The caller should check the returned namespace and adjust any symbol creation accordingly. Caller should use #getResidualNamespacePath(DemangledType, Namespace) to handle the case where only a partial namespace has been returned.

Parameters:

program -

typeNamespace - demangled namespace

parentNamespace - root namespace to be used (e.g., library, global, etc.)

functionPermitted - if true an existing function may be used as a namespace

Returns:

namespace or partial namespace if error occurs

ensureNameLength NEW

protected static java.lang.String ensureNameLength(java.lang.String name)

Ensure name does not pass the limit defined by Ghidra

createClassStructure NEW

protected Structure createClassStructure(Program prog,
                                         Function func)