X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=gdb%2Fcommand.h;h=32ee73af62c88f97f3a012a9537581b733e61b7a;hb=412294daf8786fd9060059b8be7fc59a35e13922;hp=3064ce29a8125f8893126f271a8e9cbd7a8b18ae;hpb=49c4e619f81a66545e2332dc218d9bf31bbb51ad;p=deliverable%2Fbinutils-gdb.git diff --git a/gdb/command.h b/gdb/command.h index 3064ce29a8..32ee73af62 100644 --- a/gdb/command.h +++ b/gdb/command.h @@ -1,7 +1,6 @@ /* Header file for command creation. - Copyright (C) 1986, 1989-1995, 1999-2000, 2002, 2004, 2007-2012 Free - Software Foundation, Inc. + Copyright (C) 1986-2017 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 @@ -20,6 +19,9 @@ #define COMMAND_H 1 #include "gdb_vecs.h" +#include "common/scoped_restore.h" + +struct completion_tracker; /* This file defines the public interface for any code wanting to create commands. */ @@ -77,7 +79,8 @@ typedef enum var_types /* 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. */ + 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 @@ -93,12 +96,16 @@ typedef enum var_types /* String which stores a filename. (*VAR) is a malloc'd string. */ var_filename, - /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except + /* 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. */ @@ -109,57 +116,116 @@ 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 + 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 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, + cmd_cfunc_ftype *fun, + const char *, + struct cmd_list_element **); + +/* 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_alias_cmd (char *, char *, +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_abbrev_prefix_cmd (const char *, enum command_class, - void (*fun) (char *, - int), - char *, + cmd_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); +/* Const-correct variant of the above. */ + +extern void set_cmd_cfunc (struct cmd_list_element *cmd, + cmd_const_cfunc_ftype *cfunc); + typedef void cmd_sfunc_ftype (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 *); +/* 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_cfunc_ftype *cfun); +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, @@ -179,47 +245,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_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_cfunc_ftype *fun, const char *doc, + int *supress_notification); -extern struct cmd_list_element *add_info_alias (char *, char *, int); +extern struct cmd_list_element *add_info (const char *, + cmd_cfunc_ftype *fun, + const char *); -extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *, - char *, char *); +extern struct cmd_list_element *add_info_alias (const char *, const char *, + int); -extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist, - char *, char *); +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 *, 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 @@ -233,8 +308,8 @@ 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, @@ -245,8 +320,8 @@ extern void add_setshow_enum_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -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, @@ -256,8 +331,8 @@ extern void add_setshow_auto_boolean_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_boolean_cmd (char *name, - enum command_class class, +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, @@ -266,8 +341,8 @@ extern void add_setshow_boolean_cmd (char *name, 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 void add_setshow_filename_cmd (const char *name, + enum command_class theclass, char **var, const char *set_doc, const char *show_doc, @@ -277,8 +352,8 @@ extern void add_setshow_filename_cmd (char *name, 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, @@ -288,19 +363,20 @@ extern void add_setshow_string_cmd (char *name, struct cmd_list_element **set_list, struct cmd_list_element **show_list); -extern void add_setshow_string_noescape_cmd (char *name, - enum command_class class, - char **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_optional_filename_cmd (char *name, - enum command_class class, +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_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, @@ -310,8 +386,8 @@ extern void add_setshow_optional_filename_cmd (char *name, 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, @@ -321,8 +397,8 @@ extern void add_setshow_integer_cmd (char *name, 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, @@ -332,8 +408,8 @@ extern void add_setshow_uinteger_cmd (char *name, 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, @@ -343,8 +419,8 @@ extern void add_setshow_zinteger_cmd (char *name, 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, @@ -354,24 +430,36 @@ extern void add_setshow_zuinteger_cmd (char *name, 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_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; extern void dont_repeat (void); -extern struct cleanup *prevent_dont_repeat (void); +extern scoped_restore_tmpl prevent_dont_repeat (void); /* 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);