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