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