//===-- ThreadPlanStepThrough.h ---------------------------------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//

#ifndef liblldb_ThreadPlanStepThrough_h_
#define liblldb_ThreadPlanStepThrough_h_

// C Includes
// C++ Includes
// Other libraries and framework includes
// Project includes
#include "lldb/Target/Thread.h"
#include "lldb/Target/ThreadPlan.h"

namespace lldb_private {

class ThreadPlanStepThrough : public ThreadPlan
{
public:
    ~ThreadPlanStepThrough() override;

    void GetDescription(Stream *s, lldb::DescriptionLevel level) override;
    bool ValidatePlan(Stream *error) override;
    bool ShouldStop(Event *event_ptr) override;
    bool StopOthers() override;
    lldb::StateType GetPlanRunState() override;
    bool WillStop() override;
    bool MischiefManaged() override;
    void DidPush() override;

protected:
    bool DoPlanExplainsStop(Event *event_ptr) override;
    bool DoWillResume(lldb::StateType resume_state, bool current_plan) override;

    ThreadPlanStepThrough (Thread &thread,
                           StackID &return_stack_id,
                           bool stop_others);

    void
    LookForPlanToStepThroughFromCurrentPC ();
    
    bool 
    HitOurBackstopBreakpoint();

private:
    friend lldb::ThreadPlanSP

    Thread::QueueThreadPlanForStepThrough (StackID &return_stack_id,
                                           bool abort_other_plans,
                                           bool stop_others);
                                           
    void ClearBackstopBreakpoint();

    lldb::ThreadPlanSP m_sub_plan_sp;
    lldb::addr_t      m_start_address;
    lldb::break_id_t  m_backstop_bkpt_id;
    lldb::addr_t      m_backstop_addr;
    StackID           m_return_stack_id;
    bool              m_stop_others;

    DISALLOW_COPY_AND_ASSIGN (ThreadPlanStepThrough);
};

} // namespace lldb_private

#endif // liblldb_ThreadPlanStepThrough_h_
