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

   1 //===-- ExecutionContextScope.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_ExecutionContextScope_h_
  11 #define liblldb_ExecutionContextScope_h_
  12
  13 // C Includes
  14 // C++ Includes
  15 // Other libraries and framework includes
  16 // Project includes
  17 #include "lldb/lldb-private.h"
  18
  19 namespace lldb_private {
  20
  21 //----------------------------------------------------------------------
  22 /// @class ExecutionContextScope ExecutionContextScope.h
  23 /// "lldb/Symbol/ExecutionContextScope.h"
  24 /// @brief Inherit from this if your object can reconstruct its
  25 ///        execution context.
  26 ///
  27 /// Many objects that have pointers back to parent execution context
  28 /// objects can inherit from this pure virtual class can reconstruct
  29 /// their execution context without having to keep a complete
  30 /// ExecutionContext object in the object state. Examples of these
  31 /// objects include: Process, Thread, RegisterContext and StackFrame.
  32 ///
  33 /// Objects can contain a valid pointer to an instance of this so they
  34 /// can reconstruct the execution context.
  35 ///
  36 /// Objects that adhere to this protocol can reconstruct enough of a
  37 /// execution context to allow functions that take a execution contexts
  38 /// to be called.
  39 //----------------------------------------------------------------------
  40 class ExecutionContextScope {
  41 public:
  42   virtual ~ExecutionContextScope() {}
  43
  44   virtual lldb::TargetSP CalculateTarget() = 0;
  45
  46   virtual lldb::ProcessSP CalculateProcess() = 0;
  47
  48   virtual lldb::ThreadSP CalculateThread() = 0;
  49
  50   virtual lldb::StackFrameSP CalculateStackFrame() = 0;
  51
  52   //------------------------------------------------------------------
  53   /// Reconstruct the object's execution context into \a sc.
  54   ///
  55   /// The object should fill in as much of the ExecutionContextScope as it
  56   /// can so function calls that require a execution context can be made
  57   /// for the given object.
  58   ///
  59   /// @param[out] exe_ctx
  60   ///     A reference to an execution context object that gets filled
  61   ///     in.
  62   //------------------------------------------------------------------
  63   virtual void CalculateExecutionContext(ExecutionContext &exe_ctx) = 0;
  64 };
  65
  66 } // namespace lldb_private
  67
  68 #endif // liblldb_ExecutionContextScope_h_