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