Package ghidra.app.cmd.function

Class AddStackVarCmd

java.lang.Object

ghidra.app.cmd.function.AddStackVarCmd

All Implemented Interfaces:

Command<Program>

public class AddStackVarCmd
extends Object
implements Command<Program>

Command to add a stack variable to a function.

Constructor Summary

Constructors

Constructor	Description
AddStackVarCmd(Address addr, int stackOffset, String name, DataType dataType, SourceType source)	Constructs a new command to add a stack variable to a function.

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

AddStackVarCmd

public AddStackVarCmd(Address addr,
 int stackOffset,
 String name,
 DataType dataType,
 SourceType source)

Constructs a new command to add a stack variable to a function.

Parameters:

addr - initial declaration point of variable.

stackOffset - offset into the stack for the new variable.

name - name of the new variable.

dataType - variable data-type or null for a default data type of minimal size

source - the source of this stack variable

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

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

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