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

/* Header file for GDB command decoding library.

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