Michael Buch 2e52de5aa2
[lldb][Expression] Add API to set/get language-specific expression options (#179208)
The motivation here is that we don't want to pollute the SBAPI with
getters/setters for expression evaluation options that only apply to a
single language. The ultimate goal would be to have plugins register
additional options to the `expression` command when the plugin is
loaded. This patch only provides the minimal `SBExpressionOptions`
interface to set an option with an arbitrary name, which the language
plugin knows how to interpret. The underlying options dictionary is an
`StructuredData::Dictionary` so we can map strings to values of any
type. But the SBAPI just exposes setting a boolean value. Future
overloads of `SetLanguageOption` can provide setters for more types.

The boolean setter/getter will be used for the C++-specific option being
introduced in: https://github.com/llvm/llvm-project/pull/177926
2026-02-04 21:32:14 +00:00

122 lines
4.5 KiB
Python

"""
Test expression command options.
Test cases:
o test_expr_options:
Test expression command options.
"""
import lldb
import lldbsuite.test.lldbutil as lldbutil
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
class ExprOptionsTestCase(TestBase):
def setUp(self):
# Call super's setUp().
TestBase.setUp(self)
self.main_source = "main.cpp"
self.main_source_spec = lldb.SBFileSpec(self.main_source)
self.line = line_number("main.cpp", "// breakpoint_in_main")
self.exe = self.getBuildArtifact("a.out")
def test_expr_options(self):
"""These expression command options should work as expected."""
self.build()
# Set debugger into synchronous mode
self.dbg.SetAsync(False)
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
self, "// breakpoint_in_main", self.main_source_spec
)
frame = thread.GetFrameAtIndex(0)
options = lldb.SBExpressionOptions()
# test --language on C++ expression using the SB API's
# Make sure we can evaluate a C++11 expression.
val = frame.EvaluateExpression("foo != nullptr")
self.assertTrue(val.IsValid())
self.assertSuccess(val.GetError())
self.DebugSBValue(val)
# Make sure it still works if language is set to C++11:
options.SetLanguage(lldb.eLanguageTypeC_plus_plus_11)
val = frame.EvaluateExpression("foo != nullptr", options)
self.assertTrue(val.IsValid())
self.assertSuccess(val.GetError())
self.DebugSBValue(val)
# Make sure it fails if language is set to C:
options.SetLanguage(lldb.eLanguageTypeC)
val = frame.EvaluateExpression("foo != nullptr", options)
self.assertTrue(val.IsValid())
self.assertFalse(val.GetError().Success())
def test_expr_options_lang(self):
"""These expression language options should work as expected."""
self.build()
# Set debugger into synchronous mode
self.dbg.SetAsync(False)
(target, process, thread, bkpt) = lldbutil.run_to_source_breakpoint(
self, "// breakpoint_in_main", self.main_source_spec
)
frame = thread.GetFrameAtIndex(0)
options = lldb.SBExpressionOptions()
# Make sure we can retrieve `id` variable if language is set to C++11:
options.SetLanguage(lldb.eLanguageTypeC_plus_plus_11)
val = frame.EvaluateExpression("id == 0", options)
self.assertTrue(val.IsValid())
self.assertSuccess(val.GetError())
self.DebugSBValue(val)
# Make sure we can't retrieve `id` variable if language is set to ObjC:
options.SetLanguage(lldb.eLanguageTypeObjC)
val = frame.EvaluateExpression("id == 0", options)
self.assertTrue(val.IsValid())
self.assertFalse(val.GetError().Success())
def test_expr_options_language_options(self):
"""Test SetBooleanLanguageOption/GetBooleanLanguageOption SBAPIs"""
error = lldb.SBError()
options = lldb.SBExpressionOptions()
self.assertFalse(options.GetBooleanLanguageOption("foo", error))
self.assertTrue(error.Fail())
self.assertFalse(options.GetBooleanLanguageOption("bar", error))
self.assertTrue(error.Fail())
self.assertTrue(options.SetBooleanLanguageOption("foo", True).Success())
self.assertTrue(options.SetBooleanLanguageOption("bar", True).Success())
self.assertTrue(options.GetBooleanLanguageOption("foo", error))
self.assertTrue(error.Success())
self.assertTrue(options.GetBooleanLanguageOption("bar", error))
self.assertTrue(error.Success())
self.assertTrue(options.SetBooleanLanguageOption("foo", False).Success())
self.assertTrue(options.SetBooleanLanguageOption("bar", False).Success())
self.assertFalse(options.GetBooleanLanguageOption("foo", error))
self.assertTrue(error.Success())
self.assertFalse(options.GetBooleanLanguageOption("bar", error))
self.assertTrue(error.Success())
self.assertFalse(options.GetBooleanLanguageOption("", error))
self.assertTrue(error.Fail())
self.assertTrue(options.SetBooleanLanguageOption("", True).Fail())
self.assertFalse(options.GetBooleanLanguageOption("", error))
self.assertTrue(error.Fail())
self.assertTrue(options.SetBooleanLanguageOption(None, True).Fail())
self.assertFalse(options.GetBooleanLanguageOption(None, error))
self.assertTrue(error.Fail())