2004-02-07 Andrew Cagney <cagney@redhat.com>
[binutils-gdb.git] / gdb / cli / cli-cmds.c
1 /* GDB CLI commands.
2
3 Copyright 2000, 2001, 2002, 2003, 2004 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 2 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, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22 #include "defs.h"
23 #include <readline/readline.h>
24 #include <readline/tilde.h>
25 #include "completer.h"
26 #include "target.h" /* For baud_rate, remote_debug and remote_timeout */
27 #include "gdb_wait.h" /* For shell escape implementation */
28 #include "gdb_regex.h" /* Used by apropos_command */
29 #include "gdb_string.h"
30 #include "gdb_vfork.h"
31 #include "linespec.h"
32 #include "expression.h"
33 #include "frame.h"
34 #include "value.h"
35 #include "language.h"
36 #include "filenames.h" /* for DOSish file names */
37 #include "objfiles.h"
38 #include "source.h"
39 #include "disasm.h"
40
41 #include "ui-out.h"
42
43 #include "top.h"
44 #include "cli/cli-decode.h"
45 #include "cli/cli-script.h"
46 #include "cli/cli-setshow.h"
47 #include "cli/cli-cmds.h"
48
49 #ifndef GDBINIT_FILENAME
50 #define GDBINIT_FILENAME ".gdbinit"
51 #endif
52
53 /* Prototypes for local command functions */
54
55 static void complete_command (char *, int);
56
57 static void echo_command (char *, int);
58
59 static void pwd_command (char *, int);
60
61 static void show_version (char *, int);
62
63 static void help_command (char *, int);
64
65 static void show_command (char *, int);
66
67 static void info_command (char *, int);
68
69 static void show_debug (char *, int);
70
71 static void set_debug (char *, int);
72
73 static void show_user (char *, int);
74
75 static void make_command (char *, int);
76
77 static void shell_escape (char *, int);
78
79 static void edit_command (char *, int);
80
81 static void list_command (char *, int);
82
83 void apropos_command (char *, int);
84
85 /* Prototypes for local utility functions */
86
87 static void ambiguous_line_spec (struct symtabs_and_lines *);
88 \f
89 /* Limit the call depth of user-defined commands */
90 int max_user_call_depth;
91
92 /* Define all cmd_list_elements. */
93
94 /* Chain containing all defined commands. */
95
96 struct cmd_list_element *cmdlist;
97
98 /* Chain containing all defined info subcommands. */
99
100 struct cmd_list_element *infolist;
101
102 /* Chain containing all defined enable subcommands. */
103
104 struct cmd_list_element *enablelist;
105
106 /* Chain containing all defined disable subcommands. */
107
108 struct cmd_list_element *disablelist;
109
110 /* Chain containing all defined toggle subcommands. */
111
112 struct cmd_list_element *togglelist;
113
114 /* Chain containing all defined stop subcommands. */
115
116 struct cmd_list_element *stoplist;
117
118 /* Chain containing all defined delete subcommands. */
119
120 struct cmd_list_element *deletelist;
121
122 /* Chain containing all defined "enable breakpoint" subcommands. */
123
124 struct cmd_list_element *enablebreaklist;
125
126 /* Chain containing all defined set subcommands */
127
128 struct cmd_list_element *setlist;
129
130 /* Chain containing all defined unset subcommands */
131
132 struct cmd_list_element *unsetlist;
133
134 /* Chain containing all defined show subcommands. */
135
136 struct cmd_list_element *showlist;
137
138 /* Chain containing all defined \"set history\". */
139
140 struct cmd_list_element *sethistlist;
141
142 /* Chain containing all defined \"show history\". */
143
144 struct cmd_list_element *showhistlist;
145
146 /* Chain containing all defined \"unset history\". */
147
148 struct cmd_list_element *unsethistlist;
149
150 /* Chain containing all defined maintenance subcommands. */
151
152 struct cmd_list_element *maintenancelist;
153
154 /* Chain containing all defined "maintenance info" subcommands. */
155
156 struct cmd_list_element *maintenanceinfolist;
157
158 /* Chain containing all defined "maintenance print" subcommands. */
159
160 struct cmd_list_element *maintenanceprintlist;
161
162 struct cmd_list_element *setprintlist;
163
164 struct cmd_list_element *showprintlist;
165
166 struct cmd_list_element *setdebuglist;
167
168 struct cmd_list_element *showdebuglist;
169
170 struct cmd_list_element *setchecklist;
171
172 struct cmd_list_element *showchecklist;
173 \f
174 /* Utility used everywhere when at least one argument is needed and
175 none is supplied. */
176
177 void
178 error_no_arg (char *why)
179 {
180 error ("Argument required (%s).", why);
181 }
182
183 /* The "info" command is defined as a prefix, with allow_unknown = 0.
184 Therefore, its own definition is called only for "info" with no args. */
185
186 static void
187 info_command (char *arg, int from_tty)
188 {
189 printf_unfiltered ("\"info\" must be followed by the name of an info command.\n");
190 help_list (infolist, "info ", -1, gdb_stdout);
191 }
192
193 /* The "show" command with no arguments shows all the settings. */
194
195 static void
196 show_command (char *arg, int from_tty)
197 {
198 cmd_show_list (showlist, from_tty, "");
199 }
200 \f
201 /* Provide documentation on command or list given by COMMAND. FROM_TTY
202 is ignored. */
203
204 static void
205 help_command (char *command, int from_tty)
206 {
207 help_cmd (command, gdb_stdout);
208 }
209 \f
210 /* String compare function for qsort. */
211 static int
212 compare_strings (const void *arg1, const void *arg2)
213 {
214 const char **s1 = (const char **) arg1;
215 const char **s2 = (const char **) arg2;
216 return strcmp (*s1, *s2);
217 }
218
219 /* The "complete" command is used by Emacs to implement completion. */
220
221 static void
222 complete_command (char *arg, int from_tty)
223 {
224 int i;
225 int argpoint;
226 char **completions, *point, *arg_prefix;
227
228 dont_repeat ();
229
230 if (arg == NULL)
231 arg = "";
232 argpoint = strlen (arg);
233
234 /* complete_line assumes that its first argument is somewhere within,
235 and except for filenames at the beginning of, the word to be completed.
236 The following crude imitation of readline's word-breaking tries to
237 accomodate this. */
238 point = arg + argpoint;
239 while (point > arg)
240 {
241 if (strchr (rl_completer_word_break_characters, point[-1]) != 0)
242 break;
243 point--;
244 }
245
246 arg_prefix = alloca (point - arg + 1);
247 memcpy (arg_prefix, arg, point - arg);
248 arg_prefix[point - arg] = 0;
249
250 completions = complete_line (point, arg, argpoint);
251
252 if (completions)
253 {
254 int item, size;
255
256 for (size = 0; completions[size]; ++size)
257 ;
258 qsort (completions, size, sizeof (char *), compare_strings);
259
260 /* We do extra processing here since we only want to print each
261 unique item once. */
262 item = 0;
263 while (item < size)
264 {
265 int next_item;
266 printf_unfiltered ("%s%s\n", arg_prefix, completions[item]);
267 next_item = item + 1;
268 while (next_item < size
269 && ! strcmp (completions[item], completions[next_item]))
270 {
271 xfree (completions[next_item]);
272 ++next_item;
273 }
274
275 xfree (completions[item]);
276 item = next_item;
277 }
278
279 xfree (completions);
280 }
281 }
282
283 int
284 is_complete_command (struct cmd_list_element *c)
285 {
286 return cmd_cfunc_eq (c, complete_command);
287 }
288
289 static void
290 show_version (char *args, int from_tty)
291 {
292 immediate_quit++;
293 print_gdb_version (gdb_stdout);
294 printf_filtered ("\n");
295 immediate_quit--;
296 }
297
298 /* Handle the quit command. */
299
300 void
301 quit_command (char *args, int from_tty)
302 {
303 if (!quit_confirm ())
304 error ("Not confirmed.");
305 quit_force (args, from_tty);
306 }
307
308 static void
309 pwd_command (char *args, int from_tty)
310 {
311 if (args)
312 error ("The \"pwd\" command does not take an argument: %s", args);
313 getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
314
315 if (strcmp (gdb_dirbuf, current_directory) != 0)
316 printf_unfiltered ("Working directory %s\n (canonically %s).\n",
317 current_directory, gdb_dirbuf);
318 else
319 printf_unfiltered ("Working directory %s.\n", current_directory);
320 }
321
322 void
323 cd_command (char *dir, int from_tty)
324 {
325 int len;
326 /* Found something other than leading repetitions of "/..". */
327 int found_real_path;
328 char *p;
329
330 /* If the new directory is absolute, repeat is a no-op; if relative,
331 repeat might be useful but is more likely to be a mistake. */
332 dont_repeat ();
333
334 if (dir == 0)
335 error_no_arg ("new working directory");
336
337 dir = tilde_expand (dir);
338 make_cleanup (xfree, dir);
339
340 if (chdir (dir) < 0)
341 perror_with_name (dir);
342
343 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
344 /* There's too much mess with DOSish names like "d:", "d:.",
345 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
346 simply get the canonicalized name of the current directory. */
347 dir = getcwd (gdb_dirbuf, sizeof (gdb_dirbuf));
348 #endif
349
350 len = strlen (dir);
351 if (IS_DIR_SEPARATOR (dir[len - 1]))
352 {
353 /* Remove the trailing slash unless this is a root directory
354 (including a drive letter on non-Unix systems). */
355 if (!(len == 1) /* "/" */
356 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
357 && !(len == 3 && dir[1] == ':') /* "d:/" */
358 #endif
359 )
360 len--;
361 }
362
363 dir = savestring (dir, len);
364 if (IS_ABSOLUTE_PATH (dir))
365 current_directory = dir;
366 else
367 {
368 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
369 current_directory = concat (current_directory, dir, NULL);
370 else
371 current_directory = concat (current_directory, SLASH_STRING, dir, NULL);
372 xfree (dir);
373 }
374
375 /* Now simplify any occurrences of `.' and `..' in the pathname. */
376
377 found_real_path = 0;
378 for (p = current_directory; *p;)
379 {
380 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
381 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
382 strcpy (p, p + 2);
383 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
384 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
385 {
386 if (found_real_path)
387 {
388 /* Search backwards for the directory just before the "/.."
389 and obliterate it and the "/..". */
390 char *q = p;
391 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
392 --q;
393
394 if (q == current_directory)
395 /* current_directory is
396 a relative pathname ("can't happen"--leave it alone). */
397 ++p;
398 else
399 {
400 strcpy (q - 1, p + 3);
401 p = q - 1;
402 }
403 }
404 else
405 /* We are dealing with leading repetitions of "/..", for example
406 "/../..", which is the Mach super-root. */
407 p += 3;
408 }
409 else
410 {
411 found_real_path = 1;
412 ++p;
413 }
414 }
415
416 forget_cached_source_info ();
417
418 if (from_tty)
419 pwd_command ((char *) 0, 1);
420 }
421 \f
422 void
423 source_command (char *args, int from_tty)
424 {
425 FILE *stream;
426 struct cleanup *old_cleanups;
427 char *file = args;
428
429 if (file == NULL)
430 {
431 error ("source command requires pathname of file to source.");
432 }
433
434 file = tilde_expand (file);
435 old_cleanups = make_cleanup (xfree, file);
436
437 stream = fopen (file, FOPEN_RT);
438 if (!stream)
439 {
440 if (from_tty)
441 perror_with_name (file);
442 else
443 return;
444 }
445
446 script_from_file (stream, file);
447
448 do_cleanups (old_cleanups);
449 }
450
451 static void
452 echo_command (char *text, int from_tty)
453 {
454 char *p = text;
455 int c;
456
457 if (text)
458 while ((c = *p++) != '\0')
459 {
460 if (c == '\\')
461 {
462 /* \ at end of argument is used after spaces
463 so they won't be lost. */
464 if (*p == 0)
465 return;
466
467 c = parse_escape (&p);
468 if (c >= 0)
469 printf_filtered ("%c", c);
470 }
471 else
472 printf_filtered ("%c", c);
473 }
474
475 /* Force this output to appear now. */
476 wrap_here ("");
477 gdb_flush (gdb_stdout);
478 }
479
480 static void
481 shell_escape (char *arg, int from_tty)
482 {
483 #ifdef CANT_FORK
484 /* If ARG is NULL, they want an inferior shell, but `system' just
485 reports if the shell is available when passed a NULL arg. */
486 int rc = system (arg ? arg : "");
487
488 if (!arg)
489 arg = "inferior shell";
490
491 if (rc == -1)
492 {
493 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
494 safe_strerror (errno));
495 gdb_flush (gdb_stderr);
496 }
497 else if (rc)
498 {
499 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
500 gdb_flush (gdb_stderr);
501 }
502 #ifdef GLOBAL_CURDIR
503 /* Make sure to return to the directory GDB thinks it is, in case the
504 shell command we just ran changed it. */
505 chdir (current_directory);
506 #endif
507 #else /* Can fork. */
508 int rc, status, pid;
509
510 if ((pid = vfork ()) == 0)
511 {
512 char *p, *user_shell;
513
514 if ((user_shell = (char *) getenv ("SHELL")) == NULL)
515 user_shell = "/bin/sh";
516
517 /* Get the name of the shell for arg0 */
518 if ((p = strrchr (user_shell, '/')) == NULL)
519 p = user_shell;
520 else
521 p++; /* Get past '/' */
522
523 if (!arg)
524 execl (user_shell, p, (char *) 0);
525 else
526 execl (user_shell, p, "-c", arg, (char *) 0);
527
528 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
529 safe_strerror (errno));
530 gdb_flush (gdb_stderr);
531 _exit (0177);
532 }
533
534 if (pid != -1)
535 while ((rc = wait (&status)) != pid && rc != -1)
536 ;
537 else
538 error ("Fork failed");
539 #endif /* Can fork. */
540 }
541
542 static void
543 edit_command (char *arg, int from_tty)
544 {
545 struct symtabs_and_lines sals;
546 struct symtab_and_line sal;
547 struct symbol *sym;
548 char *arg1;
549 int cmdlen, log10;
550 unsigned m;
551 char *editor;
552 char *p;
553
554 /* Pull in the current default source line if necessary */
555 if (arg == 0)
556 {
557 set_default_source_symtab_and_line ();
558 sal = get_current_source_symtab_and_line ();
559 }
560
561 /* bare "edit" edits file with present line. */
562
563 if (arg == 0)
564 {
565 if (sal.symtab == 0)
566 error ("No default source file yet.");
567 sal.line += get_lines_to_list () / 2;
568 }
569 else
570 {
571
572 /* Now should only be one argument -- decode it in SAL */
573
574 arg1 = arg;
575 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
576
577 if (! sals.nelts) return; /* C++ */
578 if (sals.nelts > 1) {
579 ambiguous_line_spec (&sals);
580 xfree (sals.sals);
581 return;
582 }
583
584 sal = sals.sals[0];
585 xfree (sals.sals);
586
587 if (*arg1)
588 error ("Junk at end of line specification.");
589
590 /* if line was specified by address,
591 first print exactly which line, and which file.
592 In this case, sal.symtab == 0 means address is outside
593 of all known source files, not that user failed to give a filename. */
594 if (*arg == '*')
595 {
596 if (sal.symtab == 0)
597 /* FIXME-32x64--assumes sal.pc fits in long. */
598 error ("No source file for address %s.",
599 local_hex_string((unsigned long) sal.pc));
600 sym = find_pc_function (sal.pc);
601 if (sym)
602 {
603 print_address_numeric (sal.pc, 1, gdb_stdout);
604 printf_filtered (" is in ");
605 fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
606 printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
607 }
608 else
609 {
610 print_address_numeric (sal.pc, 1, gdb_stdout);
611 printf_filtered (" is at %s:%d.\n",
612 sal.symtab->filename, sal.line);
613 }
614 }
615
616 /* If what was given does not imply a symtab, it must be an undebuggable
617 symbol which means no source code. */
618
619 if (sal.symtab == 0)
620 error ("No line number known for %s.", arg);
621 }
622
623 if ((editor = (char *) getenv ("EDITOR")) == NULL)
624 editor = "/bin/ex";
625
626 /* Approximate base-10 log of line to 1 unit for digit count */
627 for(log10=32, m=0x80000000; !(sal.line & m) && log10>0; log10--, m=m>>1);
628 log10 = 1 + (int)((log10 + (0 == ((m-1) & sal.line)))/3.32192809);
629
630 cmdlen = strlen(editor) + 1
631 + (NULL == sal.symtab->dirname ? 0 : strlen(sal.symtab->dirname) + 1)
632 + (NULL == sal.symtab->filename? 0 : strlen(sal.symtab->filename)+ 1)
633 + log10 + 2;
634
635 p = xmalloc(cmdlen);
636 sprintf(p,"%s +%d %s%s",editor,sal.line,
637 (NULL == sal.symtab->dirname ? "./" :
638 (NULL != sal.symtab->filename && *(sal.symtab->filename) != '/') ?
639 sal.symtab->dirname : ""),
640 (NULL == sal.symtab->filename ? "unknown" : sal.symtab->filename)
641 );
642 shell_escape(p, from_tty);
643
644 xfree(p);
645 }
646
647 static void
648 list_command (char *arg, int from_tty)
649 {
650 struct symtabs_and_lines sals, sals_end;
651 struct symtab_and_line sal, sal_end, cursal;
652 struct symbol *sym;
653 char *arg1;
654 int no_end = 1;
655 int dummy_end = 0;
656 int dummy_beg = 0;
657 int linenum_beg = 0;
658 char *p;
659
660 /* Pull in the current default source line if necessary */
661 if (arg == 0 || arg[0] == '+' || arg[0] == '-')
662 {
663 set_default_source_symtab_and_line ();
664 cursal = get_current_source_symtab_and_line ();
665 }
666
667 /* "l" or "l +" lists next ten lines. */
668
669 if (arg == 0 || strcmp (arg, "+") == 0)
670 {
671 print_source_lines (cursal.symtab, cursal.line,
672 cursal.line + get_lines_to_list (), 0);
673 return;
674 }
675
676 /* "l -" lists previous ten lines, the ones before the ten just listed. */
677 if (strcmp (arg, "-") == 0)
678 {
679 print_source_lines (cursal.symtab,
680 max (get_first_line_listed () - get_lines_to_list (), 1),
681 get_first_line_listed (), 0);
682 return;
683 }
684
685 /* Now if there is only one argument, decode it in SAL
686 and set NO_END.
687 If there are two arguments, decode them in SAL and SAL_END
688 and clear NO_END; however, if one of the arguments is blank,
689 set DUMMY_BEG or DUMMY_END to record that fact. */
690
691 if (!have_full_symbols () && !have_partial_symbols ())
692 error ("No symbol table is loaded. Use the \"file\" command.");
693
694 arg1 = arg;
695 if (*arg1 == ',')
696 dummy_beg = 1;
697 else
698 {
699 sals = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
700
701 if (!sals.nelts)
702 return; /* C++ */
703 if (sals.nelts > 1)
704 {
705 ambiguous_line_spec (&sals);
706 xfree (sals.sals);
707 return;
708 }
709
710 sal = sals.sals[0];
711 xfree (sals.sals);
712 }
713
714 /* Record whether the BEG arg is all digits. */
715
716 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
717 linenum_beg = (p == arg1);
718
719 while (*arg1 == ' ' || *arg1 == '\t')
720 arg1++;
721 if (*arg1 == ',')
722 {
723 no_end = 0;
724 arg1++;
725 while (*arg1 == ' ' || *arg1 == '\t')
726 arg1++;
727 if (*arg1 == 0)
728 dummy_end = 1;
729 else
730 {
731 if (dummy_beg)
732 sals_end = decode_line_1 (&arg1, 0, 0, 0, 0, 0);
733 else
734 sals_end = decode_line_1 (&arg1, 0, sal.symtab, sal.line, 0, 0);
735 if (sals_end.nelts == 0)
736 return;
737 if (sals_end.nelts > 1)
738 {
739 ambiguous_line_spec (&sals_end);
740 xfree (sals_end.sals);
741 return;
742 }
743 sal_end = sals_end.sals[0];
744 xfree (sals_end.sals);
745 }
746 }
747
748 if (*arg1)
749 error ("Junk at end of line specification.");
750
751 if (!no_end && !dummy_beg && !dummy_end
752 && sal.symtab != sal_end.symtab)
753 error ("Specified start and end are in different files.");
754 if (dummy_beg && dummy_end)
755 error ("Two empty args do not say what lines to list.");
756
757 /* if line was specified by address,
758 first print exactly which line, and which file.
759 In this case, sal.symtab == 0 means address is outside
760 of all known source files, not that user failed to give a filename. */
761 if (*arg == '*')
762 {
763 if (sal.symtab == 0)
764 /* FIXME-32x64--assumes sal.pc fits in long. */
765 error ("No source file for address %s.",
766 local_hex_string ((unsigned long) sal.pc));
767 sym = find_pc_function (sal.pc);
768 if (sym)
769 {
770 print_address_numeric (sal.pc, 1, gdb_stdout);
771 printf_filtered (" is in ");
772 fputs_filtered (SYMBOL_PRINT_NAME (sym), gdb_stdout);
773 printf_filtered (" (%s:%d).\n", sal.symtab->filename, sal.line);
774 }
775 else
776 {
777 print_address_numeric (sal.pc, 1, gdb_stdout);
778 printf_filtered (" is at %s:%d.\n",
779 sal.symtab->filename, sal.line);
780 }
781 }
782
783 /* If line was not specified by just a line number,
784 and it does not imply a symtab, it must be an undebuggable symbol
785 which means no source code. */
786
787 if (!linenum_beg && sal.symtab == 0)
788 error ("No line number known for %s.", arg);
789
790 /* If this command is repeated with RET,
791 turn it into the no-arg variant. */
792
793 if (from_tty)
794 *arg = 0;
795
796 if (dummy_beg && sal_end.symtab == 0)
797 error ("No default source file yet. Do \"help list\".");
798 if (dummy_beg)
799 print_source_lines (sal_end.symtab,
800 max (sal_end.line - (get_lines_to_list () - 1), 1),
801 sal_end.line + 1, 0);
802 else if (sal.symtab == 0)
803 error ("No default source file yet. Do \"help list\".");
804 else if (no_end)
805 {
806 int first_line = sal.line - get_lines_to_list () / 2;
807
808 if (first_line < 1) first_line = 1;
809
810 print_source_lines (sal.symtab,
811 first_line,
812 first_line + get_lines_to_list (),
813 0);
814 }
815 else
816 print_source_lines (sal.symtab, sal.line,
817 (dummy_end
818 ? sal.line + get_lines_to_list ()
819 : sal_end.line + 1),
820 0);
821 }
822
823 /* Dump a specified section of assembly code. With no command line
824 arguments, this command will dump the assembly code for the
825 function surrounding the pc value in the selected frame. With one
826 argument, it will dump the assembly code surrounding that pc value.
827 Two arguments are interpeted as bounds within which to dump
828 assembly. */
829
830 static void
831 disassemble_command (char *arg, int from_tty)
832 {
833 CORE_ADDR low, high;
834 char *name;
835 CORE_ADDR pc, pc_masked;
836 char *space_index;
837 #if 0
838 asection *section;
839 #endif
840
841 name = NULL;
842 if (!arg)
843 {
844 if (!deprecated_selected_frame)
845 error ("No frame selected.\n");
846
847 pc = get_frame_pc (deprecated_selected_frame);
848 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
849 error ("No function contains program counter for selected frame.\n");
850 #if defined(TUI)
851 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
852 `tui_version'. */
853 if (tui_active)
854 /* FIXME: cagney/2004-02-07: This should be an observer. */
855 low = tui_get_low_disassembly_address (low, pc);
856 #endif
857 low += FUNCTION_START_OFFSET;
858 }
859 else if (!(space_index = (char *) strchr (arg, ' ')))
860 {
861 /* One argument. */
862 pc = parse_and_eval_address (arg);
863 if (find_pc_partial_function (pc, &name, &low, &high) == 0)
864 error ("No function contains specified address.\n");
865 #if defined(TUI)
866 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
867 `tui_version'. */
868 if (tui_active)
869 /* FIXME: cagney/2004-02-07: This should be an observer. */
870 low = tui_get_low_disassembly_address (low, pc);
871 #endif
872 low += FUNCTION_START_OFFSET;
873 }
874 else
875 {
876 /* Two arguments. */
877 *space_index = '\0';
878 low = parse_and_eval_address (arg);
879 high = parse_and_eval_address (space_index + 1);
880 }
881
882 #if defined(TUI)
883 if (!tui_is_window_visible (DISASSEM_WIN))
884 #endif
885 {
886 printf_filtered ("Dump of assembler code ");
887 if (name != NULL)
888 {
889 printf_filtered ("for function %s:\n", name);
890 }
891 else
892 {
893 printf_filtered ("from ");
894 print_address_numeric (low, 1, gdb_stdout);
895 printf_filtered (" to ");
896 print_address_numeric (high, 1, gdb_stdout);
897 printf_filtered (":\n");
898 }
899
900 /* Dump the specified range. */
901 gdb_disassembly (uiout, 0, 0, 0, -1, low, high);
902
903 printf_filtered ("End of assembler dump.\n");
904 gdb_flush (gdb_stdout);
905 }
906 #if defined(TUI)
907 else
908 {
909 tui_show_assembly (low);
910 }
911 #endif
912 }
913
914 static void
915 make_command (char *arg, int from_tty)
916 {
917 char *p;
918
919 if (arg == 0)
920 p = "make";
921 else
922 {
923 p = xmalloc (sizeof ("make ") + strlen (arg));
924 strcpy (p, "make ");
925 strcpy (p + sizeof ("make ") - 1, arg);
926 }
927
928 shell_escape (p, from_tty);
929 }
930
931 static void
932 show_user (char *args, int from_tty)
933 {
934 struct cmd_list_element *c;
935 extern struct cmd_list_element *cmdlist;
936
937 if (args)
938 {
939 c = lookup_cmd (&args, cmdlist, "", 0, 1);
940 if (c->class != class_user)
941 error ("Not a user command.");
942 show_user_1 (c, gdb_stdout);
943 }
944 else
945 {
946 for (c = cmdlist; c; c = c->next)
947 {
948 if (c->class == class_user)
949 show_user_1 (c, gdb_stdout);
950 }
951 }
952 }
953
954 /* Search through names of commands and documentations for a certain
955 regular expression.
956 */
957 void
958 apropos_command (char *searchstr, int from_tty)
959 {
960 extern struct cmd_list_element *cmdlist; /*This is the main command list*/
961 regex_t pattern;
962 char *pattern_fastmap;
963 char errorbuffer[512];
964 pattern_fastmap = xcalloc (256, sizeof (char));
965 if (searchstr == NULL)
966 error("REGEXP string is empty");
967
968 if (regcomp(&pattern,searchstr,REG_ICASE) == 0)
969 {
970 pattern.fastmap=pattern_fastmap;
971 re_compile_fastmap(&pattern);
972 apropos_cmd (gdb_stdout,cmdlist,&pattern,"");
973 }
974 else
975 {
976 regerror(regcomp(&pattern,searchstr,REG_ICASE),NULL,errorbuffer,512);
977 error("Error in regular expression:%s",errorbuffer);
978 }
979 xfree (pattern_fastmap);
980 }
981 \f
982 /* Print a list of files and line numbers which a user may choose from
983 in order to list a function which was specified ambiguously (as with
984 `list classname::overloadedfuncname', for example). The vector in
985 SALS provides the filenames and line numbers. */
986
987 static void
988 ambiguous_line_spec (struct symtabs_and_lines *sals)
989 {
990 int i;
991
992 for (i = 0; i < sals->nelts; ++i)
993 printf_filtered ("file: \"%s\", line number: %d\n",
994 sals->sals[i].symtab->filename, sals->sals[i].line);
995 }
996
997 static void
998 set_debug (char *arg, int from_tty)
999 {
1000 printf_unfiltered ("\"set debug\" must be followed by the name of a print subcommand.\n");
1001 help_list (setdebuglist, "set debug ", -1, gdb_stdout);
1002 }
1003
1004 static void
1005 show_debug (char *args, int from_tty)
1006 {
1007 cmd_show_list (showdebuglist, from_tty, "");
1008 }
1009
1010 void
1011 init_cmd_lists (void)
1012 {
1013 max_user_call_depth = 1024;
1014
1015 cmdlist = NULL;
1016 infolist = NULL;
1017 enablelist = NULL;
1018 disablelist = NULL;
1019 togglelist = NULL;
1020 stoplist = NULL;
1021 deletelist = NULL;
1022 enablebreaklist = NULL;
1023 setlist = NULL;
1024 unsetlist = NULL;
1025 showlist = NULL;
1026 sethistlist = NULL;
1027 showhistlist = NULL;
1028 unsethistlist = NULL;
1029 maintenancelist = NULL;
1030 maintenanceinfolist = NULL;
1031 maintenanceprintlist = NULL;
1032 setprintlist = NULL;
1033 showprintlist = NULL;
1034 setchecklist = NULL;
1035 showchecklist = NULL;
1036 }
1037
1038 \f
1039 void
1040 init_cli_cmds (void)
1041 {
1042 struct cmd_list_element *c;
1043
1044 /* Define the classes of commands.
1045 They will appear in the help list in the reverse of this order. */
1046
1047 add_cmd ("internals", class_maintenance, NULL,
1048 "Maintenance commands.\n\
1049 Some gdb commands are provided just for use by gdb maintainers.\n\
1050 These commands are subject to frequent change, and may not be as\n\
1051 well documented as user commands.",
1052 &cmdlist);
1053 add_cmd ("obscure", class_obscure, NULL, "Obscure features.", &cmdlist);
1054 add_cmd ("aliases", class_alias, NULL, "Aliases of other commands.", &cmdlist);
1055 add_cmd ("user-defined", class_user, NULL, "User-defined commands.\n\
1056 The commands in this class are those defined by the user.\n\
1057 Use the \"define\" command to define a command.", &cmdlist);
1058 add_cmd ("support", class_support, NULL, "Support facilities.", &cmdlist);
1059 if (!dbx_commands)
1060 add_cmd ("status", class_info, NULL, "Status inquiries.", &cmdlist);
1061 add_cmd ("files", class_files, NULL, "Specifying and examining files.", &cmdlist);
1062 add_cmd ("breakpoints", class_breakpoint, NULL, "Making program stop at certain points.", &cmdlist);
1063 add_cmd ("data", class_vars, NULL, "Examining data.", &cmdlist);
1064 add_cmd ("stack", class_stack, NULL, "Examining the stack.\n\
1065 The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
1066 counting from zero for the innermost (currently executing) frame.\n\n\
1067 At any time gdb identifies one frame as the \"selected\" frame.\n\
1068 Variable lookups are done with respect to the selected frame.\n\
1069 When the program being debugged stops, gdb selects the innermost frame.\n\
1070 The commands below can be used to select other frames by number or address.",
1071 &cmdlist);
1072 add_cmd ("running", class_run, NULL, "Running the program.", &cmdlist);
1073
1074 /* Define general commands. */
1075
1076 add_com ("pwd", class_files, pwd_command,
1077 "Print working directory. This is used for your program as well.");
1078 c = add_cmd ("cd", class_files, cd_command,
1079 "Set working directory to DIR for debugger and program being debugged.\n\
1080 The change does not take effect for the program being debugged\n\
1081 until the next time it is started.", &cmdlist);
1082 set_cmd_completer (c, filename_completer);
1083
1084 add_com ("echo", class_support, echo_command,
1085 "Print a constant string. Give string as argument.\n\
1086 C escape sequences may be used in the argument.\n\
1087 No newline is added at the end of the argument;\n\
1088 use \"\\n\" if you want a newline to be printed.\n\
1089 Since leading and trailing whitespace are ignored in command arguments,\n\
1090 if you want to print some you must use \"\\\" before leading whitespace\n\
1091 to be printed or after trailing whitespace.");
1092 add_com ("document", class_support, document_command,
1093 "Document a user-defined command.\n\
1094 Give command name as argument. Give documentation on following lines.\n\
1095 End with a line of just \"end\".");
1096 add_com ("define", class_support, define_command,
1097 "Define a new command name. Command name is argument.\n\
1098 Definition appears on following lines, one command per line.\n\
1099 End with a line of just \"end\".\n\
1100 Use the \"document\" command to give documentation for the new command.\n\
1101 Commands defined in this way may have up to ten arguments.");
1102
1103 c = add_cmd ("source", class_support, source_command,
1104 "Read commands from a file named FILE.\n\
1105 Note that the file \"" GDBINIT_FILENAME "\" is read automatically in this way\n\
1106 when gdb is started.", &cmdlist);
1107 set_cmd_completer (c, filename_completer);
1108
1109 add_com ("quit", class_support, quit_command, "Exit gdb.");
1110 c = add_com ("help", class_support, help_command, "Print list of commands.");
1111 set_cmd_completer (c, command_completer);
1112 add_com_alias ("q", "quit", class_support, 1);
1113 add_com_alias ("h", "help", class_support, 1);
1114
1115 c = add_set_cmd ("verbose", class_support, var_boolean, (char *) &info_verbose,
1116 "Set ",
1117 &setlist),
1118 add_show_from_set (c, &showlist);
1119 set_cmd_sfunc (c, set_verbose);
1120 set_verbose (NULL, 0, c);
1121
1122 add_prefix_cmd ("history", class_support, set_history,
1123 "Generic command for setting command history parameters.",
1124 &sethistlist, "set history ", 0, &setlist);
1125 add_prefix_cmd ("history", class_support, show_history,
1126 "Generic command for showing command history parameters.",
1127 &showhistlist, "show history ", 0, &showlist);
1128
1129 add_show_from_set
1130 (add_set_cmd ("expansion", no_class, var_boolean, (char *) &history_expansion_p,
1131 "Set history expansion on command input.\n\
1132 Without an argument, history expansion is enabled.", &sethistlist),
1133 &showhistlist);
1134
1135 add_prefix_cmd ("info", class_info, info_command,
1136 "Generic command for showing things about the program being debugged.",
1137 &infolist, "info ", 0, &cmdlist);
1138 add_com_alias ("i", "info", class_info, 1);
1139
1140 add_com ("complete", class_obscure, complete_command,
1141 "List the completions for the rest of the line as a command.");
1142
1143 add_prefix_cmd ("show", class_info, show_command,
1144 "Generic command for showing things about the debugger.",
1145 &showlist, "show ", 0, &cmdlist);
1146 /* Another way to get at the same thing. */
1147 add_info ("set", show_command, "Show all GDB settings.");
1148
1149 add_cmd ("commands", no_class, show_commands,
1150 "Show the history of commands you typed.\n\
1151 You can supply a command number to start with, or a `+' to start after\n\
1152 the previous command number shown.",
1153 &showlist);
1154
1155 add_cmd ("version", no_class, show_version,
1156 "Show what version of GDB this is.", &showlist);
1157
1158 add_com ("while", class_support, while_command,
1159 "Execute nested commands WHILE the conditional expression is non zero.\n\
1160 The conditional expression must follow the word `while' and must in turn be\n\
1161 followed by a new line. The nested commands must be entered one per line,\n\
1162 and should be terminated by the word `end'.");
1163
1164 add_com ("if", class_support, if_command,
1165 "Execute nested commands once IF the conditional expression is non zero.\n\
1166 The conditional expression must follow the word `if' and must in turn be\n\
1167 followed by a new line. The nested commands must be entered one per line,\n\
1168 and should be terminated by the word 'else' or `end'. If an else clause\n\
1169 is used, the same rules apply to its nested commands as to the first ones.");
1170
1171 /* If target is open when baud changes, it doesn't take effect until the
1172 next open (I think, not sure). */
1173 add_show_from_set (add_set_cmd ("remotebaud", no_class,
1174 var_zinteger, (char *) &baud_rate,
1175 "Set baud rate for remote serial I/O.\n\
1176 This value is used to set the speed of the serial port when debugging\n\
1177 using remote targets.", &setlist),
1178 &showlist);
1179
1180 c = add_set_cmd ("remotedebug", no_class, var_zinteger,
1181 (char *) &remote_debug,
1182 "Set debugging of remote protocol.\n\
1183 When enabled, each packet sent or received with the remote target\n\
1184 is displayed.", &setlist);
1185 deprecate_cmd (c, "set debug remote");
1186 deprecate_cmd (add_show_from_set (c, &showlist), "show debug remote");
1187
1188 add_show_from_set (add_set_cmd ("remote", no_class, var_zinteger,
1189 (char *) &remote_debug,
1190 "Set debugging of remote protocol.\n\
1191 When enabled, each packet sent or received with the remote target\n\
1192 is displayed.", &setdebuglist),
1193 &showdebuglist);
1194
1195 add_show_from_set (
1196 add_set_cmd ("remotetimeout", no_class, var_integer, (char *) &remote_timeout,
1197 "Set timeout limit to wait for target to respond.\n\
1198 This value is used to set the time limit for gdb to wait for a response\n\
1199 from the target.", &setlist),
1200 &showlist);
1201
1202 add_prefix_cmd ("debug", no_class, set_debug,
1203 "Generic command for setting gdb debugging flags",
1204 &setdebuglist, "set debug ", 0, &setlist);
1205
1206 add_prefix_cmd ("debug", no_class, show_debug,
1207 "Generic command for showing gdb debugging flags",
1208 &showdebuglist, "show debug ", 0, &showlist);
1209
1210 c = add_com ("shell", class_support, shell_escape,
1211 "Execute the rest of the line as a shell command.\n\
1212 With no arguments, run an inferior shell.");
1213 set_cmd_completer (c, filename_completer);
1214
1215 c = add_com ("edit", class_files, edit_command,
1216 concat ("Edit specified file or function.\n\
1217 With no argument, edits file containing most recent line listed.\n\
1218 ", "\
1219 Editing targets can be specified in these ways:\n\
1220 FILE:LINENUM, to edit at that line in that file,\n\
1221 FUNCTION, to edit at the beginning of that function,\n\
1222 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1223 *ADDRESS, to edit at the line containing that address.\n\
1224 Uses EDITOR environment variable contents as editor (or ex as default).",NULL));
1225
1226 c->completer = location_completer;
1227
1228 add_com ("list", class_files, list_command,
1229 concat ("List specified function or line.\n\
1230 With no argument, lists ten more lines after or around previous listing.\n\
1231 \"list -\" lists the ten lines before a previous ten-line listing.\n\
1232 One argument specifies a line, and ten lines are listed around that line.\n\
1233 Two arguments with comma between specify starting and ending lines to list.\n\
1234 ", "\
1235 Lines can be specified in these ways:\n\
1236 LINENUM, to list around that line in current file,\n\
1237 FILE:LINENUM, to list around that line in that file,\n\
1238 FUNCTION, to list around beginning of that function,\n\
1239 FILE:FUNCTION, to distinguish among like-named static functions.\n\
1240 *ADDRESS, to list around the line containing that address.\n\
1241 With two args if one is empty it stands for ten lines away from the other arg.", NULL));
1242
1243 if (!xdb_commands)
1244 add_com_alias ("l", "list", class_files, 1);
1245 else
1246 add_com_alias ("v", "list", class_files, 1);
1247
1248 if (dbx_commands)
1249 add_com_alias ("file", "list", class_files, 1);
1250
1251 c = add_com ("disassemble", class_vars, disassemble_command,
1252 "Disassemble a specified section of memory.\n\
1253 Default is the function surrounding the pc of the selected frame.\n\
1254 With a single argument, the function surrounding that address is dumped.\n\
1255 Two arguments are taken as a range of memory to dump.");
1256 set_cmd_completer (c, location_completer);
1257 if (xdb_commands)
1258 add_com_alias ("va", "disassemble", class_xdb, 0);
1259
1260 /* NOTE: cagney/2000-03-20: Being able to enter ``(gdb) !ls'' would
1261 be a really useful feature. Unfortunately, the below wont do
1262 this. Instead it adds support for the form ``(gdb) ! ls''
1263 (i.e. the space is required). If the ``!'' command below is
1264 added the complains about no ``!'' command would be replaced by
1265 complains about how the ``!'' command is broken :-) */
1266 if (xdb_commands)
1267 add_com_alias ("!", "shell", class_support, 0);
1268
1269 c = add_com ("make", class_support, make_command,
1270 "Run the ``make'' program using the rest of the line as arguments.");
1271 set_cmd_completer (c, filename_completer);
1272 add_cmd ("user", no_class, show_user,
1273 "Show definitions of user defined commands.\n\
1274 Argument is the name of the user defined command.\n\
1275 With no argument, show definitions of all user defined commands.", &showlist);
1276 add_com ("apropos", class_support, apropos_command, "Search for commands matching a REGEXP");
1277
1278 add_show_from_set (
1279 add_set_cmd ("max-user-call-depth", no_class, var_integer,
1280 (char *) &max_user_call_depth,
1281 "Set the max call depth for user-defined commands.\n",
1282 &setlist),
1283 &showlist);
1284 }