d76566417e
This patch adds a new matching method for data formatters, in addition to the existing exact typename and regex-based matching. The new method allows users to specify the name of a Python callback function that takes a `SBType` object and decides whether the type is a match or not. Here is an overview of the changes performed: - Add a new `eFormatterMatchCallback` matching type, and logic to handle it in `TypeMatcher` and `SBTypeNameSpecifier`. - Extend `FormattersMatchCandidate` instances with a pointer to the current `ScriptInterpreter` and the `TypeImpl` corresponding to the candidate type, so we can run registered callbacks and pass the type to them. All matcher search functions now receive a `FormattersMatchCandidate` instead of a type name. - Add some glue code to ScriptInterpreterPython and the SWIG bindings to allow calling a formatter matching callback. Most of this code is modeled after the equivalent code for watchpoint callback functions. - Add an API test for the new callback-based matching feature. For more context, please check the RFC thread where this feature was originally discussed: https://discourse.llvm.org/t/rfc-python-callback-for-data-formatters-type-matching/64204/11 Differential Revision: https://reviews.llvm.org/D135648
50 lines
1.7 KiB
Python
50 lines
1.7 KiB
Python
"""
|
|
Test lldb data formatter callback-based matching.
|
|
"""
|
|
|
|
import lldb
|
|
from lldbsuite.test.decorators import *
|
|
from lldbsuite.test.lldbtest import *
|
|
from lldbsuite.test import lldbutil
|
|
|
|
|
|
class PythonSynthDataFormatterTestCase(TestBase):
|
|
|
|
def setUp(self):
|
|
# Call super's setUp().
|
|
TestBase.setUp(self)
|
|
# Find the line number to break at.
|
|
self.line = line_number('main.cpp', '// Set break point at this line.')
|
|
|
|
def test_callback_matchers(self):
|
|
"""Test data formatter commands."""
|
|
self.build()
|
|
|
|
_, process, thread, _ = lldbutil.run_to_line_breakpoint(
|
|
self, lldb.SBFileSpec("main.cpp"), self.line)
|
|
|
|
# Print derived without a formatter.
|
|
self.expect("frame variable derived",
|
|
substrs=['x = 2222',
|
|
'y = 3333'])
|
|
|
|
# now set up a summary function that uses a python callback to match
|
|
# classes that derive from `Base`.
|
|
self.runCmd("command script import --allow-reload ./formatters_with_callback.py")
|
|
|
|
# Now `derived` should use our callback summary + synthetic children.
|
|
self.expect("frame variable derived",
|
|
substrs=['hello from callback summary',
|
|
'synthetic_child = 9999'])
|
|
|
|
# But not other classes.
|
|
self.expect("frame variable base", matching=False,
|
|
substrs=['hello from callback summary'])
|
|
self.expect("frame variable base",
|
|
substrs=['x = 1111'])
|
|
|
|
self.expect("frame variable nd", matching=False,
|
|
substrs=['hello from callback summary'])
|
|
self.expect("frame variable nd",
|
|
substrs=['z = 4444'])
|