mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2024-12-15 04:31:49 +08:00
9f9aa85206
The documentation say that the display_hint method must return a string to serve as a display hint, and then goes on to list some acceptable strings. However, if we don't supply the display_hint method then we get a default display style behaviour and there's currently no way (in the python api) to force this default behaviour. The guile api allows #f to be used in order to force the default display style behaviour, and this is documented. Currently, using None in the python api also forces the default display behaviour. This commit extends the documentation to make returning None from the display_hint method an official mechanism by which the user can get the default display style. I've extended one of the existing tests to cover this case. gdb/doc/ChangeLog: * python.texi (Pretty Printing API): Document use of None for the display_hint. gdb/testsuite/ChangeLog: * gdb.python/py-prettyprint.c (struct container) <is_map_p>: New field. (make_container): Initialise new field. * gdb.python/py-prettyprint.exp: Add new tests. * gdb.python/py-prettyprint.py (class ContainerPrinter) <display_hint>: New method.
202 lines
7.2 KiB
Plaintext
202 lines
7.2 KiB
Plaintext
# Copyright (C) 2008-2019 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/>.
|
|
|
|
# This file is part of the GDB testsuite. It tests Python-based
|
|
# pretty-printing for the CLI.
|
|
|
|
load_lib gdb-python.exp
|
|
|
|
standard_testfile
|
|
|
|
# Start with a fresh gdb.
|
|
gdb_exit
|
|
gdb_start
|
|
|
|
# Skip all tests if Python scripting is not enabled.
|
|
if { [skip_python_tests] } { continue }
|
|
|
|
proc run_lang_tests {exefile lang} {
|
|
global srcdir subdir srcfile testfile hex
|
|
if { [gdb_compile "${srcdir}/${subdir}/${srcfile}" "${exefile}" executable "debug $lang"] != "" } {
|
|
untested "failed to compile in $lang mode"
|
|
return -1
|
|
}
|
|
|
|
set nl "\[\r\n\]+"
|
|
|
|
# Start with a fresh gdb.
|
|
gdb_exit
|
|
gdb_start
|
|
gdb_reinitialize_dir $srcdir/$subdir
|
|
gdb_load ${exefile}
|
|
|
|
if ![runto_main ] then {
|
|
perror "couldn't run to breakpoint"
|
|
return
|
|
}
|
|
|
|
gdb_test_no_output "set print pretty on"
|
|
|
|
gdb_breakpoint [gdb_get_line_number "break to inspect" ${testfile}.c]
|
|
gdb_continue_to_breakpoint "break to inspect" ".*break to inspect.*"
|
|
|
|
|
|
set remote_python_file [gdb_remote_download host \
|
|
${srcdir}/${subdir}/${testfile}.py]
|
|
|
|
gdb_test_no_output "source ${remote_python_file}" "load python file"
|
|
|
|
gdb_test "print ss" " = a=< a=<1> b=<$hex>> b=< a=<2> b=<$hex>>"
|
|
gdb_test "print ssa\[1\]" " = a=< a=<5> b=<$hex>> b=< a=<6> b=<$hex>>"
|
|
gdb_test "print ssa" " = {a=< a=<3> b=<$hex>> b=< a=<4> b=<$hex>>, a=< a=<5> b=<$hex>> b=< a=<6> b=<$hex>>}"
|
|
|
|
gdb_test "print arraystruct" " = {$nl *y = 7, *$nl *x = { a=<23> b=<$hex>, a=<24> b=<$hex>} *$nl *}"
|
|
|
|
# Test that when a pretty-printer returns a gdb.Value in its to_string, we
|
|
# call the pretty-printer of that value too.
|
|
gdb_test "print tsrvw" " = Inner to_string 1989"
|
|
|
|
if {$lang == "c++"} {
|
|
gdb_test "print cps" "= a=<8> b=<$hex>"
|
|
gdb_test "print cpss" " = {$nl *zss = 9, *$nl *s = a=<10> b=<$hex>$nl}"
|
|
gdb_test "print cpssa\[0\]" " = {$nl *zss = 11, *$nl *s = a=<12> b=<$hex>$nl}"
|
|
gdb_test "print cpssa\[1\]" " = {$nl *zss = 13, *$nl *s = a=<14> b=<$hex>$nl}"
|
|
gdb_test "print cpssa" " = {{$nl *zss = 11, *$nl *s = a=<12> b=<$hex>$nl *}, {$nl *zss = 13, *$nl *s = a=<14> b=<$hex>$nl *}}"
|
|
gdb_test "print sss" "= a=<15> b=< a=<8> b=<$hex>>"
|
|
gdb_test "print ref" "= a=<15> b=< a=<8> b=<$hex>>"
|
|
gdb_test "print derived" \
|
|
" = \{.*<Vbase1> = pp class name: Vbase1.*<Vbase2> = \{.*<VirtualTest> = pp value variable is: 1,.*members of Vbase2:.*_vptr.Vbase2 = $hex.*<Vbase3> = \{.*members of Vbase3.*members of Derived:.*value = 2.*"
|
|
gdb_test "print ns " "\"embedded\\\\000null\\\\000string\"" \
|
|
"print ns with default element limit"
|
|
gdb_test_no_output "set print elements 3"
|
|
gdb_test "print ns" "emb\.\.\.." \
|
|
"print ns with element limit of 3"
|
|
gdb_test_no_output "set print elements 10"
|
|
gdb_test "print ns" "embedded\\\\000n\.\.\.." \
|
|
"print ns with element limit of 10"
|
|
gdb_test_no_output "set print elements 200"
|
|
}
|
|
|
|
if { ![is_address_zero_readable] } {
|
|
gdb_test "print ns2" \
|
|
".error reading variable: Cannot access memory at address 0x0."
|
|
}
|
|
|
|
gdb_test "print x" " = \"this is x\""
|
|
gdb_test "print cstring" " = \"const string\""
|
|
|
|
gdb_test "print estring" " = \"embedded x\\\\201\\\\202\\\\203\\\\204\""
|
|
if { ![is_address_zero_readable] } {
|
|
gdb_test "print estring3" \
|
|
" = <error reading variable: Cannot create a lazy string with address 0x0, and a non-zero length.>"
|
|
}
|
|
|
|
gdb_test_no_output "python pp_ls_encoding = 'UTF-8'"
|
|
gdb_test "print estring2" "\"embedded \", <incomplete sequence \\\\302>"
|
|
|
|
gdb_test_no_output "set python print-stack full"
|
|
gdb_test "print hint_error" "Exception: hint failed\r\nhint_error_val"
|
|
|
|
gdb_test "print c" " = container \"container\" with 2 elements = {$nl *.0. = 23,$nl *.1. = 72$nl}" \
|
|
"print c, pretty printing on, default display hint"
|
|
|
|
gdb_test_no_output "set variable c.is_map_p=1"
|
|
gdb_test "print c" " = container \"container\" with 2 elements = \{$nl \\\[23\\\] = 72$nl\}" \
|
|
"print c, pretty printing on, display hint is now map"
|
|
|
|
gdb_test "print nstype" " = {$nl *.0. = 7,$nl *.1. = 42$nl}"
|
|
|
|
gdb_test_no_output "set print pretty off"
|
|
gdb_test "print nstype" " = {.0. = 7, .1. = 42}" \
|
|
"print nstype on one line"
|
|
|
|
# Now we have pretty printing turned off, try printing 'c' again.
|
|
gdb_test "print c" " = container \"container\" with 2 elements = \{\\\[23\\\] = 72\}" \
|
|
"print c, pretty printing off, display hint is now map"
|
|
|
|
gdb_test_no_output "set variable c.is_map_p=0"
|
|
gdb_test "print c" " = container \"container\" with 2 elements = \{\\\[0\\\] = 23, \\\[1\\\] = 72\}" \
|
|
"print c, pretty printing off, default display hint"
|
|
|
|
# Check that GDB doesn't lose typedefs when looking for a printer.
|
|
gdb_test "print an_int" " = -1"
|
|
gdb_test "print (int) an_int" " = -1"
|
|
gdb_test "print (int_type) an_int" " = type=int_type, val=-1"
|
|
|
|
gdb_test "print an_int_type" " = type=int_type, val=1"
|
|
gdb_test "print (int_type) an_int_type" " = type=int_type, val=1"
|
|
|
|
gdb_test "print an_int_type2" " = type=int_type2, val=2"
|
|
gdb_test "print (int) an_int_type2" " = 2"
|
|
gdb_test "print (int_type) an_int_type2" " = type=int_type, val=2"
|
|
gdb_test "print (int_type2) an_int_type2" " = type=int_type2, val=2"
|
|
|
|
# PR python/16047: it is ok for a pretty printer not to have a
|
|
# to_string method.
|
|
gdb_test "print (int_type3) an_int_type2" " = {s = 27}"
|
|
|
|
gdb_continue_to_end
|
|
}
|
|
|
|
with_test_prefix c {
|
|
if { [run_lang_tests "${binfile}" "c"] == -1 } {
|
|
return
|
|
}
|
|
}
|
|
with_test_prefix c++ {
|
|
if { [run_lang_tests "${binfile}-cxx" "c++"] == -1 } {
|
|
return
|
|
}
|
|
}
|
|
|
|
# Run various other tests.
|
|
|
|
# Start with a fresh gdb.
|
|
gdb_exit
|
|
gdb_start
|
|
gdb_reinitialize_dir $srcdir/$subdir
|
|
gdb_load ${binfile}
|
|
|
|
if ![runto_main ] then {
|
|
perror "couldn't run to breakpoint"
|
|
return
|
|
}
|
|
|
|
set remote_python_file [gdb_remote_download host \
|
|
${srcdir}/${subdir}/${testfile}.py]
|
|
|
|
gdb_test_no_output "source ${remote_python_file}" "load python file"
|
|
|
|
gdb_breakpoint [gdb_get_line_number "eval-break"]
|
|
gdb_continue_to_breakpoint "eval-break" ".* eval-break .*"
|
|
|
|
gdb_test "info locals" "eval9 = eval=<123456789>"
|
|
|
|
gdb_breakpoint [gdb_get_line_number "break to inspect" ${testfile}.c ]
|
|
gdb_continue_to_breakpoint "break to inspect" ".*break to inspect.*"
|
|
|
|
gdb_test "print ss" " = a=< a=<1> b=<$hex>> b=< a=<2> b=<$hex>>" \
|
|
"print ss enabled #1"
|
|
|
|
gdb_test_no_output "python disable_lookup_function ()"
|
|
|
|
gdb_test "print ss" " = {a = {a = 1, b = $hex}, b = {a = 2, b = $hex}}" \
|
|
"print ss disabled"
|
|
|
|
gdb_test_no_output "python enable_lookup_function ()"
|
|
|
|
gdb_test "print ss" " = a=< a=<1> b=<$hex>> b=< a=<2> b=<$hex>>" \
|
|
"print ss enabled #2"
|