* [PATCH v4] gdb: search local symbols before global symbols in completion
@ 2026-08-09 17:19 Oleg Tolmatcev
2026-08-10 18:00 ` Oleg Tolmatcev
0 siblings, 1 reply; 3+ messages in thread
From: Oleg Tolmatcev @ 2026-08-09 17:19 UTC (permalink / raw)
To: gdb-patches; +Cc: Oleg Tolmatcev
When symbol completion is performed from a selected frame, search the
local blocks before scanning minimal symbols and global/static symbols.
This makes completion prefer names that are visible in the current
context, including local variables.
Add a regression test that checks completion prefers a local symbol over
a global symbol with the same name.
---
gdb/symtab.c | 72 +++++++++++++--------------
gdb/testsuite/gdb.base/break.c | 21 ++++++++
gdb/testsuite/gdb.base/completion.exp | 10 ++++
3 files changed, 67 insertions(+), 36 deletions(-)
diff --git a/gdb/symtab.c b/gdb/symtab.c
index 5d5076f2e77..85665bebdf4 100644
--- a/gdb/symtab.c
+++ b/gdb/symtab.c
@@ -5931,6 +5931,42 @@ default_collect_symbol_completion_matches_break_on
lookup_name_info lookup_name (sym_text, name_match_type, true);
+ /* Search upwards from currently selected frame (so that we can
+ complete on local vars). Also catch fields of types defined in
+ this places which match our text string. Only complete on types
+ visible from current context. */
+
+ b = get_selected_block ();
+ surrounding_static_block = b == nullptr ? nullptr : b->static_block ();
+ surrounding_global_block = b == nullptr ? nullptr : b->global_block ();
+ if (surrounding_static_block != NULL)
+ while (b != surrounding_static_block)
+ {
+ QUIT;
+
+ for (struct symbol *sym : block_iterator_range (b))
+ {
+ if (code == TYPE_CODE_UNDEF)
+ {
+ completion_list_add_symbol (tracker, sym, lookup_name,
+ sym_text, word);
+ completion_list_add_fields (tracker, sym, lookup_name,
+ sym_text, word);
+ }
+ else if (sym->domain () == STRUCT_DOMAIN
+ && sym->type ()->code () == code)
+ completion_list_add_symbol (tracker, sym, lookup_name,
+ sym_text, word);
+ }
+
+ /* Stop when we encounter an enclosing function. Do not stop for
+ non-inlined functions - the locals of the enclosing function
+ are in scope for a nested function. */
+ if (b->function () != NULL && b->inlined_p ())
+ break;
+ b = b->superblock ();
+ }
+
/* At this point scan through the misc symbol vectors and add each
symbol you find to the list. Eventually we want to ignore
anything that isn't a text symbol (everything else will be
@@ -5974,42 +6010,6 @@ default_collect_symbol_completion_matches_break_on
SEARCH_ALL_DOMAINS);
}
- /* Search upwards from currently selected frame (so that we can
- complete on local vars). Also catch fields of types defined in
- this places which match our text string. Only complete on types
- visible from current context. */
-
- b = get_selected_block ();
- surrounding_static_block = b == nullptr ? nullptr : b->static_block ();
- surrounding_global_block = b == nullptr ? nullptr : b->global_block ();
- if (surrounding_static_block != NULL)
- while (b != surrounding_static_block)
- {
- QUIT;
-
- for (struct symbol *sym : block_iterator_range (b))
- {
- if (code == TYPE_CODE_UNDEF)
- {
- completion_list_add_symbol (tracker, sym, lookup_name,
- sym_text, word);
- completion_list_add_fields (tracker, sym, lookup_name,
- sym_text, word);
- }
- else if (sym->domain () == STRUCT_DOMAIN
- && sym->type ()->code () == code)
- completion_list_add_symbol (tracker, sym, lookup_name,
- sym_text, word);
- }
-
- /* Stop when we encounter an enclosing function. Do not stop for
- non-inlined functions - the locals of the enclosing function
- are in scope for a nested function. */
- if (b->function () != NULL && b->inlined_p ())
- break;
- b = b->superblock ();
- }
-
/* Add fields from the file's types; symbols will be added below. */
if (code == TYPE_CODE_UNDEF)
diff --git a/gdb/testsuite/gdb.base/break.c b/gdb/testsuite/gdb.base/break.c
index 26085d40ca2..c9b74c6a567 100644
--- a/gdb/testsuite/gdb.base/break.c
+++ b/gdb/testsuite/gdb.base/break.c
@@ -23,6 +23,26 @@ extern int marker2 (int a);
extern void marker3 (char *a, char *b);
extern void marker4 (long d);
+struct completion_global_struct
+{
+ int global_field;
+};
+
+struct completion_local_struct
+{
+ int local_field;
+};
+
+struct completion_global_struct completion_var;
+
+static void
+completion_local_over_global (void)
+{
+ struct completion_local_struct completion_var = { 23 };
+
+ completion_var.local_field++; /* local-completion-breakpoint */
+}
+
/* We're used by a test that requires malloc, so make sure it is in
the executable. */
void *need_malloc ()
@@ -50,6 +70,7 @@ main (int argc, char **argv, char **envp)
marker2 (43); /* set breakpoint 20 here */
marker3 ("stack", "trace"); /* set breakpoint 21 here */
marker4 (177601976L);
+ completion_local_over_global ();
/* We're used by a test that requires malloc, so make sure it is
in the executable. */
(void)malloc (1);
diff --git a/gdb/testsuite/gdb.base/completion.exp b/gdb/testsuite/gdb.base/completion.exp
index 44cf649d5b6..4cecd552d3c 100644
--- a/gdb/testsuite/gdb.base/completion.exp
+++ b/gdb/testsuite/gdb.base/completion.exp
@@ -87,6 +87,16 @@ gdb_test "complete set gnutarget aut" "set gnutarget auto"
gdb_test "complete set cp-abi aut" "set cp-abi auto"
+# Check that symbol completion in a selected frame prefers a local
+# symbol over a global symbol with the same name.
+gdb_breakpoint [gdb_get_line_number "local-completion-breakpoint"]
+gdb_continue_to_breakpoint "local-completion-breakpoint"
+gdb_test "complete p completion_var.l" "p completion_var.local_field"
+
+# Leave the helper frame before continuing with the readline-based
+# completion checks below.
+gdb_test "finish" ".*" "return from local completion helper"
+
# Test that completion of commands 'target FOO' works well.
set targets [list "core" "tfile" "exec"]
--
2.55.0.windows.3
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v4] gdb: search local symbols before global symbols in completion
2026-08-09 17:19 [PATCH v4] gdb: search local symbols before global symbols in completion Oleg Tolmatcev
@ 2026-08-10 18:00 ` Oleg Tolmatcev
2026-08-21 19:12 ` Tom Tromey
0 siblings, 1 reply; 3+ messages in thread
From: Oleg Tolmatcev @ 2026-08-10 18:00 UTC (permalink / raw)
To: gdb-patches
вс, 9 авг. 2026 г. в 19:19, Oleg Tolmatcev <oleg.tolmatcev@gmail.com>:
>
> When symbol completion is performed from a selected frame, search the
> local blocks before scanning minimal symbols and global/static symbols.
> This makes completion prefer names that are visible in the current
> context, including local variables.
>
> Add a regression test that checks completion prefers a local symbol over
> a global symbol with the same name.
> ---
> gdb/symtab.c | 72 +++++++++++++--------------
> gdb/testsuite/gdb.base/break.c | 21 ++++++++
> gdb/testsuite/gdb.base/completion.exp | 10 ++++
> 3 files changed, 67 insertions(+), 36 deletions(-)
>
> diff --git a/gdb/symtab.c b/gdb/symtab.c
> index 5d5076f2e77..85665bebdf4 100644
> --- a/gdb/symtab.c
> +++ b/gdb/symtab.c
> @@ -5931,6 +5931,42 @@ default_collect_symbol_completion_matches_break_on
>
> lookup_name_info lookup_name (sym_text, name_match_type, true);
>
> + /* Search upwards from currently selected frame (so that we can
> + complete on local vars). Also catch fields of types defined in
> + this places which match our text string. Only complete on types
> + visible from current context. */
> +
> + b = get_selected_block ();
> + surrounding_static_block = b == nullptr ? nullptr : b->static_block ();
> + surrounding_global_block = b == nullptr ? nullptr : b->global_block ();
> + if (surrounding_static_block != NULL)
> + while (b != surrounding_static_block)
> + {
> + QUIT;
> +
> + for (struct symbol *sym : block_iterator_range (b))
> + {
> + if (code == TYPE_CODE_UNDEF)
> + {
> + completion_list_add_symbol (tracker, sym, lookup_name,
> + sym_text, word);
> + completion_list_add_fields (tracker, sym, lookup_name,
> + sym_text, word);
> + }
> + else if (sym->domain () == STRUCT_DOMAIN
> + && sym->type ()->code () == code)
> + completion_list_add_symbol (tracker, sym, lookup_name,
> + sym_text, word);
> + }
> +
> + /* Stop when we encounter an enclosing function. Do not stop for
> + non-inlined functions - the locals of the enclosing function
> + are in scope for a nested function. */
> + if (b->function () != NULL && b->inlined_p ())
> + break;
> + b = b->superblock ();
> + }
> +
> /* At this point scan through the misc symbol vectors and add each
> symbol you find to the list. Eventually we want to ignore
> anything that isn't a text symbol (everything else will be
> @@ -5974,42 +6010,6 @@ default_collect_symbol_completion_matches_break_on
> SEARCH_ALL_DOMAINS);
> }
>
> - /* Search upwards from currently selected frame (so that we can
> - complete on local vars). Also catch fields of types defined in
> - this places which match our text string. Only complete on types
> - visible from current context. */
> -
> - b = get_selected_block ();
> - surrounding_static_block = b == nullptr ? nullptr : b->static_block ();
> - surrounding_global_block = b == nullptr ? nullptr : b->global_block ();
> - if (surrounding_static_block != NULL)
> - while (b != surrounding_static_block)
> - {
> - QUIT;
> -
> - for (struct symbol *sym : block_iterator_range (b))
> - {
> - if (code == TYPE_CODE_UNDEF)
> - {
> - completion_list_add_symbol (tracker, sym, lookup_name,
> - sym_text, word);
> - completion_list_add_fields (tracker, sym, lookup_name,
> - sym_text, word);
> - }
> - else if (sym->domain () == STRUCT_DOMAIN
> - && sym->type ()->code () == code)
> - completion_list_add_symbol (tracker, sym, lookup_name,
> - sym_text, word);
> - }
> -
> - /* Stop when we encounter an enclosing function. Do not stop for
> - non-inlined functions - the locals of the enclosing function
> - are in scope for a nested function. */
> - if (b->function () != NULL && b->inlined_p ())
> - break;
> - b = b->superblock ();
> - }
> -
> /* Add fields from the file's types; symbols will be added below. */
>
> if (code == TYPE_CODE_UNDEF)
> diff --git a/gdb/testsuite/gdb.base/break.c b/gdb/testsuite/gdb.base/break.c
> index 26085d40ca2..c9b74c6a567 100644
> --- a/gdb/testsuite/gdb.base/break.c
> +++ b/gdb/testsuite/gdb.base/break.c
> @@ -23,6 +23,26 @@ extern int marker2 (int a);
> extern void marker3 (char *a, char *b);
> extern void marker4 (long d);
>
> +struct completion_global_struct
> +{
> + int global_field;
> +};
> +
> +struct completion_local_struct
> +{
> + int local_field;
> +};
> +
> +struct completion_global_struct completion_var;
> +
> +static void
> +completion_local_over_global (void)
> +{
> + struct completion_local_struct completion_var = { 23 };
> +
> + completion_var.local_field++; /* local-completion-breakpoint */
> +}
> +
> /* We're used by a test that requires malloc, so make sure it is in
> the executable. */
> void *need_malloc ()
> @@ -50,6 +70,7 @@ main (int argc, char **argv, char **envp)
> marker2 (43); /* set breakpoint 20 here */
> marker3 ("stack", "trace"); /* set breakpoint 21 here */
> marker4 (177601976L);
> + completion_local_over_global ();
> /* We're used by a test that requires malloc, so make sure it is
> in the executable. */
> (void)malloc (1);
> diff --git a/gdb/testsuite/gdb.base/completion.exp b/gdb/testsuite/gdb.base/completion.exp
> index 44cf649d5b6..4cecd552d3c 100644
> --- a/gdb/testsuite/gdb.base/completion.exp
> +++ b/gdb/testsuite/gdb.base/completion.exp
> @@ -87,6 +87,16 @@ gdb_test "complete set gnutarget aut" "set gnutarget auto"
>
> gdb_test "complete set cp-abi aut" "set cp-abi auto"
>
> +# Check that symbol completion in a selected frame prefers a local
> +# symbol over a global symbol with the same name.
> +gdb_breakpoint [gdb_get_line_number "local-completion-breakpoint"]
> +gdb_continue_to_breakpoint "local-completion-breakpoint"
> +gdb_test "complete p completion_var.l" "p completion_var.local_field"
> +
> +# Leave the helper frame before continuing with the readline-based
> +# completion checks below.
> +gdb_test "finish" ".*" "return from local completion helper"
> +
> # Test that completion of commands 'target FOO' works well.
> set targets [list "core" "tfile" "exec"]
>
> --
> 2.55.0.windows.3
>
Still two regressions on ARM.
Oleg
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v4] gdb: search local symbols before global symbols in completion
2026-08-10 18:00 ` Oleg Tolmatcev
@ 2026-08-21 19:12 ` Tom Tromey
0 siblings, 0 replies; 3+ messages in thread
From: Tom Tromey @ 2026-08-21 19:12 UTC (permalink / raw)
To: Oleg Tolmatcev; +Cc: gdb-patches
>>>>> "Oleg" == Oleg Tolmatcev <oleg.tolmatcev@gmail.com> writes:
Oleg> Still two regressions on ARM.
Here too:
FAIL: gdb.base/completion.exp: complete 'p values[0].a'
FAIL: gdb.base/completion.exp: complete 'p values[0] . a'
It's often better to just write a new small test case, at least in the
case when the otherwise-relevant test case is one of these old ones.
Tom
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2026-08-21 19:13 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-08-09 17:19 [PATCH v4] gdb: search local symbols before global symbols in completion Oleg Tolmatcev
2026-08-10 18:00 ` Oleg Tolmatcev
2026-08-21 19:12 ` Tom Tromey
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox