From 7b51bc51e108b017e45141b15d940514a31260f6 Mon Sep 17 00:00:00 2001 From: Doug Evans Date: Tue, 2 Nov 2010 22:44:13 +0000 Subject: New python module gdb.printing, and new commands info pretty-printer, enable pretty-printer, disable pretty-printer. * NEWS: Mention them. * data-directory/Makefile.in (PYTHON_FILES): Add gdb/printing.py, gdb/command/__init__.py, gdb/command/pretty_printers.py. * python/lib/gdb/__init__.py: Install pretty-printer commands. * python/lib/gdb/printing.py: New file. * python/lib/gdb/command/__init__.py: New file. * python/lib/gdb/command/pretty_printers.py: New file. doc/ * gdb.texinfo (Pretty Printing): Expand into three sections, introduction, example, and commands. (Python API): Delete section Disabling Pretty-Printers, merge into Selecting Pretty-Printers. (Writing a Pretty-Printer): New section. Move the pretty-printer example here, and reformat to match python coding style. Add a second example using the gdb.printing module. (Python modules): Add gdb.printing. testsuite/ * gdb.python/py-pp-maint.c: New file. * gdb.python/py-pp-maint.exp: New file. * gdb.python/py-pp-maint.py: New file. --- gdb/testsuite/gdb.python/py-pp-maint.c | 68 +++++++++++++++++ gdb/testsuite/gdb.python/py-pp-maint.exp | 126 +++++++++++++++++++++++++++++++ gdb/testsuite/gdb.python/py-pp-maint.py | 74 ++++++++++++++++++ 3 files changed, 268 insertions(+) create mode 100644 gdb/testsuite/gdb.python/py-pp-maint.c create mode 100644 gdb/testsuite/gdb.python/py-pp-maint.exp create mode 100644 gdb/testsuite/gdb.python/py-pp-maint.py (limited to 'gdb/testsuite/gdb.python') diff --git a/gdb/testsuite/gdb.python/py-pp-maint.c b/gdb/testsuite/gdb.python/py-pp-maint.c new file mode 100644 index 0000000..e72bd41 --- /dev/null +++ b/gdb/testsuite/gdb.python/py-pp-maint.c @@ -0,0 +1,68 @@ +/* This testcase is part of GDB, the GNU debugger. + + Copyright 2010 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 . */ + +#include + +struct function_lookup_test +{ + int x,y; +}; + +void +init_flt (struct function_lookup_test *p, int x, int y) +{ + p->x = x; + p->y = y; +} + +struct s +{ + int a; + int *b; +}; + +struct ss +{ + struct s a; + struct s b; +}; + +void +init_s (struct s *s, int a) +{ + s->a = a; + s->b = &s->a; +} + +void +init_ss (struct ss *s, int a, int b) +{ + init_s (&s->a, a); + init_s (&s->b, b); +} + +int +main () +{ + struct function_lookup_test flt; + struct ss ss; + + init_flt (&flt, 42, 43); + init_ss (&ss, 1, 2); + + return 0; /* break to inspect */ +} diff --git a/gdb/testsuite/gdb.python/py-pp-maint.exp b/gdb/testsuite/gdb.python/py-pp-maint.exp new file mode 100644 index 0000000..0aa7956 --- /dev/null +++ b/gdb/testsuite/gdb.python/py-pp-maint.exp @@ -0,0 +1,126 @@ +# Copyright (C) 2010 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 . + +# This file is part of the GDB testsuite. It tests Python-based +# pretty-printing for the CLI. + +if $tracelevel then { + strace $tracelevel +} + +if [is_remote host] { + untested "py-pp-maint.exp can only be run locally" + return -1 +} + +load_lib gdb-python.exp + +set testfile "py-pp-maint" +set srcfile ${testfile}.c +set binfile ${objdir}/${subdir}/${testfile} + +# Start with a fresh gdb. +gdb_exit +gdb_start + +# Skip all tests if Python scripting is not enabled. +if { [skip_python_tests] } { continue } + +if { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${binfile}" executable "debug"] != "" } { + untested "Couldn't compile ${srcfile}" + return -1 +} + +gdb_reinitialize_dir $srcdir/$subdir +gdb_load ${binfile} + +if ![runto_main ] then { + fail "Can't run to main" + return -1 +} + +# Ensure sys.path, et.al. are initialized properly. +gdb_check_python_config + +gdb_test "b [gdb_get_line_number {break to inspect} ${testfile}.c ]" \ + ".*Breakpoint.*" +gdb_test "continue" ".*Breakpoint.*" + +set python_file ${srcdir}/${subdir}/${testfile}.py + +gdb_test_no_output "python execfile ('${python_file}')" "" + +gdb_test "info pretty-printer" \ + {.*function_lookup_test.*pp-test.*struct ss.*} + +gdb_test "info pretty-printer global .*function" \ + {.*function_lookup_test.*} + +gdb_test "info pretty-printer .* pp-test" \ + {.*pp-test.*struct ss.*} + +gdb_test "print flt" " = x=<42> y=<43>" \ + "print flt enabled #1" + +gdb_test "print ss" " = a= b=<$hex>> b= b=<$hex>>" \ + "print ss enabled #1" + +gdb_test "disable pretty-printer" \ + "5 printers disabled.*0 of 5 printers enabled" + +gdb_test "disable pretty-printer global" \ + "0 printers disabled.*0 of 5 printers enabled" + +gdb_test "disable pretty-printer global lookup_function_lookup_test" \ + "0 printers disabled.*0 of 5 printers enabled" + +gdb_test "disable pretty-printer global pp-test:.*" \ + "0 printers disabled.*0 of 5 printers enabled" + +gdb_test "info pretty-printer global .*function" \ + {.*function_lookup_test \[disabled\].*} + +gdb_test "info pretty-printer .* pp-test" \ + {.*pp-test.*struct ss \[disabled\].*} + +gdb_test "print flt" " = {x = 42, y = 43}" \ + "print flt disabled" + +gdb_test "print ss" " = {a = {a = 1, b = $hex}, b = {a = 2, b = $hex}}" \ + "print ss disabled" + +gdb_test "enable pretty-printer global lookup_function_lookup_test" \ + "1 printer enabled.*1 of 5 printers enabled" + +# This doesn't enable any printers because each subprinter in the collection +# is still individually disabled. But this is still needed, to enable the +# collection itself. +gdb_test "enable pretty-printer global pp-test" \ + "0 printers enabled.*1 of 5 printers enabled" + +gdb_test "enable pretty-printer global pp-test:.*ss.*" \ + "2 printers enabled.*3 of 5 printers enabled" + +gdb_test "enable pretty-printer global pp-test:.*s.*" \ + "2 printers enabled.*5 of 5 printers enabled" + +gdb_test "info pretty-printer" \ + {.*function_lookup_test.*pp-test.*struct ss.*} + +gdb_test "print flt" " = x=<42> y=<43>" \ + "print flt re-enabled" + +gdb_test "print ss" " = a= b=<$hex>> b= b=<$hex>>" \ + "print ss re-enabled" diff --git a/gdb/testsuite/gdb.python/py-pp-maint.py b/gdb/testsuite/gdb.python/py-pp-maint.py new file mode 100644 index 0000000..5638a42 --- /dev/null +++ b/gdb/testsuite/gdb.python/py-pp-maint.py @@ -0,0 +1,74 @@ +# Copyright (C) 2010 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 . + +# This file is part of the GDB testsuite. It tests python pretty +# printers. + +import re +import gdb.types +import gdb.printing + + +def lookup_function_lookup_test(val): + class PrintFunctionLookup(object): + def __init__(self, val): + self.val = val + + def to_string(self): + return ("x=<" + str(self.val["x"]) + + "> y=<" + str(self.val["y"]) + ">") + + typename = gdb.types.get_basic_type(val.type).tag + # Note: typename could be None. + if typename == "function_lookup_test": + return PrintFunctionLookup(val) + return None + + +class pp_s: + def __init__(self, val): + self.val = val + + def to_string(self): + a = self.val["a"] + b = self.val["b"] + if a.address != b: + raise Exception("&a(%s) != b(%s)" % (str(a.address), str(b))) + return "a=<" + str(self.val["a"]) + "> b=<" + str(self.val["b"]) + ">" + + +class pp_ss: + def __init__(self, val): + self.val = val + + def to_string(self): + return "a=<" + str(self.val["a"]) + "> b=<" + str(self.val["b"]) + ">" + + +def build_pretty_printer(): + pp = gdb.printing.RegexpCollectionPrettyPrinter("pp-test") + + pp.add_printer('struct s', '^struct s$', pp_s) + pp.add_printer('s', '^s$', pp_s) + + # Use a lambda this time to exercise doing things this way. + pp.add_printer('struct ss', '^struct ss$', lambda val: pp_ss(val)) + pp.add_printer('ss', '^ss$', lambda val: pp_ss(val)) + + return pp + + +gdb.printing.register_pretty_printer(gdb, lookup_function_lookup_test) +gdb.printing.register_pretty_printer(gdb, build_pretty_printer()) -- cgit v1.1