Class PartialUnion
- All Implemented Interfaces:
DataType
-
Field Summary
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
-
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.int
Gets the alignment to be used when aligning this datatype within another datatype.Gets the settings for this data type.Get a String briefly describing this DataType.int
Get the length (number of 8-bit bytes) of this DataType.int
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 interpretted data value in the form of the appropriate Object for this DataType.Class<?>
getValueClass
(Settings settings) Get the Class of the value Object to be returned by this datatype (seeDataType.getValue(MemBuffer, Settings, int)
).boolean
isEquivalent
(DataType dt) Check if the given datatype is equivalent to this datatype.Methods inherited from class ghidra.program.model.data.AbstractDataType
addParent, dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getMnemonic, getName, getParents, getPathName, getSourceArchive, getTypeDefSettingsDefinitions, getUniversalID, hasLanguageDependantLength, isDeleted, isEncodable, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive, toString
-
Method Details
-
getParent
- Returns:
- the Union data-type of which this is a part
-
getOffset
public int getOffset()- Returns:
- the offset, in bytes, of this part within its parent Union
-
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 shuold be made directly to this instance if supported or to a
DataType.copy(DataTypeManager)
.- Parameters:
dtm
- the data-type manager instance whose data-organization should apply.- Returns:
- cloned instance which may be the same as this instance
-
getLength
public int getLength()Description copied from interface:DataType
Get the length (number of 8-bit bytes) of this DataType.NOTE: No datatype should ever return 0, even if
DataType.isZeroLength()
, and onlyDynamic
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.- Returns:
- the length of this DataType
-
getDescription
Description copied from interface:DataType
Get a String briefly describing this DataType.- Returns:
- a one-liner describing this DataType.
-
getValue
Description copied from interface:DataType
Get the interpretted data value in the form of the appropriate Object for this DataType. This method must return a value consistent withDataType.getValueClass(Settings)
.For instance, if this datatype is a
Pointer
an Address object or null should be returned. A Byte, returns aScalar
object.- Parameters:
buf
- the data buffer.settings
- the settings to use.length
- the number of bytes to get the value from.- Returns:
- the data Object.
-
getRepresentation
Description copied from interface:DataType
Get bytes from memory in a printable format for this type.- 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.
-
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.- Returns:
- list of the settings definitions for 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.- Returns:
- the settings for this dataType.
-
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)
.- Parameters:
dtm
- the data-type manager instance whose data-organization should apply.- Returns:
- new instanceof of this datatype
-
getValueClass
Description copied from interface:DataType
Get the Class of the value Object to be returned by this datatype (seeDataType.getValue(MemBuffer, Settings, int)
).- 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.
-
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.- Parameters:
dt
- the datatype being tested for equivalence.- Returns:
- true if the if the given datatype is equivalent to this datatype.
-
getAlignment
public int getAlignment()Description copied from interface:DataType
Gets the alignment to be used when aligning this datatype within another datatype.- Returns:
- this datatype's alignment.
-