[RFA/Python] Make regexp collection printers work with typedefs as well.

[RFA/Python] Make regexp collection printers work with typedefs as well.

[Joel Brobecker]

Hello,

Consider the following type for which we would like to provide
a pretty-printer and manage it via RegexpCollectionPrettyPrinter:

        typedef long time_t;

Currently, this does not work because this framework only considers
the type's tag name:

        typename = gdb.types.get_basic_type(val.type).tag
        if not typename:
            return None

This patch extends it to use the type's name if the basic type
does not have a tag name, thus allowing the framework to also
work with typedefs like the above.

gdb/ChangeLog:

        * python/lib/gdb/printing.py (RegexpCollectionPrettyPrinter):
        Use the type's name if its basic type does not have a tag.

gdb/testsuite/ChangeLog:

        * testsuite/gdb.python/py-pp-re-notag.c: New file.
        * testsuite/gdb.python/py-pp-re-notag.ex: New file.
        * testsuite/gdb.python/py-pp-re-notag.p: New file.

Tested on x86_64-linux. OK to commit?

Thanks,
-- 
Joel

---
 gdb/python/lib/gdb/printing.py              |  2 ++
 gdb/testsuite/gdb.python/py-pp-re-notag.c   | 33 ++++++++++++++++++++++++
 gdb/testsuite/gdb.python/py-pp-re-notag.exp | 39 +++++++++++++++++++++++++++++
 gdb/testsuite/gdb.python/py-pp-re-notag.py  | 36 ++++++++++++++++++++++++++
 4 files changed, 110 insertions(+)
 create mode 100644 gdb/testsuite/gdb.python/py-pp-re-notag.c
 create mode 100644 gdb/testsuite/gdb.python/py-pp-re-notag.exp
 create mode 100644 gdb/testsuite/gdb.python/py-pp-re-notag.py

diff --git a/gdb/python/lib/gdb/printing.py b/gdb/python/lib/gdb/printing.py
index 80227c8..2940b93 100644
--- a/gdb/python/lib/gdb/printing.py
+++ b/gdb/python/lib/gdb/printing.py
@@ -200,6 +200,8 @@ class RegexpCollectionPrettyPrinter(PrettyPrinter):
         # Get the type name.
         typename = gdb.types.get_basic_type(val.type).tag
         if not typename:
+            typename = val.type.name
+        if not typename:
             return None
 
         # Iterate over table of type regexps to determine
diff --git a/gdb/testsuite/gdb.python/py-pp-re-notag.c b/gdb/testsuite/gdb.python/py-pp-re-notag.c
new file mode 100644
index 0000000..a5fe8c3
--- /dev/null
+++ b/gdb/testsuite/gdb.python/py-pp-re-notag.c
@@ -0,0 +1,33 @@
+/* This testcase is part of GDB, the GNU debugger.
+
+   Copyright 2013-2014 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/>.  */
+
+typedef long time_t;
+
+static void
+tick_tock (time_t *t)
+{
+  *t++;
+}
+
+int
+main (void)
+{
+  time_t current_time = 1384395743;
+
+  tick_tock (&current_time);
+  return 0;
+}
diff --git a/gdb/testsuite/gdb.python/py-pp-re-notag.exp b/gdb/testsuite/gdb.python/py-pp-re-notag.exp
new file mode 100644
index 0000000..8149bde
--- /dev/null
+++ b/gdb/testsuite/gdb.python/py-pp-re-notag.exp
@@ -0,0 +1,39 @@
+# Copyright (C) 2013-2014 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/>.
+
+standard_testfile
+
+if { [prepare_for_testing ${testfile}.exp ${testfile} ${srcfile}] } {
+    return -1
+}
+
+# Skip all tests if Python scripting is not enabled.
+if { [skip_python_tests] } { continue }
+
+if ![runto tick_tock] {
+    return -1
+}
+
+set remote_python_file [gdb_remote_download host \
+			    ${srcdir}/${subdir}/${testfile}.py]
+
+gdb_test_no_output "source ${remote_python_file}" \
+    "source ${testfile}.py"
+
+gdb_test "print *t" " = Thu Nov 14 02:22:23 2013 \\(1384395743\\)"
+
+gdb_test "print /r *t" "= 1384395743"
+
+remote_file host delete ${remote_python_file}
diff --git a/gdb/testsuite/gdb.python/py-pp-re-notag.py b/gdb/testsuite/gdb.python/py-pp-re-notag.py
new file mode 100644
index 0000000..0aa0c32
--- /dev/null
+++ b/gdb/testsuite/gdb.python/py-pp-re-notag.py
@@ -0,0 +1,36 @@
+# Copyright (C) 2013-2014 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/>.
+
+from time import asctime, gmtime
+import gdb  # silence pyflakes
+
+
+class TimePrinter:
+    def __init__(self, val):
+        self.val = val
+
+    def to_string(self):
+        secs = int(self.val)
+        return "%s (%d)" % (asctime(gmtime(secs)), secs)
+
+
+def build_pretty_printer():
+    pp = gdb.printing.RegexpCollectionPrettyPrinter("pp-notag")
+    pp.add_printer('time_t', 'time_t', TimePrinter)
+    return pp
+
+
+my_pretty_printer = build_pretty_printer()
+gdb.printing.register_pretty_printer(gdb, my_pretty_printer)
-- 
1.8.3.2

PING: [RFA/Python] Make regexp collection printers work with typedefs as well.

[Joel Brobecker]

Ping?

Thank you!

On Thu, Jan 30, 2014 at 07:44:56AM +0400, Joel Brobecker wrote:
> Hello,
> 
> Consider the following type for which we would like to provide
> a pretty-printer and manage it via RegexpCollectionPrettyPrinter:
> 
>         typedef long time_t;
> 
> Currently, this does not work because this framework only considers
> the type's tag name:
> 
>         typename = gdb.types.get_basic_type(val.type).tag
>         if not typename:
>             return None
> 
> This patch extends it to use the type's name if the basic type
> does not have a tag name, thus allowing the framework to also
> work with typedefs like the above.
> 
> gdb/ChangeLog:
> 
>         * python/lib/gdb/printing.py (RegexpCollectionPrettyPrinter):
>         Use the type's name if its basic type does not have a tag.
> 
> gdb/testsuite/ChangeLog:
> 
>         * testsuite/gdb.python/py-pp-re-notag.c: New file.
>         * testsuite/gdb.python/py-pp-re-notag.ex: New file.
>         * testsuite/gdb.python/py-pp-re-notag.p: New file.
> 
> Tested on x86_64-linux. OK to commit?
> 
> Thanks,
> -- 
> Joel
> 
> ---
>  gdb/python/lib/gdb/printing.py              |  2 ++
>  gdb/testsuite/gdb.python/py-pp-re-notag.c   | 33 ++++++++++++++++++++++++
>  gdb/testsuite/gdb.python/py-pp-re-notag.exp | 39 +++++++++++++++++++++++++++++
>  gdb/testsuite/gdb.python/py-pp-re-notag.py  | 36 ++++++++++++++++++++++++++
>  4 files changed, 110 insertions(+)
>  create mode 100644 gdb/testsuite/gdb.python/py-pp-re-notag.c
>  create mode 100644 gdb/testsuite/gdb.python/py-pp-re-notag.exp
>  create mode 100644 gdb/testsuite/gdb.python/py-pp-re-notag.py
> 
> diff --git a/gdb/python/lib/gdb/printing.py b/gdb/python/lib/gdb/printing.py
> index 80227c8..2940b93 100644
> --- a/gdb/python/lib/gdb/printing.py
> +++ b/gdb/python/lib/gdb/printing.py
> @@ -200,6 +200,8 @@ class RegexpCollectionPrettyPrinter(PrettyPrinter):
>          # Get the type name.
>          typename = gdb.types.get_basic_type(val.type).tag
>          if not typename:
> +            typename = val.type.name
> +        if not typename:
>              return None
>  
>          # Iterate over table of type regexps to determine
> diff --git a/gdb/testsuite/gdb.python/py-pp-re-notag.c b/gdb/testsuite/gdb.python/py-pp-re-notag.c
> new file mode 100644
> index 0000000..a5fe8c3
> --- /dev/null
> +++ b/gdb/testsuite/gdb.python/py-pp-re-notag.c
> @@ -0,0 +1,33 @@
> +/* This testcase is part of GDB, the GNU debugger.
> +
> +   Copyright 2013-2014 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/>.  */
> +
> +typedef long time_t;
> +
> +static void
> +tick_tock (time_t *t)
> +{
> +  *t++;
> +}
> +
> +int
> +main (void)
> +{
> +  time_t current_time = 1384395743;
> +
> +  tick_tock (&current_time);
> +  return 0;
> +}
> diff --git a/gdb/testsuite/gdb.python/py-pp-re-notag.exp b/gdb/testsuite/gdb.python/py-pp-re-notag.exp
> new file mode 100644
> index 0000000..8149bde
> --- /dev/null
> +++ b/gdb/testsuite/gdb.python/py-pp-re-notag.exp
> @@ -0,0 +1,39 @@
> +# Copyright (C) 2013-2014 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/>.
> +
> +standard_testfile
> +
> +if { [prepare_for_testing ${testfile}.exp ${testfile} ${srcfile}] } {
> +    return -1
> +}
> +
> +# Skip all tests if Python scripting is not enabled.
> +if { [skip_python_tests] } { continue }
> +
> +if ![runto tick_tock] {
> +    return -1
> +}
> +
> +set remote_python_file [gdb_remote_download host \
> +			    ${srcdir}/${subdir}/${testfile}.py]
> +
> +gdb_test_no_output "source ${remote_python_file}" \
> +    "source ${testfile}.py"
> +
> +gdb_test "print *t" " = Thu Nov 14 02:22:23 2013 \\(1384395743\\)"
> +
> +gdb_test "print /r *t" "= 1384395743"
> +
> +remote_file host delete ${remote_python_file}
> diff --git a/gdb/testsuite/gdb.python/py-pp-re-notag.py b/gdb/testsuite/gdb.python/py-pp-re-notag.py
> new file mode 100644
> index 0000000..0aa0c32
> --- /dev/null
> +++ b/gdb/testsuite/gdb.python/py-pp-re-notag.py
> @@ -0,0 +1,36 @@
> +# Copyright (C) 2013-2014 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/>.
> +
> +from time import asctime, gmtime
> +import gdb  # silence pyflakes
> +
> +
> +class TimePrinter:
> +    def __init__(self, val):
> +        self.val = val
> +
> +    def to_string(self):
> +        secs = int(self.val)
> +        return "%s (%d)" % (asctime(gmtime(secs)), secs)
> +
> +
> +def build_pretty_printer():
> +    pp = gdb.printing.RegexpCollectionPrettyPrinter("pp-notag")
> +    pp.add_printer('time_t', 'time_t', TimePrinter)
> +    return pp
> +
> +
> +my_pretty_printer = build_pretty_printer()
> +gdb.printing.register_pretty_printer(gdb, my_pretty_printer)
> -- 
> 1.8.3.2

-- 
Joel

Re: [RFA/Python] Make regexp collection printers work with typedefs as well.

[Joel Brobecker]

Ping!

Thank you :)

On Thu, Jan 30, 2014 at 07:44:56AM +0400, Joel Brobecker wrote:
> Hello,
> 
> Consider the following type for which we would like to provide
> a pretty-printer and manage it via RegexpCollectionPrettyPrinter:
> 
>         typedef long time_t;
> 
> Currently, this does not work because this framework only considers
> the type's tag name:
> 
>         typename = gdb.types.get_basic_type(val.type).tag
>         if not typename:
>             return None
> 
> This patch extends it to use the type's name if the basic type
> does not have a tag name, thus allowing the framework to also
> work with typedefs like the above.
> 
> gdb/ChangeLog:
> 
>         * python/lib/gdb/printing.py (RegexpCollectionPrettyPrinter):
>         Use the type's name if its basic type does not have a tag.
> 
> gdb/testsuite/ChangeLog:
> 
>         * testsuite/gdb.python/py-pp-re-notag.c: New file.
>         * testsuite/gdb.python/py-pp-re-notag.ex: New file.
>         * testsuite/gdb.python/py-pp-re-notag.p: New file.
> 
> Tested on x86_64-linux. OK to commit?
> 
> Thanks,
> -- 
> Joel
> 
> ---
>  gdb/python/lib/gdb/printing.py              |  2 ++
>  gdb/testsuite/gdb.python/py-pp-re-notag.c   | 33 ++++++++++++++++++++++++
>  gdb/testsuite/gdb.python/py-pp-re-notag.exp | 39 +++++++++++++++++++++++++++++
>  gdb/testsuite/gdb.python/py-pp-re-notag.py  | 36 ++++++++++++++++++++++++++
>  4 files changed, 110 insertions(+)
>  create mode 100644 gdb/testsuite/gdb.python/py-pp-re-notag.c
>  create mode 100644 gdb/testsuite/gdb.python/py-pp-re-notag.exp
>  create mode 100644 gdb/testsuite/gdb.python/py-pp-re-notag.py
> 
> diff --git a/gdb/python/lib/gdb/printing.py b/gdb/python/lib/gdb/printing.py
> index 80227c8..2940b93 100644
> --- a/gdb/python/lib/gdb/printing.py
> +++ b/gdb/python/lib/gdb/printing.py
> @@ -200,6 +200,8 @@ class RegexpCollectionPrettyPrinter(PrettyPrinter):
>          # Get the type name.
>          typename = gdb.types.get_basic_type(val.type).tag
>          if not typename:
> +            typename = val.type.name
> +        if not typename:
>              return None
>  
>          # Iterate over table of type regexps to determine
> diff --git a/gdb/testsuite/gdb.python/py-pp-re-notag.c b/gdb/testsuite/gdb.python/py-pp-re-notag.c
> new file mode 100644
> index 0000000..a5fe8c3
> --- /dev/null
> +++ b/gdb/testsuite/gdb.python/py-pp-re-notag.c
> @@ -0,0 +1,33 @@
> +/* This testcase is part of GDB, the GNU debugger.
> +
> +   Copyright 2013-2014 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/>.  */
> +
> +typedef long time_t;
> +
> +static void
> +tick_tock (time_t *t)
> +{
> +  *t++;
> +}
> +
> +int
> +main (void)
> +{
> +  time_t current_time = 1384395743;
> +
> +  tick_tock (&current_time);
> +  return 0;
> +}
> diff --git a/gdb/testsuite/gdb.python/py-pp-re-notag.exp b/gdb/testsuite/gdb.python/py-pp-re-notag.exp
> new file mode 100644
> index 0000000..8149bde
> --- /dev/null
> +++ b/gdb/testsuite/gdb.python/py-pp-re-notag.exp
> @@ -0,0 +1,39 @@
> +# Copyright (C) 2013-2014 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/>.
> +
> +standard_testfile
> +
> +if { [prepare_for_testing ${testfile}.exp ${testfile} ${srcfile}] } {
> +    return -1
> +}
> +
> +# Skip all tests if Python scripting is not enabled.
> +if { [skip_python_tests] } { continue }
> +
> +if ![runto tick_tock] {
> +    return -1
> +}
> +
> +set remote_python_file [gdb_remote_download host \
> +			    ${srcdir}/${subdir}/${testfile}.py]
> +
> +gdb_test_no_output "source ${remote_python_file}" \
> +    "source ${testfile}.py"
> +
> +gdb_test "print *t" " = Thu Nov 14 02:22:23 2013 \\(1384395743\\)"
> +
> +gdb_test "print /r *t" "= 1384395743"
> +
> +remote_file host delete ${remote_python_file}
> diff --git a/gdb/testsuite/gdb.python/py-pp-re-notag.py b/gdb/testsuite/gdb.python/py-pp-re-notag.py
> new file mode 100644
> index 0000000..0aa0c32
> --- /dev/null
> +++ b/gdb/testsuite/gdb.python/py-pp-re-notag.py
> @@ -0,0 +1,36 @@
> +# Copyright (C) 2013-2014 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/>.
> +
> +from time import asctime, gmtime
> +import gdb  # silence pyflakes
> +
> +
> +class TimePrinter:
> +    def __init__(self, val):
> +        self.val = val
> +
> +    def to_string(self):
> +        secs = int(self.val)
> +        return "%s (%d)" % (asctime(gmtime(secs)), secs)
> +
> +
> +def build_pretty_printer():
> +    pp = gdb.printing.RegexpCollectionPrettyPrinter("pp-notag")
> +    pp.add_printer('time_t', 'time_t', TimePrinter)
> +    return pp
> +
> +
> +my_pretty_printer = build_pretty_printer()
> +gdb.printing.register_pretty_printer(gdb, my_pretty_printer)
> -- 
> 1.8.3.2

-- 
Joel

Re: [RFA/Python] Make regexp collection printers work with typedefs as well.

[Phil Muldoon]

On 17/02/14 20:20, Joel Brobecker wrote:
> Ping!
>
> Thank you :)

I looked at this patch and I have no objections to it.  I don't have
the ability to say yes or no, but I think it is fine to go in to git
head.

If nobody else replies, I would just check it in under the global
maintainer rule.

Cheers,

Phil

Pushed: [RFA/Python] Make regexp collection printers work with typedefs as well.

[Joel Brobecker]

> gdb/ChangeLog:
> 
>         * python/lib/gdb/printing.py (RegexpCollectionPrettyPrinter):
>         Use the type's name if its basic type does not have a tag.
> 
> gdb/testsuite/ChangeLog:
> 
>         * testsuite/gdb.python/py-pp-re-notag.c: New file.
>         * testsuite/gdb.python/py-pp-re-notag.ex: New file.
>         * testsuite/gdb.python/py-pp-re-notag.p: New file.

FYI: I've pushed this patch.

Thank you,
-- 
Joel