Package ghidra.program.model.data

Class PngDataType

java.lang.Object

ghidra.program.model.data.AbstractDataType

ghidra.program.model.data.DataTypeImpl

ghidra.program.model.data.BuiltIn

ghidra.program.model.data.PngDataType

All Implemented Interfaces:

BuiltInDataType, DataType, Dynamic, Resource, ExtensionPoint, java.util.EventListener, javax.swing.event.ChangeListener

public class PngDataType
extends BuiltIn
implements Dynamic, Resource

Nested Class Summary

Nested classes/interfaces inherited from interface ghidra.util.classfinder.ExtensionPoint

ExtensionPoint.Exclude, ExtensionPoint.Util

Field Summary

Fields

Modifier and Type	Field	Description
static byte[]	MAGIC
static byte[]	MASK

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
PngDataType()
PngDataType(DataTypeManager dtm)

Method Summary

Modifier and Type	Method	Description
boolean	canSpecifyLength()	Returns true if a user-specified length can be used
DataType	clone(DataTypeManager dtm)	Returns a new instance of this DataType with its universalID and SourceArchive identity retained.
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.
int	getLength(MemBuffer buf, int maxLength)	Compute the length for this data-type which corresponds to the specified memory location.
java.lang.String	getMnemonic(Settings settings)	Get the mnemonic for this DataType.
DataType	getReplacementBaseType()	Returns a suitable replacement base data-type for pointers and arrays when exporting to C code
java.lang.String	getRepresentation(MemBuffer buf, Settings settings, int length)	Get bytes from memory in a printable format for this type.
java.lang.Object	getValue(MemBuffer buf, Settings settings, int length)	Get the data in the form of the appropriate Object for this DataType.
java.lang.Class<?>	getValueClass(Settings settings)	Get the Class of the value to be returned by this data type.
boolean	isDynamicallySized()	Indicates if this data-type is dynamically sized based upon DataOrganization.

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

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

equals, getAlignment, getDefaultSettings, getLastChangeTimeInSourceArchive, getParents, getPathName, getSourceArchive, hashCode, notifyDeleted, notifyNameChanged, notifyReplaced, notifySizeChanged, replaceWith, setDefaultSettings, setDescription, 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.BuiltInDataType

getCTypeDeclaration

Methods inherited from interface ghidra.program.model.data.DataType

addParent, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, isDeleted, isEquivalent, isNotYetDefined, removeParent, replaceWith, setCategoryPath, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive

Field Detail

MAGIC

public static byte[] MAGIC

MASK

public static byte[] MASK

Constructor Detail

PngDataType

public PngDataType()

PngDataType

public PngDataType(DataTypeManager dtm)

Method Detail

getLength

public int getLength()

Description copied from interface: DataType

Get the length (number of 8-bit bytes) of this DataType.

Specified by:

getLength in interface DataType

Returns:

the length of this DataType

getLength

public int getLength(MemBuffer buf,
                     int maxLength)

Description copied from interface: Dynamic

Compute the length for this data-type which corresponds to the specified memory location.

Specified by:

getLength in interface Dynamic

Parameters:

buf - memory location

maxLength - maximum number of bytes to consume in computing length, or -1 for unspecified.

Returns:

data length or -1 if it could not be determined. Returned length may exceed maxLength if data-type does not supported constrained lengths.

isDynamicallySized

public boolean isDynamicallySized()

Description copied from interface: DataType

Indicates if this data-type is dynamically sized based upon DataOrganization.

Specified by:

isDynamicallySized in interface DataType

Overrides:

isDynamicallySized in class AbstractDataType

See Also:

DataType.isDynamicallySized()

canSpecifyLength

public boolean canSpecifyLength()

Description copied from interface: Dynamic

Returns true if a user-specified length can be used

Specified by:

canSpecifyLength in interface Dynamic

clone

public DataType clone(DataTypeManager dtm)

Description copied from interface: DataType

Returns 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.

Specified by:

clone in interface DataType

Parameters:

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

getDescription

public java.lang.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 java.lang.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

Returns:

the mnemonic for this DataType.

getRepresentation

public java.lang.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.

getValue

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

Description copied from interface: DataType

Get 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

Specified by:

getValue in interface DataType

Parameters:

buf - the data buffer.

settings - the settings to use.

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

Returns:

the data Object.

getValueClass

public java.lang.Class<?> getValueClass(Settings settings)

Description copied from interface: DataType

Get the Class of the value to be returned by this data type.

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

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

Overrides:

getDefaultLabelPrefix in class AbstractDataType

Returns:

the default label prefix or null if none specified.

getReplacementBaseType

public DataType getReplacementBaseType()

Description copied from interface: Dynamic

Returns a suitable replacement base data-type for pointers and arrays when exporting to C code

Specified by:

getReplacementBaseType in interface Dynamic

Returns:

suitable base data-type for this Dynamic data-type