Package ghidra.app.cmd.function

Class ApplyFunctionSignatureCmd

java.lang.Object

ghidra.framework.cmd.BackgroundCommand

ghidra.app.cmd.function.ApplyFunctionSignatureCmd

All Implemented Interfaces:

Command

public class ApplyFunctionSignatureCmd
extends BackgroundCommand

Command to create apply a function signature at an address.

Constructor Summary

Constructors

Constructor	Description
ApplyFunctionSignatureCmd(Address entry, FunctionSignature signature, SourceType source)	Constructs a new command for creating a function.
ApplyFunctionSignatureCmd(Address entry, FunctionSignature signature, SourceType source, boolean preserveCallingConvention, boolean setName)	Constructs a new command for creating a function.

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(DomainObject obj, TaskMonitor monitor)	Method called when this command is to apply changes to the given domain object.

Methods inherited from class ghidra.framework.cmd.BackgroundCommand

applyTo, canCancel, dispose, getName, getStatusMsg, hasProgress, isModal, setStatusMsg, taskCompleted, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplyFunctionSignatureCmd

public ApplyFunctionSignatureCmd(Address entry,
                                 FunctionSignature signature,
                                 SourceType source)

Constructs a new command for creating a function.

Parameters:

entry - entry point address for the function to be created.

signature - function signature to apply

source - the source of this function signature

ApplyFunctionSignatureCmd

public ApplyFunctionSignatureCmd(Address entry,
                                 FunctionSignature signature,
                                 SourceType source,
                                 boolean preserveCallingConvention,
                                 boolean setName)

Constructs a new command for creating a function.

Parameters:

entry - entry point address for the function to be created.

signature - function signature to apply

source - the source of this function signature

preserveCallingConvention - if true the function calling convention will not be changed

setName - true if name of the function should be set to the name of the signature

Method Detail

applyTo

public boolean applyTo(DomainObject obj,
                       TaskMonitor monitor)

Description copied from class: BackgroundCommand

Method called when this command is to apply changes to the given domain object. A monitor is provided to display status information about the command as it executes in the background.

Specified by:

applyTo in class BackgroundCommand

Parameters:

obj - domain object that will be affected by the command

monitor - monitor to show progress of the command

Returns:

true if the command applied successfully