1 //===-- ThreadPlanPython.h --------------------------------------------*- C++
2 //-*-===//
3 //
4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5 // See https://llvm.org/LICENSE.txt for license information.
6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #ifndef LLDB_TARGET_THREADPLANPYTHON_H
11 #define LLDB_TARGET_THREADPLANPYTHON_H
12 
13 #include <string>
14 
15 #include "lldb/Core/StructuredDataImpl.h"
16 #include "lldb/Target/Process.h"
17 #include "lldb/Target/StopInfo.h"
18 #include "lldb/Target/Target.h"
19 #include "lldb/Target/Thread.h"
20 #include "lldb/Target/ThreadPlan.h"
21 #include "lldb/Target/ThreadPlanTracer.h"
22 #include "lldb/Utility/StructuredData.h"
23 #include "lldb/Utility/UserID.h"
24 #include "lldb/lldb-forward.h"
25 #include "lldb/lldb-private.h"
26 
27 namespace lldb_private {
28 
29 //  ThreadPlanPython:
30 //
31 
32 class ThreadPlanPython : public ThreadPlan {
33 public:
34   ThreadPlanPython(Thread &thread, const char *class_name,
35                    const StructuredDataImpl &args_data);
36 
37   void GetDescription(Stream *s, lldb::DescriptionLevel level) override;
38 
39   bool ValidatePlan(Stream *error) override;
40 
41   bool ShouldStop(Event *event_ptr) override;
42 
43   bool MischiefManaged() override;
44 
45   bool WillStop() override;
46 
47   bool StopOthers() override { return m_stop_others; }
48 
49   void SetStopOthers(bool new_value) override { m_stop_others = new_value; }
50 
51   void DidPush() override;
52 
53   bool IsPlanStale() override;
54 
55   bool DoWillResume(lldb::StateType resume_state, bool current_plan) override;
56 
57 
58 protected:
59   bool DoPlanExplainsStop(Event *event_ptr) override;
60 
61   lldb::StateType GetPlanRunState() override;
62 
63   ScriptInterpreter *GetScriptInterpreter();
64 
65 private:
66   std::string m_class_name;
67   StructuredDataImpl m_args_data;
68   std::string m_error_str;
69   StructuredData::ObjectSP m_implementation_sp;
70   StreamString m_stop_description; // Cache the stop description here
71   bool m_did_push;
72   bool m_stop_others;
73 
74   ThreadPlanPython(const ThreadPlanPython &) = delete;
75   const ThreadPlanPython &operator=(const ThreadPlanPython &) = delete;
76 };
77 
78 } // namespace lldb_private
79 
80 #endif // LLDB_TARGET_THREADPLANPYTHON_H
81