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

#include <ThreadPlanCallUserExpression.h>

Inheritance diagram for lldb_private::ThreadPlanCallUserExpression:
Inheritance graph

Public Member Functions

 ThreadPlanCallUserExpression (Thread &thread, Address &function, llvm::ArrayRef< lldb::addr_t > args, const EvaluateExpressionOptions &options, lldb::UserExpressionSP &user_expression_sp)
 ~ThreadPlanCallUserExpression () override
void GetDescription (Stream *s, lldb::DescriptionLevel level) override
 Print a description of this thread to the stream s.
void DidPush () override
void DidPop () override
lldb::StopInfoSP GetRealStopInfo () override
bool MischiefManaged () override
void TransferExpressionOwnership ()
lldb::ExpressionVariableSP GetExpressionVariable () override
- Public Member Functions inherited from lldb_private::ThreadPlanCallFunction
 ThreadPlanCallFunction (Thread &thread, const Address &function, const CompilerType &return_type, llvm::ArrayRef< lldb::addr_t > args, const EvaluateExpressionOptions &options)
 ThreadPlanCallFunction (Thread &thread, const Address &function, const EvaluateExpressionOptions &options)
 ~ThreadPlanCallFunction () 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
Vote ShouldReportStop (Event *event_ptr) override
bool StopOthers () override
lldb::StateType GetPlanRunState () override
void DidPush () override
bool WillStop () override
bool MischiefManaged () override
lldb::ValueObjectSP GetReturnValueObject () override
lldb::addr_t GetFunctionStackPointer ()
void DidPop () override
virtual lldb::StopInfoSP GetRealStopInfo ()
lldb::addr_t GetStopAddress ()
void RestoreThreadState () override
void ThreadDestroyed () override
void SetStopOthers (bool new_value) 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

void DoTakedown (bool success) override
- Protected Member Functions inherited from lldb_private::ThreadPlanCallFunction
void ReportRegisterState (const char *message)
bool DoPlanExplainsStop (Event *event_ptr) override
virtual void SetReturnValue ()
bool ConstructorSetup (Thread &thread, ABI *&abi, lldb::addr_t &start_load_addr, lldb::addr_t &function_load_addr)
virtual void DoTakedown (bool success)
void SetBreakpoints ()
void ClearBreakpoints ()
bool BreakpointsExplainStop ()
- 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

 ThreadPlanCallUserExpression (const ThreadPlanCallUserExpression &)=delete
const ThreadPlanCallUserExpressionoperator= (const ThreadPlanCallUserExpression &)=delete

Private Attributes

lldb::UserExpressionSP m_user_expression_sp
bool m_manage_materialization = false
lldb::ExpressionVariableSP m_result_var_sp

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::ThreadPlanCallFunction
bool m_valid
bool m_stop_other_threads
bool m_unwind_on_error
bool m_ignore_breakpoints
bool m_debug_execution
bool m_trap_exceptions
Address m_function_addr
Address m_start_addr
lldb::addr_t m_function_sp
lldb::ThreadPlanSP m_subplan_sp
Thread::ThreadStateCheckpoint m_stored_thread_state
lldb::StopInfoSP m_real_stop_info_sp
StreamString m_constructor_errors
lldb::ValueObjectSP m_return_valobj_sp
bool m_takedown_done
bool m_should_clear_objc_exception_bp
bool m_should_clear_cxx_exception_bp
lldb::addr_t m_stop_address
- 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 22 of file ThreadPlanCallUserExpression.h.

Constructor & Destructor Documentation

◆ ThreadPlanCallUserExpression() [1/2]

ThreadPlanCallUserExpression::ThreadPlanCallUserExpression ( Thread thread,
Address function,
llvm::ArrayRef< lldb::addr_t args,
const EvaluateExpressionOptions options,
lldb::UserExpressionSP user_expression_sp 

◆ ~ThreadPlanCallUserExpression()

ThreadPlanCallUserExpression::~ThreadPlanCallUserExpression ( )

◆ ThreadPlanCallUserExpression() [2/2]

lldb_private::ThreadPlanCallUserExpression::ThreadPlanCallUserExpression ( const ThreadPlanCallUserExpression )

Member Function Documentation

◆ DidPop()

void ThreadPlanCallUserExpression::DidPop ( )

◆ DidPush()

void ThreadPlanCallUserExpression::DidPush ( )

◆ DoTakedown()

void ThreadPlanCallUserExpression::DoTakedown ( bool  success)

◆ GetDescription()

void ThreadPlanCallUserExpression::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.

Reimplemented from lldb_private::ThreadPlanCallFunction.

Definition at line 48 of file ThreadPlanCallUserExpression.cpp.

References lldb::eDescriptionLevelBrief, lldb_private::ThreadPlanCallFunction::GetDescription(), and lldb_private::Stream::Printf().

◆ GetExpressionVariable()

lldb::ExpressionVariableSP lldb_private::ThreadPlanCallUserExpression::GetExpressionVariable ( )

Reimplemented from lldb_private::ThreadPlan.

Definition at line 43 of file ThreadPlanCallUserExpression.h.

References m_result_var_sp.

◆ GetRealStopInfo()

StopInfoSP ThreadPlanCallUserExpression::GetRealStopInfo ( )

◆ MischiefManaged()

bool ThreadPlanCallUserExpression::MischiefManaged ( )

◆ operator=()

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

◆ TransferExpressionOwnership()

void lldb_private::ThreadPlanCallUserExpression::TransferExpressionOwnership ( )

Member Data Documentation

◆ m_manage_materialization

bool lldb_private::ThreadPlanCallUserExpression::m_manage_materialization = false

Definition at line 54 of file ThreadPlanCallUserExpression.h.

Referenced by MischiefManaged(), and TransferExpressionOwnership().

◆ m_result_var_sp

lldb::ExpressionVariableSP lldb_private::ThreadPlanCallUserExpression::m_result_var_sp

Definition at line 56 of file ThreadPlanCallUserExpression.h.

Referenced by GetExpressionVariable(), and MischiefManaged().

◆ m_user_expression_sp

lldb::UserExpressionSP lldb_private::ThreadPlanCallUserExpression::m_user_expression_sp

Definition at line 51 of file ThreadPlanCallUserExpression.h.

Referenced by DidPop(), DidPush(), DoTakedown(), and MischiefManaged().

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