LLDB mainline
Public Member Functions | Protected Member Functions | List of all members
lldb_private::ThreadPlanNull Class Reference

#include <ThreadPlan.h>

Inheritance diagram for lldb_private::ThreadPlanNull:
Inheritance graph

Public Member Functions

 ThreadPlanNull (Thread &thread)
 ~ThreadPlanNull () override
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 IsBasePlan () override
bool OkayToDiscard () override
const StatusGetStatus ()
- 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
 ThreadPlanNull (const ThreadPlanNull &)=delete
const ThreadPlanNulloperator= (const ThreadPlanNull &)=delete
- 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)

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 571 of file ThreadPlan.h.

Constructor & Destructor Documentation

◆ ThreadPlanNull() [1/2]

ThreadPlanNull::ThreadPlanNull ( Thread thread)

Definition at line 185 of file ThreadPlan.cpp.

◆ ~ThreadPlanNull()

ThreadPlanNull::~ThreadPlanNull ( )

◆ ThreadPlanNull() [2/2]

lldb_private::ThreadPlanNull::ThreadPlanNull ( const ThreadPlanNull )

Member Function Documentation

◆ DoPlanExplainsStop()

bool ThreadPlanNull::DoPlanExplainsStop ( Event event_ptr)

◆ GetDescription()

void ThreadPlanNull::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 191 of file ThreadPlan.cpp.

References lldb_private::Stream::PutCString().

◆ GetPlanRunState()

lldb::StateType ThreadPlanNull::GetPlanRunState ( )

◆ GetStatus()

const Status & lldb_private::ThreadPlanNull::GetStatus ( )

Definition at line 590 of file ThreadPlan.h.

References lldb_private::ThreadPlan::m_status.

◆ IsBasePlan()

bool lldb_private::ThreadPlanNull::IsBasePlan ( )

Reimplemented from lldb_private::ThreadPlan.

Definition at line 586 of file ThreadPlan.h.

◆ MischiefManaged()

bool ThreadPlanNull::MischiefManaged ( )

◆ OkayToDiscard()

bool lldb_private::ThreadPlanNull::OkayToDiscard ( )

Reimplemented from lldb_private::ThreadPlan.

Definition at line 588 of file ThreadPlan.h.

◆ operator=()

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

◆ ShouldStop()

bool ThreadPlanNull::ShouldStop ( Event event_ptr)

◆ ValidatePlan()

bool ThreadPlanNull::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 195 of file ThreadPlan.cpp.

References lldb_private::Log::Error(), lldb_private::GetLog(), lldb_private::ThreadPlan::GetThread(), lldb_private::ThreadPlan::m_tid, and lldb_private::Thread.

◆ WillStop()

bool ThreadPlanNull::WillStop ( )

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