X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=gdb%2Fcommand.h;h=7f436c72c9809fc58d5055a2db0bfab94f21016f;hb=f3f8ece4b1c77c925d1f1566df0bf632790a4d24;hp=a99544563cc932d5ae48711389f77ef10c039c59;hpb=c2252c0dd8dcf3bb95598149aecd3158e89c31d7;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/command.h b/gdb/command.h index a99544563c..7f436c72c9 100644 --- a/gdb/command.h +++ b/gdb/command.h @@ -1,6 +1,6 @@ /* Header file for command creation. - Copyright (C) 1986-2017 Free Software Foundation, Inc. + Copyright (C) 1986-2020 Free Software Foundation, Inc. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -18,8 +18,8 @@ #if !defined (COMMAND_H) #define COMMAND_H 1 -#include "gdb_vecs.h" -#include "common/scoped_restore.h" +#include "gdbsupport/gdb_vecs.h" +#include "gdbsupport/scoped_restore.h" struct completion_tracker; @@ -62,8 +62,8 @@ cmd_types; /* Types of "set" or "show" command. */ typedef enum var_types { - /* "on" or "off". *VAR is an integer which is nonzero for on, - zero for off. */ + /* "on" or "off". *VAR is a bool which is true for on, + false for off. */ var_boolean, /* "on" / "true" / "enable" or "off" / "false" / "disable" or @@ -116,7 +116,6 @@ var_types; /* This structure records one command'd definition. */ struct cmd_list_element; -typedef void cmd_cfunc_ftype (char *args, int from_tty); typedef void cmd_const_cfunc_ftype (const char *args, int from_tty); /* This structure specifies notifications to be suppressed by a cli @@ -134,12 +133,15 @@ extern struct cli_suppress_notification cli_suppress_notification; /* API to the manipulation of command lists. */ -extern int valid_user_defined_cmd_name_p (const char *name); +/* Return TRUE if NAME is a valid user-defined command name. + This is a stricter subset of all gdb commands, + see find_command_name_length. */ -extern struct cmd_list_element *add_cmd (const char *, enum command_class, - cmd_cfunc_ftype *fun, - const char *, - struct cmd_list_element **); +extern bool valid_user_defined_cmd_name_p (const char *name); + +/* Return TRUE if C is a valid command character. */ + +extern bool valid_cmd_char_p (int c); /* Const-correct variant of the above. */ @@ -154,6 +156,12 @@ extern struct cmd_list_element *add_cmd (const char *, enum command_class, const char *, struct cmd_list_element **); +extern struct cmd_list_element *add_cmd_suppress_notification + (const char *name, enum command_class theclass, + cmd_const_cfunc_ftype *fun, const char *doc, + struct cmd_list_element **list, + int *suppress_notification); + extern struct cmd_list_element *add_alias_cmd (const char *, const char *, enum command_class, int, struct cmd_list_element **); @@ -171,6 +179,14 @@ extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class const char *, int, struct cmd_list_element **); +extern struct cmd_list_element *add_prefix_cmd_suppress_notification + (const char *name, enum command_class theclass, + cmd_const_cfunc_ftype *fun, + const char *doc, struct cmd_list_element **prefixlist, + const char *prefixname, int allow_unknown, + struct cmd_list_element **list, + int *suppress_notification); + extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *, enum command_class, cmd_const_cfunc_ftype *fun, @@ -180,10 +196,10 @@ extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *, struct cmd_list_element **); -typedef void cmd_sfunc_ftype (char *args, int from_tty, - struct cmd_list_element *c); +typedef void cmd_const_sfunc_ftype (const char *args, int from_tty, + struct cmd_list_element *c); extern void set_cmd_sfunc (struct cmd_list_element *cmd, - cmd_sfunc_ftype *sfunc); + cmd_const_sfunc_ftype *sfunc); /* A completion routine. Add possible completions to tracker. @@ -212,8 +228,6 @@ extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *, /* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs around in cmd objects to test the value of the commands sfunc(). */ -extern int cmd_cfunc_eq (struct cmd_list_element *cmd, - cmd_cfunc_ftype *cfun); extern int cmd_cfunc_eq (struct cmd_list_element *cmd, cmd_const_cfunc_ftype *cfun); @@ -256,7 +270,7 @@ extern int lookup_cmd_composition (const char *text, struct cmd_list_element **cmd); extern struct cmd_list_element *add_com (const char *, enum command_class, - cmd_cfunc_ftype *fun, + cmd_const_cfunc_ftype *fun, const char *); extern struct cmd_list_element *add_com_alias (const char *, const char *, @@ -268,7 +282,7 @@ extern struct cmd_list_element *add_com_suppress_notification int *supress_notification); extern struct cmd_list_element *add_info (const char *, - cmd_cfunc_ftype *fun, + cmd_const_cfunc_ftype *fun, const char *); extern struct cmd_list_element *add_info_alias (const char *, const char *, @@ -305,10 +319,11 @@ extern void add_setshow_enum_cmd (const char *name, const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, - struct cmd_list_element **show_list); + struct cmd_list_element **show_list, + void *context = nullptr); extern void add_setshow_auto_boolean_cmd (const char *name, enum command_class theclass, @@ -316,20 +331,21 @@ extern void add_setshow_auto_boolean_cmd (const char *name, const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_boolean_cmd (const char *name, - enum command_class theclass, - int *var, - const char *set_doc, const char *show_doc, - const char *help_doc, - cmd_sfunc_ftype *set_func, - show_value_ftype *show_func, - struct cmd_list_element **set_list, - struct cmd_list_element **show_list); +extern cmd_list_element * + add_setshow_boolean_cmd (const char *name, + enum command_class theclass, + bool *var, + const char *set_doc, const char *show_doc, + const char *help_doc, + cmd_const_sfunc_ftype *set_func, + show_value_ftype *show_func, + struct cmd_list_element **set_list, + struct cmd_list_element **show_list); extern void add_setshow_filename_cmd (const char *name, enum command_class theclass, @@ -337,7 +353,7 @@ extern void add_setshow_filename_cmd (const char *name, const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, struct cmd_list_element **show_list); @@ -348,7 +364,7 @@ extern void add_setshow_string_cmd (const char *name, const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, struct cmd_list_element **show_list); @@ -360,7 +376,7 @@ extern struct cmd_list_element *add_setshow_string_noescape_cmd const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, struct cmd_list_element **show_list); @@ -371,7 +387,7 @@ extern void add_setshow_optional_filename_cmd (const char *name, const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, struct cmd_list_element **show_list); @@ -382,7 +398,7 @@ extern void add_setshow_integer_cmd (const char *name, const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, struct cmd_list_element **show_list); @@ -393,7 +409,7 @@ extern void add_setshow_uinteger_cmd (const char *name, const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, struct cmd_list_element **show_list); @@ -404,7 +420,7 @@ extern void add_setshow_zinteger_cmd (const char *name, const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, struct cmd_list_element **show_list); @@ -415,7 +431,7 @@ extern void add_setshow_zuinteger_cmd (const char *name, const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, struct cmd_list_element **show_list); @@ -427,7 +443,7 @@ extern void const char *set_doc, const char *show_doc, const char *help_doc, - cmd_sfunc_ftype *set_func, + cmd_const_sfunc_ftype *set_func, show_value_ftype *show_func, struct cmd_list_element **set_list, struct cmd_list_element **show_list); @@ -441,10 +457,52 @@ extern void cmd_show_list (struct cmd_list_element *, int, const char *); extern void error_no_arg (const char *) ATTRIBUTE_NORETURN; -extern void dont_repeat (void); + +/* Command line saving and repetition. + Each input line executed is saved to possibly be repeated either + when the user types an empty line, or be repeated by a command + that wants to repeat the previously executed command. The below + functions control command repetition. */ + +/* Commands call dont_repeat if they do not want to be repeated by null + lines or by repeat_previous (). */ + +extern void dont_repeat (); + +/* Commands call repeat_previous if they want to repeat the previous + command. Such commands that repeat the previous command must + indicate to not repeat themselves, to avoid recursive repeat. + repeat_previous marks the current command as not repeating, and + ensures get_saved_command_line returns the previous command, so + that the currently executing command can repeat it. If there's no + previous command, throws an error. Otherwise, returns the result + of get_saved_command_line, which now points at the command to + repeat. */ + +extern const char *repeat_previous (); + +/* Prevent dont_repeat from working, and return a cleanup that + restores the previous state. */ extern scoped_restore_tmpl prevent_dont_repeat (void); +/* Set the arguments that will be passed if the current command is + repeated. Note that the passed-in string must be a constant. */ + +extern void set_repeat_arguments (const char *args); + +/* Returns the saved command line to repeat. + When a command is being executed, this is the currently executing + command line, unless the currently executing command has called + repeat_previous (): in this case, get_saved_command_line returns + the previously saved command line. */ + +extern char *get_saved_command_line (); + +/* Takes a copy of CMD, for possible repetition. */ + +extern void save_command_line (const char *cmd); + /* Used to mark commands that don't do anything. If we just leave the function field NULL, the command is interpreted as a help topic, or as a class of commands. */ @@ -456,6 +514,6 @@ extern int cmd_func_p (struct cmd_list_element *cmd); /* Call the command function. */ extern void cmd_func (struct cmd_list_element *cmd, - char *args, int from_tty); + const char *args, int from_tty); #endif /* !defined (COMMAND_H) */