Class PointerTypedef
PointerTypedef
provides a Pointer-Typedef template datatype
which may be used as an alternative to PointerTypedefBuilder
for
select use cases. Once resolved this datatype is transformed into a
standard TypeDef
with appropropriate settings (see
TypeDefSettingsDefinition
).
NOTE: The name of this class intentionally does not end with
DataType
since it does not implement a default constructor so it may not be treated
like other BuiltIn
datatypes which are managed by the
BuiltInDataTypeManager
.
NOTE: As a
BuiltIn
datatype the use of GenericDataType.setName(String)
and
GenericDataType.setNameAndCategory(CategoryPath, String)
is disabled. The datatype
instance must be instantiated with the correct typedef name.-
Field Summary
Fields inherited from class ghidra.program.model.data.DataTypeImpl
defaultSettings
Fields inherited from class ghidra.program.model.data.AbstractDataType
categoryPath, dataMgr, name
Fields inherited from interface ghidra.program.model.data.DataType
CONFLICT_SUFFIX, DEFAULT, NO_LAST_CHANGE_TIME, NO_SOURCE_SYNC_TIME, TYPEDEF_ATTRIBUTE_PREFIX, TYPEDEF_ATTRIBUTE_SUFFIX, VOID
-
Constructor Summary
ConstructorDescriptionPointerTypedef
(String typeDefName, DataType referencedDataType, int pointerSize, DataTypeManager dtm) Constructs a pointer-typedef without any settingsPointerTypedef
(String typeDefName, DataType referencedDataType, int pointerSize, DataTypeManager dtm, long componentOffset) Constructs a offset-pointer-typedefPointerTypedef
(String typeDefName, DataType referencedDataType, int pointerSize, DataTypeManager dtm, AddressSpace space) Constructs a pointer-typedef which dereferences into a specific address space.PointerTypedef
(String typeDefName, DataType referencedDataType, int pointerSize, DataTypeManager dtm, PointerType type) Constructs a pointer-typedef of a specific typePointerTypedef
(String typeDefName, Pointer pointerDataType, DataTypeManager dtm) Constructs a pointer-typedef without any settings -
Method Summary
Modifier and TypeMethodDescriptionclone
(DataTypeManager dtm) Returns an instance of this DataType using the specifiedDataTypeManager
to allow its use of the correspondingDataOrganization
while retaining its unique identity (seeDataType.getUniversalID()
and archive association (seeDataType.getSourceArchive()
) if applicable.copy
(DataTypeManager dtm) Returns a new instance (shallow copy) of this DataType with a new identity and no source archive association.boolean
Check if this datatype depends on the existence of the given datatype.void
Enable auto-naming for this typedef.int
Get the aligned-length of this datatype as a number of 8-bit bytes.Returns the non-typedef dataType that this typedef is based on, following chains of typedefs as necessary.Returns the dataType that this typedef is based on.Gets the settings for this data type.Get a String briefly describing this DataType.int
Get the length of this DataType as a number of 8-bit bytes.getName()
Get the name of this datatype.protected DataType
Get the referenced datatype used to construct this datatype (datatype which pointer references).getRepresentation
(MemBuffer buf, Settings settings, int length) Get bytes from memory in a printable format for this type.Get the list of settings definitions available for use with this datatype.Get the list of all settings definitions for this datatype that may be used for an associatedTypeDef
.Get the universal ID for this datatype.Returns the interpreted data value as an instance of theadvertised value class
.Class
<?> getValueClass
(Settings settings) Get the Class of the value Object to be returned by this datatype (seeDataType.getValue(MemBuffer, Settings, int)
).boolean
Indicates if the length of this data-type is determined based upon theDataOrganization
obtained from the associatedDataTypeManager
.boolean
Determine if this datatype use auto-naming (e.g., seePointerTypedef
).boolean
isEquivalent
(DataType obj) Check if the given datatype is equivalent to this datatype.toString()
Methods inherited from class ghidra.program.model.data.GenericDataType
setCategoryPath, setName, setNameAndCategory
Methods inherited from class ghidra.program.model.data.DataTypeImpl
addParent, equals, getAlignment, getLastChangeTime, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, removeParent, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive
Methods inherited from class ghidra.program.model.data.AbstractDataType
dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getMnemonic, isDeleted, isEncodable, isNotYetDefined, isZeroLength
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface ghidra.program.model.data.DataType
addParent, dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, encodeRepresentation, encodeValue, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getMnemonic, getParents, getPathName, getSourceArchive, isDeleted, isEncodable, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
Methods inherited from interface ghidra.program.model.data.TypeDef
hasSameTypeDefSettings, isPointer
-
Constructor Details
-
PointerTypedef
public PointerTypedef(String typeDefName, DataType referencedDataType, int pointerSize, DataTypeManager dtm, AddressSpace space) Constructs a pointer-typedef which dereferences into a specific address space.- Parameters:
typeDefName
- name of this pointer-typedef or null to use auto-named typedef.referencedDataType
- data type this pointer-typedef points to or nullpointerSize
- pointer size in bytes or -1 for default pointer size based upon specified address space and datatype managerdtm
- data-type manager whose data organization should be used (highly recommended, may be null)space
- address space to be used when dereferencing pointer offset
-
PointerTypedef
public PointerTypedef(String typeDefName, DataType referencedDataType, int pointerSize, DataTypeManager dtm, PointerType type) Constructs a pointer-typedef of a specific type- Parameters:
typeDefName
- name of this pointer-typedef or null to use auto-named typedef.referencedDataType
- data type this pointer-typedef points to or nullpointerSize
- pointer size in bytes or -1 for default pointer size based upon datatype managerdtm
- data-type manager whose data organization should be used (highly recommended, may be null)type
- pointer type (IBO, RELATIVE, FILE_OFFSET)
-
PointerTypedef
public PointerTypedef(String typeDefName, DataType referencedDataType, int pointerSize, DataTypeManager dtm, long componentOffset) Constructs a offset-pointer-typedef- Parameters:
typeDefName
- name of this pointer-typedef or null to use auto-named typedef.referencedDataType
- data type this pointer-typedef points to or nullpointerSize
- pointer size in bytes or -1 for default pointer size based upon datatype managerdtm
- data-type manager whose data organization should be used (highly recommended, may be null)componentOffset
- signed component offset setting value (seeComponentOffsetSettingsDefinition
-
PointerTypedef
public PointerTypedef(String typeDefName, DataType referencedDataType, int pointerSize, DataTypeManager dtm) Constructs a pointer-typedef without any settings- Parameters:
typeDefName
- name of this pointer-typedef or null to use auto-named typedef.referencedDataType
- data type this pointer-typedef points to or nullpointerSize
- pointer size in bytes or -1 for default pointer size based upon datatype managerdtm
- data-type manager whose data organization should be used (highly recommended, may be null)
-
PointerTypedef
Constructs a pointer-typedef without any settings- Parameters:
typeDefName
- name of this pointer-typedef or null to use auto-named typedef.pointerDataType
- associated pointer datatypedtm
- data-type manager whose data organization should be used (highly recommended, may be null)
-
-
Method Details
-
enableAutoNaming
public void enableAutoNaming()Description copied from interface:TypeDef
Enable auto-naming for this typedef. This will force naming to reflect the name of associated datatype plus an attribute list which corresponds to anyTypeDefSettingsDefinition
settings which may be set.- Specified by:
enableAutoNaming
in interfaceTypeDef
-
isAutoNamed
public boolean isAutoNamed()Description copied from interface:TypeDef
Determine if this datatype use auto-naming (e.g., seePointerTypedef
). If true, any change to associatedTypeDefSettingsDefinition
settings or naming of the pointer-referenced datatype will cause a automatic renaming of this datatype.- Specified by:
isAutoNamed
in interfaceTypeDef
- Returns:
- true if auto-named, else false.
-
getReferencedDataType
Get the referenced datatype used to construct this datatype (datatype which pointer references).- Returns:
- referenced datatype
-
getUniversalID
Description copied from interface:DataType
Get the universal ID for this datatype.This value is intended to be a unique identifier across all programs and archives. The same ID indicates that two datatypes were originally the same one. Keep in mind names, categories, and component makeup may differ and have changed since there origin.
- Specified by:
getUniversalID
in interfaceDataType
- Overrides:
getUniversalID
in classDataTypeImpl
- Returns:
- datatype UniversalID
-
isEquivalent
Description copied from interface:DataType
Check if the given datatype is equivalent to this datatype.The precise meaning of "equivalent" is datatype dependent.
NOTE: if invoked by a DB object or manager it should be invoked on the DataTypeDB object passing the other datatype as the argument.- Specified by:
isEquivalent
in interfaceDataType
- Parameters:
obj
- the datatype being tested for equivalence.- Returns:
- true if the if the given datatype is equivalent to this datatype.
-
getDescription
Description copied from interface:DataType
Get a String briefly describing this DataType.- Specified by:
getDescription
in interfaceDataType
- Returns:
- a one-liner describing this DataType.
-
getName
Description copied from interface:DataType
Get the name of this datatype.- Specified by:
getName
in interfaceDataType
- Overrides:
getName
in classAbstractDataType
- Returns:
- the name
-
hasLanguageDependantLength
public boolean hasLanguageDependantLength()Description copied from interface:DataType
Indicates if the length of this data-type is determined based upon theDataOrganization
obtained from the associatedDataTypeManager
.- Specified by:
hasLanguageDependantLength
in interfaceDataType
- Overrides:
hasLanguageDependantLength
in classAbstractDataType
- Returns:
- true length is language/compiler-specification dependent, else false
-
getLength
public int getLength()Description copied from interface:DataType
Get the length of this DataType as a number of 8-bit bytes.For primitive datatypes this reflects the smallest varnode which can be used to contain its value (i.e., raw data length).
Example: For x86 32-bit gcc an 80-bit
long double
raw data length
of 10-bytes will fit within a floating point register while itsaligned-length
of 12-bytes is used by the gcc compiler for data/array/component allocations to maintain alignment (i.e.,sizeof(long double)
).NOTE: Other than the
VoidDataType
, no datatype should ever return 0, even ifDataType.isZeroLength()
, and onlyDynamic
/FactoryDataType
datatypes should return -1. IfDataType.isZeroLength()
is true a length of 1 should be returned. Where a zero-length datatype can be handled (e.g.,Composite
) theDataType.isZeroLength()
method should be used. -
getAlignedLength
public int getAlignedLength()Description copied from interface:DataType
Get the aligned-length of this datatype as a number of 8-bit bytes.For primitive datatypes this is equivalent to the C/C++ "sizeof" operation within source code and should be used when determining
Array
element length or component sizing for aComposite
. ForPointer
,Composite
andArray
types this will return the same value asDataType.getLength()
.Example: For x86 32-bit gcc an 80-bit
long double
raw data length
of 10-bytes will fit within a floating point register while itsaligned-length
of 12-bytes is used by the gcc compiler for data/array/component allocations to maintain alignment (i.e.,sizeof(long double)
).NOTE: Other than the
VoidDataType
, no datatype should ever return 0, even ifDataType.isZeroLength()
, and onlyDynamic
/FactoryDataType
/FunctionDefinition
datatypes should return -1. IfDataType.isZeroLength()
is true a length of 1 should be returned.- Specified by:
getAlignedLength
in interfaceDataType
- Overrides:
getAlignedLength
in classDataTypeImpl
- Returns:
- byte length of binary encoding.
-
getDataType
Description copied from interface:TypeDef
Returns the dataType that this typedef is based on. This could be another typedef- Specified by:
getDataType
in interfaceTypeDef
- Returns:
- the datatype which this typedef is based on (may be another
TypeDef
).
-
getBaseDataType
Description copied from interface:TypeDef
Returns the non-typedef dataType that this typedef is based on, following chains of typedefs as necessary.- Specified by:
getBaseDataType
in interfaceTypeDef
- Returns:
- the datatype which this typedef is based on (will not be another
TypeDef
).
-
getSettingsDefinitions
Description copied from interface:DataType
Get the list of settings definitions available for use with this datatype.In the case of a
TypeDef
, the return list will include theTypeDefSettingsDefinition
list from the associated base data type.Unlike
TypeDefSettingsDefinition
standard settings definitions generally support default, component-default and data-instance use. In addition, standard settings definitions are never considered duringDataType.isEquivalent(DataType)
checking or during the resolve process.- Specified by:
getSettingsDefinitions
in interfaceDataType
- Overrides:
getSettingsDefinitions
in classDataTypeImpl
- Returns:
- list of the settings definitions for this datatype.
-
getTypeDefSettingsDefinitions
Description copied from interface:DataType
Get the list of all settings definitions for this datatype that may be used for an associatedTypeDef
. When used for an associatedTypeDef
, these settings will be considered during aDataType.isEquivalent(DataType)
check and will be preserved during the resolve process.- Specified by:
getTypeDefSettingsDefinitions
in interfaceDataType
- Overrides:
getTypeDefSettingsDefinitions
in classAbstractDataType
- Returns:
- a list of the settings definitions for a
TypeDef
associated with this datatype.
-
getDefaultSettings
Description copied from interface:DataType
Gets the settings for this data type. The settings may have underlying default settings and may in turn become defaults for instance-specific settings (e.g., Data or DataTypeComponent). It is important to note that these settings are tied to a specific DataType instantiation so it is important to understand the scope of its use. Example: TheBuiltInDataTypeManager
has its own set of DataType instances which are separate from those which have been instantiated or resolved to a specific Program/ArchiveDataTypeManager
. Settings manipulation may be disabled by default in some instances.- Specified by:
getDefaultSettings
in interfaceDataType
- Overrides:
getDefaultSettings
in classDataTypeImpl
- Returns:
- the settings for this dataType.
-
dependsOn
Description copied from interface:DataType
Check if this datatype depends on the existence of the given datatype.For example byte[] depends on byte. If byte were deleted, then byte[] would also be deleted.
- Specified by:
dependsOn
in interfaceDataType
- Overrides:
dependsOn
in classAbstractDataType
- Parameters:
dt
- the datatype to test that this datatype depends on.- Returns:
- true if the existence of this datatype relies on the existence of the specified datatype dt.
-
toString
- Overrides:
toString
in classAbstractDataType
-
getValueClass
Description copied from interface:DataType
Get the Class of the value Object to be returned by this datatype (seeDataType.getValue(MemBuffer, Settings, int)
).- Specified by:
getValueClass
in interfaceDataType
- Overrides:
getValueClass
in classDataTypeImpl
- Parameters:
settings
- the relevant settings to use or null for default.- Returns:
- Class of the value to be returned by this datatype or null if it can vary or is unspecified. Types which correspond to a string or char array will return the String class.
-
getValue
Description copied from interface:DataType
Returns the interpreted data value as an instance of theadvertised value class
.For instance,
Pointer
data types should return an Address object (or null), or integer data types should return aScalar
object.- Specified by:
getValue
in interfaceDataType
- Parameters:
buf
- the data buffersettings
- the settings to use.length
- indicates the maximum number of bytes that may be consumed by aDynamic
datatype, otherwise this value is ignored. A value of -1 may be specified to allow a Dynamic datatype to determine the length based upon the actual data bytes- Returns:
- the data object, or null if data is invalid
-
getRepresentation
Description copied from interface:DataType
Get bytes from memory in a printable format for this type.- Specified by:
getRepresentation
in interfaceDataType
- Parameters:
buf
- the data.settings
- the settings to use for the representation.length
- the number of bytes to represent.- Returns:
- the representation of the data in this format, never null.
-
clone
Description copied from interface:DataType
Returns an instance of this DataType using the specifiedDataTypeManager
to allow its use of the correspondingDataOrganization
while retaining its unique identity (seeDataType.getUniversalID()
and archive association (seeDataType.getSourceArchive()
) if applicable.This instance will be returned if this datatype's DataTypeManager matches the specified dtm. The recursion depth of a clone will stop on any datatype whose
DataTypeManager
matches the specified dtm and simply use the existing datatype instance.NOTE: In general, this method should not be used to obtain an instance to be modified. In most cases changes may be made directly to this instance if supported or to a
DataType.copy(DataTypeManager)
of this type. -
copy
Description copied from interface:DataType
Returns a new instance (shallow copy) of this DataType with a new identity and no source archive association.Any reference to other datatypes will use
DataType.clone(DataTypeManager)
.
-