contrib/llvm/tools/lldb/include/lldb/Target/ThreadPlanBase.h

   1 //===-- ThreadPlanBase.h ----------------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef liblldb_ThreadPlanFundamental_h_
  11 #define liblldb_ThreadPlanFundamental_h_
  12
  13 // C Includes
  14 // C++ Includes
  15 // Other libraries and framework includes
  16 // Project includes
  17 #include "lldb/Target/Process.h"
  18 #include "lldb/Target/Thread.h"
  19 #include "lldb/Target/ThreadPlan.h"
  20
  21 namespace lldb_private {
  22
  23
  24 //------------------------------------------------------------------
  25 //  Base thread plans:
  26 //  This is the generic version of the bottom most plan on the plan stack.  It should
  27 //  be able to handle generic breakpoint hitting, and signals and exceptions.
  28 //------------------------------------------------------------------
  29
  30 class ThreadPlanBase : public ThreadPlan
  31 {
  32 friend class Process;  // RunThreadPlan manages "stopper" base plans.
  33 public:
  34     virtual ~ThreadPlanBase ();
  35
  36     virtual void GetDescription (Stream *s, lldb::DescriptionLevel level);
  37     virtual bool ValidatePlan (Stream *error);
  38     virtual bool ShouldStop (Event *event_ptr);
  39     virtual Vote ShouldReportStop (Event *event_ptr);
  40     virtual bool StopOthers ();
  41     virtual lldb::StateType GetPlanRunState ();
  42     virtual bool WillStop ();
  43     virtual bool MischiefManaged ();
  44
  45     virtual bool OkayToDiscard()
  46     {
  47         return false;
  48     }
  49
  50     virtual bool
  51     IsBasePlan()
  52     {
  53         return true;
  54     }
  55
  56 protected:
  57     virtual bool DoWillResume (lldb::StateType resume_state, bool current_plan);
  58     virtual bool DoPlanExplainsStop (Event *event_ptr);
  59     ThreadPlanBase (Thread &thread);
  60
  61 private:
  62     friend lldb::ThreadPlanSP
  63     Thread::QueueFundamentalPlan(bool abort_other_plans);
  64
  65     DISALLOW_COPY_AND_ASSIGN (ThreadPlanBase);
  66 };
  67
  68
  69 } // namespace lldb_private
  70
  71 #endif  // liblldb_ThreadPlanFundamental_h_