Package ghidra.program.model.data
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
-
- All Implemented Interfaces:
DataType,Enum,java.util.EventListener,javax.swing.event.ChangeListener
- Direct Known Subclasses:
CliAbstractSig.CliTypeCodeDataType,CliBlobMarshalSpec.CliNativeTypeDataType,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.GenericDataType
packed
-
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 voidadd(java.lang.String valueName, long value)Add a enum entry.DataTypeclone(DataTypeManager dtm)Returns a new instance of this DataType with its universalID and SourceArchive identity retained.DataTypecopy(DataTypeManager dtm)Returns a new instance of this DataType with a new identity.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!!voiddataTypeSizeChanged(DataType dt)Notification that the given dataType's size has changed.booleandependsOn(DataType dt)Returns true if this dataType depends on the existence of the given dataType.intgetCount()Get the number of entries in this Enum.java.lang.StringgetDefaultLabelPrefix()Returns the appropriate string to use as the default label prefix in the absence of any data.java.lang.StringgetDescription()Get a String briefly describing this DataType.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(long value)Get the name for the given value.java.lang.String[]getNames()Get the names of the enum entries.java.lang.StringgetRepresentation(MemBuffer buf, Settings settings, int valueLength)Get bytes from memory in a printable format for this type.java.lang.StringgetRepresentation(java.math.BigInteger bigInt, Settings settings, int bitLength)Get enum representation of the big-endian value.java.lang.ObjectgetValue(MemBuffer buf, Settings settings, int valueLength)Get the data in the form of the appropriate Object for this DataType.longgetValue(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 data type.long[]getValues()Get the values of the enum entries.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.voidremove(java.lang.String valueName)Remove the enum entry with the given name.voidreplaceWith(DataType dataType)For dataTypes that support change, this method replaces the internals of this dataType with the internals of the given dataType.voidsetDescription(java.lang.String description)Sets a String briefly describing this DataType.voidsetLength(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, getSettingsDefinitions, getSourceArchive, getUniversalID, hashCode, notifyDeleted, notifyNameChanged, notifyReplaced, notifySizeChanged, removeParent, setDefaultSettings, 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.DataType
addParent, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, isDeleted, isNotYetDefined, 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
-
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()
-
getValue
public long getValue(java.lang.String valueName) throws java.util.NoSuchElementExceptionDescription copied from interface:EnumGet the value for the given name.
-
getName
public java.lang.String getName(long value)
Description copied from interface:EnumGet the name for the given value.
-
getValues
public long[] getValues()
Description copied from interface:EnumGet the values of the enum entries.
-
getNames
public java.lang.String[] getNames()
Description copied from interface:EnumGet the names of the enum entries.
-
getCount
public int getCount()
Description copied from interface:EnumGet the number of entries in this Enum.
-
add
public void add(java.lang.String valueName, long value)Description copied from interface:EnumAdd a enum entry.
-
remove
public void remove(java.lang.String valueName)
Description copied from interface:EnumRemove the enum entry with the given name.
-
copy
public DataType copy(DataTypeManager dtm)
Description copied from interface:DataTypeReturns a new instance of this DataType with a new identity. Note: for built-in DataType's, clone and copy should have the same affect.
-
clone
public 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.
-
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.
-
getLength
public int getLength()
Description copied from interface:DataTypeGet the length (number of 8-bit bytes) of this DataType.
-
setLength
public void setLength(int length)
-
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.
-
setDescription
public void setDescription(java.lang.String description)
Description copied from class:DataTypeImplSets 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:
setDescriptionin interfaceDataType- Specified by:
setDescriptionin interfaceEnum- Overrides:
setDescriptionin 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: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 valueLength)
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.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:EnumGet enum representation of the big-endian value.- Specified by:
getRepresentationin interfaceEnum- Parameters:
bigInt- BigInteger value with the appropriate signsettings- integer format settings (PADDING, FORMAT, etc.)- Returns:
- formatted integer string
-
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- 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:DataTypeFor 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:
replaceWithin interfaceDataType- Overrides:
replaceWithin classDataTypeImpl- Parameters:
dataType- the dataType that contains the internals to upgrade to.
-
dataTypeSizeChanged
public void dataTypeSizeChanged(DataType dt)
Description copied from interface:DataTypeNotification that the given dataType's size has changed. DataTypes may need to make internal changes in response.
TODO: This method is reserved for internal DB use and should be removed from the public DataType interface!!- Specified by:
dataTypeSizeChangedin interfaceDataType- Overrides:
dataTypeSizeChangedin classAbstractDataType- Parameters:
dt- the dataType that has changed.- See Also:
DataType.dataTypeSizeChanged(ghidra.program.model.data.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 classAbstractDataType- Parameters:
dt- the dataType that has been deleted.- See Also:
DataType.dataTypeDeleted(ghidra.program.model.data.DataType)
-
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 classAbstractDataType- Parameters:
dt- the data type whose name changedoldName- the data type's old name- See Also:
DataType.dataTypeNameChanged(ghidra.program.model.data.DataType, java.lang.String)
-
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 classAbstractDataType- Parameters:
oldDt- old data typenewDt- new data type- See Also:
DataType.dataTypeReplaced(ghidra.program.model.data.DataType, ghidra.program.model.data.DataType)
-
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.- Specified by:
dependsOnin interfaceDataType- Overrides:
dependsOnin classAbstractDataType- Parameters:
dt- the dataType to test that this dataType depends on.- See Also:
DataType.dependsOn(ghidra.program.model.data.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 classAbstractDataType- Returns:
- the default label prefix or null if none specified.
-
-