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