Package ghidra.program.model.data
Class AbstractIntegerDataType
- java.lang.Object
-
- ghidra.program.model.data.AbstractDataType
-
- ghidra.program.model.data.DataTypeImpl
-
- ghidra.program.model.data.BuiltIn
-
- ghidra.program.model.data.AbstractIntegerDataType
-
- All Implemented Interfaces:
ArrayStringable,BuiltInDataType,DataType,ExtensionPoint,java.util.EventListener,javax.swing.event.ChangeListener
- Direct Known Subclasses:
BooleanDataType,ByteDataType,CharDataType,DWordDataType,Integer16DataType,Integer3DataType,Integer5DataType,Integer6DataType,Integer7DataType,IntegerDataType,LongDataType,LongLongDataType,QWordDataType,ShortDataType,SignedByteDataType,SignedDWordDataType,SignedQWordDataType,SignedWordDataType,UnsignedInteger16DataType,UnsignedInteger3DataType,UnsignedInteger5DataType,UnsignedInteger6DataType,UnsignedInteger7DataType,UnsignedIntegerDataType,UnsignedLongDataType,UnsignedLongLongDataType,UnsignedShortDataType,WordDataType
public abstract class AbstractIntegerDataType extends BuiltIn implements ArrayStringable
Base type for integer data types such aschars,ints, andlongs.If
FormatSettingsDefinition.getFormat(Settings)indicates that this is aCHARtype, theArrayStringablemethods will treat an array of this data type as a string.
-
-
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 protected static EndianSettingsDefinitionENDIANprotected static DataTypeMnemonicSettingsDefinitionMNEMONICprotected static PaddingSettingsDefinitionPADDING-
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, VOID
-
-
Constructor Summary
Constructors Constructor Description AbstractIntegerDataType(java.lang.String name, boolean signed, DataTypeManager dtm)Constructor
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetArrayDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)For cases where an array of this type exists, get the appropriate string to use as the default label prefix for the array.java.lang.StringgetArrayDefaultOffcutLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutOffset)For cases where an array of this type exists, get the appropriate string to use as the default label prefix, taking into account the fact that there exists a reference to the data that references offcutLength bytes into this typejava.lang.StringgetAssemblyMnemonic()protected SettingsDefinition[]getBuiltInSettingsDefinitions()Gets a list of all the settingsDefinitions used by this datatype.java.lang.StringgetCDeclaration()java.lang.StringgetCMnemonic()java.lang.StringgetDefaultLabelPrefix()Returns the appropriate string to use as the default label prefix in the absence of any data.protected FormatSettingsDefinitiongetFormatSettingsDefinition()Return the Format settings definition included in the settings definition arrayjava.lang.StringgetMnemonic(Settings settings)Get the mnemonic for this DataType.abstract AbstractIntegerDataTypegetOppositeSignednessDataType()java.lang.StringgetRepresentation(MemBuffer buf, Settings settings, int length)Get bytes from memory in a printable format for this type.java.lang.StringgetRepresentation(java.math.BigInteger bigInt, Settings settings, int bitLength)Get integer representation of the big-endian value.static DataTypegetSignedDataType(int size, DataTypeManager dtm)Get a Signed Integer data-type instance of the requested sizestatic AbstractIntegerDataType[]getSignedDataTypes(DataTypeManager dtm)Returns all built-in signed integer data-types.static DataTypegetUnsignedDataType(int size, DataTypeManager dtm)Get a Unsigned Integer data-type instance of the requested sizestatic AbstractIntegerDataType[]getUnsignedDataTypes(DataTypeManager dtm)Returns all built-in unsigned integer data-typesjava.lang.ObjectgetValue(MemBuffer buf, Settings settings, int length)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.booleanhasStringValue(Settings settings)For cases where an array of this type exists, determines if a String value will be returned.booleanisDynamicallySized()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.booleanisSigned()-
Methods inherited from class ghidra.program.model.data.BuiltIn
addParent, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getDecompilerDisplayName, getLastChangeTime, getSettingsDefinitions, getUniversalID, removeParent, setCategoryPath, setName, setNameAndCategory
-
Methods inherited from class ghidra.program.model.data.DataTypeImpl
equals, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, hashCode, notifyDeleted, notifyNameChanged, notifyReplaced, notifySizeChanged, replaceWith, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive, stateChanged
-
Methods inherited from class ghidra.program.model.data.AbstractDataType
getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, isDeleted, isNotYetDefined, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface ghidra.program.model.data.ArrayStringable
getArrayString
-
Methods inherited from interface ghidra.program.model.data.DataType
addParent, clone, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDescription, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getLength, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, isDeleted, isNotYetDefined, removeParent, replaceWith, setCategoryPath, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
-
-
-
-
Field Detail
-
PADDING
protected static final PaddingSettingsDefinition PADDING
-
ENDIAN
protected static final EndianSettingsDefinition ENDIAN
-
MNEMONIC
protected static final DataTypeMnemonicSettingsDefinition MNEMONIC
-
-
Constructor Detail
-
AbstractIntegerDataType
public AbstractIntegerDataType(java.lang.String name, boolean signed, DataTypeManager dtm)Constructor- Parameters:
name- a unique signed/unsigned data-type name (also used as the mnemonic)signed- true if signed, false if unsigneddtm- data-type manager whose data organization should be used
-
-
Method Detail
-
isDynamicallySized
public boolean isDynamicallySized()
Description copied from interface:DataTypeIndicates if this data-type is dynamically sized based upon DataOrganization.- Specified by:
isDynamicallySizedin interfaceDataType- Overrides:
isDynamicallySizedin classAbstractDataType- See Also:
DataType.isDynamicallySized()
-
getFormatSettingsDefinition
protected FormatSettingsDefinition getFormatSettingsDefinition()
Return the Format settings definition included in the settings definition array- Returns:
- Format settings definition included in the settings definition array
- See Also:
BuiltIn.getSettingsDefinitions()
-
getBuiltInSettingsDefinitions
protected SettingsDefinition[] getBuiltInSettingsDefinitions()
Description copied from class:BuiltInGets a list of all the settingsDefinitions used by this datatype.- Overrides:
getBuiltInSettingsDefinitionsin classBuiltIn- Returns:
- a list of the settingsDefinitions used by this datatype.
-
isSigned
public boolean isSigned()
- Returns:
- true if this is a signed integer data-type
-
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 classAbstractDataType- Returns:
- the default label prefix or null if none specified.
-
getMnemonic
public java.lang.String getMnemonic(Settings settings)
Description copied from interface:DataTypeGet the mnemonic for this DataType.- Specified by:
getMnemonicin interfaceDataType- Overrides:
getMnemonicin classAbstractDataType- Returns:
- the mnemonic for this DataType.
-
getAssemblyMnemonic
public java.lang.String getAssemblyMnemonic()
- Returns:
- the Assembly style data-type declaration for this data-type.
-
getCMnemonic
public java.lang.String getCMnemonic()
- Returns:
- the C style data-type mnemonic for this data-type. NOTE: currently the same as getCDeclaration().
-
getCDeclaration
public java.lang.String getCDeclaration()
- Returns:
- the C style data-type declaration for this data-type. Null is returned if no appropriate declaration exists.
-
getValue
public java.lang.Object getValue(MemBuffer buf, Settings settings, int length)
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.
-
getRepresentation
public java.lang.String getRepresentation(MemBuffer buf, Settings settings, int length)
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.length- the number of bytes to represent.- Returns:
- the representation of the data in this format, never null.
-
getRepresentation
public java.lang.String getRepresentation(java.math.BigInteger bigInt, Settings settings, int bitLength)Get integer representation of the big-endian value.- Parameters:
bigInt- BigInteger value with the appropriate signsettings- integer format settings (PADDING, FORMAT, etc.)bitLength- number of value bits to be used from bigInt- Returns:
- formatted integer string
-
hasStringValue
public boolean hasStringValue(Settings settings)
Description copied from interface:ArrayStringableFor cases where an array of this type exists, determines if a String value will be returned.- Specified by:
hasStringValuein interfaceArrayStringable- Returns:
- true if array of this type with the specified settings will return a String value.
-
getArrayDefaultLabelPrefix
public java.lang.String getArrayDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)
Description copied from interface:ArrayStringableFor cases where an array of this type exists, get the appropriate string to use as the default label prefix for the array.- Specified by:
getArrayDefaultLabelPrefixin interfaceArrayStringable- 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.
-
getArrayDefaultOffcutLabelPrefix
public java.lang.String getArrayDefaultOffcutLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutOffset)
Description copied from interface:ArrayStringableFor cases where an array of this type exists, get the appropriate string to use as the default label prefix, taking into account the fact that there exists a reference to the data that references offcutLength bytes into this type- Specified by:
getArrayDefaultOffcutLabelPrefixin interfaceArrayStringable- 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.
-
getOppositeSignednessDataType
public abstract AbstractIntegerDataType getOppositeSignednessDataType()
- Returns:
- the data-type with the opposite signedness from this data-type. For example, this method on IntegerDataType will return an instance of UnsignedIntegerDataType.
-
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.
-
getSignedDataType
public static DataType getSignedDataType(int size, DataTypeManager dtm)
Get a Signed Integer data-type instance of the requested size- Parameters:
size- data type size, sizes greater than 8 (and other than 16) will cause an SignedByteDataType[size] (i.e., Array) to be returned.dtm- optional program data-type manager, if specified a generic data-type will be returned if possible.- Returns:
- signed integer data type
-
getSignedDataTypes
public static AbstractIntegerDataType[] getSignedDataTypes(DataTypeManager dtm)
Returns all built-in signed integer data-types.- Parameters:
dtm- optional program data-type manager, if specified generic data-types will be returned in place of fixed-sized data-types.- Returns:
- array of all signed integer types (char and bool types excluded)
-
getUnsignedDataType
public static DataType getUnsignedDataType(int size, DataTypeManager dtm)
Get a Unsigned Integer data-type instance of the requested size- Parameters:
size- data type size, sizes greater than 8 (and other than 16) will cause an undefined type to be returned.dtm- optional program data-type manager, if specified a generic data-type will be returned if possible.- Returns:
- unsigned integer data type
-
getUnsignedDataTypes
public static AbstractIntegerDataType[] getUnsignedDataTypes(DataTypeManager dtm)
Returns all built-in unsigned integer data-types- Parameters:
dtm- optional program data-type manager, if specified generic data-types will be returned in place of fixed-sized data-types.- Returns:
- array of all unsigned integer types (char and bool types excluded)
-
-