X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=gdb%2Fcommand.h;h=32b5b35b0c51275a0a9a211bd494d4bfd446db85;hb=refs%2Fheads%2Fconcurrent-displaced-stepping-2020-04-01;hp=3dde2475cb15381d28012610631ec29a368ca784;hpb=e2882c85786571175a0b0bfc3bcd2f14620b1ea3;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/command.h b/gdb/command.h index 3dde2475cb..32b5b35b0c 100644 --- a/gdb/command.h +++ b/gdb/command.h @@ -1,6 +1,6 @@ /* Header file for command creation. - Copyright (C) 1986-2018 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; @@ -29,21 +29,46 @@ struct completion_tracker; /* Command classes are top-level categories into which commands are broken down for "help" purposes. - Notes on classes: class_alias is for alias commands which are not - abbreviations of the original command. class-pseudo is for - commands which are not really commands nor help topics ("stop"). */ + The class_alias is used for the user-defined aliases, defined + using the "alias" command. + + Aliases pre-defined by GDB (e.g. the alias "bt" of the "backtrace" command) + are not using the class_alias. + Different pre-defined aliases of the same command do not necessarily + have the same classes. For example, class_stack is used for the + "backtrace" and its "bt" alias", while "info stack" (also an alias + of "backtrace" uses class_info. */ enum command_class { - /* Special args to help_list */ - class_deprecated = -3, all_classes = -2, all_commands = -1, + /* Classes of commands followed by a comment giving the name + to use in "help ". + Note that help accepts unambiguous abbreviated class names. */ + + /* Special classes to help_list */ + class_deprecated = -3, + all_classes = -2, /* help without */ + all_commands = -1, /* all */ + /* Classes of commands */ - no_class = -1, class_run = 0, class_vars, class_stack, class_files, - class_support, class_info, class_breakpoint, class_trace, - class_alias, class_bookmark, class_obscure, class_maintenance, - class_pseudo, class_tui, class_user, class_xdb, - no_set_class /* Used for "show" commands that have no corresponding - "set" command. */ + no_class = -1, + class_run = 0, /* running */ + class_vars, /* data */ + class_stack, /* stack */ + class_files, /* files */ + class_support, /* support */ + class_info, /* status */ + class_breakpoint, /* breakpoints */ + class_trace, /* tracepoints */ + class_alias, /* aliases */ + class_bookmark, + class_obscure, /* obscure */ + class_maintenance, /* internals */ + class_tui, /* text-user-interface */ + class_user, /* user-defined */ + + /* Used for "show" commands that have no corresponding "set" command. */ + no_set_class }; /* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum @@ -62,8 +87,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 @@ -133,7 +158,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 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. */ @@ -148,6 +181,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 **); @@ -165,6 +204,28 @@ extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class const char *, int, struct cmd_list_element **); +/* Like add_prefix_cmd, but sets the callback to a function that + simply calls help_list. */ + +extern struct cmd_list_element *add_basic_prefix_cmd + (const char *, enum command_class, const char *, struct cmd_list_element **, + const char *, int, struct cmd_list_element **); + +/* Like add_prefix_cmd, but useful for "show" prefixes. This sets the + callback to a function that simply calls cmd_show_list. */ + +extern struct cmd_list_element *add_show_prefix_cmd + (const char *, enum command_class, const char *, struct cmd_list_element **, + 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, @@ -300,7 +361,8 @@ extern void add_setshow_enum_cmd (const char *name, 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, @@ -313,15 +375,16 @@ extern void add_setshow_auto_boolean_cmd (const char *name, 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_const_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, @@ -426,14 +489,39 @@ extern void /* Do a "show" command for each thing on a command list. */ -extern void cmd_show_list (struct cmd_list_element *, int, const char *); +extern void cmd_show_list (struct cmd_list_element *, int); /* Used everywhere whenever at least one parameter is required and none is specified. */ 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); @@ -442,6 +530,18 @@ extern scoped_restore_tmpl prevent_dont_repeat (void); 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. */