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