Package ghidra.program.model.data
Class AbstractStringDataType
- java.lang.Object
-
- ghidra.program.model.data.AbstractDataType
-
- ghidra.program.model.data.DataTypeImpl
-
- ghidra.program.model.data.BuiltIn
-
- ghidra.program.model.data.AbstractStringDataType
-
- All Implemented Interfaces:
BuiltInDataType,DataType,DataTypeWithCharset,Dynamic,ExtensionPoint,java.util.EventListener,javax.swing.event.ChangeListener
- Direct Known Subclasses:
PascalString255DataType,PascalStringDataType,PascalUnicodeDataType,StringDataType,StringUTF8DataType,TerminatedStringDataType,TerminatedUnicode32DataType,TerminatedUnicodeDataType,Unicode32DataType,UnicodeDataType
public abstract class AbstractStringDataType extends BuiltIn implements Dynamic, DataTypeWithCharset
Common base class for all Ghidra stringDataTypes.See
StringDataTypefor information about string variations and configuration details.Sub-classes generally only need to implement a constructor that calls the mega-constructor
StringDataTypeBase.StringDataTypeBase(lots,of,params)and theDataType.clone(DataTypeManager)method.
-
-
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 SettingsDefinition[]COMMON_STRING_SETTINGS_DEFSstatic SettingsDefinition[]COMMON_WITH_CHARSET_STRING_SETTINGS_DEFSstatic java.lang.StringDEFAULT_ABBREV_PREFIXstatic java.lang.StringDEFAULT_LABELstatic java.lang.StringDEFAULT_LABEL_PREFIXstatic java.lang.StringDEFAULT_UNICODE_ABBREV_PREFIXstatic java.lang.StringDEFAULT_UNICODE_LABELstatic java.lang.StringDEFAULT_UNICODE_LABEL_PREFIXstatic java.lang.StringUSE_CHARSET_DEF_DEFAULTA symbolic name to signal that the null value being passed for the charset name param indicates that the default charset (ie.-
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 Modifier Constructor Description protectedAbstractStringDataType(java.lang.String name, java.lang.String mnemonic, java.lang.String defaultLabel, java.lang.String defaultLabelPrefix, java.lang.String defaultAbbrevLabelPrefix, java.lang.String description, java.lang.String charsetName, DataType replacementDataType, StringLayoutEnum stringLayout, DataTypeManager dtm)Protected constructor used by derived types to provide all their datatype details.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancanSpecifyLength()Returns true if a user-specified length can be usedprotected SettingsDefinition[]getBuiltInSettingsDefinitions()Gets a list of all the settingsDefinitions used by this datatype.java.lang.StringgetCharsetName(Settings settings)Get the character set for a specific data type and settingsjava.lang.StringgetDefaultAbbreviatedLabelPrefix()Returns the prefix to use for this datatype when an abbreviated prefix is desired.java.lang.StringgetDefaultLabelPrefix()Returns the appropriate string to use as the default label prefix in the absence of any data.java.lang.StringgetDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)Returns the appropriate string to use as the default label prefix.java.lang.StringgetDefaultOffcutLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutLength)Returns the appropriate string to use as the default label prefix, taking into account the fact that there exists a reference to the data that references offcutLength bytes into this typejava.lang.StringgetDescription()Get a String briefly describing this DataType.intgetLength()Get the length (number of 8-bit bytes) of this DataType.intgetLength(MemBuffer buf, int maxLength)Compute the length for this data-type which corresponds to the specified memory location.java.lang.StringgetMnemonic(Settings settings)Get the mnemonic for this DataType.DataTypegetReplacementBaseType()Returns a suitable replacement base data-type for pointers and arrays when exporting to C codejava.lang.StringgetRepresentation(MemBuffer buf, Settings settings, int length)Get bytes from memory in a printable format for this type.StringDataInstancegetStringDataInstance(MemBuffer buf, Settings settings, int length)Creates a newStringDataInstanceusing the bytes in the supplied MemBuffer and options provided by this DataType.StringLayoutEnumgetStringLayout()java.lang.ObjectgetValue(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.booleanisDynamicallySized()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, 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, 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, clone, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, getAlignment, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, 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
-
COMMON_STRING_SETTINGS_DEFS
public static final SettingsDefinition[] COMMON_STRING_SETTINGS_DEFS
-
COMMON_WITH_CHARSET_STRING_SETTINGS_DEFS
public static final SettingsDefinition[] COMMON_WITH_CHARSET_STRING_SETTINGS_DEFS
-
DEFAULT_UNICODE_LABEL
public static final java.lang.String DEFAULT_UNICODE_LABEL
- See Also:
- Constant Field Values
-
DEFAULT_UNICODE_LABEL_PREFIX
public static final java.lang.String DEFAULT_UNICODE_LABEL_PREFIX
- See Also:
- Constant Field Values
-
DEFAULT_UNICODE_ABBREV_PREFIX
public static final java.lang.String DEFAULT_UNICODE_ABBREV_PREFIX
- See Also:
- Constant Field Values
-
DEFAULT_LABEL
public static final java.lang.String DEFAULT_LABEL
- See Also:
- Constant Field Values
-
DEFAULT_LABEL_PREFIX
public static final java.lang.String DEFAULT_LABEL_PREFIX
- See Also:
- Constant Field Values
-
DEFAULT_ABBREV_PREFIX
public static final java.lang.String DEFAULT_ABBREV_PREFIX
- See Also:
- Constant Field Values
-
USE_CHARSET_DEF_DEFAULT
public static final java.lang.String USE_CHARSET_DEF_DEFAULT
A symbolic name to signal that the null value being passed for the charset name param indicates that the default charset (ie. ASCII) should be used.
-
-
Constructor Detail
-
AbstractStringDataType
protected AbstractStringDataType(java.lang.String name, java.lang.String mnemonic, java.lang.String defaultLabel, java.lang.String defaultLabelPrefix, java.lang.String defaultAbbrevLabelPrefix, java.lang.String description, java.lang.String charsetName, DataType replacementDataType, StringLayoutEnum stringLayout, DataTypeManager dtm)Protected constructor used by derived types to provide all their datatype details.- Parameters:
name- Name of this datatypemnemonic- Mnemonic of this datatypedefaultLabel- Label string for this datatype. SeedefaultLabel.defaultLabelPrefix- Label prefix string for this datatype. SeedefaultLabelPrefix.defaultAbbrevLabelPrefix- Abbreviated label prefix for this datatype. SeedefaultAbbrevLabelPrefix.description- Description of this datatype.charsetName- Charset name for this string datatype. If null the settings of the data instance will be queried for acharset.replacementDataType- ReplacementDataType.stringLayout-stringLayoutcontrols how the string is laid out in memory.dtm-DataTypeManagerfor this datatype, null ok.
-
-
Method Detail
-
getMnemonic
public java.lang.String getMnemonic(Settings settings)
Description copied from interface:DataTypeGet the mnemonic for this DataType.- Specified by:
getMnemonicin interfaceDataType- Overrides:
getMnemonicin classAbstractDataType- Returns:
- the mnemonic for this DataType.
-
getDefaultLabelPrefix
public java.lang.String getDefaultLabelPrefix()
Description copied from interface:DataTypeReturns the appropriate string to use as the default label prefix in the absence of any data.- Specified by:
getDefaultLabelPrefixin interfaceDataType- Overrides:
getDefaultLabelPrefixin classAbstractDataType- Returns:
- the default label prefix or null if none specified.
-
getDefaultAbbreviatedLabelPrefix
public java.lang.String getDefaultAbbreviatedLabelPrefix()
Description copied from interface:DataTypeReturns the prefix to use for this datatype when an abbreviated prefix is desired. For example, some data types will built a large default label, at which is is more desirable to have a shortened prefix.- Specified by:
getDefaultAbbreviatedLabelPrefixin interfaceDataType- Overrides:
getDefaultAbbreviatedLabelPrefixin classAbstractDataType- Returns:
- the prefix to use for this datatype when an abbreviated prefix is desired. May return null.
-
getDescription
public java.lang.String getDescription()
Description copied from interface:DataTypeGet a String briefly describing this DataType.- Specified by:
getDescriptionin interfaceDataType- Returns:
- a one-liner describing this DataType.
-
getBuiltInSettingsDefinitions
protected SettingsDefinition[] getBuiltInSettingsDefinitions()
Description copied from class:BuiltInGets a list of all the settingsDefinitions used by this datatype.- Overrides:
getBuiltInSettingsDefinitionsin classBuiltIn- Returns:
- a list of the settingsDefinitions used by this datatype.
-
getStringDataInstance
public StringDataInstance getStringDataInstance(MemBuffer buf, Settings settings, int length)
Creates a newStringDataInstanceusing the bytes in the supplied MemBuffer and options provided by this DataType.- Parameters:
buf- the data.settings- the settings to use for the representation.length- the number of bytes to represent.- Returns:
- a new
StringDataInstance, never null.
-
getStringLayout
public StringLayoutEnum getStringLayout()
- Returns:
StringLayoutEnumsettinEnum stringLayoutype.
-
getCharsetName
public java.lang.String getCharsetName(Settings settings)
Description copied from interface:DataTypeWithCharsetGet the character set for a specific data type and settings- Specified by:
getCharsetNamein interfaceDataTypeWithCharset- Parameters:
settings- data instance settings- Returns:
- Charset for this datatype and settings
-
isDynamicallySized
public boolean isDynamicallySized()
Description copied from interface:DataTypeIndicates if this data-type is dynamically sized based upon DataOrganization.- Specified by:
isDynamicallySizedin interfaceDataType- Overrides:
isDynamicallySizedin classAbstractDataType
-
getLength
public int getLength()
Description copied from interface:DataTypeGet the length (number of 8-bit bytes) of this DataType.
-
canSpecifyLength
public boolean canSpecifyLength()
Description copied from interface:DynamicReturns true if a user-specified length can be used- Specified by:
canSpecifyLengthin interfaceDynamic
-
getLength
public int getLength(MemBuffer buf, int maxLength)
Description copied from interface:DynamicCompute the length for this data-type which corresponds to the specified memory location.- Specified by:
getLengthin interfaceDynamic- Parameters:
buf- memory locationmaxLength- 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.
-
getValueClass
public java.lang.Class<?> getValueClass(Settings settings)
Description copied from interface:DataTypeGet the Class of the value to be returned by this data type.- Specified by:
getValueClassin interfaceDataType- Overrides:
getValueClassin classDataTypeImpl- 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.
-
getValue
public java.lang.Object getValue(MemBuffer buf, Settings settings, int length)
Description copied from interface:DataTypeGet 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
-
getRepresentation
public java.lang.String getRepresentation(MemBuffer buf, Settings settings, int length)
Description copied from interface:DataTypeGet bytes from memory in a printable format for this type.- Specified by:
getRepresentationin 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.
-
getDefaultLabelPrefix
public java.lang.String getDefaultLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options)
Description copied from interface:DataTypeReturns the appropriate string to use as the default label prefix.- Specified by:
getDefaultLabelPrefixin interfaceDataType- Overrides:
getDefaultLabelPrefixin classAbstractDataType- Parameters:
buf- memory buffer containing the bytes.settings- the Settings objectoptions- options for how to format the default label prefix.- Returns:
- the default label prefix or null if none specified.
-
getDefaultOffcutLabelPrefix
public java.lang.String getDefaultOffcutLabelPrefix(MemBuffer buf, Settings settings, int len, DataTypeDisplayOptions options, int offcutLength)
Description copied from interface:DataTypeReturns the appropriate string to use as the default label prefix, taking into account the fact that there exists a reference to the data that references offcutLength bytes into this type- Specified by:
getDefaultOffcutLabelPrefixin interfaceDataType- Overrides:
getDefaultOffcutLabelPrefixin classAbstractDataType- Parameters:
buf- memory buffer containing the bytes.settings- the Settings objectoptions- options for how to format the default label prefix.- Returns:
- the default label prefix.
-
getReplacementBaseType
public DataType getReplacementBaseType()
Description copied from interface:DynamicReturns a suitable replacement base data-type for pointers and arrays when exporting to C code- Specified by:
getReplacementBaseTypein interfaceDynamic- Returns:
- suitable base data-type for this Dynamic data-type
-
-