BasePlugin
The BasePlugin class is the base class for all angr management plugins. Plugins can extend the functionality of angr management by adding custom views, UI elements, analyses, and more.
Constructor
BasePlugin(workspace: Workspace)
The workspace instance this plugin is associated with
Class Attributes
Human-readable name for the plugin. If None, uses the class name.
Whether this plugin requires a workspace to function
TOOLBAR_BUTTONS
list[tuple[QIcon, str]]
default:"[]"
List of toolbar buttons as (icon, tooltip) tuples
List of menu button text labels
List of custom column names for the functions view
List of custom URL actions this plugin handles
CONFIG_ENTRIES
list[ConfigurationEntry]
default:"[]"
Custom configuration entries for this plugin
OPTIMIZATION_PASSES
list[tuple[type[OptimizationPass], bool]]
default:"[]"
Decompiler optimization passes as (pass_class, enabled) tuples
Properties
The workspace instance (may be None if REQUIRE_WORKSPACE is False)
Methods
teardown
Clean up plugin resources. Called when the plugin is being unloaded.
get_display_name
@classmethod
get_display_name(cls) -> str
The display name (DISPLAY_NAME if set, otherwise class name)
Generic Callbacks
status_bar_permanent_widgets() -> Generator | None
Generator yielding QWidget instances, or None
on_workspace_initialized
on_workspace_initialized(workspace: Workspace) -> None
The initialized workspace
angrdb_store_entries
angrdb_store_entries() -> Generator | None
Generator yielding (key, value) tuples, or None
angrdb_load_entry
angrdb_load_entry(key: str, value: str) -> None
UI Callbacks
color_insn
color_insn(addr: int, selected: bool, disasm_view) -> QColor | None
Whether the instruction is selected
Custom color, or None to use default
color_block
color_block(addr: int) -> QColor | None
Custom color, or None to use default
color_func
color_func(func: Function) -> QColor | None
Custom color, or None to use default
draw_insn
draw_insn(qinsn: QInstruction, painter: QPainter) -> None
QPainter for custom drawing
draw_block
draw_block(qblock: QBlock, painter: QPainter) -> None
QPainter for custom drawing
instrument_disassembly_view
instrument_disassembly_view(dview: DisassemblyView) -> None
instrument_code_view
instrument_code_view(cview: CodeView) -> None
handle_click_insn
handle_click_insn(qinsn: QInstruction, event: QGraphicsSceneMouseEvent) -> bool
The clicked instruction widget
event
QGraphicsSceneMouseEvent
required
The mouse event
True if the event was handled (prevents default behavior), False otherwise
handle_click_block
handle_click_block(qblock: QBlock, event: QGraphicsSceneMouseEvent) -> bool
event
QGraphicsSceneMouseEvent
required
The mouse event
True if the event was handled, False otherwise
handle_raise_view
handle_raise_view(view: BaseView) -> None
handle_click_toolbar(idx: int) -> None
Index of the clicked button in TOOLBAR_BUTTONS
handle_click_menu
handle_click_menu(idx: int) -> None
Index of the clicked menu item in MENU_BUTTONS
extract_func_column
extract_func_column(func: Function, idx: int) -> tuple[Any, str]
Index of the column in FUNC_COLUMNS
Tuple of (sortable_data, rendered_string)
build_context_menu_insn(item: QInstruction) -> Iterable[None | tuple[str, Callable]]
return
Iterable[None | tuple[str, Callable]]
Iterable of menu items. Use None for separators, or (text, callback) tuples.
build_context_menu_block(item: QBlock) -> Iterable[None | tuple[str, Callable]]
return
Iterable[None | tuple[str, Callable]]
Iterable of menu items
build_context_menu_node(node) -> Iterable[None | tuple[str, Callable]]
return
Iterable[None | tuple[str, Callable]]
Iterable of menu items
build_context_menu_functions(funcs: list[Function]) -> Iterable[None | tuple[str, Callable]]
List of selected functions
return
Iterable[None | tuple[str, Callable]]
Iterable of menu items
build_context_menu_label(addr: int) -> Iterable[None | tuple[str, Callable]]
return
Iterable[None | tuple[str, Callable]]
Iterable of menu items
build_qblock_annotations
build_qblock_annotations(qblock: QBlock) -> Iterable[QInstructionAnnotation]
return
Iterable[QInstructionAnnotation]
Iterable of annotation widgets
handle_url_action
handle_url_action(action: str, kwargs: dict) -> None
step_callback
step_callback(simgr: SimulationManager) -> None
simgr
SimulationManager
required
The simulation manager that stepped
Decompiler Callbacks
handle_stack_var_renamed
handle_stack_var_renamed(func: Function, offset: int, old_name: str, new_name: str) -> bool
The function containing the variable
Stack offset of the variable
True if handled, False otherwise
handle_stack_var_retyped
handle_stack_var_retyped(func: Function, offset: int, old_type, new_type) -> bool
handle_func_arg_renamed
handle_func_arg_renamed(func: Function, offset: int, old_name: str, new_name: str) -> bool
handle_func_arg_retyped
handle_func_arg_retyped(func: Function, offset: int, old_type, new_type) -> bool
handle_global_var_renamed
handle_global_var_renamed(address: int, old_name: str, new_name: str) -> bool
handle_global_var_retyped
handle_global_var_retyped(address: int, old_type, new_type) -> bool
handle_other_var_renamed
handle_other_var_renamed(var, old_name: str, new_name: str) -> bool
handle_other_var_retyped
handle_other_var_retyped(var, old_type, new_type) -> bool
handle_function_renamed
handle_function_renamed(func: Function, old_name: str, new_name: str) -> bool
handle_function_retyped
handle_function_retyped(func: Function, old_type, new_type) -> bool
handle_comment_changed(
address: int,
old_cmt: str,
new_cmt: str,
created: bool,
decomp: bool
) -> bool
True if this is a new comment
True if this is a decompiler comment
True if handled, False otherwise
handle_struct_changed
handle_struct_changed(old_struct, new_struct) -> bool
decompile_callback
decompile_callback(func: Function) -> None
The function that was decompiled
handle_project_save
handle_project_save(file_name: str) -> None
Name of the saved project file
handle_project_initialization
handle_project_initialization() -> None