Package ghidra.program.model.data

Class IconResourceDataType

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

ghidra.program.model.data.IconResourceDataType

All Implemented Interfaces:

BuiltInDataType, DataType, Dynamic, Resource, ExtensionPoint

Direct Known Subclasses:

IconMaskResourceDataType

public class IconResourceDataType
extends BitmapResourceDataType

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
	IconResourceDataType()
protected	IconResourceDataType(CategoryPath path, String name, DataTypeManager dtm)
	IconResourceDataType(DataTypeManager dtm)

Method Summary

Modifier and Type	Method	Description
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 BitmapResource	getBitmapResource(MemBuffer buf)
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)	Get the interpretted data value in the form of the appropriate Object for this DataType.

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

addComp, getAllComponents, getDefaultLabelPrefix, getValueClass

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, 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, 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, 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

IconResourceDataType

public IconResourceDataType()

IconResourceDataType

public IconResourceDataType(DataTypeManager dtm)

IconResourceDataType

protected IconResourceDataType(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

Overrides:

getDescription in class BitmapResourceDataType

Returns:

a one-liner describing this DataType.

getValue

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

Description copied from interface: DataType

Get the interpretted data value in the form of the appropriate Object for this DataType. This method must return a value consistent with DataType.getValueClass(Settings).

For instance, if this datatype is a Pointer an Address object or null should be returned. A Byte, returns a Scalar object.

Specified by:

getValue in interface DataType

Overrides:

getValue in class BitmapResourceDataType

Parameters:

buf - the data buffer.

settings - the settings to use.

length - the number of bytes to get the value from.

Returns:

the data Object.

getBitmapResource

protected BitmapResource getBitmapResource(MemBuffer buf)

Overrides:

getBitmapResource in class BitmapResourceDataType

addComponents

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

Overrides:

addComponents in class BitmapResourceDataType

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 BitmapResourceDataType

Parameters:

settings - settings which may influence the result or null

Returns:

the mnemonic for this DataType.

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

Overrides:

getRepresentation in class BitmapResourceDataType

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.

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 shuold be made directly to this instance if supported or to a DataType.copy(DataTypeManager).

Specified by:

clone in interface DataType

Overrides:

clone in class BitmapResourceDataType

Parameters:

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

Returns:

cloned instance which may be the same as this instance