Re: [PATCH v11 2/2] gdb: add shadowed field in '-stack-list-locals/variables' mi commands

[Eli Zaretskii <eliz@gnu.org>]

> From: Abdul Basit Ijaz <abdul.b.ijaz@intel.com>
> Cc: pedro@palves.net,
> 	philippe.waroquiers@skynet.be,
> 	aburgess@redhat.com,
> 	tankut.baris.aktemur@intel.com,
> 	christina.schimpe@intel.com,
> 	lsix@lancelotsix.com,
> 	eliz@gnu.org,
> 	abdul.b.ijaz@intel.com,
> 	tom@tromey.com
> Date: Fri, 28 Nov 2025 13:03:17 +0100
> 
>  gdb/NEWS                                  |   4 +
>  gdb/doc/gdb.texinfo                       |  18 +++
>  gdb/mi/mi-cmd-stack.c                     | 129 ++++++++++++++------
>  gdb/testsuite/gdb.mi/mi-var-shadowing.c   |  48 ++++++++
>  gdb/testsuite/gdb.mi/mi-var-shadowing.exp | 141 ++++++++++++++++++++++
>  5 files changed, 305 insertions(+), 35 deletions(-)
>  create mode 100644 gdb/testsuite/gdb.mi/mi-var-shadowing.c
>  create mode 100644 gdb/testsuite/gdb.mi/mi-var-shadowing.exp

Thanks.

> diff --git a/gdb/NEWS b/gdb/NEWS
> index 616899147c3..034b530a7bf 100644
> --- a/gdb/NEWS
> +++ b/gdb/NEWS
> @@ -371,6 +371,10 @@ vFile:stat
>     multiple times, and the same mapping was being reused.  In all
>     other cases, this field will have the value 'false'.
>  
> +** GDB now shows "shadowed", "file" and "line" fields in the output
> +   of '-stack-list-locals/variables' mi commands for variables
> +   shadowing case.
> +
>  * Support for stabs debugging format and the a.out/dbx object format is
>    deprecated, and will be removed in GDB 18.
>  
> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> index 9ea4a2705bf..f761e85ee28 100644
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -35417,6 +35417,24 @@ If the @code{--skip-unavailable} option is specified, local variables
>  and arguments that are not available are not listed.  Partially
>  available arguments and local variables are still displayed, however.
>  
> +@smallexample
> +1: int x = 3;
> +2: @{
> +3:       int x = 4;
> +4:       int y = 5;
> +4:       x = 99; // breakpoint-line
> +5: @}
> +(gdb) -stack-list-variables 2
> +^done,variables=[@{name="x",type="int",value="4",file="/home/src/name.c",line="3"@},@{name="y",type="int",value="5",file="/home/src/name.c",line="4"@},@{name="x",type="int",value="3",file="/home/src/name.c",line="1",shadowed="true"@}]
> +@end smallexample

Same comment as in the previous patch regarding multi-line examples.

Also, the last line is too long, so please break it into several
lines, each one no longer than 72 characters (and preferably even
fewer).

> +A variable is shadowed when there's another variable with the same
> +name which is declared within an inner scope (decision block,
> +method, or inner class).  For such cases, its location for the
> +outermost scope is followed by @samp{shadowed} attribute.  The
> +location can help to locate the instances of shadowed variables.  So,
> +location information is only added for shadowed variables.

There's no reason to explain twice what does "shadowed variable" mean.
Instead, please put here a cross-reference to the other node where
this is explained.

I still think that all variables should have this annotation.  In the
MI output, it will make the job of the front-end which needs to parse
this output simpler, since the fields will always be present.

Reviewed-By: Eli Zaretskii <eliz@gnu.org>