]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gdb/cli/cli-cmds.c
Extension Language API
[thirdparty/binutils-gdb.git] / gdb / cli / cli-cmds.c
1 /* GDB CLI commands.
2
3 Copyright (C) 2000-2014 Free Software Foundation, Inc.
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19
20 #include "defs.h"
21 #include "exceptions.h"
22 #include "arch-utils.h"
23 #include "dyn-string.h"
24 #include "readline/readline.h"
25 #include "readline/tilde.h"
26 #include "completer.h"
27 #include "target.h" /* For baud_rate, remote_debug and remote_timeout. */
28 #include "gdb_wait.h" /* For shell escape implementation. */
29 #include "gdb_regex.h" /* Used by apropos_command. */
30 #include <string.h>
31 #include "gdb_vfork.h"
32 #include "linespec.h"
33 #include "expression.h"
34 #include "frame.h"
35 #include "value.h"
36 #include "language.h"
37 #include "filenames.h" /* For DOSish file names. */
38 #include "objfiles.h"
39 #include "source.h"
40 #include "disasm.h"
41 #include "tracepoint.h"
42 #include "filestuff.h"
43
44 #include "ui-out.h"
45
46 #include "top.h"
47 #include "cli/cli-decode.h"
48 #include "cli/cli-script.h"
49 #include "cli/cli-setshow.h"
50 #include "cli/cli-cmds.h"
51 #include "cli/cli-utils.h"
52
53 #include "extension.h"
54
55 #ifdef TUI
56 #include "tui/tui.h" /* For tui_active et.al. */
57 #endif
58
59 #include <fcntl.h>
60
61 /* Prototypes for local command functions */
62
63 static void complete_command (char *, int);
64
65 static void echo_command (char *, int);
66
67 static void pwd_command (char *, int);
68
69 static void show_version (char *, int);
70
71 static void help_command (char *, int);
72
73 static void show_command (char *, int);
74
75 static void info_command (char *, int);
76
77 static void show_debug (char *, int);
78
79 static void set_debug (char *, int);
80
81 static void show_user (char *, int);
82
83 static void make_command (char *, int);
84
85 static void shell_escape (char *, int);
86
87 static void edit_command (char *, int);
88
89 static void list_command (char *, int);
90
91 /* Prototypes for local utility functions */
92
93 static void ambiguous_line_spec (struct symtabs_and_lines *);
94
95 static void filter_sals (struct symtabs_and_lines *);
96
97 \f
98 /* Limit the call depth of user-defined commands */
99 unsigned int max_user_call_depth;
100
101 /* Define all cmd_list_elements. */
102
103 /* Chain containing all defined commands. */
104
105 struct cmd_list_element *cmdlist;
106
107 /* Chain containing all defined info subcommands. */
108
109 struct cmd_list_element *infolist;
110
111 /* Chain containing all defined enable subcommands. */
112
113 struct cmd_list_element *enablelist;
114
115 /* Chain containing all defined disable subcommands. */
116
117 struct cmd_list_element *disablelist;
118
119 /* Chain containing all defined stop subcommands. */
120
121 struct cmd_list_element *stoplist;
122
123 /* Chain containing all defined delete subcommands. */
124
125 struct cmd_list_element *deletelist;
126
127 /* Chain containing all defined detach subcommands. */
128
129 struct cmd_list_element *detachlist;
130
131 /* Chain containing all defined kill subcommands. */
132
133 struct cmd_list_element *killlist;
134
135 /* Chain containing all defined set subcommands */
136
137 struct cmd_list_element *setlist;
138
139 /* Chain containing all defined unset subcommands */
140
141 struct cmd_list_element *unsetlist;
142
143 /* Chain containing all defined show subcommands. */
144
145 struct cmd_list_element *showlist;
146
147 /* Chain containing all defined \"set history\". */
148
149 struct cmd_list_element *sethistlist;
150
151 /* Chain containing all defined \"show history\". */
152
153 struct cmd_list_element *showhistlist;
154
155 /* Chain containing all defined \"unset history\". */
156
157 struct cmd_list_element *unsethistlist;
158
159 /* Chain containing all defined maintenance subcommands. */
160
161 struct cmd_list_element *maintenancelist;
162
163 /* Chain containing all defined "maintenance info" subcommands. */
164
165 struct cmd_list_element *maintenanceinfolist;
166
167 /* Chain containing all defined "maintenance print" subcommands. */
168
169 struct cmd_list_element *maintenanceprintlist;
170
171 struct cmd_list_element *setprintlist;
172
173 struct cmd_list_element *showprintlist;
174
175 struct cmd_list_element *setdebuglist;
176
177 struct cmd_list_element *showdebuglist;
178
179 struct cmd_list_element *setchecklist;
180
181 struct cmd_list_element *showchecklist;
182
183 /* Command tracing state. */
184
185 int source_verbose = 0;
186 int trace_commands = 0;
187 \f
188 /* 'script-extension' option support. */
189
190 static const char script_ext_off[] = "off";
191 static const char script_ext_soft[] = "soft";
192 static const char script_ext_strict[] = "strict";
193
194 static const char *const script_ext_enums[] = {
195 script_ext_off,
196 script_ext_soft,
197 script_ext_strict,
198 NULL
199 };
200
201 static const char *script_ext_mode = script_ext_soft;
202 \f
203 /* Utility used everywhere when at least one argument is needed and
204 none is supplied. */
205
206 void
207 error_no_arg (char *why)
208 {
209 error (_("Argument required (%s)."), why);
210 }
211
212 /* The "info" command is defined as a prefix, with allow_unknown = 0.
213 Therefore, its own definition is called only for "info" with no
214 args. */
215
216 static void
217 info_command (char *arg, int from_tty)
218 {
219 printf_unfiltered (_("\"info\" must be followed by "
220 "the name of an info command.\n"));
221 help_list (infolist, "info ", -1, gdb_stdout);
222 }
223
224 /* The "show" command with no arguments shows all the settings. */
225
226 static void
227 show_command (char *arg, int from_tty)
228 {
229 cmd_show_list (showlist, from_tty, "");
230 }
231 \f
232 /* Provide documentation on command or list given by COMMAND. FROM_TTY
233 is ignored. */
234
235 static void
236 help_command (char *command, int from_tty)
237 {
238 help_cmd (command, gdb_stdout);
239 }
240 \f
241 /* The "complete" command is used by Emacs to implement completion. */
242
243 static void
244 complete_command (char *arg, int from_tty)
245 {
246 int argpoint;
247 char *point, *arg_prefix;
248 VEC (char_ptr) *completions;
249
250 dont_repeat ();
251
252 if (arg == NULL)
253 arg = "";
254 argpoint = strlen (arg);
255
256 /* complete_line assumes that its first argument is somewhere
257 within, and except for filenames at the beginning of, the word to
258 be completed. The following crude imitation of readline's
259 word-breaking tries to accomodate this. */
260 point = arg + argpoint;
261 while (point > arg)
262 {
263 if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
264 break;
265 point--;
266 }
267
268 arg_prefix = alloca (point - arg + 1);
269 memcpy (arg_prefix, arg, point - arg);
270 arg_prefix[point - arg] = 0;
271
272 completions = complete_line (point, arg, argpoint);
273
274 if (completions)
275 {
276 int ix, size = VEC_length (char_ptr, completions);
277 char *item, *prev = NULL;
278
279 qsort (VEC_address (char_ptr, completions), size,
280 sizeof (char *), compare_strings);
281
282 /* We do extra processing here since we only want to print each
283 unique item once. */
284 for (ix = 0; VEC_iterate (char_ptr, completions, ix, item); ++ix)
285 {
286 if (prev == NULL || strcmp (item, prev) != 0)
287 {
288 printf_unfiltered ("%s%s\n", arg_prefix, item);
289 xfree (prev);
290 prev = item;
291 }
292 else
293 xfree (item);
294 }
295
296 xfree (prev);
297 VEC_free (char_ptr, completions);
298 }
299 }
300
301 int
302 is_complete_command (struct cmd_list_element *c)
303 {
304 return cmd_cfunc_eq (c, complete_command);
305 }
306
307 static void
308 show_version (char *args, int from_tty)
309 {
310 print_gdb_version (gdb_stdout);
311 printf_filtered ("\n");
312 }
313
314 static void
315 show_configuration (char *args, int from_tty)
316 {
317 print_gdb_configuration (gdb_stdout);
318 }
319
320 /* Handle the quit command. */
321
322 void
323 quit_command (char *args, int from_tty)
324 {
325 if (!quit_confirm ())
326 error (_("Not confirmed."));
327
328 query_if_trace_running (from_tty);
329
330 quit_force (args, from_tty);
331 }
332
333 static void
334 pwd_command (char *args, int from_tty)
335 {
336 if (args)
337 error (_("The \"pwd\" command does not take an argument: %s"), args);
338 if (! getcwd (gdb_dirbuf, sizeof (gdb_dirbuf)))
339 error (_("Error finding name of working directory: %s"),
340 safe_strerror (errno));
341
342 if (strcmp (gdb_dirbuf, current_directory) != 0)
343 printf_unfiltered (_("Working directory %s\n (canonically %s).\n"),
344 current_directory, gdb_dirbuf);
345 else
346 printf_unfiltered (_("Working directory %s.\n"), current_directory);
347 }
348
349 void
350 cd_command (char *dir, int from_tty)
351 {
352 int len;
353 /* Found something other than leading repetitions of "/..". */
354 int found_real_path;
355 char *p;
356 struct cleanup *cleanup;
357
358 /* If the new directory is absolute, repeat is a no-op; if relative,
359 repeat might be useful but is more likely to be a mistake. */
360 dont_repeat ();
361
362 if (dir == 0)
363 dir = "~";
364
365 dir = tilde_expand (dir);
366 cleanup = make_cleanup (xfree, dir);
367
368 if (chdir (dir) < 0)
369 perror_with_name (dir);
370
371 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
372 /* There's too much mess with DOSish names like "d:", "d:.",
373 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
374 simply get the canonicalized name of the current directory. */
375 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
376 #endif
377
378 len = strlen (dir);
379 if (IS_DIR_SEPARATOR (dir[len - 1]))
380 {
381 /* Remove the trailing slash unless this is a root directory
382 (including a drive letter on non-Unix systems). */
383 if (!(len == 1) /* "/" */
384 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
385 && !(len == 3 && dir[1] == ':') /* "d:/" */
386 #endif
387 )
388 len--;
389 }
390
391 dir = savestring (dir, len);
392 if (IS_ABSOLUTE_PATH (dir))
393 current_directory = dir;
394 else
395 {
396 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
397 current_directory = concat (current_directory, dir, (char *)NULL);
398 else
399 current_directory = concat (current_directory, SLASH_STRING,
400 dir, (char *)NULL);
401 xfree (dir);
402 }
403
404 /* Now simplify any occurrences of `.' and `..' in the pathname. */
405
406 found_real_path = 0;
407 for (p = current_directory; *p;)
408 {
409 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
410 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
411 memmove (p, p + 2, strlen (p + 2) + 1);
412 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
413 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
414 {
415 if (found_real_path)
416 {
417 /* Search backwards for the directory just before the "/.."
418 and obliterate it and the "/..". */
419 char *q = p;
420
421 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
422 --q;
423
424 if (q == current_directory)
425 /* current_directory is
426 a relative pathname ("can't happen"--leave it alone). */
427 ++p;
428 else
429 {
430 memmove (q - 1, p + 3, strlen (p + 3) + 1);
431 p = q - 1;
432 }
433 }
434 else
435 /* We are dealing with leading repetitions of "/..", for
436 example "/../..", which is the Mach super-root. */
437 p += 3;
438 }
439 else
440 {
441 found_real_path = 1;
442 ++p;
443 }
444 }
445
446 forget_cached_source_info ();
447
448 if (from_tty)
449 pwd_command ((char *) 0, 1);
450
451 do_cleanups (cleanup);
452 }
453 \f
454 /* Show the current value of the 'script-extension' option. */
455
456 static void
457 show_script_ext_mode (struct ui_file *file, int from_tty,
458 struct cmd_list_element *c, const char *value)
459 {
460 fprintf_filtered (file,
461 _("Script filename extension recognition is \"%s\".\n"),
462 value);
463 }
464
465 /* Try to open SCRIPT_FILE.
466 If successful, the full path name is stored in *FULL_PATHP,
467 the stream is stored in *STREAMP, and return 1.
468 The caller is responsible for freeing *FULL_PATHP.
469 If not successful, return 0; errno is set for the last file
470 we tried to open.
471
472 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
473 search for it in the source search path. */
474
475 int
476 find_and_open_script (const char *script_file, int search_path,
477 FILE **streamp, char **full_pathp)
478 {
479 char *file;
480 int fd;
481 struct cleanup *old_cleanups;
482 int search_flags = OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH;
483
484 file = tilde_expand (script_file);
485 old_cleanups = make_cleanup (xfree, file);
486
487 if (search_path)
488 search_flags |= OPF_SEARCH_IN_PATH;
489
490 /* Search for and open 'file' on the search path used for source
491 files. Put the full location in *FULL_PATHP. */
492 fd = openp (source_path, search_flags,
493 file, O_RDONLY, full_pathp);
494
495 if (fd == -1)
496 {
497 int save_errno = errno;
498 do_cleanups (old_cleanups);
499 errno = save_errno;
500 return 0;
501 }
502
503 do_cleanups (old_cleanups);
504
505 *streamp = fdopen (fd, FOPEN_RT);
506 if (*streamp == NULL)
507 {
508 int save_errno = errno;
509
510 close (fd);
511 if (full_pathp)
512 xfree (*full_pathp);
513 errno = save_errno;
514 return 0;
515 }
516
517 return 1;
518 }
519
520 /* Load script FILE, which has already been opened as STREAM. */
521
522 static void
523 source_script_from_stream (FILE *stream, const char *file)
524 {
525 if (script_ext_mode != script_ext_off)
526 {
527 const struct extension_language_defn *extlang
528 = get_ext_lang_of_file (file);
529
530 if (extlang != NULL)
531 {
532 if (ext_lang_present_p (extlang))
533 {
534 script_sourcer_func *sourcer
535 = ext_lang_script_sourcer (extlang);
536
537 gdb_assert (sourcer != NULL);
538 sourcer (extlang, stream, file);
539 return;
540 }
541 else if (script_ext_mode == script_ext_soft)
542 {
543 /* Assume the file is a gdb script.
544 This is handled below. */
545 }
546 else
547 throw_ext_lang_unsupported (extlang);
548 }
549 }
550
551 script_from_file (stream, file);
552 }
553
554 /* Worker to perform the "source" command.
555 Load script FILE.
556 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
557 search for it in the source search path. */
558
559 static void
560 source_script_with_search (const char *file, int from_tty, int search_path)
561 {
562 FILE *stream;
563 char *full_path;
564 struct cleanup *old_cleanups;
565
566 if (file == NULL || *file == 0)
567 error (_("source command requires file name of file to source."));
568
569 if (!find_and_open_script (file, search_path, &stream, &full_path))
570 {
571 /* The script wasn't found, or was otherwise inaccessible.
572 If the source command was invoked interactively, throw an
573 error. Otherwise (e.g. if it was invoked by a script),
574 just emit a warning, rather than cause an error. */
575 if (from_tty)
576 perror_with_name (file);
577 else
578 {
579 perror_warning_with_name (file);
580 return;
581 }
582 }
583
584 old_cleanups = make_cleanup (xfree, full_path);
585 make_cleanup_fclose (stream);
586 /* The python support reopens the file, so we need to pass full_path here
587 in case the file was found on the search path. It's useful to do this
588 anyway so that error messages show the actual file used. But only do
589 this if we (may have) used search_path, as printing the full path in
590 errors for the non-search case can be more noise than signal. */
591 source_script_from_stream (stream, search_path ? full_path : file);
592 do_cleanups (old_cleanups);
593 }
594
595 /* Wrapper around source_script_with_search to export it to main.c
596 for use in loading .gdbinit scripts. */
597
598 void
599 source_script (const char *file, int from_tty)
600 {
601 source_script_with_search (file, from_tty, 0);
602 }
603
604 /* Return the source_verbose global variable to its previous state
605 on exit from the source command, by whatever means. */
606 static void
607 source_verbose_cleanup (void *old_value)
608 {
609 source_verbose = *(int *)old_value;
610 xfree (old_value);
611 }
612
613 static void
614 source_command (char *args, int from_tty)
615 {
616 struct cleanup *old_cleanups;
617 char *file = args;
618 int *old_source_verbose = xmalloc (sizeof(int));
619 int search_path = 0;
620
621 *old_source_verbose = source_verbose;
622 old_cleanups = make_cleanup (source_verbose_cleanup,
623 old_source_verbose);
624
625 /* -v causes the source command to run in verbose mode.
626 -s causes the file to be searched in the source search path,
627 even if the file name contains a '/'.
628 We still have to be able to handle filenames with spaces in a
629 backward compatible way, so buildargv is not appropriate. */
630
631 if (args)
632 {
633 while (args[0] != '\0')
634 {
635 /* Make sure leading white space does not break the
636 comparisons. */
637 args = skip_spaces (args);
638
639 if (args[0] != '-')
640 break;
641
642 if (args[1] == 'v' && isspace (args[2]))
643 {
644 source_verbose = 1;
645
646 /* Skip passed -v. */
647 args = &args[3];
648 }
649 else if (args[1] == 's' && isspace (args[2]))
650 {
651 search_path = 1;
652
653 /* Skip passed -s. */
654 args = &args[3];
655 }
656 else
657 break;
658 }
659
660 file = skip_spaces (args);
661 }
662
663 source_script_with_search (file, from_tty, search_path);
664
665 do_cleanups (old_cleanups);
666 }
667
668
669 static void
670 echo_command (char *text, int from_tty)
671 {
672 const char *p = text;
673 int c;
674
675 if (text)
676 while ((c = *p++) != '\0')
677 {
678 if (c == '\\')
679 {
680 /* \ at end of argument is used after spaces
681 so they won't be lost. */
682 if (*p == 0)
683 return;
684
685 c = parse_escape (get_current_arch (), &p);
686 if (c >= 0)
687 printf_filtered ("%c", c);
688 }
689 else
690 printf_filtered ("%c", c);
691 }
692
693 /* Force this output to appear now. */
694 wrap_here ("");
695 gdb_flush (gdb_stdout);
696 }
697
698 static void
699 shell_escape (char *arg, int from_tty)
700 {
701 #if defined(CANT_FORK) || \
702 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
703 /* If ARG is NULL, they want an inferior shell, but `system' just
704 reports if the shell is available when passed a NULL arg. */
705 int rc = system (arg ? arg : "");
706
707 if (!arg)
708 arg = "inferior shell";
709
710 if (rc == -1)
711 {
712 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
713 safe_strerror (errno));
714 gdb_flush (gdb_stderr);
715 }
716 else if (rc)
717 {
718 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
719 gdb_flush (gdb_stderr);
720 }
721 #ifdef GLOBAL_CURDIR
722 /* Make sure to return to the directory GDB thinks it is, in case
723 the shell command we just ran changed it. */
724 chdir (current_directory);
725 #endif
726 #else /* Can fork. */
727 int status, pid;
728
729 if ((pid = vfork ()) == 0)
730 {
731 const char *p, *user_shell;
732
733 close_most_fds ();
734
735 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
736 user_shell = "/bin/sh";
737
738 /* Get the name of the shell for arg0. */
739 p = lbasename (user_shell);
740
741 if (!arg)
742 execl (user_shell, p, (char *) 0);
743 else
744 execl (user_shell, p, "-c", arg, (char *) 0);
745
746 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
747 safe_strerror (errno));
748 gdb_flush (gdb_stderr);
749 _exit (0177);
750 }
751
752 if (pid != -1)
753 waitpid (pid, &status, 0);
754 else
755 error (_("Fork failed"));
756 #endif /* Can fork. */
757 }
758
759 static void
760 edit_command (char *arg, int from_tty)
761 {
762 struct symtabs_and_lines sals;
763 struct symtab_and_line sal;
764 struct symbol *sym;
765 char *arg1;
766 char *editor;
767 char *p;
768 const char *fn;
769
770 /* Pull in the current default source line if necessary. */
771 if (arg == 0)
772 {
773 set_default_source_symtab_and_line ();
774 sal = get_current_source_symtab_and_line ();
775 }
776
777 /* Bare "edit" edits file with present line. */
778
779 if (arg == 0)
780 {
781 if (sal.symtab == 0)
782 error (_("No default source file yet."));
783 sal.line += get_lines_to_list () / 2;
784 }
785 else
786 {
787 /* Now should only be one argument -- decode it in SAL. */
788
789 arg1 = arg;
790 sals = decode_line_1 (&arg1, DECODE_LINE_LIST_MODE, 0, 0);
791
792 filter_sals (&sals);
793 if (! sals.nelts)
794 {
795 /* C++ */
796 return;
797 }
798 if (sals.nelts > 1)
799 {
800 ambiguous_line_spec (&sals);
801 xfree (sals.sals);
802 return;
803 }
804
805 sal = sals.sals[0];
806 xfree (sals.sals);
807
808 if (*arg1)
809 error (_("Junk at end of line specification."));
810
811 /* If line was specified by address, first print exactly which
812 line, and which file. In this case, sal.symtab == 0 means
813 address is outside of all known source files, not that user
814 failed to give a filename. */
815 if (*arg == '*')
816 {
817 struct gdbarch *gdbarch;
818
819 if (sal.symtab == 0)
820 error (_("No source file for address %s."),
821 paddress (get_current_arch (), sal.pc));
822
823 gdbarch = get_objfile_arch (sal.symtab->objfile);
824 sym = find_pc_function (sal.pc);
825 if (sym)
826 printf_filtered ("%s is in %s (%s:%d).\n",
827 paddress (gdbarch, sal.pc),
828 SYMBOL_PRINT_NAME (sym),
829 symtab_to_filename_for_display (sal.symtab),
830 sal.line);
831 else
832 printf_filtered ("%s is at %s:%d.\n",
833 paddress (gdbarch, sal.pc),
834 symtab_to_filename_for_display (sal.symtab),
835 sal.line);
836 }
837
838 /* If what was given does not imply a symtab, it must be an
839 undebuggable symbol which means no source code. */
840
841 if (sal.symtab == 0)
842 error (_("No line number known for %s."), arg);
843 }
844
845 if ((editor = (char *) getenv ("EDITOR")) == NULL)
846 editor = "/bin/ex";
847
848 fn = symtab_to_fullname (sal.symtab);
849
850 /* Quote the file name, in case it has whitespace or other special
851 characters. */
852 p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
853 shell_escape (p, from_tty);
854 xfree (p);
855 }
856
857 static void
858 list_command (char *arg, int from_tty)
859 {
860 struct symtabs_and_lines sals, sals_end;
861 struct symtab_and_line sal = { 0 };
862 struct symtab_and_line sal_end = { 0 };
863 struct symtab_and_line cursal = { 0 };
864 struct symbol *sym;
865 char *arg1;
866 int no_end = 1;
867 int dummy_end = 0;
868 int dummy_beg = 0;
869 int linenum_beg = 0;
870 char *p;
871
872 /* Pull in the current default source line if necessary. */
873 if (arg == 0 || arg[0] == '+' || arg[0] == '-')
874 {
875 set_default_source_symtab_and_line ();
876 cursal = get_current_source_symtab_and_line ();
877 }
878
879 /* "l" or "l +" lists next ten lines. */
880
881 if (arg == 0 || strcmp (arg, "+") == 0)
882 {
883 print_source_lines (cursal.symtab, cursal.line,
884 cursal.line + get_lines_to_list (), 0);
885 return;
886 }
887
888 /* "l -" lists previous ten lines, the ones before the ten just
889 listed. */
890 if (strcmp (arg, "-") == 0)
891 {
892 print_source_lines (cursal.symtab,
893 max (get_first_line_listed ()
894 - get_lines_to_list (), 1),
895 get_first_line_listed (), 0);
896 return;
897 }
898
899 /* Now if there is only one argument, decode it in SAL
900 and set NO_END.
901 If there are two arguments, decode them in SAL and SAL_END
902 and clear NO_END; however, if one of the arguments is blank,
903 set DUMMY_BEG or DUMMY_END to record that fact. */
904
905 if (!have_full_symbols () && !have_partial_symbols ())
906 error (_("No symbol table is loaded. Use the \"file\" command."));
907
908 arg1 = arg;
909 if (*arg1 == ',')
910 dummy_beg = 1;
911 else
912 {
913 sals = decode_line_1 (&arg1, DECODE_LINE_LIST_MODE, 0, 0);
914
915 filter_sals (&sals);
916 if (!sals.nelts)
917 return; /* C++ */
918 if (sals.nelts > 1)
919 {
920 ambiguous_line_spec (&sals);
921 xfree (sals.sals);
922 return;
923 }
924
925 sal = sals.sals[0];
926 xfree (sals.sals);
927 }
928
929 /* Record whether the BEG arg is all digits. */
930
931 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
932 linenum_beg = (p == arg1);
933
934 while (*arg1 == ' ' || *arg1 == '\t')
935 arg1++;
936 if (*arg1 == ',')
937 {
938 no_end = 0;
939 arg1++;
940 while (*arg1 == ' ' || *arg1 == '\t')
941 arg1++;
942 if (*arg1 == 0)
943 dummy_end = 1;
944 else
945 {
946 if (dummy_beg)
947 sals_end = decode_line_1 (&arg1, DECODE_LINE_LIST_MODE, 0, 0);
948 else
949 sals_end = decode_line_1 (&arg1, DECODE_LINE_LIST_MODE,
950 sal.symtab, sal.line);
951 filter_sals (&sals_end);
952 if (sals_end.nelts == 0)
953 return;
954 if (sals_end.nelts > 1)
955 {
956 ambiguous_line_spec (&sals_end);
957 xfree (sals_end.sals);
958 return;
959 }
960 sal_end = sals_end.sals[0];
961 xfree (sals_end.sals);
962 }
963 }
964
965 if (*arg1)
966 error (_("Junk at end of line specification."));
967
968 if (!no_end && !dummy_beg && !dummy_end
969 && sal.symtab != sal_end.symtab)
970 error (_("Specified start and end are in different files."));
971 if (dummy_beg && dummy_end)
972 error (_("Two empty args do not say what lines to list."));
973
974 /* If line was specified by address,
975 first print exactly which line, and which file.
976
977 In this case, sal.symtab == 0 means address is outside of all
978 known source files, not that user failed to give a filename. */
979 if (*arg == '*')
980 {
981 struct gdbarch *gdbarch;
982
983 if (sal.symtab == 0)
984 error (_("No source file for address %s."),
985 paddress (get_current_arch (), sal.pc));
986
987 gdbarch = get_objfile_arch (sal.symtab->objfile);
988 sym = find_pc_function (sal.pc);
989 if (sym)
990 printf_filtered ("%s is in %s (%s:%d).\n",
991 paddress (gdbarch, sal.pc),
992 SYMBOL_PRINT_NAME (sym),
993 symtab_to_filename_for_display (sal.symtab), sal.line);
994 else
995 printf_filtered ("%s is at %s:%d.\n",
996 paddress (gdbarch, sal.pc),
997 symtab_to_filename_for_display (sal.symtab), sal.line);
998 }
999
1000 /* If line was not specified by just a line number, and it does not
1001 imply a symtab, it must be an undebuggable symbol which means no
1002 source code. */
1003
1004 if (!linenum_beg && sal.symtab == 0)
1005 error (_("No line number known for %s."), arg);
1006
1007 /* If this command is repeated with RET,
1008 turn it into the no-arg variant. */
1009
1010 if (from_tty)
1011 *arg = 0;
1012
1013 if (dummy_beg && sal_end.symtab == 0)
1014 error (_("No default source file yet. Do \"help list\"."));
1015 if (dummy_beg)
1016 print_source_lines (sal_end.symtab,
1017 max (sal_end.line - (get_lines_to_list () - 1), 1),
1018 sal_end.line + 1, 0);
1019 else if (sal.symtab == 0)
1020 error (_("No default source file yet. Do \"help list\"."));
1021 else if (no_end)
1022 {
1023 int first_line = sal.line - get_lines_to_list () / 2;
1024
1025 if (first_line < 1) first_line = 1;
1026
1027 print_source_lines (sal.symtab,
1028 first_line,
1029 first_line + get_lines_to_list (),
1030 0);
1031 }
1032 else
1033 print_source_lines (sal.symtab, sal.line,
1034 (dummy_end
1035 ? sal.line + get_lines_to_list ()
1036 : sal_end.line + 1),
1037 0);
1038 }
1039
1040 /* Subroutine of disassemble_command to simplify it.
1041 Perform the disassembly.
1042 NAME is the name of the function if known, or NULL.
1043 [LOW,HIGH) are the range of addresses to disassemble.
1044 MIXED is non-zero to print source with the assembler. */
1045
1046 static void
1047 print_disassembly (struct gdbarch *gdbarch, const char *name,
1048 CORE_ADDR low, CORE_ADDR high, int flags)
1049 {
1050 #if defined(TUI)
1051 if (!tui_is_window_visible (DISASSEM_WIN))
1052 #endif
1053 {
1054 printf_filtered ("Dump of assembler code ");
1055 if (name != NULL)
1056 printf_filtered ("for function %s:\n", name);
1057 else
1058 printf_filtered ("from %s to %s:\n",
1059 paddress (gdbarch, low), paddress (gdbarch, high));
1060
1061 /* Dump the specified range. */
1062 gdb_disassembly (gdbarch, current_uiout, 0, flags, -1, low, high);
1063
1064 printf_filtered ("End of assembler dump.\n");
1065 gdb_flush (gdb_stdout);
1066 }
1067 #if defined(TUI)
1068 else
1069 {
1070 tui_show_assembly (gdbarch, low);
1071 }
1072 #endif
1073 }
1074
1075 /* Subroutine of disassemble_command to simplify it.
1076 Print a disassembly of the current function according to FLAGS. */
1077
1078 static void
1079 disassemble_current_function (int flags)
1080 {
1081 struct frame_info *frame;
1082 struct gdbarch *gdbarch;
1083 CORE_ADDR low, high, pc;
1084 const char *name;
1085
1086 frame = get_selected_frame (_("No frame selected."));
1087 gdbarch = get_frame_arch (frame);
1088 pc = get_frame_address_in_block (frame);
1089 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1090 error (_("No function contains program counter for selected frame."));
1091 #if defined(TUI)
1092 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1093 `tui_version'. */
1094 if (tui_active)
1095 /* FIXME: cagney/2004-02-07: This should be an observer. */
1096 low = tui_get_low_disassembly_address (gdbarch, low, pc);
1097 #endif
1098 low += gdbarch_deprecated_function_start_offset (gdbarch);
1099
1100 print_disassembly (gdbarch, name, low, high, flags);
1101 }
1102
1103 /* Dump a specified section of assembly code.
1104
1105 Usage:
1106 disassemble [/mr]
1107 - dump the assembly code for the function of the current pc
1108 disassemble [/mr] addr
1109 - dump the assembly code for the function at ADDR
1110 disassemble [/mr] low,high
1111 disassemble [/mr] low,+length
1112 - dump the assembly code in the range [LOW,HIGH), or [LOW,LOW+length)
1113
1114 A /m modifier will include source code with the assembly.
1115 A /r modifier will include raw instructions in hex with the assembly. */
1116
1117 static void
1118 disassemble_command (char *arg, int from_tty)
1119 {
1120 struct gdbarch *gdbarch = get_current_arch ();
1121 CORE_ADDR low, high;
1122 const char *name;
1123 CORE_ADDR pc;
1124 int flags;
1125 const char *p;
1126
1127 p = arg;
1128 name = NULL;
1129 flags = 0;
1130
1131 if (p && *p == '/')
1132 {
1133 ++p;
1134
1135 if (*p == '\0')
1136 error (_("Missing modifier."));
1137
1138 while (*p && ! isspace (*p))
1139 {
1140 switch (*p++)
1141 {
1142 case 'm':
1143 flags |= DISASSEMBLY_SOURCE;
1144 break;
1145 case 'r':
1146 flags |= DISASSEMBLY_RAW_INSN;
1147 break;
1148 default:
1149 error (_("Invalid disassembly modifier."));
1150 }
1151 }
1152
1153 p = skip_spaces_const (p);
1154 }
1155
1156 if (! p || ! *p)
1157 {
1158 flags |= DISASSEMBLY_OMIT_FNAME;
1159 disassemble_current_function (flags);
1160 return;
1161 }
1162
1163 pc = value_as_address (parse_to_comma_and_eval (&p));
1164 if (p[0] == ',')
1165 ++p;
1166 if (p[0] == '\0')
1167 {
1168 /* One argument. */
1169 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
1170 error (_("No function contains specified address."));
1171 #if defined(TUI)
1172 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1173 `tui_version'. */
1174 if (tui_active)
1175 /* FIXME: cagney/2004-02-07: This should be an observer. */
1176 low = tui_get_low_disassembly_address (gdbarch, low, pc);
1177 #endif
1178 low += gdbarch_deprecated_function_start_offset (gdbarch);
1179 flags |= DISASSEMBLY_OMIT_FNAME;
1180 }
1181 else
1182 {
1183 /* Two arguments. */
1184 int incl_flag = 0;
1185 low = pc;
1186 p = skip_spaces_const (p);
1187 if (p[0] == '+')
1188 {
1189 ++p;
1190 incl_flag = 1;
1191 }
1192 high = parse_and_eval_address (p);
1193 if (incl_flag)
1194 high += low;
1195 }
1196
1197 print_disassembly (gdbarch, name, low, high, flags);
1198 }
1199
1200 static void
1201 make_command (char *arg, int from_tty)
1202 {
1203 char *p;
1204
1205 if (arg == 0)
1206 p = "make";
1207 else
1208 {
1209 p = xmalloc (sizeof ("make ") + strlen (arg));
1210 strcpy (p, "make ");
1211 strcpy (p + sizeof ("make ") - 1, arg);
1212 }
1213
1214 shell_escape (p, from_tty);
1215 }
1216
1217 static void
1218 show_user (char *args, int from_tty)
1219 {
1220 struct cmd_list_element *c;
1221 extern struct cmd_list_element *cmdlist;
1222
1223 if (args)
1224 {
1225 const char *comname = args;
1226
1227 c = lookup_cmd (&comname, cmdlist, "", 0, 1);
1228 /* c->user_commands would be NULL if it's a python command. */
1229 if (c->class != class_user || !c->user_commands)
1230 error (_("Not a user command."));
1231 show_user_1 (c, "", args, gdb_stdout);
1232 }
1233 else
1234 {
1235 for (c = cmdlist; c; c = c->next)
1236 {
1237 if (c->class == class_user || c->prefixlist != NULL)
1238 show_user_1 (c, "", c->name, gdb_stdout);
1239 }
1240 }
1241 }
1242
1243 /* Search through names of commands and documentations for a certain
1244 regular expression. */
1245
1246 static void
1247 apropos_command (char *searchstr, int from_tty)
1248 {
1249 regex_t pattern;
1250 int code;
1251
1252 if (searchstr == NULL)
1253 error (_("REGEXP string is empty"));
1254
1255 code = regcomp (&pattern, searchstr, REG_ICASE);
1256 if (code == 0)
1257 {
1258 struct cleanup *cleanups;
1259
1260 cleanups = make_regfree_cleanup (&pattern);
1261 apropos_cmd (gdb_stdout, cmdlist, &pattern, "");
1262 do_cleanups (cleanups);
1263 }
1264 else
1265 {
1266 char *err = get_regcomp_error (code, &pattern);
1267
1268 make_cleanup (xfree, err);
1269 error (_("Error in regular expression: %s"), err);
1270 }
1271 }
1272
1273 /* Subroutine of alias_command to simplify it.
1274 Return the first N elements of ARGV flattened back to a string
1275 with a space separating each element.
1276 ARGV may not be NULL.
1277 This does not take care of quoting elements in case they contain spaces
1278 on purpose. */
1279
1280 static dyn_string_t
1281 argv_to_dyn_string (char **argv, int n)
1282 {
1283 int i;
1284 dyn_string_t result = dyn_string_new (10);
1285
1286 gdb_assert (argv != NULL);
1287 gdb_assert (n >= 0 && n <= countargv (argv));
1288
1289 for (i = 0; i < n; ++i)
1290 {
1291 if (i > 0)
1292 dyn_string_append_char (result, ' ');
1293 dyn_string_append_cstr (result, argv[i]);
1294 }
1295
1296 return result;
1297 }
1298
1299 /* Subroutine of alias_command to simplify it.
1300 Return TRUE if COMMAND exists, unambiguously. Otherwise FALSE. */
1301
1302 static int
1303 valid_command_p (const char *command)
1304 {
1305 struct cmd_list_element *c;
1306
1307 c = lookup_cmd_1 (& command, cmdlist, NULL, 1);
1308
1309 if (c == NULL || c == (struct cmd_list_element *) -1)
1310 return FALSE;
1311
1312 /* This is the slightly tricky part.
1313 lookup_cmd_1 will return a pointer to the last part of COMMAND
1314 to match, leaving COMMAND pointing at the remainder. */
1315 while (*command == ' ' || *command == '\t')
1316 ++command;
1317 return *command == '\0';
1318 }
1319
1320 /* Make an alias of an existing command. */
1321
1322 static void
1323 alias_command (char *args, int from_tty)
1324 {
1325 int i, alias_argc, command_argc;
1326 int abbrev_flag = 0;
1327 char *args2, *equals, *alias, *command;
1328 char **alias_argv, **command_argv;
1329 dyn_string_t alias_dyn_string, command_dyn_string;
1330 struct cleanup *cleanup;
1331 static const char usage[] = N_("Usage: alias [-a] [--] ALIAS = COMMAND");
1332
1333 if (args == NULL || strchr (args, '=') == NULL)
1334 error (_(usage));
1335
1336 args2 = xstrdup (args);
1337 cleanup = make_cleanup (xfree, args2);
1338 equals = strchr (args2, '=');
1339 *equals = '\0';
1340 alias_argv = gdb_buildargv (args2);
1341 make_cleanup_freeargv (alias_argv);
1342 command_argv = gdb_buildargv (equals + 1);
1343 make_cleanup_freeargv (command_argv);
1344
1345 for (i = 0; alias_argv[i] != NULL; )
1346 {
1347 if (strcmp (alias_argv[i], "-a") == 0)
1348 {
1349 ++alias_argv;
1350 abbrev_flag = 1;
1351 }
1352 else if (strcmp (alias_argv[i], "--") == 0)
1353 {
1354 ++alias_argv;
1355 break;
1356 }
1357 else
1358 break;
1359 }
1360
1361 if (alias_argv[0] == NULL || command_argv[0] == NULL
1362 || *alias_argv[0] == '\0' || *command_argv[0] == '\0')
1363 error (_(usage));
1364
1365 for (i = 0; alias_argv[i] != NULL; ++i)
1366 {
1367 if (! valid_user_defined_cmd_name_p (alias_argv[i]))
1368 {
1369 if (i == 0)
1370 error (_("Invalid command name: %s"), alias_argv[i]);
1371 else
1372 error (_("Invalid command element name: %s"), alias_argv[i]);
1373 }
1374 }
1375
1376 alias_argc = countargv (alias_argv);
1377 command_argc = countargv (command_argv);
1378
1379 /* COMMAND must exist.
1380 Reconstruct the command to remove any extraneous spaces,
1381 for better error messages. */
1382 command_dyn_string = argv_to_dyn_string (command_argv, command_argc);
1383 make_cleanup_dyn_string_delete (command_dyn_string);
1384 command = dyn_string_buf (command_dyn_string);
1385 if (! valid_command_p (command))
1386 error (_("Invalid command to alias to: %s"), command);
1387
1388 /* ALIAS must not exist. */
1389 alias_dyn_string = argv_to_dyn_string (alias_argv, alias_argc);
1390 make_cleanup_dyn_string_delete (alias_dyn_string);
1391 alias = dyn_string_buf (alias_dyn_string);
1392 if (valid_command_p (alias))
1393 error (_("Alias already exists: %s"), alias);
1394
1395 /* If ALIAS is one word, it is an alias for the entire COMMAND.
1396 Example: alias spe = set print elements
1397
1398 Otherwise ALIAS and COMMAND must have the same number of words,
1399 and every word except the last must match; and the last word of
1400 ALIAS is made an alias of the last word of COMMAND.
1401 Example: alias set print elms = set pr elem
1402 Note that unambiguous abbreviations are allowed. */
1403
1404 if (alias_argc == 1)
1405 {
1406 /* add_cmd requires *we* allocate space for name, hence the xstrdup. */
1407 add_com_alias (xstrdup (alias_argv[0]), command, class_alias,
1408 abbrev_flag);
1409 }
1410 else
1411 {
1412 dyn_string_t alias_prefix_dyn_string, command_prefix_dyn_string;
1413 const char *alias_prefix, *command_prefix;
1414 struct cmd_list_element *c_alias, *c_command;
1415
1416 if (alias_argc != command_argc)
1417 error (_("Mismatched command length between ALIAS and COMMAND."));
1418
1419 /* Create copies of ALIAS and COMMAND without the last word,
1420 and use that to verify the leading elements match. */
1421 alias_prefix_dyn_string =
1422 argv_to_dyn_string (alias_argv, alias_argc - 1);
1423 make_cleanup_dyn_string_delete (alias_prefix_dyn_string);
1424 command_prefix_dyn_string =
1425 argv_to_dyn_string (alias_argv, command_argc - 1);
1426 make_cleanup_dyn_string_delete (command_prefix_dyn_string);
1427 alias_prefix = dyn_string_buf (alias_prefix_dyn_string);
1428 command_prefix = dyn_string_buf (command_prefix_dyn_string);
1429
1430 c_command = lookup_cmd_1 (& command_prefix, cmdlist, NULL, 1);
1431 /* We've already tried to look up COMMAND. */
1432 gdb_assert (c_command != NULL
1433 && c_command != (struct cmd_list_element *) -1);
1434 gdb_assert (c_command->prefixlist != NULL);
1435 c_alias = lookup_cmd_1 (& alias_prefix, cmdlist, NULL, 1);
1436 if (c_alias != c_command)
1437 error (_("ALIAS and COMMAND prefixes do not match."));
1438
1439 /* add_cmd requires *we* allocate space for name, hence the xstrdup. */
1440 add_alias_cmd (xstrdup (alias_argv[alias_argc - 1]),
1441 command_argv[command_argc - 1],
1442 class_alias, abbrev_flag, c_command->prefixlist);
1443 }
1444
1445 do_cleanups (cleanup);
1446 }
1447 \f
1448 /* Print a list of files and line numbers which a user may choose from
1449 in order to list a function which was specified ambiguously (as
1450 with `list classname::overloadedfuncname', for example). The
1451 vector in SALS provides the filenames and line numbers. */
1452
1453 static void
1454 ambiguous_line_spec (struct symtabs_and_lines *sals)
1455 {
1456 int i;
1457
1458 for (i = 0; i < sals->nelts; ++i)
1459 printf_filtered (_("file: \"%s\", line number: %d\n"),
1460 symtab_to_filename_for_display (sals->sals[i].symtab),
1461 sals->sals[i].line);
1462 }
1463
1464 /* Sort function for filter_sals. */
1465
1466 static int
1467 compare_symtabs (const void *a, const void *b)
1468 {
1469 const struct symtab_and_line *sala = a;
1470 const struct symtab_and_line *salb = b;
1471 int r;
1472
1473 if (!sala->symtab->dirname)
1474 {
1475 if (salb->symtab->dirname)
1476 return -1;
1477 }
1478 else if (!salb->symtab->dirname)
1479 {
1480 if (sala->symtab->dirname)
1481 return 1;
1482 }
1483 else
1484 {
1485 r = filename_cmp (sala->symtab->dirname, salb->symtab->dirname);
1486 if (r)
1487 return r;
1488 }
1489
1490 r = filename_cmp (sala->symtab->filename, salb->symtab->filename);
1491 if (r)
1492 return r;
1493
1494 if (sala->line < salb->line)
1495 return -1;
1496 return sala->line == salb->line ? 0 : 1;
1497 }
1498
1499 /* Remove any SALs that do not match the current program space, or
1500 which appear to be "file:line" duplicates. */
1501
1502 static void
1503 filter_sals (struct symtabs_and_lines *sals)
1504 {
1505 int i, out, prev;
1506
1507 out = 0;
1508 for (i = 0; i < sals->nelts; ++i)
1509 {
1510 if (sals->sals[i].pspace == current_program_space
1511 && sals->sals[i].symtab != NULL)
1512 {
1513 sals->sals[out] = sals->sals[i];
1514 ++out;
1515 }
1516 }
1517 sals->nelts = out;
1518
1519 qsort (sals->sals, sals->nelts, sizeof (struct symtab_and_line),
1520 compare_symtabs);
1521
1522 out = 1;
1523 prev = 0;
1524 for (i = 1; i < sals->nelts; ++i)
1525 {
1526 if (compare_symtabs (&sals->sals[prev], &sals->sals[i]))
1527 {
1528 /* Symtabs differ. */
1529 sals->sals[out] = sals->sals[i];
1530 prev = out;
1531 ++out;
1532 }
1533 }
1534
1535 if (sals->nelts == 0)
1536 {
1537 xfree (sals->sals);
1538 sals->sals = NULL;
1539 }
1540 else
1541 sals->nelts = out;
1542 }
1543
1544 static void
1545 set_debug (char *arg, int from_tty)
1546 {
1547 printf_unfiltered (_("\"set debug\" must be followed by "
1548 "the name of a debug subcommand.\n"));
1549 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1550 }
1551
1552 static void
1553 show_debug (char *args, int from_tty)
1554 {
1555 cmd_show_list (showdebuglist, from_tty, "");
1556 }
1557
1558 void
1559 init_cmd_lists (void)
1560 {
1561 max_user_call_depth = 1024;
1562 }
1563
1564 static void
1565 show_info_verbose (struct ui_file *file, int from_tty,
1566 struct cmd_list_element *c,
1567 const char *value)
1568 {
1569 if (info_verbose)
1570 fprintf_filtered (file,
1571 _("Verbose printing of informational messages is %s.\n"),
1572 value);
1573 else
1574 fprintf_filtered (file, _("Verbosity is %s.\n"), value);
1575 }
1576
1577 static void
1578 show_history_expansion_p (struct ui_file *file, int from_tty,
1579 struct cmd_list_element *c, const char *value)
1580 {
1581 fprintf_filtered (file, _("History expansion on command input is %s.\n"),
1582 value);
1583 }
1584
1585 static void
1586 show_remote_debug (struct ui_file *file, int from_tty,
1587 struct cmd_list_element *c, const char *value)
1588 {
1589 fprintf_filtered (file, _("Debugging of remote protocol is %s.\n"),
1590 value);
1591 }
1592
1593 static void
1594 show_remote_timeout (struct ui_file *file, int from_tty,
1595 struct cmd_list_element *c, const char *value)
1596 {
1597 fprintf_filtered (file,
1598 _("Timeout limit to wait for target to respond is %s.\n"),
1599 value);
1600 }
1601
1602 static void
1603 show_max_user_call_depth (struct ui_file *file, int from_tty,
1604 struct cmd_list_element *c, const char *value)
1605 {
1606 fprintf_filtered (file,
1607 _("The max call depth for user-defined commands is %s.\n"),
1608 value);
1609 }
1610
1611 \f
1612
1613 initialize_file_ftype _initialize_cli_cmds;
1614
1615 void
1616 _initialize_cli_cmds (void)
1617 {
1618 struct cmd_list_element *c;
1619
1620 /* Define the classes of commands.
1621 They will appear in the help list in alphabetical order. */
1622
1623 add_cmd ("internals", class_maintenance, NULL, _("\
1624 Maintenance commands.\n\
1625 Some gdb commands are provided just for use by gdb maintainers.\n\
1626 These commands are subject to frequent change, and may not be as\n\
1627 well documented as user commands."),
1628 &cmdlist);
1629 add_cmd ("obscure", class_obscure, NULL, _("Obscure features."), &cmdlist);
1630 add_cmd ("aliases", class_alias, NULL,
1631 _("Aliases of other commands."), &cmdlist);
1632 add_cmd ("user-defined", class_user, NULL, _("\
1633 User-defined commands.\n\
1634 The commands in this class are those defined by the user.\n\
1635 Use the \"define\" command to define a command."), &cmdlist);
1636 add_cmd ("support", class_support, NULL, _("Support facilities."), &cmdlist);
1637 if (!dbx_commands)
1638 add_cmd ("status", class_info, NULL, _("Status inquiries."), &cmdlist);
1639 add_cmd ("files", class_files, NULL, _("Specifying and examining files."),
1640 &cmdlist);
1641 add_cmd ("breakpoints", class_breakpoint, NULL,
1642 _("Making program stop at certain points."), &cmdlist);
1643 add_cmd ("data", class_vars, NULL, _("Examining data."), &cmdlist);
1644 add_cmd ("stack", class_stack, NULL, _("\
1645 Examining the stack.\n\
1646 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1647 counting from zero for the innermost (currently executing) frame.\n\n\
1648 At any time gdb identifies one frame as the \"selected\" frame.\n\
1649 Variable lookups are done with respect to the selected frame.\n\
1650 When the program being debugged stops, gdb selects the innermost frame.\n\
1651 The commands below can be used to select other frames by number or address."),
1652 &cmdlist);
1653 add_cmd ("running", class_run, NULL, _("Running the program."), &cmdlist);
1654
1655 /* Define general commands. */
1656
1657 add_com ("pwd", class_files, pwd_command, _("\
1658 Print working directory. This is used for your program as well."));
1659
1660 c = add_cmd ("cd", class_files, cd_command, _("\
1661 Set working directory to DIR for debugger and program being debugged.\n\
1662 The change does not take effect for the program being debugged\n\
1663 until the next time it is started."), &cmdlist);
1664 set_cmd_completer (c, filename_completer);
1665
1666 add_com ("echo", class_support, echo_command, _("\
1667 Print a constant string. Give string as argument.\n\
1668 C escape sequences may be used in the argument.\n\
1669 No newline is added at the end of the argument;\n\
1670 use \"\\n\" if you want a newline to be printed.\n\
1671 Since leading and trailing whitespace are ignored in command arguments,\n\
1672 if you want to print some you must use \"\\\" before leading whitespace\n\
1673 to be printed or after trailing whitespace."));
1674
1675 add_setshow_enum_cmd ("script-extension", class_support,
1676 script_ext_enums, &script_ext_mode, _("\
1677 Set mode for script filename extension recognition."), _("\
1678 Show mode for script filename extension recognition."), _("\
1679 off == no filename extension recognition (all sourced files are GDB scripts)\n\
1680 soft == evaluate script according to filename extension, fallback to GDB script"
1681 "\n\
1682 strict == evaluate script according to filename extension, error if not supported"
1683 ),
1684 NULL,
1685 show_script_ext_mode,
1686 &setlist, &showlist);
1687
1688 add_com ("quit", class_support, quit_command, _("Exit gdb."));
1689 c = add_com ("help", class_support, help_command,
1690 _("Print list of commands."));
1691 set_cmd_completer (c, command_completer);
1692 add_com_alias ("q", "quit", class_support, 1);
1693 add_com_alias ("h", "help", class_support, 1);
1694
1695 add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
1696 Set verbosity."), _("\
1697 Show verbosity."), NULL,
1698 set_verbose,
1699 show_info_verbose,
1700 &setlist, &showlist);
1701
1702 add_prefix_cmd ("history", class_support, set_history,
1703 _("Generic command for setting command history parameters."),
1704 &sethistlist, "set history ", 0, &setlist);
1705 add_prefix_cmd ("history", class_support, show_history,
1706 _("Generic command for showing command history parameters."),
1707 &showhistlist, "show history ", 0, &showlist);
1708
1709 add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
1710 Set history expansion on command input."), _("\
1711 Show history expansion on command input."), _("\
1712 Without an argument, history expansion is enabled."),
1713 NULL,
1714 show_history_expansion_p,
1715 &sethistlist, &showhistlist);
1716
1717 add_prefix_cmd ("info", class_info, info_command, _("\
1718 Generic command for showing things about the program being debugged."),
1719 &infolist, "info ", 0, &cmdlist);
1720 add_com_alias ("i", "info", class_info, 1);
1721 add_com_alias ("inf", "info", class_info, 1);
1722
1723 add_com ("complete", class_obscure, complete_command,
1724 _("List the completions for the rest of the line as a command."));
1725
1726 add_prefix_cmd ("show", class_info, show_command, _("\
1727 Generic command for showing things about the debugger."),
1728 &showlist, "show ", 0, &cmdlist);
1729 /* Another way to get at the same thing. */
1730 add_info ("set", show_command, _("Show all GDB settings."));
1731
1732 add_cmd ("commands", no_set_class, show_commands, _("\
1733 Show the history of commands you typed.\n\
1734 You can supply a command number to start with, or a `+' to start after\n\
1735 the previous command number shown."),
1736 &showlist);
1737
1738 add_cmd ("version", no_set_class, show_version,
1739 _("Show what version of GDB this is."), &showlist);
1740
1741 add_cmd ("configuration", no_set_class, show_configuration,
1742 _("Show how GDB was configured at build time."), &showlist);
1743
1744 add_setshow_zinteger_cmd ("remote", no_class, &remote_debug, _("\
1745 Set debugging of remote protocol."), _("\
1746 Show debugging of remote protocol."), _("\
1747 When enabled, each packet sent or received with the remote target\n\
1748 is displayed."),
1749 NULL,
1750 show_remote_debug,
1751 &setdebuglist, &showdebuglist);
1752
1753 add_setshow_zuinteger_unlimited_cmd ("remotetimeout", no_class,
1754 &remote_timeout, _("\
1755 Set timeout limit to wait for target to respond."), _("\
1756 Show timeout limit to wait for target to respond."), _("\
1757 This value is used to set the time limit for gdb to wait for a response\n\
1758 from the target."),
1759 NULL,
1760 show_remote_timeout,
1761 &setlist, &showlist);
1762
1763 add_prefix_cmd ("debug", no_class, set_debug,
1764 _("Generic command for setting gdb debugging flags"),
1765 &setdebuglist, "set debug ", 0, &setlist);
1766
1767 add_prefix_cmd ("debug", no_class, show_debug,
1768 _("Generic command for showing gdb debugging flags"),
1769 &showdebuglist, "show debug ", 0, &showlist);
1770
1771 c = add_com ("shell", class_support, shell_escape, _("\
1772 Execute the rest of the line as a shell command.\n\
1773 With no arguments, run an inferior shell."));
1774 set_cmd_completer (c, filename_completer);
1775
1776 c = add_com ("edit", class_files, edit_command, _("\
1777 Edit specified file or function.\n\
1778 With no argument, edits file containing most recent line listed.\n\
1779 Editing targets can be specified in these ways:\n\
1780 FILE:LINENUM, to edit at that line in that file,\n\
1781 FUNCTION, to edit at the beginning of that function,\n\
1782 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1783 *ADDRESS, to edit at the line containing that address.\n\
1784 Uses EDITOR environment variable contents as editor (or ex as default)."));
1785
1786 c->completer = location_completer;
1787
1788 add_com ("list", class_files, list_command, _("\
1789 List specified function or line.\n\
1790 With no argument, lists ten more lines after or around previous listing.\n\
1791 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1792 One argument specifies a line, and ten lines are listed around that line.\n\
1793 Two arguments with comma between specify starting and ending lines to list.\n\
1794 Lines can be specified in these ways:\n\
1795 LINENUM, to list around that line in current file,\n\
1796 FILE:LINENUM, to list around that line in that file,\n\
1797 FUNCTION, to list around beginning of that function,\n\
1798 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1799 *ADDRESS, to list around the line containing that address.\n\
1800 With two args if one is empty it stands for ten lines away from \
1801 the other arg."));
1802
1803 if (!xdb_commands)
1804 add_com_alias ("l", "list", class_files, 1);
1805 else
1806 add_com_alias ("v", "list", class_files, 1);
1807
1808 if (dbx_commands)
1809 add_com_alias ("file", "list", class_files, 1);
1810
1811 c = add_com ("disassemble", class_vars, disassemble_command, _("\
1812 Disassemble a specified section of memory.\n\
1813 Default is the function surrounding the pc of the selected frame.\n\
1814 With a /m modifier, source lines are included (if available).\n\
1815 With a /r modifier, raw instructions in hex are included.\n\
1816 With a single argument, the function surrounding that address is dumped.\n\
1817 Two arguments (separated by a comma) are taken as a range of memory to dump,\n\
1818 in the form of \"start,end\", or \"start,+length\".\n\
1819 \n\
1820 Note that the address is interpreted as an expression, not as a location\n\
1821 like in the \"break\" command.\n\
1822 So, for example, if you want to disassemble function bar in file foo.c\n\
1823 you must type \"disassemble 'foo.c'::bar\" and not \"disassemble foo.c:bar\"."));
1824 set_cmd_completer (c, location_completer);
1825 if (xdb_commands)
1826 add_com_alias ("va", "disassemble", class_xdb, 0);
1827
1828 add_com_alias ("!", "shell", class_support, 0);
1829
1830 c = add_com ("make", class_support, make_command, _("\
1831 Run the ``make'' program using the rest of the line as arguments."));
1832 set_cmd_completer (c, filename_completer);
1833 add_cmd ("user", no_class, show_user, _("\
1834 Show definitions of non-python user defined commands.\n\
1835 Argument is the name of the user defined command.\n\
1836 With no argument, show definitions of all user defined commands."), &showlist);
1837 add_com ("apropos", class_support, apropos_command,
1838 _("Search for commands matching a REGEXP"));
1839
1840 add_setshow_uinteger_cmd ("max-user-call-depth", no_class,
1841 &max_user_call_depth, _("\
1842 Set the max call depth for non-python user-defined commands."), _("\
1843 Show the max call depth for non-python user-defined commands."), NULL,
1844 NULL,
1845 show_max_user_call_depth,
1846 &setlist, &showlist);
1847
1848 add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
1849 Set tracing of GDB CLI commands."), _("\
1850 Show state of GDB CLI command tracing."), _("\
1851 When 'on', each command is displayed as it is executed."),
1852 NULL,
1853 NULL,
1854 &setlist, &showlist);
1855
1856 c = add_com ("alias", class_support, alias_command, _("\
1857 Define a new command that is an alias of an existing command.\n\
1858 Usage: alias [-a] [--] ALIAS = COMMAND\n\
1859 ALIAS is the name of the alias command to create.\n\
1860 COMMAND is the command being aliased to.\n\
1861 If \"-a\" is specified, the command is an abbreviation,\n\
1862 and will not appear in help command list output.\n\
1863 \n\
1864 Examples:\n\
1865 Make \"spe\" an alias of \"set print elements\":\n\
1866 alias spe = set print elements\n\
1867 Make \"elms\" an alias of \"elements\" in the \"set print\" command:\n\
1868 alias -a set print elms = set print elements"));
1869 }
1870
1871 void
1872 init_cli_cmds (void)
1873 {
1874 struct cmd_list_element *c;
1875 char *source_help_text;
1876
1877 source_help_text = xstrprintf (_("\
1878 Read commands from a file named FILE.\n\
1879 \n\
1880 Usage: source [-s] [-v] FILE\n\
1881 -s: search for the script in the source search path,\n\
1882 even if FILE contains directories.\n\
1883 -v: each command in FILE is echoed as it is executed.\n\
1884 \n\
1885 Note that the file \"%s\" is read automatically in this way\n\
1886 when GDB is started."), gdbinit);
1887 c = add_cmd ("source", class_support, source_command,
1888 source_help_text, &cmdlist);
1889 set_cmd_completer (c, filename_completer);
1890 }