LLVM: SBExpressionOptions.h Source File
Description: C++ source code API documentation for LLDB.
Keywords: LLDB,C++,doxygen,API,documentation

LLDB API Documentation

- Main Page
- Namespaces
- Classes
- Files

- File List

SBExpressionOptions.h
Go to the documentation of this file.
1 //===-- SBEvent.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 LLDB_SBExpressionOptions_h_
11 #define LLDB_SBExpressionOptions_h_
12
13 #include "lldb/API/SBDefines.h"
14
15 #include <vector>
16
17 namespace lldb {
18
19 class LLDB_API SBExpressionOptions {
20 public:
21 SBExpressionOptions();
22
23 SBExpressionOptions(const lldb::SBExpressionOptions &rhs);
24
25 ~SBExpressionOptions();
26
27 const SBExpressionOptions &operator=(const lldb::SBExpressionOptions &rhs);
28
29 bool GetCoerceResultToId() const;
30
31 void SetCoerceResultToId(bool coerce = true);
32
33 bool GetUnwindOnError() const;
34
35 void SetUnwindOnError(bool unwind = true);
36
37 bool GetIgnoreBreakpoints() const;
38
39 void SetIgnoreBreakpoints(bool ignore = true);
40
41 lldb::DynamicValueType GetFetchDynamicValue() const;
42
43 void SetFetchDynamicValue(
44 lldb::DynamicValueType dynamic = lldb::eDynamicCanRunTarget);
45
46 uint32_t GetTimeoutInMicroSeconds() const;
47
48 // Set the timeout for the expression, 0 means wait forever.
49 void SetTimeoutInMicroSeconds(uint32_t timeout = 0);
50
51 uint32_t GetOneThreadTimeoutInMicroSeconds() const;
52
53 // Set the timeout for running on one thread, 0 means use the default
54 // behavior.
55 // If you set this higher than the overall timeout, you'll get an error when
56 // you
57 // try to run the expression.
58 void SetOneThreadTimeoutInMicroSeconds(uint32_t timeout = 0);
59
60 bool GetTryAllThreads() const;
61
62 void SetTryAllThreads(bool run_others = true);
63
64 bool GetStopOthers() const;
65
66 void SetStopOthers(bool stop_others = true);
67
68 bool GetTrapExceptions() const;
69
70 void SetTrapExceptions(bool trap_exceptions = true);
71
72 void SetLanguage(lldb::LanguageType language);
73
74 void SetCancelCallback(lldb::ExpressionCancelCallback callback, void *baton);
75
76 bool GetGenerateDebugInfo();
77
78 void SetGenerateDebugInfo(bool b = true);
79
80 bool GetSuppressPersistentResult();
81
82 void SetSuppressPersistentResult(bool b = false);
83
84 const char *GetPrefix() const;
85
86 void SetPrefix(const char *prefix);
87
88 void SetAutoApplyFixIts(bool b = true);
89
90 bool GetAutoApplyFixIts();
91
92 bool GetTopLevel();
93
94 void SetTopLevel(bool b = true);
95
96 protected:
97 SBExpressionOptions(
98 lldb_private::EvaluateExpressionOptions &expression_options);
99
100 lldb_private::EvaluateExpressionOptions *get() const;
101
102 lldb_private::EvaluateExpressionOptions &ref() const;
103
104 friend class SBFrame;
105 friend class SBValue;
106 friend class SBTarget;
107
108 private:
109 // This auto_pointer is made in the constructor and is always valid.
110 mutable std::unique_ptr<lldb_private::EvaluateExpressionOptions> m_opaque_ap;
111 };
112
113 } // namespace lldb
114
115 #endif // LLDB_SBExpressionOptions_h_
lldb::SBFrame
Definition: SBFrame.h:18
SBDefines.h
lldb::SBExpressionOptions
class LLDB_API SBExpressionOptions
Definition: SBDefines.h:50
lldb::SBValue
Definition: SBValue.h:22
lldb::SBExpressionOptions
Definition: SBExpressionOptions.h:19
lldb::SBTarget
Definition: SBTarget.h:34