Package ghidra.app.cmd.function

Class ApplyFunctionDataTypesCmd

java.lang.Object

ghidra.framework.cmd.BackgroundCommand<Program>

ghidra.app.cmd.function.ApplyFunctionDataTypesCmd

All Implemented Interfaces:

Command<Program>

public class ApplyFunctionDataTypesCmd
extends BackgroundCommand<Program>

Apply all function signature data types in a data type manager to any user defined label that has the same name as the function signature.

Constructor Summary

Constructors

Constructor	Description
ApplyFunctionDataTypesCmd(Category sourceCategory, AddressSetView set, SourceType source, boolean alwaysReplace, boolean createBookmarksEnabled)	Constructs a new command to apply all function signature data types in the given data type category (includes all subcategories).
ApplyFunctionDataTypesCmd(List<DataTypeManager> managers, AddressSetView set, SourceType source, boolean alwaysReplace, boolean createBookmarksEnabled)	Constructs a new command to apply all function signature data types in the given data type manager.

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(Program p, 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, run, setStatusMsg, taskCompleted, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ApplyFunctionDataTypesCmd

public ApplyFunctionDataTypesCmd(List<DataTypeManager> managers,
 AddressSetView set,
 SourceType source,
 boolean alwaysReplace,
 boolean createBookmarksEnabled)

Constructs a new command to apply all function signature data types in the given data type manager.

Parameters:

managers - list of data type managers containing the function signature data types

set - set of addresses containing labels to match against function names. The addresses must not already be included in the body of any existing function. If null, all symbols will be processed

source - the source of this command.

alwaysReplace - true to always replace the existing function signature with the function signature data type.

createBookmarksEnabled - true to create a bookmark when a function signature has been applied.

ApplyFunctionDataTypesCmd

public ApplyFunctionDataTypesCmd(Category sourceCategory,
 AddressSetView set,
 SourceType source,
 boolean alwaysReplace,
 boolean createBookmarksEnabled)

Constructs a new command to apply all function signature data types in the given data type category (includes all subcategories).

Parameters:

sourceCategory - datatype category containing the function signature data types

set - set of addresses containing labels to match against function names. The addresses must not already be included in the body of any existing function. If null, all symbols will be processed

source - the source of this command.

alwaysReplace - true to always replace the existing function signature with the function signature data type.

createBookmarksEnabled - true to create a bookmark when a function signature has been applied.

Method Details

applyTo

public boolean applyTo(Program p,
 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<Program>

Parameters:

p - domain object that will be affected by the command

monitor - monitor to show progress of the command

Returns:

true if the command applied successfully