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