Class AbstractLeb128DataType
java.lang.Object
ghidra.program.model.data.AbstractDataType
ghidra.program.model.data.DataTypeImpl
ghidra.program.model.data.BuiltIn
ghidra.app.plugin.exceptionhandlers.gcc.datatype.AbstractLeb128DataType
- All Implemented Interfaces:
BuiltInDataType
,DataType
,Dynamic
,ExtensionPoint
- Direct Known Subclasses:
SignedLeb128DataType
,UnsignedLeb128DataType
LEB128 is an integer compression system resulting in variable-length byte sequence.
An abstract base class for a little endian base 128 integer data type.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The maximum length in bytes of a leb128 data type.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
ConstructorsConstructorDescriptionAbstractLeb128DataType
(String name, boolean signed, DataTypeManager dtm) Base constructor for a little endian based 128 data type. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Determine if the length may be specified for an instanceof this datatype (e.g.,Data
,Array
,DataTypeComponent
, etc.).protected SettingsDefinition[]
Gets a list of all the settingsDefinitions used by this datatype.Get a String briefly describing this DataType.int
Get the length (number of 8-bit bytes) of this DataType.int
Compute the length for this data-type which corresponds to the specified memory location.Returns a suitable replacement base data-type for pointers and arrays when exporting to C codegetRepresentation
(MemBuffer buf, Settings settings, int length) Get bytes from memory in a printable format for this type.Get the interpretted data value in the form of the appropriate Object for this DataType.Methods inherited from class ghidra.program.model.data.BuiltIn
addParent, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getDecompilerDisplayName, getLastChangeTime, getSettingsDefinitions, getUniversalID, isEquivalent, removeParent, setCategoryPath, setDefaultSettings, setName, setNameAndCategory
Methods inherited from class ghidra.program.model.data.DataTypeImpl
equals, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, getValueClass, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive
Methods inherited from class ghidra.program.model.data.AbstractDataType
dataTypeAlignmentChanged, encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getMnemonic, getName, getTypeDefSettingsDefinitions, hasLanguageDependantLength, isDeleted, isEncodable, isNotYetDefined, isZeroLength, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface ghidra.program.model.data.BuiltInDataType
getCTypeDeclaration, setDefaultSettings
Methods inherited from interface ghidra.program.model.data.DataType
addParent, clone, copy, dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, encodeRepresentation, encodeValue, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getMnemonic, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getTypeDefSettingsDefinitions, getUniversalID, getValueClass, hasLanguageDependantLength, isDeleted, isEncodable, isEquivalent, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
-
Field Details
-
MAX_LEB128_ENCODED_VALUE_LEN
public static final int MAX_LEB128_ENCODED_VALUE_LENThe maximum length in bytes of a leb128 data type.- See Also:
-
-
Constructor Details
-
AbstractLeb128DataType
Base constructor for a little endian based 128 data type.- Parameters:
name
- name of the leb128 data type that extends this class.signed
- true if it is signed. false if unsigned.dtm
- the data type manager to associate with this data type.
-
-
Method Details
-
getBuiltInSettingsDefinitions
Description copied from class:BuiltIn
Gets a list of all the settingsDefinitions used by this datatype.- Overrides:
getBuiltInSettingsDefinitions
in classBuiltIn
- Returns:
- a list of the settingsDefinitions used by 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.
-
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. -
getLength
Description copied from interface:Dynamic
Compute the length for this data-type which corresponds to the specified memory location.- Specified by:
getLength
in interfaceDynamic
- Parameters:
buf
- memory locationmaxLength
- maximum number of bytes to consume in computing length, or -1 for unspecified.- Returns:
- data length or -1 if it could not be determined. Returned length may exceed maxLength if data-type does not supported constrained lengths.
-
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. -
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.
-
getReplacementBaseType
Description copied from interface:Dynamic
Returns a suitable replacement base data-type for pointers and arrays when exporting to C code- Specified by:
getReplacementBaseType
in interfaceDynamic
- Returns:
- suitable base data-type for this Dynamic data-type
-
canSpecifyLength
public boolean canSpecifyLength()Description copied from interface:Dynamic
Determine if the length may be specified for an instanceof this datatype (e.g.,Data
,Array
,DataTypeComponent
, etc.).- Specified by:
canSpecifyLength
in interfaceDynamic
- Returns:
- true if a user-specified length can be used, else false
-