X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=gdb%2Fcommand.h;h=4d52f00de51da1d26f87e970de875e6ced3938f8;hb=c596f180a130c85faf8942d161be9ecf71c6791c;hp=a25fe04090a78ddfd332c6476d5b29799d3c7447;hpb=b69b1fb10d005fd658668d7e2888c14c249a3481;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/command.h b/gdb/command.h index a25fe04090..4d52f00de5 100644 --- a/gdb/command.h +++ b/gdb/command.h @@ -1,6 +1,6 @@ /* Header file for command creation. - Copyright (C) 1986-2013 Free Software Foundation, Inc. + Copyright (C) 1986-2019 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,7 +18,10 @@ #if !defined (COMMAND_H) #define COMMAND_H 1 -#include "gdb_vecs.h" +#include "common/gdb_vecs.h" +#include "common/scoped_restore.h" + +struct completion_tracker; /* This file defines the public interface for any code wanting to create commands. */ @@ -113,57 +116,112 @@ 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. */ -extern int valid_user_defined_cmd_name_p (const char *name); +extern bool valid_user_defined_cmd_name_p (const char *name); + +/* 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 (char *, enum command_class, - void (*fun) (char *, int), char *, +extern struct cmd_list_element *add_cmd (const char *, enum command_class, + const char *, struct cmd_list_element **); -extern struct cmd_list_element *add_alias_cmd (char *, char *, +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_prefix_cmd (char *, enum command_class, - void (*fun) (char *, int), - char *, +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 **, - char *, int, + const char *, int, struct cmd_list_element **); -extern struct cmd_list_element *add_abbrev_prefix_cmd (char *, +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, - void (*fun) (char *, - int), - char *, + cmd_const_cfunc_ftype *fun, + const char *, struct cmd_list_element - **, char *, int, + **, const char *, int, struct cmd_list_element **); -/* Set the commands corresponding callback. */ - -typedef void cmd_cfunc_ftype (char *args, int from_tty); -extern void set_cmd_cfunc (struct cmd_list_element *cmd, - cmd_cfunc_ftype *cfunc); - -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); - -typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *, - char *, char *); + 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, - void (*cfunc) (char *args, int from_tty)); + 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, @@ -183,47 +241,56 @@ extern enum cmd_types cmd_type (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 (char **, - struct cmd_list_element *, char *, +extern struct cmd_list_element *lookup_cmd (const char **, + struct cmd_list_element *, + const char *, int, int); -extern struct cmd_list_element *lookup_cmd_1 (char **, +extern struct cmd_list_element *lookup_cmd_1 (const char **, struct cmd_list_element *, struct cmd_list_element **, int); extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *, - char * ); + const char * ); -extern void deprecated_cmd_warning (char **); +extern void deprecated_cmd_warning (const char *); -extern int lookup_cmd_composition (char *text, +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 (char *, enum command_class, - void (*fun) (char *, int), - char *); +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 (char *, char *, +extern struct cmd_list_element *add_com_alias (const char *, const char *, enum command_class, int); -extern struct cmd_list_element *add_info (char *, - void (*fun) (char *, int), - char *); +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 (char *, char *, int); +extern struct cmd_list_element *add_info_alias (const char *, const char *, + int); -extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *, - char *, char *, int); +extern void complete_on_cmdlist (struct cmd_list_element *, + completion_tracker &tracker, + const char *, const char *, int); -extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist, - char *, char *); +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 *, char *, +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 @@ -237,164 +304,205 @@ typedef void (show_value_ftype) (struct ui_file *file, instead print the value out directly. */ extern show_value_ftype deprecated_show_value_hack; -extern void add_setshow_enum_cmd (char *name, - enum command_class class, +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_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 (char *name, - enum command_class class, +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_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 (char *name, - enum command_class class, - 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 void add_setshow_filename_cmd (char *name, - enum command_class class, +extern cmd_list_element * + 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 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_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_string_cmd (char *name, - enum command_class class, +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_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 struct cmd_list_element *add_setshow_string_noescape_cmd - (char *name, - enum command_class class, + (const char *name, + enum command_class theclass, char **var, 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_optional_filename_cmd (char *name, - enum command_class class, +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_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_integer_cmd (char *name, - enum command_class class, +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_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_uinteger_cmd (char *name, - enum command_class class, +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_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_zinteger_cmd (char *name, - enum command_class class, +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_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_zuinteger_cmd (char *name, - enum command_class class, +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_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_zuinteger_unlimited_cmd (char *name, - enum command_class class, + 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_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); /* Do a "show" command for each thing on a command list. */ -extern void cmd_show_list (struct cmd_list_element *, int, char *); +extern void cmd_show_list (struct cmd_list_element *, int, const char *); /* Used everywhere whenever at least one parameter is required and none is specified. */ -extern void error_no_arg (char *) ATTRIBUTE_NORETURN; +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 will mark the current command as not repeating, + and will ensure get_saved_command_line returns the previous command, + so that the currently executing command can repeat it. */ + +extern void 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 (); -extern void dont_repeat (void); +/* Takes a copy of CMD, for possible repetition. */ -extern struct cleanup *prevent_dont_repeat (void); +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 (char *, int); +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, - char *args, int from_tty); + const char *args, int from_tty); #endif /* !defined (COMMAND_H) */