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

/* Header file for GDB command decoding library.
   Copyright (C) 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 "gnu-regex.h"   /* Needed by apropos_cmd. */

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

/* Reasonable values for an AUTO_BOOLEAN variable. */
enum cmd_auto_boolean
{
  CMD_AUTO_BOOLEAN_TRUE,
  CMD_AUTO_BOOLEAN_FALSE,
  CMD_AUTO_BOOLEAN_AUTO
};

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

    /* "on" / "true" / "enable" or "off" / "false" / "disable" or
       "auto.  *VAR is an ``enum cmd_auto_boolean''.  NOTE: In general
       a custom show command will need to be implemented - one that
       for "auto" prints both the "auto" and the current auto-selected
       value. */
    var_auto_boolean,

    /* Unsigned Integer.  *VAR is an unsigned int.  The user can type 0
       to mean "unlimited", which is stored in *VAR as UINT_MAX.  */
    var_uinteger,

    /* Like var_uinteger but signed.  *VAR is an int.  The user can type 0
       to mean "unlimited", which is stored in *VAR as INT_MAX.  */
    var_integer,

    /* String which the user enters with escapes (e.g. the user types \n and
       it is a real newline in the stored string).
       *VAR is a malloc'd string, or NULL if the string is empty.  */
    var_string,
    /* String which stores what the user types verbatim.
       *VAR is a malloc'd string, or NULL if the string is empty.  */
    var_string_noescape,
    /* String which stores a filename.
       *VAR is a malloc'd string, or NULL if the string is empty.  */
    var_filename,
    /* ZeroableInteger.  *VAR is an int.  Like Unsigned Integer except
       that zero really means zero.  */
    var_zinteger,
    /* Enumerated type.  Can only have one of the specified values.  *VAR is a
       char pointer to the name of the element that we find.  */
    var_enum
  }
var_types;

/* This structure records one command'd definition.  */


/* This flag is used by the code executing commands to warn the user 
   the first time a deprecated command is used, see the 'flags' field in
   the following struct.
*/
#define CMD_DEPRECATED            0x1
#define DEPRECATED_WARN_USER      0x2
#define MALLOCED_REPLACEMENT      0x4

struct cmd_list_element
  {
    /* Points to next command in this list.  */
    struct cmd_list_element *next;

    /* Name of this command.  */
    char *name;

    /* Command class; class values are chosen by application program.  */
    enum command_class class;

    /* Function definition of this command.
       NO_FUNCTION for command class names and for help topics that
       are not really commands.  */
    union
      {
	/* If type is not_set_cmd, call it like this:  */
	void (*cfunc) (char *args, int from_tty);

	/* If type is cmd_set or show_cmd, first set the variables, and
	   then call this.  */
	void (*sfunc) (char *args, int from_tty, struct cmd_list_element * c);
      }
    function;
#define NO_FUNCTION ((void (*) (char *args, int from_tty)) 0)

    /* Documentation of this command (or help topic).
       First line is brief documentation; remaining lines form, with it,
       the full documentation.  First line should end with a period.
       Entire string should also end with a period, not a newline.  */
    char *doc;

    /* flags : a bitfield 
       
       bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
       is deprecated. It may be removed from gdb's command set in the
       future.

       bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
       this is a deprecated command.  The user should only be warned
       the first time a command is used.
        
       bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
       compile time (this is the way it should, in general, be done)
       the memory containing the replacement string is statically
       allocated.  In some cases it makes sense to deprecate commands
       at runtime (the testsuite is one example).  In this case the
       memory for replacement is malloc'ed.  When a command is
       undeprecated or re-deprecated at runtime we don't want to risk
       calling free on statically allocated memory, so we check this
       flag.  
     */
    int flags;

    /* if this command is deprecated, this is the replacement name */
    char *replacement;

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

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_set_auto_boolean_cmd (char *name,
							  enum command_class class,
							  enum cmd_auto_boolean *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 FN	1	/* Header file for GDB command decoding library.
	2	Copyright (C) 2000 Free Software Foundation, Inc.
	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
	22	#include "gnu-regex.h" /* Needed by apropos_cmd. */
	23
	24	/* Command classes are top-level categories into which commands are broken
	25	down for "help" purposes.
	26	Notes on classes: class_alias is for alias commands which are not
	27	abbreviations of the original command. class-pseudo is for
	28	commands which are not really commands nor help topics ("stop"). */
	29
	30	enum command_class
	31	{
	32	/* Special args to help_list */
	33	class_deprecated, all_classes = -2, all_commands = -1,
	34	/* Classes of commands */
	35	no_class = -1, class_run = 0, class_vars, class_stack,
	36	class_files, class_support, class_info, class_breakpoint, class_trace,
	37	class_alias, class_obscure, class_user, class_maintenance,
	38	class_pseudo, class_tui, class_xdb
	39	};
	40
	41	/* Not a set/show command. Note that some commands which begin with
	42	"set" or "show" might be in this category, if their syntax does
	43	not fall into one of the following categories. */
	44	typedef enum cmd_types
	45	{
	46	not_set_cmd,
	47	set_cmd,
	48	show_cmd
	49	}
	50	cmd_types;
	51
	52	/* Reasonable values for an AUTO_BOOLEAN variable. */
	53	enum cmd_auto_boolean
	54	{
	55	CMD_AUTO_BOOLEAN_TRUE,
	56	CMD_AUTO_BOOLEAN_FALSE,
	57	CMD_AUTO_BOOLEAN_AUTO
	58	};
	59
	60	/* Types of "set" or "show" command. */
	61	typedef enum var_types
	62	{
	63	/* "on" or "off". *VAR is an integer which is nonzero for on,
	64	zero for off. */
65	var_boolean,
66
67	/* "on" / "true" / "enable" or "off" / "false" / "disable" or
68	"auto. *VAR is an ``enum cmd_auto_boolean''. NOTE: In general
69	a custom show command will need to be implemented - one that
70	for "auto" prints both the "auto" and the current auto-selected
71	value. */
72	var_auto_boolean,
73
74	/* Unsigned Integer. *VAR is an unsigned int. The user can type 0
75	to mean "unlimited", which is stored in VAR as UINT_MAX. /
76	var_uinteger,
77
78	/* Like var_uinteger but signed. *VAR is an int. The user can type 0
79	to mean "unlimited", which is stored in VAR as INT_MAX. /
80	var_integer,
81
82	/* String which the user enters with escapes (e.g. the user types \n and
83	it is a real newline in the stored string).
84	VAR is a malloc'd string, or NULL if the string is empty. /
85	var_string,
86	/* String which stores what the user types verbatim.
87	VAR is a malloc'd string, or NULL if the string is empty. /
88	var_string_noescape,
89	/* String which stores a filename.
90	VAR is a malloc'd string, or NULL if the string is empty. /
91	var_filename,
92	/* ZeroableInteger. *VAR is an int. Like Unsigned Integer except
93	that zero really means zero. */
94	var_zinteger,
95	/* Enumerated type. Can only have one of the specified values. *VAR is a
96	char pointer to the name of the element that we find. */
97	var_enum
98	}
99	var_types;
100
101	/* This structure records one command'd definition. */
102
103
104	/* This flag is used by the code executing commands to warn the user
105	the first time a deprecated command is used, see the 'flags' field in
106	the following struct.
107	*/
108	#define CMD_DEPRECATED 0x1
109	#define DEPRECATED_WARN_USER 0x2
110	#define MALLOCED_REPLACEMENT 0x4
111
112	struct cmd_list_element
113	{
114	/* Points to next command in this list. */
115	struct cmd_list_element *next;
116
117	/* Name of this command. */
118	char *name;
119
120	/* Command class; class values are chosen by application program. */
121	enum command_class class;
122
123	/* Function definition of this command.
124	NO_FUNCTION for command class names and for help topics that
125	are not really commands. */
126	union
127	{
128	/* If type is not_set_cmd, call it like this: */
129	void (cfunc) (char args, int from_tty);
130
131	/* If type is cmd_set or show_cmd, first set the variables, and
132	then call this. */
133	void (sfunc) (char args, int from_tty, struct cmd_list_element * c);
134	}
135	function;
136	#define NO_FUNCTION ((void () (char args, int from_tty)) 0)
137
138	/* Documentation of this command (or help topic).
139	First line is brief documentation; remaining lines form, with it,
140	the full documentation. First line should end with a period.
141	Entire string should also end with a period, not a newline. */
142	char *doc;
143
144	/* flags : a bitfield
145
146	bit 0: (LSB) CMD_DEPRECATED, when 1 indicated that this command
147	is deprecated. It may be removed from gdb's command set in the
148	future.
149
150	bit 1: DEPRECATED_WARN_USER, the user needs to be warned that
151	this is a deprecated command. The user should only be warned
152	the first time a command is used.
153
154	bit 2: MALLOCED_REPLACEMENT, when functions are deprecated at
155	compile time (this is the way it should, in general, be done)
156	the memory containing the replacement string is statically
157	allocated. In some cases it makes sense to deprecate commands
158	at runtime (the testsuite is one example). In this case the
159	memory for replacement is malloc'ed. When a command is
160	undeprecated or re-deprecated at runtime we don't want to risk
161	calling free on statically allocated memory, so we check this
162	flag.
163	*/
164	int flags;
165
166	/* if this command is deprecated, this is the replacement name */
167	char *replacement;
168
169	/* Hook for another command to be executed before this command. */
170	struct cmd_list_element *hook_pre;
171
172	/* Hook for another command to be executed after this command. */
173	struct cmd_list_element *hook_post;
174
175	/* Flag that specifies if this command is already running it's hook. */
176	/* Prevents the possibility of hook recursion. */
177	int hook_in;
178
179	/* Nonzero identifies a prefix command. For them, the address
180	of the variable containing the list of subcommands. */
181	struct cmd_list_element **prefixlist;
182
183	/* For prefix commands only:
184	String containing prefix commands to get here: this one
185	plus any others needed to get to it. Should end in a space.
186	It is used before the word "command" in describing the
187	commands reached through this prefix. */
188	char *prefixname;
189
190	/* For prefix commands only:
191	nonzero means do not get an error if subcommand is not
192	recognized; call the prefix's own function in that case. */
193	char allow_unknown;
194
195	/* Nonzero says this is an abbreviation, and should not
196	be mentioned in lists of commands.
197	This allows "br<tab>" to complete to "break", which it
198	otherwise wouldn't. */
199	char abbrev_flag;
200
201	/* Completion routine for this command. TEXT is the text beyond
202	what was matched for the command itself (leading whitespace is
203	skipped). It stops where we are supposed to stop completing
204	(rl_point) and is '\0' terminated.
205
206	Return value is a malloc'd vector of pointers to possible completions
207	terminated with NULL. If there are no completions, returning a pointer
208	to a NULL would work but returning NULL itself is also valid.
209	WORD points in the same buffer as TEXT, and completions should be
210	returned relative to this position. For example, suppose TEXT is "foo"
211	and we want to complete to "foobar". If WORD is "oo", return
212	"oobar"; if WORD is "baz/foo", return "baz/foobar". */
213	char *(completer) (char text, char word);
214
215	/* Type of "set" or "show" command (or SET_NOT_SET if not "set"
216	or "show"). */
217	cmd_types type;
218
219	/* Pointer to variable affected by "set" and "show". Doesn't matter
220	if type is not_set. */
221	void *var;
222
223	/* What kind of variable is VAR? /
224	var_types var_type;
225
226	/* Pointer to NULL terminated list of enumerated values (like argv). */
227	const char **enums;
228
229	/* Pointer to command strings of user-defined commands */
230	struct command_line *user_commands;
231
232	/* Pointer to command that is hooked by this one, (by hook_pre)
233	so the hook can be removed when this one is deleted. */
234	struct cmd_list_element *hookee_pre;
235
236	/* Pointer to command that is hooked by this one, (by hook_post)
237	so the hook can be removed when this one is deleted. */
238	struct cmd_list_element *hookee_post;
239
240	/* Pointer to command that is aliased by this one, so the
241	aliased command can be located in case it has been hooked. */
242	struct cmd_list_element *cmd_pointer;
243	};
244
245	/* API to the manipulation of command lists. */
246
247	extern struct cmd_list_element add_cmd (char , enum command_class,
248	void (fun) (char , int), char *,
249	struct cmd_list_element **);
250
251	extern struct cmd_list_element add_alias_cmd (char , char *,
252	enum command_class, int,
253	struct cmd_list_element **);
254
255	extern struct cmd_list_element add_prefix_cmd (char , enum command_class,
256	void (fun) (char , int),
257	char *,
258	struct cmd_list_element **,
259	char *, int,
260	struct cmd_list_element **);
261
262	extern struct cmd_list_element add_abbrev_prefix_cmd (char ,
263	enum command_class,
264	void (fun) (char ,
265	int),
266	char *,
267	struct cmd_list_element
268	*, char , int,
269	struct cmd_list_element
270	**);
271
272	extern struct cmd_list_element lookup_cmd (char *,
273	struct cmd_list_element , char ,
274	int, int);
275
276	extern struct cmd_list_element lookup_cmd_1 (char *,
277	struct cmd_list_element *,
278	struct cmd_list_element **,
279	int);
280
281	extern struct cmd_list_element *
282	deprecate_cmd (struct cmd_list_element , char );
283
284	extern void
285	deprecated_cmd_warning (char **);
286
287	extern int
288	lookup_cmd_composition (char *text,
289	struct cmd_list_element **alias,
290	struct cmd_list_element **prefix_cmd,
291	struct cmd_list_element **cmd);
292
293	extern struct cmd_list_element add_com (char , enum command_class,
294	void (fun) (char , int), char *);
295
296	extern struct cmd_list_element add_com_alias (char , char *,
297	enum command_class, int);
298
299	extern struct cmd_list_element add_info (char , void (fun) (char , int),
300	char *);
301
302	extern struct cmd_list_element add_info_alias (char , char *, int);
303
304	extern char *complete_on_cmdlist (struct cmd_list_element , char , char );
305
306	extern char *complete_on_enum (const char enumlist[], char , char );
307
308	extern void delete_cmd (char , struct cmd_list_element *);
309
310	extern void help_cmd_list (struct cmd_list_element *, enum command_class,
311	char , int, struct ui_file );
312
313	extern struct cmd_list_element add_set_cmd (char name, enum
314	command_class class,
315	var_types var_type, void *var,
316	char *doc,
317	struct cmd_list_element **list);
318
319	extern struct cmd_list_element add_set_enum_cmd (char name,
320	enum command_class class,
321	const char *enumlist[],
322	const char **var,
323	char *doc,
324	struct cmd_list_element **list);
325
326	extern struct cmd_list_element add_set_auto_boolean_cmd (char name,
327	enum command_class class,
328	enum cmd_auto_boolean *var,
329	char *doc,
330	struct cmd_list_element **list);
331
332	extern struct cmd_list_element add_show_from_set (struct cmd_list_element ,
333	struct cmd_list_element
334	**);
335
336	/* Functions that implement commands about CLI commands. */
337
338	extern void help_cmd (char , struct ui_file );
339
340	extern void help_list (struct cmd_list_element , char ,
341	enum command_class, struct ui_file *);
342
343	extern void apropos_cmd (struct ui_file , struct cmd_list_element ,
344	struct re_pattern_buffer , char );
345
346	/* Used to mark commands that don't do anything. If we just leave the
347	function field NULL, the command is interpreted as a help topic, or
348	as a class of commands. */
349
350	extern void not_just_help_class_command (char *arg, int from_tty);
351
352	/* Exported to cli/cli-setshow.c */
353
354	extern void print_doc_line (struct ui_file , char );
355
356
357	#endif /* !defined (CLI_DECODE_H) */