[thirdparty/binutils-gdb.git] / gdb / cli / cli-decode.h

/* Header file for GDB command decoding library.
   Copyright 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 (CLI_DECODE_H)
#define CLI_DECODE_H 1

#include "gdb_regex.h"		/* Needed by apropos_cmd.  */
#include "command.h"

#if 0
/* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
   cmd_types'' can be moved from "command.h" to "cli-decode.h".  */
/* 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;
#endif

/* 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.  NULL for command class
       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.  */
    union
      {
	/* If type is not_set_cmd, call it like this: */
	cmd_cfunc_ftype *cfunc;
	/* If type is set_cmd or show_cmd, first set the variables,
	   and then call this: */
	cmd_sfunc_ftype *sfunc;
      }
    function;

    /* Local state (context) for this command.  This can be anything.  */
    void *context;

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

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

    /* Hook for another command to be executed before this command.  */
    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;

    /* 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).  */
    const char **enums;

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

    /* 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)
       so the hook can be removed when this one is deleted.  */
    struct cmd_list_element *hookee_post;

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

/* API to the manipulation of command lists.  */

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

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

extern void set_cmd_completer (struct cmd_list_element *cmd,
			       char **(*completer) (char *text, char *word));

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

/* Access to the command's local context.  */
extern void set_cmd_context (struct cmd_list_element *cmd, void *context);
extern void *get_cmd_context (struct cmd_list_element *cmd);

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 (const char *enumlist[], char *, char *);

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

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

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

/* Functions that implement commands about CLI commands. */

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 apropos_cmd (struct ui_file *, struct cmd_list_element *,
                         struct re_pattern_buffer *, char *);

/* 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 *arg, int from_tty);

/* Exported to cli/cli-setshow.c */

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


#endif /* !defined (CLI_DECODE_H) */
Commit	Line	Data
d318976c	1	/* Header file for GDB command decoding library.
b6ba6518	2	Copyright 2000 Free Software Foundation, Inc.
d318976c FN	3
	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.
	8
	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.
	13
	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. */
	18
	19	#if !defined (CLI_DECODE_H)
	20	#define CLI_DECODE_H 1
	21
cc6dd2c0	22	#include "gdb_regex.h" /* Needed by apropos_cmd. */
18a642a1	23	#include "command.h"
d318976c	24
18a642a1 AC	25	#if 0
	26	/* FIXME: cagney/2002-03-17: Once cmd_type() has been removed, ``enum
	27	cmd_types'' can be moved from "command.h" to "cli-decode.h". */
d318976c FN	28	/* Not a set/show command. Note that some commands which begin with
	29	"set" or "show" might be in this category, if their syntax does
	30	not fall into one of the following categories. */
	31	typedef enum cmd_types
	32	{
	33	not_set_cmd,
	34	set_cmd,
	35	show_cmd
	36	}
	37	cmd_types;
18a642a1	38	#endif
d318976c FN	39
	40	/* This structure records one command'd definition. */
	41
	42
	43	/* This flag is used by the code executing commands to warn the user
	44	the first time a deprecated command is used, see the 'flags' field in
	45	the following struct.
	46	*/
	47	#define CMD_DEPRECATED 0x1
	48	#define DEPRECATED_WARN_USER 0x2
	49	#define MALLOCED_REPLACEMENT 0x4
	50
	51	struct cmd_list_element
	52	{
	53	/* Points to next command in this list. */
	54	struct cmd_list_element *next;
	55
	56	/* Name of this command. */
	57	char *name;
	58
	59	/* Command class; class values are chosen by application program. */
	60	enum command_class class;
	61
e00d1dc8	62	/* Function definition of this command. NULL for command class
9f60d481 AC	63	names and for help topics that are not really commands. NOTE:
	64	cagney/2002-02-02: This function signature is evolving. For
	65	the moment suggest sticking with either set_cmd_cfunc() or
	66	set_cmd_sfunc(). */
	67	void (func) (struct cmd_list_element c, char *args, int from_tty);
	68	/* The command's real callback. At present func() bounces through
	69	to one of the below. */
d318976c FN	70	union
d318976c FN	71	{
9773a94b AC	72	/* If type is not_set_cmd, call it like this: */
	73	cmd_cfunc_ftype *cfunc;
	74	/* If type is set_cmd or show_cmd, first set the variables,
	75	and then call this: */
	76	cmd_sfunc_ftype *sfunc;
d318976c FN	77	}
d318976c FN	78	function;
d318976c	79
7d0766f3 AC	80	/* Local state (context) for this command. This can be anything. */
	81	void *context;
	82
d318976c FN	83	/* Documentation of this command (or help topic).
	84	First line is brief documentation; remaining lines form, with it,
	85	the full documentation. First line should end with a period.
	86	Entire string should also end with a period, not a newline. */
	87	char *doc;
	88
	89	/* flags : a bitfield
	90
	91	bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
	92	is deprecated. It may be removed from gdb's command set in the
	93	future.
	94
	95	bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
	96	this is a deprecated command. The user should only be warned
	97	the first time a command is used.
	98
	99	bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
	100	compile time (this is the way it should, in general, be done)
	101	the memory containing the replacement string is statically
	102	allocated. In some cases it makes sense to deprecate commands
	103	at runtime (the testsuite is one example). In this case the
	104	memory for replacement is malloc'ed. When a command is
	105	undeprecated or re-deprecated at runtime we don't want to risk
	106	calling free on statically allocated memory, so we check this
	107	flag.
	108	*/
	109	int flags;
	110
	111	/* if this command is deprecated, this is the replacement name */
	112	char *replacement;
	113
552c04a7 TT	114	/* If this command represents a show command, then this function
	115	is called before the variable's value is examined. */
	116	void (pre_show_hook) (struct cmd_list_element c);
	117
d318976c FN	118	/* Hook for another command to be executed before this command. */
	119	struct cmd_list_element *hook_pre;
	120
	121	/* Hook for another command to be executed after this command. */
	122	struct cmd_list_element *hook_post;
	123
	124	/* Flag that specifies if this command is already running it's hook. */
	125	/* Prevents the possibility of hook recursion. */
	126	int hook_in;
	127
	128	/* Nonzero identifies a prefix command. For them, the address
	129	of the variable containing the list of subcommands. */
	130	struct cmd_list_element **prefixlist;
	131
	132	/* For prefix commands only:
	133	String containing prefix commands to get here: this one
	134	plus any others needed to get to it. Should end in a space.
	135	It is used before the word "command" in describing the
	136	commands reached through this prefix. */
	137	char *prefixname;
	138
	139	/* For prefix commands only:
	140	nonzero means do not get an error if subcommand is not
	141	recognized; call the prefix's own function in that case. */
	142	char allow_unknown;
	143
	144	/* Nonzero says this is an abbreviation, and should not
	145	be mentioned in lists of commands.
	146	This allows "br<tab>" to complete to "break", which it
	147	otherwise wouldn't. */
	148	char abbrev_flag;
	149
	150	/* Completion routine for this command. TEXT is the text beyond
	151	what was matched for the command itself (leading whitespace is
	152	skipped). It stops where we are supposed to stop completing
	153	(rl_point) and is '\0' terminated.
	154
	155	Return value is a malloc'd vector of pointers to possible completions
	156	terminated with NULL. If there are no completions, returning a pointer
	157	to a NULL would work but returning NULL itself is also valid.
	158	WORD points in the same buffer as TEXT, and completions should be
	159	returned relative to this position. For example, suppose TEXT is "foo"
	160	and we want to complete to "foobar". If WORD is "oo", return
	161	"oobar"; if WORD is "baz/foo", return "baz/foobar". */
	162	char *(completer) (char text, char word);
	163
	164	/* Type of "set" or "show" command (or SET_NOT_SET if not "set"
	165	or "show"). */
	166	cmd_types type;
	167
	168	/* Pointer to variable affected by "set" and "show". Doesn't matter
	169	if type is not_set. */
	170	void *var;
	171
	172	/* What kind of variable is VAR? /
	173	var_types var_type;
	174
	175	/* Pointer to NULL terminated list of enumerated values (like argv). */
	176	const char **enums;
	177
	178	/* Pointer to command strings of user-defined commands */
	179	struct command_line *user_commands;
	180
	181	/* Pointer to command that is hooked by this one, (by hook_pre)
182	so the hook can be removed when this one is deleted. */
183	struct cmd_list_element *hookee_pre;
184
185	/* Pointer to command that is hooked by this one, (by hook_post)
186	so the hook can be removed when this one is deleted. */
187	struct cmd_list_element *hookee_post;
188
189	/* Pointer to command that is aliased by this one, so the
190	aliased command can be located in case it has been hooked. */
191	struct cmd_list_element *cmd_pointer;
192	};
193
194	/* API to the manipulation of command lists. */
195
196	extern struct cmd_list_element add_cmd (char , enum command_class,
197	void (fun) (char , int), char *,
198	struct cmd_list_element **);
199
200	extern struct cmd_list_element add_alias_cmd (char , char *,
201	enum command_class, int,
202	struct cmd_list_element **);
203
204	extern struct cmd_list_element add_prefix_cmd (char , enum command_class,
205	void (fun) (char , int),
206	char *,
207	struct cmd_list_element **,
208	char *, int,
209	struct cmd_list_element **);
210
211	extern struct cmd_list_element add_abbrev_prefix_cmd (char ,
212	enum command_class,
213	void (fun) (char ,
214	int),
215	char *,
216	struct cmd_list_element
217	*, char , int,
218	struct cmd_list_element
219	**);
220
9f60d481 AC	221	/* Set the commands corresponding callback. */
	222
	223	extern void set_cmd_cfunc (struct cmd_list_element *cmd,
	224	void (cfunc) (char args, int from_tty));
	225
	226	extern void set_cmd_sfunc (struct cmd_list_element *cmd,
	227	void (sfunc) (char args, int from_tty,
	228	struct cmd_list_element * c));
	229
5ba2abeb AC	230	extern void set_cmd_completer (struct cmd_list_element *cmd,
	231	char *(completer) (char text, char word));
	232
bbaca940 AC	233	/* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
	234	around in cmd objects to test the value of the commands sfunc(). */
	235	extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
	236	void (cfunc) (char args, int from_tty));
9f60d481	237
7d0766f3 AC	238	/* Access to the command's local context. */
	239	extern void set_cmd_context (struct cmd_list_element cmd, void context);
	240	extern void get_cmd_context (struct cmd_list_element cmd);
	241
d318976c FN	242	extern struct cmd_list_element lookup_cmd (char *,
	243	struct cmd_list_element , char ,
	244	int, int);
	245
	246	extern struct cmd_list_element lookup_cmd_1 (char *,
	247	struct cmd_list_element *,
	248	struct cmd_list_element **,
	249	int);
	250
	251	extern struct cmd_list_element *
	252	deprecate_cmd (struct cmd_list_element , char );
	253
	254	extern void
	255	deprecated_cmd_warning (char **);
	256
	257	extern int
	258	lookup_cmd_composition (char *text,
	259	struct cmd_list_element **alias,
	260	struct cmd_list_element **prefix_cmd,
	261	struct cmd_list_element **cmd);
	262
	263	extern struct cmd_list_element add_com (char , enum command_class,
	264	void (fun) (char , int), char *);
	265
	266	extern struct cmd_list_element add_com_alias (char , char *,
	267	enum command_class, int);
	268
	269	extern struct cmd_list_element add_info (char , void (fun) (char , int),
	270	char *);
	271
	272	extern struct cmd_list_element add_info_alias (char , char *, int);
	273
	274	extern char *complete_on_cmdlist (struct cmd_list_element , char , char );
	275
	276	extern char *complete_on_enum (const char enumlist[], char , char );
	277
	278	extern void delete_cmd (char , struct cmd_list_element *);
	279
	280	extern void help_cmd_list (struct cmd_list_element *, enum command_class,
	281	char , int, struct ui_file );
	282
	283	extern struct cmd_list_element add_set_cmd (char name, enum
	284	command_class class,
	285	var_types var_type, void *var,
	286	char *doc,
	287	struct cmd_list_element **list);
	288
	289	extern struct cmd_list_element add_set_enum_cmd (char name,
	290	enum command_class class,
	291	const char *enumlist[],
	292	const char **var,
	293	char *doc,
	294	struct cmd_list_element **list);
	295
d318976c FN	296	extern struct cmd_list_element add_show_from_set (struct cmd_list_element ,
	297	struct cmd_list_element
	298	**);
	299
	300	/* Functions that implement commands about CLI commands. */
	301
	302	extern void help_cmd (char , struct ui_file );
	303
	304	extern void help_list (struct cmd_list_element , char ,
	305	enum command_class, struct ui_file *);
	306
	307	extern void apropos_cmd (struct ui_file , struct cmd_list_element ,
	308	struct re_pattern_buffer , char );
	309
	310	/* Used to mark commands that don't do anything. If we just leave the
	311	function field NULL, the command is interpreted as a help topic, or
	312	as a class of commands. */
	313
	314	extern void not_just_help_class_command (char *arg, int from_tty);
	315
	316	/* Exported to cli/cli-setshow.c */
	317
	318	extern void print_doc_line (struct ui_file , char );
	319
	320
	321	#endif /* !defined (CLI_DECODE_H) */