-/* Header file for command-reading library command.c.
+/* Header file for command creation.
- Copyright 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1999,
- 2000, 2002, 2004 Free Software Foundation, Inc.
+ Copyright (C) 1986-2013 Free Software Foundation, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA. */
+ along with this program. If not, see <http://www.gnu.org/licenses/>. */
#if !defined (COMMAND_H)
#define COMMAND_H 1
-/* Command classes are top-level categories into which commands are broken
- down for "help" purposes.
+#include "gdb_vecs.h"
+
+/* This file defines the public interface for any code wanting to
+ create commands. */
+
+/* Command classes are top-level categories into which commands are
+ broken down for "help" purposes.
+
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,
+ class_deprecated = -3, 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,
- class_pseudo, class_tui, class_xdb
+ no_class = -1, class_run = 0, class_vars, class_stack, class_files,
+ class_support, class_info, class_breakpoint, class_trace,
+ class_alias, class_bookmark, class_obscure, class_maintenance,
+ class_pseudo, class_tui, class_user, class_xdb,
+ no_set_class /* Used for "show" commands that have no corresponding
+ "set" command. */
};
/* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
"auto. *VAR is an ``enum auto_boolean''. NOTE: In general a
custom show command will need to be implemented - one that for
"auto" prints both the "auto" and the current auto-selected
- value. */
+ value. */
var_auto_boolean,
- /* Unsigned Integer. *VAR is an unsigned int. The user can type 0
- to mean "unlimited", which is stored in *VAR as UINT_MAX. */
+ /* 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. */
+ /* Like var_uinteger but signed. *VAR is an int. The user can
+ type 0 to mean "unlimited", which is stored in *VAR as
+ INT_MAX. The only remaining use of it is the Python API.
+ Don't use it elsewhere. */
var_integer,
- /* String which the user enters with escapes (e.g. the user types \n and
- it is a real newline in the stored string).
+ /* 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. */
+ /* String which stores a filename. (*VAR) is a malloc'd string,
+ or "" if the string was empty. */
+ var_optional_filename,
+ /* String which stores a filename. (*VAR) is a malloc'd
+ string. */
var_filename,
- /* ZeroableInteger. *VAR is an int. Like Unsigned Integer except
+ /* ZeroableInteger. *VAR is an int. Like var_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. */
+ /* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really
+ means zero. */
+ var_zuinteger,
+ /* ZeroableUnsignedInteger with unlimited value. *VAR is an unsigned
+ int, but its range is [0, INT_MAX]. -1 stands for unlimited. */
+ var_zuinteger_unlimited,
+ /* Enumerated type. Can only have one of the specified values.
+ *VAR is a char pointer to the name of the element that we
+ find. */
var_enum
}
var_types;
/* 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 *,
struct cmd_list_element **);
extern void set_cmd_sfunc (struct cmd_list_element *cmd,
cmd_sfunc_ftype *sfunc);
-extern void set_cmd_completer (struct cmd_list_element *cmd,
- char **(*completer) (char *text, char *word));
+typedef VEC (char_ptr) *completer_ftype (struct cmd_list_element *,
+ char *, char *);
+
+extern void set_cmd_completer (struct cmd_list_element *, completer_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));
-/* Each command object has a local context attached to it. . */
-extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
+/* Each command object has a local context attached to it. */
+extern void set_cmd_context (struct cmd_list_element *cmd,
+ void *context);
extern void *get_cmd_context (struct cmd_list_element *cmd);
extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
/* Return the type of the command. */
-/* NOTE: cagney/2002-03-17: The deprecated_add_show_from_set()
- function clones the set command passed as a parameter. The clone
- operation will include (BUG?) any ``set'' command callback, if
- present. Commands like ``info set'' call all the ``show'' command
- callbacks. Unfortunately, for ``show'' commands cloned from
- ``set'', this includes callbacks belonging to ``set'' commands.
- Making this worse, this only occures if
- deprecated_add_show_from_set() is called after add_cmd_sfunc()
- (BUG?). */
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 *,
struct cmd_list_element **,
int);
-extern struct cmd_list_element *
- deprecate_cmd (struct cmd_list_element *, char * );
+extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
+ char * );
-extern void
- deprecated_cmd_warning (char **);
+extern void 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);
+extern int lookup_cmd_composition (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 *);
+ void (*fun) (char *, int),
+ char *);
extern struct cmd_list_element *add_com_alias (char *, char *,
enum command_class, int);
-extern struct cmd_list_element *add_info (char *, void (*fun) (char *, int),
+extern struct cmd_list_element *add_info (char *,
+ void (*fun) (char *, int),
char *);
extern struct cmd_list_element *add_info_alias (char *, char *, int);
-extern char **complete_on_cmdlist (struct cmd_list_element *, char *, char *);
+extern VEC (char_ptr) *complete_on_cmdlist (struct cmd_list_element *,
+ char *, char *, int);
-extern char **complete_on_enum (const char *enumlist[], char *, char *);
+extern VEC (char_ptr) *complete_on_enum (const char *const *enumlist,
+ char *, char *);
-extern void delete_cmd (char *, struct cmd_list_element **);
-
-extern void help_cmd (char *, struct ui_file *);
+/* Functions that implement commands about CLI commands. */
extern void help_list (struct cmd_list_element *, char *,
enum command_class, struct ui_file *);
-extern void help_cmd_list (struct cmd_list_element *, enum command_class,
- char *, int, struct ui_file *);
-
-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,
- const char *enumlist[],
- const char **var,
- char *doc,
- struct cmd_list_element **list);
+/* Method for show a set/show variable's VALUE on FILE. If this
+ method isn't supplied deprecated_show_value_hack() is called (which
+ is not good). */
+typedef void (show_value_ftype) (struct ui_file *file,
+ int from_tty,
+ struct cmd_list_element *cmd,
+ const char *value);
+/* NOTE: i18n: This function is not i18n friendly. Callers should
+ instead print the value out directly. */
+extern show_value_ftype deprecated_show_value_hack;
+
extern void add_setshow_enum_cmd (char *name,
enum command_class class,
- const char *enumlist[],
+ const char *const *enumlist,
const char **var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
- const char *print,
cmd_sfunc_ftype *set_func,
- cmd_sfunc_ftype *show_func,
+ show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
const char *set_doc,
const char *show_doc,
const char *help_doc,
- const char *print,
cmd_sfunc_ftype *set_func,
- cmd_sfunc_ftype *show_func,
+ show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
enum command_class class,
int *var,
const char *set_doc, const char *show_doc,
- const char *help_doc, const char *print,
+ const char *help_doc,
cmd_sfunc_ftype *set_func,
- cmd_sfunc_ftype *show_func,
+ show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
const char *set_doc,
const char *show_doc,
const char *help_doc,
- const char *print,
cmd_sfunc_ftype *set_func,
- cmd_sfunc_ftype *show_func,
+ show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
const char *set_doc,
const char *show_doc,
const char *help_doc,
- const char *print,
cmd_sfunc_ftype *set_func,
- cmd_sfunc_ftype *show_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,
+ 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,
+ 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_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);
+
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,
- const char *print,
cmd_sfunc_ftype *set_func,
- cmd_sfunc_ftype *show_func,
+ show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
const char *set_doc,
const char *show_doc,
const char *help_doc,
- const char *print,
cmd_sfunc_ftype *set_func,
- cmd_sfunc_ftype *show_func,
+ show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
-extern struct cmd_list_element *deprecated_add_show_from_set (struct cmd_list_element *,
- struct cmd_list_element **);
+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,
+ 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,
+ 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 NORETURN void error_no_arg (char *) ATTR_NORETURN;
+/* Used everywhere whenever at least one parameter is required and
+ none is specified. */
+
+extern void error_no_arg (char *) ATTRIBUTE_NORETURN;
extern void dont_repeat (void);
+extern struct cleanup *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);
-/* check function pointer */
+/* 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);
+/* Call the command function. */
+extern void cmd_func (struct cmd_list_element *cmd,
+ char *args, int from_tty);
#endif /* !defined (COMMAND_H) */
projects / deliverable / binutils-gdb.git / blobdiff