2012-01-05 Pedro Alves <alves.ped@gmail.com>
* cli/cli-decode.h: Add comments.
(CMD_LIST_AMBIGUOUS): Moved to command.h
(add_cmd, add_alias_cmd, add_prefix_cmd, add_abbrev_prefix_cmd)
(set_cmd_cfunc, set_cmd_sfunc, set_cmd_completer, cmd_cfunc_eq)
(set_cmd_context, get_cmd_context, lookup_cmd, lookup_cmd_1)
(deprecate_cmd, deprecated_cmd_warning, lookup_cmd_composition)
(add_com, add_com_alias, add_info, add_info_alias)
(complete_on_cmdlist, complete_on_enum, help_list): Remove
declarations.
* command.h: Add and adjust comments.
(CMD_LIST_AMBIGUOUS): Moved here.
(help_cmd, help_cmd_list): Delete declarations.
2012-01-05 19:39:31 +08:00
|
|
|
/* Header file for command creation.
|
2002-03-24 08:40:35 +08:00
|
|
|
|
2013-01-01 14:33:28 +08:00
|
|
|
Copyright (C) 1986-2013 Free Software Foundation, Inc.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
1999-07-08 04:19:36 +08:00
|
|
|
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
|
2007-08-24 02:08:50 +08:00
|
|
|
the Free Software Foundation; either version 3 of the License, or
|
1999-07-08 04:19:36 +08:00
|
|
|
(at your option) any later version.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
1999-07-08 04:19:36 +08:00
|
|
|
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.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
1999-07-08 04:19:36 +08:00
|
|
|
You should have received a copy of the GNU General Public License
|
2007-08-24 02:08:50 +08:00
|
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
#if !defined (COMMAND_H)
|
|
|
|
#define COMMAND_H 1
|
|
|
|
|
* ada-lang.c (ada_make_symbol_completion_list): Return a VEC.
* breakpoint.c (catch_syscall_completer): Return a VEC.
* cli/cli-cmds.c (complete_command): Update.
* cli/cli-decode.c (complete_on_cmdlist): Return a VEC.
(complete_on_enum): Likewise.
* command.h: Include gdb_vecs.h.
(completer_ftype): Change return type.
(complete_on_cmdlist, complete_on_enum): Likewise.
* completer.c (noop_completer, filename_completer)
(location_completer): Return a VEC.
(add_struct_fields): Remove 'nextp' argument. Change 'output'
to a VEC.
(expression_completer, complete_line_internal, complete_line)
(command_completer): Return a VEC.
(gdb_completion_word_break_characters, line_completion_function):
Update.
* completer.h: Include gdb_vecs.h.
(complete_line, noop_completer, filename_completer)
(expression_completer, location_completer, command_completer):
Update.
* f-lang.c (f_word_break_characters): Return a VEC.
* interps.c (interpreter_completer): Return a VEC.
* language.h (struct language_defn)
<la_make_symbol_completion_list>: Return a VEC.
* python/py-cmd.c (cmdpy_completer): Return a VEC.
* symtab.c (free_completion_list): Take a VEC.
(return_val_size, return_val_index): Remove.
(return_val): Now a VEC.
(completion_list_add_name): Update.
(default_make_symbol_completion_list_break_on)
(default_make_symbol_completion_list, make_symbol_completion_list)
(make_symbol_completion_list_fn, make_file_symbol_completion_list):
Return a VEC.
(add_filename_to_list): Update.
(struct add_partial_filename_data) <list_used, list_alloced>: Remove.
<list>: Now a VEC.
(maybe_add_partial_symtab_filename): Update.
(make_source_files_completion_list): Return a VEC.
* symtab.h (default_make_symbol_completion_list_break_on)
(default_make_symbol_completion_list, make_symbol_completion_list)
(make_symbol_completion_list_fn, make_file_symbol_completion_list)
(make_source_files_completion_list): Update.
2012-06-13 23:47:16 +08:00
|
|
|
#include "gdb_vecs.h"
|
|
|
|
|
2012-01-05 Pedro Alves <alves.ped@gmail.com>
* cli/cli-decode.h: Add comments.
(CMD_LIST_AMBIGUOUS): Moved to command.h
(add_cmd, add_alias_cmd, add_prefix_cmd, add_abbrev_prefix_cmd)
(set_cmd_cfunc, set_cmd_sfunc, set_cmd_completer, cmd_cfunc_eq)
(set_cmd_context, get_cmd_context, lookup_cmd, lookup_cmd_1)
(deprecate_cmd, deprecated_cmd_warning, lookup_cmd_composition)
(add_com, add_com_alias, add_info, add_info_alias)
(complete_on_cmdlist, complete_on_enum, help_list): Remove
declarations.
* command.h: Add and adjust comments.
(CMD_LIST_AMBIGUOUS): Moved here.
(help_cmd, help_cmd_list): Delete declarations.
2012-01-05 19:39:31 +08:00
|
|
|
/* This file defines the public interface for any code wanting to
|
|
|
|
create commands. */
|
|
|
|
|
2011-01-01 06:59:52 +08:00
|
|
|
/* Command classes are top-level categories into which commands are
|
|
|
|
broken down for "help" purposes.
|
|
|
|
|
1999-09-29 05:55:21 +08:00
|
|
|
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"). */
|
|
|
|
|
|
|
|
enum command_class
|
|
|
|
{
|
|
|
|
/* Special args to help_list */
|
2006-10-31 19:45:41 +08:00
|
|
|
class_deprecated = -3, all_classes = -2, all_commands = -1,
|
1999-09-29 05:55:21 +08:00
|
|
|
/* Classes of commands */
|
2011-01-01 06:59:52 +08:00
|
|
|
no_class = -1, class_run = 0, class_vars, class_stack, class_files,
|
|
|
|
class_support, class_info, class_breakpoint, class_trace,
|
2009-11-21 01:23:38 +08:00
|
|
|
class_alias, class_bookmark, class_obscure, class_maintenance,
|
2011-02-15 07:41:33 +08:00
|
|
|
class_pseudo, class_tui, class_user, class_xdb,
|
|
|
|
no_set_class /* Used for "show" commands that have no corresponding
|
|
|
|
"set" command. */
|
1999-09-29 05:55:21 +08:00
|
|
|
};
|
|
|
|
|
2002-03-24 08:40:35 +08:00
|
|
|
/* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
|
|
|
|
cmd_types'' can be moved from "command.h" to "cli-decode.h". */
|
1999-04-16 09:35:26 +08:00
|
|
|
/* Not a set/show command. Note that some commands which begin with
|
|
|
|
"set" or "show" might be in this category, if their syntax does
|
|
|
|
not fall into one of the following categories. */
|
1999-07-08 04:19:36 +08:00
|
|
|
typedef enum cmd_types
|
|
|
|
{
|
|
|
|
not_set_cmd,
|
|
|
|
set_cmd,
|
|
|
|
show_cmd
|
|
|
|
}
|
|
|
|
cmd_types;
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
/* Types of "set" or "show" command. */
|
1999-07-08 04:19:36 +08:00
|
|
|
typedef enum var_types
|
|
|
|
{
|
|
|
|
/* "on" or "off". *VAR is an integer which is nonzero for on,
|
|
|
|
zero for off. */
|
|
|
|
var_boolean,
|
2000-06-23 16:12:27 +08:00
|
|
|
|
|
|
|
/* "on" / "true" / "enable" or "off" / "false" / "disable" or
|
2002-06-16 02:45:32 +08:00
|
|
|
"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
|
2010-12-29 10:11:04 +08:00
|
|
|
value. */
|
2000-06-23 16:12:27 +08:00
|
|
|
var_auto_boolean,
|
|
|
|
|
2011-01-01 06:59:52 +08:00
|
|
|
/* Unsigned Integer. *VAR is an unsigned int. The user can type
|
|
|
|
0 to mean "unlimited", which is stored in *VAR as UINT_MAX. */
|
1999-07-08 04:19:36 +08:00
|
|
|
var_uinteger,
|
|
|
|
|
2011-01-01 06:59:52 +08:00
|
|
|
/* Like var_uinteger but signed. *VAR is an int. The user can
|
|
|
|
type 0 to mean "unlimited", which is stored in *VAR as
|
2012-09-17 16:42:14 +08:00
|
|
|
INT_MAX. The only remaining use of it is the Python API.
|
|
|
|
Don't use it elsewhere. */
|
1999-07-08 04:19:36 +08:00
|
|
|
var_integer,
|
|
|
|
|
2011-01-01 06:59:52 +08:00
|
|
|
/* String which the user enters with escapes (e.g. the user types
|
|
|
|
\n and it is a real newline in the stored string).
|
1999-07-08 04:19:36 +08:00
|
|
|
*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,
|
2005-02-21 11:25:56 +08:00
|
|
|
/* 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. */
|
1999-07-08 04:19:36 +08:00
|
|
|
var_filename,
|
2012-07-20 00:01:13 +08:00
|
|
|
/* ZeroableInteger. *VAR is an int. Like var_integer except
|
1999-07-08 04:19:36 +08:00
|
|
|
that zero really means zero. */
|
|
|
|
var_zinteger,
|
2009-01-24 02:47:46 +08:00
|
|
|
/* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really
|
|
|
|
means zero. */
|
|
|
|
var_zuinteger,
|
2012-09-17 16:42:14 +08:00
|
|
|
/* ZeroableUnsignedInteger with unlimited value. *VAR is an unsigned
|
|
|
|
int, but its range is [0, INT_MAX]. -1 stands for unlimited. */
|
|
|
|
var_zuinteger_unlimited,
|
2011-01-01 06:59:52 +08:00
|
|
|
/* Enumerated type. Can only have one of the specified values.
|
|
|
|
*VAR is a char pointer to the name of the element that we
|
|
|
|
find. */
|
1999-07-08 04:19:36 +08:00
|
|
|
var_enum
|
|
|
|
}
|
|
|
|
var_types;
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
/* This structure records one command'd definition. */
|
2002-03-24 08:40:35 +08:00
|
|
|
struct cmd_list_element;
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2002-02-24 05:30:23 +08:00
|
|
|
/* Forward-declarations of the entry-points of cli/cli-decode.c. */
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2012-01-05 Pedro Alves <alves.ped@gmail.com>
* cli/cli-decode.h: Add comments.
(CMD_LIST_AMBIGUOUS): Moved to command.h
(add_cmd, add_alias_cmd, add_prefix_cmd, add_abbrev_prefix_cmd)
(set_cmd_cfunc, set_cmd_sfunc, set_cmd_completer, cmd_cfunc_eq)
(set_cmd_context, get_cmd_context, lookup_cmd, lookup_cmd_1)
(deprecate_cmd, deprecated_cmd_warning, lookup_cmd_composition)
(add_com, add_com_alias, add_info, add_info_alias)
(complete_on_cmdlist, complete_on_enum, help_list): Remove
declarations.
* command.h: Add and adjust comments.
(CMD_LIST_AMBIGUOUS): Moved here.
(help_cmd, help_cmd_list): Delete declarations.
2012-01-05 19:39:31 +08:00
|
|
|
/* API to the manipulation of command lists. */
|
|
|
|
|
2011-10-10 06:21:43 +08:00
|
|
|
extern int valid_user_defined_cmd_name_p (const char *name);
|
|
|
|
|
2000-05-28 09:12:42 +08:00
|
|
|
extern struct cmd_list_element *add_cmd (char *, enum command_class,
|
|
|
|
void (*fun) (char *, int), char *,
|
|
|
|
struct cmd_list_element **);
|
|
|
|
|
|
|
|
extern struct cmd_list_element *add_alias_cmd (char *, 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 *,
|
|
|
|
struct cmd_list_element **,
|
|
|
|
char *, int,
|
|
|
|
struct cmd_list_element **);
|
|
|
|
|
|
|
|
extern struct cmd_list_element *add_abbrev_prefix_cmd (char *,
|
|
|
|
enum command_class,
|
|
|
|
void (*fun) (char *,
|
|
|
|
int),
|
|
|
|
char *,
|
|
|
|
struct cmd_list_element
|
|
|
|
**, char *, int,
|
|
|
|
struct cmd_list_element
|
|
|
|
**);
|
|
|
|
|
2002-02-05 12:37:23 +08:00
|
|
|
/* Set the commands corresponding callback. */
|
|
|
|
|
2002-06-16 03:54:26 +08:00
|
|
|
typedef void cmd_cfunc_ftype (char *args, int from_tty);
|
2002-02-05 12:37:23 +08:00
|
|
|
extern void set_cmd_cfunc (struct cmd_list_element *cmd,
|
2002-06-16 03:54:26 +08:00
|
|
|
cmd_cfunc_ftype *cfunc);
|
2002-02-05 12:37:23 +08:00
|
|
|
|
2002-06-16 03:54:26 +08:00
|
|
|
typedef void cmd_sfunc_ftype (char *args, int from_tty,
|
|
|
|
struct cmd_list_element *c);
|
2002-02-05 12:37:23 +08:00
|
|
|
extern void set_cmd_sfunc (struct cmd_list_element *cmd,
|
2002-06-16 03:54:26 +08:00
|
|
|
cmd_sfunc_ftype *sfunc);
|
2002-02-05 12:37:23 +08:00
|
|
|
|
* ada-lang.c (ada_make_symbol_completion_list): Return a VEC.
* breakpoint.c (catch_syscall_completer): Return a VEC.
* cli/cli-cmds.c (complete_command): Update.
* cli/cli-decode.c (complete_on_cmdlist): Return a VEC.
(complete_on_enum): Likewise.
* command.h: Include gdb_vecs.h.
(completer_ftype): Change return type.
(complete_on_cmdlist, complete_on_enum): Likewise.
* completer.c (noop_completer, filename_completer)
(location_completer): Return a VEC.
(add_struct_fields): Remove 'nextp' argument. Change 'output'
to a VEC.
(expression_completer, complete_line_internal, complete_line)
(command_completer): Return a VEC.
(gdb_completion_word_break_characters, line_completion_function):
Update.
* completer.h: Include gdb_vecs.h.
(complete_line, noop_completer, filename_completer)
(expression_completer, location_completer, command_completer):
Update.
* f-lang.c (f_word_break_characters): Return a VEC.
* interps.c (interpreter_completer): Return a VEC.
* language.h (struct language_defn)
<la_make_symbol_completion_list>: Return a VEC.
* python/py-cmd.c (cmdpy_completer): Return a VEC.
* symtab.c (free_completion_list): Take a VEC.
(return_val_size, return_val_index): Remove.
(return_val): Now a VEC.
(completion_list_add_name): Update.
(default_make_symbol_completion_list_break_on)
(default_make_symbol_completion_list, make_symbol_completion_list)
(make_symbol_completion_list_fn, make_file_symbol_completion_list):
Return a VEC.
(add_filename_to_list): Update.
(struct add_partial_filename_data) <list_used, list_alloced>: Remove.
<list>: Now a VEC.
(maybe_add_partial_symtab_filename): Update.
(make_source_files_completion_list): Return a VEC.
* symtab.h (default_make_symbol_completion_list_break_on)
(default_make_symbol_completion_list, make_symbol_completion_list)
(make_symbol_completion_list_fn, make_file_symbol_completion_list)
(make_source_files_completion_list): Update.
2012-06-13 23:47:16 +08:00
|
|
|
typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *,
|
|
|
|
char *, char *);
|
2012-06-13 23:41:24 +08:00
|
|
|
|
|
|
|
extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *);
|
2002-03-06 14:28:35 +08:00
|
|
|
|
2002-02-24 04:12:13 +08:00
|
|
|
/* 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));
|
2002-02-05 12:37:23 +08:00
|
|
|
|
2010-12-29 10:11:04 +08:00
|
|
|
/* Each command object has a local context attached to it. */
|
2011-01-01 06:59:52 +08:00
|
|
|
extern void set_cmd_context (struct cmd_list_element *cmd,
|
|
|
|
void *context);
|
2002-03-19 10:19:17 +08:00
|
|
|
extern void *get_cmd_context (struct cmd_list_element *cmd);
|
|
|
|
|
|
|
|
|
2002-03-18 03:53:39 +08:00
|
|
|
/* 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);
|
|
|
|
|
2002-03-18 10:26:32 +08:00
|
|
|
/* Return the type of the command. */
|
|
|
|
extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
|
|
|
|
|
2012-01-05 Pedro Alves <alves.ped@gmail.com>
* cli/cli-decode.h: Add comments.
(CMD_LIST_AMBIGUOUS): Moved to command.h
(add_cmd, add_alias_cmd, add_prefix_cmd, add_abbrev_prefix_cmd)
(set_cmd_cfunc, set_cmd_sfunc, set_cmd_completer, cmd_cfunc_eq)
(set_cmd_context, get_cmd_context, lookup_cmd, lookup_cmd_1)
(deprecate_cmd, deprecated_cmd_warning, lookup_cmd_composition)
(add_com, add_com_alias, add_info, add_info_alias)
(complete_on_cmdlist, complete_on_enum, help_list): Remove
declarations.
* command.h: Add and adjust comments.
(CMD_LIST_AMBIGUOUS): Moved here.
(help_cmd, help_cmd_list): Delete declarations.
2012-01-05 19:39:31 +08:00
|
|
|
/* Flag for an ambiguous cmd_list result. */
|
|
|
|
#define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
|
2002-03-18 10:26:32 +08:00
|
|
|
|
2000-05-28 09:12:42 +08:00
|
|
|
extern struct cmd_list_element *lookup_cmd (char **,
|
|
|
|
struct cmd_list_element *, char *,
|
|
|
|
int, int);
|
|
|
|
|
|
|
|
extern struct cmd_list_element *lookup_cmd_1 (char **,
|
|
|
|
struct cmd_list_element *,
|
|
|
|
struct cmd_list_element **,
|
|
|
|
int);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2011-01-01 06:59:52 +08:00
|
|
|
extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
|
|
|
|
char * );
|
2000-03-23 Fernando Nasser <fnasser@cygnus.com>
From David Whedon <dwhedon@gordian.com>
* top.c (execute_command): Checks all commands beore executing
to see if the user needs to be warned that the command is
deprecated, warns user if appropriate.
(add_info), (add_info_alias), (add_com) , (add_com_alias): Changed
return values from void to struct cmd_list_element *.
* command.c (lookup_cmd_1): Check aliases before following link
in case user needs to be warned about a deprecated alias.
(deprecate_cmd): new exported function for command deprecation,
sets flags and posibly a replacement string.
(deprecated_cmd_warning): New exported funciton to warn user about
a deprecated command.
(lookup_cmd_composition): New exported function that determines
alias, prefix_command, and cmd based on a string. This is useful
is we want to full name of a command.
* command.h : Added prototypes for deprecate_cmd,
deprecated_warn_user and lookup_cmd_composition, added flags to
the cmd_list_element structure, changed return values for
add_com_* and add_info_* from void to cmd_list_element.
* maint.c : (maintenance_deprecate): New function to deprecate a
command. This exists only so that the testsuite can deprecate
commands at runtime and check the warning behavior.
(maintenance_undeprecate) : New function, drops deprecated flags.
(maintenance_do_deprecate): Actually does the (un)deprecation.
(initialize_maint_cmds): Added the above new deprecate commands.
2000-03-24 07:43:19 +08:00
|
|
|
|
2011-01-01 06:59:52 +08:00
|
|
|
extern void deprecated_cmd_warning (char **);
|
2000-03-23 Fernando Nasser <fnasser@cygnus.com>
From David Whedon <dwhedon@gordian.com>
* top.c (execute_command): Checks all commands beore executing
to see if the user needs to be warned that the command is
deprecated, warns user if appropriate.
(add_info), (add_info_alias), (add_com) , (add_com_alias): Changed
return values from void to struct cmd_list_element *.
* command.c (lookup_cmd_1): Check aliases before following link
in case user needs to be warned about a deprecated alias.
(deprecate_cmd): new exported function for command deprecation,
sets flags and posibly a replacement string.
(deprecated_cmd_warning): New exported funciton to warn user about
a deprecated command.
(lookup_cmd_composition): New exported function that determines
alias, prefix_command, and cmd based on a string. This is useful
is we want to full name of a command.
* command.h : Added prototypes for deprecate_cmd,
deprecated_warn_user and lookup_cmd_composition, added flags to
the cmd_list_element structure, changed return values for
add_com_* and add_info_* from void to cmd_list_element.
* maint.c : (maintenance_deprecate): New function to deprecate a
command. This exists only so that the testsuite can deprecate
commands at runtime and check the warning behavior.
(maintenance_undeprecate) : New function, drops deprecated flags.
(maintenance_do_deprecate): Actually does the (un)deprecation.
(initialize_maint_cmds): Added the above new deprecate commands.
2000-03-24 07:43:19 +08:00
|
|
|
|
2011-01-01 06:59:52 +08:00
|
|
|
extern int lookup_cmd_composition (char *text,
|
|
|
|
struct cmd_list_element **alias,
|
|
|
|
struct cmd_list_element **prefix_cmd,
|
|
|
|
struct cmd_list_element **cmd);
|
2000-03-23 Fernando Nasser <fnasser@cygnus.com>
From David Whedon <dwhedon@gordian.com>
* top.c (execute_command): Checks all commands beore executing
to see if the user needs to be warned that the command is
deprecated, warns user if appropriate.
(add_info), (add_info_alias), (add_com) , (add_com_alias): Changed
return values from void to struct cmd_list_element *.
* command.c (lookup_cmd_1): Check aliases before following link
in case user needs to be warned about a deprecated alias.
(deprecate_cmd): new exported function for command deprecation,
sets flags and posibly a replacement string.
(deprecated_cmd_warning): New exported funciton to warn user about
a deprecated command.
(lookup_cmd_composition): New exported function that determines
alias, prefix_command, and cmd based on a string. This is useful
is we want to full name of a command.
* command.h : Added prototypes for deprecate_cmd,
deprecated_warn_user and lookup_cmd_composition, added flags to
the cmd_list_element structure, changed return values for
add_com_* and add_info_* from void to cmd_list_element.
* maint.c : (maintenance_deprecate): New function to deprecate a
command. This exists only so that the testsuite can deprecate
commands at runtime and check the warning behavior.
(maintenance_undeprecate) : New function, drops deprecated flags.
(maintenance_do_deprecate): Actually does the (un)deprecation.
(initialize_maint_cmds): Added the above new deprecate commands.
2000-03-24 07:43:19 +08:00
|
|
|
|
2000-05-28 09:12:42 +08:00
|
|
|
extern struct cmd_list_element *add_com (char *, enum command_class,
|
2011-01-01 06:59:52 +08:00
|
|
|
void (*fun) (char *, int),
|
|
|
|
char *);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2000-05-28 09:12:42 +08:00
|
|
|
extern struct cmd_list_element *add_com_alias (char *, char *,
|
|
|
|
enum command_class, int);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2011-01-01 06:59:52 +08:00
|
|
|
extern struct cmd_list_element *add_info (char *,
|
|
|
|
void (*fun) (char *, int),
|
2000-05-28 09:12:42 +08:00
|
|
|
char *);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2000-05-28 09:12:42 +08:00
|
|
|
extern struct cmd_list_element *add_info_alias (char *, char *, int);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
* ada-lang.c (ada_make_symbol_completion_list): Return a VEC.
* breakpoint.c (catch_syscall_completer): Return a VEC.
* cli/cli-cmds.c (complete_command): Update.
* cli/cli-decode.c (complete_on_cmdlist): Return a VEC.
(complete_on_enum): Likewise.
* command.h: Include gdb_vecs.h.
(completer_ftype): Change return type.
(complete_on_cmdlist, complete_on_enum): Likewise.
* completer.c (noop_completer, filename_completer)
(location_completer): Return a VEC.
(add_struct_fields): Remove 'nextp' argument. Change 'output'
to a VEC.
(expression_completer, complete_line_internal, complete_line)
(command_completer): Return a VEC.
(gdb_completion_word_break_characters, line_completion_function):
Update.
* completer.h: Include gdb_vecs.h.
(complete_line, noop_completer, filename_completer)
(expression_completer, location_completer, command_completer):
Update.
* f-lang.c (f_word_break_characters): Return a VEC.
* interps.c (interpreter_completer): Return a VEC.
* language.h (struct language_defn)
<la_make_symbol_completion_list>: Return a VEC.
* python/py-cmd.c (cmdpy_completer): Return a VEC.
* symtab.c (free_completion_list): Take a VEC.
(return_val_size, return_val_index): Remove.
(return_val): Now a VEC.
(completion_list_add_name): Update.
(default_make_symbol_completion_list_break_on)
(default_make_symbol_completion_list, make_symbol_completion_list)
(make_symbol_completion_list_fn, make_file_symbol_completion_list):
Return a VEC.
(add_filename_to_list): Update.
(struct add_partial_filename_data) <list_used, list_alloced>: Remove.
<list>: Now a VEC.
(maybe_add_partial_symtab_filename): Update.
(make_source_files_completion_list): Return a VEC.
* symtab.h (default_make_symbol_completion_list_break_on)
(default_make_symbol_completion_list, make_symbol_completion_list)
(make_symbol_completion_list_fn, make_file_symbol_completion_list)
(make_source_files_completion_list): Update.
2012-06-13 23:47:16 +08:00
|
|
|
extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *,
|
2012-11-21 05:02:36 +08:00
|
|
|
char *, char *, int);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
* ada-lang.c (ada_make_symbol_completion_list): Return a VEC.
* breakpoint.c (catch_syscall_completer): Return a VEC.
* cli/cli-cmds.c (complete_command): Update.
* cli/cli-decode.c (complete_on_cmdlist): Return a VEC.
(complete_on_enum): Likewise.
* command.h: Include gdb_vecs.h.
(completer_ftype): Change return type.
(complete_on_cmdlist, complete_on_enum): Likewise.
* completer.c (noop_completer, filename_completer)
(location_completer): Return a VEC.
(add_struct_fields): Remove 'nextp' argument. Change 'output'
to a VEC.
(expression_completer, complete_line_internal, complete_line)
(command_completer): Return a VEC.
(gdb_completion_word_break_characters, line_completion_function):
Update.
* completer.h: Include gdb_vecs.h.
(complete_line, noop_completer, filename_completer)
(expression_completer, location_completer, command_completer):
Update.
* f-lang.c (f_word_break_characters): Return a VEC.
* interps.c (interpreter_completer): Return a VEC.
* language.h (struct language_defn)
<la_make_symbol_completion_list>: Return a VEC.
* python/py-cmd.c (cmdpy_completer): Return a VEC.
* symtab.c (free_completion_list): Take a VEC.
(return_val_size, return_val_index): Remove.
(return_val): Now a VEC.
(completion_list_add_name): Update.
(default_make_symbol_completion_list_break_on)
(default_make_symbol_completion_list, make_symbol_completion_list)
(make_symbol_completion_list_fn, make_file_symbol_completion_list):
Return a VEC.
(add_filename_to_list): Update.
(struct add_partial_filename_data) <list_used, list_alloced>: Remove.
<list>: Now a VEC.
(maybe_add_partial_symtab_filename): Update.
(make_source_files_completion_list): Return a VEC.
* symtab.h (default_make_symbol_completion_list_break_on)
(default_make_symbol_completion_list, make_symbol_completion_list)
(make_symbol_completion_list_fn, make_file_symbol_completion_list)
(make_source_files_completion_list): Update.
2012-06-13 23:47:16 +08:00
|
|
|
extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist,
|
|
|
|
char *, char *);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2012-01-05 Pedro Alves <alves.ped@gmail.com>
* cli/cli-decode.h: Add comments.
(CMD_LIST_AMBIGUOUS): Moved to command.h
(add_cmd, add_alias_cmd, add_prefix_cmd, add_abbrev_prefix_cmd)
(set_cmd_cfunc, set_cmd_sfunc, set_cmd_completer, cmd_cfunc_eq)
(set_cmd_context, get_cmd_context, lookup_cmd, lookup_cmd_1)
(deprecate_cmd, deprecated_cmd_warning, lookup_cmd_composition)
(add_com, add_com_alias, add_info, add_info_alias)
(complete_on_cmdlist, complete_on_enum, help_list): Remove
declarations.
* command.h: Add and adjust comments.
(CMD_LIST_AMBIGUOUS): Moved here.
(help_cmd, help_cmd_list): Delete declarations.
2012-01-05 19:39:31 +08:00
|
|
|
/* Functions that implement commands about CLI commands. */
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2000-02-02 08:21:19 +08:00
|
|
|
extern void help_list (struct cmd_list_element *, char *,
|
|
|
|
enum command_class, struct ui_file *);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2005-02-17 01:20:59 +08:00
|
|
|
/* 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;
|
|
|
|
|
2004-10-31 01:10:14 +08:00
|
|
|
extern void add_setshow_enum_cmd (char *name,
|
|
|
|
enum command_class class,
|
2012-01-29 02:08:22 +08:00
|
|
|
const char *const *enumlist,
|
2004-10-31 01:10:14 +08:00
|
|
|
const char **var,
|
|
|
|
const char *set_doc,
|
|
|
|
const char *show_doc,
|
|
|
|
const char *help_doc,
|
|
|
|
cmd_sfunc_ftype *set_func,
|
2005-02-17 01:20:59 +08:00
|
|
|
show_value_ftype *show_func,
|
2004-10-31 01:10:14 +08:00
|
|
|
struct cmd_list_element **set_list,
|
2005-02-10 07:15:01 +08:00
|
|
|
struct cmd_list_element **show_list);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2002-06-16 06:05:33 +08:00
|
|
|
extern void add_setshow_auto_boolean_cmd (char *name,
|
|
|
|
enum command_class class,
|
|
|
|
enum auto_boolean *var,
|
2004-07-29 01:26:27 +08:00
|
|
|
const char *set_doc,
|
|
|
|
const char *show_doc,
|
|
|
|
const char *help_doc,
|
2002-06-16 06:05:33 +08:00
|
|
|
cmd_sfunc_ftype *set_func,
|
2005-02-17 01:20:59 +08:00
|
|
|
show_value_ftype *show_func,
|
2002-06-16 06:05:33 +08:00
|
|
|
struct cmd_list_element **set_list,
|
|
|
|
struct cmd_list_element **show_list);
|
2000-06-23 16:12:27 +08:00
|
|
|
|
2002-06-16 05:07:59 +08:00
|
|
|
extern void add_setshow_boolean_cmd (char *name,
|
|
|
|
enum command_class class,
|
|
|
|
int *var,
|
2004-07-29 01:26:27 +08:00
|
|
|
const char *set_doc, const char *show_doc,
|
2005-02-17 Andrew Cagney <cagney@gnu.org>
* cli/cli-decode.c (add_setshow_cmd_full, add_setshow_enum_cmd)
(add_setshow_auto_boolean_cmd, add_setshow_boolean_cmd)
(add_setshow_filename_cmd, add_setshow_string_cmd)
(add_setshow_uinteger_cmd, add_setshow_zinteger_cmd): Delete
fprint_setshow parameter.
* command.h (fprint_setshow_ftype): Delete.
(add_setshow_cmd_full, add_setshow_enum_cmd)
(add_setshow_auto_boolean_cmd, add_setshow_boolean_cmd)
(add_setshow_filename_cmd, add_setshow_string_cmd)
(add_setshow_uinteger_cmd, add_setshow_zinteger_cmd): Delete
fprint_setshow parameter.
* aix-thread.c, alpha-tdep.c, arm-tdep.c, breakpoint.c: Update.
* complaints.c, cris-tdep.c, dwarf2read.c, frame.c: Update.
* hppa-tdep.c, infcall.c, m32r-rom.c, maint.c: Update.
* mips-tdep.c, nto-tdep.c, observer.c, remote-rdi.c: Update
* remote.c, target.c, cli/cli-logging.c: Update.
2005-02-17 21:49:56 +08:00
|
|
|
const char *help_doc,
|
2002-06-16 05:07:59 +08:00
|
|
|
cmd_sfunc_ftype *set_func,
|
2005-02-17 01:20:59 +08:00
|
|
|
show_value_ftype *show_func,
|
2002-06-16 05:07:59 +08:00
|
|
|
struct cmd_list_element **set_list,
|
|
|
|
struct cmd_list_element **show_list);
|
2001-10-01 00:16:16 +08:00
|
|
|
|
2004-07-29 03:42:01 +08:00
|
|
|
extern void add_setshow_filename_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,
|
2005-02-17 01:20:59 +08:00
|
|
|
show_value_ftype *show_func,
|
2004-07-29 03:42:01 +08:00
|
|
|
struct cmd_list_element **set_list,
|
|
|
|
struct cmd_list_element **show_list);
|
|
|
|
|
2009-08-13 22:56:19 +08:00
|
|
|
extern void add_setshow_string_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_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);
|
2005-02-17 Andrew Cagney <cagney@gnu.org>
* cli/cli-decode.c (add_setshow_cmd_full, add_setshow_enum_cmd)
(add_setshow_auto_boolean_cmd, add_setshow_boolean_cmd)
(add_setshow_filename_cmd, add_setshow_string_cmd)
(add_setshow_uinteger_cmd, add_setshow_zinteger_cmd): Delete
fprint_setshow parameter.
* command.h (fprint_setshow_ftype): Delete.
(add_setshow_cmd_full, add_setshow_enum_cmd)
(add_setshow_auto_boolean_cmd, add_setshow_boolean_cmd)
(add_setshow_filename_cmd, add_setshow_string_cmd)
(add_setshow_uinteger_cmd, add_setshow_zinteger_cmd): Delete
fprint_setshow parameter.
* aix-thread.c, alpha-tdep.c, arm-tdep.c, breakpoint.c: Update.
* complaints.c, cris-tdep.c, dwarf2read.c, frame.c: Update.
* hppa-tdep.c, infcall.c, m32r-rom.c, maint.c: Update.
* mips-tdep.c, nto-tdep.c, observer.c, remote-rdi.c: Update
* remote.c, target.c, cli/cli-logging.c: Update.
2005-02-17 23:00:36 +08:00
|
|
|
|
2005-02-21 11:25:56 +08:00
|
|
|
extern void add_setshow_optional_filename_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);
|
|
|
|
|
2009-08-13 22:56:19 +08:00
|
|
|
extern void add_setshow_integer_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);
|
2005-02-19 04:57:16 +08:00
|
|
|
|
2009-08-13 22:56:19 +08:00
|
|
|
extern void add_setshow_uinteger_cmd (char *name,
|
|
|
|
enum command_class class,
|
|
|
|
unsigned 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);
|
2004-05-07 21:35:52 +08:00
|
|
|
|
2009-08-13 22:56:19 +08:00
|
|
|
extern void add_setshow_zinteger_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);
|
2003-08-09 23:10:09 +08:00
|
|
|
|
2009-08-13 22:56:19 +08:00
|
|
|
extern void add_setshow_zuinteger_cmd (char *name,
|
|
|
|
enum command_class class,
|
|
|
|
unsigned int *var,
|
|
|
|
const char *set_doc,
|
|
|
|
const char *show_doc,
|
|
|
|
const char *help_doc,
|
2012-09-17 16:42:14 +08:00
|
|
|
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_zuinteger_unlimited_cmd (char *name,
|
|
|
|
enum command_class class,
|
|
|
|
unsigned int *var,
|
|
|
|
const char *set_doc,
|
|
|
|
const char *show_doc,
|
|
|
|
const char *help_doc,
|
2009-08-13 22:56:19 +08:00
|
|
|
cmd_sfunc_ftype *set_func,
|
|
|
|
show_value_ftype *show_func,
|
|
|
|
struct cmd_list_element **set_list,
|
|
|
|
struct cmd_list_element **show_list);
|
2009-01-24 02:47:46 +08:00
|
|
|
|
1999-04-16 09:35:26 +08:00
|
|
|
/* Do a "show" command for each thing on a command list. */
|
|
|
|
|
2000-05-28 09:12:42 +08:00
|
|
|
extern void cmd_show_list (struct cmd_list_element *, int, char *);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
gdb/
* cli/cli-cmds.h (error_no_arg): Remove. Move the comment ...
* command.h (error_no_arg): ... here. Remove NORETURN, change
ATTR_NORETURN to ATTRIBUTE_NORETURN.
* defs.h (NORETURN, ATTR_NORETURN): Remove.
(perror_with_name, verror, error, error_stream, vfatal, fatal)
(internal_verror, internal_error, nomem): Remove NORETURN, change
ATTR_NORETURN to ATTRIBUTE_NORETURN.
* exceptions.c (throw_exception, deprecated_throw_reason, throw_verror)
(throw_vfatal, throw_error): Remove NORETURN.
(throw_it): Remove NORETURN, change ATTR_NORETURN to ATTRIBUTE_NORETURN.
* exceptions.h (throw_exception, throw_verror, throw_vfatal)
(throw_error, deprecated_throw_reason): Remove NORETURN, change
ATTR_NORETURN to ATTRIBUTE_NORETURN.
* linespec.c (cplusplus_error): Remove NORETURN, change ATTR_NORETURN
to ATTRIBUTE_NORETURN for prototype, for the definition only remove
NORETURN.
* remote-mips.c (mips_error): Change NORETURN to ATTRIBUTE_NORETURN.
* remote-sim.c (gdb_os_error): Change ATTR_NORETURN to
ATTRIBUTE_NORETURN.
* target.c (tcomplain): Likewise.
* target.h (noprocess): Remove NORETURN, change ATTR_NORETURN to
ATTRIBUTE_NORETURN.
* utils.c (verror, error, vfatal, fatal, error_stream, internal_verror)
(internal_error, perror_with_name, nomem): Remove NORETURN.
* xml-support.h (gdb_xml_error): Change ATTR_NORETURN to
ATTRIBUTE_NORETURN.
gdb/doc/
* gdbint.texinfo (Host Definition): Remove items NORETURN and
ATTR_NORETURN.
2010-05-03 07:52:14 +08:00
|
|
|
/* Used everywhere whenever at least one parameter is required and
|
2010-12-29 10:11:04 +08:00
|
|
|
none is specified. */
|
gdb/
* cli/cli-cmds.h (error_no_arg): Remove. Move the comment ...
* command.h (error_no_arg): ... here. Remove NORETURN, change
ATTR_NORETURN to ATTRIBUTE_NORETURN.
* defs.h (NORETURN, ATTR_NORETURN): Remove.
(perror_with_name, verror, error, error_stream, vfatal, fatal)
(internal_verror, internal_error, nomem): Remove NORETURN, change
ATTR_NORETURN to ATTRIBUTE_NORETURN.
* exceptions.c (throw_exception, deprecated_throw_reason, throw_verror)
(throw_vfatal, throw_error): Remove NORETURN.
(throw_it): Remove NORETURN, change ATTR_NORETURN to ATTRIBUTE_NORETURN.
* exceptions.h (throw_exception, throw_verror, throw_vfatal)
(throw_error, deprecated_throw_reason): Remove NORETURN, change
ATTR_NORETURN to ATTRIBUTE_NORETURN.
* linespec.c (cplusplus_error): Remove NORETURN, change ATTR_NORETURN
to ATTRIBUTE_NORETURN for prototype, for the definition only remove
NORETURN.
* remote-mips.c (mips_error): Change NORETURN to ATTRIBUTE_NORETURN.
* remote-sim.c (gdb_os_error): Change ATTR_NORETURN to
ATTRIBUTE_NORETURN.
* target.c (tcomplain): Likewise.
* target.h (noprocess): Remove NORETURN, change ATTR_NORETURN to
ATTRIBUTE_NORETURN.
* utils.c (verror, error, vfatal, fatal, error_stream, internal_verror)
(internal_error, perror_with_name, nomem): Remove NORETURN.
* xml-support.h (gdb_xml_error): Change ATTR_NORETURN to
ATTRIBUTE_NORETURN.
gdb/doc/
* gdbint.texinfo (Host Definition): Remove items NORETURN and
ATTR_NORETURN.
2010-05-03 07:52:14 +08:00
|
|
|
|
|
|
|
extern void error_no_arg (char *) ATTRIBUTE_NORETURN;
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2000-05-28 09:12:42 +08:00
|
|
|
extern void dont_repeat (void);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2011-02-01 00:52:35 +08:00
|
|
|
extern struct cleanup *prevent_dont_repeat (void);
|
|
|
|
|
1999-04-16 09:35:26 +08:00
|
|
|
/* 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. */
|
|
|
|
|
2000-05-28 09:12:42 +08:00
|
|
|
extern void not_just_help_class_command (char *, int);
|
1999-04-16 09:35:26 +08:00
|
|
|
|
2011-01-01 06:59:52 +08:00
|
|
|
/* Check function pointer. */
|
2002-07-04 01:35:21 +08:00
|
|
|
extern int cmd_func_p (struct cmd_list_element *cmd);
|
|
|
|
|
2011-01-01 06:59:52 +08:00
|
|
|
/* Call the command function. */
|
|
|
|
extern void cmd_func (struct cmd_list_element *cmd,
|
|
|
|
char *args, int from_tty);
|
2002-07-04 01:35:21 +08:00
|
|
|
|
1999-04-16 09:35:26 +08:00
|
|
|
#endif /* !defined (COMMAND_H) */
|