LLDB mainline
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
lldb_private::ThreadPlanPython Class Reference

#include <ThreadPlanPython.h>

Inheritance diagram for lldb_private::ThreadPlanPython:
Inheritance graph

Public Member Functions

 ThreadPlanPython (Thread &thread, const char *class_name, const StructuredDataImpl &args_data)
void GetDescription (Stream *s, lldb::DescriptionLevel level) override
 Print a description of this thread to the stream s.
bool ValidatePlan (Stream *error) override
 Returns whether this plan could be successfully created.
bool ShouldStop (Event *event_ptr) override
bool MischiefManaged () override
bool WillStop () override
bool StopOthers () override
void SetStopOthers (bool new_value) override
void DidPush () override
bool IsPlanStale () override
bool DoWillResume (lldb::StateType resume_state, bool current_plan) override
- Public Member Functions inherited from lldb_private::ThreadPlan
virtual ~ThreadPlan ()
const char * GetName () const
 Returns the name of this thread plan.
ThreadGetThread ()
 Returns the Thread that is using this thread plan.
TargetGetTarget ()
const TargetGetTarget () const
void ClearThreadCache ()
 Clear the Thread* cache.
virtual void GetDescription (Stream *s, lldb::DescriptionLevel level)=0
 Print a description of this thread to the stream s.
virtual bool ValidatePlan (Stream *error)=0
 Returns whether this plan could be successfully created.
bool TracerExplainsStop ()
lldb::StateType RunState ()
bool PlanExplainsStop (Event *event_ptr)
virtual bool ShouldStop (Event *event_ptr)=0
virtual bool ShouldAutoContinue (Event *event_ptr)
 Returns whether this thread plan overrides the ShouldStop of subsequently processed plans.
virtual Vote ShouldReportStop (Event *event_ptr)
Vote ShouldReportRun (Event *event_ptr)
virtual void SetStopOthers (bool new_value)
virtual bool StopOthers ()
virtual bool ShouldRunBeforePublicStop ()
bool WillResume (lldb::StateType resume_state, bool current_plan)
virtual bool WillStop ()=0
bool IsControllingPlan ()
bool SetIsControllingPlan (bool value)
virtual bool OkayToDiscard ()
void SetOkayToDiscard (bool value)
virtual bool MischiefManaged ()
virtual void ThreadDestroyed ()
bool GetPrivate ()
void SetPrivate (bool input)
virtual void DidPush ()
virtual void DidPop ()
ThreadPlanKind GetKind () const
bool IsPlanComplete ()
void SetPlanComplete (bool success=true)
virtual bool IsPlanStale ()
bool PlanSucceeded ()
virtual bool IsBasePlan ()
lldb::ThreadPlanTracerSPGetThreadPlanTracer ()
void SetThreadPlanTracer (lldb::ThreadPlanTracerSP new_tracer_sp)
void DoTraceLog ()
virtual lldb::ValueObjectSP GetReturnValueObject ()
virtual lldb::ExpressionVariableSP GetExpressionVariable ()
virtual void RestoreThreadState ()
virtual bool IsVirtualStep ()
bool SetIterationCount (size_t count)
- Public Member Functions inherited from lldb_private::UserID
 UserID (lldb::user_id_t uid=LLDB_INVALID_UID)
 Construct with optional user ID.
 ~UserID ()=default
void Clear ()
 Clears the object state.
lldb::user_id_t GetID () const
 Get accessor for the user ID.
void SetID (lldb::user_id_t uid)
 Set accessor for the user ID.

Protected Member Functions

bool DoPlanExplainsStop (Event *event_ptr) override
lldb::StateType GetPlanRunState () override
ScriptInterpreterGetScriptInterpreter ()
- Protected Member Functions inherited from lldb_private::ThreadPlan
 ThreadPlan (ThreadPlanKind kind, const char *name, Thread &thread, Vote report_stop_vote, Vote report_run_vote)
virtual bool DoWillResume (lldb::StateType resume_state, bool current_plan)
virtual bool DoPlanExplainsStop (Event *event_ptr)=0
void PushPlan (lldb::ThreadPlanSP &thread_plan_sp)
ThreadPlanGetPreviousPlan ()
lldb::StopInfoSP GetPrivateStopInfo ()
void SetStopInfo (lldb::StopInfoSP stop_reason_sp)
virtual lldb::StateType GetPlanRunState ()=0
bool IsUsuallyUnexplainedStopReason (lldb::StopReason)

Private Member Functions

 ThreadPlanPython (const ThreadPlanPython &)=delete
const ThreadPlanPythonoperator= (const ThreadPlanPython &)=delete

Private Attributes

std::string m_class_name
StructuredDataImpl m_args_data
std::string m_error_str
StructuredData::ObjectSP m_implementation_sp
StreamString m_stop_description
bool m_did_push
bool m_stop_others

Additional Inherited Members

- Public Types inherited from lldb_private::ThreadPlan
enum  ThreadPlanKind {
  eKindGeneric , eKindNull , eKindBase , eKindCallFunction ,
  eKindPython , eKindStepInstruction , eKindStepOut , eKindStepOverBreakpoint ,
  eKindStepOverRange , eKindStepInRange , eKindRunToAddress , eKindStepThrough ,
- Protected Attributes inherited from lldb_private::ThreadPlan
Status m_status
lldb::tid_t m_tid
Vote m_report_stop_vote
Vote m_report_run_vote
bool m_takes_iteration_count
bool m_could_not_resolve_hw_bp
int32_t m_iteration_count = 1
- Protected Attributes inherited from lldb_private::UserID
lldb::user_id_t m_uid
 The user ID that uniquely identifies an object.

Detailed Description

Definition at line 32 of file ThreadPlanPython.h.

Constructor & Destructor Documentation

◆ ThreadPlanPython() [1/2]

ThreadPlanPython::ThreadPlanPython ( Thread thread,
const char *  class_name,
const StructuredDataImpl args_data 

◆ ThreadPlanPython() [2/2]

lldb_private::ThreadPlanPython::ThreadPlanPython ( const ThreadPlanPython )

Member Function Documentation

◆ DidPush()

void ThreadPlanPython::DidPush ( )

◆ DoPlanExplainsStop()

bool ThreadPlanPython::DoPlanExplainsStop ( Event event_ptr)

◆ DoWillResume()

bool ThreadPlanPython::DoWillResume ( lldb::StateType  resume_state,
bool  current_plan 

Reimplemented from lldb_private::ThreadPlan.

Definition at line 196 of file ThreadPlanPython.cpp.

References lldb_private::StreamString::Clear(), and m_stop_description.

◆ GetDescription()

void ThreadPlanPython::GetDescription ( Stream s,
lldb::DescriptionLevel  level 

Print a description of this thread to the stream s.

thread. Don't expect that the result of GetThread is valid in the description method. This might get called when the underlying Thread has not been reported, so we only know the TID and not the thread.

[in]sThe stream to which to print the description.
[in]levelThe level of description desired. Note that eDescriptionLevelBrief will be used in the stop message printed when the plan is complete.

Implements lldb_private::ThreadPlan.

Definition at line 164 of file ThreadPlanPython.cpp.

References lldb_private::StreamString::Empty(), lldb_private::StreamString::GetData(), lldb_private::GetLog(), GetScriptInterpreter(), LLDB_LOGF, m_class_name, m_implementation_sp, m_stop_description, lldb_private::Stream::Printf(), lldb_private::Stream::PutCString(), lldb_private::ScriptInterpreter::ScriptedThreadPlanGetStopDescription(), and lldb_private::Thread.

Referenced by MischiefManaged().

◆ GetPlanRunState()

lldb::StateType ThreadPlanPython::GetPlanRunState ( )

◆ GetScriptInterpreter()

ScriptInterpreter * ThreadPlanPython::GetScriptInterpreter ( )

◆ IsPlanStale()

bool ThreadPlanPython::IsPlanStale ( )

◆ MischiefManaged()

bool ThreadPlanPython::MischiefManaged ( )

◆ operator=()

const ThreadPlanPython & lldb_private::ThreadPlanPython::operator= ( const ThreadPlanPython )

◆ SetStopOthers()

void lldb_private::ThreadPlanPython::SetStopOthers ( bool  new_value)

Reimplemented from lldb_private::ThreadPlan.

Definition at line 49 of file ThreadPlanPython.h.

References m_stop_others.

◆ ShouldStop()

bool ThreadPlanPython::ShouldStop ( Event event_ptr)

◆ StopOthers()

bool lldb_private::ThreadPlanPython::StopOthers ( )

Reimplemented from lldb_private::ThreadPlan.

Definition at line 47 of file ThreadPlanPython.h.

References m_stop_others.

◆ ValidatePlan()

bool ThreadPlanPython::ValidatePlan ( Stream error)

Returns whether this plan could be successfully created.

[in]errorA stream to which to print some reason why the plan could not be created. Can be NULL.
true if the plan should be queued, false otherwise.

Implements lldb_private::ThreadPlan.

Definition at line 40 of file ThreadPlanPython.cpp.

References error(), m_did_push, m_error_str, and m_implementation_sp.

◆ WillStop()

bool ThreadPlanPython::WillStop ( )

Member Data Documentation

◆ m_args_data

StructuredDataImpl lldb_private::ThreadPlanPython::m_args_data

Definition at line 67 of file ThreadPlanPython.h.

Referenced by DidPush().

◆ m_class_name

std::string lldb_private::ThreadPlanPython::m_class_name

◆ m_did_push

bool lldb_private::ThreadPlanPython::m_did_push

Definition at line 71 of file ThreadPlanPython.h.

Referenced by DidPush(), and ValidatePlan().

◆ m_error_str

std::string lldb_private::ThreadPlanPython::m_error_str

Definition at line 68 of file ThreadPlanPython.h.

Referenced by DidPush(), and ValidatePlan().

◆ m_implementation_sp

StructuredData::ObjectSP lldb_private::ThreadPlanPython::m_implementation_sp

◆ m_stop_description

StreamString lldb_private::ThreadPlanPython::m_stop_description

Definition at line 70 of file ThreadPlanPython.h.

Referenced by DoWillResume(), GetDescription(), and MischiefManaged().

◆ m_stop_others

bool lldb_private::ThreadPlanPython::m_stop_others

Definition at line 72 of file ThreadPlanPython.h.

Referenced by SetStopOthers(), and StopOthers().

The documentation for this class was generated from the following files: