//===-- ThreadPlanStepOut.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_ThreadPlanStepOut_h_
#define liblldb_ThreadPlanStepOut_h_

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

namespace lldb_private {

class ThreadPlanStepOut : public ThreadPlan,
                          public ThreadPlanShouldStopHere
{
public:
    ThreadPlanStepOut (Thread &thread,
                       SymbolContext *addr_context,
                       bool first_insn,
                       bool stop_others,
                       Vote stop_vote,
                       Vote run_vote,
                       uint32_t frame_idx,
                       LazyBool step_out_avoids_code_without_debug_info,
                       bool continue_to_next_branch = false);

    ~ThreadPlanStepOut() 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;
    bool IsPlanStale() override;
    
    lldb::ValueObjectSP GetReturnValueObject() override
    {
        return m_return_valobj_sp;
    }

protected:
    void
    SetFlagsToDefault() override
    {
        GetFlags().Set(ThreadPlanStepOut::s_default_flag_values);
    }
    
    bool DoPlanExplainsStop (Event *event_ptr) override;
    bool DoWillResume(lldb::StateType resume_state, bool current_plan) override;
    bool QueueInlinedStepPlan (bool queue_now);

private:
    static uint32_t s_default_flag_values;  // These are the default flag values for the ThreadPlanStepThrough.
    
    lldb::addr_t m_step_from_insn;
    StackID  m_step_out_to_id;
    StackID  m_immediate_step_from_id;
    lldb::break_id_t m_return_bp_id;
    lldb::addr_t m_return_addr;
    bool m_stop_others;
    lldb::ThreadPlanSP m_step_out_to_inline_plan_sp;    // This plan implements step out to the real function containing
                                                        // an inlined frame so we can then step out of that.
    lldb::ThreadPlanSP m_step_through_inline_plan_sp;   // This plan then steps past the inlined frame(s).
    lldb::ThreadPlanSP m_step_out_further_plan_sp;      // This plan keeps stepping out if ShouldStopHere told us to.
    Function *m_immediate_step_from_function;
    lldb::ValueObjectSP m_return_valobj_sp;

    friend lldb::ThreadPlanSP
    Thread::QueueThreadPlanForStepOut (bool abort_other_plans,
                                       SymbolContext *addr_context,
                                       bool first_insn,
                                       bool stop_others,
                                       Vote stop_vote,
                                       Vote run_vote,
                                       uint32_t frame_idx,
                                       LazyBool step_out_avoids_code_without_debug_info);

    void SetupAvoidNoDebug(LazyBool step_out_avoids_code_without_debug_info);
    // Need an appropriate marker for the current stack so we can tell step out
    // from step in.

    void
    CalculateReturnValue();
    
    DISALLOW_COPY_AND_ASSIGN (ThreadPlanStepOut);
};

} // namespace lldb_private

#endif // liblldb_ThreadPlanStepOut_h_
