xref: /freebsd-src/contrib/llvm-project/lldb/bindings/interface/SBBreakpointLocationDocstrings.i (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1*06c3fb27SDimitry Andric %feature("docstring",
2*06c3fb27SDimitry Andric "Represents one unique instance (by address) of a logical breakpoint.
3*06c3fb27SDimitry Andric 
4*06c3fb27SDimitry Andric A breakpoint location is defined by the breakpoint that produces it,
5*06c3fb27SDimitry Andric and the address that resulted in this particular instantiation.
6*06c3fb27SDimitry Andric Each breakpoint location has its settable options.
7*06c3fb27SDimitry Andric 
8*06c3fb27SDimitry Andric :py:class:`SBBreakpoint` contains SBBreakpointLocation(s). See docstring of SBBreakpoint
9*06c3fb27SDimitry Andric for retrieval of an SBBreakpointLocation from an SBBreakpoint."
10*06c3fb27SDimitry Andric ) lldb::SBBreakpointLocation;
11*06c3fb27SDimitry Andric 
12*06c3fb27SDimitry Andric %feature("docstring", "
13*06c3fb27SDimitry Andric     The breakpoint location stops only if the condition expression evaluates
14*06c3fb27SDimitry Andric     to true.") lldb::SBBreakpointLocation::SetCondition;
15*06c3fb27SDimitry Andric 
16*06c3fb27SDimitry Andric %feature("docstring", "
17*06c3fb27SDimitry Andric     Get the condition expression for the breakpoint location."
18*06c3fb27SDimitry Andric ) lldb::SBBreakpointLocation::GetCondition;
19*06c3fb27SDimitry Andric 
20*06c3fb27SDimitry Andric %feature("docstring", "
21*06c3fb27SDimitry Andric     Set the callback to the given Python function name.
22*06c3fb27SDimitry Andric     The function takes three arguments (frame, bp_loc, internal_dict)."
23*06c3fb27SDimitry Andric ) lldb::SBBreakpointLocation::SetScriptCallbackFunction;
24*06c3fb27SDimitry Andric 
25*06c3fb27SDimitry Andric %feature("docstring", "
26*06c3fb27SDimitry Andric     Set the name of the script function to be called when the breakpoint is hit.
27*06c3fb27SDimitry Andric     To use this variant, the function should take (frame, bp_loc, extra_args, internal_dict) and
28*06c3fb27SDimitry Andric     when the breakpoint is hit the extra_args will be passed to the callback function."
29*06c3fb27SDimitry Andric ) lldb::SBBreakpointLocation::SetScriptCallbackFunction;
30*06c3fb27SDimitry Andric 
31*06c3fb27SDimitry Andric %feature("docstring", "
32*06c3fb27SDimitry Andric     Provide the body for the script function to be called when the breakpoint location is hit.
33*06c3fb27SDimitry Andric     The body will be wrapped in a function, which be passed two arguments:
34*06c3fb27SDimitry Andric     'frame' - which holds the bottom-most SBFrame of the thread that hit the breakpoint
35*06c3fb27SDimitry Andric     'bpno'  - which is the SBBreakpointLocation to which the callback was attached.
36*06c3fb27SDimitry Andric 
37*06c3fb27SDimitry Andric     The error parameter is currently ignored, but will at some point hold the Python
38*06c3fb27SDimitry Andric     compilation diagnostics.
39*06c3fb27SDimitry Andric     Returns true if the body compiles successfully, false if not."
40*06c3fb27SDimitry Andric ) lldb::SBBreakpointLocation::SetScriptCallbackBody;
41