[thirdparty/binutils-gdb.git] / gdb / command.h

/* Header file for command-reading library command.c.
   Copyright (C) 1986, 1989, 1990, 2000 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
   (at your option) any later version.

   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.

   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.  */

#if !defined (COMMAND_H)
#define COMMAND_H 1

/* 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,
  class_pseudo, class_tui, class_xdb
};

/* 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.  */
typedef enum cmd_types
  {
    not_set_cmd,
    set_cmd,
    show_cmd
  }
cmd_types;

/* Types of "set" or "show" command.  */
typedef enum var_types
  {
    /* "on" or "off".  *VAR is an integer which is nonzero for on,
       zero for off.  */
    var_boolean,
    /* 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;

/* This structure records one command'd definition.  */


/* 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

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;

    /* Function definition of this command.
       NO_FUNCTION for command class names and for help topics that
       are not really commands.  */
    union
      {
	/* If type is not_set_cmd, call it like this:  */
	void (*cfunc) PARAMS ((char *args, int from_tty));

	/* If type is cmd_set or show_cmd, first set the variables, and
	   then call this.  */
	void (*sfunc) PARAMS ((char *args, int from_tty,
			       struct cmd_list_element * c));
      }
    function;
#define NO_FUNCTION ((void (*) PARAMS((char *args, int from_tty))) 0)

    /* 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;

    /* 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)
       the memory containing the replacement string is statically
       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;

    /* Hook for another command to be executed before this command.  */
    struct cmd_list_element *hook;

    /* 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".  */
    char **(*completer) PARAMS ((char *text, char *word));

    /* 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.  */
    char *var;

    /* What kind of variable is *VAR?  */
    var_types var_type;

    /* Pointer to NULL terminated list of enumerated values (like argv).  */
    char **enums;

    /* Pointer to command strings of user-defined commands */
    struct command_line *user_commands;

    /* Pointer to command that is hooked by this one,
       so the hook can be removed when this one is deleted.  */
    struct cmd_list_element *hookee;

    /* 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;
  };

/* Forward-declarations of the entry-points of command.c.  */

extern struct cmd_list_element *
  add_cmd PARAMS ((char *, enum command_class, void (*fun) (char *, int),
		   char *, struct cmd_list_element **));

extern struct cmd_list_element *
  add_alias_cmd PARAMS ((char *, char *, enum command_class, int,
			 struct cmd_list_element **));

extern struct cmd_list_element *
  add_prefix_cmd PARAMS ((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 PARAMS ((char *, enum command_class,
				 void (*fun) (char *, int), char *,
				 struct cmd_list_element **, char *, int,
				 struct cmd_list_element **));

extern struct cmd_list_element *
  lookup_cmd PARAMS ((char **, struct cmd_list_element *, char *, int, int));

extern struct cmd_list_element *
  lookup_cmd_1 PARAMS ((char **, struct cmd_list_element *,
			struct cmd_list_element **, int));

extern struct cmd_list_element *
  deprecate_cmd (struct cmd_list_element *, 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 struct cmd_list_element *
  add_com PARAMS ((char *, enum command_class, void (*fun) (char *, int),
		 char *));

extern struct cmd_list_element *
  add_com_alias PARAMS ((char *, char *, enum command_class, int));

extern struct cmd_list_element *
  add_info PARAMS ((char *, void (*fun) (char *, int), char *));

extern struct cmd_list_element *
  add_info_alias PARAMS ((char *, char *, int));

extern char **
  complete_on_cmdlist PARAMS ((struct cmd_list_element *, char *, char *));

extern char **
  complete_on_enum PARAMS ((char **enumlist, char *, char *));

extern void
delete_cmd PARAMS ((char *, struct cmd_list_element **));

extern void help_cmd (char *, struct ui_file *);

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 PARAMS ((char *, enum command_class, var_types, char *, char *,
		       struct cmd_list_element **));

extern struct cmd_list_element *
  add_set_enum_cmd PARAMS ((char *name, enum command_class, char *list[],
		       char *var, char *doc, struct cmd_list_element ** c));

extern struct cmd_list_element *
  add_show_from_set PARAMS ((struct cmd_list_element *,
			     struct cmd_list_element **));

/* Do a "set" or "show" command.  ARG is NULL if no argument, or the text
   of the argument, and FROM_TTY is nonzero if this command is being entered
   directly by the user (i.e. these are just like any other
   command).  C is the command list element for the command.  */

extern void
do_setshow_command PARAMS ((char *, int, struct cmd_list_element *));

/* Do a "show" command for each thing on a command list.  */

extern void
cmd_show_list PARAMS ((struct cmd_list_element *, int, char *));

extern void
error_no_arg PARAMS ((char *));

extern void
dont_repeat PARAMS ((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 PARAMS ((char *, int));

#endif /* !defined (COMMAND_H) */
Commit	Line	Data
c906108c	1	/* Header file for command-reading library command.c.
d9fcf2fb	2	Copyright (C) 1986, 1989, 1990, 2000 Free Software Foundation, Inc.
c906108c	3
c5aa993b JM	4	This program is free software; you can redistribute it and/or modify
	5	it under the terms of the GNU General Public License as published by
	6	the Free Software Foundation; either version 2 of the License, or
	7	(at your option) any later version.
c906108c	8
c5aa993b JM	9	This program is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	GNU General Public License for more details.
c906108c	13
c5aa993b JM	14	You should have received a copy of the GNU General Public License
	15	along with this program; if not, write to the Free Software
	16	Foundation, Inc., 59 Temple Place - Suite 330,
	17	Boston, MA 02111-1307, USA. */
c906108c SS	18
	19	#if !defined (COMMAND_H)
	20	#define COMMAND_H 1
	21
6426a772 JM	22	/* Command classes are top-level categories into which commands are broken
	23	down for "help" purposes.
	24	Notes on classes: class_alias is for alias commands which are not
	25	abbreviations of the original command. class-pseudo is for
	26	commands which are not really commands nor help topics ("stop"). */
	27
	28	enum command_class
	29	{
	30	/* Special args to help_list */
	31	class_deprecated, all_classes = -2, all_commands = -1,
	32	/* Classes of commands */
	33	no_class = -1, class_run = 0, class_vars, class_stack,
	34	class_files, class_support, class_info, class_breakpoint, class_trace,
	35	class_alias, class_obscure, class_user, class_maintenance,
9285ab80	36	class_pseudo, class_tui, class_xdb
6426a772 JM	37	};
6426a772 JM	38
c906108c SS	39	/* Not a set/show command. Note that some commands which begin with
	40	"set" or "show" might be in this category, if their syntax does
	41	not fall into one of the following categories. */
c5aa993b JM	42	typedef enum cmd_types
	43	{
	44	not_set_cmd,
	45	set_cmd,
	46	show_cmd
	47	}
	48	cmd_types;
c906108c SS	49
c906108c SS	50	/* Types of "set" or "show" command. */
c5aa993b JM	51	typedef enum var_types
	52	{
	53	/* "on" or "off". *VAR is an integer which is nonzero for on,
	54	zero for off. */
	55	var_boolean,
	56	/* Unsigned Integer. *VAR is an unsigned int. The user can type 0
	57	to mean "unlimited", which is stored in VAR as UINT_MAX. /
	58	var_uinteger,
	59
	60	/* Like var_uinteger but signed. *VAR is an int. The user can type 0
	61	to mean "unlimited", which is stored in VAR as INT_MAX. /
	62	var_integer,
	63
	64	/* String which the user enters with escapes (e.g. the user types \n and
	65	it is a real newline in the stored string).
	66	VAR is a malloc'd string, or NULL if the string is empty. /
	67	var_string,
	68	/* String which stores what the user types verbatim.
	69	VAR is a malloc'd string, or NULL if the string is empty. /
	70	var_string_noescape,
	71	/* String which stores a filename.
	72	VAR is a malloc'd string, or NULL if the string is empty. /
	73	var_filename,
	74	/* ZeroableInteger. *VAR is an int. Like Unsigned Integer except
	75	that zero really means zero. */
	76	var_zinteger,
	77	/* Enumerated type. Can only have one of the specified values. *VAR is a
	78	char pointer to the name of the element that we find. */
	79	var_enum
	80	}
	81	var_types;
c906108c SS	82
	83	/* This structure records one command'd definition. */
	84
56382845 FN	85
	86	/* This flag is used by the code executing commands to warn the user
	87	the first time a deprecated command is used, see the 'flags' field in
	88	the following struct.
	89	*/
	90	#define CMD_DEPRECATED 0x1
	91	#define DEPRECATED_WARN_USER 0x2
	92	#define MALLOCED_REPLACEMENT 0x4
	93
c906108c SS	94	struct cmd_list_element
	95	{
	96	/* Points to next command in this list. */
	97	struct cmd_list_element *next;
	98
	99	/* Name of this command. */
	100	char *name;
	101
	102	/* Command class; class values are chosen by application program. */
	103	enum command_class class;
	104
	105	/* Function definition of this command.
	106	NO_FUNCTION for command class names and for help topics that
	107	are not really commands. */
	108	union
	109	{
	110	/* If type is not_set_cmd, call it like this: */
	111	void (cfunc) PARAMS ((char args, int from_tty));
	112
	113	/* If type is cmd_set or show_cmd, first set the variables, and
	114	then call this. */
	115	void (sfunc) PARAMS ((char args, int from_tty,
c5aa993b JM	116	struct cmd_list_element * c));
	117	}
	118	function;
	119	#define NO_FUNCTION ((void () PARAMS((char args, int from_tty))) 0)
c906108c SS	120
	121	/* Documentation of this command (or help topic).
	122	First line is brief documentation; remaining lines form, with it,
	123	the full documentation. First line should end with a period.
	124	Entire string should also end with a period, not a newline. */
	125	char *doc;
	126
56382845 FN	127	/* flags : a bitfield
	128
	129	bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
	130	is deprecated. It may be removed from gdb's command set in the
	131	future.
	132
	133	bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
	134	this is a deprecated command. The user should only be warned
	135	the first time a command is used.
	136
	137	bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
	138	compile time (this is the way it should, in general, be done)
c0c9b0b8	139	the memory containing the replacement string is statically
56382845 FN	140	allocated. In some cases it makes sense to deprecate commands
	141	at runtime (the testsuite is one example). In this case the
	142	memory for replacement is malloc'ed. When a command is
	143	undeprecated or re-deprecated at runtime we don't want to risk
	144	calling free on statically allocated memory, so we check this
	145	flag.
	146	*/
	147	int flags;
	148
	149	/* if this command is deprecated, this is the replacement name */
	150	char *replacement;
	151
c906108c SS	152	/* Hook for another command to be executed before this command. */
	153	struct cmd_list_element *hook;
	154
	155	/* Nonzero identifies a prefix command. For them, the address
	156	of the variable containing the list of subcommands. */
	157	struct cmd_list_element **prefixlist;
	158
	159	/* For prefix commands only:
	160	String containing prefix commands to get here: this one
	161	plus any others needed to get to it. Should end in a space.
	162	It is used before the word "command" in describing the
	163	commands reached through this prefix. */
	164	char *prefixname;
	165
	166	/* For prefix commands only:
	167	nonzero means do not get an error if subcommand is not
	168	recognized; call the prefix's own function in that case. */
	169	char allow_unknown;
	170
	171	/* Nonzero says this is an abbreviation, and should not
	172	be mentioned in lists of commands.
	173	This allows "br<tab>" to complete to "break", which it
	174	otherwise wouldn't. */
	175	char abbrev_flag;
	176
	177	/* Completion routine for this command. TEXT is the text beyond
	178	what was matched for the command itself (leading whitespace is
	179	skipped). It stops where we are supposed to stop completing
	180	(rl_point) and is '\0' terminated.
	181
	182	Return value is a malloc'd vector of pointers to possible completions
	183	terminated with NULL. If there are no completions, returning a pointer
	184	to a NULL would work but returning NULL itself is also valid.
	185	WORD points in the same buffer as TEXT, and completions should be
	186	returned relative to this position. For example, suppose TEXT is "foo"
	187	and we want to complete to "foobar". If WORD is "oo", return
	188	"oobar"; if WORD is "baz/foo", return "baz/foobar". */
c5aa993b	189	char *(completer) PARAMS ((char text, char word));
c906108c SS	190
	191	/* Type of "set" or "show" command (or SET_NOT_SET if not "set"
	192	or "show"). */
	193	cmd_types type;
	194
	195	/* Pointer to variable affected by "set" and "show". Doesn't matter
	196	if type is not_set. */
	197	char *var;
	198
	199	/* What kind of variable is VAR? /
	200	var_types var_type;
	201
	202	/* Pointer to NULL terminated list of enumerated values (like argv). */
	203	char **enums;
	204
	205	/* Pointer to command strings of user-defined commands */
	206	struct command_line *user_commands;
	207
	208	/* Pointer to command that is hooked by this one,
	209	so the hook can be removed when this one is deleted. */
	210	struct cmd_list_element *hookee;
	211
	212	/* Pointer to command that is aliased by this one, so the
	213	aliased command can be located in case it has been hooked. */
	214	struct cmd_list_element *cmd_pointer;
	215	};
	216
	217	/* Forward-declarations of the entry-points of command.c. */
	218
	219	extern struct cmd_list_element *
c5aa993b JM	220	add_cmd PARAMS ((char , enum command_class, void (fun) (char *, int),
c5aa993b JM	221	char , struct cmd_list_element *));
c906108c SS	222
c906108c SS	223	extern struct cmd_list_element *
c5aa993b JM	224	add_alias_cmd PARAMS ((char , char , enum command_class, int,
c5aa993b JM	225	struct cmd_list_element **));
c906108c SS	226
c906108c SS	227	extern struct cmd_list_element *
c5aa993b JM	228	add_prefix_cmd PARAMS ((char , enum command_class, void (fun) (char *, int),
	229	char , struct cmd_list_element , char , int,
	230	struct cmd_list_element **));
c906108c SS	231
c906108c SS	232	extern struct cmd_list_element *
c5aa993b JM	233	add_abbrev_prefix_cmd PARAMS ((char *, enum command_class,
	234	void (fun) (char , int), char *,
	235	struct cmd_list_element *, char , int,
	236	struct cmd_list_element **));
c906108c SS	237
c906108c SS	238	extern struct cmd_list_element *
c5aa993b	239	lookup_cmd PARAMS ((char *, struct cmd_list_element , char *, int, int));
c906108c SS	240
c906108c SS	241	extern struct cmd_list_element *
c5aa993b JM	242	lookup_cmd_1 PARAMS ((char *, struct cmd_list_element ,
c5aa993b JM	243	struct cmd_list_element **, int));
c906108c	244
56382845 FN	245	extern struct cmd_list_element *
	246	deprecate_cmd (struct cmd_list_element , char );
	247
c906108c	248	extern void
56382845 FN	249	deprecated_cmd_warning (char **);
	250
	251	extern int
	252	lookup_cmd_composition (char *text,
	253	struct cmd_list_element **alias,
	254	struct cmd_list_element **prefix_cmd,
	255	struct cmd_list_element **cmd);
	256
	257	extern struct cmd_list_element *
	258	add_com PARAMS ((char , enum command_class, void (fun) (char *, int),
c906108c SS	259	char *));
c906108c SS	260
56382845 FN	261	extern struct cmd_list_element *
56382845 FN	262	add_com_alias PARAMS ((char , char , enum command_class, int));
c906108c	263
56382845 FN	264	extern struct cmd_list_element *
56382845 FN	265	add_info PARAMS ((char , void (fun) (char , int), char ));
c906108c	266
56382845 FN	267	extern struct cmd_list_element *
56382845 FN	268	add_info_alias PARAMS ((char , char , int));
c906108c SS	269
c906108c SS	270	extern char **
c5aa993b	271	complete_on_cmdlist PARAMS ((struct cmd_list_element , char , char *));
c906108c SS	272
c906108c SS	273	extern char **
c5aa993b	274	complete_on_enum PARAMS ((char *enumlist, char , char *));
c906108c SS	275
	276	extern void
	277	delete_cmd PARAMS ((char , struct cmd_list_element *));
	278
d9fcf2fb	279	extern void help_cmd (char , struct ui_file );
c906108c	280
d9fcf2fb JM	281	extern void help_list (struct cmd_list_element , char ,
d9fcf2fb JM	282	enum command_class, struct ui_file *);
c906108c	283
d9fcf2fb JM	284	extern void help_cmd_list (struct cmd_list_element *, enum command_class,
d9fcf2fb JM	285	char , int, struct ui_file );
c906108c SS	286
c906108c SS	287	extern struct cmd_list_element *
c5aa993b JM	288	add_set_cmd PARAMS ((char , enum command_class, var_types, char , char *,
c5aa993b JM	289	struct cmd_list_element **));
c906108c SS	290
c906108c SS	291	extern struct cmd_list_element *
c5aa993b JM	292	add_set_enum_cmd PARAMS ((char name, enum command_class, char list[],
c5aa993b JM	293	char var, char doc, struct cmd_list_element ** c));
c906108c SS	294
c906108c SS	295	extern struct cmd_list_element *
c5aa993b JM	296	add_show_from_set PARAMS ((struct cmd_list_element *,
c5aa993b JM	297	struct cmd_list_element **));
c906108c SS	298
	299	/* Do a "set" or "show" command. ARG is NULL if no argument, or the text
	300	of the argument, and FROM_TTY is nonzero if this command is being entered
	301	directly by the user (i.e. these are just like any other
	302	command). C is the command list element for the command. */
	303
	304	extern void
	305	do_setshow_command PARAMS ((char , int, struct cmd_list_element ));
	306
	307	/* Do a "show" command for each thing on a command list. */
	308
	309	extern void
	310	cmd_show_list PARAMS ((struct cmd_list_element , int, char ));
	311
	312	extern void
	313	error_no_arg PARAMS ((char *));
	314
	315	extern void
	316	dont_repeat PARAMS ((void));
	317
	318	/* Used to mark commands that don't do anything. If we just leave the
	319	function field NULL, the command is interpreted as a help topic, or
	320	as a class of commands. */
	321
	322	extern void
	323	not_just_help_class_command PARAMS ((char *, int));
	324
	325	#endif /* !defined (COMMAND_H) */