Package ghidra.app.cmd.function

Class FunctionStackAnalysisCmd

java.lang.Object

ghidra.framework.cmd.BackgroundCommand

ghidra.app.cmd.function.FunctionStackAnalysisCmd

All Implemented Interfaces:

Command

public class FunctionStackAnalysisCmd
extends BackgroundCommand

Command for analyzing the Stack; the command is run in the background. NOTE: referenced thunk-functions should be created prior to this command

Constructor Summary

Constructors

Constructor	Description
FunctionStackAnalysisCmd(Address entry, boolean forceProcessing)	Constructs a new command for analyzing the Stack.
FunctionStackAnalysisCmd(AddressSetView entries, boolean forceProcessing)	Constructs a new command for analyzing the Stack.
FunctionStackAnalysisCmd(AddressSetView entries, boolean doParameterAnalysis, boolean doLocalAnalysis, boolean forceProcessing)

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

FunctionStackAnalysisCmd

public FunctionStackAnalysisCmd(AddressSetView entries,
                                boolean forceProcessing)

Constructs a new command for analyzing the Stack.

Parameters:

entries - and address set indicating the entry points of functions that have stacks to be analyzed.

forceProcessing - flag to force processing of stack references even if the stack has already been defined.

FunctionStackAnalysisCmd

public FunctionStackAnalysisCmd(Address entry,
                                boolean forceProcessing)

Constructs a new command for analyzing the Stack.

Parameters:

entry - the entry point of the function that contains the stack to be analyzed.

forceProcessing - flag to force processing of stack references even if the stack has already been defined.

FunctionStackAnalysisCmd

public FunctionStackAnalysisCmd(AddressSetView entries,
                                boolean doParameterAnalysis,
                                boolean doLocalAnalysis,
                                boolean forceProcessing)

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

See Also:

BackgroundCommand.applyTo(ghidra.framework.model.DomainObject, ghidra.util.task.TaskMonitor)