Class EnumDataType
- java.lang.Object
-
- ghidra.program.model.data.AbstractDataType
-
- ghidra.program.model.data.DataTypeImpl
-
- ghidra.program.model.data.GenericDataType
-
- ghidra.program.model.data.EnumDataType
-
- Direct Known Subclasses:
CliAbstractSig.CliTypeCodeDataType
,CliBlobMarshalSpec.CliNativeTypeDataType
,CliBlobMarshalSpec.CliSafeArrayElemTypeDataType
,CliFlags.CliEnumAssemblyFlags
,CliFlags.CliEnumAssemblyHashAlgorithm
,CliFlags.CliEnumEventAttributes
,CliFlags.CliEnumFieldAttributes
,CliFlags.CliEnumFileAttributes
,CliFlags.CliEnumGenericParamAttributes
,CliFlags.CliEnumManifestResourceAttributes
,CliFlags.CliEnumMethodAttributes
,CliFlags.CliEnumMethodImplAttributes
,CliFlags.CliEnumMethodSemanticsAttributes
,CliFlags.CliEnumParamAttributes
,CliFlags.CliEnumPInvokeAttributes
,CliFlags.CliEnumPropertyAttributes
,CliFlags.CliEnumTypeAttributes
,ImageCor20Header.ImageCor20Flags
public class EnumDataType extends GenericDataType implements Enum
-
-
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, VOID
-
-
Constructor Summary
Constructors Constructor Description EnumDataType(CategoryPath path, java.lang.String name, int length)
EnumDataType(CategoryPath path, java.lang.String name, int length, DataTypeManager dtm)
EnumDataType(CategoryPath path, java.lang.String name, int length, UniversalID universalID, SourceArchive sourceArchive, long lastChangeTime, long lastChangeTimeInSourceArchive, DataTypeManager dtm)
EnumDataType(java.lang.String name, int length)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(java.lang.String valueName, long value)
Add a enum entry.void
add(java.lang.String valueName, long value, java.lang.String comment)
Add a enum entry.DataType
clone(DataTypeManager dtm)
Returns an instance of this DataType with its universalID and SourceArchive identity retained.DataType
copy(DataTypeManager dtm)
Returns a new instance (shallow copy) of this DataType with a new identity.java.lang.String
getComment(java.lang.String valueName)
Get the comment for the given name.int
getCount()
Get the number of entries in this Enum.java.lang.String
getDefaultLabelPrefix()
Returns the appropriate string to use as the default label prefix in the absence of any data.java.lang.String
getDescription()
Get a String briefly describing this DataType.int
getLength()
Get the length (number of 8-bit bytes) of this DataType.java.lang.String
getMnemonic(Settings settings)
Get the mnemonic for this DataType.java.lang.String
getName(long value)
Get the name for the given value.java.lang.String[]
getNames()
Get the names of the enum entries.java.lang.String
getRepresentation(MemBuffer buf, Settings settings, int valueLength)
Get bytes from memory in a printable format for this type.java.lang.String
getRepresentation(java.math.BigInteger bigInt, Settings settings, int bitLength)
Get enum representation of the big-endian value.SettingsDefinition[]
getSettingsDefinitions()
Gets a list of all the settingsDefinitions used by this datatype.java.lang.Object
getValue(MemBuffer buf, Settings settings, int valueLength)
Get the data in the form of the appropriate Object for this DataType.long
getValue(java.lang.String valueName)
Get the value for the given name.java.lang.Class<?>
getValueClass(Settings settings)
Get the Class of the value to be returned by this datatype.long[]
getValues()
Get the values of the enum entries.boolean
isEquivalent(DataType dt)
Check if the given datatype is equivalent to this datatype.void
remove(java.lang.String valueName)
Remove the enum entry with the given name.void
replaceWith(DataType dataType)
For datatypes that support change, this method replaces the internals of this datatype with the internals of the given datatype.void
setDescription(java.lang.String description)
Sets a String briefly describing this DataType.void
setLength(int length)
-
Methods inherited from class ghidra.program.model.data.GenericDataType
setCategoryPath, setName, setNameAndCategory
-
Methods inherited from class ghidra.program.model.data.DataTypeImpl
addParent, equals, getAlignment, getDefaultSettings, getLastChangeTime, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, getUniversalID, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, removeParent, setDefaultSettings, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive
-
Methods inherited from class ghidra.program.model.data.AbstractDataType
dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, encodeRepresentation, encodeValue, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, 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.DataType
addParent, dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, encodeRepresentation, encodeValue, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSourceArchive, getUniversalID, hasLanguageDependantLength, isDeleted, isEncodable, isNotYetDefined, isZeroLength, removeParent, setCategoryPath, setDefaultSettings, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
-
-
-
-
Constructor Detail
-
EnumDataType
public EnumDataType(java.lang.String name, int length)
-
EnumDataType
public EnumDataType(CategoryPath path, java.lang.String name, int length)
-
EnumDataType
public EnumDataType(CategoryPath path, java.lang.String name, int length, DataTypeManager dtm)
-
EnumDataType
public EnumDataType(CategoryPath path, java.lang.String name, int length, UniversalID universalID, SourceArchive sourceArchive, long lastChangeTime, long lastChangeTimeInSourceArchive, DataTypeManager dtm)
-
-
Method Detail
-
getSettingsDefinitions
public SettingsDefinition[] getSettingsDefinitions()
Description copied from interface:DataType
Gets a list of all the settingsDefinitions used by this datatype.- Specified by:
getSettingsDefinitions
in interfaceDataType
- Overrides:
getSettingsDefinitions
in classDataTypeImpl
- Returns:
- a list of the settingsDefinitions used by this datatype.
-
getValue
public long getValue(java.lang.String valueName) throws java.util.NoSuchElementException
Description copied from interface:Enum
Get the value for the given name.
-
getName
public java.lang.String getName(long value)
Description copied from interface:Enum
Get the name for the given value.
-
getComment
public java.lang.String getComment(java.lang.String valueName)
Description copied from interface:Enum
Get the comment for the given name.- Specified by:
getComment
in interfaceEnum
- Parameters:
valueName
- name of the entry.- Returns:
- the comment or the empty string if the name does not exist in this enum or if no comment is set.
-
getValues
public long[] getValues()
Description copied from interface:Enum
Get the values of the enum entries.
-
getNames
public java.lang.String[] getNames()
Description copied from interface:Enum
Get the names of the enum entries. The returned names are first sorted by the enum int value, then sub-sorted by name value where there are multiple name values per int value.
-
getCount
public int getCount()
Description copied from interface:Enum
Get the number of entries in this Enum.
-
add
public void add(java.lang.String valueName, long value)
Description copied from interface:Enum
Add a enum entry.
-
add
public void add(java.lang.String valueName, long value, java.lang.String comment)
Description copied from interface:Enum
Add a enum entry.
-
remove
public void remove(java.lang.String valueName)
Description copied from interface:Enum
Remove the enum entry with the given name.
-
copy
public DataType copy(DataTypeManager dtm)
Description copied from interface:DataType
Returns a new instance (shallow copy) of this DataType with a new identity.Any reference to other datatypes will use
DataType.clone(DataTypeManager)
.
-
clone
public DataType clone(DataTypeManager dtm)
Description copied from interface:DataType
Returns an instance of this DataType with its universalID and SourceArchive identity retained.The current instanceof 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.
-
getMnemonic
public java.lang.String getMnemonic(Settings settings)
Description copied from interface:DataType
Get the mnemonic for this DataType.- Specified by:
getMnemonic
in interfaceDataType
- Overrides:
getMnemonic
in classAbstractDataType
- Parameters:
settings
- settings which may influence the result or null- Returns:
- the mnemonic for 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.
-
setLength
public void setLength(int length)
-
getDescription
public java.lang.String 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.
-
setDescription
public void setDescription(java.lang.String description)
Description copied from class:DataTypeImpl
Sets a String briefly describing this DataType.
If a data type that extends this class wants to allow the description to be changed, then it must override this method.- Specified by:
setDescription
in interfaceDataType
- Specified by:
setDescription
in interfaceEnum
- Overrides:
setDescription
in classDataTypeImpl
- Parameters:
description
- a one-liner describing this DataType.
-
getValue
public java.lang.Object getValue(MemBuffer buf, Settings settings, int valueLength)
Description copied from interface:DataType
Get the data in the form of the appropriate Object for this DataType.For instance if the datatype 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:DataType
Get the Class of the value to be returned by this datatype.- 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.
-
getRepresentation
public java.lang.String getRepresentation(MemBuffer buf, Settings settings, int valueLength)
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.valueLength
- 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)
Description copied from interface:Enum
Get enum representation of the big-endian value.- Specified by:
getRepresentation
in interfaceEnum
- Parameters:
bigInt
- BigInteger value with the appropriate signsettings
- integer format settings (PADDING, FORMAT, etc.)bitLength
- the bit length- Returns:
- formatted integer string
-
isEquivalent
public boolean isEquivalent(DataType dt)
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:
dt
- the datatype being tested for equivalence.- Returns:
- true if the if the given datatype is equivalent to this datatype.
-
replaceWith
public void replaceWith(DataType dataType)
Description copied from interface:DataType
For datatypes that support change, this method replaces the internals of this datatype with the internals of the given datatype.The datatypes must be of the same "type" (i.e. structure can only be replacedWith another structure.
- Specified by:
replaceWith
in interfaceDataType
- Overrides:
replaceWith
in classDataTypeImpl
-
getDefaultLabelPrefix
public java.lang.String getDefaultLabelPrefix()
Description copied from interface:DataType
Returns the appropriate string to use as the default label prefix in the absence of any data.- Specified by:
getDefaultLabelPrefix
in interfaceDataType
- Overrides:
getDefaultLabelPrefix
in classAbstractDataType
- Returns:
- the default label prefix or null if none specified.
-
-