diff mbox series

[1/4] Allow pretty-printer 'children' method to return strings

Message ID 20230901-varobj-fixes-v1-1-b9a1f8139ca7@adacore.com
State New
Headers
Series Fix two varobj bugs |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_gdb_build--master-arm success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-arm success Testing passed

Commit Message

Tom Tromey Sept. 1, 2023, 2:47 p.m. UTC 
  A user noticed that, while a pretty-printer can return Python strings
from its "children" method, this does not really work for MI.  I
tracked this down to my_value_of_variable calling into
c_value_of_variable, which specially handles arrays and structures --
not using the actual contents of the string.

Now, this part of MI seems bad to me, but rather than change that,
this applies the fix to only dynamic varobjs, which is the only
scenario where a string like this can really be returned.

Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=18282
---
 gdb/testsuite/gdb.python/py-varobj.c   | 26 ++++++++++++++++++
 gdb/testsuite/gdb.python/py-varobj.exp | 49 ++++++++++++++++++++++++++++++++++
 gdb/testsuite/gdb.python/py-varobj.py  | 35 ++++++++++++++++++++++++
 gdb/varobj.c                           |  3 +++
 4 files changed, 113 insertions(+)
diff mbox series

Patch

diff --git a/gdb/testsuite/gdb.python/py-varobj.c b/gdb/testsuite/gdb.python/py-varobj.c
new file mode 100644
index 00000000000..894ce8fca06
--- /dev/null
+++ b/gdb/testsuite/gdb.python/py-varobj.c
@@ -0,0 +1,26 @@ 
+/* This testcase is part of GDB, the GNU debugger.
+
+   Copyright 2023 Free Software Foundation, Inc.
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+struct test {
+  int x;
+};
+
+struct test tval = {23};
+
+int main () {
+  return 0;
+}
diff --git a/gdb/testsuite/gdb.python/py-varobj.exp b/gdb/testsuite/gdb.python/py-varobj.exp
new file mode 100644
index 00000000000..0e0978352a5
--- /dev/null
+++ b/gdb/testsuite/gdb.python/py-varobj.exp
@@ -0,0 +1,49 @@ 
+# Copyright (C) 2023 Free Software Foundation, Inc.
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Some varobj tests involving pretty-printers
+
+load_lib mi-support.exp
+set MIFLAGS "-i=mi"
+
+require allow_python_tests
+
+standard_testfile
+
+if {[gdb_compile "$srcdir/$subdir/$srcfile" $binfile executable {debug}] != ""} {
+    return -1
+}
+
+mi_clean_restart $binfile
+
+set pyfile [gdb_remote_download host ${srcdir}/${subdir}/${testfile}.py]
+mi_gdb_test "source ${pyfile}" \
+  ".*\\^done" \
+  "load python file"
+
+mi_gdb_test "-enable-pretty-printing" \
+  "\\^done" \
+  "-enable-pretty-printing"
+
+mi_gdb_test "set python print-stack full" \
+  ".*\\^done" \
+  "set python print-stack full"
+
+mi_runto_main
+
+mi_gdb_test "-var-create tval * tval" \
+   "\\^done.*"
+
+mi_gdb_test "-var-list-children --all-values tval" \
+    ".*value=.*flicker.*"
diff --git a/gdb/testsuite/gdb.python/py-varobj.py b/gdb/testsuite/gdb.python/py-varobj.py
new file mode 100644
index 00000000000..bc31a198297
--- /dev/null
+++ b/gdb/testsuite/gdb.python/py-varobj.py
@@ -0,0 +1,35 @@ 
+# Copyright (C) 2023 Free Software Foundation, Inc.
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import gdb.printing
+
+
+class TestPrinter:
+    def __init__(self, val):
+        self.val = val
+
+    def to_string(self):
+        return "map"
+
+    def children(self):
+        yield "1", "flicker"
+
+
+def str_lookup_function(val):
+    lookup_tag = val.type.tag
+    if lookup_tag == "test":
+        return TestPrinter(val)
+
+
+gdb.printing.register_pretty_printer(None, str_lookup_function)
diff --git a/gdb/varobj.c b/gdb/varobj.c
index e7323bed127..52e62aca265 100644
--- a/gdb/varobj.c
+++ b/gdb/varobj.c
@@ -2117,6 +2117,9 @@  my_value_of_variable (struct varobj *var, enum varobj_display_formats format)
       if (var->dynamic->pretty_printer != NULL)
 	return varobj_value_get_print_value (var->value.get (), var->format,
 					     var);
+      else if (var->parent != nullptr && varobj_is_dynamic_p (var->parent))
+	return var->print_value;
+
       return (*var->root->lang_ops->value_of_variable) (var, format);
     }
   else