Package ghidra.app.cmd.function

Class AddRegisterVarCmd

java.lang.Object

ghidra.app.cmd.function.AddRegisterVarCmd

All Implemented Interfaces:

Command<Program>

public class AddRegisterVarCmd
extends Object
implements Command<Program>

Command to add a register variable to a function.

Constructor Summary

Constructors

Constructor	Description
AddRegisterVarCmd(Address addr, Register reg, String name, DataType dataType, SourceType source)	Constructs a new command to add a register variable to a function.
AddRegisterVarCmd(Address addr, Register reg, String name, SourceType source)	Constructs a new command to add a register 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

AddRegisterVarCmd

public AddRegisterVarCmd(Address addr,
 Register reg,
 String name,
 SourceType source)

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

Parameters:

addr - initial declaration point of variable.

reg - register for the new variable.

name - name of the new variable.

source - the source of this register variable

AddRegisterVarCmd

public AddRegisterVarCmd(Address addr,
 Register reg,
 String name,
 DataType dataType,
 SourceType source)

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

Parameters:

addr - initial declaration point of variable.

reg - register for the new variable.

name - name of the new variable.

dataType - data type to set on the new variable

source - the source of this register 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

See Also:

• Command.getName()

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

See Also:

• Command.getStatusMsg()