Class WideCharDataType
- java.lang.Object
-
- ghidra.program.model.data.AbstractDataType
-
- ghidra.program.model.data.DataTypeImpl
-
- ghidra.program.model.data.BuiltIn
-
- ghidra.program.model.data.WideCharDataType
-
- All Implemented Interfaces:
ArrayStringable
,BuiltInDataType
,DataType
,DataTypeWithCharset
,ExtensionPoint
public class WideCharDataType extends BuiltIn implements ArrayStringable, DataTypeWithCharset
-
-
Field Summary
Fields Modifier and Type Field Description static WideCharDataType
dataType
A statically defined WideCharDataType instance.-
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 WideCharDataType()
WideCharDataType(DataTypeManager dtm)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataType
clone(DataTypeManager dtm)
Returns an instance of this DataType with its universalID and SourceArchive identity retained.byte[]
encodeRepresentation(java.lang.String repr, MemBuffer buf, Settings settings, int length)
Encode bytes according to the display format for this type.byte[]
encodeValue(java.lang.Object value, MemBuffer buf, Settings settings, int length)
Encode bytes from an Object appropriate for this DataType.java.lang.String
getArrayDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)
For cases where an array of this type exists, get the appropriate string to use as the default label prefix for the array.java.lang.String
getArrayDefaultOffcutLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutOffset)
For cases where an array of this type exists, get the appropriate string to use as the default label prefix, taking into account the fact that there exists a reference to the data that referencesoffcutLength
bytes into this typeprotected SettingsDefinition[]
getBuiltInSettingsDefinitions()
Gets a list of all the settingsDefinitions used by this datatype.java.lang.String
getCharsetName(Settings settings)
Get the character set for a specific data type and settingsjava.lang.String
getCTypeDeclaration(DataOrganization dataOrganization)
Returns null for FactoryDataType (which should never be used) and Dynamic types which should generally be replaced by a primitive array (e.g., char[5]) or, a primitive pointer (e.g., char *).java.lang.String
getDefaultLabelPrefix()
Returns the appropriate string to use as the default label prefix in the absence of any data.java.lang.String
getDefaultLabelPrefix(MemBuffer buf, Settings settings, int length, DataTypeDisplayOptions options)
Returns the appropriate string to use as the default label prefix.java.lang.String
getDescription()
Get a String briefly describing this DataType.int
getLength()
Get the length (number of 8-bit bytes) of this DataType.java.lang.String
getMnemonic(Settings settings)
Get the mnemonic for this DataType.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 datatype.boolean
hasLanguageDependantLength()
Indicates if the length of this data-type is determined based upon theDataOrganization
obtained from the associatedDataTypeManager
.boolean
hasStringValue(Settings settings)
For cases where an array of this type exists, determines if a String value will be returned.boolean
isEncodable()
Check if this type supports encoding (patching)-
Methods inherited from class ghidra.program.model.data.BuiltIn
addParent, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, 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, notifyAlignmentChanged, notifyDeleted, notifyNameChanged, notifyParents, notifyReplaced, notifySizeChanged, replaceWith, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setSourceArchive
-
Methods inherited from class ghidra.program.model.data.AbstractDataType
dataTypeAlignmentChanged, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultOffcutLabelPrefix, getDisplayName, getDocs, getName, isDeleted, 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.ArrayStringable
getArrayString
-
Methods inherited from interface ghidra.program.model.data.DataType
addParent, copy, dataTypeAlignmentChanged, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getName, getParents, getPathName, getSettingsDefinitions, getSourceArchive, getUniversalID, isDeleted, isEquivalent, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setDefaultSettings, setDescription, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive
-
Methods inherited from interface ghidra.program.model.data.DataTypeWithCharset
encodeCharacterRepresentation, encodeCharacterValue
-
-
-
-
Field Detail
-
dataType
public static final WideCharDataType dataType
A statically defined WideCharDataType instance.
-
-
Constructor Detail
-
WideCharDataType
public WideCharDataType()
-
WideCharDataType
public WideCharDataType(DataTypeManager dtm)
-
-
Method Detail
-
getLength
public int getLength()
Description copied from interface:DataType
Get the length (number of 8-bit bytes) of this DataType.NOTE: No datatype should ever return 0, even if
DataType.isZeroLength()
, and onlyDynamic
datatypes should return -1. IfDataType.isZeroLength()
is true a length of 1 should be returned. Where a zero-length datatype can be handled (e.g.,Composite
) theDataType.isZeroLength()
method should be used.
-
hasLanguageDependantLength
public boolean hasLanguageDependantLength()
Description copied from interface:DataType
Indicates if the length of this data-type is determined based upon theDataOrganization
obtained from the associatedDataTypeManager
.- Specified by:
hasLanguageDependantLength
in interfaceDataType
- Overrides:
hasLanguageDependantLength
in classAbstractDataType
- Returns:
- true length is language/compiler-specification dependent, else false
-
getDescription
public java.lang.String getDescription()
Description copied from interface:DataType
Get a String briefly describing this DataType.- Specified by:
getDescription
in interfaceDataType
- Returns:
- a one-liner describing this DataType.
-
getBuiltInSettingsDefinitions
protected SettingsDefinition[] getBuiltInSettingsDefinitions()
Description copied from class:BuiltIn
Gets a list of all the settingsDefinitions used by this datatype.- Overrides:
getBuiltInSettingsDefinitions
in classBuiltIn
- Returns:
- a list of the settingsDefinitions used by this datatype.
-
clone
public DataType clone(DataTypeManager dtm)
Description copied from interface:DataType
Returns an instance of this DataType with its universalID and SourceArchive identity retained.The current instanceof 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.
-
getMnemonic
public java.lang.String getMnemonic(Settings settings)
Description copied from interface:DataType
Get the mnemonic for this DataType.- Specified by:
getMnemonic
in interfaceDataType
- Overrides:
getMnemonic
in classAbstractDataType
- Parameters:
settings
- settings which may influence the result or null- 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 interfaceDataType
- 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 datatype is an AddressDT, return an Address object. a Byte, return a Scalar* (maybe this should be a Byte) a Float, return a Float
-
isEncodable
public boolean isEncodable()
Description copied from interface:DataType
Check if this type supports encoding (patching)If unsupported,
DataType.encodeValue(Object, MemBuffer, Settings, int)
andDataType.encodeRepresentation(String, MemBuffer, Settings, int)
will always throw an exception. Actions which rely on eitherencode
method should not be displayed if the applicable datatype is not encodable.- Specified by:
isEncodable
in interfaceDataType
- Overrides:
isEncodable
in classAbstractDataType
- Returns:
- true if encoding is supported
-
encodeValue
public byte[] encodeValue(java.lang.Object value, MemBuffer buf, Settings settings, int length) throws DataTypeEncodeException
Description copied from interface:DataType
Encode bytes from an Object appropriate for this DataType.Converts the given object to the byte encoding and returns it. When appropriate, this should seek the nearest encoding to the specified value, since the object may come from a user script. For example, a floating-point value may be rounded. Invalid values should be rejected with a
DataTypeEncodeException
.- Specified by:
encodeValue
in interfaceDataType
- Overrides:
encodeValue
in classAbstractDataType
- Parameters:
value
- the desired value.buf
- a buffer representing the eventual destination of the bytes.settings
- the settings to use.length
- the expected length of the result, usually the length of the data unit, or -1 to let the type choose the length. It may be ignored, e.g., for fixed-length types.- Returns:
- the encoded value.
- Throws:
DataTypeEncodeException
- if the value cannot be encoded for any reason, e.g., incorrect type, not enough space, buffer overflow, unsupported (seeDataType.isEncodable()
).
-
encodeRepresentation
public byte[] encodeRepresentation(java.lang.String repr, MemBuffer buf, Settings settings, int length) throws DataTypeEncodeException
Description copied from interface:DataType
Encode bytes according to the display format for this type.Converts the given representation to the byte encoding and returns it. When appropriate, this should seek the nearest encoding to the specified value, since the representation is likely coming from user input. For example, a floating-point value may be rounded. Invalid representations should be rejected with a
DataTypeEncodeException
.- Specified by:
encodeRepresentation
in interfaceDataType
- Overrides:
encodeRepresentation
in classAbstractDataType
- Parameters:
repr
- the representation of the desired value, as inDataType.getRepresentation(MemBuffer, Settings, int)
. The supported formats depend on the specific datatype and its settings.buf
- a buffer representing the eventual destination of the bytes.settings
- the settings to use for the representation.length
- the expected length of the result, usually the length of the data unit, or -1 to let the type choose the length. It may be ignored, e.g., for fixed-length types.- Returns:
- the encoded value.
- Throws:
DataTypeEncodeException
- if the value cannot be encoded for any reason, e.g., incorrect format, not enough space, buffer overflow, unsupported (seeDataType.isEncodable()
).
-
getValueClass
public java.lang.Class<?> getValueClass(Settings settings)
Description copied from interface:DataType
Get the Class of the value to be returned by this datatype.- Specified by:
getValueClass
in interfaceDataType
- Overrides:
getValueClass
in classDataTypeImpl
- 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.
-
getDefaultLabelPrefix
public java.lang.String getDefaultLabelPrefix(MemBuffer buf, Settings settings, int length, DataTypeDisplayOptions options)
Description copied from interface:DataType
Returns the appropriate string to use as the default label prefix.- Specified by:
getDefaultLabelPrefix
in interfaceDataType
- Overrides:
getDefaultLabelPrefix
in classAbstractDataType
- Parameters:
buf
- memory buffer containing the bytes.settings
- the Settings objectlength
- the length of the data.options
- options for how to format the default label prefix.- Returns:
- the default label prefix or null if none specified.
-
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 interfaceDataType
- Overrides:
getDefaultLabelPrefix
in classAbstractDataType
- Returns:
- the default label prefix or null if none specified.
-
getCTypeDeclaration
public java.lang.String getCTypeDeclaration(DataOrganization dataOrganization)
Description copied from class:BuiltIn
Returns null for FactoryDataType (which should never be used) and Dynamic types which should generally be replaced by a primitive array (e.g., char[5]) or, a primitive pointer (e.g., char *). For other types an appropriately sized unsigned integer typedef is returned.- Specified by:
getCTypeDeclaration
in interfaceBuiltInDataType
- Overrides:
getCTypeDeclaration
in classBuiltIn
- Parameters:
dataOrganization
- or null for default- Returns:
- definition C-statement (e.g., #define or typedef) or null if type name is a standard C-primitive name or if type is FactoryDataType or Dynamic.
- See Also:
BuiltInDataType.getCTypeDeclaration(ghidra.program.model.data.DataOrganization)
-
hasStringValue
public boolean hasStringValue(Settings settings)
Description copied from interface:ArrayStringable
For cases where an array of this type exists, determines if a String value will be returned.- Specified by:
hasStringValue
in interfaceArrayStringable
- Returns:
- true if array of this type with the specified settings will return a String value.
-
getArrayDefaultLabelPrefix
public java.lang.String getArrayDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)
Description copied from interface:ArrayStringable
For cases where an array of this type exists, get the appropriate string to use as the default label prefix for the array.- Specified by:
getArrayDefaultLabelPrefix
in interfaceArrayStringable
- Parameters:
buf
- memory buffer containing the bytes.settings
- the Settings objectlen
- the length of the data.options
- options for how to format the default label prefix.- Returns:
- the default label prefix or null if none specified.
-
getArrayDefaultOffcutLabelPrefix
public java.lang.String getArrayDefaultOffcutLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutOffset)
Description copied from interface:ArrayStringable
For cases where an array of this type exists, get the appropriate string to use as the default label prefix, taking into account the fact that there exists a reference to the data that referencesoffcutLength
bytes into this type- Specified by:
getArrayDefaultOffcutLabelPrefix
in interfaceArrayStringable
- Parameters:
buf
- memory buffer containing the bytes.settings
- the Settings object.len
- the length of the data.options
- options for how to format the default label prefix.offcutOffset
- the length of the offcut label prefix.- Returns:
- the default label prefix or null if none specified.
-
getCharsetName
public java.lang.String getCharsetName(Settings settings)
Description copied from interface:DataTypeWithCharset
Get the character set for a specific data type and settings- Specified by:
getCharsetName
in interfaceDataTypeWithCharset
- Parameters:
settings
- data instance settings- Returns:
- Charset for this datatype and settings
-
-