[binutils-gdb] gdb: move more completion setup into completer.c

[binutils-gdb] gdb: move more completion setup into completer.c

[Andrew Burgess]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=ec483c2344f967708cfa71c84ef349b6951c1374

commit ec483c2344f967708cfa71c84ef349b6951c1374
Author: Andrew Burgess <aburgess@redhat.com>
Date:   Mon Feb 19 10:53:54 2024 +0000

    gdb: move more completion setup into completer.c
    
    Move more setup of the readline global state relating to tab
    completion into completer.c out of top.c.
    
    Lots of the readline setup is done in init_main (top.c).  This commit
    moves those bits of initialisation that relate to completion, and
    which are only set the one time, into completer.c.  This does mean
    that readline initialisation is now done in multiple locations, some
    in init_main (top.c) and some in completer.c, but I think this is OK.
    The work done in init_main is the general readline setup.
    
    I think making static what can be made static, and having it all in
    one file, makes things easier to reason about.  So I'm OK with having
    this split initialisation.
    
    The only completion related thing which is still setup in top.c is
    rl_completion_display_matches_hook.  I've left this where it is for
    now as rl_completion_display_matches_hook is also updated in the tui
    code, and the display hook functions are not in completer.c anyway, so
    moving this initialisation to completer.c would not allow anything
    else to be made static.
    
    There should be no user visible changes after this commit.

Diff:
---
 gdb/completer.c | 24 +++++++++++++++++++-----
 gdb/completer.h | 11 -----------
 gdb/top.c       |  3 ---
 3 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/gdb/completer.c b/gdb/completer.c
index 2fee90503db..8e34e30f46b 100644
--- a/gdb/completer.c
+++ b/gdb/completer.c
@@ -51,6 +51,8 @@ static const char *completion_find_completion_word (completion_tracker &tracker,
 						    const char *text,
 						    int *quote_char);
 
+static void set_rl_completer_word_break_characters (const char *break_chars);
+
 /* See completer.h.  */
 
 class completion_tracker::completion_hash_entry
@@ -1113,9 +1115,12 @@ expression_completer (struct cmd_list_element *ignore,
   complete_expression (tracker, text, word);
 }
 
-/* See definition in completer.h.  */
+/* Set the word break characters array to BREAK_CHARS.  This function is
+   useful as const-correct alternative to direct assignment to
+   rl_completer_word_break_characters, which is "char *", not "const
+   char *".  */
 
-void
+static void
 set_rl_completer_word_break_characters (const char *break_chars)
 {
   rl_completer_word_break_characters = (char *) break_chars;
@@ -1940,8 +1945,12 @@ gdb_completion_word_break_characters_throw ()
   return (char *) rl_completer_word_break_characters;
 }
 
-char *
-gdb_completion_word_break_characters ()
+/* Get the list of chars that are considered as word breaks for the current
+   command.  This function does not throw any exceptions and is called from
+   readline.  See gdb_completion_word_break_characters_throw for details.  */
+
+static char *
+gdb_completion_word_break_characters () noexcept
 {
   /* New completion starting.  */
   current_completion.aborted = false;
@@ -2336,7 +2345,7 @@ gdb_rl_attempted_completion_function_throw (const char *text, int start, int end
    hook.  Wrapper around gdb_rl_attempted_completion_function_throw
    that catches C++ exceptions, which can't cross readline.  */
 
-char **
+static char **
 gdb_rl_attempted_completion_function (const char *text, int start, int end)
 {
   /* Restore globals that might have been tweaked in
@@ -3004,6 +3013,11 @@ void _initialize_completer ();
 void
 _initialize_completer ()
 {
+  /* Setup some readline completion globals.  */
+  rl_completion_word_break_hook = gdb_completion_word_break_characters;
+  rl_attempted_completion_function = gdb_rl_attempted_completion_function;
+  set_rl_completer_word_break_characters (default_word_break_characters ());
+
   add_setshow_zuinteger_unlimited_cmd ("max-completions", no_class,
 				       &max_completions, _("\
 Set maximum number of completion candidates."), _("\
diff --git a/gdb/completer.h b/gdb/completer.h
index 9011ba778a7..98a12f3907c 100644
--- a/gdb/completer.h
+++ b/gdb/completer.h
@@ -569,9 +569,6 @@ const char *advance_to_expression_complete_word_point
 extern const char *advance_to_filename_complete_word_point
   (completion_tracker &tracker, const char *text);
 
-extern char **gdb_rl_attempted_completion_function (const char *text,
-						    int start, int end);
-
 extern void noop_completer (struct cmd_list_element *,
 			    completion_tracker &tracker,
 			    const char *, const char *);
@@ -608,14 +605,6 @@ extern void reggroup_completer (struct cmd_list_element *,
 				completion_tracker &tracker,
 				const char *, const char *);
 
-extern char *gdb_completion_word_break_characters (void);
-
-/* Set the word break characters array to BREAK_CHARS.  This function
-   is useful as const-correct alternative to direct assignment to
-   rl_completer_word_break_characters, which is "char *",
-   not "const char *".  */
-extern void set_rl_completer_word_break_characters (const char *break_chars);
-
 /* Get the matching completer_handle_brkchars_ftype function for FN.
    FN is one of the core completer functions above (filename,
    location, symbol, etc.).  This function is useful for cases when
diff --git a/gdb/top.c b/gdb/top.c
index 8df684ec8b4..0aeeb987832 100644
--- a/gdb/top.c
+++ b/gdb/top.c
@@ -2139,9 +2139,6 @@ init_main (void)
   write_history_p = 0;
 
   /* Setup important stuff for command line editing.  */
-  rl_completion_word_break_hook = gdb_completion_word_break_characters;
-  rl_attempted_completion_function = gdb_rl_attempted_completion_function;
-  set_rl_completer_word_break_characters (default_word_break_characters ());
   rl_completion_display_matches_hook = cli_display_match_list;
   rl_readline_name = "gdb";
   rl_terminal_name = getenv ("TERM");