Package ghidra.program.model.data
Class PointerDataType
- java.lang.Object
-
- ghidra.program.model.data.DataTypeImpl
-
- ghidra.program.model.data.BuiltIn
-
- ghidra.program.model.data.PointerDataType
-
- All Implemented Interfaces:
BuiltInDataType,DataType,Pointer,ExtensionPoint,java.io.Serializable,java.util.EventListener,javax.swing.event.ChangeListener
- Direct Known Subclasses:
Pointer16DataType,Pointer24DataType,Pointer32DataType,Pointer40DataType,Pointer48DataType,Pointer56DataType,Pointer64DataType,Pointer8DataType
public class PointerDataType extends BuiltIn implements Pointer
Basic implementation for a pointer dataType- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface ghidra.util.classfinder.ExtensionPoint
ExtensionPoint.Exclude, ExtensionPoint.Util
-
-
Field Summary
Fields Modifier and Type Field Description static PointerDataTypedataTypeprotected intlengthstatic intMAX_POINTER_SIZE_BYTESstatic java.lang.StringPOINTER_LABEL_PREFIXstatic java.lang.StringPOINTER_LOOP_LABEL_PREFIXstatic java.lang.StringPOINTER_NAMEprotected DataTypereferencedDataType-
Fields inherited from class ghidra.program.model.data.DataTypeImpl
categoryPath, defaultSettings, name
-
Fields inherited from interface ghidra.program.model.data.DataType
CONFLICT_SUFFIX, DEFAULT, NO_LAST_CHANGE_TIME, NO_SOURCE_SYNC_TIME, VOID
-
-
Constructor Summary
Constructors Constructor Description PointerDataType()Creates a dynamically-sized default pointer data type.PointerDataType(DataType referencedDataType)Construct a dynamically-sized pointer to a referencedDataType A dynamic pointer size of 4-bytes will be in used, but will adapt to a data type manager's data organization when resolved.PointerDataType(DataTypeManager dtm)Creates a dynamically-sized default pointer data type.PointerDataType(DataType referencedDataType, int length)Construct a pointer of a specified length to a referencedDataType.PointerDataType(DataType referencedDataType, int length, DataTypeManager dtm)Construct a pointer of a specified length to a referencedDataType.PointerDataType(DataType referencedDataType, DataTypeManager dtm)Construct a dynamically-sized pointer to the given data type.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DataTypeclone(DataTypeManager dtm)Returns a new instance of this DataType with its universalID and SourceArchive identity retained.voiddataTypeDeleted(DataType dt)Informs this dataType that the given dataType has been deleted.voiddataTypeNameChanged(DataType dt, java.lang.String oldName)Informs this data type that its name has changed from the indicated old name.voiddataTypeReplaced(DataType oldDt, DataType newDt)Informs this data type that the given oldDT has been replaced with newDT
TODO: This method is reserved for internal DB use and should be removed from the public DataType interface!!booleandependsOn(DataType dt)Returns true if this dataType depends on the existence of the given dataType.static AddressgetAddressValue(MemBuffer buf, int size, AddressSpace targetSpace)Generate an address value based upon bytes stored at the specified buf locationCategoryPathgetCategoryPath()Gets the categoryPath associated with this data typeDataTypegetDataType()Returns the "pointed to" dataTypejava.lang.StringgetDefaultLabelPrefix()Returns the appropriate string to use as the default label prefix in the absence of any data.java.lang.StringgetDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)Returns the appropriate string to use as the default label prefix.java.lang.StringgetDescription()Get a String briefly describing this DataType.java.lang.StringgetDisplayName()Gets the name for referring to this data type.static java.lang.StringgetLabelString(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)intgetLength()Get the length (number of 8-bit bytes) of this DataType.java.lang.StringgetMnemonic(Settings settings)Get the mnemonic for this DataType.java.lang.StringgetName()Return that name of the data typestatic PointergetPointer(DataType dt, int pointerSize)Get a pointer data-type instance of the requested size.static PointergetPointer(DataType dt, DataTypeManager dtm)Get a pointer data-type instance with a default sizejava.lang.StringgetRepresentation(MemBuffer buf, Settings settings, int len)Get bytes from memory in a printable format for this type.java.lang.ObjectgetValue(MemBuffer buf, Settings settings, int len)Get the data in the form of the appropriate Object for this DataType.java.lang.Class<?>getValueClass(Settings settings)Get the Class of the value to be returned by this data type.booleanisDeleted()Returns true if this data type has been deleted and is no longer validbooleanisDynamicallySized()Indicates if this data-type is dynamically sized based upon DataOrganization.booleanisEquivalent(DataType dt)Returns true if the given dataType is equivalent to this dataType.PointernewPointer(DataType dt)Creates a pointer to the indicated data type.-
Methods inherited from class ghidra.program.model.data.BuiltIn
addParent, copy, dataTypeSizeChanged, getBuiltInSettingsDefinitions, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getDecompilerDisplayName, getLastChangeTime, getSettingsDefinitions, getUniversalID, removeParent, setCategoryPath, setName, setNameAndCategory
-
Methods inherited from class ghidra.program.model.data.DataTypeImpl
equals, getAlignment, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDocs, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, hashCode, isNotYetDefined, notifyDeleted, notifyNameChanged, notifyReplaced, notifySizeChanged, replaceWith, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive, stateChanged, toString
-
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, copy, dataTypeSizeChanged, getAlignment, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, isNotYetDefined, removeParent, replaceWith, setCategoryPath, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
-
-
-
-
Field Detail
-
dataType
public static final PointerDataType dataType
-
MAX_POINTER_SIZE_BYTES
public static final int MAX_POINTER_SIZE_BYTES
- See Also:
- Constant Field Values
-
POINTER_NAME
public static final java.lang.String POINTER_NAME
- See Also:
- Constant Field Values
-
POINTER_LABEL_PREFIX
public static final java.lang.String POINTER_LABEL_PREFIX
- See Also:
- Constant Field Values
-
POINTER_LOOP_LABEL_PREFIX
public static final java.lang.String POINTER_LOOP_LABEL_PREFIX
- See Also:
- Constant Field Values
-
referencedDataType
protected DataType referencedDataType
-
length
protected int length
-
-
Constructor Detail
-
PointerDataType
public PointerDataType()
Creates a dynamically-sized default pointer data type. A dynamic pointer size of 4-bytes will be in used, but will adapt to a data type manager's data organization when resolved.
-
PointerDataType
public PointerDataType(DataTypeManager dtm)
Creates a dynamically-sized default pointer data type. The pointer size is established dynamically based upon the data organization associated with the specified dtm but can adapt to another data type manager's data organization when resolved.- Parameters:
dtm- data-type manager whose data organization should be used
-
PointerDataType
public PointerDataType(DataType referencedDataType)
Construct a dynamically-sized pointer to a referencedDataType A dynamic pointer size of 4-bytes will be in used, but will adapt to a data type manager's data organization when resolved.- Parameters:
referencedDataType- data type this pointer points to
-
PointerDataType
public PointerDataType(DataType referencedDataType, int length)
Construct a pointer of a specified length to a referencedDataType. Note: It is preferred to use default sized pointers when possible (i.e., length=-1, seePointerDataType(DataType)) instead of explicitly specifying the pointer length value.- Parameters:
referencedDataType- data type this pointer points tolength- pointer length (values <= 0 will result in dynamically-sized pointer)
-
PointerDataType
public PointerDataType(DataType referencedDataType, DataTypeManager dtm)
Construct a dynamically-sized pointer to the given data type. The pointer size is established dynamically based upon the data organization associated with the specified dtm but can adapt to another data type manager's data organization when resolved.- Parameters:
dt- data type this pointer points todtm- data-type manager whose data organization should be used
-
PointerDataType
public PointerDataType(DataType referencedDataType, int length, DataTypeManager dtm)
Construct a pointer of a specified length to a referencedDataType. Note: It is preferred to use default sized pointers when possible (i.e., length=-1, seePointerDataType(DataType, DataTypeManager)) instead of explicitly specifying the pointer length value.- Parameters:
referencedDataType-length- pointer length (-1 will result in dynamically-sized pointer)dtm- associated data type manager whose data organization will be used
-
-
Method Detail
-
clone
public final DataType clone(DataTypeManager dtm)
Description copied from interface:DataTypeReturns a new instance of this DataType with its universalID and SourceArchive identity retained. Note: for built-in DataType's, clone and copy should have the same affect.
-
getDataType
public DataType getDataType()
Description copied from interface:PointerReturns the "pointed to" dataType- Specified by:
getDataTypein interfacePointer
-
isDynamicallySized
public boolean isDynamicallySized()
Description copied from interface:DataTypeIndicates if this data-type is dynamically sized based upon DataOrganization.- Specified by:
isDynamicallySizedin interfaceDataType
-
getLength
public int getLength()
Description copied from interface:DataTypeGet the length (number of 8-bit bytes) of this DataType.
-
getDefaultLabelPrefix
public java.lang.String getDefaultLabelPrefix()
Description copied from interface:DataTypeReturns the appropriate string to use as the default label prefix in the absence of any data.- Specified by:
getDefaultLabelPrefixin interfaceDataType- Overrides:
getDefaultLabelPrefixin classDataTypeImpl- Returns:
- the default label prefix or null if none specified.
-
getDefaultLabelPrefix
public java.lang.String getDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)
Description copied from interface:DataTypeReturns the appropriate string to use as the default label prefix.- Specified by:
getDefaultLabelPrefixin interfaceDataType- Overrides:
getDefaultLabelPrefixin classDataTypeImpl- Parameters:
buf- memory buffer containing the bytes.settings- the Settings objectoptions- options for how to format the default label prefix.- Returns:
- the default label prefix or null if none specified.
-
getLabelString
public static java.lang.String getLabelString(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)
-
getDisplayName
public java.lang.String getDisplayName()
Description copied from interface:DataTypeGets the name for referring to this data type.- Specified by:
getDisplayNamein interfaceDataType- Overrides:
getDisplayNamein classDataTypeImpl- Returns:
- generic name for this Data Type (i.e.: Word)
-
getDescription
public java.lang.String getDescription()
Description copied from interface:DataTypeGet a String briefly describing this DataType.- Specified by:
getDescriptionin interfaceDataType- Returns:
- a one-liner describing this DataType.
-
getMnemonic
public java.lang.String getMnemonic(Settings settings)
Description copied from interface:DataTypeGet the mnemonic for this DataType.- Specified by:
getMnemonicin interfaceDataType- Returns:
- the mnemonic for this DataType.
-
getValue
public java.lang.Object getValue(MemBuffer buf, Settings settings, int len)
Description copied from interface:DataTypeGet the data in the form of the appropriate Object for this DataType. For instance if the data type is an AddressDT, return an Address object. a Byte, return a Scalar* (maybe this should be a Byte) a Float, return a Float
-
getValueClass
public java.lang.Class<?> getValueClass(Settings settings)
Description copied from interface:DataTypeGet the Class of the value to be returned by this data type.- Specified by:
getValueClassin interfaceDataType- Overrides:
getValueClassin classDataTypeImpl- Parameters:
settings- the relevant settings to use or null for default.- Returns:
- Class of the value to be returned by this data type or null if it can vary or is unspecified. Types which correspond to a string or char array will return the String class.
-
getAddressValue
public static Address getAddressValue(MemBuffer buf, int size, AddressSpace targetSpace)
Generate an address value based upon bytes stored at the specified buf location- Parameters:
buf- memory buffer and stored pointer locationsize- pointer size in bytestargetSpace- address space for returned pointer- Returns:
- pointer value or null if unusable buf or data
-
getRepresentation
public java.lang.String getRepresentation(MemBuffer buf, Settings settings, int len)
Description copied from interface:DataTypeGet bytes from memory in a printable format for this type.- Specified by:
getRepresentationin interfaceDataType- Parameters:
buf- the data.settings- the settings to use for the representation.len- the number of bytes to represent.- Returns:
- the representation of the data in this format, never null.
-
isEquivalent
public boolean isEquivalent(DataType dt)
Description copied from interface:DataTypeReturns true if the given dataType is equivalent to this dataType. The precise meaning of "equivalent" is dataType dependent.- Specified by:
isEquivalentin interfaceDataType- Overrides:
isEquivalentin classBuiltIn- Parameters:
dt- the dataType being tested for equivalence.- Returns:
- true if the if the given dataType is equivalent to this dataType.
-
dataTypeDeleted
public void dataTypeDeleted(DataType dt)
Description copied from interface:DataTypeInforms this dataType that the given dataType has been deleted.
TODO: This method is reserved for internal DB use and should be removed from the public DataType interface!!- Specified by:
dataTypeDeletedin interfaceDataType- Overrides:
dataTypeDeletedin classBuiltIn- Parameters:
dt- the dataType that has been deleted.
-
isDeleted
public boolean isDeleted()
Description copied from interface:DataTypeReturns true if this data type has been deleted and is no longer valid- Specified by:
isDeletedin interfaceDataType- Overrides:
isDeletedin classDataTypeImpl- Returns:
- true if this data type has been deleted and is no longer valid.
- See Also:
DataType.isDeleted()
-
dataTypeReplaced
public void dataTypeReplaced(DataType oldDt, DataType newDt)
Description copied from interface:DataTypeInforms this data type that the given oldDT has been replaced with newDT
TODO: This method is reserved for internal DB use and should be removed from the public DataType interface!!- Specified by:
dataTypeReplacedin interfaceDataType- Overrides:
dataTypeReplacedin classBuiltIn- Parameters:
oldDt- old data typenewDt- new data type
-
dataTypeNameChanged
public void dataTypeNameChanged(DataType dt, java.lang.String oldName)
Description copied from interface:DataTypeInforms this data type that its name has changed from the indicated old name.
TODO: This method is reserved for internal DB use and should be removed from the public DataType interface!!- Specified by:
dataTypeNameChangedin interfaceDataType- Overrides:
dataTypeNameChangedin classBuiltIn- Parameters:
dt- the data type whose name changedoldName- the data type's old name
-
getCategoryPath
public CategoryPath getCategoryPath()
Description copied from interface:DataTypeGets the categoryPath associated with this data type- Specified by:
getCategoryPathin interfaceDataType- Overrides:
getCategoryPathin classDataTypeImpl- Returns:
- the datatype's category path
-
dependsOn
public boolean dependsOn(DataType dt)
Description copied from interface:DataTypeReturns true 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.
-
getPointer
public static Pointer getPointer(DataType dt, DataTypeManager dtm)
Get a pointer data-type instance with a default size- Parameters:
dt- data-type referenced by pointerdtm- program data-type manager (required) a generic data-type will be returned if possible.- Returns:
- signed integer data type
-
getPointer
public static Pointer getPointer(DataType dt, int pointerSize)
Get a pointer data-type instance of the requested size. NOTE: The returned data-type will not be associated with any particular data-type-manager and may therefore not utilize dynamically-sized-pointers when a valid pointerSize is specified. If an invalid pointerSize is specified, a dynamically-size pointer will be returned whose length is based upon the default-data-organization.- Parameters:
dt- data-type referenced by pointerpointerSize- pointer size- Returns:
- signed integer data type
-
newPointer
public Pointer newPointer(DataType dt)
Description copied from interface:PointerCreates a pointer to the indicated data type.- Specified by:
newPointerin interfacePointer- Parameters:
dt- the data type to point to.- Returns:
- the newly created pointer.
-
getName
public java.lang.String getName()
Description copied from interface:DataTypeReturn that name of the data type- Specified by:
getNamein interfaceDataType- Overrides:
getNamein classDataTypeImpl- See Also:
DataType.getName()
-
-