[PATCH 14/24] Migrate rest of compile commands to new options framework

Pedro Alves
2019-05-22T20:53:48Z

As I was in the neighbourhood, I converted the other "compile"
subcommands to the new options framework too. Specifically, "compile
code" and "compile file".

The user-visible changes are:

- All abbreviations of "-raw" are accepted now, instead of just -r.
Obviously that means "-ra" is now accepted.

- Option completion now works.

- "compile file" did not have a completer yet, and now it knows to
complete on filenames.

- You couldn't use "compile file" with a file named "-something".
You can now, with "compile file -- -something".

gdb/ChangeLog:
yyyy-mm-dd Pedro Alves <palves@redhat.com>

* compile/compile.c (struct compile_options): New.
(compile_flag_option_def, compile_command_option_defs)
(make_compile_options_def_group): New.
(compile_file_command): Handle options with
gdb::option::process_options.
(compile_file_command_completer): New function.
(compile_code_command): Handle options with
gdb::option::process_options.
(compile_code_command_completer): New function.
(_initialize_compiler): Install completers for "compile code" and
"compile file". Mention available options in "compile code" and
"compile code"'s help.
* completer.c (advance_to_completion_word): New, factored out from
...
(advance_to_expression_complete_word_point): ... this.
(advance_to_filename_complete_word_point): New.
* completer.h (advance_to_filename_complete_word_point): New
declaration.

gdb/testsuite/ChangeLog:
yyyy-mm-dd Pedro Alves <palves@redhat.com>

* gdb.compile/compile.exp: Adjust expected output to option
processing changes.
---
gdb/compile/compile.c | 169 ++++++++++++++++++++++------------
gdb/completer.c | 34 +++++--
gdb/completer.h | 7 +-
gdb/testsuite/gdb.compile/compile.exp | 15 ++-
4 files changed, 155 insertions(+), 70 deletions(-)

diff --git a/gdb/compile/compile.c b/gdb/compile/compile.c
index 6693809cf4f..b467254fe83 100644
--- a/gdb/compile/compile.c
+++ b/gdb/compile/compile.c
@@ -236,19 +236,34 @@ show_compile_debug (struct ui_file *file, int from_tty,

\f

-/* Check *ARG for a "-raw" or "-r" argument. Return 0 if not seen.
- Return 1 if seen and update *ARG. */
+/* Options for the compile command. */

-static int
-check_raw_argument (const char **arg)
+struct compile_options
{
- *arg = skip_spaces (*arg);
+ /* For -raw. */
+ int raw = false;
+};
+
+using compile_flag_option_def
+ = gdb::option::flag_option_def<compile_options>;
+
+static const gdb::option::option_def compile_command_option_defs[] = {
+
+ compile_flag_option_def {
+ "raw",
+ [] (compile_options *opts) { return &opts->raw; },
+ N_("Suppress automatic 'void _gdb_expr () { CODE }' wrapping."),
+ },
+
+};

- if (arg != NULL
- && (check_for_argument (arg, "-raw", sizeof ("-raw") - 1)
- || check_for_argument (arg, "-r", sizeof ("-r") - 1)))
- return 1;
- return 0;
+/* Create an option_def_group for the "compile" command's options,
+ with OPTS as context. */
+
+static gdb::option::option_def_group
+make_compile_options_def_group (compile_options *opts)
+{
+ return {compile_command_option_defs, opts};
}

/* Handle the input from the 'compile file' command. The "compile
@@ -256,65 +271,74 @@ check_raw_argument (const char **arg)
that may contain calls to the GCC compiler. */

static void
-compile_file_command (const char *arg, int from_tty)
+compile_file_command (const char *args, int from_tty)
{
- enum compile_i_scope_types scope = COMPILE_I_SIMPLE_SCOPE;
-
scoped_restore save_async = make_scoped_restore (&current_ui->async, 0);

- /* Check the user did not just <enter> after command. */
- if (arg == NULL)
- error (_("You must provide a filename for this command."));
+ /* Check if a -raw option is provided. */

- /* Check if a raw (-r|-raw) argument is provided. */
- if (arg != NULL && check_raw_argument (&arg))
- {
- scope = COMPILE_I_RAW_SCOPE;
- arg = skip_spaces (arg);
- }
+ compile_options options;

- /* After processing arguments, check there is a filename at the end
- of the command. */
- if (arg[0] == '\0')
- error (_("You must provide a filename with the raw option set."));
+ const gdb::option::option_def_group group
+ = make_compile_options_def_group (&options);
+ gdb::option::process_options
+ (&args, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR,
+ group);
+
+ enum compile_i_scope_types scope
+ = options.raw ? COMPILE_I_RAW_SCOPE : COMPILE_I_SIMPLE_SCOPE;
+
+ args = skip_spaces (args);

- if (arg[0] == '-')
- error (_("Unknown argument specified."));
+ /* After processing options, check whether we have a filename. */
+ if (args == nullptr || args[0] == '\0')
+ error (_("You must provide a filename for this command."));

- arg = skip_spaces (arg);
- gdb::unique_xmalloc_ptr<char> abspath = gdb_abspath (arg);
+ args = skip_spaces (args);
+ gdb::unique_xmalloc_ptr<char> abspath = gdb_abspath (args);
std::string buffer = string_printf ("#include \"%s\"\n", abspath.get ());
eval_compile_command (NULL, buffer.c_str (), scope, NULL);
}

+/* Completer for the "compile file" command. */
+
+static void
+compile_file_command_completer (struct cmd_list_element *ignore,
+ completion_tracker &tracker,
+ const char *text, const char *word)
+{
+ const gdb::option::option_def_group group
+ = make_compile_options_def_group (nullptr);
+ if (gdb::option::complete_options
+ (tracker, &text, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR, group))
+ return;
+
+ word = advance_to_filename_complete_word_point (tracker, text);
+ filename_completer (ignore, tracker, text, word);
+}
+
/* Handle the input from the 'compile code' command. The
"compile code" command is used to evaluate an expression that may
contain calls to the GCC compiler. The language expected in this
compile command is the language currently set in GDB. */

static void
-compile_code_command (const char *arg, int from_tty)
+compile_code_command (const char *args, int from_tty)
{
- enum compile_i_scope_types scope = COMPILE_I_SIMPLE_SCOPE;
-
scoped_restore save_async = make_scoped_restore (&current_ui->async, 0);

- if (arg != NULL && check_raw_argument (&arg))
- {
- scope = COMPILE_I_RAW_SCOPE;
- arg = skip_spaces (arg);
- }
+ compile_options options;

- arg = skip_spaces (arg);
+ const gdb::option::option_def_group group
+ = make_compile_options_def_group (&options);
+ gdb::option::process_options
+ (&args, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR, group);

- if (arg != NULL && !check_for_argument (&arg, "--", sizeof ("--") - 1))
- {
- if (arg[0] == '-')
- error (_("Unknown argument specified."));
- }
+ enum compile_i_scope_types scope
+ = options.raw ? COMPILE_I_RAW_SCOPE : COMPILE_I_SIMPLE_SCOPE;

- if (arg && *arg)
- eval_compile_command (NULL, arg, scope, NULL);
+ if (args && *args)
+ eval_compile_command (NULL, args, scope, NULL);
else
{
counted_command_line l = get_command_line (compile_control, "");
@@ -324,6 +348,23 @@ compile_code_command (const char *arg, int from_tty)
}
}

+/* Completer for the "compile code" command. */
+
+static void
+compile_code_command_completer (struct cmd_list_element *ignore,
+ completion_tracker &tracker,
+ const char *text, const char *word)
+{
+ const gdb::option::option_def_group group
+ = make_compile_options_def_group (nullptr);
+ if (gdb::option::complete_options
+ (tracker, &text, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR, group))
+ return;
+
+ word = advance_to_expression_complete_word_point (tracker, text);
+ symbol_completer (ignore, tracker, text, word);
+}
+
/* Callback for compile_print_command. */

void
@@ -927,15 +968,16 @@ Command to compile source code and inject it into the inferior."),
&compile_command_list, "compile ", 1, &cmdlist);
add_com_alias ("expression", "compile", class_obscure, 0);

- add_cmd ("code", class_obscure, compile_code_command,
- _("\
+ const auto compile_opts = make_compile_options_def_group (nullptr);
+
+ static const std::string compile_code_help
+ = gdb::option::build_help (N_("\
Compile, inject, and execute code.\n\
\n\
-Usage: compile code [-r|-raw] [--] [CODE]\n\
--r|-raw: Suppress automatic 'void _gdb_expr () { CODE }' wrapping.\n\
---: Do not parse any options beyond this delimiter. All text to the\n\
- right will be treated as source code.\n\
+Usage: compile code [OPTION]... [CODE]\n\
\n\
+Options:\n\
+%OPTIONS%\n\
The source code may be specified as a simple one line expression, e.g.:\n\
\n\
compile code printf(\"Hello world\\n\");\n\
@@ -944,16 +986,27 @@ Alternatively, you can type a multiline expression by invoking\n\
this command with no argument. GDB will then prompt for the\n\
expression interactively; type a line containing \"end\" to\n\
indicate the end of the expression."),
- &compile_command_list);
+ compile_opts);

- c = add_cmd ("file", class_obscure, compile_file_command,
- _("\
+ c = add_cmd ("code", class_obscure, compile_code_command,
+ compile_code_help.c_str (),
+ &compile_command_list);
+ set_cmd_completer_handle_brkchars (c, compile_code_command_completer);
+
+static const std::string compile_file_help
+ = gdb::option::build_help (N_("\
Evaluate a file containing source code.\n\
\n\
-Usage: compile file [-r|-raw] [FILENAME]\n\
--r|-raw: Suppress automatic 'void _gdb_expr () { CODE }' wrapping."),
+Usage: compile file [OPTION].. [FILENAME]\n\
+\n\
+Options:\n\
+%OPTIONS%"),
+ compile_opts);
+
+ c = add_cmd ("file", class_obscure, compile_file_command,
+ compile_file_help.c_str (),
&compile_command_list);
- set_cmd_completer (c, filename_completer);
+ set_cmd_completer_handle_brkchars (c, compile_file_command_completer);

const auto compile_print_opts = make_value_print_options_def_group (nullptr);

diff --git a/gdb/completer.c b/gdb/completer.c
index e86b0531f54..25714c33c28 100644
--- a/gdb/completer.c
+++ b/gdb/completer.c
@@ -352,16 +352,18 @@ gdb_rl_find_completion_word (struct gdb_rl_completion_word_info *info,
return line_buffer + point;
}

-/* See completer.h. */
+/* Find the completion word point for TEXT, emulating the algorithm
+ readline uses to find the word point, using WORD_BREAK_CHARACTERS
+ as word break characters. */

-const char *
-advance_to_expression_complete_word_point (completion_tracker &tracker,
- const char *text)
+static const char *
+advance_to_completion_word (completion_tracker &tracker,
+ const char *word_break_characters,
+ const char *text)
{
gdb_rl_completion_word_info info;

- info.word_break_characters
- = current_language->la_word_break_characters ();
+ info.word_break_characters = word_break_characters;
info.quote_characters = gdb_completer_quote_characters;
info.basic_quote_characters = rl_basic_quote_characters;

@@ -382,6 +384,26 @@ advance_to_expression_complete_word_point (completion_tracker &tracker,

/* See completer.h. */

+const char *
+advance_to_expression_complete_word_point (completion_tracker &tracker,
+ const char *text)
+{
+ const char *brk_chars = current_language->la_word_break_characters ();
+ return advance_to_completion_word (tracker, brk_chars, text);
+}
+
+/* See completer.h. */
+
+const char *
+advance_to_filename_complete_word_point (completion_tracker &tracker,
+ const char *text)
+{
+ const char *brk_chars = gdb_completer_file_name_break_characters;
+ return advance_to_completion_word (tracker, brk_chars, text);
+}
+
+/* See completer.h. */
+
bool
completion_tracker::completes_to_completion_word (const char *word)
{
diff --git a/gdb/completer.h b/gdb/completer.h
index 27371b63a57..58fe84f4fee 100644
--- a/gdb/completer.h
+++ b/gdb/completer.h
@@ -532,10 +532,15 @@ extern const char *completion_find_completion_word (completion_tracker &tracker,
completion word point for TEXT, emulating the algorithm readline
uses to find the word point, using the current language's word
break characters. */
-
const char *advance_to_expression_complete_word_point
(completion_tracker &tracker, const char *text);

+/* Assuming TEXT is an filename, find the completion word point for
+ TEXT, emulating the algorithm readline uses to find the 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);

diff --git a/gdb/testsuite/gdb.compile/compile.exp b/gdb/testsuite/gdb.compile/compile.exp
index b4e88470e40..20a6a72386c 100644
--- a/gdb/testsuite/gdb.compile/compile.exp
+++ b/gdb/testsuite/gdb.compile/compile.exp
@@ -325,7 +325,7 @@ gdb_test_no_output "set debug compile off"
gdb_test "show debug compile" "Compile debugging is .*"
gdb_test "show compile-args" \
"Compile command command-line arguments are .*"
-gdb_test "compile code -z" "Unknown argument.*"
+gdb_test "compile code -z" "Unrecognized option at: -z"

gdb_test "set lang rust" \
"Warning: the current language does not match this frame."
@@ -340,12 +340,17 @@ gdb_test "compile file" \
"You must provide a filename for this command.*" \
"Test compile file without a filename"
gdb_test "compile file -r" \
- "You must provide a filename with the raw option set.*" \
+ "You must provide a filename for this command.*" \
"Test compile file and raw option without a filename"
gdb_test "compile file -z" \
- "Unknown argument.*" \
- "test compile file with unknown argument"
-
+ "Unrecognized option at: -z" \
+ "test compile file with unknown option"
+gdb_test "compile file -z --" \
+ "Unrecognized option at: -z --" \
+ "test compile file with unknown option plus --"
+gdb_test "compile file -raw -- -raw" \
+ "/-raw: No such file or directory.*" \
+ "test compile file \"-raw\" file"

# LOC_CONST tests.

--
2.14.5