Package ghidra.app.cmd.refs

Class AddStackRefCmd

java.lang.Object

ghidra.app.cmd.refs.AddStackRefCmd

All Implemented Interfaces:

Command

public class AddStackRefCmd
extends java.lang.Object
implements Command

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(DomainObject obj)	Applies the command to the given domain object.
java.lang.String	getName()	Returns the name of this command.
java.lang.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 Detail

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 Detail

applyTo

public boolean applyTo(DomainObject obj)

Description copied from interface: Command

Applies the command to the given domain object.

Specified by:

applyTo in interface Command

Parameters:

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

Returns:

true if the command applied successfully

See Also:

Command.applyTo(ghidra.framework.model.DomainObject)

getStatusMsg

public java.lang.String getStatusMsg()

Description copied from interface: Command

Returns the status message indicating the status of the command.

Specified by:

getStatusMsg in interface Command

Returns:

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

See Also:

Command.getStatusMsg()

getName

public java.lang.String getName()

Description copied from interface: Command

Returns the name of this command.

Specified by:

getName in interface Command

Returns:

the name of this command

See Also:

Command.getName()