xref: /freebsd-src/contrib/llvm-project/lldb/bindings/interface/SBThreadPlanDocstrings.i (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1*06c3fb27SDimitry Andric %feature("docstring",
2*06c3fb27SDimitry Andric "Represents a plan for the execution control of a given thread.
3*06c3fb27SDimitry Andric 
4*06c3fb27SDimitry Andric See also :py:class:`SBThread` and :py:class:`SBFrame`."
5*06c3fb27SDimitry Andric ) lldb::SBThreadPlan;
6*06c3fb27SDimitry Andric 
7*06c3fb27SDimitry Andric %feature("docstring", "
8*06c3fb27SDimitry Andric     Get the number of words associated with the stop reason.
9*06c3fb27SDimitry Andric     See also GetStopReasonDataAtIndex()."
10*06c3fb27SDimitry Andric ) lldb::SBThreadPlan::GetStopReasonDataCount;
11*06c3fb27SDimitry Andric 
12*06c3fb27SDimitry Andric %feature("docstring", "
13*06c3fb27SDimitry Andric     Get information associated with a stop reason.
14*06c3fb27SDimitry Andric 
15*06c3fb27SDimitry Andric     Breakpoint stop reasons will have data that consists of pairs of
16*06c3fb27SDimitry Andric     breakpoint IDs followed by the breakpoint location IDs (they always come
17*06c3fb27SDimitry Andric     in pairs).
18*06c3fb27SDimitry Andric 
19*06c3fb27SDimitry Andric     Stop Reason              Count Data Type
20*06c3fb27SDimitry Andric     ======================== ===== =========================================
21*06c3fb27SDimitry Andric     eStopReasonNone          0
22*06c3fb27SDimitry Andric     eStopReasonTrace         0
23*06c3fb27SDimitry Andric     eStopReasonBreakpoint    N     duple: {breakpoint id, location id}
24*06c3fb27SDimitry Andric     eStopReasonWatchpoint    1     watchpoint id
25*06c3fb27SDimitry Andric     eStopReasonSignal        1     unix signal number
26*06c3fb27SDimitry Andric     eStopReasonException     N     exception data
27*06c3fb27SDimitry Andric     eStopReasonExec          0
28*06c3fb27SDimitry Andric     eStopReasonFork          1     pid of the child process
29*06c3fb27SDimitry Andric     eStopReasonVFork         1     pid of the child process
30*06c3fb27SDimitry Andric     eStopReasonVForkDone     0
31*06c3fb27SDimitry Andric     eStopReasonPlanComplete  0"
32*06c3fb27SDimitry Andric ) lldb::SBThreadPlan::GetStopReasonDataAtIndex;
33*06c3fb27SDimitry Andric 
34*06c3fb27SDimitry Andric %feature("docstring", "Return whether this plan will ask to stop other threads when it runs."
35*06c3fb27SDimitry Andric ) lldb::SBThreadPlan::GetStopOthers;
36*06c3fb27SDimitry Andric 
37*06c3fb27SDimitry Andric %feature("docstring", "Set whether this plan will ask to stop other threads when it runs."
38*06c3fb27SDimitry Andric ) lldb::SBThreadPlan::SetStopOthers;
39