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

/* Header file for GDB command decoding library.

   Copyright (c) 2000, 2003, 2007, 2008, 2009 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 3 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, see <http://www.gnu.org/licenses/>.  */

#if !defined (CLI_DECODE_H)
#define CLI_DECODE_H 1

#include "command.h"

struct re_pattern_buffer;

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

    /* For set/show commands.  A method for printing the output to the
       specified stream.  */
    show_value_ftype *show_value_func;

    /* 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 its 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) (struct cmd_list_element *cmd, char *text, char *word);

    /* Destruction routine for this command.  If non-NULL, this is
       called when this command instance is destroyed.  This may be
       used to finalize the CONTEXT field, if needed.  */
    void (*destroyer) (struct cmd_list_element *self, void *context);

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

    /* Start of a linked list of all aliases of this command.  */
    struct cmd_list_element *aliases;

    /* Link pointer for aliases on an alias list.  */
    struct cmd_list_element *alias_chain;
  };

/* 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) (struct cmd_list_element *self,
						    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 help_cmd_list (struct cmd_list_element *, enum command_class,
			   char *, int, struct ui_file *);

/* 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.
1bac305b	2
0fb0cc75	3	Copyright (c) 2000, 2003, 2007, 2008, 2009 Free Software Foundation, Inc.
d318976c FN	4
	5	This program is free software; you can redistribute it and/or modify
	6	it under the terms of the GNU General Public License as published by
a9762ec7	7	the Free Software Foundation; either version 3 of the License, or
d318976c FN	8	(at your option) any later version.
	9
	10	This program is distributed in the hope that it will be useful,
	11	but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	GNU General Public License for more details.
	14
	15	You should have received a copy of the GNU General Public License
a9762ec7	16	along with this program. If not, see <http://www.gnu.org/licenses/>. */
d318976c FN	17
	18	#if !defined (CLI_DECODE_H)
	19	#define CLI_DECODE_H 1
	20
18a642a1	21	#include "command.h"
d318976c	22
8fe84d01 MK	23	struct re_pattern_buffer;
8fe84d01 MK	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
335cca0d AC	89	/* For set/show commands. A method for printing the output to the
335cca0d AC	90	specified stream. */
08546159	91	show_value_ftype *show_value_func;
335cca0d	92
d318976c FN	93	/* flags : a bitfield
	94
	95	bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
	96	is deprecated. It may be removed from gdb's command set in the
	97	future.
	98
	99	bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
	100	this is a deprecated command. The user should only be warned
	101	the first time a command is used.
	102
	103	bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
	104	compile time (this is the way it should, in general, be done)
	105	the memory containing the replacement string is statically
	106	allocated. In some cases it makes sense to deprecate commands
	107	at runtime (the testsuite is one example). In this case the
	108	memory for replacement is malloc'ed. When a command is
	109	undeprecated or re-deprecated at runtime we don't want to risk
	110	calling free on statically allocated memory, so we check this
	111	flag.
	112	*/
	113	int flags;
	114
4e18e2de	115	/* If this command is deprecated, this is the replacement name. */
d318976c FN	116	char *replacement;
d318976c FN	117
552c04a7 TT	118	/* If this command represents a show command, then this function
	119	is called before the variable's value is examined. */
	120	void (pre_show_hook) (struct cmd_list_element c);
	121
d318976c FN	122	/* Hook for another command to be executed before this command. */
	123	struct cmd_list_element *hook_pre;
	124
	125	/* Hook for another command to be executed after this command. */
	126	struct cmd_list_element *hook_post;
	127
0fb0cc75	128	/* Flag that specifies if this command is already running its hook. */
4e18e2de	129	/* Prevents the possibility of hook recursion. */
d318976c FN	130	int hook_in;
	131
	132	/* Nonzero identifies a prefix command. For them, the address
	133	of the variable containing the list of subcommands. */
	134	struct cmd_list_element **prefixlist;
	135
	136	/* For prefix commands only:
	137	String containing prefix commands to get here: this one
	138	plus any others needed to get to it. Should end in a space.
	139	It is used before the word "command" in describing the
	140	commands reached through this prefix. */
	141	char *prefixname;
	142
	143	/* For prefix commands only:
	144	nonzero means do not get an error if subcommand is not
	145	recognized; call the prefix's own function in that case. */
	146	char allow_unknown;
	147
	148	/* Nonzero says this is an abbreviation, and should not
	149	be mentioned in lists of commands.
	150	This allows "br<tab>" to complete to "break", which it
	151	otherwise wouldn't. */
	152	char abbrev_flag;
	153
	154	/* Completion routine for this command. TEXT is the text beyond
	155	what was matched for the command itself (leading whitespace is
	156	skipped). It stops where we are supposed to stop completing
	157	(rl_point) and is '\0' terminated.
	158
	159	Return value is a malloc'd vector of pointers to possible completions
	160	terminated with NULL. If there are no completions, returning a pointer
	161	to a NULL would work but returning NULL itself is also valid.
	162	WORD points in the same buffer as TEXT, and completions should be
	163	returned relative to this position. For example, suppose TEXT is "foo"
	164	and we want to complete to "foobar". If WORD is "oo", return
	165	"oobar"; if WORD is "baz/foo", return "baz/foobar". */
d8906c6f TJB	166	char *(completer) (struct cmd_list_element cmd, char text, char *word);
	167
	168	/* Destruction routine for this command. If non-NULL, this is
	169	called when this command instance is destroyed. This may be
	170	used to finalize the CONTEXT field, if needed. */
	171	void (destroyer) (struct cmd_list_element self, void *context);
d318976c FN	172
	173	/* Type of "set" or "show" command (or SET_NOT_SET if not "set"
	174	or "show"). */
	175	cmd_types type;
	176
	177	/* Pointer to variable affected by "set" and "show". Doesn't matter
	178	if type is not_set. */
	179	void *var;
	180
	181	/* What kind of variable is VAR? /
	182	var_types var_type;
	183
	184	/* Pointer to NULL terminated list of enumerated values (like argv). */
	185	const char **enums;
	186
	187	/* Pointer to command strings of user-defined commands */
	188	struct command_line *user_commands;
	189
	190	/* Pointer to command that is hooked by this one, (by hook_pre)
	191	so the hook can be removed when this one is deleted. */
	192	struct cmd_list_element *hookee_pre;
	193
	194	/* Pointer to command that is hooked by this one, (by hook_post)
	195	so the hook can be removed when this one is deleted. */
	196	struct cmd_list_element *hookee_post;
	197
	198	/* Pointer to command that is aliased by this one, so the
	199	aliased command can be located in case it has been hooked. */
	200	struct cmd_list_element *cmd_pointer;
b05dcbb7 TT	201
	202	/* Start of a linked list of all aliases of this command. */
	203	struct cmd_list_element *aliases;
	204
	205	/* Link pointer for aliases on an alias list. */
	206	struct cmd_list_element *alias_chain;
d318976c FN	207	};
	208
	209	/* API to the manipulation of command lists. */
	210
	211	extern struct cmd_list_element add_cmd (char , enum command_class,
	212	void (fun) (char , int), char *,
	213	struct cmd_list_element **);
	214
	215	extern struct cmd_list_element add_alias_cmd (char , char *,
	216	enum command_class, int,
	217	struct cmd_list_element **);
	218
	219	extern struct cmd_list_element add_prefix_cmd (char , enum command_class,
	220	void (fun) (char , int),
	221	char *,
	222	struct cmd_list_element **,
	223	char *, int,
	224	struct cmd_list_element **);
	225
	226	extern struct cmd_list_element add_abbrev_prefix_cmd (char ,
	227	enum command_class,
	228	void (fun) (char ,
	229	int),
	230	char *,
	231	struct cmd_list_element
	232	*, char , int,
	233	struct cmd_list_element
	234	**);
	235
9f60d481 AC	236	/* Set the commands corresponding callback. */
	237
	238	extern void set_cmd_cfunc (struct cmd_list_element *cmd,
	239	void (cfunc) (char args, int from_tty));
	240
	241	extern void set_cmd_sfunc (struct cmd_list_element *cmd,
	242	void (sfunc) (char args, int from_tty,
	243	struct cmd_list_element * c));
	244
5ba2abeb	245	extern void set_cmd_completer (struct cmd_list_element *cmd,
d8906c6f TJB	246	char *(completer) (struct cmd_list_element *self,
d8906c6f TJB	247	char text, char word));
5ba2abeb	248
bbaca940 AC	249	/* HACK: cagney/2002-02-23: Code, mostly in tracepoints.c, grubs
	250	around in cmd objects to test the value of the commands sfunc(). */
	251	extern int cmd_cfunc_eq (struct cmd_list_element *cmd,
	252	void (cfunc) (char args, int from_tty));
9f60d481	253
7d0766f3 AC	254	/* Access to the command's local context. */
	255	extern void set_cmd_context (struct cmd_list_element cmd, void context);
	256	extern void get_cmd_context (struct cmd_list_element cmd);
	257
d318976c FN	258	extern struct cmd_list_element lookup_cmd (char *,
	259	struct cmd_list_element , char ,
	260	int, int);
	261
	262	extern struct cmd_list_element lookup_cmd_1 (char *,
	263	struct cmd_list_element *,
	264	struct cmd_list_element **,
	265	int);
	266
	267	extern struct cmd_list_element *
	268	deprecate_cmd (struct cmd_list_element , char );
	269
	270	extern void
	271	deprecated_cmd_warning (char **);
	272
	273	extern int
	274	lookup_cmd_composition (char *text,
	275	struct cmd_list_element **alias,
	276	struct cmd_list_element **prefix_cmd,
	277	struct cmd_list_element **cmd);
	278
	279	extern struct cmd_list_element add_com (char , enum command_class,
	280	void (fun) (char , int), char *);
	281
	282	extern struct cmd_list_element add_com_alias (char , char *,
	283	enum command_class, int);
	284
	285	extern struct cmd_list_element add_info (char , void (fun) (char , int),
	286	char *);
	287
	288	extern struct cmd_list_element add_info_alias (char , char *, int);
	289
	290	extern char *complete_on_cmdlist (struct cmd_list_element , char , char );
	291
	292	extern char *complete_on_enum (const char enumlist[], char , char );
	293
d318976c FN	294	extern void help_cmd_list (struct cmd_list_element *, enum command_class,
	295	char , int, struct ui_file );
	296
d318976c FN	297	/* Functions that implement commands about CLI commands. */
	298
	299	extern void help_cmd (char , struct ui_file );
	300
	301	extern void help_list (struct cmd_list_element , char ,
	302	enum command_class, struct ui_file *);
	303
	304	extern void apropos_cmd (struct ui_file , struct cmd_list_element ,
	305	struct re_pattern_buffer , char );
	306
	307	/* Used to mark commands that don't do anything. If we just leave the
	308	function field NULL, the command is interpreted as a help topic, or
	309	as a class of commands. */
	310
	311	extern void not_just_help_class_command (char *arg, int from_tty);
	312
	313	/* Exported to cli/cli-setshow.c */
	314
	315	extern void print_doc_line (struct ui_file , char );
	316
	317
	318	#endif /* !defined (CLI_DECODE_H) */