1 //===-- SBThread.h ----------------------------------------------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 #ifndef LLDB_SBThreadPlan_h_
10 #define LLDB_SBThreadPlan_h_
12 #include "lldb/API/SBDefines.h"
19 "Represents a plan for the execution control of a given thread.
21 See also SBThread and SBFrame."
27 friend class lldb_private::ThreadPlan;
32 SBThreadPlan (const lldb::SBThreadPlan &threadPlan);
34 SBThreadPlan (const lldb::ThreadPlanSP& lldb_object_sp);
36 SBThreadPlan (lldb::SBThread &thread, const char *class_name);
46 explicit operator bool() const;
54 %feature("docstring", "
55 Get the number of words associated with the stop reason.
56 See also GetStopReasonDataAtIndex().") GetStopReasonDataCount;
58 GetStopReasonDataCount();
60 %feature("docstring", "
61 Get information associated with a stop reason.
63 Breakpoint stop reasons will have data that consists of pairs of
64 breakpoint IDs followed by the breakpoint location IDs (they always come
67 Stop Reason Count Data Type
68 ======================== ===== =========================================
71 eStopReasonBreakpoint N duple: {breakpoint id, location id}
72 eStopReasonWatchpoint 1 watchpoint id
73 eStopReasonSignal 1 unix signal number
74 eStopReasonException N exception data
76 eStopReasonPlanComplete 0") GetStopReasonDataAtIndex;
78 GetStopReasonDataAtIndex(uint32_t idx);
84 GetDescription (lldb::SBStream &description) const;
87 SetPlanComplete (bool success);
96 QueueThreadPlanForStepOverRange (SBAddress &start_address,
97 lldb::addr_t range_size);
100 QueueThreadPlanForStepInRange (SBAddress &start_address,
101 lldb::addr_t range_size);
104 QueueThreadPlanForStepOut (uint32_t frame_idx_to_step_to, bool first_insn = false);
107 QueueThreadPlanForRunToAddress (SBAddress address);
110 QueueThreadPlanForStepScripted(const char *script_class_name);
113 QueueThreadPlanForStepScripted(const char *script_class_name,
116 QueueThreadPlanForStepScripted(const char *script_class_name,
117 SBStructuredData &args_data,
122 friend class SBBreakpoint;
123 friend class SBBreakpointLocation;
124 friend class SBFrame;
125 friend class SBProcess;
126 friend class SBDebugger;
127 friend class SBValue;
128 friend class lldb_private::QueueImpl;
129 friend class SBQueueItem;
132 lldb::ThreadPlanSP m_opaque_sp;
137 #endif // LLDB_SBThreadPlan_h_