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

This thread plan calls a function object when the current function exits. More...

#include <ThreadPlanCallOnFunctionExit.h>

Inheritance diagram for lldb_private::ThreadPlanCallOnFunctionExit:
Inheritance graph
[legend]
Collaboration diagram for lldb_private::ThreadPlanCallOnFunctionExit:
Collaboration graph
[legend]

Public Types

using Callback = std::function< void()>
 Definition for the callback made when the currently executing thread finishes executing its function. More...
 
- Public Types inherited from lldb_private::ThreadPlan
enum  ThreadPlanKind {
  eKindGeneric, eKindNull, eKindBase, eKindCallFunction,
  eKindPython, eKindStepInstruction, eKindStepOut, eKindStepOverBreakpoint,
  eKindStepOverRange, eKindStepInRange, eKindRunToAddress, eKindStepThrough,
  eKindStepUntil
}
 

Public Member Functions

 ThreadPlanCallOnFunctionExit (Thread &thread, const Callback &callback)
 
void DidPush () override
 
void GetDescription (Stream *s, lldb::DescriptionLevel level) override
 Print a description of this thread to the stream s. More...
 
bool ValidatePlan (Stream *error) override
 Returns whether this plan could be successfully created. More...
 
bool ShouldStop (Event *event_ptr) override
 
bool WillStop () override
 
- Public Member Functions inherited from lldb_private::ThreadPlan
virtual ~ThreadPlan ()
 
const char * GetName () const
 Returns the name of this thread plan. More...
 
ThreadGetThread ()
 Returns the Thread that is using this thread plan. More...
 
TargetGetTarget ()
 
const TargetGetTarget () const
 
void ClearThreadCache ()
 Clear the Thread* cache. More...
 
bool TracerExplainsStop ()
 
lldb::StateType RunState ()
 
bool PlanExplainsStop (Event *event_ptr)
 
virtual bool ShouldAutoContinue (Event *event_ptr)
 Returns whether this thread plan overrides the ShouldStop of subsequently processed plans. More...
 
virtual Vote ShouldReportStop (Event *event_ptr)
 
Vote ShouldReportRun (Event *event_ptr)
 
virtual void SetStopOthers (bool new_value)
 
virtual bool StopOthers ()
 
bool WillResume (lldb::StateType resume_state, bool current_plan)
 
bool IsMasterPlan ()
 
bool SetIsMasterPlan (bool value)
 
virtual bool OkayToDiscard ()
 
void SetOkayToDiscard (bool value)
 
virtual bool MischiefManaged ()
 
virtual void ThreadDestroyed ()
 
bool GetPrivate ()
 
void SetPrivate (bool input)
 
virtual void DidPop ()
 
ThreadPlanKind GetKind () const
 
bool IsPlanComplete ()
 
void SetPlanComplete (bool success=true)
 
virtual bool IsPlanStale ()
 
bool PlanSucceeded ()
 
virtual bool IsBasePlan ()
 
lldb::ThreadPlanTracerSP & GetThreadPlanTracer ()
 
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. More...
 
 ~UserID ()=default
 Destructor. More...
 
void Clear ()
 Clears the object state. More...
 
lldb::user_id_t GetID () const
 Get accessor for the user ID. More...
 
void SetID (lldb::user_id_t uid)
 Set accessor for the user ID. More...
 

Protected Member Functions

bool DoPlanExplainsStop (Event *event_ptr) override
 
lldb::StateType GetPlanRunState () override
 
- 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)
 
void PushPlan (lldb::ThreadPlanSP &thread_plan_sp)
 
ThreadPlanGetPreviousPlan ()
 
lldb::StopInfoSP GetPrivateStopInfo ()
 
void SetStopInfo (lldb::StopInfoSP stop_reason_sp)
 
bool IsUsuallyUnexplainedStopReason (lldb::StopReason)
 

Private Attributes

Callback m_callback
 
lldb::ThreadPlanSP m_step_out_threadplan_sp
 

Additional Inherited Members

- Protected Attributes inherited from lldb_private::ThreadPlan
Status m_status
 
Processm_process
 
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. More...
 

Detailed Description

This thread plan calls a function object when the current function exits.

Definition at line 22 of file ThreadPlanCallOnFunctionExit.h.

Member Typedef Documentation

◆ Callback

Definition for the callback made when the currently executing thread finishes executing its function.

Definition at line 26 of file ThreadPlanCallOnFunctionExit.h.

Constructor & Destructor Documentation

◆ ThreadPlanCallOnFunctionExit()

ThreadPlanCallOnFunctionExit::ThreadPlanCallOnFunctionExit ( Thread thread,
const Callback callback 
)

Member Function Documentation

◆ DidPush()

void ThreadPlanCallOnFunctionExit::DidPush ( )
overridevirtual

◆ DoPlanExplainsStop()

bool ThreadPlanCallOnFunctionExit::DoPlanExplainsStop ( Event event_ptr)
overrideprotectedvirtual

Implements lldb_private::ThreadPlan.

Definition at line 86 of file ThreadPlanCallOnFunctionExit.cpp.

◆ GetDescription()

void ThreadPlanCallOnFunctionExit::GetDescription ( Stream s,
lldb::DescriptionLevel  level 
)
overridevirtual

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.

Parameters
[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 45 of file ThreadPlanCallOnFunctionExit.cpp.

References lldb_private::Stream::Printf().

◆ GetPlanRunState()

lldb::StateType ThreadPlanCallOnFunctionExit::GetPlanRunState ( )
overrideprotectedvirtual

Implements lldb_private::ThreadPlan.

Definition at line 93 of file ThreadPlanCallOnFunctionExit.cpp.

References lldb::eStateRunning.

◆ ShouldStop()

bool ThreadPlanCallOnFunctionExit::ShouldStop ( Event event_ptr)
overridevirtual

◆ ValidatePlan()

bool ThreadPlanCallOnFunctionExit::ValidatePlan ( Stream error)
overridevirtual

Returns whether this plan could be successfully created.

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

Implements lldb_private::ThreadPlan.

Definition at line 53 of file ThreadPlanCallOnFunctionExit.cpp.

◆ WillStop()

bool ThreadPlanCallOnFunctionExit::WillStop ( )
overridevirtual

Implements lldb_private::ThreadPlan.

Definition at line 79 of file ThreadPlanCallOnFunctionExit.cpp.

Member Data Documentation

◆ m_callback

Callback lldb_private::ThreadPlanCallOnFunctionExit::m_callback
private

Definition at line 48 of file ThreadPlanCallOnFunctionExit.h.

Referenced by ShouldStop().

◆ m_step_out_threadplan_sp

lldb::ThreadPlanSP lldb_private::ThreadPlanCallOnFunctionExit::m_step_out_threadplan_sp
private

Definition at line 49 of file ThreadPlanCallOnFunctionExit.h.

Referenced by DidPush(), and ShouldStop().


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