Re: [PATCH 4/6] Add `set print repeats' tests for C/C++ arrays

[Andrew Burgess <aburgess@redhat.com>]

* Maciej W. Rozycki <macro@embecosm.com> [2021-12-11 11:47:34 +0000]:

> Add `set print repeats' tests for C/C++ arrays, complementing one for 
> Fortran arrays and covering the different interpretation of the `set 
> print elements' setting in particular where the per-dimension count of 
> the elements handled is matched against the trigger rather than the 
> total element count as with Fortran arrays.

I know we disagree on this topic, but I would, one day, like to see
the C/C++ array printing behave as the Fortran array printing does, as
that makes much more sense to me.

But, adding tests for GDB's current behaviour is definitely a good
thing, so I'm happy to see this going in, with one change...

Given that the C and C++ tests are almost identical, I think you
should consider just adding one copy in gdb.base and compiling it as
both C and C++.

For inspiration you can look at these files:

  gdb/testsuite/gdb.base/infcall-nested-structs-c.exp
  gdb/testsuite/gdb.base/infcall-nested-structs-c++.exp
  gdb/testsuite/gdb.base/infcall-nested-structs.exp.tcl

Thanks,
Andrew

> ---
>  gdb/testsuite/gdb.base/array-repeat.c   |   63 ++++++++++++++
>  gdb/testsuite/gdb.base/array-repeat.exp |  137 +++++++++++++++++++++++++++++++
>  gdb/testsuite/gdb.cp/array-repeat.cc    |   64 ++++++++++++++
>  gdb/testsuite/gdb.cp/array-repeat.exp   |  139 ++++++++++++++++++++++++++++++++
>  4 files changed, 403 insertions(+)
>  create mode 100644 gdb/testsuite/gdb.fortran/array-repeat.exp
>  create mode 100644 gdb/testsuite/gdb.fortran/array-repeat.f90
> 
> gdb-set-print-repeats-test.diff
> Index: src/gdb/testsuite/gdb.base/array-repeat.c
> ===================================================================
> --- /dev/null
> +++ src/gdb/testsuite/gdb.base/array-repeat.c
> @@ -0,0 +1,63 @@
> +/* Copyright 2021 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/>.  */
> +
> +#include <stdio.h>
> +
> +int
> +main (void)
> +{
> +  int array_1d[5];
> +  int array_1d9[6];
> +  int array_2d[5][5];
> +  int array_2d9[6][6];
> +  int array_3d[5][5][5];
> +  int array_3d9[6][6][6];
> +  int i;
> +
> +  for (i = 0; i < sizeof (array_1d) / sizeof (int); i++)
> +    *(array_1d + i) = 1;
> +  for (i = 0; i < sizeof (array_1d9) / sizeof (int); i++)
> +    *(array_1d9 + i) = i % 6 == 5 ? 9 : 1;
> +  for (i = 0; i < sizeof (array_2d) / sizeof (int); i++)
> +    *(*array_2d + i) = 2;
> +  for (i = 0; i < sizeof (array_2d9) / sizeof (int); i++)
> +    *(*array_2d9 + i) = i / 6 == 5 || i % 6 == 5 ? 9 : 2;
> +  for (i = 0; i < sizeof (array_3d) / sizeof (int); i++)
> +    *(**array_3d + i) = 3;
> +  for (i = 0; i < sizeof (array_3d9) / sizeof (int); i++)
> +    *(**array_3d9 + i) = i / 6 / 6 == 5 || i / 6 % 6 == 5 || i % 6 == 5 ? 9 : 3;
> +
> +  printf("\n");						/* Break here */
> +  for (i = 0; i < sizeof (array_1d) / sizeof (int); i++)
> +    printf(" %d", *(array_1d + i));
> +  printf("\n");
> +  for (i = 0; i < sizeof (array_1d9) / sizeof (int); i++)
> +    printf(" %d", *(array_1d9 + i));
> +  printf("\n");
> +  for (i = 0; i < sizeof (array_2d) / sizeof (int); i++)
> +    printf(" %d", *(*array_2d + i));
> +  printf("\n");
> +  for (i = 0; i < sizeof (array_2d9) / sizeof (int); i++)
> +    printf(" %d", *(*array_2d9 + i));
> +  printf("\n");
> +  for (i = 0; i < sizeof (array_3d) / sizeof (int); i++)
> +    printf(" %d", *(**array_3d + i));
> +  printf("\n");
> +  for (i = 0; i < sizeof (array_3d9) / sizeof (int); i++)
> +    printf(" %d", *(**array_3d9 + i));
> +  printf("\n");
> +
> +  return 0;
> +}
> Index: src/gdb/testsuite/gdb.base/array-repeat.exp
> ===================================================================
> --- /dev/null
> +++ src/gdb/testsuite/gdb.base/array-repeat.exp
> @@ -0,0 +1,137 @@
> +# Copyright 2021 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/>.
> +
> +# Test the detection and printing of repeated elements in C arrays.
> +
> +standard_testfile .c
> +
> +if {[prepare_for_testing ${testfile}.exp ${testfile} ${srcfile} {debug}]} {
> +    return -1
> +}
> +
> +if {![runto_main]} {
> +    perror "Could not run to main."
> +    continue
> +}
> +
> +gdb_breakpoint [gdb_get_line_number "Break here"]
> +gdb_continue_to_breakpoint "Break here"
> +
> +# Build up the expected output for each array.
> +set a9p9o "{9, 9, 9, 9, 9, 9}"
> +set a1p   "{1, 1, 1, 1, 1}"
> +set a1p9  "{1, 1, 1, 1, 1, 9}"
> +set a2po  "{2, 2, 2, 2, 2}"
> +set a2p   "{${a2po}, ${a2po}, ${a2po}, ${a2po}, ${a2po}}"
> +set a2p9o "{2, 2, 2, 2, 2, 9}"
> +set a2p9  "{${a2p9o}, ${a2p9o}, ${a2p9o}, ${a2p9o}, ${a2p9o}, ${a9p9o}}"
> +set a3po  "{3, 3, 3, 3, 3}"
> +set a3p   "{${a3po}, ${a3po}, ${a3po}, ${a3po}, ${a3po}}"
> +set a3p   "{${a3p}, ${a3p}, ${a3p}, ${a3p}, ${a3p}}"
> +set a3p9o "{3, 3, 3, 3, 3, 9}"
> +set a3p9  "{${a3p9o}, ${a3p9o}, ${a3p9o}, ${a3p9o}, ${a3p9o}, ${a9p9o}}"
> +set a9p9  "{${a9p9o}, ${a9p9o}, ${a9p9o}, ${a9p9o}, ${a9p9o}, ${a9p9o}}"
> +set a3p9  "{${a3p9}, ${a3p9}, ${a3p9}, ${a3p9}, ${a3p9}, ${a9p9}}"
> +
> +# Convert the output into a regexp.
> +set r1p   [string_to_regexp $a1p]
> +set r1p9  [string_to_regexp $a1p9]
> +set r2po  [string_to_regexp $a2po]
> +set r2p9o [string_to_regexp $a2p9o]
> +set r2p   [string_to_regexp $a2p]
> +set r2p9  [string_to_regexp $a2p9]
> +set r3po  [string_to_regexp $a3po]
> +set r3p9o [string_to_regexp $a3p9o]
> +set r3p   [string_to_regexp $a3p]
> +set r3p9  [string_to_regexp $a3p9]
> +
> +set rep5  "<repeats 5 times>"
> +set rep6  "<repeats 6 times>"
> +
> +with_test_prefix "repeats=unlimited, elements=unlimited" {
> +    # Check the arrays print as expected.
> +    gdb_test_no_output "set print repeats unlimited"
> +    gdb_test_no_output "set print elements unlimited"
> +
> +    gdb_test "print array_1d"  "${r1p}"
> +    gdb_test "print array_1d9" "${r1p9}"
> +    gdb_test "print array_2d"  "${r2p}"
> +    gdb_test "print array_2d9" "${r2p9}"
> +    gdb_test "print array_3d"  "${r3p}"
> +    gdb_test "print array_3d9" "${r3p9}"
> +}
> +
> +with_test_prefix "repeats=4, elements=unlimited" {
> +    # Now set the repeat limit.
> +    gdb_test_no_output "set print repeats 4"
> +    gdb_test_no_output "set print elements unlimited"
> +
> +    gdb_test "print array_1d" \
> +	[string_to_regexp "{1 ${rep5}}"]
> +    gdb_test "print array_1d9" \
> +	[string_to_regexp "{1 ${rep5}, 9}"]
> +    gdb_test "print array_2d" \
> +	[string_to_regexp "{{2 ${rep5}} ${rep5}}"]
> +    gdb_test "print array_2d9" \
> +	[string_to_regexp "{{2 ${rep5}, 9} ${rep5}, {9 ${rep6}}}"]
> +    gdb_test "print array_3d" \
> +	[string_to_regexp "{{{3 ${rep5}} ${rep5}} ${rep5}}"]
> +    gdb_test "print array_3d9" \
> +	[string_to_regexp "{{{3 ${rep5}, 9} ${rep5}, {9 ${rep6}}} ${rep5},\
> +			    {{9 ${rep6}} ${rep6}}}"]
> +}
> +
> +with_test_prefix "repeats=unlimited, elements=3" {
> +    # Now set the element limit.
> +    gdb_test_no_output "set print repeats unlimited"
> +    gdb_test_no_output "set print elements 3"
> +
> +    gdb_test "print array_1d" \
> +	[string_to_regexp "{1, 1, 1...}"]
> +    gdb_test "print array_1d9" \
> +	[string_to_regexp "{1, 1, 1...}"]
> +    gdb_test "print array_2d" \
> +	[string_to_regexp "{{2, 2, 2...}, {2, 2, 2...}, {2, 2, 2...}...}"]
> +    gdb_test "print array_2d9" \
> +	[string_to_regexp "{{2, 2, 2...}, {2, 2, 2...}, {2, 2, 2...}...}"]
> +    gdb_test "print array_3d" \
> +	[string_to_regexp "{{{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...},\
> +			    {{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...},\
> +			    {{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...}...}"]
> +    gdb_test "print array_3d9" \
> +	[string_to_regexp "{{{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...},\
> +			    {{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...},\
> +			    {{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...}...}"]
> +}
> +
> +with_test_prefix "repeats=4, elements=12" {
> +    # Now set both limits.
> +    gdb_test_no_output "set print repeats 4"
> +    gdb_test_no_output "set print elements 12"
> +
> +    gdb_test "print array_1d" \
> +	[string_to_regexp "{1 ${rep5}}"]
> +    gdb_test "print array_1d9" \
> +	[string_to_regexp "{1 ${rep5}, 9}"]
> +    gdb_test "print array_2d" \
> +	[string_to_regexp "{{2 ${rep5}} ${rep5}}"]
> +    gdb_test "print array_2d9" \
> +	[string_to_regexp "{{2 ${rep5}, 9} ${rep5}, {9 ${rep6}}}"]
> +    gdb_test "print array_3d" \
> +	[string_to_regexp "{{{3 ${rep5}} ${rep5}} ${rep5}}"]
> +    gdb_test "print array_3d9" \
> +	[string_to_regexp "{{{3 ${rep5}, 9} ${rep5}, {9 ${rep6}}} ${rep5},\
> +			    {{9 ${rep6}} ${rep6}}}"]
> +}
> Index: src/gdb/testsuite/gdb.cp/array-repeat.cc
> ===================================================================
> --- /dev/null
> +++ src/gdb/testsuite/gdb.cp/array-repeat.cc
> @@ -0,0 +1,64 @@
> +// Copyright 2021 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/>.
> +
> +#include <cstddef>
> +#include <iostream>
> +
> +int
> +main ()
> +{
> +  int array_1d[5];
> +  int array_1d9[6];
> +  int array_2d[5][5];
> +  int array_2d9[6][6];
> +  int array_3d[5][5][5];
> +  int array_3d9[6][6][6];
> +  std::size_t i;
> +
> +  for (i = 0; i < sizeof (array_1d) / sizeof (int); i++)
> +    *(array_1d + i) = 1;
> +  for (i = 0; i < sizeof (array_1d9) / sizeof (int); i++)
> +    *(array_1d9 + i) = i % 6 == 5 ? 9 : 1;
> +  for (i = 0; i < sizeof (array_2d) / sizeof (int); i++)
> +    *(*array_2d + i) = 2;
> +  for (i = 0; i < sizeof (array_2d9) / sizeof (int); i++)
> +    *(*array_2d9 + i) = i / 6 == 5 || i % 6 == 5 ? 9 : 2;
> +  for (i = 0; i < sizeof (array_3d) / sizeof (int); i++)
> +    *(**array_3d + i) = 3;
> +  for (i = 0; i < sizeof (array_3d9) / sizeof (int); i++)
> +    *(**array_3d9 + i) = i / 6 / 6 == 5 || i / 6 % 6 == 5 || i % 6 == 5 ? 9 : 3;
> +
> +  std::cout << "\n";					// Break here
> +  for (i = 0; i < sizeof (array_1d) / sizeof (int); i++)
> +    std::cout << " " << *(array_1d + i);
> +  std::cout << "\n";
> +  for (i = 0; i < sizeof (array_1d9) / sizeof (int); i++)
> +    std::cout << " " << *(array_1d9 + i);
> +  std::cout << "\n";
> +  for (i = 0; i < sizeof (array_2d) / sizeof (int); i++)
> +    std::cout << " " << *(*array_2d + i);
> +  std::cout << "\n";
> +  for (i = 0; i < sizeof (array_2d9) / sizeof (int); i++)
> +    std::cout << " " << *(*array_2d9 + i);
> +  std::cout << "\n";
> +  for (i = 0; i < sizeof (array_3d) / sizeof (int); i++)
> +    std::cout << " " << *(**array_3d + i);
> +  std::cout << "\n";
> +  for (i = 0; i < sizeof (array_3d9) / sizeof (int); i++)
> +    std::cout << " " << *(**array_3d9 + i);
> +  std::cout << "\n";
> +
> +  return 0;
> +}
> Index: src/gdb/testsuite/gdb.cp/array-repeat.exp
> ===================================================================
> --- /dev/null
> +++ src/gdb/testsuite/gdb.cp/array-repeat.exp
> @@ -0,0 +1,139 @@
> +# Copyright 2021 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/>.
> +
> +# Test the detection and printing of repeated elements in C++ arrays.
> +
> +if {[skip_cplus_tests]} { continue }
> +
> +standard_testfile .cc
> +
> +if {[prepare_for_testing ${testfile}.exp ${testfile} ${srcfile} {debug c++}]} {
> +    return -1
> +}
> +
> +if {![runto_main]} {
> +    perror "Could not run to main."
> +    continue
> +}
> +
> +gdb_breakpoint [gdb_get_line_number "Break here"]
> +gdb_continue_to_breakpoint "Break here"
> +
> +# Build up the expected output for each array.
> +set a9p9o "{9, 9, 9, 9, 9, 9}"
> +set a1p   "{1, 1, 1, 1, 1}"
> +set a1p9  "{1, 1, 1, 1, 1, 9}"
> +set a2po  "{2, 2, 2, 2, 2}"
> +set a2p   "{${a2po}, ${a2po}, ${a2po}, ${a2po}, ${a2po}}"
> +set a2p9o "{2, 2, 2, 2, 2, 9}"
> +set a2p9  "{${a2p9o}, ${a2p9o}, ${a2p9o}, ${a2p9o}, ${a2p9o}, ${a9p9o}}"
> +set a3po  "{3, 3, 3, 3, 3}"
> +set a3p   "{${a3po}, ${a3po}, ${a3po}, ${a3po}, ${a3po}}"
> +set a3p   "{${a3p}, ${a3p}, ${a3p}, ${a3p}, ${a3p}}"
> +set a3p9o "{3, 3, 3, 3, 3, 9}"
> +set a3p9  "{${a3p9o}, ${a3p9o}, ${a3p9o}, ${a3p9o}, ${a3p9o}, ${a9p9o}}"
> +set a9p9  "{${a9p9o}, ${a9p9o}, ${a9p9o}, ${a9p9o}, ${a9p9o}, ${a9p9o}}"
> +set a3p9  "{${a3p9}, ${a3p9}, ${a3p9}, ${a3p9}, ${a3p9}, ${a9p9}}"
> +
> +# Convert the output into a regexp.
> +set r1p   [string_to_regexp $a1p]
> +set r1p9  [string_to_regexp $a1p9]
> +set r2po  [string_to_regexp $a2po]
> +set r2p9o [string_to_regexp $a2p9o]
> +set r2p   [string_to_regexp $a2p]
> +set r2p9  [string_to_regexp $a2p9]
> +set r3po  [string_to_regexp $a3po]
> +set r3p9o [string_to_regexp $a3p9o]
> +set r3p   [string_to_regexp $a3p]
> +set r3p9  [string_to_regexp $a3p9]
> +
> +set rep5  "<repeats 5 times>"
> +set rep6  "<repeats 6 times>"
> +
> +with_test_prefix "repeats=unlimited, elements=unlimited" {
> +    # Check the arrays print as expected.
> +    gdb_test_no_output "set print repeats unlimited"
> +    gdb_test_no_output "set print elements unlimited"
> +
> +    gdb_test "print array_1d"  "${r1p}"
> +    gdb_test "print array_1d9" "${r1p9}"
> +    gdb_test "print array_2d"  "${r2p}"
> +    gdb_test "print array_2d9" "${r2p9}"
> +    gdb_test "print array_3d"  "${r3p}"
> +    gdb_test "print array_3d9" "${r3p9}"
> +}
> +
> +with_test_prefix "repeats=4, elements=unlimited" {
> +    # Now set the repeat limit.
> +    gdb_test_no_output "set print repeats 4"
> +    gdb_test_no_output "set print elements unlimited"
> +
> +    gdb_test "print array_1d" \
> +	[string_to_regexp "{1 ${rep5}}"]
> +    gdb_test "print array_1d9" \
> +	[string_to_regexp "{1 ${rep5}, 9}"]
> +    gdb_test "print array_2d" \
> +	[string_to_regexp "{{2 ${rep5}} ${rep5}}"]
> +    gdb_test "print array_2d9" \
> +	[string_to_regexp "{{2 ${rep5}, 9} ${rep5}, {9 ${rep6}}}"]
> +    gdb_test "print array_3d" \
> +	[string_to_regexp "{{{3 ${rep5}} ${rep5}} ${rep5}}"]
> +    gdb_test "print array_3d9" \
> +	[string_to_regexp "{{{3 ${rep5}, 9} ${rep5}, {9 ${rep6}}} ${rep5},\
> +			    {{9 ${rep6}} ${rep6}}}"]
> +}
> +
> +with_test_prefix "repeats=unlimited, elements=3" {
> +    # Now set the element limit.
> +    gdb_test_no_output "set print repeats unlimited"
> +    gdb_test_no_output "set print elements 3"
> +
> +    gdb_test "print array_1d" \
> +	[string_to_regexp "{1, 1, 1...}"]
> +    gdb_test "print array_1d9" \
> +	[string_to_regexp "{1, 1, 1...}"]
> +    gdb_test "print array_2d" \
> +	[string_to_regexp "{{2, 2, 2...}, {2, 2, 2...}, {2, 2, 2...}...}"]
> +    gdb_test "print array_2d9" \
> +	[string_to_regexp "{{2, 2, 2...}, {2, 2, 2...}, {2, 2, 2...}...}"]
> +    gdb_test "print array_3d" \
> +	[string_to_regexp "{{{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...},\
> +			    {{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...},\
> +			    {{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...}...}"]
> +    gdb_test "print array_3d9" \
> +	[string_to_regexp "{{{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...},\
> +			    {{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...},\
> +			    {{3, 3, 3...}, {3, 3, 3...}, {3, 3, 3...}...}...}"]
> +}
> +
> +with_test_prefix "repeats=4, elements=12" {
> +    # Now set both limits.
> +    gdb_test_no_output "set print repeats 4"
> +    gdb_test_no_output "set print elements 12"
> +
> +    gdb_test "print array_1d" \
> +	[string_to_regexp "{1 ${rep5}}"]
> +    gdb_test "print array_1d9" \
> +	[string_to_regexp "{1 ${rep5}, 9}"]
> +    gdb_test "print array_2d" \
> +	[string_to_regexp "{{2 ${rep5}} ${rep5}}"]
> +    gdb_test "print array_2d9" \
> +	[string_to_regexp "{{2 ${rep5}, 9} ${rep5}, {9 ${rep6}}}"]
> +    gdb_test "print array_3d" \
> +	[string_to_regexp "{{{3 ${rep5}} ${rep5}} ${rep5}}"]
> +    gdb_test "print array_3d9" \
> +	[string_to_regexp "{{{3 ${rep5}, 9} ${rep5}, {9 ${rep6}}} ${rep5},\
> +			    {{9 ${rep6}} ${rep6}}}"]
> +}
>