Automatic Copyright Year update after running gdb/copyright.py
[deliverable/binutils-gdb.git] / gdb / cli / cli-cmds.c
CommitLineData
d318976c 1/* GDB CLI commands.
8926118c 2
88b9d363 3 Copyright (C) 2000-2022 Free Software Foundation, Inc.
d318976c
FN
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
a9762ec7 9 the Free Software Foundation; either version 3 of the License, or
d318976c
FN
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
a9762ec7 18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
d318976c
FN
19
20#include "defs.h"
13274fc3 21#include "arch-utils.h"
dbda9972 22#include "readline/tilde.h"
d318976c 23#include "completer.h"
ebcd3b23 24#include "target.h" /* For baud_rate, remote_debug and remote_timeout. */
268a13a5 25#include "gdbsupport/gdb_wait.h" /* For shell escape implementation. */
947d3946 26#include "gdbcmd.h"
ebcd3b23 27#include "gdb_regex.h" /* Used by apropos_command. */
325ed089 28#include "gdb_vfork.h"
0378c332
FN
29#include "linespec.h"
30#include "expression.h"
83c31e7d
FN
31#include "frame.h"
32#include "value.h"
0378c332 33#include "language.h"
ebcd3b23 34#include "filenames.h" /* For DOSish file names. */
0378c332
FN
35#include "objfiles.h"
36#include "source.h"
83c31e7d 37#include "disasm.h"
33da3f1c 38#include "tracepoint.h"
268a13a5 39#include "gdbsupport/filestuff.h"
f00aae0f 40#include "location.h"
e9480230 41#include "block.h"
d318976c 42
d318976c 43#include "ui-out.h"
947d3946 44#include "interps.h"
d318976c
FN
45
46#include "top.h"
47#include "cli/cli-decode.h"
48#include "cli/cli-script.h"
49#include "cli/cli-setshow.h"
50#include "cli/cli-cmds.h"
14309bb6 51#include "cli/cli-style.h"
529480d0 52#include "cli/cli-utils.h"
cf00cd6f 53#include "cli/cli-style.h"
d318976c 54
6dddc817 55#include "extension.h"
268a13a5 56#include "gdbsupport/pathstuff.h"
1845e254 57#include "gdbsupport/gdb_tilde_expand.h"
973817a3 58
6a83354a 59#ifdef TUI
ebcd3b23 60#include "tui/tui.h" /* For tui_active et.al. */
6a83354a
AC
61#endif
62
4b505b12 63#include <fcntl.h>
325fac50 64#include <algorithm>
a97e29d2 65#include <string>
4b505b12 66
0378c332
FN
67/* Prototypes for local utility functions */
68
06871ae8
PA
69static void print_sal_location (const symtab_and_line &sal);
70
6c5b2ebe 71static void ambiguous_line_spec (gdb::array_view<const symtab_and_line> sals,
e439fa14
PA
72 const char *format, ...)
73 ATTRIBUTE_PRINTF (2, 3);
f8eba3c6 74
6c5b2ebe 75static void filter_sals (std::vector<symtab_and_line> &);
f8eba3c6 76
d318976c 77\f
cc8dee1f 78/* See cli-cmds.h. */
883b9c6c 79unsigned int max_user_call_depth;
20f01a46 80
d318976c
FN
81/* Define all cmd_list_elements. */
82
83/* Chain containing all defined commands. */
84
85struct cmd_list_element *cmdlist;
86
87/* Chain containing all defined info subcommands. */
88
89struct cmd_list_element *infolist;
90
ebcd3b23 91/* Chain containing all defined enable subcommands. */
d318976c
FN
92
93struct cmd_list_element *enablelist;
94
ebcd3b23 95/* Chain containing all defined disable subcommands. */
d318976c
FN
96
97struct cmd_list_element *disablelist;
98
ebcd3b23 99/* Chain containing all defined stop subcommands. */
d318976c
FN
100
101struct cmd_list_element *stoplist;
102
ebcd3b23 103/* Chain containing all defined delete subcommands. */
d318976c
FN
104
105struct cmd_list_element *deletelist;
106
ebcd3b23 107/* Chain containing all defined detach subcommands. */
f73adfeb
AS
108
109struct cmd_list_element *detachlist;
110
ebcd3b23 111/* Chain containing all defined kill subcommands. */
2277426b
PA
112
113struct cmd_list_element *killlist;
114
d318976c
FN
115/* Chain containing all defined set subcommands */
116
117struct cmd_list_element *setlist;
118
119/* Chain containing all defined unset subcommands */
120
121struct cmd_list_element *unsetlist;
122
123/* Chain containing all defined show subcommands. */
124
125struct cmd_list_element *showlist;
126
127/* Chain containing all defined \"set history\". */
128
129struct cmd_list_element *sethistlist;
130
131/* Chain containing all defined \"show history\". */
132
133struct cmd_list_element *showhistlist;
134
135/* Chain containing all defined \"unset history\". */
136
137struct cmd_list_element *unsethistlist;
138
ebcd3b23 139/* Chain containing all defined maintenance subcommands. */
d318976c
FN
140
141struct cmd_list_element *maintenancelist;
142
ebcd3b23 143/* Chain containing all defined "maintenance info" subcommands. */
d318976c
FN
144
145struct cmd_list_element *maintenanceinfolist;
146
ebcd3b23 147/* Chain containing all defined "maintenance print" subcommands. */
d318976c
FN
148
149struct cmd_list_element *maintenanceprintlist;
150
27d41eac
YQ
151/* Chain containing all defined "maintenance check" subcommands. */
152
153struct cmd_list_element *maintenancechecklist;
154
50a5f187
AB
155/* Chain containing all defined "maintenance flush" subcommands. */
156
157struct cmd_list_element *maintenanceflushlist;
158
d318976c
FN
159struct cmd_list_element *setprintlist;
160
161struct cmd_list_element *showprintlist;
162
163struct cmd_list_element *setdebuglist;
164
165struct cmd_list_element *showdebuglist;
166
167struct cmd_list_element *setchecklist;
168
169struct cmd_list_element *showchecklist;
16026cd7
AS
170
171/* Command tracing state. */
172
173int source_verbose = 0;
491144b5 174bool trace_commands = false;
d318976c 175\f
973817a3
JB
176/* 'script-extension' option support. */
177
178static const char script_ext_off[] = "off";
179static const char script_ext_soft[] = "soft";
180static const char script_ext_strict[] = "strict";
181
40478521 182static const char *const script_ext_enums[] = {
973817a3
JB
183 script_ext_off,
184 script_ext_soft,
185 script_ext_strict,
186 NULL
187};
188
189static const char *script_ext_mode = script_ext_soft;
190\f
d318976c 191/* Utility used everywhere when at least one argument is needed and
ebcd3b23 192 none is supplied. */
d318976c
FN
193
194void
5b10184c 195error_no_arg (const char *why)
d318976c 196{
8a3fe4f8 197 error (_("Argument required (%s)."), why);
d318976c
FN
198}
199
4fd6c7e8
TT
200/* This implements the "info" prefix command. Normally such commands
201 are automatically handled by add_basic_prefix_cmd, but in this case
202 a separate command is used so that it can be hooked into by
203 gdb-gdb.gdb. */
204
205static void
206info_command (const char *arg, int from_tty)
207{
208 help_list (infolist, "info ", all_commands, gdb_stdout);
209}
210
fdbc9870
PA
211/* See cli/cli-cmds.h. */
212
213void
214with_command_1 (const char *set_cmd_prefix,
215 cmd_list_element *setlist, const char *args, int from_tty)
216{
26c957f1
PA
217 if (args == nullptr)
218 error (_("Missing arguments."));
219
fdbc9870
PA
220 const char *delim = strstr (args, "--");
221 const char *nested_cmd = nullptr;
222
223 if (delim == args)
224 error (_("Missing setting before '--' delimiter"));
225
226 if (delim == nullptr || *skip_spaces (&delim[2]) == '\0')
227 nested_cmd = repeat_previous ();
228
229 cmd_list_element *set_cmd = lookup_cmd (&args, setlist, set_cmd_prefix,
cf00cd6f 230 nullptr,
fdbc9870
PA
231 /*allow_unknown=*/ 0,
232 /*ignore_help_classes=*/ 1);
233 gdb_assert (set_cmd != nullptr);
234
235 if (set_cmd->var == nullptr)
236 error (_("Cannot use this setting with the \"with\" command"));
237
238 std::string temp_value
239 = (delim == nullptr ? args : std::string (args, delim - args));
240
241 if (nested_cmd == nullptr)
242 nested_cmd = skip_spaces (delim + 2);
243
244 std::string org_value = get_setshow_command_value_string (set_cmd);
245
246 /* Tweak the setting to the new temporary value. */
247 do_set_command (temp_value.c_str (), from_tty, set_cmd);
248
249 try
250 {
251 scoped_restore save_async = make_scoped_restore (&current_ui->async, 0);
252
253 /* Execute the nested command. */
254 execute_command (nested_cmd, from_tty);
255 }
256 catch (const gdb_exception &ex)
257 {
258 /* Restore the setting and rethrow. If restoring the setting
259 throws, swallow the new exception and warn. There's nothing
260 else we can reasonably do. */
261 try
262 {
263 do_set_command (org_value.c_str (), from_tty, set_cmd);
264 }
265 catch (const gdb_exception &ex2)
266 {
267 warning (_("Couldn't restore setting: %s"), ex2.what ());
268 }
269
270 throw;
271 }
272
273 /* Restore the setting. */
274 do_set_command (org_value.c_str (), from_tty, set_cmd);
275}
276
277/* See cli/cli-cmds.h. */
278
279void
280with_command_completer_1 (const char *set_cmd_prefix,
281 completion_tracker &tracker,
282 const char *text)
283{
284 tracker.set_use_custom_word_point (true);
285
286 const char *delim = strstr (text, "--");
287
288 /* If we're still not past the "--" delimiter, complete the "with"
289 command as if it was a "set" command. */
290 if (delim == text
291 || delim == nullptr
292 || !isspace (delim[-1])
293 || !(isspace (delim[2]) || delim[2] == '\0'))
294 {
295 std::string new_text = std::string (set_cmd_prefix) + text;
296 tracker.advance_custom_word_point_by (-(int) strlen (set_cmd_prefix));
297 complete_nested_command_line (tracker, new_text.c_str ());
298 return;
299 }
300
301 /* We're past the "--" delimiter. Complete on the sub command. */
302 const char *nested_cmd = skip_spaces (delim + 2);
303 tracker.advance_custom_word_point_by (nested_cmd - text);
304 complete_nested_command_line (tracker, nested_cmd);
305}
306
307/* The "with" command. */
308
309static void
310with_command (const char *args, int from_tty)
311{
312 with_command_1 ("set ", setlist, args, from_tty);
313}
314
315/* "with" command completer. */
316
317static void
318with_command_completer (struct cmd_list_element *ignore,
319 completion_tracker &tracker,
320 const char *text, const char * /*word*/)
321{
322 with_command_completer_1 ("set ", tracker, text);
323}
324
cf00cd6f
PW
325/* Look up the contents of TEXT as a command usable with default args.
326 Throws an error if no such command is found.
327 Return the found command and advances TEXT past the found command.
328 If the found command is a postfix command, set *PREFIX_CMD to its
329 prefix command. */
330
331static struct cmd_list_element *
332lookup_cmd_for_default_args (const char **text,
333 struct cmd_list_element **prefix_cmd)
334{
335 const char *orig_text = *text;
336 struct cmd_list_element *lcmd;
337
338 if (*text == nullptr || skip_spaces (*text) == nullptr)
339 error (_("ALIAS missing."));
340
341 /* We first use lookup_cmd to verify TEXT unambiguously identifies
342 a command. */
343 lcmd = lookup_cmd (text, cmdlist, "", NULL,
344 /*allow_unknown=*/ 0,
345 /*ignore_help_classes=*/ 1);
346
347 /* Note that we accept default args for prefix commands,
348 as a prefix command can also be a valid usable
349 command accepting some arguments.
350 For example, "thread apply" applies a command to a
351 list of thread ids, and is also the prefix command for
352 thread apply all. */
353
354 /* We have an unambiguous command for which default args
355 can be specified. What remains after having found LCMD
356 is either spaces, or the default args character. */
357
358 /* We then use lookup_cmd_composition to detect if the user
359 has specified an alias, and find the possible prefix_cmd
360 of cmd. */
361 struct cmd_list_element *alias, *cmd;
362 lookup_cmd_composition
363 (std::string (orig_text, *text - orig_text).c_str (),
364 &alias, prefix_cmd, &cmd);
365 gdb_assert (cmd != nullptr);
366 gdb_assert (cmd == lcmd);
367 if (alias != nullptr)
368 cmd = alias;
369
370 return cmd;
371}
372
d318976c
FN
373/* Provide documentation on command or list given by COMMAND. FROM_TTY
374 is ignored. */
375
d318976c 376static void
0b39b52e 377help_command (const char *command, int from_tty)
d318976c
FN
378{
379 help_cmd (command, gdb_stdout);
380}
381\f
eb3ff9a5 382
ef0b411a
GB
383/* Note: The "complete" command is used by Emacs to implement completion.
384 [Is that why this function writes output with *_unfiltered?] */
d318976c 385
d318976c 386static void
0b39b52e 387complete_command (const char *arg, int from_tty)
d318976c 388{
d318976c
FN
389 dont_repeat ();
390
ef0b411a
GB
391 if (max_completions == 0)
392 {
393 /* Only print this for non-mi frontends. An MI frontend may not
394 be able to handle this. */
112e8700 395 if (!current_uiout->is_mi_like_p ())
ef0b411a
GB
396 {
397 printf_unfiltered (_("max-completions is zero,"
398 " completion is disabled.\n"));
399 }
400 return;
401 }
402
d318976c
FN
403 if (arg == NULL)
404 arg = "";
d9b52655 405
6a2c1b87
PA
406 int quote_char = '\0';
407 const char *word;
408
6e035501 409 completion_result result = complete (arg, &word, &quote_char);
eb3ff9a5 410
eb3ff9a5
PA
411 if (result.number_matches != 0)
412 {
fb7806c7
TV
413 std::string arg_prefix (arg, word - arg);
414
eb3ff9a5
PA
415 if (result.number_matches == 1)
416 printf_unfiltered ("%s%s\n", arg_prefix.c_str (), result.match_list[0]);
417 else
83d31a92 418 {
eb3ff9a5
PA
419 result.sort_match_list ();
420
421 for (size_t i = 0; i < result.number_matches; i++)
83d31a92 422 {
eb3ff9a5
PA
423 printf_unfiltered ("%s%s",
424 arg_prefix.c_str (),
425 result.match_list[i + 1]);
6a2c1b87
PA
426 if (quote_char)
427 printf_unfiltered ("%c", quote_char);
eb3ff9a5 428 printf_unfiltered ("\n");
83d31a92 429 }
83d31a92
TT
430 }
431
eb3ff9a5 432 if (result.number_matches == max_completions)
ef0b411a 433 {
6a2c1b87 434 /* ARG_PREFIX and WORD are included in the output so that emacs
ef0b411a
GB
435 will include the message in the output. */
436 printf_unfiltered (_("%s%s %s\n"),
6a2c1b87 437 arg_prefix.c_str (), word,
ef0b411a
GB
438 get_max_completions_reached_message ());
439 }
d318976c
FN
440 }
441}
442
bbaca940
AC
443int
444is_complete_command (struct cmd_list_element *c)
d318976c 445{
bbaca940 446 return cmd_cfunc_eq (c, complete_command);
d318976c
FN
447}
448
d318976c 449static void
dede02ce 450show_version (const char *args, int from_tty)
d318976c 451{
c61b06a1 452 print_gdb_version (gdb_stdout, true);
d318976c 453 printf_filtered ("\n");
d318976c
FN
454}
455
6eaaf48b 456static void
dede02ce 457show_configuration (const char *args, int from_tty)
6eaaf48b
EZ
458{
459 print_gdb_configuration (gdb_stdout);
460}
461
d318976c
FN
462/* Handle the quit command. */
463
464void
0b39b52e 465quit_command (const char *args, int from_tty)
d318976c 466{
36cf1806
TT
467 int exit_code = 0;
468
469 /* An optional expression may be used to cause gdb to terminate with
470 the value of that expression. */
471 if (args)
472 {
473 struct value *val = parse_and_eval (args);
474
475 exit_code = (int) value_as_long (val);
476 }
477
d318976c 478 if (!quit_confirm ())
8a3fe4f8 479 error (_("Not confirmed."));
d5551862 480
2f9d54cf 481 query_if_trace_running (from_tty);
d5551862 482
36cf1806 483 quit_force (args ? &exit_code : NULL, from_tty);
d318976c
FN
484}
485
d318976c 486static void
0b39b52e 487pwd_command (const char *args, int from_tty)
d318976c
FN
488{
489 if (args)
8a3fe4f8 490 error (_("The \"pwd\" command does not take an argument: %s"), args);
43573013
SDJ
491
492 gdb::unique_xmalloc_ptr<char> cwd (getcwd (NULL, 0));
493
494 if (cwd == NULL)
bf1d7d9c 495 error (_("Error finding name of working directory: %s"),
dda83cd7 496 safe_strerror (errno));
d318976c 497
43573013 498 if (strcmp (cwd.get (), current_directory) != 0)
14309bb6
TT
499 printf_unfiltered (_("Working directory %ps\n (canonically %ps).\n"),
500 styled_string (file_name_style.style (),
501 current_directory),
502 styled_string (file_name_style.style (), cwd.get ()));
d318976c 503 else
14309bb6
TT
504 printf_unfiltered (_("Working directory %ps.\n"),
505 styled_string (file_name_style.style (),
506 current_directory));
d318976c
FN
507}
508
509void
5e93d4c6 510cd_command (const char *dir, int from_tty)
d318976c
FN
511{
512 int len;
513 /* Found something other than leading repetitions of "/..". */
514 int found_real_path;
515 char *p;
516
517 /* If the new directory is absolute, repeat is a no-op; if relative,
518 repeat might be useful but is more likely to be a mistake. */
519 dont_repeat ();
520
6eecf35f
TT
521 gdb::unique_xmalloc_ptr<char> dir_holder
522 (tilde_expand (dir != NULL ? dir : "~"));
523 dir = dir_holder.get ();
d318976c
FN
524
525 if (chdir (dir) < 0)
526 perror_with_name (dir);
527
c3690141 528#ifdef HAVE_DOS_BASED_FILE_SYSTEM
d318976c
FN
529 /* There's too much mess with DOSish names like "d:", "d:.",
530 "d:./foo" etc. Instead of having lots of special #ifdef'ed code,
531 simply get the canonicalized name of the current directory. */
43573013
SDJ
532 gdb::unique_xmalloc_ptr<char> cwd (getcwd (NULL, 0));
533 dir = cwd.get ();
d318976c
FN
534#endif
535
536 len = strlen (dir);
fe4e3eb8 537 if (IS_DIR_SEPARATOR (dir[len - 1]))
d318976c
FN
538 {
539 /* Remove the trailing slash unless this is a root directory
dda83cd7 540 (including a drive letter on non-Unix systems). */
d318976c 541 if (!(len == 1) /* "/" */
c3690141 542#ifdef HAVE_DOS_BASED_FILE_SYSTEM
fe4e3eb8 543 && !(len == 3 && dir[1] == ':') /* "d:/" */
d318976c
FN
544#endif
545 )
546 len--;
547 }
548
6eecf35f
TT
549 dir_holder.reset (savestring (dir, len));
550 if (IS_ABSOLUTE_PATH (dir_holder.get ()))
43573013
SDJ
551 {
552 xfree (current_directory);
553 current_directory = dir_holder.release ();
554 }
d318976c
FN
555 else
556 {
fe4e3eb8 557 if (IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]))
6eecf35f
TT
558 current_directory = concat (current_directory, dir_holder.get (),
559 (char *) NULL);
d318976c 560 else
1754f103 561 current_directory = concat (current_directory, SLASH_STRING,
6eecf35f 562 dir_holder.get (), (char *) NULL);
d318976c
FN
563 }
564
565 /* Now simplify any occurrences of `.' and `..' in the pathname. */
566
567 found_real_path = 0;
568 for (p = current_directory; *p;)
569 {
fe4e3eb8
EZ
570 if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.'
571 && (p[2] == 0 || IS_DIR_SEPARATOR (p[2])))
b2a3b509 572 memmove (p, p + 2, strlen (p + 2) + 1);
fe4e3eb8
EZ
573 else if (IS_DIR_SEPARATOR (p[0]) && p[1] == '.' && p[2] == '.'
574 && (p[3] == 0 || IS_DIR_SEPARATOR (p[3])))
d318976c
FN
575 {
576 if (found_real_path)
577 {
578 /* Search backwards for the directory just before the "/.."
dda83cd7 579 and obliterate it and the "/..". */
d318976c 580 char *q = p;
cdb27c12 581
fe4e3eb8 582 while (q != current_directory && !IS_DIR_SEPARATOR (q[-1]))
d318976c
FN
583 --q;
584
585 if (q == current_directory)
586 /* current_directory is
587 a relative pathname ("can't happen"--leave it alone). */
588 ++p;
589 else
590 {
b2a3b509 591 memmove (q - 1, p + 3, strlen (p + 3) + 1);
d318976c
FN
592 p = q - 1;
593 }
594 }
595 else
ebcd3b23
MS
596 /* We are dealing with leading repetitions of "/..", for
597 example "/../..", which is the Mach super-root. */
d318976c
FN
598 p += 3;
599 }
600 else
601 {
602 found_real_path = 1;
603 ++p;
604 }
605 }
606
607 forget_cached_source_info ();
608
609 if (from_tty)
610 pwd_command ((char *) 0, 1);
611}
612\f
973817a3
JB
613/* Show the current value of the 'script-extension' option. */
614
615static void
616show_script_ext_mode (struct ui_file *file, int from_tty,
617 struct cmd_list_element *c, const char *value)
d318976c 618{
9a2b4c1b
MS
619 fprintf_filtered (file,
620 _("Script filename extension recognition is \"%s\".\n"),
973817a3
JB
621 value);
622}
623
3f7b2faa
DE
624/* Try to open SCRIPT_FILE.
625 If successful, the full path name is stored in *FULL_PATHP,
ed166945
TT
626 and the stream is returned.
627 If not successful, return NULL; errno is set for the last file
3f7b2faa
DE
628 we tried to open.
629
630 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
f5b95b50 631 search for it in the source search path. */
3f7b2faa 632
ed166945
TT
633gdb::optional<open_script>
634find_and_open_script (const char *script_file, int search_path)
973817a3 635{
4b505b12 636 int fd;
24b9144d 637 openp_flags search_flags = OPF_TRY_CWD_FIRST | OPF_RETURN_REALPATH;
ed166945 638 gdb::optional<open_script> opened;
d318976c 639
ee0c3293 640 gdb::unique_xmalloc_ptr<char> file (tilde_expand (script_file));
d318976c 641
3f7b2faa
DE
642 if (search_path)
643 search_flags |= OPF_SEARCH_IN_PATH;
4b505b12 644
3f7b2faa
DE
645 /* Search for and open 'file' on the search path used for source
646 files. Put the full location in *FULL_PATHP. */
e0cc99a6 647 gdb::unique_xmalloc_ptr<char> full_path;
3f7b2faa 648 fd = openp (source_path, search_flags,
e0cc99a6 649 file.get (), O_RDONLY, &full_path);
4b505b12
AS
650
651 if (fd == -1)
ee0c3293 652 return opened;
973817a3 653
ed166945
TT
654 FILE *result = fdopen (fd, FOPEN_RT);
655 if (result == NULL)
77a35dd8
JK
656 {
657 int save_errno = errno;
658
659 close (fd);
77a35dd8 660 errno = save_errno;
77a35dd8 661 }
ed166945
TT
662 else
663 opened.emplace (gdb_file_up (result), std::move (full_path));
77a35dd8 664
ed166945 665 return opened;
973817a3
JB
666}
667
1a70ae97
DE
668/* Load script FILE, which has already been opened as STREAM.
669 FILE_TO_OPEN is the form of FILE to use if one needs to open the file.
670 This is provided as FILE may have been found via the source search path.
671 An important thing to note here is that FILE may be a symlink to a file
672 with a different or non-existing suffix, and thus one cannot infer the
673 extension language from FILE_TO_OPEN. */
973817a3 674
3f7b2faa 675static void
1a70ae97
DE
676source_script_from_stream (FILE *stream, const char *file,
677 const char *file_to_open)
3f7b2faa 678{
6dddc817 679 if (script_ext_mode != script_ext_off)
973817a3 680 {
6dddc817
DE
681 const struct extension_language_defn *extlang
682 = get_ext_lang_of_file (file);
683
684 if (extlang != NULL)
973817a3 685 {
6dddc817
DE
686 if (ext_lang_present_p (extlang))
687 {
688 script_sourcer_func *sourcer
689 = ext_lang_script_sourcer (extlang);
690
691 gdb_assert (sourcer != NULL);
1a70ae97 692 sourcer (extlang, stream, file_to_open);
6dddc817
DE
693 return;
694 }
695 else if (script_ext_mode == script_ext_soft)
696 {
697 /* Assume the file is a gdb script.
698 This is handled below. */
699 }
700 else
701 throw_ext_lang_unsupported (extlang);
973817a3
JB
702 }
703 }
6dddc817
DE
704
705 script_from_file (stream, file);
3f7b2faa 706}
d318976c 707
3f7b2faa
DE
708/* Worker to perform the "source" command.
709 Load script FILE.
710 If SEARCH_PATH is non-zero, and the file isn't found in cwd,
711 search for it in the source search path. */
712
713static void
714source_script_with_search (const char *file, int from_tty, int search_path)
715{
3f7b2faa
DE
716
717 if (file == NULL || *file == 0)
718 error (_("source command requires file name of file to source."));
719
ed166945
TT
720 gdb::optional<open_script> opened = find_and_open_script (file, search_path);
721 if (!opened)
3f7b2faa 722 {
d234ef5c 723 /* The script wasn't found, or was otherwise inaccessible.
dda83cd7 724 If the source command was invoked interactively, throw an
ebcd3b23 725 error. Otherwise (e.g. if it was invoked by a script),
7c647d61 726 just emit a warning, rather than cause an error. */
3f7b2faa
DE
727 if (from_tty)
728 perror_with_name (file);
729 else
7c647d61
JB
730 {
731 perror_warning_with_name (file);
732 return;
733 }
3f7b2faa
DE
734 }
735
d234ef5c
DE
736 /* The python support reopens the file, so we need to pass full_path here
737 in case the file was found on the search path. It's useful to do this
738 anyway so that error messages show the actual file used. But only do
739 this if we (may have) used search_path, as printing the full path in
740 errors for the non-search case can be more noise than signal. */
1845e254
AB
741 const char *file_to_open;
742 gdb::unique_xmalloc_ptr<char> tilde_expanded_file;
743 if (search_path)
744 file_to_open = opened->full_path.get ();
745 else
746 {
747 tilde_expanded_file = gdb_tilde_expand_up (file);
748 file_to_open = tilde_expanded_file.get ();
749 }
750 source_script_from_stream (opened->stream.get (), file, file_to_open);
d318976c
FN
751}
752
3f7b2faa
DE
753/* Wrapper around source_script_with_search to export it to main.c
754 for use in loading .gdbinit scripts. */
755
756void
50dd9793 757source_script (const char *file, int from_tty)
3f7b2faa
DE
758{
759 source_script_with_search (file, from_tty, 0);
760}
761
16026cd7 762static void
dede02ce 763source_command (const char *args, int from_tty)
16026cd7 764{
dede02ce 765 const char *file = args;
3f7b2faa 766 int search_path = 0;
16026cd7 767
2ec845e7 768 scoped_restore save_source_verbose = make_scoped_restore (&source_verbose);
16026cd7
AS
769
770 /* -v causes the source command to run in verbose mode.
3f7b2faa
DE
771 -s causes the file to be searched in the source search path,
772 even if the file name contains a '/'.
16026cd7
AS
773 We still have to be able to handle filenames with spaces in a
774 backward compatible way, so buildargv is not appropriate. */
775
776 if (args)
777 {
3f7b2faa 778 while (args[0] != '\0')
16026cd7 779 {
ebcd3b23
MS
780 /* Make sure leading white space does not break the
781 comparisons. */
529480d0 782 args = skip_spaces (args);
3f7b2faa
DE
783
784 if (args[0] != '-')
785 break;
786
787 if (args[1] == 'v' && isspace (args[2]))
788 {
789 source_verbose = 1;
790
791 /* Skip passed -v. */
792 args = &args[3];
793 }
794 else if (args[1] == 's' && isspace (args[2]))
795 {
796 search_path = 1;
16026cd7 797
3f7b2faa
DE
798 /* Skip passed -s. */
799 args = &args[3];
800 }
801 else
802 break;
16026cd7 803 }
3f7b2faa 804
529480d0 805 file = skip_spaces (args);
16026cd7
AS
806 }
807
3f7b2faa 808 source_script_with_search (file, from_tty, search_path);
16026cd7
AS
809}
810
811
d318976c 812static void
0b39b52e 813echo_command (const char *text, int from_tty)
d318976c 814{
d7561cbb 815 const char *p = text;
d5b5ac79 816 int c;
d318976c
FN
817
818 if (text)
819 while ((c = *p++) != '\0')
820 {
821 if (c == '\\')
822 {
823 /* \ at end of argument is used after spaces
824 so they won't be lost. */
825 if (*p == 0)
826 return;
827
f870a310 828 c = parse_escape (get_current_arch (), &p);
d318976c
FN
829 if (c >= 0)
830 printf_filtered ("%c", c);
831 }
832 else
833 printf_filtered ("%c", c);
834 }
835
ef1dfa36
TT
836 reset_terminal_style (gdb_stdout);
837
d318976c
FN
838 /* Force this output to appear now. */
839 wrap_here ("");
840 gdb_flush (gdb_stdout);
841}
842
947d3946
PW
843/* Sets the last launched shell command convenience variables based on
844 EXIT_STATUS. */
845
846static void
847exit_status_set_internal_vars (int exit_status)
848{
849 struct internalvar *var_code = lookup_internalvar ("_shell_exitcode");
850 struct internalvar *var_signal = lookup_internalvar ("_shell_exitsignal");
851
852 clear_internalvar (var_code);
853 clear_internalvar (var_signal);
854 if (WIFEXITED (exit_status))
855 set_internalvar_integer (var_code, WEXITSTATUS (exit_status));
559e7e50
EZ
856#ifdef __MINGW32__
857 else if (WIFSIGNALED (exit_status) && WTERMSIG (exit_status) == -1)
858 {
859 /* The -1 condition can happen on MinGW, if we don't recognize
860 the fatal exception code encoded in the exit status; see
861 gdbsupport/gdb_wait.c. We don't want to lose information in
862 the exit status in that case. Record it as a normal exit
863 with the full exit status, including the higher 0xC0000000
864 bits. */
865 set_internalvar_integer (var_code, exit_status);
866 }
867#endif
947d3946
PW
868 else if (WIFSIGNALED (exit_status))
869 set_internalvar_integer (var_signal, WTERMSIG (exit_status));
870 else
422186a9 871 warning (_("unexpected shell command exit status %d"), exit_status);
947d3946
PW
872}
873
d318976c 874static void
be47f9e8 875shell_escape (const char *arg, int from_tty)
d318976c 876{
9b265ec2
MM
877#if defined(CANT_FORK) || \
878 (!defined(HAVE_WORKING_VFORK) && !defined(HAVE_WORKING_FORK))
d318976c
FN
879 /* If ARG is NULL, they want an inferior shell, but `system' just
880 reports if the shell is available when passed a NULL arg. */
881 int rc = system (arg ? arg : "");
882
883 if (!arg)
884 arg = "inferior shell";
885
886 if (rc == -1)
c119e040
TT
887 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", arg,
888 safe_strerror (errno));
d318976c 889 else if (rc)
c119e040 890 fprintf_unfiltered (gdb_stderr, "%s exited with status %d\n", arg, rc);
2584159e 891#ifdef GLOBAL_CURDIR
ebcd3b23
MS
892 /* Make sure to return to the directory GDB thinks it is, in case
893 the shell command we just ran changed it. */
d318976c
FN
894 chdir (current_directory);
895#endif
c17ace43 896 exit_status_set_internal_vars (rc);
d318976c 897#else /* Can fork. */
5be4dfca 898 int status, pid;
d318976c 899
325ed089 900 if ((pid = vfork ()) == 0)
d318976c 901 {
974e6844 902 const char *p, *user_shell = get_shell ();
30e94205 903
614c279d
TT
904 close_most_fds ();
905
ebcd3b23 906 /* Get the name of the shell for arg0. */
9f37bbcc 907 p = lbasename (user_shell);
30e94205 908
d318976c 909 if (!arg)
36662fde 910 execl (user_shell, p, (char *) 0);
d318976c 911 else
36662fde 912 execl (user_shell, p, "-c", arg, (char *) 0);
d318976c
FN
913
914 fprintf_unfiltered (gdb_stderr, "Cannot execute %s: %s\n", user_shell,
915 safe_strerror (errno));
d318976c
FN
916 _exit (0177);
917 }
918
919 if (pid != -1)
5be4dfca 920 waitpid (pid, &status, 0);
d318976c 921 else
8a3fe4f8 922 error (_("Fork failed"));
947d3946 923 exit_status_set_internal_vars (status);
d318976c
FN
924#endif /* Can fork. */
925}
926
be47f9e8
PA
927/* Implementation of the "shell" command. */
928
929static void
0b39b52e 930shell_command (const char *arg, int from_tty)
be47f9e8
PA
931{
932 shell_escape (arg, from_tty);
933}
934
0378c332 935static void
0b39b52e 936edit_command (const char *arg, int from_tty)
0378c332 937{
0378c332
FN
938 struct symtab_and_line sal;
939 struct symbol *sym;
a121b7c1 940 const char *editor;
0b0865da
TT
941 char *p;
942 const char *fn;
0378c332 943
d5529a84 944 /* Pull in the current default source line if necessary. */
0378c332 945 if (arg == 0)
53cb0458
FN
946 {
947 set_default_source_symtab_and_line ();
948 sal = get_current_source_symtab_and_line ();
949 }
0378c332 950
ebcd3b23 951 /* Bare "edit" edits file with present line. */
0378c332
FN
952
953 if (arg == 0)
954 {
955 if (sal.symtab == 0)
8a3fe4f8 956 error (_("No default source file yet."));
0378c332
FN
957 sal.line += get_lines_to_list () / 2;
958 }
959 else
960 {
f2fc3015 961 const char *arg1;
0378c332 962
f00aae0f 963 /* Now should only be one argument -- decode it in SAL. */
0378c332 964 arg1 = arg;
ffc2605c
TT
965 event_location_up location = string_to_event_location (&arg1,
966 current_language);
6c5b2ebe
PA
967 std::vector<symtab_and_line> sals = decode_line_1 (location.get (),
968 DECODE_LINE_LIST_MODE,
969 NULL, NULL, 0);
0378c332 970
6c5b2ebe
PA
971 filter_sals (sals);
972 if (sals.empty ())
d5529a84
TT
973 {
974 /* C++ */
975 return;
976 }
6c5b2ebe 977 if (sals.size () > 1)
d5529a84 978 {
6c5b2ebe 979 ambiguous_line_spec (sals,
e439fa14 980 _("Specified line is ambiguous:\n"));
d5529a84
TT
981 return;
982 }
0378c332 983
6c5b2ebe 984 sal = sals[0];
0378c332
FN
985
986 if (*arg1)
dda83cd7 987 error (_("Junk at end of line specification."));
0378c332 988
ebcd3b23 989 /* If line was specified by address, first print exactly which
dda83cd7
SM
990 line, and which file. In this case, sal.symtab == 0 means
991 address is outside of all known source files, not that user
992 failed to give a filename. */
0378c332 993 if (*arg == '*')
dda83cd7 994 {
5af949e3 995 struct gdbarch *gdbarch;
cdb27c12 996
dda83cd7 997 if (sal.symtab == 0)
8a3fe4f8 998 error (_("No source file for address %s."),
2b69941d 999 paddress (get_current_arch (), sal.pc));
5af949e3 1000
08feed99 1001 gdbarch = SYMTAB_OBJFILE (sal.symtab)->arch ();
dda83cd7
SM
1002 sym = find_pc_function (sal.pc);
1003 if (sym)
5af949e3
UW
1004 printf_filtered ("%s is in %s (%s:%d).\n",
1005 paddress (gdbarch, sal.pc),
987012b8 1006 sym->print_name (),
05cba821
JK
1007 symtab_to_filename_for_display (sal.symtab),
1008 sal.line);
dda83cd7 1009 else
5af949e3
UW
1010 printf_filtered ("%s is at %s:%d.\n",
1011 paddress (gdbarch, sal.pc),
05cba821
JK
1012 symtab_to_filename_for_display (sal.symtab),
1013 sal.line);
dda83cd7 1014 }
0378c332 1015
ebcd3b23 1016 /* If what was given does not imply a symtab, it must be an
dda83cd7 1017 undebuggable symbol which means no source code. */
0378c332
FN
1018
1019 if (sal.symtab == 0)
dda83cd7 1020 error (_("No line number known for %s."), arg);
0378c332
FN
1021 }
1022
081bca4d
TT
1023 if ((editor = getenv ("EDITOR")) == NULL)
1024 editor = "/bin/ex";
a955ca71 1025
f35a17b5 1026 fn = symtab_to_fullname (sal.symtab);
0378c332 1027
a955ca71
EZ
1028 /* Quote the file name, in case it has whitespace or other special
1029 characters. */
1030 p = xstrprintf ("%s +%d \"%s\"", editor, sal.line, fn);
d5529a84
TT
1031 shell_escape (p, from_tty);
1032 xfree (p);
0378c332
FN
1033}
1034
5f4ba3e7
PA
1035/* The options for the "pipe" command. */
1036
1037struct pipe_cmd_opts
1038{
1039 /* For "-d". */
1040 char *delimiter = nullptr;
1041
1042 ~pipe_cmd_opts ()
1043 {
1044 xfree (delimiter);
1045 }
1046};
1047
1048static const gdb::option::option_def pipe_cmd_option_defs[] = {
1049
1050 gdb::option::string_option_def<pipe_cmd_opts> {
1051 "d",
1052 [] (pipe_cmd_opts *opts) { return &opts->delimiter; },
1053 nullptr,
1054 N_("Indicates to use the specified delimiter string to separate\n\
1055COMMAND from SHELL_COMMAND, in alternative to |. This is useful in\n\
1056case COMMAND contains a | character."),
1057 },
1058
1059};
1060
1061/* Create an option_def_group for the "pipe" command's options, with
1062 OPTS as context. */
1063
1064static inline gdb::option::option_def_group
1065make_pipe_cmd_options_def_group (pipe_cmd_opts *opts)
1066{
1067 return {{pipe_cmd_option_defs}, opts};
1068}
1069
947d3946
PW
1070/* Implementation of the "pipe" command. */
1071
1072static void
1073pipe_command (const char *arg, int from_tty)
1074{
5f4ba3e7 1075 pipe_cmd_opts opts;
947d3946 1076
5f4ba3e7
PA
1077 auto grp = make_pipe_cmd_options_def_group (&opts);
1078 gdb::option::process_options
1079 (&arg, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND, grp);
1080
1081 const char *delim = "|";
1082 if (opts.delimiter != nullptr)
1083 delim = opts.delimiter;
947d3946
PW
1084
1085 const char *command = arg;
1086 if (command == nullptr)
1087 error (_("Missing COMMAND"));
1088
5f4ba3e7 1089 arg = strstr (arg, delim);
947d3946
PW
1090
1091 if (arg == nullptr)
1092 error (_("Missing delimiter before SHELL_COMMAND"));
1093
1094 std::string gdb_cmd (command, arg - command);
1095
5f4ba3e7 1096 arg += strlen (delim); /* Skip the delimiter. */
947d3946
PW
1097
1098 if (gdb_cmd.empty ())
fdbc9870 1099 gdb_cmd = repeat_previous ();
947d3946
PW
1100
1101 const char *shell_command = skip_spaces (arg);
1102 if (*shell_command == '\0')
1103 error (_("Missing SHELL_COMMAND"));
1104
1105 FILE *to_shell_command = popen (shell_command, "w");
1106
1107 if (to_shell_command == nullptr)
1108 error (_("Error launching \"%s\""), shell_command);
1109
1110 try
1111 {
1112 stdio_file pipe_file (to_shell_command);
1113
1114 execute_command_to_ui_file (&pipe_file, gdb_cmd.c_str (), from_tty);
1115 }
1116 catch (...)
1117 {
1118 pclose (to_shell_command);
1119 throw;
1120 }
1121
1122 int exit_status = pclose (to_shell_command);
1123
1124 if (exit_status < 0)
1125 error (_("shell command \"%s\" failed: %s"), shell_command,
dda83cd7 1126 safe_strerror (errno));
947d3946
PW
1127 exit_status_set_internal_vars (exit_status);
1128}
1129
5f4ba3e7
PA
1130/* Completer for the pipe command. */
1131
1132static void
1133pipe_command_completer (struct cmd_list_element *ignore,
1134 completion_tracker &tracker,
1135 const char *text, const char *word_ignored)
1136{
1137 pipe_cmd_opts opts;
1138
1139 const char *org_text = text;
1140 auto grp = make_pipe_cmd_options_def_group (&opts);
1141 if (gdb::option::complete_options
1142 (tracker, &text, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND, grp))
1143 return;
1144
1145 const char *delimiter = "|";
1146 if (opts.delimiter != nullptr)
1147 delimiter = opts.delimiter;
1148
1149 /* Check if we're past option values already. */
1150 if (text > org_text && !isspace (text[-1]))
1151 return;
1152
1153 const char *delim = strstr (text, delimiter);
1154
1155 /* If we're still not past the delimiter, complete the gdb
1156 command. */
1157 if (delim == nullptr || delim == text)
1158 {
1159 complete_nested_command_line (tracker, text);
1160 return;
1161 }
1162
1163 /* We're past the delimiter. What follows is a shell command, which
1164 we don't know how to complete. */
1165}
1166
0378c332 1167static void
0b39b52e 1168list_command (const char *arg, int from_tty)
0378c332 1169{
0378c332 1170 struct symbol *sym;
f2fc3015 1171 const char *arg1;
0378c332
FN
1172 int no_end = 1;
1173 int dummy_end = 0;
1174 int dummy_beg = 0;
1175 int linenum_beg = 0;
0b39b52e 1176 const char *p;
0378c332 1177
ebcd3b23 1178 /* Pull in the current default source line if necessary. */
a0def019 1179 if (arg == NULL || ((arg[0] == '+' || arg[0] == '-') && arg[1] == '\0'))
53cb0458
FN
1180 {
1181 set_default_source_symtab_and_line ();
51abb421 1182 symtab_and_line cursal = get_current_source_symtab_and_line ();
5166082f
PA
1183
1184 /* If this is the first "list" since we've set the current
1185 source line, center the listing around that line. */
1186 if (get_first_line_listed () == 0)
1187 {
1188 int first;
1189
325fac50 1190 first = std::max (cursal.line - get_lines_to_list () / 2, 1);
5166082f
PA
1191
1192 /* A small special case --- if listing backwards, and we
1193 should list only one line, list the preceding line,
1194 instead of the exact line we've just shown after e.g.,
1195 stopping for a breakpoint. */
1196 if (arg != NULL && arg[0] == '-'
1197 && get_lines_to_list () == 1 && first > 1)
1198 first -= 1;
1199
0e2a2133 1200 print_source_lines (cursal.symtab, source_lines_range (first), 0);
5166082f 1201 }
0378c332 1202
1a48ce76 1203 /* "l" or "l +" lists next ten lines. */
a0def019 1204 else if (arg == NULL || arg[0] == '+')
0e2a2133
AB
1205 print_source_lines (cursal.symtab,
1206 source_lines_range (cursal.line), 0);
0378c332 1207
1a48ce76
AB
1208 /* "l -" lists previous ten lines, the ones before the ten just
1209 listed. */
a0def019 1210 else if (arg[0] == '-')
3b2464a8
AB
1211 {
1212 if (get_first_line_listed () == 1)
1213 error (_("Already at the start of %s."),
1214 symtab_to_filename_for_display (cursal.symtab));
0e2a2133
AB
1215 source_lines_range range (get_first_line_listed (),
1216 source_lines_range::BACKWARD);
1217 print_source_lines (cursal.symtab, range, 0);
3b2464a8 1218 }
0378c332 1219
0378c332
FN
1220 return;
1221 }
1222
1223 /* Now if there is only one argument, decode it in SAL
1224 and set NO_END.
1225 If there are two arguments, decode them in SAL and SAL_END
1226 and clear NO_END; however, if one of the arguments is blank,
1227 set DUMMY_BEG or DUMMY_END to record that fact. */
1228
1229 if (!have_full_symbols () && !have_partial_symbols ())
8a3fe4f8 1230 error (_("No symbol table is loaded. Use the \"file\" command."));
0378c332 1231
6c5b2ebe 1232 std::vector<symtab_and_line> sals;
51abb421 1233 symtab_and_line sal, sal_end;
6c5b2ebe 1234
0378c332
FN
1235 arg1 = arg;
1236 if (*arg1 == ',')
1237 dummy_beg = 1;
1238 else
1239 {
ffc2605c
TT
1240 event_location_up location = string_to_event_location (&arg1,
1241 current_language);
1242 sals = decode_line_1 (location.get (), DECODE_LINE_LIST_MODE,
1243 NULL, NULL, 0);
6c5b2ebe
PA
1244 filter_sals (sals);
1245 if (sals.empty ())
f00aae0f
KS
1246 {
1247 /* C++ */
f00aae0f
KS
1248 return;
1249 }
0378c332 1250
6c5b2ebe 1251 sal = sals[0];
0378c332
FN
1252 }
1253
1254 /* Record whether the BEG arg is all digits. */
1255
1256 for (p = arg; p != arg1 && *p >= '0' && *p <= '9'; p++);
1257 linenum_beg = (p == arg1);
1258
e439fa14
PA
1259 /* Save the range of the first argument, in case we need to let the
1260 user know it was ambiguous. */
1261 const char *beg = arg;
1262 size_t beg_len = arg1 - beg;
1263
0378c332
FN
1264 while (*arg1 == ' ' || *arg1 == '\t')
1265 arg1++;
1266 if (*arg1 == ',')
1267 {
1268 no_end = 0;
6c5b2ebe 1269 if (sals.size () > 1)
0d999a6e 1270 {
6c5b2ebe 1271 ambiguous_line_spec (sals,
e439fa14
PA
1272 _("Specified first line '%.*s' is ambiguous:\n"),
1273 (int) beg_len, beg);
0d999a6e
ZZ
1274 return;
1275 }
0378c332
FN
1276 arg1++;
1277 while (*arg1 == ' ' || *arg1 == '\t')
1278 arg1++;
1279 if (*arg1 == 0)
1280 dummy_end = 1;
1281 else
1282 {
e439fa14
PA
1283 /* Save the last argument, in case we need to let the user
1284 know it was ambiguous. */
1285 const char *end_arg = arg1;
1286
ffc2605c
TT
1287 event_location_up location
1288 = string_to_event_location (&arg1, current_language);
f00aae0f 1289
6c5b2ebe
PA
1290 std::vector<symtab_and_line> sals_end
1291 = (dummy_beg
1292 ? decode_line_1 (location.get (), DECODE_LINE_LIST_MODE,
1293 NULL, NULL, 0)
1294 : decode_line_1 (location.get (), DECODE_LINE_LIST_MODE,
1295 NULL, sal.symtab, sal.line));
1296
1297 filter_sals (sals_end);
1298 if (sals_end.empty ())
1299 return;
1300 if (sals_end.size () > 1)
0d999a6e 1301 {
6c5b2ebe 1302 ambiguous_line_spec (sals_end,
e439fa14
PA
1303 _("Specified last line '%s' is ambiguous:\n"),
1304 end_arg);
0378c332
FN
1305 return;
1306 }
6c5b2ebe 1307 sal_end = sals_end[0];
0378c332
FN
1308 }
1309 }
1310
1311 if (*arg1)
8a3fe4f8 1312 error (_("Junk at end of line specification."));
0378c332
FN
1313
1314 if (!no_end && !dummy_beg && !dummy_end
1315 && sal.symtab != sal_end.symtab)
e439fa14 1316 error (_("Specified first and last lines are in different files."));
0378c332 1317 if (dummy_beg && dummy_end)
8a3fe4f8 1318 error (_("Two empty args do not say what lines to list."));
0378c332 1319
ebcd3b23 1320 /* If line was specified by address,
0378c332 1321 first print exactly which line, and which file.
ebcd3b23
MS
1322
1323 In this case, sal.symtab == 0 means address is outside of all
1324 known source files, not that user failed to give a filename. */
0378c332
FN
1325 if (*arg == '*')
1326 {
5af949e3 1327 struct gdbarch *gdbarch;
cdb27c12 1328
0378c332 1329 if (sal.symtab == 0)
8a3fe4f8 1330 error (_("No source file for address %s."),
2b69941d 1331 paddress (get_current_arch (), sal.pc));
5af949e3 1332
08feed99 1333 gdbarch = SYMTAB_OBJFILE (sal.symtab)->arch ();
0378c332
FN
1334 sym = find_pc_function (sal.pc);
1335 if (sym)
50ee7535 1336 printf_filtered ("%s is in %s (%s:%d).\n",
5af949e3 1337 paddress (gdbarch, sal.pc),
987012b8 1338 sym->print_name (),
05cba821 1339 symtab_to_filename_for_display (sal.symtab), sal.line);
0378c332 1340 else
5af949e3
UW
1341 printf_filtered ("%s is at %s:%d.\n",
1342 paddress (gdbarch, sal.pc),
05cba821 1343 symtab_to_filename_for_display (sal.symtab), sal.line);
0378c332
FN
1344 }
1345
ebcd3b23
MS
1346 /* If line was not specified by just a line number, and it does not
1347 imply a symtab, it must be an undebuggable symbol which means no
1348 source code. */
0378c332
FN
1349
1350 if (!linenum_beg && sal.symtab == 0)
8a3fe4f8 1351 error (_("No line number known for %s."), arg);
0378c332
FN
1352
1353 /* If this command is repeated with RET,
1354 turn it into the no-arg variant. */
1355
1356 if (from_tty)
85c4be7c 1357 set_repeat_arguments ("");
0378c332
FN
1358
1359 if (dummy_beg && sal_end.symtab == 0)
8a3fe4f8 1360 error (_("No default source file yet. Do \"help list\"."));
0378c332 1361 if (dummy_beg)
0e2a2133
AB
1362 {
1363 source_lines_range range (sal_end.line + 1,
1364 source_lines_range::BACKWARD);
1365 print_source_lines (sal_end.symtab, range, 0);
1366 }
0378c332 1367 else if (sal.symtab == 0)
8a3fe4f8 1368 error (_("No default source file yet. Do \"help list\"."));
0378c332
FN
1369 else if (no_end)
1370 {
6c5b2ebe 1371 for (int i = 0; i < sals.size (); i++)
0d999a6e 1372 {
6c5b2ebe 1373 sal = sals[i];
0d999a6e
ZZ
1374 int first_line = sal.line - get_lines_to_list () / 2;
1375 if (first_line < 1)
1376 first_line = 1;
6c5b2ebe 1377 if (sals.size () > 1)
06871ae8 1378 print_sal_location (sal);
0e2a2133 1379 print_source_lines (sal.symtab, source_lines_range (first_line), 0);
0d999a6e 1380 }
0378c332 1381 }
0e2a2133
AB
1382 else if (dummy_end)
1383 print_source_lines (sal.symtab, source_lines_range (sal.line), 0);
0378c332 1384 else
0e2a2133
AB
1385 print_source_lines (sal.symtab,
1386 source_lines_range (sal.line, (sal_end.line + 1)),
0378c332
FN
1387 0);
1388}
1389
d14508fe
DE
1390/* Subroutine of disassemble_command to simplify it.
1391 Perform the disassembly.
1392 NAME is the name of the function if known, or NULL.
1393 [LOW,HIGH) are the range of addresses to disassemble.
e9480230
KB
1394 BLOCK is the block to disassemble; it needs to be provided
1395 when non-contiguous blocks are disassembled; otherwise
1396 it can be NULL.
d14508fe
DE
1397 MIXED is non-zero to print source with the assembler. */
1398
1399static void
13274fc3 1400print_disassembly (struct gdbarch *gdbarch, const char *name,
9a24775b 1401 CORE_ADDR low, CORE_ADDR high,
e9480230 1402 const struct block *block,
9a24775b 1403 gdb_disassembly_flags flags)
d14508fe
DE
1404{
1405#if defined(TUI)
f9ba974d
TT
1406 if (tui_is_window_visible (DISASSEM_WIN))
1407 tui_show_assembly (gdbarch, low);
1408 else
d14508fe
DE
1409#endif
1410 {
b2701685 1411 printf_filtered (_("Dump of assembler code "));
d14508fe 1412 if (name != NULL)
b2701685
TT
1413 printf_filtered (_("for function %ps:\n"),
1414 styled_string (function_name_style.style (), name));
e9480230 1415 if (block == nullptr || BLOCK_CONTIGUOUS_P (block))
dda83cd7 1416 {
e9480230 1417 if (name == NULL)
b2701685
TT
1418 printf_filtered (_("from %ps to %ps:\n"),
1419 styled_string (address_style.style (),
1420 paddress (gdbarch, low)),
1421 styled_string (address_style.style (),
1422 paddress (gdbarch, high)));
d14508fe 1423
e9480230
KB
1424 /* Dump the specified range. */
1425 gdb_disassembly (gdbarch, current_uiout, flags, -1, low, high);
1426 }
1427 else
dda83cd7 1428 {
e9480230
KB
1429 for (int i = 0; i < BLOCK_NRANGES (block); i++)
1430 {
b926417a
TT
1431 CORE_ADDR range_low = BLOCK_RANGE_START (block, i);
1432 CORE_ADDR range_high = BLOCK_RANGE_END (block, i);
b2701685
TT
1433 printf_filtered (_("Address range %ps to %ps:\n"),
1434 styled_string (address_style.style (),
1435 paddress (gdbarch, range_low)),
1436 styled_string (address_style.style (),
1437 paddress (gdbarch, range_high)));
b926417a
TT
1438 gdb_disassembly (gdbarch, current_uiout, flags, -1,
1439 range_low, range_high);
e9480230
KB
1440 }
1441 }
b2701685 1442 printf_filtered (_("End of assembler dump.\n"));
d14508fe 1443 }
d14508fe
DE
1444}
1445
1446/* Subroutine of disassemble_command to simplify it.
9c419145 1447 Print a disassembly of the current function according to FLAGS. */
d14508fe
DE
1448
1449static void
9a24775b 1450disassemble_current_function (gdb_disassembly_flags flags)
d14508fe 1451{
13274fc3
UW
1452 struct frame_info *frame;
1453 struct gdbarch *gdbarch;
d14508fe 1454 CORE_ADDR low, high, pc;
2c02bd72 1455 const char *name;
e9480230 1456 const struct block *block;
d14508fe 1457
13274fc3
UW
1458 frame = get_selected_frame (_("No frame selected."));
1459 gdbarch = get_frame_arch (frame);
9bf4bce9 1460 pc = get_frame_address_in_block (frame);
e9480230 1461 if (find_pc_partial_function (pc, &name, &low, &high, &block) == 0)
d14508fe
DE
1462 error (_("No function contains program counter for selected frame."));
1463#if defined(TUI)
1464 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1465 `tui_version'. */
1466 if (tui_active)
1467 /* FIXME: cagney/2004-02-07: This should be an observer. */
13274fc3 1468 low = tui_get_low_disassembly_address (gdbarch, low, pc);
d14508fe 1469#endif
13274fc3 1470 low += gdbarch_deprecated_function_start_offset (gdbarch);
d14508fe 1471
e9480230 1472 print_disassembly (gdbarch, name, low, high, block, flags);
d14508fe
DE
1473}
1474
1475/* Dump a specified section of assembly code.
1476
1477 Usage:
6ff0ba5f 1478 disassemble [/mrs]
d14508fe 1479 - dump the assembly code for the function of the current pc
6ff0ba5f 1480 disassemble [/mrs] addr
d14508fe 1481 - dump the assembly code for the function at ADDR
6ff0ba5f
DE
1482 disassemble [/mrs] low,high
1483 disassemble [/mrs] low,+length
53a71c06 1484 - dump the assembly code in the range [LOW,HIGH), or [LOW,LOW+length)
d14508fe 1485
6ff0ba5f
DE
1486 A /m modifier will include source code with the assembly in a
1487 "source centric" view. This view lists only the file of the first insn,
1488 even if other source files are involved (e.g., inlined functions), and
1489 the output is in source order, even with optimized code. This view is
1490 considered deprecated as it hasn't been useful in practice.
1491
1492 A /r modifier will include raw instructions in hex with the assembly.
1493
1494 A /s modifier will include source code with the assembly, like /m, with
1495 two important differences:
1496 1) The output is still in pc address order.
1497 2) File names and contents for all relevant source files are displayed. */
83c31e7d 1498
83c31e7d 1499static void
0b39b52e 1500disassemble_command (const char *arg, int from_tty)
83c31e7d 1501{
13274fc3 1502 struct gdbarch *gdbarch = get_current_arch ();
83c31e7d 1503 CORE_ADDR low, high;
f75a0693 1504 const general_symbol_info *symbol = nullptr;
2c02bd72 1505 const char *name;
d36fc00b 1506 CORE_ADDR pc;
9a24775b 1507 gdb_disassembly_flags flags;
bbc13ae3 1508 const char *p;
e9480230 1509 const struct block *block = nullptr;
83c31e7d 1510
bbc13ae3 1511 p = arg;
83c31e7d 1512 name = NULL;
e6158f16 1513 flags = 0;
d14508fe 1514
bbc13ae3 1515 if (p && *p == '/')
83c31e7d 1516 {
bbc13ae3 1517 ++p;
d14508fe 1518
bbc13ae3 1519 if (*p == '\0')
d14508fe
DE
1520 error (_("Missing modifier."));
1521
bbc13ae3 1522 while (*p && ! isspace (*p))
d14508fe 1523 {
bbc13ae3 1524 switch (*p++)
d14508fe
DE
1525 {
1526 case 'm':
6ff0ba5f 1527 flags |= DISASSEMBLY_SOURCE_DEPRECATED;
e6158f16
HZ
1528 break;
1529 case 'r':
1530 flags |= DISASSEMBLY_RAW_INSN;
d14508fe 1531 break;
6ff0ba5f
DE
1532 case 's':
1533 flags |= DISASSEMBLY_SOURCE;
1534 break;
d14508fe
DE
1535 default:
1536 error (_("Invalid disassembly modifier."));
1537 }
1538 }
1539
f1735a53 1540 p = skip_spaces (p);
d14508fe
DE
1541 }
1542
6ff0ba5f
DE
1543 if ((flags & (DISASSEMBLY_SOURCE_DEPRECATED | DISASSEMBLY_SOURCE))
1544 == (DISASSEMBLY_SOURCE_DEPRECATED | DISASSEMBLY_SOURCE))
1545 error (_("Cannot specify both /m and /s."));
1546
bbc13ae3 1547 if (! p || ! *p)
d14508fe 1548 {
9c419145 1549 flags |= DISASSEMBLY_OMIT_FNAME;
e6158f16 1550 disassemble_current_function (flags);
d14508fe 1551 return;
83c31e7d 1552 }
d14508fe 1553
bbc13ae3
KS
1554 pc = value_as_address (parse_to_comma_and_eval (&p));
1555 if (p[0] == ',')
1556 ++p;
1557 if (p[0] == '\0')
83c31e7d
FN
1558 {
1559 /* One argument. */
f75a0693 1560 if (!find_pc_partial_function_sym (pc, &symbol, &low, &high, &block))
8a3fe4f8 1561 error (_("No function contains specified address."));
f75a0693
AB
1562
1563 if (asm_demangle)
1564 name = symbol->print_name ();
1565 else
1566 name = symbol->linkage_name ();
1567
83c31e7d 1568#if defined(TUI)
021e7609
AC
1569 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1570 `tui_version'. */
22940a24
AC
1571 if (tui_active)
1572 /* FIXME: cagney/2004-02-07: This should be an observer. */
13274fc3 1573 low = tui_get_low_disassembly_address (gdbarch, low, pc);
83c31e7d 1574#endif
13274fc3 1575 low += gdbarch_deprecated_function_start_offset (gdbarch);
9c419145 1576 flags |= DISASSEMBLY_OMIT_FNAME;
83c31e7d
FN
1577 }
1578 else
1579 {
1580 /* Two arguments. */
53a71c06 1581 int incl_flag = 0;
21a0512e 1582 low = pc;
f1735a53 1583 p = skip_spaces (p);
bbc13ae3 1584 if (p[0] == '+')
53a71c06 1585 {
bbc13ae3 1586 ++p;
53a71c06
CR
1587 incl_flag = 1;
1588 }
bbc13ae3 1589 high = parse_and_eval_address (p);
53a71c06
CR
1590 if (incl_flag)
1591 high += low;
83c31e7d
FN
1592 }
1593
e9480230 1594 print_disassembly (gdbarch, name, low, high, block, flags);
83c31e7d
FN
1595}
1596
d318976c 1597static void
0b39b52e 1598make_command (const char *arg, int from_tty)
d318976c 1599{
d318976c 1600 if (arg == 0)
be47f9e8 1601 shell_escape ("make", from_tty);
d318976c
FN
1602 else
1603 {
be47f9e8 1604 std::string cmd = std::string ("make ") + arg;
d318976c 1605
be47f9e8
PA
1606 shell_escape (cmd.c_str (), from_tty);
1607 }
d318976c
FN
1608}
1609
d318976c 1610static void
dede02ce 1611show_user (const char *args, int from_tty)
d318976c
FN
1612{
1613 struct cmd_list_element *c;
d318976c
FN
1614
1615 if (args)
1616 {
6f937416 1617 const char *comname = args;
cdb27c12 1618
cf00cd6f 1619 c = lookup_cmd (&comname, cmdlist, "", NULL, 0, 1);
a9f116cb 1620 if (!cli_user_command_p (c))
8a3fe4f8 1621 error (_("Not a user command."));
adb483fe 1622 show_user_1 (c, "", args, gdb_stdout);
d318976c
FN
1623 }
1624 else
1625 {
1626 for (c = cmdlist; c; c = c->next)
1627 {
3d0b3564 1628 if (cli_user_command_p (c) || c->is_prefix ())
adb483fe 1629 show_user_1 (c, "", c->name, gdb_stdout);
d318976c
FN
1630 }
1631 }
1632}
1633
1634/* Search through names of commands and documentations for a certain
ebcd3b23
MS
1635 regular expression. */
1636
66d8c862
PW
1637static void
1638apropos_command (const char *arg, int from_tty)
d318976c 1639{
66d8c862
PW
1640 bool verbose = arg && check_for_argument (&arg, "-v", 2);
1641
66d8c862 1642 if (arg == NULL || *arg == '\0')
f55af66d 1643 error (_("REGEXP string is empty"));
d318976c 1644
66d8c862 1645 compiled_regex pattern (arg, REG_ICASE,
2d7cc5c7 1646 _("Error in regular expression"));
dc92e161 1647
66d8c862 1648 apropos_cmd (gdb_stdout, cmdlist, verbose, pattern, "");
d318976c 1649}
5a56e9c5 1650
cf00cd6f
PW
1651/* The options for the "alias" command. */
1652
1653struct alias_opts
1654{
1655 /* For "-a". */
1656 bool abbrev_flag = false;
1657};
1658
1659static const gdb::option::option_def alias_option_defs[] = {
1660
1661 gdb::option::flag_option_def<alias_opts> {
1662 "a",
1663 [] (alias_opts *opts) { return &opts->abbrev_flag; },
1664 N_("Specify that ALIAS is an abbreviation of COMMAND.\n\
1665Abbreviations are not used in command completion."),
1666 },
1667
1668};
1669
1670/* Create an option_def_group for the "alias" options, with
1671 A_OPTS as context. */
1672
1673static gdb::option::option_def_group
1674make_alias_options_def_group (alias_opts *a_opts)
1675{
1676 return {{alias_option_defs}, a_opts};
1677}
1678
1679/* Completer for the "alias_command". */
1680
1681static void
1682alias_command_completer (struct cmd_list_element *ignore,
1683 completion_tracker &tracker,
1684 const char *text, const char *word)
1685{
1686 const auto grp = make_alias_options_def_group (nullptr);
1687
1688 tracker.set_use_custom_word_point (true);
1689
1690 if (gdb::option::complete_options
1691 (tracker, &text, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR, grp))
1692 return;
1693
1694 const char *delim = strchr (text, '=');
1695
1696 /* If we're past the "=" delimiter, complete the
1697 "alias ALIAS = COMMAND [DEFAULT-ARGS...]" as if the user is
1698 typing COMMAND DEFAULT-ARGS... */
1699 if (delim != text
1700 && delim != nullptr
1701 && isspace (delim[-1])
1702 && (isspace (delim[1]) || delim[1] == '\0'))
1703 {
1704 std::string new_text = std::string (delim + 1);
1705
1706 tracker.advance_custom_word_point_by (delim + 1 - text);
1707 complete_nested_command_line (tracker, new_text.c_str ());
1708 return;
1709 }
1710
1711 /* We're not yet past the "=" delimiter. Complete a command, as
1712 the user might type an alias following a prefix command. */
1713 complete_nested_command_line (tracker, text);
1714}
1715
5a56e9c5
DE
1716/* Subroutine of alias_command to simplify it.
1717 Return the first N elements of ARGV flattened back to a string
1718 with a space separating each element.
1719 ARGV may not be NULL.
1720 This does not take care of quoting elements in case they contain spaces
1721 on purpose. */
1722
a97e29d2
TT
1723static std::string
1724argv_to_string (char **argv, int n)
5a56e9c5
DE
1725{
1726 int i;
a97e29d2 1727 std::string result;
5a56e9c5
DE
1728
1729 gdb_assert (argv != NULL);
1730 gdb_assert (n >= 0 && n <= countargv (argv));
1731
1732 for (i = 0; i < n; ++i)
1733 {
1734 if (i > 0)
a97e29d2
TT
1735 result += " ";
1736 result += argv[i];
5a56e9c5
DE
1737 }
1738
1739 return result;
1740}
1741
1742/* Subroutine of alias_command to simplify it.
cf00cd6f
PW
1743 Verifies that COMMAND can have an alias:
1744 COMMAND must exist.
1745 COMMAND must not have default args.
1746 This last condition is to avoid the following:
1747 alias aaa = backtrace -full
1748 alias bbb = aaa -past-main
1749 as (at least currently), alias default args are not cumulative
1750 and the user would expect bbb to execute 'backtrace -full -past-main'
1751 while it will execute 'backtrace -past-main'. */
5a56e9c5 1752
3947f654 1753static cmd_list_element *
cf00cd6f 1754validate_aliased_command (const char *command)
5a56e9c5 1755{
cf00cd6f 1756 std::string default_args;
3947f654
SM
1757 cmd_list_element *c
1758 = lookup_cmd_1 (& command, cmdlist, NULL, &default_args, 1);
5a56e9c5
DE
1759
1760 if (c == NULL || c == (struct cmd_list_element *) -1)
cf00cd6f
PW
1761 error (_("Invalid command to alias to: %s"), command);
1762
1763 if (!default_args.empty ())
1764 error (_("Cannot define an alias of an alias that has default args"));
3947f654
SM
1765
1766 return c;
5a56e9c5
DE
1767}
1768
7f31862a
PA
1769/* Called when "alias" was incorrectly used. */
1770
1771static void
1772alias_usage_error (void)
1773{
cf00cd6f 1774 error (_("Usage: alias [-a] [--] ALIAS = COMMAND [DEFAULT-ARGS...]"));
7f31862a
PA
1775}
1776
5a56e9c5
DE
1777/* Make an alias of an existing command. */
1778
1779static void
0b39b52e 1780alias_command (const char *args, int from_tty)
5a56e9c5 1781{
cf00cd6f
PW
1782 alias_opts a_opts;
1783
1784 auto grp = make_alias_options_def_group (&a_opts);
1785 gdb::option::process_options
1786 (&args, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_ERROR, grp);
1787
5a56e9c5 1788 int i, alias_argc, command_argc;
0b39b52e 1789 const char *equals;
a97e29d2 1790 const char *alias, *command;
5a56e9c5
DE
1791
1792 if (args == NULL || strchr (args, '=') == NULL)
7f31862a 1793 alias_usage_error ();
5a56e9c5 1794
773a1edc
TT
1795 equals = strchr (args, '=');
1796 std::string args2 (args, equals - args);
1797
1798 gdb_argv built_alias_argv (args2.c_str ());
cf00cd6f
PW
1799
1800 const char *default_args = equals + 1;
1801 struct cmd_list_element *c_command_prefix;
1802
1803 lookup_cmd_for_default_args (&default_args, &c_command_prefix);
1804 std::string command_argv_str (equals + 1,
1805 default_args == nullptr
1806 ? strlen (equals + 1)
1807 : default_args - equals - 1);
1808 gdb_argv command_argv (command_argv_str.c_str ());
5a56e9c5 1809
773a1edc 1810 char **alias_argv = built_alias_argv.get ();
5a56e9c5
DE
1811
1812 if (alias_argv[0] == NULL || command_argv[0] == NULL
1813 || *alias_argv[0] == '\0' || *command_argv[0] == '\0')
7f31862a 1814 alias_usage_error ();
5a56e9c5
DE
1815
1816 for (i = 0; alias_argv[i] != NULL; ++i)
1817 {
1818 if (! valid_user_defined_cmd_name_p (alias_argv[i]))
1819 {
1820 if (i == 0)
1821 error (_("Invalid command name: %s"), alias_argv[i]);
1822 else
1823 error (_("Invalid command element name: %s"), alias_argv[i]);
1824 }
1825 }
1826
1827 alias_argc = countargv (alias_argv);
773a1edc 1828 command_argc = command_argv.count ();
5a56e9c5 1829
cf00cd6f 1830 /* COMMAND must exist, and cannot have default args.
5a56e9c5
DE
1831 Reconstruct the command to remove any extraneous spaces,
1832 for better error messages. */
773a1edc
TT
1833 std::string command_string (argv_to_string (command_argv.get (),
1834 command_argc));
a97e29d2 1835 command = command_string.c_str ();
3947f654 1836 cmd_list_element *target_cmd = validate_aliased_command (command);
5a56e9c5
DE
1837
1838 /* ALIAS must not exist. */
a97e29d2
TT
1839 std::string alias_string (argv_to_string (alias_argv, alias_argc));
1840 alias = alias_string.c_str ();
0605465f
PW
1841 {
1842 cmd_list_element *alias_cmd, *prefix_cmd, *cmd;
1843
1844 if (lookup_cmd_composition (alias, &alias_cmd, &prefix_cmd, &cmd))
1845 {
1846 const char *alias_name = alias_argv[alias_argc-1];
1847
1848 /* If we found an existing ALIAS_CMD, check that the prefix differ or
1849 the name differ. */
1850
1851 if (alias_cmd != nullptr
1852 && alias_cmd->prefix == prefix_cmd
1853 && strcmp (alias_name, alias_cmd->name) == 0)
1854 error (_("Alias already exists: %s"), alias);
1855
1856 /* Check ALIAS differs from the found CMD. */
1857
1858 if (cmd->prefix == prefix_cmd
1859 && strcmp (alias_name, cmd->name) == 0)
1860 error (_("Alias %s is the name of an existing command"), alias);
1861 }
1862 }
1863
5a56e9c5 1864
cf00cd6f
PW
1865 struct cmd_list_element *alias_cmd;
1866
5a56e9c5
DE
1867 /* If ALIAS is one word, it is an alias for the entire COMMAND.
1868 Example: alias spe = set print elements
1869
1870 Otherwise ALIAS and COMMAND must have the same number of words,
b65b566c
PW
1871 and every word except the last must identify the same prefix command;
1872 and the last word of ALIAS is made an alias of the last word of COMMAND.
5a56e9c5
DE
1873 Example: alias set print elms = set pr elem
1874 Note that unambiguous abbreviations are allowed. */
1875
1876 if (alias_argc == 1)
1877 {
1878 /* add_cmd requires *we* allocate space for name, hence the xstrdup. */
3947f654
SM
1879 alias_cmd = add_com_alias (xstrdup (alias_argv[0]), target_cmd,
1880 class_alias, a_opts.abbrev_flag);
5a56e9c5
DE
1881 }
1882 else
1883 {
6f937416 1884 const char *alias_prefix, *command_prefix;
5a56e9c5
DE
1885 struct cmd_list_element *c_alias, *c_command;
1886
1887 if (alias_argc != command_argc)
1888 error (_("Mismatched command length between ALIAS and COMMAND."));
1889
1890 /* Create copies of ALIAS and COMMAND without the last word,
b65b566c
PW
1891 and use that to verify the leading elements give the same
1892 prefix command. */
a97e29d2
TT
1893 std::string alias_prefix_string (argv_to_string (alias_argv,
1894 alias_argc - 1));
b65b566c 1895 std::string command_prefix_string (argv_to_string (command_argv.get (),
a97e29d2
TT
1896 command_argc - 1));
1897 alias_prefix = alias_prefix_string.c_str ();
1898 command_prefix = command_prefix_string.c_str ();
5a56e9c5 1899
cf00cd6f 1900 c_command = lookup_cmd_1 (& command_prefix, cmdlist, NULL, NULL, 1);
5a56e9c5
DE
1901 /* We've already tried to look up COMMAND. */
1902 gdb_assert (c_command != NULL
1903 && c_command != (struct cmd_list_element *) -1);
3d0b3564 1904 gdb_assert (c_command->is_prefix ());
cf00cd6f 1905 c_alias = lookup_cmd_1 (& alias_prefix, cmdlist, NULL, NULL, 1);
5a56e9c5
DE
1906 if (c_alias != c_command)
1907 error (_("ALIAS and COMMAND prefixes do not match."));
1908
1909 /* add_cmd requires *we* allocate space for name, hence the xstrdup. */
cf00cd6f 1910 alias_cmd = add_alias_cmd (xstrdup (alias_argv[alias_argc - 1]),
5e84b7ee 1911 target_cmd, class_alias, a_opts.abbrev_flag,
14b42fc4 1912 c_command->subcommands);
cf00cd6f
PW
1913 }
1914
1915 gdb_assert (alias_cmd != nullptr);
1916 gdb_assert (alias_cmd->default_args.empty ());
1917 if (default_args != nullptr)
1918 {
1919 default_args = skip_spaces (default_args);
1920
1921 alias_cmd->default_args = default_args;
5a56e9c5
DE
1922 }
1923}
d318976c 1924\f
06871ae8
PA
1925/* Print the file / line number / symbol name of the location
1926 specified by SAL. */
1927
1928static void
1929print_sal_location (const symtab_and_line &sal)
1930{
1931 scoped_restore_current_program_space restore_pspace;
1932 set_current_program_space (sal.pspace);
1933
1934 const char *sym_name = NULL;
1935 if (sal.symbol != NULL)
987012b8 1936 sym_name = sal.symbol->print_name ();
06871ae8
PA
1937 printf_filtered (_("file: \"%s\", line number: %d, symbol: \"%s\"\n"),
1938 symtab_to_filename_for_display (sal.symtab),
1939 sal.line, sym_name != NULL ? sym_name : "???");
1940}
1941
0378c332 1942/* Print a list of files and line numbers which a user may choose from
ebcd3b23 1943 in order to list a function which was specified ambiguously (as
6c5b2ebe
PA
1944 with `list classname::overloadedfuncname', for example). The SALS
1945 array provides the filenames and line numbers. FORMAT is a
1946 printf-style format string used to tell the user what was
e439fa14 1947 ambiguous. */
0378c332
FN
1948
1949static void
6c5b2ebe
PA
1950ambiguous_line_spec (gdb::array_view<const symtab_and_line> sals,
1951 const char *format, ...)
0378c332 1952{
e439fa14
PA
1953 va_list ap;
1954 va_start (ap, format);
1955 vprintf_filtered (format, ap);
1956 va_end (ap);
1957
6c5b2ebe 1958 for (const auto &sal : sals)
06871ae8 1959 print_sal_location (sal);
0378c332
FN
1960}
1961
6c5b2ebe
PA
1962/* Comparison function for filter_sals. Returns a qsort-style
1963 result. */
f8eba3c6
TT
1964
1965static int
6c5b2ebe 1966cmp_symtabs (const symtab_and_line &sala, const symtab_and_line &salb)
f8eba3c6 1967{
6c5b2ebe
PA
1968 const char *dira = SYMTAB_DIRNAME (sala.symtab);
1969 const char *dirb = SYMTAB_DIRNAME (salb.symtab);
f8eba3c6
TT
1970 int r;
1971
ee6f8984 1972 if (dira == NULL)
f8eba3c6 1973 {
ee6f8984 1974 if (dirb != NULL)
f8eba3c6
TT
1975 return -1;
1976 }
ee6f8984 1977 else if (dirb == NULL)
f8eba3c6 1978 {
ee6f8984 1979 if (dira != NULL)
f8eba3c6
TT
1980 return 1;
1981 }
1982 else
1983 {
ee6f8984 1984 r = filename_cmp (dira, dirb);
f8eba3c6
TT
1985 if (r)
1986 return r;
1987 }
1988
6c5b2ebe 1989 r = filename_cmp (sala.symtab->filename, salb.symtab->filename);
f8eba3c6
TT
1990 if (r)
1991 return r;
1992
6c5b2ebe 1993 if (sala.line < salb.line)
f8eba3c6 1994 return -1;
6c5b2ebe 1995 return sala.line == salb.line ? 0 : 1;
f8eba3c6
TT
1996}
1997
1998/* Remove any SALs that do not match the current program space, or
1999 which appear to be "file:line" duplicates. */
2000
2001static void
6c5b2ebe 2002filter_sals (std::vector<symtab_and_line> &sals)
f8eba3c6 2003{
6c5b2ebe
PA
2004 /* Remove SALs that do not match. */
2005 auto from = std::remove_if (sals.begin (), sals.end (),
2006 [&] (const symtab_and_line &sal)
2007 { return (sal.pspace != current_program_space || sal.symtab == NULL); });
2008
2009 /* Remove dups. */
2010 std::sort (sals.begin (), from,
2011 [] (const symtab_and_line &sala, const symtab_and_line &salb)
2012 { return cmp_symtabs (sala, salb) < 0; });
2013
2014 from = std::unique (sals.begin (), from,
2015 [&] (const symtab_and_line &sala,
2016 const symtab_and_line &salb)
2017 { return cmp_symtabs (sala, salb) == 0; });
2018
2019 sals.erase (from, sals.end ());
f8eba3c6
TT
2020}
2021
d318976c
FN
2022void
2023init_cmd_lists (void)
2024{
20f01a46 2025 max_user_call_depth = 1024;
d318976c
FN
2026}
2027
920d2a44
AC
2028static void
2029show_info_verbose (struct ui_file *file, int from_tty,
2030 struct cmd_list_element *c,
2031 const char *value)
2032{
2033 if (info_verbose)
9a2b4c1b
MS
2034 fprintf_filtered (file,
2035 _("Verbose printing of informational messages is %s.\n"),
2036 value);
920d2a44
AC
2037 else
2038 fprintf_filtered (file, _("Verbosity is %s.\n"), value);
2039}
2040
2041static void
2042show_history_expansion_p (struct ui_file *file, int from_tty,
2043 struct cmd_list_element *c, const char *value)
2044{
2045 fprintf_filtered (file, _("History expansion on command input is %s.\n"),
2046 value);
2047}
2048
920d2a44
AC
2049static void
2050show_max_user_call_depth (struct ui_file *file, int from_tty,
2051 struct cmd_list_element *c, const char *value)
2052{
9a2b4c1b
MS
2053 fprintf_filtered (file,
2054 _("The max call depth for user-defined commands is %s.\n"),
920d2a44
AC
2055 value);
2056}
2057
9ad9b77d
PW
2058/* Returns the cmd_list_element in SHOWLIST corresponding to the first
2059 argument of ARGV, which must contain one single value.
2060 Throws an error if no value provided, or value not correct.
2061 FNNAME is used in the error message. */
2062
2063static cmd_list_element *
2064setting_cmd (const char *fnname, struct cmd_list_element *showlist,
2065 int argc, struct value **argv)
2066{
2067 if (argc == 0)
2068 error (_("You must provide an argument to %s"), fnname);
2069 if (argc != 1)
2070 error (_("You can only provide one argument to %s"), fnname);
2071
2072 struct type *type0 = check_typedef (value_type (argv[0]));
2073
78134374
SM
2074 if (type0->code () != TYPE_CODE_ARRAY
2075 && type0->code () != TYPE_CODE_STRING)
9ad9b77d
PW
2076 error (_("First argument of %s must be a string."), fnname);
2077
2078 const char *a0 = (const char *) value_contents (argv[0]);
cf00cd6f 2079 cmd_list_element *cmd = lookup_cmd (&a0, showlist, "", NULL, -1, 0);
9ad9b77d 2080
cd4c4c07 2081 if (cmd == nullptr || cmd->type != show_cmd)
9ad9b77d
PW
2082 error (_("First argument of %s must be a "
2083 "valid setting of the 'show' command."), fnname);
2084
2085 return cmd;
2086}
2087
2088/* Builds a value from the show CMD. */
2089
2090static struct value *
2091value_from_setting (const cmd_list_element *cmd, struct gdbarch *gdbarch)
2092{
2093 switch (cmd->var_type)
2094 {
2095 case var_integer:
2096 if (*(int *) cmd->var == INT_MAX)
2097 return value_from_longest (builtin_type (gdbarch)->builtin_int,
2098 0);
2099 else
2100 return value_from_longest (builtin_type (gdbarch)->builtin_int,
2101 *(int *) cmd->var);
2102 case var_zinteger:
2103 return value_from_longest (builtin_type (gdbarch)->builtin_int,
2104 *(int *) cmd->var);
2105 case var_boolean:
2106 return value_from_longest (builtin_type (gdbarch)->builtin_int,
2107 *(bool *) cmd->var ? 1 : 0);
2108 case var_zuinteger_unlimited:
2109 return value_from_longest (builtin_type (gdbarch)->builtin_int,
2110 *(int *) cmd->var);
2111 case var_auto_boolean:
2112 {
2113 int val;
2114
2115 switch (*(enum auto_boolean*) cmd->var)
2116 {
2117 case AUTO_BOOLEAN_TRUE:
2118 val = 1;
2119 break;
2120 case AUTO_BOOLEAN_FALSE:
2121 val = 0;
2122 break;
2123 case AUTO_BOOLEAN_AUTO:
2124 val = -1;
2125 break;
2126 default:
2127 gdb_assert_not_reached ("invalid var_auto_boolean");
2128 }
2129 return value_from_longest (builtin_type (gdbarch)->builtin_int,
2130 val);
2131 }
2132 case var_uinteger:
2133 if (*(unsigned int *) cmd->var == UINT_MAX)
2134 return value_from_ulongest
2135 (builtin_type (gdbarch)->builtin_unsigned_int, 0);
2136 else
2137 return value_from_ulongest
2138 (builtin_type (gdbarch)->builtin_unsigned_int,
2139 *(unsigned int *) cmd->var);
2140 case var_zuinteger:
2141 return value_from_ulongest (builtin_type (gdbarch)->builtin_unsigned_int,
2142 *(unsigned int *) cmd->var);
2143 case var_string:
2144 case var_string_noescape:
2145 case var_optional_filename:
2146 case var_filename:
2147 case var_enum:
2148 if (*(char **) cmd->var)
2149 return value_cstring (*(char **) cmd->var, strlen (*(char **) cmd->var),
2150 builtin_type (gdbarch)->builtin_char);
2151 else
2152 return value_cstring ("", 1,
2153 builtin_type (gdbarch)->builtin_char);
2154 default:
2155 gdb_assert_not_reached ("bad var_type");
2156 }
2157}
2158
2159/* Implementation of the convenience function $_gdb_setting. */
2160
2161static struct value *
2162gdb_setting_internal_fn (struct gdbarch *gdbarch,
2163 const struct language_defn *language,
2164 void *cookie, int argc, struct value **argv)
2165{
2166 return value_from_setting (setting_cmd ("$_gdb_setting", showlist,
2167 argc, argv),
2168 gdbarch);
2169}
2170
2171/* Implementation of the convenience function $_gdb_maint_setting. */
2172
2173static struct value *
2174gdb_maint_setting_internal_fn (struct gdbarch *gdbarch,
2175 const struct language_defn *language,
2176 void *cookie, int argc, struct value **argv)
2177{
2178 return value_from_setting (setting_cmd ("$_gdb_maint_setting",
2179 maintenance_show_cmdlist,
2180 argc, argv),
2181 gdbarch);
2182}
2183
2184/* Builds a string value from the show CMD. */
2185
2186static struct value *
2187str_value_from_setting (const cmd_list_element *cmd, struct gdbarch *gdbarch)
2188{
2189 switch (cmd->var_type)
2190 {
2191 case var_integer:
2192 case var_zinteger:
2193 case var_boolean:
2194 case var_zuinteger_unlimited:
2195 case var_auto_boolean:
2196 case var_uinteger:
2197 case var_zuinteger:
2198 {
2199 std::string cmd_val = get_setshow_command_value_string (cmd);
2200
2201 return value_cstring (cmd_val.c_str (), cmd_val.size (),
2202 builtin_type (gdbarch)->builtin_char);
2203 }
2204
2205 case var_string:
2206 case var_string_noescape:
2207 case var_optional_filename:
2208 case var_filename:
2209 case var_enum:
2210 /* For these cases, we do not use get_setshow_command_value_string,
2211 as this function handle some characters specially, e.g. by
2212 escaping quotes. So, we directly use the cmd->var string value,
2213 similarly to the value_from_setting code for these cases. */
2214 if (*(char **) cmd->var)
2215 return value_cstring (*(char **) cmd->var, strlen (*(char **) cmd->var),
2216 builtin_type (gdbarch)->builtin_char);
2217 else
2218 return value_cstring ("", 1,
2219 builtin_type (gdbarch)->builtin_char);
2220
2221 default:
2222 gdb_assert_not_reached ("bad var_type");
2223 }
2224}
2225
2226/* Implementation of the convenience function $_gdb_setting_str. */
2227
2228static struct value *
2229gdb_setting_str_internal_fn (struct gdbarch *gdbarch,
2230 const struct language_defn *language,
2231 void *cookie, int argc, struct value **argv)
2232{
2233 return str_value_from_setting (setting_cmd ("$_gdb_setting_str",
2234 showlist, argc, argv),
2235 gdbarch);
2236}
2237
2238
2239/* Implementation of the convenience function $_gdb_maint_setting_str. */
2240
2241static struct value *
2242gdb_maint_setting_str_internal_fn (struct gdbarch *gdbarch,
2243 const struct language_defn *language,
2244 void *cookie, int argc, struct value **argv)
2245{
2246 return str_value_from_setting (setting_cmd ("$_gdb_maint_setting_str",
2247 maintenance_show_cmdlist,
2248 argc, argv),
2249 gdbarch);
2250}
2251
6c265988 2252void _initialize_cli_cmds ();
d318976c 2253void
6c265988 2254_initialize_cli_cmds ()
d318976c
FN
2255{
2256 struct cmd_list_element *c;
2257
2258 /* Define the classes of commands.
1bfeeb0f 2259 They will appear in the help list in alphabetical order. */
d318976c 2260
0450cc4c 2261 add_cmd ("internals", class_maintenance, _("\
1a966eab 2262Maintenance commands.\n\
d318976c
FN
2263Some gdb commands are provided just for use by gdb maintainers.\n\
2264These commands are subject to frequent change, and may not be as\n\
1a966eab 2265well documented as user commands."),
d318976c 2266 &cmdlist);
0450cc4c
TT
2267 add_cmd ("obscure", class_obscure, _("Obscure features."), &cmdlist);
2268 add_cmd ("aliases", class_alias,
cf00cd6f 2269 _("User-defined aliases of other commands."), &cmdlist);
0450cc4c 2270 add_cmd ("user-defined", class_user, _("\
1a966eab 2271User-defined commands.\n\
d318976c 2272The commands in this class are those defined by the user.\n\
1a966eab 2273Use the \"define\" command to define a command."), &cmdlist);
0450cc4c 2274 add_cmd ("support", class_support, _("Support facilities."), &cmdlist);
d318976c 2275 if (!dbx_commands)
0450cc4c
TT
2276 add_cmd ("status", class_info, _("Status inquiries."), &cmdlist);
2277 add_cmd ("files", class_files, _("Specifying and examining files."),
1a966eab 2278 &cmdlist);
0450cc4c 2279 add_cmd ("breakpoints", class_breakpoint,
1a966eab 2280 _("Making program stop at certain points."), &cmdlist);
0450cc4c
TT
2281 add_cmd ("data", class_vars, _("Examining data."), &cmdlist);
2282 add_cmd ("stack", class_stack, _("\
1a966eab 2283Examining the stack.\n\
d318976c
FN
2284The stack is made up of stack frames. Gdb assigns numbers to stack frames\n\
2285counting from zero for the innermost (currently executing) frame.\n\n\
2286At any time gdb identifies one frame as the \"selected\" frame.\n\
2287Variable lookups are done with respect to the selected frame.\n\
2288When the program being debugged stops, gdb selects the innermost frame.\n\
1a966eab 2289The commands below can be used to select other frames by number or address."),
d318976c 2290 &cmdlist);
e98d2e6d
PW
2291#ifdef TUI
2292 add_cmd ("text-user-interface", class_tui,
2293 _("TUI is the GDB text based interface.\n\
2294In TUI mode, GDB can display several text windows showing\n\
2295the source file, the processor registers, the program disassembly, ..."), &cmdlist);
2296#endif
0450cc4c 2297 add_cmd ("running", class_run, _("Running the program."), &cmdlist);
d318976c 2298
ebcd3b23 2299 /* Define general commands. */
d318976c 2300
d729566a 2301 add_com ("pwd", class_files, pwd_command, _("\
590042fc
PW
2302Print working directory.\n\
2303This is used for your program as well."));
4f8d22e3 2304
1a966eab 2305 c = add_cmd ("cd", class_files, cd_command, _("\
d092c5a2
SDJ
2306Set working directory to DIR for debugger.\n\
2307The debugger's current working directory specifies where scripts and other\n\
2308files that can be loaded by GDB are located.\n\
2309In order to change the inferior's current working directory, the recommended\n\
2310way is to use the \"set cwd\" command."), &cmdlist);
5ba2abeb 2311 set_cmd_completer (c, filename_completer);
d318976c 2312
1bedd215
AC
2313 add_com ("echo", class_support, echo_command, _("\
2314Print a constant string. Give string as argument.\n\
d318976c
FN
2315C escape sequences may be used in the argument.\n\
2316No newline is added at the end of the argument;\n\
2317use \"\\n\" if you want a newline to be printed.\n\
2318Since leading and trailing whitespace are ignored in command arguments,\n\
2319if you want to print some you must use \"\\\" before leading whitespace\n\
1bedd215 2320to be printed or after trailing whitespace."));
d318976c 2321
973817a3
JB
2322 add_setshow_enum_cmd ("script-extension", class_support,
2323 script_ext_enums, &script_ext_mode, _("\
2324Set mode for script filename extension recognition."), _("\
2325Show mode for script filename extension recognition."), _("\
2326off == no filename extension recognition (all sourced files are GDB scripts)\n\
2327soft == evaluate script according to filename extension, fallback to GDB script"
2328 "\n\
2329strict == evaluate script according to filename extension, error if not supported"
2330 ),
2331 NULL,
2332 show_script_ext_mode,
2333 &setlist, &showlist);
2334
3947f654
SM
2335 cmd_list_element *quit_cmd
2336 = add_com ("quit", class_support, quit_command, _("\
bdb52a22
TT
2337Exit gdb.\n\
2338Usage: quit [EXPR]\n\
2339The optional expression EXPR, if present, is evaluated and the result\n\
2340used as GDB's exit code. The default is zero."));
3947f654
SM
2341 cmd_list_element *help_cmd
2342 = add_com ("help", class_support, help_command,
1bedd215 2343 _("Print list of commands."));
3947f654
SM
2344 set_cmd_completer (help_cmd, command_completer);
2345 add_com_alias ("q", quit_cmd, class_support, 1);
2346 add_com_alias ("h", help_cmd, class_support, 1);
d318976c 2347
5bf193a2
AC
2348 add_setshow_boolean_cmd ("verbose", class_support, &info_verbose, _("\
2349Set verbosity."), _("\
2350Show verbosity."), NULL,
2351 set_verbose,
920d2a44 2352 show_info_verbose,
5bf193a2 2353 &setlist, &showlist);
d318976c 2354
0743fc83
TT
2355 add_basic_prefix_cmd ("history", class_support, _("\
2356Generic command for setting command history parameters."),
2f822da5 2357 &sethistlist, 0, &setlist);
0743fc83
TT
2358 add_show_prefix_cmd ("history", class_support, _("\
2359Generic command for showing command history parameters."),
2f822da5 2360 &showhistlist, 0, &showlist);
d318976c 2361
5bf193a2
AC
2362 add_setshow_boolean_cmd ("expansion", no_class, &history_expansion_p, _("\
2363Set history expansion on command input."), _("\
2364Show history expansion on command input."), _("\
2365Without an argument, history expansion is enabled."),
2366 NULL,
920d2a44 2367 show_history_expansion_p,
5bf193a2 2368 &sethistlist, &showhistlist);
d318976c 2369
3947f654
SM
2370 cmd_list_element *info_cmd
2371 = add_prefix_cmd ("info", class_info, info_command, _("\
1bedd215 2372Generic command for showing things about the program being debugged."),
3947f654
SM
2373 &infolist, 0, &cmdlist);
2374 add_com_alias ("i", info_cmd, class_info, 1);
2375 add_com_alias ("inf", info_cmd, class_info, 1);
d318976c
FN
2376
2377 add_com ("complete", class_obscure, complete_command,
1bedd215 2378 _("List the completions for the rest of the line as a command."));
d318976c 2379
a7b9ceb8 2380 c = add_show_prefix_cmd ("show", class_info, _("\
700b53b1 2381Generic command for showing things about the debugger."),
2f822da5 2382 &showlist, 0, &cmdlist);
d318976c 2383 /* Another way to get at the same thing. */
a7b9ceb8 2384 add_alias_cmd ("set", c, class_info, 0, &infolist);
d318976c 2385
3947f654
SM
2386 cmd_list_element *with_cmd
2387 = add_com ("with", class_vars, with_command, _("\
fdbc9870
PA
2388Temporarily set SETTING to VALUE, run COMMAND, and restore SETTING.\n\
2389Usage: with SETTING [VALUE] [-- COMMAND]\n\
2390Usage: w SETTING [VALUE] [-- COMMAND]\n\
2391With no COMMAND, repeats the last executed command.\n\
2392\n\
2393SETTING is any setting you can change with the \"set\" subcommands.\n\
2394E.g.:\n\
2395 with language pascal -- print obj\n\
2396 with print elements unlimited -- print obj\n\
2397\n\
2398You can change multiple settings using nested with, and use\n\
2399abbreviations for commands and/or values. E.g.:\n\
2400 w la p -- w p el u -- p obj"));
3947f654
SM
2401 set_cmd_completer_handle_brkchars (with_cmd, with_command_completer);
2402 add_com_alias ("w", with_cmd, class_vars, 1);
fdbc9870 2403
9ad9b77d
PW
2404 add_internal_function ("_gdb_setting_str", _("\
2405$_gdb_setting_str - returns the value of a GDB setting as a string.\n\
2406Usage: $_gdb_setting_str (setting)\n\
2407\n\
2408auto-boolean values are \"off\", \"on\", \"auto\".\n\
2409boolean values are \"off\", \"on\".\n\
2410Some integer settings accept an unlimited value, returned\n\
2411as \"unlimited\"."),
2412 gdb_setting_str_internal_fn, NULL);
2413
2414 add_internal_function ("_gdb_setting", _("\
2415$_gdb_setting - returns the value of a GDB setting.\n\
2416Usage: $_gdb_setting (setting)\n\
2417auto-boolean values are \"off\", \"on\", \"auto\".\n\
2418boolean values are \"off\", \"on\".\n\
2419Some integer settings accept an unlimited value, returned\n\
2420as 0 or -1 depending on the setting."),
2421 gdb_setting_internal_fn, NULL);
2422
2423 add_internal_function ("_gdb_maint_setting_str", _("\
2424$_gdb_maint_setting_str - returns the value of a GDB maintenance setting as a string.\n\
2425Usage: $_gdb_maint_setting_str (setting)\n\
2426\n\
2427auto-boolean values are \"off\", \"on\", \"auto\".\n\
2428boolean values are \"off\", \"on\".\n\
2429Some integer settings accept an unlimited value, returned\n\
2430as \"unlimited\"."),
2431 gdb_maint_setting_str_internal_fn, NULL);
2432
2433 add_internal_function ("_gdb_maint_setting", _("\
2434$_gdb_maint_setting - returns the value of a GDB maintenance setting.\n\
2435Usage: $_gdb_maint_setting (setting)\n\
2436auto-boolean values are \"off\", \"on\", \"auto\".\n\
2437boolean values are \"off\", \"on\".\n\
2438Some integer settings accept an unlimited value, returned\n\
2439as 0 or -1 depending on the setting."),
2440 gdb_maint_setting_internal_fn, NULL);
2441
db5f229b 2442 add_cmd ("commands", no_set_class, show_commands, _("\
1a966eab 2443Show the history of commands you typed.\n\
d318976c 2444You can supply a command number to start with, or a `+' to start after\n\
1a966eab 2445the previous command number shown."),
d318976c
FN
2446 &showlist);
2447
db5f229b 2448 add_cmd ("version", no_set_class, show_version,
1a966eab 2449 _("Show what version of GDB this is."), &showlist);
d318976c 2450
6eaaf48b
EZ
2451 add_cmd ("configuration", no_set_class, show_configuration,
2452 _("Show how GDB was configured at build time."), &showlist);
2453
0743fc83
TT
2454 add_basic_prefix_cmd ("debug", no_class,
2455 _("Generic command for setting gdb debugging flags."),
2f822da5 2456 &setdebuglist, 0, &setlist);
d318976c 2457
0743fc83
TT
2458 add_show_prefix_cmd ("debug", no_class,
2459 _("Generic command for showing gdb debugging flags."),
2f822da5 2460 &showdebuglist, 0, &showlist);
d318976c 2461
3947f654
SM
2462 cmd_list_element *shell_cmd
2463 = add_com ("shell", class_support, shell_command, _("\
1bedd215
AC
2464Execute the rest of the line as a shell command.\n\
2465With no arguments, run an inferior shell."));
3947f654 2466 set_cmd_completer (shell_cmd, filename_completer);
d318976c 2467
3947f654 2468 add_com_alias ("!", shell_cmd, class_support, 0);
d563b953 2469
1bedd215
AC
2470 c = add_com ("edit", class_files, edit_command, _("\
2471Edit specified file or function.\n\
0378c332 2472With no argument, edits file containing most recent line listed.\n\
0378c332
FN
2473Editing targets can be specified in these ways:\n\
2474 FILE:LINENUM, to edit at that line in that file,\n\
2475 FUNCTION, to edit at the beginning of that function,\n\
2476 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2477 *ADDRESS, to edit at the line containing that address.\n\
1bedd215 2478Uses EDITOR environment variable contents as editor (or ex as default)."));
0378c332
FN
2479
2480 c->completer = location_completer;
2481
3947f654
SM
2482 cmd_list_element *pipe_cmd
2483 = add_com ("pipe", class_support, pipe_command, _("\
947d3946
PW
2484Send the output of a gdb command to a shell command.\n\
2485Usage: | [COMMAND] | SHELL_COMMAND\n\
2486Usage: | -d DELIM COMMAND DELIM SHELL_COMMAND\n\
2487Usage: pipe [COMMAND] | SHELL_COMMAND\n\
2488Usage: pipe -d DELIM COMMAND DELIM SHELL_COMMAND\n\
2489\n\
2490Executes COMMAND and sends its output to SHELL_COMMAND.\n\
2491\n\
2492The -d option indicates to use the string DELIM to separate COMMAND\n\
2493from SHELL_COMMAND, in alternative to |. This is useful in\n\
2494case COMMAND contains a | character.\n\
2495\n\
2496With no COMMAND, repeat the last executed command\n\
2497and send its output to SHELL_COMMAND."));
3947f654
SM
2498 set_cmd_completer_handle_brkchars (pipe_cmd, pipe_command_completer);
2499 add_com_alias ("|", pipe_cmd, class_support, 0);
947d3946 2500
3947f654
SM
2501 cmd_list_element *list_cmd
2502 = add_com ("list", class_files, list_command, _("\
1bedd215 2503List specified function or line.\n\
0378c332
FN
2504With no argument, lists ten more lines after or around previous listing.\n\
2505\"list -\" lists the ten lines before a previous ten-line listing.\n\
2506One argument specifies a line, and ten lines are listed around that line.\n\
2507Two arguments with comma between specify starting and ending lines to list.\n\
0378c332
FN
2508Lines can be specified in these ways:\n\
2509 LINENUM, to list around that line in current file,\n\
2510 FILE:LINENUM, to list around that line in that file,\n\
2511 FUNCTION, to list around beginning of that function,\n\
2512 FILE:FUNCTION, to distinguish among like-named static functions.\n\
2513 *ADDRESS, to list around the line containing that address.\n\
4fdd372d
AB
2514With two args, if one is empty, it stands for ten lines away from\n\
2515the other arg.\n\
2516\n\
2517By default, when a single location is given, display ten lines.\n\
2518This can be changed using \"set listsize\", and the current value\n\
2519can be shown using \"show listsize\"."));
0378c332 2520
3947f654 2521 add_com_alias ("l", list_cmd, class_files, 1);
0378c332
FN
2522
2523 if (dbx_commands)
3947f654 2524 add_com_alias ("file", list_cmd, class_files, 1);
0378c332 2525
1bedd215
AC
2526 c = add_com ("disassemble", class_vars, disassemble_command, _("\
2527Disassemble a specified section of memory.\n\
16f3242c 2528Usage: disassemble[/m|/r|/s] START [, END]\n\
83c31e7d 2529Default is the function surrounding the pc of the selected frame.\n\
6ff0ba5f 2530\n\
16f3242c
TT
2531With a /s modifier, source lines are included (if available).\n\
2532In this mode, the output is displayed in PC address order, and\n\
2533file names and contents for all relevant source files are displayed.\n\
2534\n\
d14508fe 2535With a /m modifier, source lines are included (if available).\n\
6ff0ba5f
DE
2536This view is \"source centric\": the output is in source line order,\n\
2537regardless of any optimization that is present. Only the main source file\n\
2538is displayed, not those of, e.g., any inlined functions.\n\
2539This modifier hasn't proved useful in practice and is deprecated\n\
2540in favor of /s.\n\
2541\n\
e6158f16 2542With a /r modifier, raw instructions in hex are included.\n\
6ff0ba5f 2543\n\
83c31e7d 2544With a single argument, the function surrounding that address is dumped.\n\
53a71c06 2545Two arguments (separated by a comma) are taken as a range of memory to dump,\n\
7e1e0340
DE
2546 in the form of \"start,end\", or \"start,+length\".\n\
2547\n\
2548Note that the address is interpreted as an expression, not as a location\n\
2549like in the \"break\" command.\n\
2550So, for example, if you want to disassemble function bar in file foo.c\n\
2551you must type \"disassemble 'foo.c'::bar\" and not \"disassemble foo.c:bar\"."));
83c31e7d 2552 set_cmd_completer (c, location_completer);
0378c332 2553
1bedd215
AC
2554 c = add_com ("make", class_support, make_command, _("\
2555Run the ``make'' program using the rest of the line as arguments."));
5ba2abeb 2556 set_cmd_completer (c, filename_completer);
1a966eab 2557 add_cmd ("user", no_class, show_user, _("\
ed3ef339 2558Show definitions of non-python/scheme user defined commands.\n\
d318976c 2559Argument is the name of the user defined command.\n\
1a966eab 2560With no argument, show definitions of all user defined commands."), &showlist);
66d8c862 2561 add_com ("apropos", class_support, apropos_command, _("\
590042fc 2562Search for commands matching a REGEXP.\n\
66d8c862
PW
2563Usage: apropos [-v] REGEXP\n\
2564Flag -v indicates to produce a verbose output, showing full documentation\n\
2565of the matching commands."));
20f01a46 2566
883b9c6c 2567 add_setshow_uinteger_cmd ("max-user-call-depth", no_class,
c0d88b1b 2568 &max_user_call_depth, _("\
ed3ef339
DE
2569Set the max call depth for non-python/scheme user-defined commands."), _("\
2570Show the max call depth for non-python/scheme user-defined commands."), NULL,
883b9c6c
YQ
2571 NULL,
2572 show_max_user_call_depth,
2573 &setlist, &showlist);
16026cd7
AS
2574
2575 add_setshow_boolean_cmd ("trace-commands", no_class, &trace_commands, _("\
2576Set tracing of GDB CLI commands."), _("\
2577Show state of GDB CLI command tracing."), _("\
2578When 'on', each command is displayed as it is executed."),
2579 NULL,
2580 NULL,
2581 &setlist, &showlist);
5a56e9c5 2582
cf00cd6f
PW
2583 const auto alias_opts = make_alias_options_def_group (nullptr);
2584
2585 static std::string alias_help
2586 = gdb::option::build_help (_("\
5a56e9c5 2587Define a new command that is an alias of an existing command.\n\
cf00cd6f 2588Usage: alias [-a] [--] ALIAS = COMMAND [DEFAULT-ARGS...]\n\
5a56e9c5
DE
2589ALIAS is the name of the alias command to create.\n\
2590COMMAND is the command being aliased to.\n\
cf00cd6f
PW
2591\n\
2592Options:\n\
2593%OPTIONS%\n\
2594\n\
2595GDB will automatically prepend the provided DEFAULT-ARGS to the list\n\
2596of arguments explicitly provided when using ALIAS.\n\
2597Use \"help aliases\" to list all user defined aliases and their default args.\n\
5a56e9c5
DE
2598\n\
2599Examples:\n\
2600Make \"spe\" an alias of \"set print elements\":\n\
e0c45ded 2601 alias spe = set print elements\n\
5a56e9c5 2602Make \"elms\" an alias of \"elements\" in the \"set print\" command:\n\
e0c45ded 2603 alias -a set print elms = set print elements\n\
cf00cd6f
PW
2604Make \"btf\" an alias of \"backtrace -full -past-entry -past-main\" :\n\
2605 alias btf = backtrace -full -past-entry -past-main\n\
2606Make \"wLapPeu\" an alias of 2 nested \"with\":\n\
2607 alias wLapPeu = with language pascal -- with print elements unlimited --"),
2608 alias_opts);
2609
2610 c = add_com ("alias", class_support, alias_command,
2611 alias_help.c_str ());
2612
2613 set_cmd_completer_handle_brkchars (c, alias_command_completer);
43e4916f 2614
b777eb6d 2615 const char *source_help_text = xstrprintf (_("\
43e4916f
TT
2616Read commands from a file named FILE.\n\
2617\n\
2618Usage: source [-s] [-v] FILE\n\
2619-s: search for the script in the source search path,\n\
2620 even if FILE contains directories.\n\
2621-v: each command in FILE is echoed as it is executed.\n\
2622\n\
2623Note that the file \"%s\" is read automatically in this way\n\
b777eb6d 2624when GDB is started."), GDBINIT);
43e4916f
TT
2625 c = add_cmd ("source", class_support, source_command,
2626 source_help_text, &cmdlist);
2627 set_cmd_completer (c, filename_completer);
2628}
This page took 1.818719 seconds and 4 git commands to generate.