xref: /freebsd-src/contrib/llvm-project/lldb/bindings/interface/SBExpressionOptionsDocstrings.i (revision 06c3fb2749bda94cb5201f81ffdb8fa6c3161b2e)
1*06c3fb27SDimitry Andric %feature("docstring",
2*06c3fb27SDimitry Andric "A container for options to use when evaluating expressions."
3*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions;
4*06c3fb27SDimitry Andric 
5*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to coerce the expression result to ObjC id type after evaluation."
6*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetCoerceResultToId;
7*06c3fb27SDimitry Andric 
8*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to unwind the expression stack on error."
9*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetUnwindOnError;
10*06c3fb27SDimitry Andric 
11*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to ignore breakpoint hits while running expressions."
12*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetIgnoreBreakpoints;
13*06c3fb27SDimitry Andric 
14*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to cast the expression result to its dynamic type."
15*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetFetchDynamicValue;
16*06c3fb27SDimitry Andric 
17*06c3fb27SDimitry Andric %feature("docstring", "Sets the timeout in microseconds to run the expression for. If try all threads is set to true and the expression doesn't complete within the specified timeout, all threads will be resumed for the same timeout to see if the expression will finish."
18*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetTimeoutInMicroSeconds;
19*06c3fb27SDimitry Andric 
20*06c3fb27SDimitry Andric %feature("docstring", "Sets the timeout in microseconds to run the expression on one thread before either timing out or trying all threads."
21*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetOneThreadTimeoutInMicroSeconds;
22*06c3fb27SDimitry Andric 
23*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to run all threads if the expression does not complete on one thread."
24*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetTryAllThreads;
25*06c3fb27SDimitry Andric 
26*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to stop other threads at all while running expressions.  If false, TryAllThreads does nothing."
27*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetStopOthers;
28*06c3fb27SDimitry Andric 
29*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to abort expression evaluation if an exception is thrown while executing.  Don't set this to false unless you know the function you are calling traps all exceptions itself."
30*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetTrapExceptions;
31*06c3fb27SDimitry Andric 
32*06c3fb27SDimitry Andric %feature ("docstring", "Sets the language that LLDB should assume the expression is written in"
33*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetLanguage;
34*06c3fb27SDimitry Andric 
35*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to generate debug information for the expression and also controls if a SBModule is generated."
36*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetGenerateDebugInfo;
37*06c3fb27SDimitry Andric 
38*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to produce a persistent result that can be used in future expressions."
39*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetSuppressPersistentResult;
40*06c3fb27SDimitry Andric 
41*06c3fb27SDimitry Andric %feature("docstring", "Gets the prefix to use for this expression."
42*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::GetPrefix;
43*06c3fb27SDimitry Andric 
44*06c3fb27SDimitry Andric %feature("docstring", "Sets the prefix to use for this expression. This prefix gets inserted after the 'target.expr-prefix' prefix contents, but before the wrapped expression function body."
45*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetPrefix;
46*06c3fb27SDimitry Andric 
47*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to auto-apply fix-it hints to the expression being evaluated."
48*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetAutoApplyFixIts;
49*06c3fb27SDimitry Andric 
50*06c3fb27SDimitry Andric %feature("docstring", "Gets whether to auto-apply fix-it hints to an expression."
51*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::GetAutoApplyFixIts;
52*06c3fb27SDimitry Andric 
53*06c3fb27SDimitry Andric %feature("docstring", "Sets how often LLDB should retry applying fix-its to an expression."
54*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetRetriesWithFixIts;
55*06c3fb27SDimitry Andric 
56*06c3fb27SDimitry Andric %feature("docstring", "Gets how often LLDB will retry applying fix-its to an expression."
57*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::GetRetriesWithFixIts;
58*06c3fb27SDimitry Andric 
59*06c3fb27SDimitry Andric %feature("docstring", "Gets whether to JIT an expression if it cannot be interpreted."
60*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::GetAllowJIT;
61*06c3fb27SDimitry Andric 
62*06c3fb27SDimitry Andric %feature("docstring", "Sets whether to JIT an expression if it cannot be interpreted."
63*06c3fb27SDimitry Andric ) lldb::SBExpressionOptions::SetAllowJIT;
64