plugin module¶
- class BackgroundTask(initial_progress_text='', can_cancel=False, handle=None)[source]¶
Bases:
object
- property can_cancel¶
Whether the task can be cancelled (read-only)
- property cancelled¶
Whether the task has been cancelled
- property finished¶
Whether the task has finished
- property progress¶
Text description of the progress of the background task (displayed in status bar of the UI)
- class BackgroundTaskThread(initial_progress_text: str = '', can_cancel: bool = False)[source]¶
Bases:
BackgroundTask
- class PluginCommand(cmd)[source]¶
Bases:
object
- execute(context)[source]¶
execute
Execute a Plugin- Parameters:
context (str) – PluginCommandContext to pass the PluginCommand
- Return type:
None
>>> ctx = PluginCommandContext(bv); >>> PluginCommand.get_valid_list(ctx)[r'PDB\Load'].execute(ctx)
- classmethod register(name: str, description: str, action: Callable[[BinaryView], None], is_valid: Optional[Callable[[BinaryView], bool]] = None)[source]¶
register
Register a plugin- Parameters:
name (str) – name of the plugin (use ‘Folder\Name’ to have the menu item nested in a folder)
description (str) – description of the plugin
action (callback) – function to call with the
BinaryView
as an argumentis_valid (callback) – optional argument of a function passed a
BinaryView
to determine whether the plugin should be enabled for that view
- Return type:
None
Warning
Calling
register
with the same function name will replace the existing function but will leak the memory of the original plugin.
- classmethod register_for_address(name: str, description: str, action: Callable[[BinaryView, int], None], is_valid: Optional[Callable[[BinaryView, int], bool]] = None)[source]¶
register_for_address
Register a plugin to be called with an address argument- Parameters:
name (str) – name of the plugin (use ‘Folder\Name’ to have the menu item nested in a folder)
description (str) – description of the plugin
action (callback) – function to call with the
BinaryView
and address as argumentsis_valid (callback) – optional argument of a function passed a
BinaryView
and address to determine whether the plugin should be enabled for that view
- Return type:
None
Warning
Calling
register_for_address
with the same function name will replace the existing function but will leak the memory of the original plugin.
- classmethod register_for_function(name: str, description: str, action: Callable[[BinaryView, Function], None], is_valid: Optional[Callable[[BinaryView, Function], bool]] = None)[source]¶
register_for_function
Register a plugin to be called with a function argument- Parameters:
name (str) – name of the plugin (use ‘Folder\Name’ to have the menu item nested in a folder)
description (str) – description of the plugin
action (callback) – function to call with the
BinaryView
and aFunction
as argumentsis_valid (callback) – optional argument of a function passed a
BinaryView
andFunction
to determine whether the plugin should be enabled for that view
- Return type:
None
Warning
Calling
register_for_function
with the same function name will replace the existing function but will leak the memory of the original plugin.
- classmethod register_for_high_level_il_function(name: str, description: str, action: Callable[[BinaryView, HighLevelILFunction], None], is_valid: Optional[Callable[[BinaryView, HighLevelILFunction], bool]] = None)[source]¶
register_for_high_level_il_function
Register a plugin to be called with a high level IL function argument- Parameters:
name (str) – name of the plugin (use ‘Folder\Name’ to have the menu item nested in a folder)
description (str) – description of the plugin
action (callback) – function to call with the
BinaryView
and aHighLevelILFunction
as argumentsis_valid (callback) – optional argument of a function passed a
BinaryView
andHighLevelILFunction
to determine whether the plugin should be enabled for that view
- Return type:
None
Warning
Calling
register_for_high_level_il_function
with the same function name will replace the existing function but will leak the memory of the original plugin.
- classmethod register_for_high_level_il_instruction(name: str, description: str, action: Callable[[BinaryView, HighLevelILInstruction], None], is_valid: Optional[Callable[[BinaryView, HighLevelILInstruction], bool]] = None)[source]¶
register_for_high_level_il_instruction
Register a plugin to be called with a high level IL instruction argument- Parameters:
name (str) – name of the plugin (use ‘Folder\Name’ to have the menu item nested in a folder)
description (str) – description of the plugin
action (callback) – function to call with the
BinaryView
and aHighLevelILInstruction
as argumentsis_valid (callback) – optional argument of a function passed a
BinaryView
andHighLevelILInstruction
to determine whether the plugin should be enabled for that view
- Return type:
None
Warning
Calling
register_for_high_level_il_instruction
with the same function name will replace the existing function but will leak the memory of the original plugin.
- classmethod register_for_low_level_il_function(name: str, description: str, action: Callable[[BinaryView, LowLevelILFunction], None], is_valid: Optional[Callable[[BinaryView, LowLevelILFunction], bool]] = None)[source]¶
register_for_low_level_il_function
Register a plugin to be called with a low level IL function argument- Parameters:
name (str) – name of the plugin (use ‘Folder\Name’ to have the menu item nested in a folder)
description (str) – description of the plugin
action (callback) – function to call with the
BinaryView
and aLowLevelILFunction
as argumentsis_valid (callback) – optional argument of a function passed a
BinaryView
andLowLevelILFunction
to determine whether the plugin should be enabled for that view
- Return type:
None
Warning
Calling
register_for_low_level_il_function
with the same function name will replace the existing function but will leak the memory of the original plugin.
- classmethod register_for_low_level_il_instruction(name: str, description: str, action: Callable[[BinaryView, LowLevelILInstruction], None], is_valid: Optional[Callable[[BinaryView, LowLevelILInstruction], bool]] = None)[source]¶
register_for_low_level_il_instruction
Register a plugin to be called with a low level IL instruction argument- Parameters:
name (str) – name of the plugin (use ‘Folder\Name’ to have the menu item nested in a folder)
description (str) – description of the plugin
action (callback) – function to call with the
BinaryView
and aLowLevelILInstruction
as argumentsis_valid (callback) – optional argument of a function passed a
BinaryView
andLowLevelILInstruction
to determine whether the plugin should be enabled for that view
- Return type:
None
Warning
Calling
register_for_low_level_il_instruction
with the same function name will replace the existing function but will leak the memory of the original plugin.
- classmethod register_for_medium_level_il_function(name: str, description: str, action: Callable[[BinaryView, MediumLevelILFunction], None], is_valid: Optional[Callable[[BinaryView, MediumLevelILFunction], bool]] = None)[source]¶
register_for_medium_level_il_function
Register a plugin to be called with a medium level IL function argument- Parameters:
name (str) – name of the plugin (use ‘Folder\Name’ to have the menu item nested in a folder)
description (str) – description of the plugin
action (callback) – function to call with the
BinaryView
and aMediumLevelILFunction
as argumentsis_valid (callback) – optional argument of a function passed a
BinaryView
andMediumLevelILFunction
to determine whether the plugin should be enabled for that view
- Return type:
None
Warning
Calling
register_for_medium_level_il_function
with the same function name will replace the existing function but will leak the memory of the original plugin.
- classmethod register_for_medium_level_il_instruction(name: str, description: str, action: Callable[[BinaryView, MediumLevelILInstruction], None], is_valid: Optional[Callable[[BinaryView, MediumLevelILInstruction], bool]] = None)[source]¶
register_for_medium_level_il_instruction
Register a plugin to be called with a medium level IL instruction argument- Parameters:
name (str) – name of the plugin (use ‘Folder\Name’ to have the menu item nested in a folder)
description (str) – description of the plugin
action (callback) – function to call with the
BinaryView
and aMediumLevelILInstruction
as argumentsis_valid (callback) – optional argument of a function passed a
BinaryView
andMediumLevelILInstruction
to determine whether the plugin should be enabled for that view
- Return type:
None
Warning
Calling
register_for_medium_level_il_instruction
with the same function name will replace the existing function but will leak the memory of the original plugin.
- classmethod register_for_range(name: str, description: str, action: Callable[[BinaryView, int, int], None], is_valid: Optional[Callable[[BinaryView, int, int], bool]] = None)[source]¶
register_for_range
Register a plugin to be called with a range argument- Parameters:
name (str) – name of the plugin (use ‘Folder\Name’ to have the menu item nested in a folder)
description (str) – description of the plugin
action (callback) – function to call with the
BinaryView
, start address, and length as argumentsis_valid (callback) – optional argument of a function passed a
BinaryView
, start address, and length to determine whether the plugin should be enabled for that view
- Return type:
None
Warning
Calling
register_for_range
with the same function name will replace the existing function but will leak the memory of the original plugin.
- property command¶
- property description¶
- property name¶
- property type¶