Package ghidra.program.model.data

Class BitmapResourceDataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.BuiltIn

ghidra.program.model.data.DynamicDataType

ghidra.program.model.data.BitmapResourceDataType

All Implemented Interfaces:

BuiltInDataType, DataType, Dynamic, Resource, ExtensionPoint

Direct Known Subclasses:

IconResourceDataType

public class BitmapResourceDataType
extends DynamicDataType
implements Resource

Definition of a Bitmap Resource Data Structure defined within the resources section of a windows executable.

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, TYPEDEF_ATTRIBUTE_PREFIX, TYPEDEF_ATTRIBUTE_SUFFIX, VOID

Constructor Summary

Constructors

Modifier	Constructor	Description
	BitmapResourceDataType()
protected	BitmapResourceDataType(CategoryPath path, String name, DataTypeManager dtm)
	BitmapResourceDataType(DataTypeManager dtm)

Method Summary

Modifier and Type	Method	Description
protected final int	addComp(DataType dataType, int length, String fieldName, List<DataTypeComponent> comps, int offset)
protected int	addComponents(MemBuffer buf, BitmapResource bmr, List<DataTypeComponent> comps)
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.
protected final DataTypeComponent[]	getAllComponents(MemBuffer buf)	Get all dynamic components associated with the specified MemBuffer
protected BitmapResource	getBitmapResource(MemBuffer buf)
String	getDefaultLabelPrefix()	Returns the appropriate string to use as the default label prefix in the absence of any data.
String	getDescription()	Get a String briefly describing this DataType.
String	getMnemonic(Settings settings)	Get the mnemonic for this DataType.
String	getRepresentation(MemBuffer buf, Settings settings, int length)	Get bytes from memory in a printable format for this type.
Object	getValue(MemBuffer buf, Settings settings, int length)	Returns the interpreted data value as an instance of the advertised value class.
Class<?>	getValueClass(Settings settings)	Get the Class of the value Object to be returned by this datatype (see DataType.getValue(MemBuffer, Settings, int)).

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

canSpecifyLength, getComponent, getComponentAt, getComponents, getComps, getLength, getLength, getNumComponents, getReplacementBaseType, invalidateCache

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

addParent, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getBuiltInSettingsDefinitions, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getCTypeDeclaration, getDecompilerDisplayName, getLastChangeTime, getSettingsDefinitions, getUniversalID, isEquivalent, removeParent, setCategoryPath, setDefaultSettings, setName, setNameAndCategory

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

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

Constructor Details

BitmapResourceDataType

public BitmapResourceDataType()

BitmapResourceDataType

public BitmapResourceDataType(DataTypeManager dtm)

BitmapResourceDataType

protected BitmapResourceDataType(CategoryPath path,
 String name,
 DataTypeManager dtm)

Method Details

getDescription

public String getDescription()

Description copied from interface: DataType

Get a String briefly describing this DataType.

Specified by:

getDescription in interface DataType

Returns:

a one-liner describing this DataType.

getMnemonic

public String getMnemonic(Settings settings)

Description copied from interface: DataType

Get the mnemonic for this DataType.

Specified by:

getMnemonic in interface DataType

Overrides:

getMnemonic in class AbstractDataType

Parameters:

settings - settings which may influence the result or null

Returns:

the mnemonic for this DataType.

getValue

public Object getValue(MemBuffer buf,
 Settings settings,
 int length)

Description copied from interface: DataType

Returns the interpreted data value as an instance of the advertised value class.

For instance, Pointer data types should return an Address object (or null), or integer data types should return a Scalar object.

Specified by:

getValue in interface DataType

Parameters:

buf - the data buffer

settings - the settings to use.

length - indicates the maximum number of bytes that may be consumed by a Dynamic datatype, otherwise this value is ignored. A value of -1 may be specified to allow a Dynamic datatype to determine the length based upon the actual data bytes

Returns:

the data object, or null if data is invalid

getValueClass

public Class<?> getValueClass(Settings settings)

Description copied from interface: DataType

Get the Class of the value Object to be returned by this datatype (see DataType.getValue(MemBuffer, Settings, int)).

Specified by:

getValueClass in interface DataType

Overrides:

getValueClass in class DataTypeImpl

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.

getAllComponents

protected final DataTypeComponent[] getAllComponents(MemBuffer buf)

Description copied from class: DynamicDataType

Get all dynamic components associated with the specified MemBuffer

Specified by:

getAllComponents in class DynamicDataType

Parameters:

buf - memory buffer positioned at start of data type instance

Returns:

all components or null if memory data is not valid for this data type.

addComp

protected final int addComp(DataType dataType,
 int length,
 String fieldName,
 List<DataTypeComponent> comps,
 int offset)

getBitmapResource

protected BitmapResource getBitmapResource(MemBuffer buf)

addComponents

protected int addComponents(MemBuffer buf,
 BitmapResource bmr,
 List<DataTypeComponent> comps)

getRepresentation

public String getRepresentation(MemBuffer buf,
 Settings settings,
 int length)

Description copied from interface: DataType

Get bytes from memory in a printable format for this type.

Specified by:

getRepresentation in interface DataType

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.

getDefaultLabelPrefix

public 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 interface DataType

Overrides:

getDefaultLabelPrefix in class AbstractDataType

Returns:

the default label prefix or null if none specified.

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.

Specified by:

clone in interface DataType

Parameters:

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

Returns:

cloned instance which may be the same as this instance