[Lldb-commits] [lldb] 82af559 - [API] add GetSyntheticValue (#95959)
via lldb-commits
lldb-commits at lists.llvm.org
Mon Jul 15 08:29:00 PDT 2024
Author: Vincent Belliard
Date: 2024-07-15T17:28:56+02:00
New Revision: 82af55983d75d4a821b76ee926b19725ec7fa889
URL: https://github.com/llvm/llvm-project/commit/82af55983d75d4a821b76ee926b19725ec7fa889
DIFF: https://github.com/llvm/llvm-project/commit/82af55983d75d4a821b76ee926b19725ec7fa889.diff
LOG: [API] add GetSyntheticValue (#95959)
Adds GetSyntheticValue to the API on top of GetNonSyntheticValue.
---------
Co-authored-by: Vincent Belliard <v-bulle at github.com>
Added:
Modified:
lldb/include/lldb/API/SBValue.h
lldb/source/API/SBValue.cpp
lldb/test/API/python_api/formatters/TestFormattersSBAPI.py
lldb/test/API/python_api/formatters/main.cpp
lldb/test/API/python_api/formatters/synth.py
Removed:
################################################################################
diff --git a/lldb/include/lldb/API/SBValue.h b/lldb/include/lldb/API/SBValue.h
index 65920c76df7a8..bec816fb45184 100644
--- a/lldb/include/lldb/API/SBValue.h
+++ b/lldb/include/lldb/API/SBValue.h
@@ -89,6 +89,8 @@ class LLDB_API SBValue {
lldb::SBValue GetNonSyntheticValue();
+ lldb::SBValue GetSyntheticValue();
+
lldb::DynamicValueType GetPreferDynamicValue();
void SetPreferDynamicValue(lldb::DynamicValueType use_dynamic);
diff --git a/lldb/source/API/SBValue.cpp b/lldb/source/API/SBValue.cpp
index 10a691c403419..96670481eca3f 100644
--- a/lldb/source/API/SBValue.cpp
+++ b/lldb/source/API/SBValue.cpp
@@ -764,6 +764,21 @@ lldb::SBValue SBValue::GetNonSyntheticValue() {
return value_sb;
}
+lldb::SBValue SBValue::GetSyntheticValue() {
+ LLDB_INSTRUMENT_VA(this);
+
+ SBValue value_sb;
+ if (IsValid()) {
+ ValueImplSP proxy_sp(new ValueImpl(m_opaque_sp->GetRootSP(),
+ m_opaque_sp->GetUseDynamic(), true));
+ value_sb.SetSP(proxy_sp);
+ if (!value_sb.IsSynthetic()) {
+ return {};
+ }
+ }
+ return value_sb;
+}
+
lldb::DynamicValueType SBValue::GetPreferDynamicValue() {
LLDB_INSTRUMENT_VA(this);
diff --git a/lldb/test/API/python_api/formatters/TestFormattersSBAPI.py b/lldb/test/API/python_api/formatters/TestFormattersSBAPI.py
index 7e802f92da352..c01c466b70c82 100644
--- a/lldb/test/API/python_api/formatters/TestFormattersSBAPI.py
+++ b/lldb/test/API/python_api/formatters/TestFormattersSBAPI.py
@@ -143,6 +143,19 @@ def cleanup():
self.dbg.GetCategory("JASSynth").SetEnabled(True)
self.expect("frame variable foo", matching=True, substrs=["X = 1"])
+ self.dbg.GetCategory("CCCSynth2").SetEnabled(True)
+ self.expect(
+ "frame variable ccc",
+ matching=True,
+ substrs=[
+ "CCC object with leading synthetic value (int) b = 222",
+ "a = 111",
+ "b = 222",
+ "c = 333",
+ ],
+ )
+ self.dbg.GetCategory("CCCSynth2").SetEnabled(False)
+
self.dbg.GetCategory("CCCSynth").SetEnabled(True)
self.expect(
"frame variable ccc",
@@ -155,6 +168,15 @@ def cleanup():
],
)
+ self.dbg.GetCategory("BarIntSynth").SetEnabled(True)
+ self.expect(
+ "frame variable bar_int",
+ matching=True,
+ substrs=[
+ "(int) bar_int = 20 bar_int synthetic: No value",
+ ],
+ )
+
foo_var = (
self.dbg.GetSelectedTarget()
.GetProcess()
diff --git a/lldb/test/API/python_api/formatters/main.cpp b/lldb/test/API/python_api/formatters/main.cpp
index f21c956144c29..50c29657a09a9 100644
--- a/lldb/test/API/python_api/formatters/main.cpp
+++ b/lldb/test/API/python_api/formatters/main.cpp
@@ -52,6 +52,8 @@ int main(int argc, char const *argv[]) {
CCC ccc = {111, 222, 333};
+ int bar_int = 20;
+
Empty1 e1;
Empty2 e2;
diff --git a/lldb/test/API/python_api/formatters/synth.py b/lldb/test/API/python_api/formatters/synth.py
index 474c18bc62ebd..91afb26af8436 100644
--- a/lldb/test/API/python_api/formatters/synth.py
+++ b/lldb/test/API/python_api/formatters/synth.py
@@ -29,11 +29,28 @@ def ccc_summary(sbvalue, internal_dict):
# This tests that the SBValue.GetNonSyntheticValue() actually returns a
# non-synthetic value. If it does not, then sbvalue.GetChildMemberWithName("a")
# in the following statement will call the 'get_child_index' method of the
- # synthetic child provider CCCSynthProvider below (which raises an
- # exception).
+ # synthetic child provider CCCSynthProvider below (which return the "b" field").
return "CCC object with leading value " + str(sbvalue.GetChildMemberWithName("a"))
+def ccc_synthetic(sbvalue, internal_dict):
+ sbvalue = sbvalue.GetSyntheticValue()
+ # This tests that the SBValue.GetSyntheticValue() actually returns a
+ # synthetic value. If it does, then sbvalue.GetChildMemberWithName("a")
+ # in the following statement will call the 'get_child_index' method of the
+ # synthetic child provider CCCSynthProvider below (which return the "b" field").
+ return "CCC object with leading synthetic value " + str(
+ sbvalue.GetChildMemberWithName("a")
+ )
+
+
+def bar_int_synthetic(sbvalue, internal_dict):
+ sbvalue = sbvalue.GetSyntheticValue()
+ # This tests that the SBValue.GetSyntheticValue() actually returns no
+ # value when the value has no synthetic representation.
+ return "bar_int synthetic: " + str(sbvalue)
+
+
class CCCSynthProvider(object):
def __init__(self, sbvalue, internal_dict):
self._sbvalue = sbvalue
@@ -42,6 +59,9 @@ def num_children(self):
return 3
def get_child_index(self, name):
+ if name == "a":
+ # Return b for test.
+ return 1
raise RuntimeError("I don't want to be called!")
def get_child_at_index(self, index):
@@ -119,3 +139,23 @@ def __lldb_init_module(debugger, dict):
"synth.empty2_summary", lldb.eTypeOptionHideEmptyAggregates
),
)
+ cat2 = debugger.CreateCategory("CCCSynth2")
+ cat2.AddTypeSynthetic(
+ lldb.SBTypeNameSpecifier("CCC"),
+ lldb.SBTypeSynthetic.CreateWithClassName(
+ "synth.CCCSynthProvider", lldb.eTypeOptionCascade
+ ),
+ )
+ cat2.AddTypeSummary(
+ lldb.SBTypeNameSpecifier("CCC"),
+ lldb.SBTypeSummary.CreateWithFunctionName(
+ "synth.ccc_synthetic", lldb.eTypeOptionCascade
+ ),
+ )
+ cat3 = debugger.CreateCategory("BarIntSynth")
+ cat3.AddTypeSummary(
+ lldb.SBTypeNameSpecifier("int"),
+ lldb.SBTypeSummary.CreateWithFunctionName(
+ "synth.bar_int_synthetic", lldb.eTypeOptionCascade
+ ),
+ )
More information about the lldb-commits
mailing list