Package ghidra.program.model.symbol

Class MemReferenceImpl

java.lang.Object

ghidra.program.model.symbol.MemReferenceImpl

All Implemented Interfaces:

Reference, Comparable<Reference>

public class MemReferenceImpl
extends Object
implements Reference

Implementation for a reference, not associated with a program.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isPrimary
protected int	opIndex
protected RefType	refType
protected SourceType	sourceType
protected long	symbolID

Fields inherited from interface ghidra.program.model.symbol.Reference

MNEMONIC, OTHER

Constructor Summary

Constructors

Constructor	Description
MemReferenceImpl(Address fromAddr, Address toAddr, RefType refType, SourceType sourceType, int opIndex, boolean isPrimary)	Constructs a MemReferenceImpl.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Reference ref)
boolean	equals(Object obj)
Address	getFromAddress()	Get the address of the codeunit that is making the reference.
int	getOperandIndex()	Get the operand index of where this reference was placed.
RefType	getReferenceType()	Get the type of reference being made.
SourceType	getSource()	Gets the source of this reference.
long	getSymbolID()	Get the symbol ID associated with this reference.
Address	getToAddress()	Get the "to" address for this reference.
boolean	isEntryPointReference()	Returns true if this reference is an instance of EntryReference.
boolean	isExternalReference()	Returns true if this reference is an instance of ExternalReference.
boolean	isMemoryReference()	Returns true if this reference to an address in the programs memory space.
boolean	isMnemonicReference()	Return true if this reference is on the Mnemonic and not on an operand
boolean	isOffsetReference()	Returns true if this reference is an instance of OffsetReference.
boolean	isOperandReference()	Return true if this reference is on an operand and not on the Mnemonic.
boolean	isPrimary()	Return whether this reference is marked as primary.
boolean	isRegisterReference()	Returns true if this reference to an address in the programs register space.
boolean	isShiftedReference()	Returns true if this reference is an instance of ShiftedReference.
boolean	isStackReference()	Returns true if this reference is an instance of StackReference and refers to a stack location.
void	setSource(SourceType source)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

refType

protected RefType refType

opIndex

protected int opIndex

sourceType

protected SourceType sourceType

symbolID

protected long symbolID

isPrimary

protected boolean isPrimary

Constructor Details

MemReferenceImpl

public MemReferenceImpl(Address fromAddr,
 Address toAddr,
 RefType refType,
 SourceType sourceType,
 int opIndex,
 boolean isPrimary)

Constructs a MemReferenceImpl.

Parameters:

fromAddr - reference from address

toAddr - reference to address

refType - the type of the reference

sourceType - reference source type SourceType

opIndex - the operand index of the from location

isPrimary - true if this reference should substitue the operand

Method Details

getFromAddress

public Address getFromAddress()

Description copied from interface: Reference

Get the address of the codeunit that is making the reference.

Specified by:

getFromAddress in interface Reference

See Also:

• Reference.getFromAddress()

getToAddress

public Address getToAddress()

Description copied from interface: Reference

Get the "to" address for this reference.

Specified by:

getToAddress in interface Reference

See Also:

• Reference.getToAddress()

isPrimary

public boolean isPrimary()

Description copied from interface: Reference

Return whether this reference is marked as primary.

Specified by:

isPrimary in interface Reference

See Also:

• Reference.isPrimary()

getSymbolID

public long getSymbolID()

Description copied from interface: Reference

Get the symbol ID associated with this reference. Applies to memory references only.

Specified by:

getSymbolID in interface Reference

Returns:

symbol ID or -1 if no symbol is associated with this reference

See Also:

• Reference.getSymbolID()

getReferenceType

public RefType getReferenceType()

Description copied from interface: Reference

Get the type of reference being made.

Specified by:

getReferenceType in interface Reference

See Also:

• Reference.getReferenceType()

getOperandIndex

public int getOperandIndex()

Description copied from interface: Reference

Get the operand index of where this reference was placed.

Specified by:

getOperandIndex in interface Reference

Returns:

op index or ReferenceManager.MNEMONIC

See Also:

• Reference.getOperandIndex()

isMnemonicReference

public boolean isMnemonicReference()

Description copied from interface: Reference

Return true if this reference is on the Mnemonic and not on an operand

Specified by:

isMnemonicReference in interface Reference

See Also:

• Reference.isMnemonicReference()

isOperandReference

public boolean isOperandReference()

Description copied from interface: Reference

Return true if this reference is on an operand and not on the Mnemonic.

Specified by:

isOperandReference in interface Reference

See Also:

• Reference.isOperandReference()

compareTo

public int compareTo(Reference ref)

Specified by:

compareTo in interface Comparable<Reference>

See Also:

• Comparable.compareTo(Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(Object)

isExternalReference

public boolean isExternalReference()

Description copied from interface: Reference

Returns true if this reference is an instance of ExternalReference.

Specified by:

isExternalReference in interface Reference

See Also:

• Reference.isExternalReference()

isOffsetReference

public boolean isOffsetReference()

Description copied from interface: Reference

Returns true if this reference is an instance of OffsetReference.

Specified by:

isOffsetReference in interface Reference

See Also:

• Reference.isOffsetReference()

isShiftedReference

public boolean isShiftedReference()

Description copied from interface: Reference

Returns true if this reference is an instance of ShiftedReference.

Specified by:

isShiftedReference in interface Reference

See Also:

• Reference.isShiftedReference()

isEntryPointReference

public boolean isEntryPointReference()

Description copied from interface: Reference

Returns true if this reference is an instance of EntryReference.

Specified by:

isEntryPointReference in interface Reference

See Also:

• Reference.isEntryPointReference()

isMemoryReference

public boolean isMemoryReference()

Description copied from interface: Reference

Returns true if this reference to an address in the programs memory space. This includes offset and shifted references.

Specified by:

isMemoryReference in interface Reference

See Also:

• Reference.isMemoryReference()

isRegisterReference

public boolean isRegisterReference()

Description copied from interface: Reference

Returns true if this reference to an address in the programs register space.

Specified by:

isRegisterReference in interface Reference

See Also:

• Reference.isRegisterReference()

isStackReference

public boolean isStackReference()

Description copied from interface: Reference

Returns true if this reference is an instance of StackReference and refers to a stack location.

Specified by:

isStackReference in interface Reference

See Also:

• Reference.isStackReference()

getSource

public SourceType getSource()

Description copied from interface: Reference

Gets the source of this reference. SourceTypes

Specified by:

getSource in interface Reference

Returns:

the source of this reference

setSource

public void setSource(SourceType source)