1 //===-- ExecutionContextScope.h ---------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef liblldb_ExecutionContextScope_h_
11 #define liblldb_ExecutionContextScope_h_
15 // Other libraries and framework includes
17 #include "lldb/lldb-private.h"
19 namespace lldb_private {
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.
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.
33 /// Objects can contain a valid pointer to an instance of this so they
34 /// can reconstruct the execution context.
36 /// Objects that adhere to this protocol can reconstruct enough of a
37 /// execution context to allow functions that take a execution contexts
39 //----------------------------------------------------------------------
40 class ExecutionContextScope {
42 virtual ~ExecutionContextScope() {}
44 virtual lldb::TargetSP CalculateTarget() = 0;
46 virtual lldb::ProcessSP CalculateProcess() = 0;
48 virtual lldb::ThreadSP CalculateThread() = 0;
50 virtual lldb::StackFrameSP CalculateStackFrame() = 0;
52 //------------------------------------------------------------------
53 /// Reconstruct the object's execution context into \a sc.
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.
59 /// @param[out] exe_ctx
60 /// A reference to an execution context object that gets filled
62 //------------------------------------------------------------------
63 virtual void CalculateExecutionContext(ExecutionContext &exe_ctx) = 0;
66 } // namespace lldb_private
68 #endif // liblldb_ExecutionContextScope_h_