1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
|
/* Header file for command creation.
Copyright (C) 1986-2020 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 (COMMAND_H)
#define COMMAND_H 1
#include "gdbsupport/gdb_vecs.h"
#include "gdbsupport/scoped_restore.h"
struct completion_tracker;
/* This file defines the public interface for any code wanting to
create commands. */
/* Command classes are top-level categories into which commands are
broken down for "help" purposes.
The class_alias is used for the user-defined aliases, defined
using the "alias" command.
Aliases pre-defined by GDB (e.g. the alias "bt" of the "backtrace" command)
are not using the class_alias.
Different pre-defined aliases of the same command do not necessarily
have the same classes. For example, class_stack is used for the
"backtrace" and its "bt" alias", while "info stack" (also an alias
of "backtrace" uses class_info. */
enum command_class
{
/* Classes of commands followed by a comment giving the name
to use in "help <classname>".
Note that help accepts unambiguous abbreviated class names. */
/* Special classes to help_list */
class_deprecated = -3,
all_classes = -2, /* help without <classname> */
all_commands = -1, /* all */
/* Classes of commands */
no_class = -1,
class_run = 0, /* running */
class_vars, /* data */
class_stack, /* stack */
class_files, /* files */
class_support, /* support */
class_info, /* status */
class_breakpoint, /* breakpoints */
class_trace, /* tracepoints */
class_alias, /* aliases */
class_bookmark,
class_obscure, /* obscure */
class_maintenance, /* internals */
class_tui, /* text-user-interface */
class_user, /* user-defined */
/* Used for "show" commands that have no corresponding "set" command. */
no_set_class
};
/* 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;
/* Types of "set" or "show" command. */
typedef enum var_types
{
/* "on" or "off". *VAR is a bool which is true for on,
false for off. */
var_boolean,
/* "on" / "true" / "enable" or "off" / "false" / "disable" or
"auto. *VAR is an ``enum 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. The only remaining use of it is the Python API.
Don't use it elsewhere. */
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 "" if the string was empty. */
var_optional_filename,
/* String which stores a filename. (*VAR) is a malloc'd
string. */
var_filename,
/* ZeroableInteger. *VAR is an int. Like var_integer except
that zero really means zero. */
var_zinteger,
/* ZeroableUnsignedInteger. *VAR is an unsigned int. Zero really
means zero. */
var_zuinteger,
/* ZeroableUnsignedInteger with unlimited value. *VAR is an int,
but its range is [0, INT_MAX]. -1 stands for unlimited and
other negative numbers are not allowed. */
var_zuinteger_unlimited,
/* Enumerated type. Can only have one of the specified values.
*VAR is a char pointer to the name of the element that we
find. */
var_enum
}
var_types;
/* This structure records one command'd definition. */
struct cmd_list_element;
typedef void cmd_const_cfunc_ftype (const char *args, int from_tty);
/* This structure specifies notifications to be suppressed by a cli
command interpreter. */
struct cli_suppress_notification
{
/* Inferior, thread, frame selected notification suppressed? */
int user_selected_context;
};
extern struct cli_suppress_notification cli_suppress_notification;
/* Forward-declarations of the entry-points of cli/cli-decode.c. */
/* API to the manipulation of command lists. */
/* Return TRUE if NAME is a valid user-defined command name.
This is a stricter subset of all gdb commands,
see find_command_name_length. */
extern bool valid_user_defined_cmd_name_p (const char *name);
/* Return TRUE if C is a valid command character. */
extern bool valid_cmd_char_p (int c);
/* Const-correct variant of the above. */
extern struct cmd_list_element *add_cmd (const char *, enum command_class,
cmd_const_cfunc_ftype *fun,
const char *,
struct cmd_list_element **);
/* Like add_cmd, but no command function is specified. */
extern struct cmd_list_element *add_cmd (const char *, enum command_class,
const char *,
struct cmd_list_element **);
extern struct cmd_list_element *add_cmd_suppress_notification
(const char *name, enum command_class theclass,
cmd_const_cfunc_ftype *fun, const char *doc,
struct cmd_list_element **list,
int *suppress_notification);
extern struct cmd_list_element *add_alias_cmd (const char *, const char *,
enum command_class, int,
struct cmd_list_element **);
extern struct cmd_list_element *add_alias_cmd (const char *,
cmd_list_element *,
enum command_class, int,
struct cmd_list_element **);
extern struct cmd_list_element *add_prefix_cmd (const char *, enum command_class,
cmd_const_cfunc_ftype *fun,
const char *,
struct cmd_list_element **,
const char *, int,
struct cmd_list_element **);
/* Like add_prefix_cmd, but sets the callback to a function that
simply calls help_list. */
extern struct cmd_list_element *add_basic_prefix_cmd
(const char *, enum command_class, const char *, struct cmd_list_element **,
const char *, int, struct cmd_list_element **);
/* Like add_prefix_cmd, but useful for "show" prefixes. This sets the
callback to a function that simply calls cmd_show_list. */
extern struct cmd_list_element *add_show_prefix_cmd
(const char *, enum command_class, const char *, struct cmd_list_element **,
const char *, int, struct cmd_list_element **);
extern struct cmd_list_element *add_prefix_cmd_suppress_notification
(const char *name, enum command_class theclass,
cmd_const_cfunc_ftype *fun,
const char *doc, struct cmd_list_element **prefixlist,
const char *prefixname, int allow_unknown,
struct cmd_list_element **list,
int *suppress_notification);
extern struct cmd_list_element *add_abbrev_prefix_cmd (const char *,
enum command_class,
cmd_const_cfunc_ftype *fun,
const char *,
struct cmd_list_element
**, const char *, int,
struct cmd_list_element
**);
typedef void cmd_const_sfunc_ftype (const char *args, int from_tty,
struct cmd_list_element *c);
extern void set_cmd_sfunc (struct cmd_list_element *cmd,
cmd_const_sfunc_ftype *sfunc);
/* A completion routine. Add possible completions to tracker.
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. 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". */
typedef void completer_ftype (struct cmd_list_element *,
completion_tracker &tracker,
const char *text, const char *word);
/* Same, but for set_cmd_completer_handle_brkchars. */
typedef void completer_handle_brkchars_ftype (struct cmd_list_element *,
completion_tracker &tracker,
const char *text, const char *word);
extern void set_cmd_completer (struct cmd_list_element *, completer_ftype *);
/* Set the completer_handle_brkchars callback. */
extern void set_cmd_completer_handle_brkchars (struct cmd_list_element *,
completer_handle_brkchars_ftype *);
/* 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,
cmd_const_cfunc_ftype *cfun);
/* Each command object has a local context attached to it. */
extern void set_cmd_context (struct cmd_list_element *cmd,
void *context);
extern void *get_cmd_context (struct cmd_list_element *cmd);
/* Execute CMD's pre/post hook. Throw an error if the command fails.
If already executing this pre/post hook, or there is no pre/post
hook, the call is silently ignored. */
extern void execute_cmd_pre_hook (struct cmd_list_element *cmd);
extern void execute_cmd_post_hook (struct cmd_list_element *cmd);
/* Return the type of the command. */
extern enum cmd_types cmd_type (struct cmd_list_element *cmd);
/* Flag for an ambiguous cmd_list result. */
#define CMD_LIST_AMBIGUOUS ((struct cmd_list_element *) -1)
extern struct cmd_list_element *lookup_cmd (const char **,
struct cmd_list_element *,
const char *,
int, int);
extern struct cmd_list_element *lookup_cmd_1 (const char **,
struct cmd_list_element *,
struct cmd_list_element **,
int);
extern struct cmd_list_element *deprecate_cmd (struct cmd_list_element *,
const char * );
extern void deprecated_cmd_warning (const char *);
extern int lookup_cmd_composition (const 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 (const char *, enum command_class,
cmd_const_cfunc_ftype *fun,
const char *);
extern struct cmd_list_element *add_com_alias (const char *, const char *,
enum command_class, int);
extern struct cmd_list_element *add_com_suppress_notification
(const char *name, enum command_class theclass,
cmd_const_cfunc_ftype *fun, const char *doc,
int *supress_notification);
extern struct cmd_list_element *add_info (const char *,
cmd_const_cfunc_ftype *fun,
const char *);
extern struct cmd_list_element *add_info_alias (const char *, const char *,
int);
extern void complete_on_cmdlist (struct cmd_list_element *,
completion_tracker &tracker,
const char *, const char *, int);
extern void complete_on_enum (completion_tracker &tracker,
const char *const *enumlist,
const char *, const char *);
/* Functions that implement commands about CLI commands. */
extern void help_list (struct cmd_list_element *, const char *,
enum command_class, struct ui_file *);
/* Method for show a set/show variable's VALUE on FILE. If this
method isn't supplied deprecated_show_value_hack() is called (which
is not good). */
typedef void (show_value_ftype) (struct ui_file *file,
int from_tty,
struct cmd_list_element *cmd,
const char *value);
/* NOTE: i18n: This function is not i18n friendly. Callers should
instead print the value out directly. */
extern show_value_ftype deprecated_show_value_hack;
extern void add_setshow_enum_cmd (const char *name,
enum command_class theclass,
const char *const *enumlist,
const char **var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list,
void *context = nullptr);
extern void add_setshow_auto_boolean_cmd (const char *name,
enum command_class theclass,
enum auto_boolean *var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
extern cmd_list_element *
add_setshow_boolean_cmd (const char *name,
enum command_class theclass,
bool *var,
const char *set_doc, const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
extern void add_setshow_filename_cmd (const char *name,
enum command_class theclass,
char **var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
extern void add_setshow_string_cmd (const char *name,
enum command_class theclass,
char **var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
extern struct cmd_list_element *add_setshow_string_noescape_cmd
(const char *name,
enum command_class theclass,
char **var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
extern void add_setshow_optional_filename_cmd (const char *name,
enum command_class theclass,
char **var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
extern void add_setshow_integer_cmd (const char *name,
enum command_class theclass,
int *var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
extern void add_setshow_uinteger_cmd (const char *name,
enum command_class theclass,
unsigned int *var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
extern void add_setshow_zinteger_cmd (const char *name,
enum command_class theclass,
int *var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
extern void add_setshow_zuinteger_cmd (const char *name,
enum command_class theclass,
unsigned int *var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
extern void
add_setshow_zuinteger_unlimited_cmd (const char *name,
enum command_class theclass,
int *var,
const char *set_doc,
const char *show_doc,
const char *help_doc,
cmd_const_sfunc_ftype *set_func,
show_value_ftype *show_func,
struct cmd_list_element **set_list,
struct cmd_list_element **show_list);
/* Do a "show" command for each thing on a command list. */
extern void cmd_show_list (struct cmd_list_element *, int);
/* Used everywhere whenever at least one parameter is required and
none is specified. */
extern void error_no_arg (const char *) ATTRIBUTE_NORETURN;
/* Command line saving and repetition.
Each input line executed is saved to possibly be repeated either
when the user types an empty line, or be repeated by a command
that wants to repeat the previously executed command. The below
functions control command repetition. */
/* Commands call dont_repeat if they do not want to be repeated by null
lines or by repeat_previous (). */
extern void dont_repeat ();
/* Commands call repeat_previous if they want to repeat the previous
command. Such commands that repeat the previous command must
indicate to not repeat themselves, to avoid recursive repeat.
repeat_previous marks the current command as not repeating, and
ensures get_saved_command_line returns the previous command, so
that the currently executing command can repeat it. If there's no
previous command, throws an error. Otherwise, returns the result
of get_saved_command_line, which now points at the command to
repeat. */
extern const char *repeat_previous ();
/* Prevent dont_repeat from working, and return a cleanup that
restores the previous state. */
extern scoped_restore_tmpl<int> prevent_dont_repeat (void);
/* Set the arguments that will be passed if the current command is
repeated. Note that the passed-in string must be a constant. */
extern void set_repeat_arguments (const char *args);
/* Returns the saved command line to repeat.
When a command is being executed, this is the currently executing
command line, unless the currently executing command has called
repeat_previous (): in this case, get_saved_command_line returns
the previously saved command line. */
extern char *get_saved_command_line ();
/* Takes a copy of CMD, for possible repetition. */
extern void save_command_line (const char *cmd);
/* 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 (const char *, int);
/* Check function pointer. */
extern int cmd_func_p (struct cmd_list_element *cmd);
/* Call the command function. */
extern void cmd_func (struct cmd_list_element *cmd,
const char *args, int from_tty);
#endif /* !defined (COMMAND_H) */
|