2000-12-01 Fernando Nasser <fnasser@redhat.com>
* cli/cli-decode.c: New file. Handle lists of commands, their decoding
and documentation.
(add_cmd, deprecate_cmd, add_abbrev_cmd, add_alias_cmd, add_prefix_cmd,
add_abbrev_prefix_cmd, not_just_help_class_command, empty_sfunc,
add_set_cmd, add_set_enum_cmd, add_set_auto_boolean_cmd,
add_show_from_set, delete_cmd, apropos_cmd, help_cmd, help_list,
help_all, print_doc_line, help_cmd_list, find_cmd, lookup_cmd_1,
undef_cmd_error, lookup_cmd, deprecated_cmd_warning,
lookup_cmd_composition, complete_on_cmdlist, complete_on_enum):
Moved here from command.c.
(add_info, add_info_alias, add_com, add_com_alias): Moved here from
top.c.
* cli/cli-decode.h: Definitions/declarations for the above.
* cli/cli-cmds.c: New file. GDB CLI commands.
(error_no_arg, info_command, show_command, help_command, show_version,
quit_command, pwd_command, cd_command, echo_command, shell_escape,
make_command, show_user, set_debug, show_debug, init_cmd_lists):
Moved here from top.c.
(apropos_command): Moved here from command.c.
(complete_command, source_command): Moved here (part) from top.c.
(is_complete_command): New function. Checks if a command is the
"complete" command.
(init_cli_cmds): New function. Add commands to the CLI (from code
previously in top.c.
* cli/cli-cmds.h: Definitions/declarations for the above.
* cli/cli-script.c: New file. GDB CLI command scripting.
(build_command_line, get_command_line, print_command_lines,
print_command_line, execute_user_command, execute_control_command,
while_command, if_command, arg_cleanup, setup_user_args, locate_arg,
insert_args, realloc_body_list, read_next_line,
recurse_read_control_structure, read_command_lines, free_command_lines,
do_free_command_lines_cleanup, make_cleanup_free_command_lines,
validate_comname, user_defined_command, define_command,
document_command, source_cleanup_lines, do_fclose_cleanup,
show_user_1): Moved here from top.c.
(script_from_file): New function. Implements execution of a script
contained in a file (part of code for the source_command() that used
to exist in top.c).
* cli/cli-script.h: Definitions/declarations for the above.
* cli/cli-setshow.c: New file. Handle set and show GDB CLI commands.
(parse_auto_binary_operation, parse_binary_operation,
do_setshow_command, cmd_show_list): Moved here from command.c.
* cli/cli-setshow.h: Definitions/declarations for the above.
* top.c: Remove all CLI code, except the command loop.
(gdb_init): Call init_cli_cmds().
* command.c: Remove obsolete file.
* command.h: Mark as DEPRECATED.
* gdbcmd.h: Ditto.
* call-cmds.h: Ditto.
* Makefile.in (SFILES): Remove command.c.
(COMMON_OBS): Remove command.o.
(command.o): Remove obsolete target.
(cli_decode_h, cli_cmds_h, cli_script_h, cli_setshow_h): New macros.
Refer to CLI header files.
(cli-decode.o, cli-cmds.o, cli-setshow.o, cli-script.o): New targets.
(SUBDIR_CLI_OBS, SUBDIR_CLI_SRCS, SUBDIR_CLI_DEPS, SUBDIR_CLI_INITS,
SUBDIR_CLI_LDFLAGS, SUBDIR_CLI_CFLAGS, SUBDIR_CLI_ALL, SUBDIR_CLI_CLEAN,
SUBDIR_CLI_INSTALL, SUBDIR_CLI_UNINSTALL): New macros for new cli
subdirectory.
* configure.in (enable_gdbcli): New option. Include the CLI in the
executable (cannot be disabled yet).
(CONFIG_OBS, CONFIG_DEPS, CONFIG_SRCS, CONFIG_INITS, ENABLE_CFLAGS,
CONFIG_ALL, CONFIG_CLEAN, CONFIG_INSTALL, CONFIG_UNINSTALL): Add
the corresponding SUBDIR_CLI_* macros if CLI requested.
* configure: Regenerate.
2000-12-01 19:01:38 +01:00
|
|
|
/* ***DEPRECATED*** The gdblib files must not be calling/using things in any
|
|
|
|
of the possible command languages. If necessary, a hook (that may be
|
|
|
|
present or not) must be used and set to the appropriate routine by any
|
|
|
|
command language that cares about it. If you are having to include this
|
|
|
|
file you are possibly doing things the old way. This file will disapear.
|
2000-12-21 17:08:52 +01:00
|
|
|
2000-12-01 fnasser@redhat.com */
|
2000-12-01 Fernando Nasser <fnasser@redhat.com>
* cli/cli-decode.c: New file. Handle lists of commands, their decoding
and documentation.
(add_cmd, deprecate_cmd, add_abbrev_cmd, add_alias_cmd, add_prefix_cmd,
add_abbrev_prefix_cmd, not_just_help_class_command, empty_sfunc,
add_set_cmd, add_set_enum_cmd, add_set_auto_boolean_cmd,
add_show_from_set, delete_cmd, apropos_cmd, help_cmd, help_list,
help_all, print_doc_line, help_cmd_list, find_cmd, lookup_cmd_1,
undef_cmd_error, lookup_cmd, deprecated_cmd_warning,
lookup_cmd_composition, complete_on_cmdlist, complete_on_enum):
Moved here from command.c.
(add_info, add_info_alias, add_com, add_com_alias): Moved here from
top.c.
* cli/cli-decode.h: Definitions/declarations for the above.
* cli/cli-cmds.c: New file. GDB CLI commands.
(error_no_arg, info_command, show_command, help_command, show_version,
quit_command, pwd_command, cd_command, echo_command, shell_escape,
make_command, show_user, set_debug, show_debug, init_cmd_lists):
Moved here from top.c.
(apropos_command): Moved here from command.c.
(complete_command, source_command): Moved here (part) from top.c.
(is_complete_command): New function. Checks if a command is the
"complete" command.
(init_cli_cmds): New function. Add commands to the CLI (from code
previously in top.c.
* cli/cli-cmds.h: Definitions/declarations for the above.
* cli/cli-script.c: New file. GDB CLI command scripting.
(build_command_line, get_command_line, print_command_lines,
print_command_line, execute_user_command, execute_control_command,
while_command, if_command, arg_cleanup, setup_user_args, locate_arg,
insert_args, realloc_body_list, read_next_line,
recurse_read_control_structure, read_command_lines, free_command_lines,
do_free_command_lines_cleanup, make_cleanup_free_command_lines,
validate_comname, user_defined_command, define_command,
document_command, source_cleanup_lines, do_fclose_cleanup,
show_user_1): Moved here from top.c.
(script_from_file): New function. Implements execution of a script
contained in a file (part of code for the source_command() that used
to exist in top.c).
* cli/cli-script.h: Definitions/declarations for the above.
* cli/cli-setshow.c: New file. Handle set and show GDB CLI commands.
(parse_auto_binary_operation, parse_binary_operation,
do_setshow_command, cmd_show_list): Moved here from command.c.
* cli/cli-setshow.h: Definitions/declarations for the above.
* top.c: Remove all CLI code, except the command loop.
(gdb_init): Call init_cli_cmds().
* command.c: Remove obsolete file.
* command.h: Mark as DEPRECATED.
* gdbcmd.h: Ditto.
* call-cmds.h: Ditto.
* Makefile.in (SFILES): Remove command.c.
(COMMON_OBS): Remove command.o.
(command.o): Remove obsolete target.
(cli_decode_h, cli_cmds_h, cli_script_h, cli_setshow_h): New macros.
Refer to CLI header files.
(cli-decode.o, cli-cmds.o, cli-setshow.o, cli-script.o): New targets.
(SUBDIR_CLI_OBS, SUBDIR_CLI_SRCS, SUBDIR_CLI_DEPS, SUBDIR_CLI_INITS,
SUBDIR_CLI_LDFLAGS, SUBDIR_CLI_CFLAGS, SUBDIR_CLI_ALL, SUBDIR_CLI_CLEAN,
SUBDIR_CLI_INSTALL, SUBDIR_CLI_UNINSTALL): New macros for new cli
subdirectory.
* configure.in (enable_gdbcli): New option. Include the CLI in the
executable (cannot be disabled yet).
(CONFIG_OBS, CONFIG_DEPS, CONFIG_SRCS, CONFIG_INITS, ENABLE_CFLAGS,
CONFIG_ALL, CONFIG_CLEAN, CONFIG_INSTALL, CONFIG_UNINSTALL): Add
the corresponding SUBDIR_CLI_* macros if CLI requested.
* configure: Regenerate.
2000-12-01 19:01:38 +01:00
|
|
|
|
1999-04-16 03:35:26 +02:00
|
|
|
/* Header file for command-reading library command.c.
|
2001-03-06 09:22:02 +01:00
|
|
|
Copyright 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999, 2000
|
|
|
|
Free Software Foundation, Inc.
|
1999-04-16 03:35:26 +02:00
|
|
|
|
1999-07-07 22:19:36 +02: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
|
|
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
|
|
(at your option) any later version.
|
1999-04-16 03:35:26 +02:00
|
|
|
|
1999-07-07 22:19:36 +02: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 03:35:26 +02:00
|
|
|
|
1999-07-07 22:19:36 +02:00
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
along with this program; if not, write to the Free Software
|
|
|
|
Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
|
Boston, MA 02111-1307, USA. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
#if !defined (COMMAND_H)
|
|
|
|
#define COMMAND_H 1
|
|
|
|
|
1999-09-28 23:55:21 +02:00
|
|
|
/* Command classes are top-level categories into which commands are broken
|
|
|
|
down for "help" purposes.
|
|
|
|
Notes on classes: class_alias is for alias commands which are not
|
|
|
|
abbreviations of the original command. class-pseudo is for
|
|
|
|
commands which are not really commands nor help topics ("stop"). */
|
|
|
|
|
|
|
|
enum command_class
|
|
|
|
{
|
|
|
|
/* Special args to help_list */
|
|
|
|
class_deprecated, all_classes = -2, all_commands = -1,
|
|
|
|
/* Classes of commands */
|
|
|
|
no_class = -1, class_run = 0, class_vars, class_stack,
|
|
|
|
class_files, class_support, class_info, class_breakpoint, class_trace,
|
|
|
|
class_alias, class_obscure, class_user, class_maintenance,
|
2000-04-10 17:07:37 +02:00
|
|
|
class_pseudo, class_tui, class_xdb
|
1999-09-28 23:55:21 +02:00
|
|
|
};
|
|
|
|
|
1999-04-16 03:35:26 +02: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-07 22:19:36 +02:00
|
|
|
typedef enum cmd_types
|
|
|
|
{
|
|
|
|
not_set_cmd,
|
|
|
|
set_cmd,
|
|
|
|
show_cmd
|
|
|
|
}
|
|
|
|
cmd_types;
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-06-23 10:12:27 +02:00
|
|
|
/* Reasonable values for an AUTO_BOOLEAN variable. */
|
|
|
|
enum cmd_auto_boolean
|
|
|
|
{
|
|
|
|
CMD_AUTO_BOOLEAN_TRUE,
|
|
|
|
CMD_AUTO_BOOLEAN_FALSE,
|
|
|
|
CMD_AUTO_BOOLEAN_AUTO
|
|
|
|
};
|
|
|
|
|
1999-04-16 03:35:26 +02:00
|
|
|
/* Types of "set" or "show" command. */
|
1999-07-07 22:19:36 +02: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 10:12:27 +02:00
|
|
|
|
|
|
|
/* "on" / "true" / "enable" or "off" / "false" / "disable" or
|
|
|
|
"auto. *VAR is an ``enum cmd_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,
|
|
|
|
|
1999-07-07 22:19:36 +02:00
|
|
|
/* 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. */
|
|
|
|
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 NULL if the string is empty. */
|
|
|
|
var_filename,
|
|
|
|
/* ZeroableInteger. *VAR is an int. Like Unsigned Integer except
|
|
|
|
that zero really means zero. */
|
|
|
|
var_zinteger,
|
|
|
|
/* 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;
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* This structure records one command'd definition. */
|
|
|
|
|
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 00:43:19 +01:00
|
|
|
|
|
|
|
/* This flag is used by the code executing commands to warn the user
|
|
|
|
the first time a deprecated command is used, see the 'flags' field in
|
|
|
|
the following struct.
|
|
|
|
*/
|
|
|
|
#define CMD_DEPRECATED 0x1
|
|
|
|
#define DEPRECATED_WARN_USER 0x2
|
|
|
|
#define MALLOCED_REPLACEMENT 0x4
|
|
|
|
|
1999-04-16 03:35:26 +02:00
|
|
|
struct cmd_list_element
|
|
|
|
{
|
|
|
|
/* Points to next command in this list. */
|
|
|
|
struct cmd_list_element *next;
|
|
|
|
|
|
|
|
/* Name of this command. */
|
|
|
|
char *name;
|
|
|
|
|
|
|
|
/* Command class; class values are chosen by application program. */
|
|
|
|
enum command_class class;
|
|
|
|
|
2002-02-02 01:56:37 +01:00
|
|
|
/* Function definition of this command. NULL for command class
|
2002-02-05 05:37:23 +01:00
|
|
|
names and for help topics that are not really commands. NOTE:
|
|
|
|
cagney/2002-02-02: This function signature is evolving. For
|
|
|
|
the moment suggest sticking with either set_cmd_cfunc() or
|
|
|
|
set_cmd_sfunc(). */
|
|
|
|
void (*func) (struct cmd_list_element *c, char *args, int from_tty);
|
|
|
|
/* The command's real callback. At present func() bounces through
|
|
|
|
to one of the below. */
|
1999-04-16 03:35:26 +02:00
|
|
|
union
|
|
|
|
{
|
|
|
|
/* If type is not_set_cmd, call it like this: */
|
2000-06-04 02:41:10 +02:00
|
|
|
void (*cfunc) (char *args, int from_tty);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2001-11-22 01:23:13 +01:00
|
|
|
/* If type is set_cmd or show_cmd, first set the variables, and
|
1999-04-16 03:35:26 +02:00
|
|
|
then call this. */
|
2000-06-04 02:41:10 +02:00
|
|
|
void (*sfunc) (char *args, int from_tty, struct cmd_list_element * c);
|
1999-07-07 22:19:36 +02:00
|
|
|
}
|
|
|
|
function;
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* Documentation of this command (or help topic).
|
|
|
|
First line is brief documentation; remaining lines form, with it,
|
|
|
|
the full documentation. First line should end with a period.
|
|
|
|
Entire string should also end with a period, not a newline. */
|
|
|
|
char *doc;
|
|
|
|
|
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 00:43:19 +01:00
|
|
|
/* flags : a bitfield
|
|
|
|
|
|
|
|
bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
|
|
|
|
is deprecated. It may be removed from gdb's command set in the
|
|
|
|
future.
|
|
|
|
|
|
|
|
bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
|
|
|
|
this is a deprecated command. The user should only be warned
|
|
|
|
the first time a command is used.
|
|
|
|
|
|
|
|
bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
|
|
|
|
compile time (this is the way it should, in general, be done)
|
2000-04-03 17:17:37 +02:00
|
|
|
the memory containing the replacement string is statically
|
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 00:43:19 +01:00
|
|
|
allocated. In some cases it makes sense to deprecate commands
|
|
|
|
at runtime (the testsuite is one example). In this case the
|
|
|
|
memory for replacement is malloc'ed. When a command is
|
|
|
|
undeprecated or re-deprecated at runtime we don't want to risk
|
|
|
|
calling free on statically allocated memory, so we check this
|
|
|
|
flag.
|
|
|
|
*/
|
|
|
|
int flags;
|
|
|
|
|
|
|
|
/* if this command is deprecated, this is the replacement name */
|
|
|
|
char *replacement;
|
|
|
|
|
2001-11-22 01:23:13 +01:00
|
|
|
/* If this command represents a show command, then this function
|
|
|
|
is called before the variable's value is examined. */
|
|
|
|
void (*pre_show_hook) (struct cmd_list_element *c);
|
|
|
|
|
1999-04-16 03:35:26 +02:00
|
|
|
/* Hook for another command to be executed before this command. */
|
2000-11-06 23:44:34 +01:00
|
|
|
struct cmd_list_element *hook_pre;
|
|
|
|
|
|
|
|
/* Hook for another command to be executed after this command. */
|
|
|
|
struct cmd_list_element *hook_post;
|
|
|
|
|
|
|
|
/* Flag that specifies if this command is already running it's hook. */
|
|
|
|
/* Prevents the possibility of hook recursion. */
|
|
|
|
int hook_in;
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* Nonzero identifies a prefix command. For them, the address
|
|
|
|
of the variable containing the list of subcommands. */
|
|
|
|
struct cmd_list_element **prefixlist;
|
|
|
|
|
|
|
|
/* For prefix commands only:
|
|
|
|
String containing prefix commands to get here: this one
|
|
|
|
plus any others needed to get to it. Should end in a space.
|
|
|
|
It is used before the word "command" in describing the
|
|
|
|
commands reached through this prefix. */
|
|
|
|
char *prefixname;
|
|
|
|
|
|
|
|
/* For prefix commands only:
|
|
|
|
nonzero means do not get an error if subcommand is not
|
|
|
|
recognized; call the prefix's own function in that case. */
|
|
|
|
char allow_unknown;
|
|
|
|
|
|
|
|
/* Nonzero says this is an abbreviation, and should not
|
|
|
|
be mentioned in lists of commands.
|
|
|
|
This allows "br<tab>" to complete to "break", which it
|
|
|
|
otherwise wouldn't. */
|
|
|
|
char abbrev_flag;
|
|
|
|
|
|
|
|
/* Completion routine for this command. 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.
|
|
|
|
|
|
|
|
Return value is a malloc'd vector of pointers to possible completions
|
|
|
|
terminated with NULL. If there are no completions, returning a pointer
|
|
|
|
to a NULL would work but returning NULL itself is also valid.
|
|
|
|
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". */
|
2000-06-04 02:41:10 +02:00
|
|
|
char **(*completer) (char *text, char *word);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* Type of "set" or "show" command (or SET_NOT_SET if not "set"
|
|
|
|
or "show"). */
|
|
|
|
cmd_types type;
|
|
|
|
|
|
|
|
/* Pointer to variable affected by "set" and "show". Doesn't matter
|
|
|
|
if type is not_set. */
|
2000-05-16 05:03:13 +02:00
|
|
|
void *var;
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* What kind of variable is *VAR? */
|
|
|
|
var_types var_type;
|
|
|
|
|
|
|
|
/* Pointer to NULL terminated list of enumerated values (like argv). */
|
2000-06-08 02:52:56 +02:00
|
|
|
const char **enums;
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* Pointer to command strings of user-defined commands */
|
|
|
|
struct command_line *user_commands;
|
|
|
|
|
2000-11-06 23:44:34 +01:00
|
|
|
/* Pointer to command that is hooked by this one, (by hook_pre)
|
|
|
|
so the hook can be removed when this one is deleted. */
|
|
|
|
struct cmd_list_element *hookee_pre;
|
|
|
|
|
|
|
|
/* Pointer to command that is hooked by this one, (by hook_post)
|
1999-04-16 03:35:26 +02:00
|
|
|
so the hook can be removed when this one is deleted. */
|
2000-11-06 23:44:34 +01:00
|
|
|
struct cmd_list_element *hookee_post;
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* Pointer to command that is aliased by this one, so the
|
|
|
|
aliased command can be located in case it has been hooked. */
|
|
|
|
struct cmd_list_element *cmd_pointer;
|
|
|
|
};
|
|
|
|
|
2002-02-23 22:30:23 +01:00
|
|
|
/* Forward-declarations of the entry-points of cli/cli-decode.c. */
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-05-28 03:12:42 +02: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 05:37:23 +01:00
|
|
|
/* Set the commands corresponding callback. */
|
|
|
|
|
|
|
|
extern void set_cmd_cfunc (struct cmd_list_element *cmd,
|
|
|
|
void (*cfunc) (char *args, int from_tty));
|
|
|
|
|
|
|
|
extern void set_cmd_sfunc (struct cmd_list_element *cmd,
|
|
|
|
void (*sfunc) (char *args, int from_tty,
|
|
|
|
struct cmd_list_element * c));
|
|
|
|
|
2002-03-06 07:28:35 +01:00
|
|
|
extern void set_cmd_completer (struct cmd_list_element *cmd,
|
|
|
|
char **(*completer) (char *text, char *word));
|
|
|
|
|
2002-02-23 21:12:13 +01: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 05:37:23 +01:00
|
|
|
|
2000-05-28 03:12:42 +02: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 03:35:26 +02:00
|
|
|
|
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 00:43:19 +01:00
|
|
|
extern struct cmd_list_element *
|
|
|
|
deprecate_cmd (struct cmd_list_element *, char * );
|
|
|
|
|
1999-04-16 03:35:26 +02:00
|
|
|
extern void
|
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 00:43:19 +01:00
|
|
|
deprecated_cmd_warning (char **);
|
|
|
|
|
|
|
|
extern int
|
|
|
|
lookup_cmd_composition (char *text,
|
|
|
|
struct cmd_list_element **alias,
|
|
|
|
struct cmd_list_element **prefix_cmd,
|
|
|
|
struct cmd_list_element **cmd);
|
|
|
|
|
2000-05-28 03:12:42 +02:00
|
|
|
extern struct cmd_list_element *add_com (char *, enum command_class,
|
|
|
|
void (*fun) (char *, int), char *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-05-28 03:12:42 +02:00
|
|
|
extern struct cmd_list_element *add_com_alias (char *, char *,
|
|
|
|
enum command_class, int);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-05-28 03:12:42 +02:00
|
|
|
extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
|
|
|
|
char *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-05-28 03:12:42 +02:00
|
|
|
extern struct cmd_list_element *add_info_alias (char *, char *, int);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-05-28 03:12:42 +02:00
|
|
|
extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-06-08 02:52:56 +02:00
|
|
|
extern char **complete_on_enum (const char *enumlist[], char *, char *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-05-28 03:12:42 +02:00
|
|
|
extern void delete_cmd (char *, struct cmd_list_element **);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-02-02 01:21:19 +01:00
|
|
|
extern void help_cmd (char *, struct ui_file *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-02-02 01:21:19 +01:00
|
|
|
extern void help_list (struct cmd_list_element *, char *,
|
|
|
|
enum command_class, struct ui_file *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-02-02 01:21:19 +01:00
|
|
|
extern void help_cmd_list (struct cmd_list_element *, enum command_class,
|
|
|
|
char *, int, struct ui_file *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-05-16 05:03:13 +02:00
|
|
|
extern struct cmd_list_element *add_set_cmd (char *name, enum
|
|
|
|
command_class class,
|
|
|
|
var_types var_type, void *var,
|
|
|
|
char *doc,
|
|
|
|
struct cmd_list_element **list);
|
|
|
|
|
|
|
|
extern struct cmd_list_element *add_set_enum_cmd (char *name,
|
|
|
|
enum command_class class,
|
2000-06-08 02:52:56 +02:00
|
|
|
const char *enumlist[],
|
|
|
|
const char **var,
|
2000-05-16 05:03:13 +02:00
|
|
|
char *doc,
|
|
|
|
struct cmd_list_element **list);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-06-23 10:12:27 +02:00
|
|
|
extern struct cmd_list_element *add_set_auto_boolean_cmd (char *name,
|
|
|
|
enum command_class class,
|
|
|
|
enum cmd_auto_boolean *var,
|
|
|
|
char *doc,
|
|
|
|
struct cmd_list_element **list);
|
|
|
|
|
2001-09-30 18:16:16 +02:00
|
|
|
extern struct cmd_list_element *add_set_boolean_cmd (char *name,
|
|
|
|
enum command_class class,
|
|
|
|
int *var,
|
|
|
|
char *doc,
|
|
|
|
struct cmd_list_element **list);
|
|
|
|
|
2000-05-28 03:12:42 +02:00
|
|
|
extern struct cmd_list_element *add_show_from_set (struct cmd_list_element *,
|
|
|
|
struct cmd_list_element
|
|
|
|
**);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
/* Do a "show" command for each thing on a command list. */
|
|
|
|
|
2000-05-28 03:12:42 +02:00
|
|
|
extern void cmd_show_list (struct cmd_list_element *, int, char *);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-11-20 04:37:09 +01:00
|
|
|
extern NORETURN void error_no_arg (char *) ATTR_NORETURN;
|
1999-04-16 03:35:26 +02:00
|
|
|
|
2000-05-28 03:12:42 +02:00
|
|
|
extern void dont_repeat (void);
|
1999-04-16 03:35:26 +02: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 03:12:42 +02:00
|
|
|
extern void not_just_help_class_command (char *, int);
|
1999-04-16 03:35:26 +02:00
|
|
|
|
|
|
|
#endif /* !defined (COMMAND_H) */
|