Package ghidra.program.model.data

Interface CompositeInternal

All Superinterfaces:

Composite, DataType

All Known Subinterfaces:

StructureInternal, UnionInternal

All Known Implementing Classes:

CompositeDataTypeImpl, StructureDataType, UnionDataType

public interface CompositeInternal
extends Composite

Interface for common methods in Structure and Union

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CompositeInternal.ComponentComparator	ComponentComparator provides ability to compare two DataTypeComponent objects based upon their ordinal.
static class	CompositeInternal.OffsetComparator	OffsetComparator provides ability to compare an Integer offset with a DataTypeComponent object.
static class	CompositeInternal.OrdinalComparator	OrdinalComparator provides ability to compare an Integer ordinal with a DataTypeComponent object.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALIGN_NAME
static final int	DEFAULT_ALIGNMENT	The stored minimum alignment value which indicates the default alignment should be used based upon the packing and component alignment requirements.
static final int	DEFAULT_PACKING	The stored packing value which corresponds to a composite that will automatically pack based upon the alignment requirements of its components.
static final String	DEFAULT_PACKING_NAME
static final String	DISABLED_PACKING_NAME
static final int	MACHINE_ALIGNMENT	The stored minimum alignment value which indicates the machine alignment should be used as the minimum alignment (as defined by the current DataOrganization.getMachineAlignment()).
static final int	NO_PACKING	The stored packing value which corresponds to a composite whose packing has been disabled.
static final String	PACKING_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

Method Summary

Modifier and Type	Method	Description
static String	getAlignmentAndPackingString(Composite composite)
static String	getMinAlignmentString(Composite composite)
static String	getPackingString(Composite composite)
int	getStoredMinimumAlignment()	Get the minimum alignment setting for this Composite which contributes to the actual computed alignment value (see Composite.getAlignment().
int	getStoredPackingValue()	Gets the current packing value (typically a power of 2).
static String	toString(Composite composite)	Dump composite and its components for use in Object.toString() representation.

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

add, add, add, add, addBitField, align, dataTypeAlignmentChanged, delete, delete, getAlignment, getAlignmentType, getComponent, getComponents, getDefinedComponents, getExplicitMinimumAlignment, getExplicitPackingValue, getNumComponents, getNumDefinedComponents, getPackingType, hasDefaultPacking, hasExplicitMinimumAlignment, hasExplicitPackingValue, insert, insert, insert, isDefaultAligned, isMachineAligned, isPackingEnabled, isPartOf, pack, repack, setDescription, setExplicitMinimumAlignment, setExplicitPackingValue, setPackingEnabled, setToDefaultAligned, setToDefaultPacking, setToMachineAligned

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

addParent, clone, copy, dataTypeDeleted, dataTypeNameChanged, dataTypeReplaced, dataTypeSizeChanged, dependsOn, encodeRepresentation, encodeValue, getAlignedLength, getCategoryPath, getDataOrganization, getDataTypeManager, getDataTypePath, getDefaultAbbreviatedLabelPrefix, getDefaultLabelPrefix, getDefaultLabelPrefix, getDefaultOffcutLabelPrefix, getDefaultSettings, getDescription, getDisplayName, getDocs, getLastChangeTime, getLastChangeTimeInSourceArchive, getLength, getMnemonic, getName, getParents, getPathName, getRepresentation, getSettingsDefinitions, getSourceArchive, getTypeDefSettingsDefinitions, getUniversalID, getValue, getValueClass, hasLanguageDependantLength, isDeleted, isEncodable, isEquivalent, isNotYetDefined, isZeroLength, removeParent, replaceWith, setCategoryPath, setLastChangeTime, setLastChangeTimeInSourceArchive, setName, setNameAndCategory, setSourceArchive

Field Details

ALIGN_NAME

static final String ALIGN_NAME

See Also:

• Constant Field Values

PACKING_NAME

static final String PACKING_NAME

See Also:

• Constant Field Values

DISABLED_PACKING_NAME

static final String DISABLED_PACKING_NAME

See Also:

• Constant Field Values

DEFAULT_PACKING_NAME

static final String DEFAULT_PACKING_NAME

See Also:

• Constant Field Values

DEFAULT_PACKING

static final int DEFAULT_PACKING

The stored packing value which corresponds to a composite that will automatically pack based upon the alignment requirements of its components. A positive pack value will also pack in a similar fashion but will use the pack value as a maximum alignment for each component. See getStoredPackingValue().

See Also:

• Constant Field Values

NO_PACKING

static final int NO_PACKING

The stored packing value which corresponds to a composite whose packing has been disabled. In the case of structures this will permit explicit component placement by offset within the structure and undefined filler components will be used. This is the initial state of all newly instantiated structures. See getStoredPackingValue().

See Also:

• Constant Field Values

DEFAULT_ALIGNMENT

static final int DEFAULT_ALIGNMENT

The stored minimum alignment value which indicates the default alignment should be used based upon the packing and component alignment requirements. See getStoredMinimumAlignment().

See Also:

• Constant Field Values

MACHINE_ALIGNMENT

static final int MACHINE_ALIGNMENT

The stored minimum alignment value which indicates the machine alignment should be used as the minimum alignment (as defined by the current DataOrganization.getMachineAlignment()). See getStoredMinimumAlignment().

See Also:

• Constant Field Values

Method Details

getStoredPackingValue

int getStoredPackingValue()

Gets the current packing value (typically a power of 2). Other special values which may be returned include 0 and -1.

Returns:

the current positive packing value, 0 or -1.

getStoredMinimumAlignment

int getStoredMinimumAlignment()

Get the minimum alignment setting for this Composite which contributes to the actual computed alignment value (see Composite.getAlignment().

Returns:

the minimum alignment setting for this Composite or a reserved value to indicate either DEFAULT_ALIGNMENT or MACHINE_ALIGNMENT.

toString

static String toString(Composite composite)

Dump composite and its components for use in Object.toString() representation.

Parameters:

composite - composite instance to be dumped

Returns:

formatted dump as string

getAlignmentAndPackingString

static String getAlignmentAndPackingString(Composite composite)

getMinAlignmentString

static String getMinAlignmentString(Composite composite)

getPackingString

static String getPackingString(Composite composite)