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

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;

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

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

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

extern void
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,
	36	class_pseudo, class_tui, class_xdb,
	37	};
	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
	85	struct cmd_list_element
	86	{
	87	/* Points to next command in this list. */
	88	struct cmd_list_element *next;
	89
	90	/* Name of this command. */
	91	char *name;
	92
	93	/* Command class; class values are chosen by application program. */
	94	enum command_class class;
	95
	96	/* Function definition of this command.
	97	NO_FUNCTION for command class names and for help topics that
	98	are not really commands. */
	99	union
	100	{
	101	/* If type is not_set_cmd, call it like this: */
	102	void (cfunc) PARAMS ((char args, int from_tty));
	103
	104	/* If type is cmd_set or show_cmd, first set the variables, and
	105	then call this. */
	106	void (sfunc) PARAMS ((char args, int from_tty,
c5aa993b JM	107	struct cmd_list_element * c));
	108	}
	109	function;
	110	#define NO_FUNCTION ((void () PARAMS((char args, int from_tty))) 0)
c906108c SS	111
	112	/* Documentation of this command (or help topic).
	113	First line is brief documentation; remaining lines form, with it,
	114	the full documentation. First line should end with a period.
	115	Entire string should also end with a period, not a newline. */
	116	char *doc;
	117
	118	/* Hook for another command to be executed before this command. */
	119	struct cmd_list_element *hook;
	120
	121	/* Nonzero identifies a prefix command. For them, the address
	122	of the variable containing the list of subcommands. */
	123	struct cmd_list_element **prefixlist;
	124
	125	/* For prefix commands only:
	126	String containing prefix commands to get here: this one
	127	plus any others needed to get to it. Should end in a space.
	128	It is used before the word "command" in describing the
	129	commands reached through this prefix. */
	130	char *prefixname;
	131
	132	/* For prefix commands only:
	133	nonzero means do not get an error if subcommand is not
	134	recognized; call the prefix's own function in that case. */
	135	char allow_unknown;
	136
	137	/* Nonzero says this is an abbreviation, and should not
	138	be mentioned in lists of commands.
	139	This allows "br<tab>" to complete to "break", which it
	140	otherwise wouldn't. */
	141	char abbrev_flag;
	142
	143	/* Completion routine for this command. TEXT is the text beyond
	144	what was matched for the command itself (leading whitespace is
	145	skipped). It stops where we are supposed to stop completing
	146	(rl_point) and is '\0' terminated.
	147
	148	Return value is a malloc'd vector of pointers to possible completions
	149	terminated with NULL. If there are no completions, returning a pointer
	150	to a NULL would work but returning NULL itself is also valid.
	151	WORD points in the same buffer as TEXT, and completions should be
	152	returned relative to this position. For example, suppose TEXT is "foo"
	153	and we want to complete to "foobar". If WORD is "oo", return
	154	"oobar"; if WORD is "baz/foo", return "baz/foobar". */
c5aa993b	155	char *(completer) PARAMS ((char text, char word));
c906108c SS	156
	157	/* Type of "set" or "show" command (or SET_NOT_SET if not "set"
	158	or "show"). */
	159	cmd_types type;
	160
	161	/* Pointer to variable affected by "set" and "show". Doesn't matter
	162	if type is not_set. */
	163	char *var;
	164
	165	/* What kind of variable is VAR? /
	166	var_types var_type;
	167
	168	/* Pointer to NULL terminated list of enumerated values (like argv). */
	169	char **enums;
	170
	171	/* Pointer to command strings of user-defined commands */
	172	struct command_line *user_commands;
	173
	174	/* Pointer to command that is hooked by this one,
	175	so the hook can be removed when this one is deleted. */
	176	struct cmd_list_element *hookee;
	177
	178	/* Pointer to command that is aliased by this one, so the
	179	aliased command can be located in case it has been hooked. */
	180	struct cmd_list_element *cmd_pointer;
	181	};
	182
	183	/* Forward-declarations of the entry-points of command.c. */
	184
	185	extern struct cmd_list_element *
c5aa993b JM	186	add_cmd PARAMS ((char , enum command_class, void (fun) (char *, int),
c5aa993b JM	187	char , struct cmd_list_element *));
c906108c SS	188
c906108c SS	189	extern struct cmd_list_element *
c5aa993b JM	190	add_alias_cmd PARAMS ((char , char , enum command_class, int,
c5aa993b JM	191	struct cmd_list_element **));
c906108c SS	192
c906108c SS	193	extern struct cmd_list_element *
c5aa993b JM	194	add_prefix_cmd PARAMS ((char , enum command_class, void (fun) (char *, int),
	195	char , struct cmd_list_element , char , int,
	196	struct cmd_list_element **));
c906108c SS	197
c906108c SS	198	extern struct cmd_list_element *
c5aa993b JM	199	add_abbrev_prefix_cmd PARAMS ((char *, enum command_class,
	200	void (fun) (char , int), char *,
	201	struct cmd_list_element *, char , int,
	202	struct cmd_list_element **));
c906108c SS	203
c906108c SS	204	extern struct cmd_list_element *
c5aa993b	205	lookup_cmd PARAMS ((char *, struct cmd_list_element , char *, int, int));
c906108c SS	206
c906108c SS	207	extern struct cmd_list_element *
c5aa993b JM	208	lookup_cmd_1 PARAMS ((char *, struct cmd_list_element ,
c5aa993b JM	209	struct cmd_list_element **, int));
c906108c SS	210
c906108c SS	211	extern void
c5aa993b	212	add_com PARAMS ((char , enum command_class, void (fun) (char *, int),
c906108c SS	213	char *));
	214
	215	extern void
	216	add_com_alias PARAMS ((char , char , enum command_class, int));
	217
	218	extern void
	219	add_info PARAMS ((char , void (fun) (char , int), char ));
	220
	221	extern void
	222	add_info_alias PARAMS ((char , char , int));
	223
	224	extern char **
c5aa993b	225	complete_on_cmdlist PARAMS ((struct cmd_list_element , char , char *));
c906108c SS	226
c906108c SS	227	extern char **
c5aa993b	228	complete_on_enum PARAMS ((char *enumlist, char , char *));
c906108c SS	229
	230	extern void
	231	delete_cmd PARAMS ((char , struct cmd_list_element *));
	232
d9fcf2fb	233	extern void help_cmd (char , struct ui_file );
c906108c	234
d9fcf2fb JM	235	extern void help_list (struct cmd_list_element , char ,
d9fcf2fb JM	236	enum command_class, struct ui_file *);
c906108c	237
d9fcf2fb JM	238	extern void help_cmd_list (struct cmd_list_element *, enum command_class,
d9fcf2fb JM	239	char , int, struct ui_file );
c906108c SS	240
c906108c SS	241	extern struct cmd_list_element *
c5aa993b JM	242	add_set_cmd PARAMS ((char , enum command_class, var_types, char , char *,
c5aa993b JM	243	struct cmd_list_element **));
c906108c SS	244
c906108c SS	245	extern struct cmd_list_element *
c5aa993b JM	246	add_set_enum_cmd PARAMS ((char name, enum command_class, char list[],
c5aa993b JM	247	char var, char doc, struct cmd_list_element ** c));
c906108c SS	248
c906108c SS	249	extern struct cmd_list_element *
c5aa993b JM	250	add_show_from_set PARAMS ((struct cmd_list_element *,
c5aa993b JM	251	struct cmd_list_element **));
c906108c SS	252
	253	/* Do a "set" or "show" command. ARG is NULL if no argument, or the text
	254	of the argument, and FROM_TTY is nonzero if this command is being entered
	255	directly by the user (i.e. these are just like any other
	256	command). C is the command list element for the command. */
	257
	258	extern void
	259	do_setshow_command PARAMS ((char , int, struct cmd_list_element ));
	260
	261	/* Do a "show" command for each thing on a command list. */
	262
	263	extern void
	264	cmd_show_list PARAMS ((struct cmd_list_element , int, char ));
	265
	266	extern void
	267	error_no_arg PARAMS ((char *));
	268
	269	extern void
	270	dont_repeat PARAMS ((void));
	271
	272	/* Used to mark commands that don't do anything. If we just leave the
	273	function field NULL, the command is interpreted as a help topic, or
	274	as a class of commands. */
	275
	276	extern void
	277	not_just_help_class_command PARAMS ((char *, int));
	278
	279	#endif /* !defined (COMMAND_H) */