ScriptedBreakpointResolver

class lldb.plugins.scripted_breakpoint.ScriptedBreakpointResolver(bkpt: SBBreakpoint, args: SBStructuredData)

The base class for a scripted breakpoint resolver.

Methods Summary

get_location_description(bp_loc, level)	Customize the description used when printing a breakpoint location owned by this resolver.
get_short_help()	A one-line description of this resolver, shown by breakpoint list.
overrides_resolver(resolver_data)	Decide, from the incoming resolver options, whether this breakpoint should have its resolver replaced by this class.
set_breakpoint(bkpt)	Called once the underlying breakpoint has been fully created and associated to this resolver.
was_hit(frame, bp_loc)	Called when a location owned by this resolver is hit, to allow overriding which location is reported as hit.

Methods Documentation

get_location_description(bp_loc: SBBreakpointLocation, level: int) → str | None

Customize the description used when printing a breakpoint location owned by this resolver.

Parameters:

• bp_loc (lldb.SBBreakpointLocation) – The breakpoint location to describe.

• level (lldb.DescriptionLevel) – The level of detail requested.

Returns:

The description for the location.

Return type:

str

get_short_help() → str | None

A one-line description of this resolver, shown by breakpoint list.

Returns:

The short help string.

Return type:

str

overrides_resolver(resolver_data: SBStructuredData) → bool

Decide, from the incoming resolver options, whether this breakpoint should have its resolver replaced by this class. When True, this class’s __callback__ picks locations for this breakpoint instead of the original resolver’s. Search depth is unaffected either way and still comes from __get_depth__.

Parameters:

resolver_data (lldb.SBStructuredData) – The resolver options passed in when the breakpoint was created.

Returns:

True if this class’s __callback__ should be used in place of the original resolver’s, False to leave the original resolver in charge.

Return type:

bool

set_breakpoint(bkpt: SBBreakpoint) → None

Called once the underlying breakpoint has been fully created and associated to this resolver.

Parameters:

bkpt (lldb.SBBreakpoint) – The breakpoint owning this resolver.

was_hit(frame: SBFrame, bp_loc: SBBreakpointLocation) → SBBreakpointLocation

Called when a location owned by this resolver is hit, to allow overriding which location is reported as hit.

Parameters:

• frame (lldb.SBFrame) – The frame where the breakpoint was hit.

• bp_loc (lldb.SBBreakpointLocation) – The breakpoint location that was hit.

Returns:

The location to report as hit. Defaults to bp_loc.

Return type:

lldb.SBBreakpointLocation