Package ghidra.program.util

Class VariableLocFieldLocation

java.lang.Object

ghidra.program.util.ProgramLocation

ghidra.program.util.FunctionLocation

ghidra.program.util.VariableLocation

ghidra.program.util.VariableLocFieldLocation

All Implemented Interfaces:

java.lang.Comparable<ProgramLocation>

public class VariableLocFieldLocation
extends VariableLocation

The VariableLocFieldLocation class provides specific information about the stack variable offset field within a program location.

Field Summary

Fields inherited from class ghidra.program.util.FunctionLocation

functionAddr

Fields inherited from class ghidra.program.util.ProgramLocation

addr, program, refAddr

Constructor Summary

Constructors

Constructor	Description
VariableLocFieldLocation()	Should only be used by XML restoration.
VariableLocFieldLocation(Program program, Address locationAddr, Variable var, int charOffset)	Construct a new VariableLocFieldLocation object.
VariableLocFieldLocation(Program program, Variable var, int charOffset)	Construct a new VariableLocFieldLocation object.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getLoc()	Gets the location string.
int	hashCode()
void	restoreState(Program program1, SaveState obj)	Restore this function location using the given program and save state object.
void	saveState(SaveState obj)	Save this function location to the given save state object.

Methods inherited from class ghidra.program.util.VariableLocation

compareTo, getVariable, isLocationFor, isParameter, isReturn, isValid, toString

Methods inherited from class ghidra.program.util.FunctionLocation

getFunctionAddress

Methods inherited from class ghidra.program.util.ProgramLocation

compareAddr, getAddress, getByteAddress, getCharOffset, getColumn, getComponentPath, getLocation, getProgram, getRefAddress, getRow

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VariableLocFieldLocation

public VariableLocFieldLocation(Program program,
                                Address locationAddr,
                                Variable var,
                                int charOffset)

Construct a new VariableLocFieldLocation object.

Parameters:

program - the program of the location

locationAddr - the address of the listing location (i.e., referent code unit)

var - the variable which has its location (stack offset) in the field.

charOffset - the position within the variable location (stack offset) string for this location.

VariableLocFieldLocation

public VariableLocFieldLocation(Program program,
                                Variable var,
                                int charOffset)

Construct a new VariableLocFieldLocation object. Variable function entry point is the assumed listing location (i.e., referent code unit). Care should be taken if variable corresponds to an EXTERNAL function.

Parameters:

program - the program of the location

var - the variable which has its location (stack offset) in the field.

charOffset - the position within the variable location (stack offset) string for this location.

VariableLocFieldLocation

public VariableLocFieldLocation()

Should only be used by XML restoration.

Method Detail

getLoc

public java.lang.String getLoc()

Gets the location string. (For stack variables this is the offset as a string.)

hashCode

public int hashCode()

Overrides:

hashCode in class ProgramLocation

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class VariableLocation

See Also:

Object.equals(java.lang.Object)

restoreState

public void restoreState(Program program1,
                         SaveState obj)

Description copied from class: FunctionLocation

Restore this function location using the given program and save state object.

Overrides:

restoreState in class VariableLocation

Parameters:

program1 - the program containing the function location

obj - the save state object for saving the location

saveState

public void saveState(SaveState obj)

Description copied from class: FunctionLocation

Save this function location to the given save state object.

Overrides:

saveState in class VariableLocation

Parameters:

obj - the save state object for saving the location