[deliverable/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) (char *args, int from_tty);

	/* If type is cmd_set or show_cmd, first set the variables, and
	   then call this.  */
	void (*sfunc) (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) (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.  */
    void *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 (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
						       **);

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);

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

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

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

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

extern void delete_cmd (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 (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,
						  char *enumlist[],
						  char **var,
						  char *doc,
						  struct cmd_list_element **list);

extern struct cmd_list_element *add_show_from_set (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 (char *, int, struct cmd_list_element *);

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

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

extern void error_no_arg (char *);

extern void 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);

#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: */
507f3c78	111	void (cfunc) (char args, int from_tty);
c906108c SS	112
	113	/* If type is cmd_set or show_cmd, first set the variables, and
	114	then call this. */
507f3c78	115	void (sfunc) (char args, int from_tty, struct cmd_list_element * c);
c5aa993b JM	116	}
	117	function;
	118	#define NO_FUNCTION ((void () PARAMS((char args, int from_tty))) 0)
c906108c SS	119
	120	/* Documentation of this command (or help topic).
	121	First line is brief documentation; remaining lines form, with it,
	122	the full documentation. First line should end with a period.
	123	Entire string should also end with a period, not a newline. */
	124	char *doc;
	125
56382845 FN	126	/* flags : a bitfield
	127
	128	bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
	129	is deprecated. It may be removed from gdb's command set in the
	130	future.
	131
	132	bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
	133	this is a deprecated command. The user should only be warned
	134	the first time a command is used.
	135
	136	bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
	137	compile time (this is the way it should, in general, be done)
c0c9b0b8	138	the memory containing the replacement string is statically
56382845 FN	139	allocated. In some cases it makes sense to deprecate commands
	140	at runtime (the testsuite is one example). In this case the
	141	memory for replacement is malloc'ed. When a command is
	142	undeprecated or re-deprecated at runtime we don't want to risk
	143	calling free on statically allocated memory, so we check this
	144	flag.
	145	*/
	146	int flags;
	147
	148	/* if this command is deprecated, this is the replacement name */
	149	char *replacement;
	150
c906108c SS	151	/* Hook for another command to be executed before this command. */
	152	struct cmd_list_element *hook;
	153
	154	/* Nonzero identifies a prefix command. For them, the address
	155	of the variable containing the list of subcommands. */
	156	struct cmd_list_element **prefixlist;
	157
	158	/* For prefix commands only:
	159	String containing prefix commands to get here: this one
	160	plus any others needed to get to it. Should end in a space.
	161	It is used before the word "command" in describing the
	162	commands reached through this prefix. */
	163	char *prefixname;
	164
	165	/* For prefix commands only:
	166	nonzero means do not get an error if subcommand is not
	167	recognized; call the prefix's own function in that case. */
	168	char allow_unknown;
	169
	170	/* Nonzero says this is an abbreviation, and should not
	171	be mentioned in lists of commands.
	172	This allows "br<tab>" to complete to "break", which it
	173	otherwise wouldn't. */
	174	char abbrev_flag;
	175
	176	/* Completion routine for this command. TEXT is the text beyond
	177	what was matched for the command itself (leading whitespace is
	178	skipped). It stops where we are supposed to stop completing
	179	(rl_point) and is '\0' terminated.
	180
	181	Return value is a malloc'd vector of pointers to possible completions
	182	terminated with NULL. If there are no completions, returning a pointer
	183	to a NULL would work but returning NULL itself is also valid.
	184	WORD points in the same buffer as TEXT, and completions should be
	185	returned relative to this position. For example, suppose TEXT is "foo"
	186	and we want to complete to "foobar". If WORD is "oo", return
	187	"oobar"; if WORD is "baz/foo", return "baz/foobar". */
507f3c78	188	char *(completer) (char text, char word);
c906108c SS	189
	190	/* Type of "set" or "show" command (or SET_NOT_SET if not "set"
	191	or "show"). */
	192	cmd_types type;
	193
	194	/* Pointer to variable affected by "set" and "show". Doesn't matter
	195	if type is not_set. */
1ed2a135	196	void *var;
c906108c SS	197
	198	/* What kind of variable is VAR? /
	199	var_types var_type;
	200
	201	/* Pointer to NULL terminated list of enumerated values (like argv). */
	202	char **enums;
	203
	204	/* Pointer to command strings of user-defined commands */
	205	struct command_line *user_commands;
	206
	207	/* Pointer to command that is hooked by this one,
	208	so the hook can be removed when this one is deleted. */
	209	struct cmd_list_element *hookee;
	210
	211	/* Pointer to command that is aliased by this one, so the
	212	aliased command can be located in case it has been hooked. */
	213	struct cmd_list_element *cmd_pointer;
	214	};
	215
	216	/* Forward-declarations of the entry-points of command.c. */
	217
a14ed312 KB	218	extern struct cmd_list_element add_cmd (char , enum command_class,
	219	void (fun) (char , int), char *,
	220	struct cmd_list_element **);
	221
	222	extern struct cmd_list_element add_alias_cmd (char , char *,
	223	enum command_class, int,
	224	struct cmd_list_element **);
	225
	226	extern struct cmd_list_element add_prefix_cmd (char , enum command_class,
	227	void (fun) (char , int),
	228	char *,
	229	struct cmd_list_element **,
	230	char *, int,
	231	struct cmd_list_element **);
	232
	233	extern struct cmd_list_element add_abbrev_prefix_cmd (char ,
	234	enum command_class,
	235	void (fun) (char ,
	236	int),
	237	char *,
	238	struct cmd_list_element
	239	*, char , int,
	240	struct cmd_list_element
	241	**);
	242
	243	extern struct cmd_list_element lookup_cmd (char *,
	244	struct cmd_list_element , char ,
	245	int, int);
	246
	247	extern struct cmd_list_element lookup_cmd_1 (char *,
	248	struct cmd_list_element *,
	249	struct cmd_list_element **,
	250	int);
c906108c	251
56382845 FN	252	extern struct cmd_list_element *
	253	deprecate_cmd (struct cmd_list_element , char );
	254
c906108c	255	extern void
56382845 FN	256	deprecated_cmd_warning (char **);
	257
	258	extern int
	259	lookup_cmd_composition (char *text,
	260	struct cmd_list_element **alias,
	261	struct cmd_list_element **prefix_cmd,
	262	struct cmd_list_element **cmd);
	263
a14ed312 KB	264	extern struct cmd_list_element add_com (char , enum command_class,
a14ed312 KB	265	void (fun) (char , int), char *);
c906108c	266
a14ed312 KB	267	extern struct cmd_list_element add_com_alias (char , char *,
a14ed312 KB	268	enum command_class, int);
c906108c	269
a14ed312 KB	270	extern struct cmd_list_element add_info (char , void (fun) (char , int),
a14ed312 KB	271	char *);
c906108c	272
a14ed312	273	extern struct cmd_list_element add_info_alias (char , char *, int);
c906108c	274
a14ed312	275	extern char *complete_on_cmdlist (struct cmd_list_element , char , char );
c906108c	276
a14ed312	277	extern char complete_on_enum (char enumlist, char , char );
c906108c	278
a14ed312	279	extern void delete_cmd (char , struct cmd_list_element *);
c906108c	280
d9fcf2fb	281	extern void help_cmd (char , struct ui_file );
c906108c	282
d9fcf2fb JM	283	extern void help_list (struct cmd_list_element , char ,
d9fcf2fb JM	284	enum command_class, struct ui_file *);
c906108c	285
d9fcf2fb JM	286	extern void help_cmd_list (struct cmd_list_element *, enum command_class,
d9fcf2fb JM	287	char , int, struct ui_file );
c906108c	288
1ed2a135 AC	289	extern struct cmd_list_element add_set_cmd (char name, enum
	290	command_class class,
	291	var_types var_type, void *var,
	292	char *doc,
	293	struct cmd_list_element **list);
	294
	295	extern struct cmd_list_element add_set_enum_cmd (char name,
	296	enum command_class class,
	297	char *enumlist[],
	298	char **var,
	299	char *doc,
	300	struct cmd_list_element **list);
c906108c	301
a14ed312 KB	302	extern struct cmd_list_element add_show_from_set (struct cmd_list_element ,
	303	struct cmd_list_element
	304	**);
c906108c SS	305
	306	/* Do a "set" or "show" command. ARG is NULL if no argument, or the text
	307	of the argument, and FROM_TTY is nonzero if this command is being entered
	308	directly by the user (i.e. these are just like any other
	309	command). C is the command list element for the command. */
	310
a14ed312	311	extern void do_setshow_command (char , int, struct cmd_list_element );
c906108c SS	312
	313	/* Do a "show" command for each thing on a command list. */
	314
a14ed312	315	extern void cmd_show_list (struct cmd_list_element , int, char );
c906108c	316
a14ed312	317	extern void error_no_arg (char *);
c906108c	318
a14ed312	319	extern void dont_repeat (void);
c906108c SS	320
	321	/* Used to mark commands that don't do anything. If we just leave the
	322	function field NULL, the command is interpreted as a help topic, or
	323	as a class of commands. */
	324
a14ed312	325	extern void not_just_help_class_command (char *, int);
c906108c SS	326
c906108c SS	327	#endif /* !defined (COMMAND_H) */