1 /* CLI options framework, for GDB.
3 Copyright (C) 2017-2024 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "cli/cli-option.h"
22 #include "cli/cli-decode.h"
23 #include "cli/cli-utils.h"
24 #include "cli/cli-setshow.h"
31 /* An option's value. Which field is active depends on the option's
35 /* For var_boolean options. */
38 /* For var_uinteger options. */
39 unsigned int uinteger
;
41 /* For var_integer and var_pinteger options. */
44 /* For var_enum options. */
45 const char *enumeration
;
47 /* For var_string options. This is malloc-allocated. */
51 /* Holds an options definition and its value. */
52 struct option_def_and_value
54 /* The option definition. */
55 const option_def
&option
;
60 /* The option's value, if any. */
61 std::optional
<option_value
> value
;
64 option_def_and_value (const option_def
&option_
, void *ctx_
,
65 std::optional
<option_value
> &&value_
= {})
68 value (std::move (value_
))
70 clear_value (option_
, value_
);
73 /* Move constructor. Need this because for some types the values
74 are allocated on the heap. */
75 option_def_and_value (option_def_and_value
&&rval
)
76 : option (rval
.option
),
78 value (std::move (rval
.value
))
80 clear_value (rval
.option
, rval
.value
);
83 DISABLE_COPY_AND_ASSIGN (option_def_and_value
);
85 ~option_def_and_value ()
87 if (value
.has_value ())
89 if (option
.type
== var_string
)
96 /* Clear the option_value, without releasing it. This is used after
97 the value has been moved to some other option_def_and_value
98 instance. This is needed because for some types the value is
99 allocated on the heap, so we must clear the pointer in the
100 source, to avoid a double free. */
101 static void clear_value (const option_def
&option
,
102 std::optional
<option_value
> &value
)
104 if (value
.has_value ())
106 if (option
.type
== var_string
)
107 value
->string
= nullptr;
112 static void save_option_value_in_ctx (std::optional
<option_def_and_value
> &ov
);
114 /* Info passed around when handling completion. */
115 struct parse_option_completion_info
117 /* The completion word. */
121 completion_tracker
&tracker
;
124 /* If ARGS starts with "-", look for a "--" delimiter. If one is
125 found, then interpret everything up until the "--" as command line
126 options. Otherwise, interpret unknown input as the beginning of
127 the command's operands. */
130 find_end_options_delimiter (const char *args
)
134 const char *p
= args
;
139 if (check_for_argument (&p
, "--"))
142 p
= skip_to_space (p
);
150 /* Complete TEXT/WORD on all options in OPTIONS_GROUP. */
153 complete_on_options (gdb::array_view
<const option_def_group
> options_group
,
154 completion_tracker
&tracker
,
155 const char *text
, const char *word
)
157 size_t textlen
= strlen (text
);
158 for (const auto &grp
: options_group
)
159 for (const auto &opt
: grp
.options
)
160 if (strncmp (opt
.name
, text
, textlen
) == 0)
162 tracker
.add_completion
163 (make_completion_match_str (opt
.name
, text
, word
));
167 /* See cli-option.h. */
170 complete_on_all_options (completion_tracker
&tracker
,
171 gdb::array_view
<const option_def_group
> options_group
)
173 static const char opt
[] = "-";
174 complete_on_options (options_group
, tracker
, opt
+ 1, opt
);
177 /* Parse ARGS, guided by OPTIONS_GROUP. HAVE_DELIMITER is true if the
178 whole ARGS line included the "--" options-terminator delimiter. */
180 static std::optional
<option_def_and_value
>
181 parse_option (gdb::array_view
<const option_def_group
> options_group
,
182 process_options_mode mode
,
185 parse_option_completion_info
*completion
= nullptr)
187 if (*args
== nullptr)
189 else if (**args
!= '-')
192 error (_("Unrecognized option at: %s"), *args
);
195 else if (check_for_argument (args
, "--"))
198 /* Skip the initial '-'. */
199 const char *arg
= *args
+ 1;
201 const char *after
= skip_to_space (arg
);
202 size_t len
= after
- arg
;
203 const option_def
*match
= nullptr;
204 void *match_ctx
= nullptr;
206 for (const auto &grp
: options_group
)
208 for (const auto &o
: grp
.options
)
210 if (strncmp (o
.name
, arg
, len
) == 0)
212 if (match
!= nullptr)
214 if (completion
!= nullptr && arg
[len
] == '\0')
216 complete_on_options (options_group
,
218 arg
, completion
->word
);
222 error (_("Ambiguous option at: -%s"), arg
);
228 if ((isspace (arg
[len
]) || arg
[len
] == '\0')
229 && strlen (o
.name
) == len
)
230 break; /* Exact match. */
235 if (match
== nullptr)
237 if (have_delimiter
|| mode
!= PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
)
238 error (_("Unrecognized option at: %s"), *args
);
243 if (completion
!= nullptr && arg
[len
] == '\0')
245 complete_on_options (options_group
, completion
->tracker
,
246 arg
, completion
->word
);
251 *args
= skip_spaces (*args
);
252 if (completion
!= nullptr)
253 completion
->word
= *args
;
259 if (!match
->have_argument
)
263 return option_def_and_value
{*match
, match_ctx
, val
};
266 const char *val_str
= *args
;
269 if (**args
== '\0' && completion
!= nullptr)
271 /* Complete on both "on/off" and more options. */
273 if (mode
== PROCESS_OPTIONS_REQUIRE_DELIMITER
)
275 complete_on_enum (completion
->tracker
,
276 boolean_enums
, val_str
, val_str
);
277 complete_on_all_options (completion
->tracker
, options_group
);
279 return option_def_and_value
{*match
, match_ctx
};
281 else if (**args
== '-')
284 "cmd -boolean-option -another-opt..."
286 "cmd -boolean-option on -another-opt..."
290 else if (**args
== '\0')
293 (1) "cmd -boolean-option "
295 (1) "cmd -boolean-option on"
301 res
= parse_cli_boolean_value (args
);
304 const char *end
= skip_to_space (*args
);
305 if (completion
!= nullptr)
309 complete_on_enum (completion
->tracker
,
310 boolean_enums
, val_str
, val_str
);
311 return option_def_and_value
{*match
, match_ctx
};
316 error (_("Value given for `-%s' is not a boolean: %.*s"),
317 match
->name
, (int) (end
- val_str
), val_str
);
318 /* The user didn't separate options from operands
319 using "--", so treat this unrecognized value as the
320 start of the operands. This makes "frame apply all
321 -past-main CMD" work. */
322 return option_def_and_value
{*match
, match_ctx
};
324 else if (completion
!= nullptr && **args
== '\0')
326 /* While "cmd -boolean [TAB]" only offers "on" and
327 "off", the boolean option actually accepts "1",
328 "yes", etc. as boolean values. We complete on all
329 of those instead of BOOLEAN_ENUMS here to make
332 "p -object 1[TAB]" -> "p -object 1 "
333 "p -object ye[TAB]" -> "p -object yes "
335 Etc. Note that it's important that the space is
336 auto-appended. Otherwise, if we only completed on
337 on/off here, then it might look to the user like
338 "1" isn't valid, like:
339 "p -object 1[TAB]" -> "p -object 1" (i.e., nothing happens).
341 static const char *const all_boolean_enums
[] = {
348 complete_on_enum (completion
->tracker
, all_boolean_enums
,
356 return option_def_and_value
{*match
, match_ctx
, val
};
362 if (completion
!= nullptr && match
->extra_literals
!= nullptr)
364 /* Convenience to let the user know what the option can
365 accept. Make sure there's no common prefix between
366 "NUMBER" and all the strings when adding new ones,
367 so that readline doesn't do a partial match. */
370 completion
->tracker
.add_completion
371 (make_unique_xstrdup ("NUMBER"));
372 for (const literal_def
*l
= match
->extra_literals
;
373 l
->literal
!= nullptr;
375 completion
->tracker
.add_completion
376 (make_unique_xstrdup (l
->literal
));
381 bool completions
= false;
382 for (const literal_def
*l
= match
->extra_literals
;
383 l
->literal
!= nullptr;
385 if (startswith (l
->literal
, *args
))
387 completion
->tracker
.add_completion
388 (make_unique_xstrdup (l
->literal
));
396 LONGEST v
= parse_cli_var_integer (match
->type
,
397 match
->extra_literals
,
400 if (match
->type
== var_uinteger
)
404 return option_def_and_value
{*match
, match_ctx
, val
};
408 if (completion
!= nullptr)
410 const char *after_arg
= skip_to_space (*args
);
411 if (*after_arg
== '\0')
413 complete_on_enum (completion
->tracker
,
414 match
->enums
, *args
, *args
);
415 if (completion
->tracker
.have_completions ())
418 /* If we don't have completions, let the
419 non-completion path throw on invalid enum value
420 below, so that completion processing stops. */
424 if (check_for_argument (args
, "--"))
426 /* Treat e.g., "backtrace -entry-values --" as if there
427 was no argument after "-entry-values". This makes
428 parse_cli_var_enum throw an error with a suggestion of
429 what are the valid options. */
434 val
.enumeration
= parse_cli_var_enum (args
, match
->enums
);
435 return option_def_and_value
{*match
, match_ctx
, val
};
439 if (check_for_argument (args
, "--"))
441 /* Treat e.g., "maint test-options -string --" as if there
442 was no argument after "-string". */
443 error (_("-%s requires an argument"), match
->name
);
446 const char *arg_start
= *args
;
447 std::string str
= extract_string_maybe_quoted (args
);
448 if (*args
== arg_start
)
449 error (_("-%s requires an argument"), match
->name
);
452 val
.string
= new std::string (std::move (str
));
453 return option_def_and_value
{*match
, match_ctx
, val
};
458 gdb_assert_not_reached ("option type not supported");
464 /* See cli-option.h. */
467 complete_options (completion_tracker
&tracker
,
469 process_options_mode mode
,
470 gdb::array_view
<const option_def_group
> options_group
)
472 const char *text
= *args
;
474 tracker
.set_use_custom_word_point (true);
476 const char *delimiter
= find_end_options_delimiter (text
);
477 bool have_delimiter
= delimiter
!= nullptr;
479 if (text
[0] == '-' && (!have_delimiter
|| *delimiter
== '\0'))
481 parse_option_completion_info completion_info
{nullptr, tracker
};
485 *args
= skip_spaces (*args
);
486 completion_info
.word
= *args
;
488 if (strcmp (*args
, "-") == 0)
490 complete_on_options (options_group
, tracker
, *args
+ 1,
491 completion_info
.word
);
493 else if (strcmp (*args
, "--") == 0)
495 tracker
.add_completion (make_unique_xstrdup (*args
));
497 else if (**args
== '-')
499 std::optional
<option_def_and_value
> ov
500 = parse_option (options_group
, mode
, have_delimiter
,
501 args
, &completion_info
);
502 if (!ov
&& !tracker
.have_completions ())
504 tracker
.advance_custom_word_point_by (*args
- text
);
505 return mode
== PROCESS_OPTIONS_REQUIRE_DELIMITER
;
509 && ov
->option
.type
== var_boolean
510 && !ov
->value
.has_value ())
512 /* Looked like a boolean option, but we failed to
513 parse the value. If this command requires a
514 delimiter, this value can't be the start of the
515 operands, so return true. Otherwise, if the
516 command doesn't require a delimiter return false
517 so that the caller tries to complete on the
519 tracker
.advance_custom_word_point_by (*args
- text
);
520 return mode
== PROCESS_OPTIONS_REQUIRE_DELIMITER
;
523 /* If we parsed an option with an argument, and reached
524 the end of the input string with no trailing space,
525 return true, so that our callers don't try to
526 complete anything by themselves. E.g., this makes it
529 (gdb) frame apply all -limit 10[TAB]
531 we don't try to complete on command names. */
533 && !tracker
.have_completions ()
535 && *args
> text
&& !isspace ((*args
)[-1]))
537 tracker
.advance_custom_word_point_by
542 /* If the caller passed in a context, then it is
543 interested in the option argument values. */
544 if (ov
&& ov
->ctx
!= nullptr)
545 save_option_value_in_ctx (ov
);
549 tracker
.advance_custom_word_point_by
550 (completion_info
.word
- text
);
552 /* If the command requires a delimiter, but we haven't
553 seen one, then return true, so that the caller
554 doesn't try to complete on whatever follows options,
555 which for these commands should only be done if
556 there's a delimiter. */
557 if (mode
== PROCESS_OPTIONS_REQUIRE_DELIMITER
560 /* If we reached the end of the input string, then
561 offer all options, since that's all the user can
563 if (completion_info
.word
[0] == '\0')
564 complete_on_all_options (tracker
, options_group
);
571 if (tracker
.have_completions ())
573 tracker
.advance_custom_word_point_by
574 (completion_info
.word
- text
);
579 else if (delimiter
!= nullptr)
581 tracker
.advance_custom_word_point_by (delimiter
- text
);
589 /* Save the parsed value in the option's context. */
592 save_option_value_in_ctx (std::optional
<option_def_and_value
> &ov
)
594 switch (ov
->option
.type
)
598 bool value
= ov
->value
.has_value () ? ov
->value
->boolean
: true;
599 *ov
->option
.var_address
.boolean (ov
->option
, ov
->ctx
) = value
;
603 *ov
->option
.var_address
.uinteger (ov
->option
, ov
->ctx
)
604 = ov
->value
->uinteger
;
608 *ov
->option
.var_address
.integer (ov
->option
, ov
->ctx
)
609 = ov
->value
->integer
;
612 *ov
->option
.var_address
.enumeration (ov
->option
, ov
->ctx
)
613 = ov
->value
->enumeration
;
616 *ov
->option
.var_address
.string (ov
->option
, ov
->ctx
)
617 = std::move (*ov
->value
->string
);
620 gdb_assert_not_reached ("unhandled option type");
624 /* See cli-option.h. */
627 process_options (const char **args
,
628 process_options_mode mode
,
629 gdb::array_view
<const option_def_group
> options_group
)
631 if (*args
== nullptr)
634 /* If ARGS starts with "-", look for a "--" sequence. If one is
635 found, then interpret everything up until the "--" as
636 'gdb::option'-style command line options. Otherwise, interpret
637 ARGS as possibly the command's operands. */
638 bool have_delimiter
= find_end_options_delimiter (*args
) != nullptr;
640 if (mode
== PROCESS_OPTIONS_REQUIRE_DELIMITER
&& !have_delimiter
)
643 bool processed_any
= false;
647 *args
= skip_spaces (*args
);
649 auto ov
= parse_option (options_group
, mode
, have_delimiter
, args
);
657 processed_any
= true;
659 save_option_value_in_ctx (ov
);
663 /* Helper for build_help. Return a fragment of a help string showing
664 OPT's possible values. Returns NULL if OPT doesn't take an
668 get_val_type_str (const option_def
&opt
, std::string
&buffer
)
670 if (!opt
.have_argument
)
682 if (opt
.extra_literals
!= nullptr)
683 for (const literal_def
*l
= opt
.extra_literals
;
684 l
->literal
!= nullptr;
688 buffer
+= l
->literal
;
690 return buffer
.c_str ();
695 for (size_t i
= 0; opt
.enums
[i
] != nullptr; i
++)
699 buffer
+= opt
.enums
[i
];
701 return buffer
.c_str ();
710 /* Helper for build_help. Appends an indented version of DOC into
714 append_indented_doc (const char *doc
, std::string
&help
)
717 const char *n
= strchr (p
, '\n');
722 help
.append (p
, n
- p
+ 1);
724 n
= strchr (p
, '\n');
730 /* Fill HELP with an auto-generated "help" string fragment for
734 build_help_option (gdb::array_view
<const option_def
> options
,
739 for (const auto &o
: options
)
741 if (o
.set_doc
== nullptr)
747 const char *val_type_str
= get_val_type_str (o
, buffer
);
748 if (val_type_str
!= nullptr)
751 help
+= val_type_str
;
754 append_indented_doc (o
.set_doc
, help
);
755 if (o
.help_doc
!= nullptr)
758 append_indented_doc (o
.help_doc
, help
);
763 /* See cli-option.h. */
766 build_help (const char *help_tmpl
,
767 gdb::array_view
<const option_def_group
> options_group
)
769 bool need_newlines
= false;
770 std::string help_str
;
772 const char *p
= strstr (help_tmpl
, "%OPTIONS%");
773 help_str
.assign (help_tmpl
, p
);
775 for (const auto &grp
: options_group
)
776 for (const auto &opt
: grp
.options
)
781 need_newlines
= true;
782 build_help_option (opt
, help_str
);
785 p
+= strlen ("%OPTIONS%");
791 /* See cli-option.h. */
794 add_setshow_cmds_for_options (command_class cmd_class
,
796 gdb::array_view
<const option_def
> options
,
797 struct cmd_list_element
**set_list
,
798 struct cmd_list_element
**show_list
)
800 for (const auto &option
: options
)
802 if (option
.type
== var_boolean
)
804 add_setshow_boolean_cmd (option
.name
, cmd_class
,
805 option
.var_address
.boolean (option
, data
),
806 option
.set_doc
, option
.show_doc
,
808 nullptr, option
.show_cmd_cb
,
809 set_list
, show_list
);
811 else if (option
.type
== var_uinteger
)
813 add_setshow_uinteger_cmd (option
.name
, cmd_class
,
814 option
.var_address
.uinteger (option
, data
),
815 option
.extra_literals
,
816 option
.set_doc
, option
.show_doc
,
818 nullptr, option
.show_cmd_cb
,
819 set_list
, show_list
);
821 else if (option
.type
== var_integer
)
823 add_setshow_integer_cmd (option
.name
, cmd_class
,
824 option
.var_address
.integer (option
, data
),
825 option
.extra_literals
,
826 option
.set_doc
, option
.show_doc
,
828 nullptr, option
.show_cmd_cb
,
829 set_list
, show_list
);
831 else if (option
.type
== var_pinteger
)
833 add_setshow_pinteger_cmd (option
.name
, cmd_class
,
834 option
.var_address
.integer (option
, data
),
835 option
.extra_literals
,
836 option
.set_doc
, option
.show_doc
,
838 nullptr, option
.show_cmd_cb
,
839 set_list
, show_list
);
841 else if (option
.type
== var_enum
)
843 add_setshow_enum_cmd (option
.name
, cmd_class
,
845 option
.var_address
.enumeration (option
, data
),
846 option
.set_doc
, option
.show_doc
,
848 nullptr, option
.show_cmd_cb
,
849 set_list
, show_list
);
851 else if (option
.type
== var_string
)
853 add_setshow_string_cmd (option
.name
, cmd_class
,
854 option
.var_address
.string (option
, data
),
855 option
.set_doc
, option
.show_doc
,
857 nullptr, option
.show_cmd_cb
,
858 set_list
, show_list
);
861 gdb_assert_not_reached ("option type not handled");
865 } /* namespace option */
866 } /* namespace gdb */