mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2024-12-21 04:42:53 +08:00
3666a04883
This commits the result of running gdb/copyright.py as per our Start
of New Year procedure...
gdb/ChangeLog
Update copyright year range in copyright header of all GDB files.
587 lines
22 KiB
C++
587 lines
22 KiB
C++
/* Header file for command creation.
|
|
|
|
Copyright (C) 1986-2021 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
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
|
#if !defined (COMMAND_H)
|
|
#define COMMAND_H 1
|
|
|
|
#include "gdbsupport/gdb_vecs.h"
|
|
#include "gdbsupport/scoped_restore.h"
|
|
|
|
struct completion_tracker;
|
|
|
|
/* This file defines the public interface for any code wanting to
|
|
create commands. */
|
|
|
|
/* Command classes are top-level categories into which commands are
|
|
broken down for "help" purposes.
|
|
|
|
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
|
|
{
|
|
/* Classes of commands followed by a comment giving the name
|
|
to use in "help <classname>".
|
|
Note that help accepts unambiguous abbreviated class names. */
|
|
|
|
/* Special classes to help_list */
|
|
class_deprecated = -3,
|
|
all_classes = -2, /* help without <classname> */
|
|
all_commands = -1, /* all */
|
|
|
|
/* Classes of commands */
|
|
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
|
|
};
|
|
|
|
/* Types of "set" or "show" command. */
|
|
typedef enum var_types
|
|
{
|
|
/* "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
|
|
"auto. *VAR is an ``enum auto_boolean''. NOTE: In general a
|
|
custom show command will need to be implemented - one that for
|
|
"auto" prints both the "auto" and the current auto-selected
|
|
value. */
|
|
var_auto_boolean,
|
|
|
|
/* Unsigned Integer. *VAR is an unsigned int. The user can type
|
|
0 to mean "unlimited", which is stored in *VAR as UINT_MAX. */
|
|
var_uinteger,
|
|
|
|
/* Like var_uinteger but signed. *VAR is an int. The user can
|
|
type 0 to mean "unlimited", which is stored in *VAR as
|
|
INT_MAX. The only remaining use of it is the Python API.
|
|
Don't use it elsewhere. */
|
|
var_integer,
|
|
|
|
/* String which the user enters with escapes (e.g. the user types
|
|
\n and it is a real newline in the stored string).
|
|
*VAR is a malloc'd string, or NULL if the string is empty. */
|
|
var_string,
|
|
/* String which stores what the user types verbatim.
|
|
*VAR is a malloc'd string, or NULL if the string is empty. */
|
|
var_string_noescape,
|
|
/* String which stores a filename. (*VAR) is a malloc'd string,
|
|
or "" if the string was empty. */
|
|
var_optional_filename,
|
|
/* String which stores a filename. (*VAR) is a malloc'd
|
|
string. */
|
|
var_filename,
|
|
/* ZeroableInteger. *VAR is an int. Like var_integer except
|
|
that zero really means zero. */
|
|
var_zinteger,
|
|
/* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really
|
|
means zero. */
|
|
var_zuinteger,
|
|
/* ZeroableUnsignedInteger with unlimited value. *VAR is an int,
|
|
but its range is [0, INT_MAX]. -1 stands for unlimited and
|
|
other negative numbers are not allowed. */
|
|
var_zuinteger_unlimited,
|
|
/* Enumerated type. Can only have one of the specified values.
|
|
*VAR is a char pointer to the name of the element that we
|
|
find. */
|
|
var_enum
|
|
}
|
|
var_types;
|
|
|
|
/* This structure records one command'd definition. */
|
|
struct cmd_list_element;
|
|
|
|
typedef void cmd_const_cfunc_ftype (const char *args, int from_tty);
|
|
|
|
/* This structure specifies notifications to be suppressed by a cli
|
|
command interpreter. */
|
|
|
|
struct cli_suppress_notification
|
|
{
|
|
/* Inferior, thread, frame selected notification suppressed? */
|
|
int user_selected_context;
|
|
};
|
|
|
|
extern struct cli_suppress_notification cli_suppress_notification;
|
|
|
|
/* Forward-declarations of the entry-points of cli/cli-decode.c. */
|
|
|
|
/* API to the manipulation of command lists. */
|
|
|
|
/* 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. */
|
|
|
|
extern struct cmd_list_element *add_cmd (const char *, enum command_class,
|
|
cmd_const_cfunc_ftype *fun,
|
|
const char *,
|
|
struct cmd_list_element **);
|
|
|
|
/* Like add_cmd, but no command function is specified. */
|
|
|
|
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 **);
|
|
|
|
extern struct cmd_list_element *add_alias_cmd (const char *,
|
|
cmd_list_element *,
|
|
enum command_class, int,
|
|
struct cmd_list_element **);
|
|
|
|
|
|
extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class,
|
|
cmd_const_cfunc_ftype *fun,
|
|
const char *,
|
|
struct cmd_list_element **,
|
|
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,
|
|
const char *,
|
|
struct cmd_list_element
|
|
**, const char *, int,
|
|
struct cmd_list_element
|
|
**);
|
|
|
|
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_const_sfunc_ftype *sfunc);
|
|
|
|
/* A completion routine. Add possible completions to tracker.
|
|
|
|
TEXT is the text beyond what was matched for the command itself
|
|
(leading whitespace is skipped). It stops where we are supposed to
|
|
stop completing (rl_point) and is '\0' terminated. WORD points in
|
|
the same buffer as TEXT, and completions should be returned
|
|
relative to this position. For example, suppose TEXT is "foo" and
|
|
we want to complete to "foobar". If WORD is "oo", return "oobar";
|
|
if WORD is "baz/foo", return "baz/foobar". */
|
|
typedef void completer_ftype (struct cmd_list_element *,
|
|
completion_tracker &tracker,
|
|
const char *text, const char *word);
|
|
|
|
/* Same, but for set_cmd_completer_handle_brkchars. */
|
|
typedef void completer_handle_brkchars_ftype (struct cmd_list_element *,
|
|
completion_tracker &tracker,
|
|
const char *text, const char *word);
|
|
|
|
extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *);
|
|
|
|
/* Set the completer_handle_brkchars callback. */
|
|
|
|
extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *,
|
|
completer_handle_brkchars_ftype *);
|
|
|
|
/* 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_const_cfunc_ftype *cfun);
|
|
|
|
/* Each command object has a local context attached to it. */
|
|
extern void set_cmd_context (struct cmd_list_element *cmd,
|
|
void *context);
|
|
extern void *get_cmd_context (struct cmd_list_element *cmd);
|
|
|
|
|
|
/* Execute CMD's pre/post hook. Throw an error if the command fails.
|
|
If already executing this pre/post hook, or there is no pre/post
|
|
hook, the call is silently ignored. */
|
|
extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
|
|
extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
|
|
|
|
/* Flag for an ambiguous cmd_list result. */
|
|
#define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
|
|
|
|
extern struct cmd_list_element *lookup_cmd (const char **,
|
|
struct cmd_list_element *,
|
|
const char *,
|
|
std::string *,
|
|
int, int);
|
|
|
|
/* This routine takes a line of TEXT and a CLIST in which to start the
|
|
lookup. When it returns it will have incremented the text pointer past
|
|
the section of text it matched, set *RESULT_LIST to point to the list in
|
|
which the last word was matched, and will return a pointer to the cmd
|
|
list element which the text matches. It will return NULL if no match at
|
|
all was possible. It will return -1 (cast appropriately, ick) if ambigous
|
|
matches are possible; in this case *RESULT_LIST will be set to point to
|
|
the list in which there are ambiguous choices (and *TEXT will be set to
|
|
the ambiguous text string).
|
|
|
|
if DEFAULT_ARGS is not null, *DEFAULT_ARGS is set to the found command
|
|
default args (possibly empty).
|
|
|
|
If the located command was an abbreviation, this routine returns the base
|
|
command of the abbreviation. Note that *DEFAULT_ARGS will contain the
|
|
default args defined for the alias.
|
|
|
|
It does no error reporting whatsoever; control will always return
|
|
to the superior routine.
|
|
|
|
In the case of an ambiguous return (-1), *RESULT_LIST will be set to point
|
|
at the prefix_command (ie. the best match) *or* (special case) will be NULL
|
|
if no prefix command was ever found. For example, in the case of "info a",
|
|
"info" matches without ambiguity, but "a" could be "args" or "address", so
|
|
*RESULT_LIST is set to the cmd_list_element for "info". So in this case
|
|
RESULT_LIST should not be interpreted as a pointer to the beginning of a
|
|
list; it simply points to a specific command. In the case of an ambiguous
|
|
return *TEXT is advanced past the last non-ambiguous prefix (e.g.
|
|
"info t" can be "info types" or "info target"; upon return *TEXT has been
|
|
advanced past "info ").
|
|
|
|
If RESULT_LIST is NULL, don't set *RESULT_LIST (but don't otherwise
|
|
affect the operation).
|
|
|
|
This routine does *not* modify the text pointed to by TEXT.
|
|
|
|
If IGNORE_HELP_CLASSES is nonzero, ignore any command list elements which
|
|
are actually help classes rather than commands (i.e. the function field of
|
|
the struct cmd_list_element is NULL).
|
|
|
|
When LOOKUP_FOR_COMPLETION_P is true the completion is being requested
|
|
for the completion engine, no warnings should be printed. */
|
|
|
|
extern struct cmd_list_element *lookup_cmd_1
|
|
(const char **text, struct cmd_list_element *clist,
|
|
struct cmd_list_element **result_list, std::string *default_args,
|
|
int ignore_help_classes, bool lookup_for_completion_p = false);
|
|
|
|
extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
|
|
const char * );
|
|
|
|
extern void deprecated_cmd_warning (const char *, struct cmd_list_element *);
|
|
|
|
extern int lookup_cmd_composition (const char *text,
|
|
struct cmd_list_element **alias,
|
|
struct cmd_list_element **prefix_cmd,
|
|
struct cmd_list_element **cmd);
|
|
|
|
extern struct cmd_list_element *add_com (const char *, enum command_class,
|
|
cmd_const_cfunc_ftype *fun,
|
|
const char *);
|
|
|
|
extern struct cmd_list_element *add_com_alias (const char *, const char *,
|
|
enum command_class, int);
|
|
|
|
extern struct cmd_list_element *add_com_suppress_notification
|
|
(const char *name, enum command_class theclass,
|
|
cmd_const_cfunc_ftype *fun, const char *doc,
|
|
int *supress_notification);
|
|
|
|
extern struct cmd_list_element *add_info (const char *,
|
|
cmd_const_cfunc_ftype *fun,
|
|
const char *);
|
|
|
|
extern struct cmd_list_element *add_info_alias (const char *, const char *,
|
|
int);
|
|
|
|
extern void complete_on_cmdlist (struct cmd_list_element *,
|
|
completion_tracker &tracker,
|
|
const char *, const char *, int);
|
|
|
|
extern void complete_on_enum (completion_tracker &tracker,
|
|
const char *const *enumlist,
|
|
const char *, const char *);
|
|
|
|
/* Functions that implement commands about CLI commands. */
|
|
|
|
extern void help_list (struct cmd_list_element *, const char *,
|
|
enum command_class, struct ui_file *);
|
|
|
|
/* Method for show a set/show variable's VALUE on FILE. If this
|
|
method isn't supplied deprecated_show_value_hack() is called (which
|
|
is not good). */
|
|
typedef void (show_value_ftype) (struct ui_file *file,
|
|
int from_tty,
|
|
struct cmd_list_element *cmd,
|
|
const char *value);
|
|
/* NOTE: i18n: This function is not i18n friendly. Callers should
|
|
instead print the value out directly. */
|
|
extern show_value_ftype deprecated_show_value_hack;
|
|
|
|
extern void add_setshow_enum_cmd (const char *name,
|
|
enum command_class theclass,
|
|
const char *const *enumlist,
|
|
const char **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,
|
|
void *context = nullptr);
|
|
|
|
extern void add_setshow_auto_boolean_cmd (const char *name,
|
|
enum command_class theclass,
|
|
enum auto_boolean *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,
|
|
char **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_string_cmd (const char *name,
|
|
enum command_class theclass,
|
|
char **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 struct cmd_list_element *add_setshow_string_noescape_cmd
|
|
(const char *name,
|
|
enum command_class theclass,
|
|
char **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_optional_filename_cmd (const char *name,
|
|
enum command_class theclass,
|
|
char **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_integer_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 void add_setshow_uinteger_cmd (const char *name,
|
|
enum command_class theclass,
|
|
unsigned 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 void add_setshow_zinteger_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 void add_setshow_zuinteger_cmd (const char *name,
|
|
enum command_class theclass,
|
|
unsigned 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 void
|
|
add_setshow_zuinteger_unlimited_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);
|
|
|
|
/* Do a "show" command for each thing on a command list. */
|
|
|
|
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;
|
|
|
|
|
|
/* 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<int> 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. */
|
|
|
|
extern void not_just_help_class_command (const char *, int);
|
|
|
|
/* Check function pointer. */
|
|
extern int cmd_func_p (struct cmd_list_element *cmd);
|
|
|
|
/* Call the command function. */
|
|
extern void cmd_func (struct cmd_list_element *cmd,
|
|
const char *args, int from_tty);
|
|
|
|
#endif /* !defined (COMMAND_H) */
|