Package ghidra.app.cmd.refs

Class AddStackRefCmd

java.lang.Object

ghidra.app.cmd.refs.AddStackRefCmd

All Implemented Interfaces:

Command<Program>

public class AddStackRefCmd
extends Object
implements Command<Program>

Command class for adding stack references to a program.

Constructor Summary

Constructors

Constructor	Description
AddStackRefCmd(Address fromAddr, int opIndex, int stackOffset, RefType refType, SourceType source)	Constructs a new command for adding a stack reference.
AddStackRefCmd(Address fromAddr, int opIndex, int stackOffset, SourceType source)	Constructs a new command for adding a stack reference.

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(Program program)	Applies the command to the given domain object.
String	getName()	Returns the name of this command.
String	getStatusMsg()	Returns the status message indicating the status of the command.

Methods inherited from class java.lang.Object

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

Constructor Details

AddStackRefCmd

public AddStackRefCmd(Address fromAddr,
 int opIndex,
 int stackOffset,
 SourceType source)

Constructs a new command for adding a stack reference.

Parameters:

fromAddr - "from" address within a function

opIndex - operand index

stackOffset - stack offset of the reference

source - the source of this reference

AddStackRefCmd

public AddStackRefCmd(Address fromAddr,
 int opIndex,
 int stackOffset,
 RefType refType,
 SourceType source)

Constructs a new command for adding a stack reference.

Parameters:

fromAddr - "from" address within a function

opIndex - operand index

stackOffset - stack offset of the reference

refType - reference type (e.g., STACK_READ or STACK_WRITE)

source - the source of this reference

Method Details

applyTo

public boolean applyTo(Program program)

Description copied from interface: Command

Applies the command to the given domain object.

Specified by:

applyTo in interface Command<Program>

Parameters:

program - domain object that this command is to be applied.

Returns:

true if the command applied successfully

getStatusMsg

public String getStatusMsg()

Description copied from interface: Command

Returns the status message indicating the status of the command.

Specified by:

getStatusMsg in interface Command<Program>

Returns:

reason for failure, or null if the status of the command was successful

getName

public String getName()

Description copied from interface: Command

Returns the name of this command.

Specified by:

getName in interface Command<Program>

Returns:

the name of this command