Package ghidra.program.model.data

Class RGB32ColorDataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.BuiltIn

ghidra.program.model.data.AbstractIntegerDataType

ghidra.program.model.data.AbstractUnsignedIntegerDataType

ghidra.program.model.data.AbstractColorDataType

ghidra.program.model.data.RGB32ColorDataType

All Implemented Interfaces:

ArrayStringable, BuiltInDataType, DataType, ExtensionPoint

public class RGB32ColorDataType
extends AbstractColorDataType

RGB32ColorDataType provides a base implementation for 32-bit RGB Color values with an Alpha channel. While this base implementation defaults to ARGB_8888 encoding a TypeDef may be established with a different 32-bit encoding specified via a default setting of RGB32EncodingSettingsDefinition.

Nested Class Summary

Nested classes/interfaces inherited from class ghidra.program.model.data.AbstractColorDataType

AbstractColorDataType.ComponentValue

Field Summary

Fields

Modifier and Type	Field	Description
static RGB32ColorDataType	datatype

Fields inherited from class ghidra.program.model.data.AbstractIntegerDataType

ENDIAN, MNEMONIC, PADDING, SETTINGS_DEFS, TYPEDEF_SETTINGS_DEFS

Fields inherited from class ghidra.program.model.data.DataTypeImpl

defaultSettings

Fields inherited from class ghidra.program.model.data.AbstractDataType

categoryPath, dataMgr, EMPTY_TYPEDEF_DEFINITIONS, 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

Constructors

Constructor	Description
RGB32ColorDataType()
RGB32ColorDataType(DataTypeManager dtm)

Method Summary

Modifier and Type	Method	Description
DataType	clone(DataTypeManager dtm)	Returns an instance of this DataType using the specified DataTypeManager to allow its use of the corresponding DataOrganization while retaining its unique identity (see DataType.getUniversalID() and archive association (see DataType.getSourceArchive()) if applicable.
static TypedefDataType	createRGB32Typedef(RGB32EncodingSettingsDefinition.RGB32Encoding rgb32Encoding)	Generate a 32-bit RGB typedef with a specific encoding
protected Color	decodeColor(MemBuffer buf, Settings settings)	Generate the Color which corresponds to the memory bytes.
protected List<AbstractColorDataType.ComponentValue>	getComponentValues(MemBuffer buf, Settings settings)
String	getDescription()	Get a String briefly describing this DataType.
protected String	getEncodingName(Settings settings)
int	getLength()	Get the length of this DataType as a number of 8-bit bytes.
TypeDefSettingsDefinition[]	getTypeDefSettingsDefinitions()	Get the list of all settings definitions for this datatype that may be used for an associated TypeDef.

Methods inherited from class ghidra.program.model.data.AbstractColorDataType

getFieldValue, getOppositeSignednessDataType, getRepresentation, getValue, getValueClass, scaleFieldValue

Methods inherited from class ghidra.program.model.data.AbstractUnsignedIntegerDataType

isSigned

Methods inherited from class ghidra.program.model.data.AbstractIntegerDataType

castValueToEncode, encodeRepresentation, encodeValue, getArrayDefaultLabelPrefix, getArrayDefaultOffcutLabelPrefix, getAssemblyMnemonic, getBitCount, getBuiltInSettingsDefinitions, getCDeclaration, getCMnemonic, getDefaultLabelPrefix, getFormatSettingsDefinition, getMnemonic, getSignedDataType, getSignedDataTypes, getUnsignedDataType, getUnsignedDataTypes, hasStringValue, isEncodable, isEquivalent

Methods inherited from class ghidra.program.model.data.BuiltIn

addParent, copy, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getDecompilerDisplayName, getLastChangeTime, getSettingsDefinitions, getUniversalID, removeParent, setDefaultSettings

Methods inherited from class ghidra.program.model.data.DataTypeImpl

equals, getAlignedLength, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getSourceArchive, hashCode, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, replaceWith, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive

Methods inherited from class ghidra.program.model.data.AbstractDataType

dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getCategoryPath, getDataOrganization, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getName, getPathName, hasLanguageDependantLength, isDeleted, isNotYetDefined, isZeroLength, setCategoryPath, setName, setNameAndCategory, 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, copy, dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getAlignedLength, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, hasLanguageDependantLength, isDeleted, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive

Field Details

datatype

public static RGB32ColorDataType datatype

Constructor Details

RGB32ColorDataType

public RGB32ColorDataType()

RGB32ColorDataType

public RGB32ColorDataType(DataTypeManager dtm)

Method Details

createRGB32Typedef

public static TypedefDataType createRGB32Typedef(RGB32EncodingSettingsDefinition.RGB32Encoding rgb32Encoding)

Generate a 32-bit RGB typedef with a specific encoding

Parameters:

rgb32Encoding - 32-bit RGB encoding

Returns:

RGB32 typedef

clone

public DataType clone(DataTypeManager dtm)

Description copied from interface: DataType

Returns an instance of this DataType using the specified DataTypeManager to allow its use of the corresponding DataOrganization while retaining its unique identity (see DataType.getUniversalID() and archive association (see DataType.getSourceArchive()) if applicable.

This instance 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.

NOTE: In general, this method should not be used to obtain an instance to be modified. In most cases changes may be made directly to this instance if supported or to a DataType.copy(DataTypeManager) of this type.

Parameters:

dtm - the data-type manager instance whose data-organization should apply.

Returns:

cloned instance which may be the same as this instance

getLength

public int getLength()

Description copied from interface: DataType

Get the length of this DataType as a number of 8-bit bytes.

For primitive datatypes this reflects the smallest varnode which can be used to contain its value (i.e., raw data length).

Example: For x86 32-bit gcc an 80-bit long double raw data length of 10-bytes will fit within a floating point register while its aligned-length of 12-bytes is used by the gcc compiler for data/array/component allocations to maintain alignment (i.e., sizeof(long double) ).

NOTE: Other than the VoidDataType, no datatype should ever return 0, even if DataType.isZeroLength(), and only Dynamic/FactoryDataType datatypes should return -1. If DataType.isZeroLength() is true a length of 1 should be returned. Where a zero-length datatype can be handled (e.g., Composite) the DataType.isZeroLength() method should be used.

Returns:

the length of this DataType

getDescription

public String getDescription()

Description copied from interface: DataType

Get a String briefly describing this DataType.

Returns:

a one-liner describing this DataType.

getTypeDefSettingsDefinitions

public TypeDefSettingsDefinition[] getTypeDefSettingsDefinitions()

Description copied from interface: DataType

Get the list of all settings definitions for this datatype that may be used for an associated TypeDef. When used for an associated TypeDef, these settings will be considered during a DataType.isEquivalent(DataType) check and will be preserved during the resolve process.

Specified by:

getTypeDefSettingsDefinitions in interface DataType

Overrides:

getTypeDefSettingsDefinitions in class AbstractIntegerDataType

Returns:

a list of the settings definitions for a TypeDef associated with this datatype.

decodeColor

protected Color decodeColor(MemBuffer buf,
 Settings settings)

Description copied from class: AbstractColorDataType

Generate the Color which corresponds to the memory bytes. Implementation must factor Endianess setting into value used.

Specified by:

decodeColor in class AbstractColorDataType

Parameters:

buf - memory bytes buffer

settings - datatype settings

Returns:

Color to be rendered

getEncodingName

protected String getEncodingName(Settings settings)

Specified by:

getEncodingName in class AbstractColorDataType

getComponentValues

protected List<AbstractColorDataType.ComponentValue> getComponentValues(MemBuffer buf,
 Settings settings)

Specified by:

getComponentValues in class AbstractColorDataType