* gdb.base/valgrind-db-attach.exp: Use unique test name for
[deliverable/binutils-gdb.git] / gdb / utils.c
CommitLineData
c906108c 1/* General utility routines for GDB, the GNU debugger.
1bac305b 2
6aba47ca 3 Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
0fb0cc75 4 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
4c38e0a4 5 2009, 2010 Free Software Foundation, Inc.
c906108c 6
c5aa993b 7 This file is part of GDB.
c906108c 8
c5aa993b
JM
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
a9762ec7 11 the Free Software Foundation; either version 3 of the License, or
c5aa993b 12 (at your option) any later version.
c906108c 13
c5aa993b
JM
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
c906108c 18
c5aa993b 19 You should have received a copy of the GNU General Public License
a9762ec7 20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c906108c 21
4e8f7a8b
DJ
22#include "defs.h"
23#include "gdb_assert.h"
24#include <ctype.h>
25#include "gdb_string.h"
26#include "event-top.h"
60250e8b 27#include "exceptions.h"
95e54da7 28#include "gdbthread.h"
7991dee7
JK
29#ifdef HAVE_SYS_RESOURCE_H
30#include <sys/resource.h>
31#endif /* HAVE_SYS_RESOURCE_H */
4e8f7a8b 32
6a83354a
AC
33#ifdef TUI
34#include "tui/tui.h" /* For tui_get_command_dimension. */
35#endif
36
9d271fd8
AC
37#ifdef __GO32__
38#include <pc.h>
39#endif
40
c906108c
SS
41/* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
42#ifdef reg
43#undef reg
44#endif
45
042be3a9 46#include <signal.h>
c906108c
SS
47#include "gdbcmd.h"
48#include "serial.h"
49#include "bfd.h"
50#include "target.h"
51#include "demangle.h"
52#include "expression.h"
53#include "language.h"
234b45d4 54#include "charset.h"
c906108c 55#include "annotate.h"
303c8ebd 56#include "filenames.h"
7b90c3f9 57#include "symfile.h"
ae5a43e0 58#include "gdb_obstack.h"
9544c605 59#include "gdbcore.h"
698ba934 60#include "top.h"
7c953934 61#include "main.h"
c906108c 62
8731e58e 63#include "inferior.h" /* for signed_pointer_to_address */
ac2e2ef7 64
2d1b2124
AC
65#include <sys/param.h> /* For MAXPATHLEN */
66
3b78cdbb 67#include "gdb_curses.h"
020cc13c 68
dbda9972 69#include "readline/readline.h"
c906108c 70
75feb17d
DJ
71#include <sys/time.h>
72#include <time.h>
73
8626589c 74#include "gdb_usleep.h"
390a8aca 75#include "interps.h"
8626589c 76
a3828db0 77#if !HAVE_DECL_MALLOC
5ac79d78 78extern PTR malloc (); /* ARI: PTR */
3c37485b 79#endif
a3828db0 80#if !HAVE_DECL_REALLOC
5ac79d78 81extern PTR realloc (); /* ARI: PTR */
0e52036f 82#endif
a3828db0 83#if !HAVE_DECL_FREE
81b8eb80
AC
84extern void free ();
85#endif
81b8eb80 86
c906108c
SS
87/* readline defines this. */
88#undef savestring
89
9a4105ab 90void (*deprecated_error_begin_hook) (void);
c906108c
SS
91
92/* Prototypes for local functions */
93
d9fcf2fb 94static void vfprintf_maybe_filtered (struct ui_file *, const char *,
a0b31db1 95 va_list, int) ATTRIBUTE_PRINTF (2, 0);
c906108c 96
d9fcf2fb 97static void fputs_maybe_filtered (const char *, struct ui_file *, int);
c906108c 98
e42c9534
AC
99static void do_my_cleanups (struct cleanup **, struct cleanup *);
100
a14ed312 101static void prompt_for_continue (void);
c906108c 102
eb0d3137 103static void set_screen_size (void);
a14ed312 104static void set_width (void);
c906108c 105
75feb17d
DJ
106/* A flag indicating whether to timestamp debugging messages. */
107
108static int debug_timestamp = 0;
109
c906108c
SS
110/* Chain of cleanup actions established with make_cleanup,
111 to be executed if an error happens. */
112
c5aa993b
JM
113static struct cleanup *cleanup_chain; /* cleaned up after a failed command */
114static struct cleanup *final_cleanup_chain; /* cleaned up when gdb exits */
43ff13b4 115
c906108c
SS
116/* Nonzero if we have job control. */
117
118int job_control;
119
120/* Nonzero means a quit has been requested. */
121
122int quit_flag;
123
124/* Nonzero means quit immediately if Control-C is typed now, rather
125 than waiting until QUIT is executed. Be careful in setting this;
126 code which executes with immediate_quit set has to be very careful
127 about being able to deal with being interrupted at any time. It is
128 almost always better to use QUIT; the only exception I can think of
129 is being able to quit out of a system call (using EINTR loses if
130 the SIGINT happens between the previous QUIT and the system call).
131 To immediately quit in the case in which a SIGINT happens between
132 the previous QUIT and setting immediate_quit (desirable anytime we
133 expect to block), call QUIT after setting immediate_quit. */
134
135int immediate_quit;
136
4a351cef
AF
137/* Nonzero means that encoded C++/ObjC names should be printed out in their
138 C++/ObjC form rather than raw. */
c906108c
SS
139
140int demangle = 1;
920d2a44
AC
141static void
142show_demangle (struct ui_file *file, int from_tty,
143 struct cmd_list_element *c, const char *value)
144{
145 fprintf_filtered (file, _("\
146Demangling of encoded C++/ObjC names when displaying symbols is %s.\n"),
147 value);
148}
c906108c 149
4a351cef
AF
150/* Nonzero means that encoded C++/ObjC names should be printed out in their
151 C++/ObjC form even in assembler language displays. If this is set, but
c906108c
SS
152 DEMANGLE is zero, names are printed raw, i.e. DEMANGLE controls. */
153
154int asm_demangle = 0;
920d2a44
AC
155static void
156show_asm_demangle (struct ui_file *file, int from_tty,
157 struct cmd_list_element *c, const char *value)
158{
159 fprintf_filtered (file, _("\
160Demangling of C++/ObjC names in disassembly listings is %s.\n"),
161 value);
162}
c906108c
SS
163
164/* Nonzero means that strings with character values >0x7F should be printed
165 as octal escapes. Zero means just print the value (e.g. it's an
166 international character, and the terminal or window can cope.) */
167
168int sevenbit_strings = 0;
920d2a44
AC
169static void
170show_sevenbit_strings (struct ui_file *file, int from_tty,
171 struct cmd_list_element *c, const char *value)
172{
173 fprintf_filtered (file, _("\
174Printing of 8-bit characters in strings as \\nnn is %s.\n"),
175 value);
176}
c906108c
SS
177
178/* String to be printed before error messages, if any. */
179
180char *error_pre_print;
181
182/* String to be printed before quit messages, if any. */
183
184char *quit_pre_print;
185
186/* String to be printed before warning messages, if any. */
187
188char *warning_pre_print = "\nwarning: ";
189
190int pagination_enabled = 1;
920d2a44
AC
191static void
192show_pagination_enabled (struct ui_file *file, int from_tty,
193 struct cmd_list_element *c, const char *value)
194{
195 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
196}
197
c906108c 198\f
c5aa993b 199
c906108c
SS
200/* Add a new cleanup to the cleanup_chain,
201 and return the previous chain pointer
202 to be passed later to do_cleanups or discard_cleanups.
203 Args are FUNCTION to clean up with, and ARG to pass to it. */
204
205struct cleanup *
e4005526 206make_cleanup (make_cleanup_ftype *function, void *arg)
c906108c 207{
c5aa993b 208 return make_my_cleanup (&cleanup_chain, function, arg);
c906108c
SS
209}
210
4f8d22e3
PA
211struct cleanup *
212make_cleanup_dtor (make_cleanup_ftype *function, void *arg,
213 void (*dtor) (void *))
214{
215 return make_my_cleanup2 (&cleanup_chain,
216 function, arg, dtor);
217}
218
c906108c 219struct cleanup *
e4005526 220make_final_cleanup (make_cleanup_ftype *function, void *arg)
c906108c 221{
c5aa993b 222 return make_my_cleanup (&final_cleanup_chain, function, arg);
c906108c 223}
7a292a7a 224
7a292a7a 225static void
fba45db2 226do_freeargv (void *arg)
7a292a7a 227{
c5aa993b 228 freeargv ((char **) arg);
7a292a7a
SS
229}
230
231struct cleanup *
fba45db2 232make_cleanup_freeargv (char **arg)
7a292a7a
SS
233{
234 return make_my_cleanup (&cleanup_chain, do_freeargv, arg);
235}
236
5c65bbb6
AC
237static void
238do_bfd_close_cleanup (void *arg)
239{
240 bfd_close (arg);
241}
242
243struct cleanup *
244make_cleanup_bfd_close (bfd *abfd)
245{
246 return make_cleanup (do_bfd_close_cleanup, abfd);
247}
248
f5ff8c83
AC
249static void
250do_close_cleanup (void *arg)
251{
f042532c 252 int *fd = arg;
e0627e85 253
f042532c 254 close (*fd);
f5ff8c83
AC
255}
256
257struct cleanup *
258make_cleanup_close (int fd)
259{
f042532c 260 int *saved_fd = xmalloc (sizeof (fd));
e0627e85 261
f042532c 262 *saved_fd = fd;
a05016c0 263 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
f5ff8c83
AC
264}
265
7c8a8b04
TT
266/* Helper function which does the work for make_cleanup_fclose. */
267
268static void
269do_fclose_cleanup (void *arg)
270{
c02866a0 271 FILE *file = arg;
e0627e85 272
c02866a0 273 fclose (file);
7c8a8b04
TT
274}
275
276/* Return a new cleanup that closes FILE. */
277
278struct cleanup *
279make_cleanup_fclose (FILE *file)
280{
281 return make_cleanup (do_fclose_cleanup, file);
282}
283
16ad9370
TT
284/* Helper function which does the work for make_cleanup_obstack_free. */
285
286static void
287do_obstack_free (void *arg)
288{
289 struct obstack *ob = arg;
e0627e85 290
16ad9370
TT
291 obstack_free (ob, NULL);
292}
293
294/* Return a new cleanup that frees OBSTACK. */
295
296struct cleanup *
297make_cleanup_obstack_free (struct obstack *obstack)
298{
299 return make_cleanup (do_obstack_free, obstack);
300}
301
11cf8741 302static void
d9fcf2fb 303do_ui_file_delete (void *arg)
11cf8741 304{
d9fcf2fb 305 ui_file_delete (arg);
11cf8741
JM
306}
307
308struct cleanup *
d9fcf2fb 309make_cleanup_ui_file_delete (struct ui_file *arg)
11cf8741 310{
d9fcf2fb 311 return make_my_cleanup (&cleanup_chain, do_ui_file_delete, arg);
11cf8741
JM
312}
313
7b90c3f9
JB
314static void
315do_free_section_addr_info (void *arg)
316{
317 free_section_addr_info (arg);
318}
319
320struct cleanup *
321make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
322{
323 return make_my_cleanup (&cleanup_chain, do_free_section_addr_info, addrs);
324}
325
0b080f59
VP
326struct restore_integer_closure
327{
328 int *variable;
329 int value;
330};
331
332static void
333restore_integer (void *p)
334{
335 struct restore_integer_closure *closure = p;
e0627e85 336
0b080f59
VP
337 *(closure->variable) = closure->value;
338}
7b90c3f9 339
0b080f59
VP
340/* Remember the current value of *VARIABLE and make it restored when the cleanup
341 is run. */
c906108c 342struct cleanup *
0b080f59
VP
343make_cleanup_restore_integer (int *variable)
344{
345 struct restore_integer_closure *c =
346 xmalloc (sizeof (struct restore_integer_closure));
e0627e85 347
0b080f59
VP
348 c->variable = variable;
349 c->value = *variable;
350
351 return make_my_cleanup2 (&cleanup_chain, restore_integer, (void *)c,
352 xfree);
353}
354
c0edd9ed
JK
355/* Helper for make_cleanup_unpush_target. */
356
357static void
358do_unpush_target (void *arg)
359{
360 struct target_ops *ops = arg;
361
362 unpush_target (ops);
363}
364
365/* Return a new cleanup that unpushes OPS. */
366
367struct cleanup *
368make_cleanup_unpush_target (struct target_ops *ops)
369{
370 return make_my_cleanup (&cleanup_chain, do_unpush_target, ops);
371}
372
0b080f59
VP
373struct cleanup *
374make_my_cleanup2 (struct cleanup **pmy_chain, make_cleanup_ftype *function,
375 void *arg, void (*free_arg) (void *))
c906108c 376{
52f0bd74 377 struct cleanup *new
8731e58e 378 = (struct cleanup *) xmalloc (sizeof (struct cleanup));
52f0bd74 379 struct cleanup *old_chain = *pmy_chain;
c906108c
SS
380
381 new->next = *pmy_chain;
382 new->function = function;
0b080f59 383 new->free_arg = free_arg;
c906108c
SS
384 new->arg = arg;
385 *pmy_chain = new;
386
387 return old_chain;
388}
389
0b080f59
VP
390struct cleanup *
391make_my_cleanup (struct cleanup **pmy_chain, make_cleanup_ftype *function,
392 void *arg)
393{
394 return make_my_cleanup2 (pmy_chain, function, arg, NULL);
395}
396
c906108c
SS
397/* Discard cleanups and do the actions they describe
398 until we get back to the point OLD_CHAIN in the cleanup_chain. */
399
400void
aa1ee363 401do_cleanups (struct cleanup *old_chain)
c906108c 402{
c5aa993b 403 do_my_cleanups (&cleanup_chain, old_chain);
c906108c
SS
404}
405
406void
aa1ee363 407do_final_cleanups (struct cleanup *old_chain)
c906108c 408{
c5aa993b 409 do_my_cleanups (&final_cleanup_chain, old_chain);
c906108c
SS
410}
411
e42c9534 412static void
aa1ee363
AC
413do_my_cleanups (struct cleanup **pmy_chain,
414 struct cleanup *old_chain)
c906108c 415{
52f0bd74 416 struct cleanup *ptr;
e0627e85 417
c906108c
SS
418 while ((ptr = *pmy_chain) != old_chain)
419 {
420 *pmy_chain = ptr->next; /* Do this first incase recursion */
421 (*ptr->function) (ptr->arg);
0b080f59
VP
422 if (ptr->free_arg)
423 (*ptr->free_arg) (ptr->arg);
b8c9b27d 424 xfree (ptr);
c906108c
SS
425 }
426}
427
428/* Discard cleanups, not doing the actions they describe,
429 until we get back to the point OLD_CHAIN in the cleanup_chain. */
430
431void
aa1ee363 432discard_cleanups (struct cleanup *old_chain)
c906108c 433{
c5aa993b 434 discard_my_cleanups (&cleanup_chain, old_chain);
c906108c
SS
435}
436
437void
aa1ee363 438discard_final_cleanups (struct cleanup *old_chain)
c906108c 439{
c5aa993b 440 discard_my_cleanups (&final_cleanup_chain, old_chain);
c906108c
SS
441}
442
443void
aa1ee363
AC
444discard_my_cleanups (struct cleanup **pmy_chain,
445 struct cleanup *old_chain)
c906108c 446{
52f0bd74 447 struct cleanup *ptr;
e0627e85 448
c906108c
SS
449 while ((ptr = *pmy_chain) != old_chain)
450 {
451 *pmy_chain = ptr->next;
0b080f59
VP
452 if (ptr->free_arg)
453 (*ptr->free_arg) (ptr->arg);
b8c9b27d 454 xfree (ptr);
c906108c
SS
455 }
456}
457
458/* Set the cleanup_chain to 0, and return the old cleanup chain. */
459struct cleanup *
fba45db2 460save_cleanups (void)
c906108c 461{
c5aa993b 462 return save_my_cleanups (&cleanup_chain);
c906108c
SS
463}
464
465struct cleanup *
fba45db2 466save_final_cleanups (void)
c906108c 467{
c5aa993b 468 return save_my_cleanups (&final_cleanup_chain);
c906108c
SS
469}
470
471struct cleanup *
fba45db2 472save_my_cleanups (struct cleanup **pmy_chain)
c906108c
SS
473{
474 struct cleanup *old_chain = *pmy_chain;
475
476 *pmy_chain = 0;
477 return old_chain;
478}
479
480/* Restore the cleanup chain from a previously saved chain. */
481void
fba45db2 482restore_cleanups (struct cleanup *chain)
c906108c 483{
c5aa993b 484 restore_my_cleanups (&cleanup_chain, chain);
c906108c
SS
485}
486
487void
fba45db2 488restore_final_cleanups (struct cleanup *chain)
c906108c 489{
c5aa993b 490 restore_my_cleanups (&final_cleanup_chain, chain);
c906108c
SS
491}
492
493void
fba45db2 494restore_my_cleanups (struct cleanup **pmy_chain, struct cleanup *chain)
c906108c
SS
495{
496 *pmy_chain = chain;
497}
498
499/* This function is useful for cleanups.
500 Do
501
c5aa993b
JM
502 foo = xmalloc (...);
503 old_chain = make_cleanup (free_current_contents, &foo);
c906108c
SS
504
505 to arrange to free the object thus allocated. */
506
507void
2f9429ae 508free_current_contents (void *ptr)
c906108c 509{
2f9429ae 510 void **location = ptr;
e0627e85 511
e2f9c474 512 if (location == NULL)
8e65ff28 513 internal_error (__FILE__, __LINE__,
e2e0b3e5 514 _("free_current_contents: NULL pointer"));
2f9429ae 515 if (*location != NULL)
e2f9c474 516 {
b8c9b27d 517 xfree (*location);
e2f9c474
AC
518 *location = NULL;
519 }
c906108c
SS
520}
521
522/* Provide a known function that does nothing, to use as a base for
523 for a possibly long chain of cleanups. This is useful where we
524 use the cleanup chain for handling normal cleanups as well as dealing
525 with cleanups that need to be done as a result of a call to error().
526 In such cases, we may not be certain where the first cleanup is, unless
527 we have a do-nothing one to always use as the base. */
528
c906108c 529void
e4005526 530null_cleanup (void *arg)
c906108c
SS
531{
532}
533
0f3bb72e
PH
534/* If nonzero, display time usage both at startup and for each command. */
535
536static int display_time;
537
538/* If nonzero, display space usage both at startup and for each command. */
539
540static int display_space;
541
542/* Records a run time and space usage to be used as a base for
543 reporting elapsed time or change in space. In addition,
544 the msg_type field indicates whether the saved time is from the
545 beginning of GDB execution (0) or the beginning of an individual
546 command execution (1). */
547struct cmd_stats
548{
549 int msg_type;
550 long start_time;
551 long start_space;
552};
553
554/* Set whether to display time statistics to NEW_VALUE (non-zero
555 means true). */
556void
557set_display_time (int new_value)
558{
559 display_time = new_value;
560}
561
562/* Set whether to display space statistics to NEW_VALUE (non-zero
563 means true). */
564void
565set_display_space (int new_value)
566{
567 display_space = new_value;
568}
569
570/* As indicated by display_time and display_space, report GDB's elapsed time
571 and space usage from the base time and space provided in ARG, which
572 must be a pointer to a struct cmd_stat. This function is intended
573 to be called as a cleanup. */
574static void
575report_command_stats (void *arg)
576{
577 struct cmd_stats *start_stats = (struct cmd_stats *) arg;
578 int msg_type = start_stats->msg_type;
579
580 if (display_time)
581 {
582 long cmd_time = get_run_time () - start_stats->start_time;
583
584 printf_unfiltered (msg_type == 0
585 ? _("Startup time: %ld.%06ld\n")
586 : _("Command execution time: %ld.%06ld\n"),
587 cmd_time / 1000000, cmd_time % 1000000);
588 }
589
590 if (display_space)
591 {
592#ifdef HAVE_SBRK
593 char *lim = (char *) sbrk (0);
594
595 long space_now = lim - lim_at_start;
596 long space_diff = space_now - start_stats->start_space;
597
598 printf_unfiltered (msg_type == 0
599 ? _("Space used: %ld (%c%ld during startup)\n")
600 : _("Space used: %ld (%c%ld for this command)\n"),
601 space_now,
602 (space_diff >= 0 ? '+' : '-'),
603 space_diff);
604#endif
605 }
606}
607
608/* Create a cleanup that reports time and space used since its
609 creation. Precise messages depend on MSG_TYPE:
610 0: Initial time/space
611 1: Individual command time/space. */
612struct cleanup *
613make_command_stats_cleanup (int msg_type)
614{
615 struct cmd_stats *new_stat = XMALLOC (struct cmd_stats);
616
617#ifdef HAVE_SBRK
618 char *lim = (char *) sbrk (0);
619 new_stat->start_space = lim - lim_at_start;
620#endif
621
622 new_stat->msg_type = msg_type;
623 new_stat->start_time = get_run_time ();
624
625 return make_cleanup_dtor (report_command_stats, new_stat, xfree);
626}
627
0ffe5012
PA
628/* Continuations are implemented as cleanups internally. Inherit from
629 cleanups. */
630struct continuation
631{
632 struct cleanup base;
633};
634
95e54da7
PA
635/* Add a continuation to the continuation list of THREAD. The new
636 continuation will be added at the front. */
43ff13b4 637void
95e54da7
PA
638add_continuation (struct thread_info *thread,
639 void (*continuation_hook) (void *), void *args,
604ead4a 640 void (*continuation_free_args) (void *))
43ff13b4 641{
95e54da7 642 struct cleanup *as_cleanup = &thread->continuations->base;
604ead4a 643 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
43ff13b4 644
0ffe5012 645 make_my_cleanup2 (&as_cleanup,
604ead4a
PA
646 continuation_hook_fn,
647 args,
648 continuation_free_args);
0ffe5012 649
95e54da7 650 thread->continuations = (struct continuation *) as_cleanup;
43ff13b4
JM
651}
652
e0ba6746
PA
653/* Add a continuation to the continuation list of INFERIOR. The new
654 continuation will be added at the front. */
655
656void
657add_inferior_continuation (void (*continuation_hook) (void *), void *args,
658 void (*continuation_free_args) (void *))
659{
660 struct inferior *inf = current_inferior ();
661 struct cleanup *as_cleanup = &inf->continuations->base;
662 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
663
664 make_my_cleanup2 (&as_cleanup,
665 continuation_hook_fn,
666 args,
667 continuation_free_args);
668
669 inf->continuations = (struct continuation *) as_cleanup;
670}
671
672/* Do all continuations of the current inferior. */
673
674void
675do_all_inferior_continuations (void)
676{
e0ba6746
PA
677 struct cleanup *as_cleanup;
678 struct inferior *inf = current_inferior ();
679
680 if (inf->continuations == NULL)
681 return;
682
683 /* Copy the list header into another pointer, and set the global
684 list header to null, so that the global list can change as a side
685 effect of invoking the continuations and the processing of the
686 preexisting continuations will not be affected. */
687
688 as_cleanup = &inf->continuations->base;
689 inf->continuations = NULL;
690
691 /* Work now on the list we have set aside. */
692 do_my_cleanups (&as_cleanup, NULL);
693}
694
695/* Get rid of all the inferior-wide continuations of INF. */
696
697void
698discard_all_inferior_continuations (struct inferior *inf)
699{
700 struct cleanup *continuation_ptr = &inf->continuations->base;
e0627e85 701
e0ba6746
PA
702 discard_my_cleanups (&continuation_ptr, NULL);
703 inf->continuations = NULL;
704}
705
95e54da7
PA
706static void
707restore_thread_cleanup (void *arg)
708{
709 ptid_t *ptid_p = arg;
e0627e85 710
95e54da7
PA
711 switch_to_thread (*ptid_p);
712}
713
714/* Walk down the continuation list of PTID, and execute all the
715 continuations. There is a problem though. In some cases new
716 continuations may be added while we are in the middle of this loop.
717 If this happens they will be added in the front, and done before we
718 have a chance of exhausting those that were already there. We need
719 to then save the beginning of the list in a pointer and do the
720 continuations from there on, instead of using the global beginning
721 of list as our iteration pointer. */
722static void
723do_all_continuations_ptid (ptid_t ptid,
724 struct continuation **continuations_p)
c2d11a7d 725{
95e54da7
PA
726 struct cleanup *old_chain;
727 ptid_t current_thread;
728 struct cleanup *as_cleanup;
729
730 if (*continuations_p == NULL)
731 return;
732
733 current_thread = inferior_ptid;
734
735 /* Restore selected thread on exit. Don't try to restore the frame
736 as well, because:
737
738 - When running continuations, the selected frame is always #0.
739
740 - The continuations may trigger symbol file loads, which may
741 change the frame layout (frame ids change), which would trigger
742 a warning if we used make_cleanup_restore_current_thread. */
743
744 old_chain = make_cleanup (restore_thread_cleanup, &current_thread);
745
746 /* Let the continuation see this thread as selected. */
747 switch_to_thread (ptid);
c2d11a7d
JM
748
749 /* Copy the list header into another pointer, and set the global
750 list header to null, so that the global list can change as a side
604ead4a
PA
751 effect of invoking the continuations and the processing of the
752 preexisting continuations will not be affected. */
753
95e54da7
PA
754 as_cleanup = &(*continuations_p)->base;
755 *continuations_p = NULL;
c2d11a7d 756
0a4a0819 757 /* Work now on the list we have set aside. */
95e54da7
PA
758 do_my_cleanups (&as_cleanup, NULL);
759
760 do_cleanups (old_chain);
761}
762
763/* Callback for iterate over threads. */
764static int
765do_all_continuations_thread_callback (struct thread_info *thread, void *data)
766{
767 do_all_continuations_ptid (thread->ptid, &thread->continuations);
768 return 0;
c2d11a7d
JM
769}
770
95e54da7 771/* Do all continuations of thread THREAD. */
c2d11a7d 772void
95e54da7
PA
773do_all_continuations_thread (struct thread_info *thread)
774{
775 do_all_continuations_thread_callback (thread, NULL);
776}
777
778/* Do all continuations of all threads. */
779void
780do_all_continuations (void)
43ff13b4 781{
95e54da7
PA
782 iterate_over_threads (do_all_continuations_thread_callback, NULL);
783}
784
785/* Callback for iterate over threads. */
786static int
787discard_all_continuations_thread_callback (struct thread_info *thread,
788 void *data)
789{
790 struct cleanup *continuation_ptr = &thread->continuations->base;
e0627e85 791
0ffe5012 792 discard_my_cleanups (&continuation_ptr, NULL);
95e54da7
PA
793 thread->continuations = NULL;
794 return 0;
795}
796
797/* Get rid of all the continuations of THREAD. */
798void
799discard_all_continuations_thread (struct thread_info *thread)
800{
801 discard_all_continuations_thread_callback (thread, NULL);
802}
803
804/* Get rid of all the continuations of all threads. */
805void
806discard_all_continuations (void)
807{
808 iterate_over_threads (discard_all_continuations_thread_callback, NULL);
43ff13b4 809}
c2c6d25f 810
95e54da7
PA
811
812/* Add a continuation to the intermediate continuation list of THREAD.
813 The new continuation will be added at the front. */
c2d11a7d 814void
95e54da7
PA
815add_intermediate_continuation (struct thread_info *thread,
816 void (*continuation_hook)
604ead4a
PA
817 (void *), void *args,
818 void (*continuation_free_args) (void *))
c2d11a7d 819{
95e54da7 820 struct cleanup *as_cleanup = &thread->intermediate_continuations->base;
604ead4a 821 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
c2d11a7d 822
0ffe5012 823 make_my_cleanup2 (&as_cleanup,
604ead4a
PA
824 continuation_hook_fn,
825 args,
826 continuation_free_args);
0ffe5012 827
95e54da7 828 thread->intermediate_continuations = (struct continuation *) as_cleanup;
c2d11a7d
JM
829}
830
831/* Walk down the cmd_continuation list, and execute all the
832 continuations. There is a problem though. In some cases new
833 continuations may be added while we are in the middle of this
834 loop. If this happens they will be added in the front, and done
835 before we have a chance of exhausting those that were already
836 there. We need to then save the beginning of the list in a pointer
837 and do the continuations from there on, instead of using the
838 global beginning of list as our iteration pointer.*/
95e54da7
PA
839static int
840do_all_intermediate_continuations_thread_callback (struct thread_info *thread,
841 void *data)
842{
843 do_all_continuations_ptid (thread->ptid,
844 &thread->intermediate_continuations);
845 return 0;
846}
847
848/* Do all intermediate continuations of thread THREAD. */
c2d11a7d 849void
95e54da7 850do_all_intermediate_continuations_thread (struct thread_info *thread)
c2d11a7d 851{
95e54da7
PA
852 do_all_intermediate_continuations_thread_callback (thread, NULL);
853}
c2d11a7d 854
95e54da7
PA
855/* Do all intermediate continuations of all threads. */
856void
857do_all_intermediate_continuations (void)
858{
859 iterate_over_threads (do_all_intermediate_continuations_thread_callback, NULL);
860}
604ead4a 861
95e54da7
PA
862/* Callback for iterate over threads. */
863static int
864discard_all_intermediate_continuations_thread_callback (struct thread_info *thread,
865 void *data)
866{
867 struct cleanup *continuation_ptr = &thread->intermediate_continuations->base;
e0627e85 868
95e54da7
PA
869 discard_my_cleanups (&continuation_ptr, NULL);
870 thread->intermediate_continuations = NULL;
871 return 0;
872}
c2d11a7d 873
95e54da7
PA
874/* Get rid of all the intermediate continuations of THREAD. */
875void
876discard_all_intermediate_continuations_thread (struct thread_info *thread)
877{
878 discard_all_intermediate_continuations_thread_callback (thread, NULL);
c2d11a7d
JM
879}
880
95e54da7 881/* Get rid of all the intermediate continuations of all threads. */
c2c6d25f 882void
fba45db2 883discard_all_intermediate_continuations (void)
c2c6d25f 884{
95e54da7 885 iterate_over_threads (discard_all_intermediate_continuations_thread_callback, NULL);
c2c6d25f 886}
c906108c 887\f
c5aa993b 888
8731e58e 889
f5a96129
AC
890/* Print a warning message. The first argument STRING is the warning
891 message, used as an fprintf format string, the second is the
892 va_list of arguments for that string. A warning is unfiltered (not
893 paginated) so that the user does not need to page through each
894 screen full of warnings when there are lots of them. */
c906108c
SS
895
896void
f5a96129 897vwarning (const char *string, va_list args)
c906108c 898{
9a4105ab
AC
899 if (deprecated_warning_hook)
900 (*deprecated_warning_hook) (string, args);
f5a96129
AC
901 else
902 {
903 target_terminal_ours ();
904 wrap_here (""); /* Force out any buffered output */
905 gdb_flush (gdb_stdout);
906 if (warning_pre_print)
306d9ac5 907 fputs_unfiltered (warning_pre_print, gdb_stderr);
f5a96129
AC
908 vfprintf_unfiltered (gdb_stderr, string, args);
909 fprintf_unfiltered (gdb_stderr, "\n");
910 va_end (args);
911 }
c906108c
SS
912}
913
914/* Print a warning message.
915 The first argument STRING is the warning message, used as a fprintf string,
916 and the remaining args are passed as arguments to it.
917 The primary difference between warnings and errors is that a warning
918 does not force the return to command level. */
919
c906108c 920void
8731e58e 921warning (const char *string, ...)
c906108c
SS
922{
923 va_list args;
e0627e85 924
c906108c 925 va_start (args, string);
f5a96129
AC
926 vwarning (string, args);
927 va_end (args);
c906108c
SS
928}
929
c906108c
SS
930/* Print an error message and return to command level.
931 The first argument STRING is the error message, used as a fprintf string,
932 and the remaining args are passed as arguments to it. */
933
c25c4a8b 934void
4ce44c66
JM
935verror (const char *string, va_list args)
936{
6b1b7650 937 throw_verror (GENERIC_ERROR, string, args);
4ce44c66
JM
938}
939
c25c4a8b 940void
8731e58e 941error (const char *string, ...)
c906108c
SS
942{
943 va_list args;
e0627e85 944
c906108c 945 va_start (args, string);
6b1b7650 946 throw_verror (GENERIC_ERROR, string, args);
4ce44c66 947 va_end (args);
c906108c
SS
948}
949
d75e3c94
JJ
950/* Print an error message and quit.
951 The first argument STRING is the error message, used as a fprintf string,
952 and the remaining args are passed as arguments to it. */
953
c25c4a8b 954void
d75e3c94
JJ
955vfatal (const char *string, va_list args)
956{
6b1b7650 957 throw_vfatal (string, args);
d75e3c94
JJ
958}
959
c25c4a8b 960void
d75e3c94
JJ
961fatal (const char *string, ...)
962{
963 va_list args;
e0627e85 964
d75e3c94 965 va_start (args, string);
6b1b7650 966 throw_vfatal (string, args);
d75e3c94
JJ
967 va_end (args);
968}
969
c25c4a8b 970void
d75e3c94 971error_stream (struct ui_file *stream)
2acceee2 972{
759ef836 973 char *message = ui_file_xstrdup (stream, NULL);
e0627e85 974
6b1b7650 975 make_cleanup (xfree, message);
8a3fe4f8 976 error (("%s"), message);
2acceee2 977}
c906108c 978
7991dee7
JK
979/* Dump core trying to increase the core soft limit to hard limit first. */
980
981static void
982dump_core (void)
983{
984#ifdef HAVE_SETRLIMIT
985 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
986
987 setrlimit (RLIMIT_CORE, &rlim);
988#endif /* HAVE_SETRLIMIT */
989
990 abort (); /* NOTE: GDB has only three calls to abort(). */
991}
992
993/* Check whether GDB will be able to dump core using the dump_core function. */
994
995static int
996can_dump_core (const char *reason)
997{
998#ifdef HAVE_GETRLIMIT
999 struct rlimit rlim;
1000
1001 /* Be quiet and assume we can dump if an error is returned. */
1002 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
1003 return 1;
1004
1005 if (rlim.rlim_max == 0)
1006 {
1007 fprintf_unfiltered (gdb_stderr,
1008 _("%s\nUnable to dump core, use `ulimit -c unlimited'"
1009 " before executing GDB next time.\n"), reason);
1010 return 0;
1011 }
1012#endif /* HAVE_GETRLIMIT */
1013
1014 return 1;
1015}
1016
3c16cced
PA
1017/* Allow the user to configure the debugger behavior with respect to
1018 what to do when an internal problem is detected. */
1019
1020const char internal_problem_ask[] = "ask";
1021const char internal_problem_yes[] = "yes";
1022const char internal_problem_no[] = "no";
1023static const char *internal_problem_modes[] =
1024{
1025 internal_problem_ask,
1026 internal_problem_yes,
1027 internal_problem_no,
1028 NULL
1029};
3c16cced 1030
dec43320
AC
1031/* Print a message reporting an internal error/warning. Ask the user
1032 if they want to continue, dump core, or just exit. Return
1033 something to indicate a quit. */
c906108c 1034
dec43320 1035struct internal_problem
c906108c 1036{
dec43320 1037 const char *name;
3c16cced
PA
1038 const char *should_quit;
1039 const char *should_dump_core;
dec43320
AC
1040};
1041
1042/* Report a problem, internal to GDB, to the user. Once the problem
1043 has been reported, and assuming GDB didn't quit, the caller can
1044 either allow execution to resume or throw an error. */
1045
a0b31db1 1046static void ATTRIBUTE_PRINTF (4, 0)
dec43320 1047internal_vproblem (struct internal_problem *problem,
8731e58e 1048 const char *file, int line, const char *fmt, va_list ap)
dec43320 1049{
dec43320 1050 static int dejavu;
375fc983 1051 int quit_p;
7be570e7 1052 int dump_core_p;
714b1282 1053 char *reason;
c906108c 1054
dec43320 1055 /* Don't allow infinite error/warning recursion. */
714b1282
AC
1056 {
1057 static char msg[] = "Recursive internal problem.\n";
5d502164 1058
714b1282
AC
1059 switch (dejavu)
1060 {
1061 case 0:
1062 dejavu = 1;
1063 break;
1064 case 1:
1065 dejavu = 2;
1066 fputs_unfiltered (msg, gdb_stderr);
7991dee7 1067 abort (); /* NOTE: GDB has only three calls to abort(). */
714b1282
AC
1068 default:
1069 dejavu = 3;
bf1d7d9c
JB
1070 /* Newer GLIBC versions put the warn_unused_result attribute
1071 on write, but this is one of those rare cases where
1072 ignoring the return value is correct. Casting to (void)
1073 does not fix this problem. This is the solution suggested
1074 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
1075 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
7991dee7 1076 abort (); /* NOTE: GDB has only three calls to abort(). */
714b1282
AC
1077 exit (1);
1078 }
1079 }
c906108c 1080
dec43320 1081 /* Try to get the message out and at the start of a new line. */
4261bedc 1082 target_terminal_ours ();
dec43320
AC
1083 begin_line ();
1084
714b1282
AC
1085 /* Create a string containing the full error/warning message. Need
1086 to call query with this full string, as otherwize the reason
1087 (error/warning) and question become separated. Format using a
1088 style similar to a compiler error message. Include extra detail
1089 so that the user knows that they are living on the edge. */
1090 {
1091 char *msg;
5d502164 1092
e623b504 1093 msg = xstrvprintf (fmt, ap);
b435e160 1094 reason = xstrprintf ("\
714b1282
AC
1095%s:%d: %s: %s\n\
1096A problem internal to GDB has been detected,\n\
1097further debugging may prove unreliable.", file, line, problem->name, msg);
1098 xfree (msg);
1099 make_cleanup (xfree, reason);
1100 }
7be570e7 1101
3c16cced 1102 if (problem->should_quit == internal_problem_ask)
dec43320 1103 {
dec43320 1104 /* Default (yes/batch case) is to quit GDB. When in batch mode
3c16cced
PA
1105 this lessens the likelihood of GDB going into an infinite
1106 loop. */
26bb68be
PP
1107 if (caution == 0)
1108 {
1109 /* Emit the message and quit. */
1110 fputs_unfiltered (reason, gdb_stderr);
1111 fputs_unfiltered ("\n", gdb_stderr);
1112 quit_p = 1;
1113 }
1114 else
1115 quit_p = query (_("%s\nQuit this debugging session? "), reason);
dec43320 1116 }
3c16cced
PA
1117 else if (problem->should_quit == internal_problem_yes)
1118 quit_p = 1;
1119 else if (problem->should_quit == internal_problem_no)
1120 quit_p = 0;
1121 else
1122 internal_error (__FILE__, __LINE__, _("bad switch"));
dec43320 1123
3c16cced 1124 if (problem->should_dump_core == internal_problem_ask)
dec43320 1125 {
7991dee7
JK
1126 if (!can_dump_core (reason))
1127 dump_core_p = 0;
1128 else
1129 {
1130 /* Default (yes/batch case) is to dump core. This leaves a GDB
1131 `dropping' so that it is easier to see that something went
1132 wrong in GDB. */
1133 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
1134 }
dec43320 1135 }
3c16cced 1136 else if (problem->should_dump_core == internal_problem_yes)
7991dee7 1137 dump_core_p = can_dump_core (reason);
3c16cced
PA
1138 else if (problem->should_dump_core == internal_problem_no)
1139 dump_core_p = 0;
1140 else
1141 internal_error (__FILE__, __LINE__, _("bad switch"));
7be570e7 1142
375fc983 1143 if (quit_p)
7be570e7
JM
1144 {
1145 if (dump_core_p)
7991dee7 1146 dump_core ();
375fc983
AC
1147 else
1148 exit (1);
7be570e7
JM
1149 }
1150 else
1151 {
1152 if (dump_core_p)
375fc983 1153 {
9b265ec2 1154#ifdef HAVE_WORKING_FORK
375fc983 1155 if (fork () == 0)
7991dee7 1156 dump_core ();
9b265ec2 1157#endif
375fc983 1158 }
7be570e7 1159 }
96baa820
JM
1160
1161 dejavu = 0;
dec43320
AC
1162}
1163
1164static struct internal_problem internal_error_problem = {
3c16cced 1165 "internal-error", internal_problem_ask, internal_problem_ask
dec43320
AC
1166};
1167
c25c4a8b 1168void
8731e58e 1169internal_verror (const char *file, int line, const char *fmt, va_list ap)
dec43320
AC
1170{
1171 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
315a522e 1172 deprecated_throw_reason (RETURN_ERROR);
c906108c
SS
1173}
1174
c25c4a8b 1175void
8e65ff28 1176internal_error (const char *file, int line, const char *string, ...)
4ce44c66
JM
1177{
1178 va_list ap;
e0627e85 1179
4ce44c66 1180 va_start (ap, string);
8e65ff28 1181 internal_verror (file, line, string, ap);
4ce44c66
JM
1182 va_end (ap);
1183}
1184
dec43320 1185static struct internal_problem internal_warning_problem = {
3c16cced 1186 "internal-warning", internal_problem_ask, internal_problem_ask
dec43320
AC
1187};
1188
1189void
8731e58e 1190internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
dec43320
AC
1191{
1192 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
1193}
1194
1195void
1196internal_warning (const char *file, int line, const char *string, ...)
1197{
1198 va_list ap;
e0627e85 1199
dec43320
AC
1200 va_start (ap, string);
1201 internal_vwarning (file, line, string, ap);
1202 va_end (ap);
1203}
1204
3c16cced
PA
1205/* Dummy functions to keep add_prefix_cmd happy. */
1206
1207static void
1208set_internal_problem_cmd (char *args, int from_tty)
1209{
1210}
1211
1212static void
1213show_internal_problem_cmd (char *args, int from_tty)
1214{
1215}
1216
1217/* When GDB reports an internal problem (error or warning) it gives
1218 the user the opportunity to quit GDB and/or create a core file of
1219 the current debug session. This function registers a few commands
1220 that make it possible to specify that GDB should always or never
1221 quit or create a core file, without asking. The commands look
1222 like:
1223
1224 maint set PROBLEM-NAME quit ask|yes|no
1225 maint show PROBLEM-NAME quit
1226 maint set PROBLEM-NAME corefile ask|yes|no
1227 maint show PROBLEM-NAME corefile
1228
1229 Where PROBLEM-NAME is currently "internal-error" or
1230 "internal-warning". */
1231
1232static void
1233add_internal_problem_command (struct internal_problem *problem)
1234{
1235 struct cmd_list_element **set_cmd_list;
1236 struct cmd_list_element **show_cmd_list;
1237 char *set_doc;
1238 char *show_doc;
1239
1240 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
1241 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
1242 *set_cmd_list = NULL;
1243 *show_cmd_list = NULL;
1244
1245 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
1246 problem->name);
1247
1248 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
1249 problem->name);
1250
1251 add_prefix_cmd ((char*) problem->name,
1252 class_maintenance, set_internal_problem_cmd, set_doc,
1253 set_cmd_list,
c4f7c687
MK
1254 concat ("maintenance set ", problem->name, " ",
1255 (char *) NULL),
3c16cced
PA
1256 0/*allow-unknown*/, &maintenance_set_cmdlist);
1257
1258 add_prefix_cmd ((char*) problem->name,
1259 class_maintenance, show_internal_problem_cmd, show_doc,
1260 show_cmd_list,
c4f7c687
MK
1261 concat ("maintenance show ", problem->name, " ",
1262 (char *) NULL),
3c16cced
PA
1263 0/*allow-unknown*/, &maintenance_show_cmdlist);
1264
1265 set_doc = xstrprintf (_("\
1266Set whether GDB should quit when an %s is detected"),
1267 problem->name);
1268 show_doc = xstrprintf (_("\
1269Show whether GDB will quit when an %s is detected"),
1270 problem->name);
1271 add_setshow_enum_cmd ("quit", class_maintenance,
1272 internal_problem_modes,
1273 &problem->should_quit,
1274 set_doc,
1275 show_doc,
1276 NULL, /* help_doc */
1277 NULL, /* setfunc */
1278 NULL, /* showfunc */
1279 set_cmd_list,
1280 show_cmd_list);
1281
1eefb858
TT
1282 xfree (set_doc);
1283 xfree (show_doc);
1284
3c16cced
PA
1285 set_doc = xstrprintf (_("\
1286Set whether GDB should create a core file of GDB when %s is detected"),
1287 problem->name);
1288 show_doc = xstrprintf (_("\
1289Show whether GDB will create a core file of GDB when %s is detected"),
1290 problem->name);
1291 add_setshow_enum_cmd ("corefile", class_maintenance,
1292 internal_problem_modes,
1293 &problem->should_dump_core,
1294 set_doc,
1295 show_doc,
1296 NULL, /* help_doc */
1297 NULL, /* setfunc */
1298 NULL, /* showfunc */
1299 set_cmd_list,
1300 show_cmd_list);
1eefb858
TT
1301
1302 xfree (set_doc);
1303 xfree (show_doc);
3c16cced
PA
1304}
1305
c906108c
SS
1306/* Print the system error message for errno, and also mention STRING
1307 as the file name for which the error was encountered.
1308 Then return to command level. */
1309
c25c4a8b 1310void
6972bc8b 1311perror_with_name (const char *string)
c906108c
SS
1312{
1313 char *err;
1314 char *combined;
1315
1316 err = safe_strerror (errno);
1317 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1318 strcpy (combined, string);
1319 strcat (combined, ": ");
1320 strcat (combined, err);
1321
1322 /* I understand setting these is a matter of taste. Still, some people
1323 may clear errno but not know about bfd_error. Doing this here is not
1324 unreasonable. */
1325 bfd_set_error (bfd_error_no_error);
1326 errno = 0;
1327
8a3fe4f8 1328 error (_("%s."), combined);
c906108c
SS
1329}
1330
1331/* Print the system error message for ERRCODE, and also mention STRING
1332 as the file name for which the error was encountered. */
1333
1334void
6972bc8b 1335print_sys_errmsg (const char *string, int errcode)
c906108c
SS
1336{
1337 char *err;
1338 char *combined;
1339
1340 err = safe_strerror (errcode);
1341 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1342 strcpy (combined, string);
1343 strcat (combined, ": ");
1344 strcat (combined, err);
1345
1346 /* We want anything which was printed on stdout to come out first, before
1347 this message. */
1348 gdb_flush (gdb_stdout);
1349 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1350}
1351
1352/* Control C eventually causes this to be called, at a convenient time. */
1353
1354void
fba45db2 1355quit (void)
c906108c 1356{
7be570e7
JM
1357#ifdef __MSDOS__
1358 /* No steenking SIGINT will ever be coming our way when the
1359 program is resumed. Don't lie. */
e06e2353 1360 fatal ("Quit");
7be570e7 1361#else
c906108c 1362 if (job_control
8731e58e
AC
1363 /* If there is no terminal switching for this target, then we can't
1364 possibly get screwed by the lack of job control. */
c906108c 1365 || current_target.to_terminal_ours == NULL)
e06e2353 1366 fatal ("Quit");
c906108c 1367 else
e06e2353 1368 fatal ("Quit (expect signal SIGINT when the program is resumed)");
7be570e7 1369#endif
c906108c
SS
1370}
1371
c906108c 1372\f
c906108c
SS
1373/* Called when a memory allocation fails, with the number of bytes of
1374 memory requested in SIZE. */
1375
c25c4a8b 1376void
fba45db2 1377nomem (long size)
c906108c
SS
1378{
1379 if (size > 0)
1380 {
8e65ff28 1381 internal_error (__FILE__, __LINE__,
e2e0b3e5 1382 _("virtual memory exhausted: can't allocate %ld bytes."),
8731e58e 1383 size);
c906108c
SS
1384 }
1385 else
1386 {
e2e0b3e5 1387 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
c906108c
SS
1388 }
1389}
1390
c0e61796
AC
1391/* The xmalloc() (libiberty.h) family of memory management routines.
1392
1393 These are like the ISO-C malloc() family except that they implement
1394 consistent semantics and guard against typical memory management
7936743b 1395 problems. */
c0e61796
AC
1396
1397/* NOTE: These are declared using PTR to ensure consistency with
1398 "libiberty.h". xfree() is GDB local. */
1399
5ac79d78 1400PTR /* ARI: PTR */
c0e61796
AC
1401xmalloc (size_t size)
1402{
7936743b
AC
1403 void *val;
1404
1405 /* See libiberty/xmalloc.c. This function need's to match that's
1406 semantics. It never returns NULL. */
1407 if (size == 0)
1408 size = 1;
1409
5ac79d78 1410 val = malloc (size); /* ARI: malloc */
7936743b
AC
1411 if (val == NULL)
1412 nomem (size);
1413
1414 return (val);
c0e61796 1415}
c906108c 1416
5b90c7b5
AC
1417void *
1418xzalloc (size_t size)
1419{
1420 return xcalloc (1, size);
1421}
1422
5ac79d78
PM
1423PTR /* ARI: PTR */
1424xrealloc (PTR ptr, size_t size) /* ARI: PTR */
c906108c 1425{
0efffb96
AC
1426 void *val;
1427
1428 /* See libiberty/xmalloc.c. This function need's to match that's
1429 semantics. It never returns NULL. */
1430 if (size == 0)
1431 size = 1;
1432
1433 if (ptr != NULL)
5ac79d78 1434 val = realloc (ptr, size); /* ARI: realloc */
0efffb96 1435 else
5ac79d78 1436 val = malloc (size); /* ARI: malloc */
0efffb96
AC
1437 if (val == NULL)
1438 nomem (size);
1439
1440 return (val);
c906108c 1441}
b8c9b27d 1442
5ac79d78 1443PTR /* ARI: PTR */
c0e61796
AC
1444xcalloc (size_t number, size_t size)
1445{
aa2ee5f6
AC
1446 void *mem;
1447
1448 /* See libiberty/xmalloc.c. This function need's to match that's
1449 semantics. It never returns NULL. */
1450 if (number == 0 || size == 0)
1451 {
1452 number = 1;
1453 size = 1;
1454 }
1455
5ac79d78 1456 mem = calloc (number, size); /* ARI: xcalloc */
aa2ee5f6
AC
1457 if (mem == NULL)
1458 nomem (number * size);
1459
1460 return mem;
c0e61796 1461}
b8c9b27d
KB
1462
1463void
1464xfree (void *ptr)
1465{
2dc74dc1 1466 if (ptr != NULL)
5ac79d78 1467 free (ptr); /* ARI: free */
b8c9b27d 1468}
c906108c 1469\f
c5aa993b 1470
76995688
AC
1471/* Like asprintf/vasprintf but get an internal_error if the call
1472 fails. */
1473
9ebf4acf
AC
1474char *
1475xstrprintf (const char *format, ...)
1476{
1477 char *ret;
1478 va_list args;
e0627e85 1479
9ebf4acf 1480 va_start (args, format);
e623b504 1481 ret = xstrvprintf (format, args);
9ebf4acf
AC
1482 va_end (args);
1483 return ret;
1484}
1485
76995688
AC
1486void
1487xasprintf (char **ret, const char *format, ...)
1488{
1489 va_list args;
e0627e85 1490
76995688 1491 va_start (args, format);
e623b504 1492 (*ret) = xstrvprintf (format, args);
76995688
AC
1493 va_end (args);
1494}
1495
1496void
1497xvasprintf (char **ret, const char *format, va_list ap)
1498{
a552edd9 1499 (*ret) = xstrvprintf (format, ap);
76995688
AC
1500}
1501
e623b504
AC
1502char *
1503xstrvprintf (const char *format, va_list ap)
1504{
1505 char *ret = NULL;
1506 int status = vasprintf (&ret, format, ap);
e0627e85 1507
46e9880c
DJ
1508 /* NULL is returned when there was a memory allocation problem, or
1509 any other error (for instance, a bad format string). A negative
1510 status (the printed length) with a non-NULL buffer should never
1511 happen, but just to be sure. */
1512 if (ret == NULL || status < 0)
1513 internal_error (__FILE__, __LINE__, _("vasprintf call failed"));
e623b504
AC
1514 return ret;
1515}
76995688 1516
bde2058d
MK
1517int
1518xsnprintf (char *str, size_t size, const char *format, ...)
1519{
1520 va_list args;
1521 int ret;
1522
1523 va_start (args, format);
1524 ret = vsnprintf (str, size, format, args);
1525 gdb_assert (ret < size);
1526 va_end (args);
1527
1528 return ret;
1529}
1530
c906108c
SS
1531/* My replacement for the read system call.
1532 Used like `read' but keeps going if `read' returns too soon. */
1533
1534int
fba45db2 1535myread (int desc, char *addr, int len)
c906108c 1536{
52f0bd74 1537 int val;
c906108c
SS
1538 int orglen = len;
1539
1540 while (len > 0)
1541 {
1542 val = read (desc, addr, len);
1543 if (val < 0)
1544 return val;
1545 if (val == 0)
1546 return orglen - len;
1547 len -= val;
1548 addr += val;
1549 }
1550 return orglen;
1551}
1552\f
1553/* Make a copy of the string at PTR with SIZE characters
1554 (and add a null character at the end in the copy).
1555 Uses malloc to get the space. Returns the address of the copy. */
1556
1557char *
5565b556 1558savestring (const char *ptr, size_t size)
c906108c 1559{
52f0bd74 1560 char *p = (char *) xmalloc (size + 1);
e0627e85 1561
c906108c
SS
1562 memcpy (p, ptr, size);
1563 p[size] = 0;
1564 return p;
1565}
1566
c906108c 1567void
aa1ee363 1568print_spaces (int n, struct ui_file *file)
c906108c 1569{
392a587b 1570 fputs_unfiltered (n_spaces (n), file);
c906108c
SS
1571}
1572
1573/* Print a host address. */
1574
1575void
ac16bf07 1576gdb_print_host_address (const void *addr, struct ui_file *stream)
c906108c 1577{
ea8992ce 1578 fprintf_filtered (stream, "%s", host_address_to_string (addr));
c906108c 1579}
c906108c 1580\f
c5aa993b 1581
981c7f5a 1582/* This function supports the query, nquery, and yquery functions.
cbdeadca 1583 Ask user a y-or-n question and return 0 if answer is no, 1 if
981c7f5a
DJ
1584 answer is yes, or default the answer to the specified default
1585 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1586 default answer, or '\0' for no default.
cbdeadca
JJ
1587 CTLSTR is the control string and should end in "? ". It should
1588 not say how to answer, because we do that.
1589 ARGS are the arguments passed along with the CTLSTR argument to
1590 printf. */
1591
a0b31db1 1592static int ATTRIBUTE_PRINTF (1, 0)
cbdeadca
JJ
1593defaulted_query (const char *ctlstr, const char defchar, va_list args)
1594{
1595 int answer;
1596 int ans2;
1597 int retval;
1598 int def_value;
1599 char def_answer, not_def_answer;
981c7f5a 1600 char *y_string, *n_string, *question;
cbdeadca
JJ
1601
1602 /* Set up according to which answer is the default. */
981c7f5a
DJ
1603 if (defchar == '\0')
1604 {
1605 def_value = 1;
1606 def_answer = 'Y';
1607 not_def_answer = 'N';
1608 y_string = "y";
1609 n_string = "n";
1610 }
1611 else if (defchar == 'y')
cbdeadca
JJ
1612 {
1613 def_value = 1;
1614 def_answer = 'Y';
1615 not_def_answer = 'N';
1616 y_string = "[y]";
1617 n_string = "n";
1618 }
1619 else
1620 {
1621 def_value = 0;
1622 def_answer = 'N';
1623 not_def_answer = 'Y';
1624 y_string = "y";
1625 n_string = "[n]";
1626 }
1627
981c7f5a 1628 /* Automatically answer the default value if the user did not want
a502cf95
NR
1629 prompts or the command was issued with the server prefix. */
1630 if (! caution || server_command)
981c7f5a
DJ
1631 return def_value;
1632
1633 /* If input isn't coming from the user directly, just say what
7a01c6e0 1634 question we're asking, and then answer the default automatically. This
981c7f5a
DJ
1635 way, important error messages don't get lost when talking to GDB
1636 over a pipe. */
c63a1f86 1637 if (! input_from_terminal_p ())
981c7f5a
DJ
1638 {
1639 wrap_here ("");
1640 vfprintf_filtered (gdb_stdout, ctlstr, args);
1641
1642 printf_filtered (_("(%s or %s) [answered %c; input not from terminal]\n"),
1643 y_string, n_string, def_answer);
1644 gdb_flush (gdb_stdout);
1645
1646 return def_value;
1647 }
1648
9a4105ab 1649 if (deprecated_query_hook)
cbdeadca 1650 {
9a4105ab 1651 return deprecated_query_hook (ctlstr, args);
cbdeadca
JJ
1652 }
1653
981c7f5a
DJ
1654 /* Format the question outside of the loop, to avoid reusing args. */
1655 question = xstrvprintf (ctlstr, args);
1656
cbdeadca
JJ
1657 while (1)
1658 {
1659 wrap_here (""); /* Flush any buffered output */
1660 gdb_flush (gdb_stdout);
1661
1662 if (annotation_level > 1)
a3f17187 1663 printf_filtered (("\n\032\032pre-query\n"));
cbdeadca 1664
981c7f5a 1665 fputs_filtered (question, gdb_stdout);
a3f17187 1666 printf_filtered (_("(%s or %s) "), y_string, n_string);
cbdeadca
JJ
1667
1668 if (annotation_level > 1)
a3f17187 1669 printf_filtered (("\n\032\032query\n"));
cbdeadca
JJ
1670
1671 wrap_here ("");
1672 gdb_flush (gdb_stdout);
1673
1674 answer = fgetc (stdin);
8626589c
JB
1675
1676 /* We expect fgetc to block until a character is read. But
1677 this may not be the case if the terminal was opened with
1678 the NONBLOCK flag. In that case, if there is nothing to
1679 read on stdin, fgetc returns EOF, but also sets the error
1680 condition flag on stdin and errno to EAGAIN. With a true
1681 EOF, stdin's error condition flag is not set.
1682
1683 A situation where this behavior was observed is a pseudo
1684 terminal on AIX. */
1685 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1686 {
1687 /* Not a real EOF. Wait a little while and try again until
1688 we read something. */
1689 clearerr (stdin);
1690 gdb_usleep (10000);
1691 answer = fgetc (stdin);
1692 }
1693
cbdeadca
JJ
1694 clearerr (stdin); /* in case of C-d */
1695 if (answer == EOF) /* C-d */
1696 {
fa3fd85b 1697 printf_filtered ("EOF [assumed %c]\n", def_answer);
cbdeadca
JJ
1698 retval = def_value;
1699 break;
1700 }
1701 /* Eat rest of input line, to EOF or newline */
1702 if (answer != '\n')
1703 do
1704 {
1705 ans2 = fgetc (stdin);
1706 clearerr (stdin);
1707 }
1708 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1709
1710 if (answer >= 'a')
1711 answer -= 040;
1712 /* Check answer. For the non-default, the user must specify
1713 the non-default explicitly. */
1714 if (answer == not_def_answer)
1715 {
1716 retval = !def_value;
1717 break;
1718 }
981c7f5a
DJ
1719 /* Otherwise, if a default was specified, the user may either
1720 specify the required input or have it default by entering
1721 nothing. */
1722 if (answer == def_answer
1723 || (defchar != '\0' &&
1724 (answer == '\n' || answer == '\r' || answer == EOF)))
cbdeadca
JJ
1725 {
1726 retval = def_value;
1727 break;
1728 }
1729 /* Invalid entries are not defaulted and require another selection. */
a3f17187 1730 printf_filtered (_("Please answer %s or %s.\n"),
cbdeadca
JJ
1731 y_string, n_string);
1732 }
1733
981c7f5a 1734 xfree (question);
cbdeadca 1735 if (annotation_level > 1)
a3f17187 1736 printf_filtered (("\n\032\032post-query\n"));
cbdeadca
JJ
1737 return retval;
1738}
1739\f
1740
1741/* Ask user a y-or-n question and return 0 if answer is no, 1 if
1742 answer is yes, or 0 if answer is defaulted.
1743 Takes three args which are given to printf to print the question.
1744 The first, a control string, should end in "? ".
1745 It should not say how to answer, because we do that. */
1746
1747int
1748nquery (const char *ctlstr, ...)
1749{
1750 va_list args;
1751
1752 va_start (args, ctlstr);
1753 return defaulted_query (ctlstr, 'n', args);
1754 va_end (args);
1755}
1756
1757/* Ask user a y-or-n question and return 0 if answer is no, 1 if
1758 answer is yes, or 1 if answer is defaulted.
1759 Takes three args which are given to printf to print the question.
1760 The first, a control string, should end in "? ".
1761 It should not say how to answer, because we do that. */
1762
1763int
1764yquery (const char *ctlstr, ...)
1765{
1766 va_list args;
1767
1768 va_start (args, ctlstr);
1769 return defaulted_query (ctlstr, 'y', args);
1770 va_end (args);
1771}
1772
981c7f5a
DJ
1773/* Ask user a y-or-n question and return 1 iff answer is yes.
1774 Takes three args which are given to printf to print the question.
1775 The first, a control string, should end in "? ".
1776 It should not say how to answer, because we do that. */
1777
1778int
1779query (const char *ctlstr, ...)
1780{
1781 va_list args;
1782
1783 va_start (args, ctlstr);
1784 return defaulted_query (ctlstr, '\0', args);
1785 va_end (args);
1786}
1787
6c7a06a3
TT
1788/* A helper for parse_escape that converts a host character to a
1789 target character. C is the host character. If conversion is
1790 possible, then the target character is stored in *TARGET_C and the
1791 function returns 1. Otherwise, the function returns 0. */
1792
1793static int
f870a310 1794host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
234b45d4 1795{
6c7a06a3
TT
1796 struct obstack host_data;
1797 char the_char = c;
1798 struct cleanup *cleanups;
1799 int result = 0;
234b45d4 1800
6c7a06a3
TT
1801 obstack_init (&host_data);
1802 cleanups = make_cleanup_obstack_free (&host_data);
234b45d4 1803
f870a310 1804 convert_between_encodings (target_charset (gdbarch), host_charset (),
6c7a06a3
TT
1805 &the_char, 1, 1, &host_data, translit_none);
1806
1807 if (obstack_object_size (&host_data) == 1)
1808 {
1809 result = 1;
1810 *target_c = *(char *) obstack_base (&host_data);
1811 }
1812
1813 do_cleanups (cleanups);
1814 return result;
234b45d4
KB
1815}
1816
c906108c
SS
1817/* Parse a C escape sequence. STRING_PTR points to a variable
1818 containing a pointer to the string to parse. That pointer
1819 should point to the character after the \. That pointer
1820 is updated past the characters we use. The value of the
1821 escape sequence is returned.
1822
1823 A negative value means the sequence \ newline was seen,
1824 which is supposed to be equivalent to nothing at all.
1825
1826 If \ is followed by a null character, we return a negative
1827 value and leave the string pointer pointing at the null character.
1828
1829 If \ is followed by 000, we return 0 and leave the string pointer
1830 after the zeros. A value of 0 does not mean end of string. */
1831
1832int
f870a310 1833parse_escape (struct gdbarch *gdbarch, char **string_ptr)
c906108c 1834{
27e3013d 1835 int target_char = -2; /* initialize to avoid GCC warnings */
52f0bd74 1836 int c = *(*string_ptr)++;
e0627e85 1837
6c7a06a3
TT
1838 switch (c)
1839 {
8731e58e
AC
1840 case '\n':
1841 return -2;
1842 case 0:
1843 (*string_ptr)--;
1844 return 0;
8731e58e
AC
1845
1846 case '0':
1847 case '1':
1848 case '2':
1849 case '3':
1850 case '4':
1851 case '5':
1852 case '6':
1853 case '7':
1854 {
6c7a06a3 1855 int i = host_hex_value (c);
aa1ee363 1856 int count = 0;
8731e58e
AC
1857 while (++count < 3)
1858 {
5cb316ef 1859 c = (**string_ptr);
6c7a06a3 1860 if (isdigit (c) && c != '8' && c != '9')
8731e58e 1861 {
5cb316ef 1862 (*string_ptr)++;
8731e58e 1863 i *= 8;
6c7a06a3 1864 i += host_hex_value (c);
8731e58e
AC
1865 }
1866 else
1867 {
8731e58e
AC
1868 break;
1869 }
1870 }
1871 return i;
1872 }
6c7a06a3
TT
1873
1874 case 'a':
1875 c = '\a';
1876 break;
1877 case 'b':
1878 c = '\b';
1879 break;
1880 case 'f':
1881 c = '\f';
1882 break;
1883 case 'n':
1884 c = '\n';
1885 break;
1886 case 'r':
1887 c = '\r';
1888 break;
1889 case 't':
1890 c = '\t';
1891 break;
1892 case 'v':
1893 c = '\v';
1894 break;
1895
1896 default:
1897 break;
1898 }
1899
f870a310 1900 if (!host_char_to_target (gdbarch, c, &target_char))
6c7a06a3
TT
1901 error
1902 ("The escape sequence `\%c' is equivalent to plain `%c', which"
1903 " has no equivalent\n" "in the `%s' character set.", c, c,
f870a310 1904 target_charset (gdbarch));
6c7a06a3 1905 return target_char;
c906108c
SS
1906}
1907\f
1908/* Print the character C on STREAM as part of the contents of a literal
1909 string whose delimiter is QUOTER. Note that this routine should only
1910 be call for printing things which are independent of the language
1911 of the program being debugged. */
1912
43e526b9 1913static void
74f832da 1914printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
bee0189a
DJ
1915 void (*do_fprintf) (struct ui_file *, const char *, ...)
1916 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
c906108c 1917{
c906108c
SS
1918 c &= 0xFF; /* Avoid sign bit follies */
1919
c5aa993b
JM
1920 if (c < 0x20 || /* Low control chars */
1921 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1922 (sevenbit_strings && c >= 0x80))
1923 { /* high order bit set */
1924 switch (c)
1925 {
1926 case '\n':
43e526b9 1927 do_fputs ("\\n", stream);
c5aa993b
JM
1928 break;
1929 case '\b':
43e526b9 1930 do_fputs ("\\b", stream);
c5aa993b
JM
1931 break;
1932 case '\t':
43e526b9 1933 do_fputs ("\\t", stream);
c5aa993b
JM
1934 break;
1935 case '\f':
43e526b9 1936 do_fputs ("\\f", stream);
c5aa993b
JM
1937 break;
1938 case '\r':
43e526b9 1939 do_fputs ("\\r", stream);
c5aa993b
JM
1940 break;
1941 case '\033':
43e526b9 1942 do_fputs ("\\e", stream);
c5aa993b
JM
1943 break;
1944 case '\007':
43e526b9 1945 do_fputs ("\\a", stream);
c5aa993b
JM
1946 break;
1947 default:
43e526b9 1948 do_fprintf (stream, "\\%.3o", (unsigned int) c);
c5aa993b
JM
1949 break;
1950 }
1951 }
1952 else
1953 {
1954 if (c == '\\' || c == quoter)
43e526b9
JM
1955 do_fputs ("\\", stream);
1956 do_fprintf (stream, "%c", c);
c5aa993b 1957 }
c906108c 1958}
43e526b9
JM
1959
1960/* Print the character C on STREAM as part of the contents of a
1961 literal string whose delimiter is QUOTER. Note that these routines
1962 should only be call for printing things which are independent of
1963 the language of the program being debugged. */
1964
1965void
fba45db2 1966fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
43e526b9
JM
1967{
1968 while (*str)
1969 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1970}
1971
1972void
fba45db2 1973fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
43e526b9
JM
1974{
1975 while (*str)
1976 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1977}
1978
0876f84a
DJ
1979void
1980fputstrn_filtered (const char *str, int n, int quoter,
1981 struct ui_file *stream)
1982{
1983 int i;
e0627e85 1984
0876f84a
DJ
1985 for (i = 0; i < n; i++)
1986 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1987}
1988
43e526b9 1989void
8731e58e
AC
1990fputstrn_unfiltered (const char *str, int n, int quoter,
1991 struct ui_file *stream)
43e526b9
JM
1992{
1993 int i;
5d502164 1994
43e526b9
JM
1995 for (i = 0; i < n; i++)
1996 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1997}
c906108c 1998\f
c5aa993b 1999
c906108c
SS
2000/* Number of lines per page or UINT_MAX if paging is disabled. */
2001static unsigned int lines_per_page;
920d2a44
AC
2002static void
2003show_lines_per_page (struct ui_file *file, int from_tty,
2004 struct cmd_list_element *c, const char *value)
2005{
2006 fprintf_filtered (file, _("\
2007Number of lines gdb thinks are in a page is %s.\n"),
2008 value);
2009}
eb0d3137 2010
cbfbd72a 2011/* Number of chars per line or UINT_MAX if line folding is disabled. */
c906108c 2012static unsigned int chars_per_line;
920d2a44
AC
2013static void
2014show_chars_per_line (struct ui_file *file, int from_tty,
2015 struct cmd_list_element *c, const char *value)
2016{
2017 fprintf_filtered (file, _("\
2018Number of characters gdb thinks are in a line is %s.\n"),
2019 value);
2020}
eb0d3137 2021
c906108c
SS
2022/* Current count of lines printed on this page, chars on this line. */
2023static unsigned int lines_printed, chars_printed;
2024
2025/* Buffer and start column of buffered text, for doing smarter word-
2026 wrapping. When someone calls wrap_here(), we start buffering output
2027 that comes through fputs_filtered(). If we see a newline, we just
2028 spit it out and forget about the wrap_here(). If we see another
2029 wrap_here(), we spit it out and remember the newer one. If we see
2030 the end of the line, we spit out a newline, the indent, and then
2031 the buffered output. */
2032
2033/* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
2034 are waiting to be output (they have already been counted in chars_printed).
2035 When wrap_buffer[0] is null, the buffer is empty. */
2036static char *wrap_buffer;
2037
2038/* Pointer in wrap_buffer to the next character to fill. */
2039static char *wrap_pointer;
2040
2041/* String to indent by if the wrap occurs. Must not be NULL if wrap_column
2042 is non-zero. */
2043static char *wrap_indent;
2044
2045/* Column number on the screen where wrap_buffer begins, or 0 if wrapping
2046 is not in effect. */
2047static int wrap_column;
c906108c 2048\f
c5aa993b 2049
eb0d3137
MK
2050/* Inialize the number of lines per page and chars per line. */
2051
c906108c 2052void
fba45db2 2053init_page_info (void)
c906108c
SS
2054{
2055#if defined(TUI)
5ecb1806 2056 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
c906108c
SS
2057#endif
2058 {
eb0d3137 2059 int rows, cols;
c906108c 2060
ec145965
EZ
2061#if defined(__GO32__)
2062 rows = ScreenRows ();
2063 cols = ScreenCols ();
2064 lines_per_page = rows;
2065 chars_per_line = cols;
2066#else
eb0d3137
MK
2067 /* Make sure Readline has initialized its terminal settings. */
2068 rl_reset_terminal (NULL);
c906108c 2069
eb0d3137
MK
2070 /* Get the screen size from Readline. */
2071 rl_get_screen_size (&rows, &cols);
2072 lines_per_page = rows;
2073 chars_per_line = cols;
c906108c 2074
eb0d3137
MK
2075 /* Readline should have fetched the termcap entry for us. */
2076 if (tgetnum ("li") < 0 || getenv ("EMACS"))
2077 {
2078 /* The number of lines per page is not mentioned in the
2079 terminal description. This probably means that paging is
2080 not useful (e.g. emacs shell window), so disable paging. */
2081 lines_per_page = UINT_MAX;
2082 }
c906108c 2083
eb0d3137 2084 /* FIXME: Get rid of this junk. */
c906108c 2085#if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
c906108c
SS
2086 SIGWINCH_HANDLER (SIGWINCH);
2087#endif
eb0d3137 2088
c906108c 2089 /* If the output is not a terminal, don't paginate it. */
d9fcf2fb 2090 if (!ui_file_isatty (gdb_stdout))
c5aa993b 2091 lines_per_page = UINT_MAX;
eb0d3137 2092#endif
ec145965 2093 }
eb0d3137
MK
2094
2095 set_screen_size ();
c5aa993b 2096 set_width ();
c906108c
SS
2097}
2098
eb0d3137
MK
2099/* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
2100
2101static void
2102set_screen_size (void)
2103{
2104 int rows = lines_per_page;
2105 int cols = chars_per_line;
2106
2107 if (rows <= 0)
2108 rows = INT_MAX;
2109
2110 if (cols <= 0)
0caa462c 2111 cols = INT_MAX;
eb0d3137
MK
2112
2113 /* Update Readline's idea of the terminal size. */
2114 rl_set_screen_size (rows, cols);
2115}
2116
2117/* Reinitialize WRAP_BUFFER according to the current value of
2118 CHARS_PER_LINE. */
2119
c906108c 2120static void
fba45db2 2121set_width (void)
c906108c
SS
2122{
2123 if (chars_per_line == 0)
c5aa993b 2124 init_page_info ();
c906108c
SS
2125
2126 if (!wrap_buffer)
2127 {
2128 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
2129 wrap_buffer[0] = '\0';
2130 }
2131 else
2132 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
eb0d3137 2133 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
c906108c
SS
2134}
2135
c5aa993b 2136static void
fba45db2 2137set_width_command (char *args, int from_tty, struct cmd_list_element *c)
c906108c 2138{
eb0d3137 2139 set_screen_size ();
c906108c
SS
2140 set_width ();
2141}
2142
eb0d3137
MK
2143static void
2144set_height_command (char *args, int from_tty, struct cmd_list_element *c)
2145{
2146 set_screen_size ();
2147}
2148
c906108c
SS
2149/* Wait, so the user can read what's on the screen. Prompt the user
2150 to continue by pressing RETURN. */
2151
2152static void
fba45db2 2153prompt_for_continue (void)
c906108c
SS
2154{
2155 char *ignore;
2156 char cont_prompt[120];
2157
2158 if (annotation_level > 1)
a3f17187 2159 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
c906108c
SS
2160
2161 strcpy (cont_prompt,
2162 "---Type <return> to continue, or q <return> to quit---");
2163 if (annotation_level > 1)
2164 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
2165
2166 /* We must do this *before* we call gdb_readline, else it will eventually
2167 call us -- thinking that we're trying to print beyond the end of the
2168 screen. */
2169 reinitialize_more_filter ();
2170
2171 immediate_quit++;
2172 /* On a real operating system, the user can quit with SIGINT.
2173 But not on GO32.
2174
2175 'q' is provided on all systems so users don't have to change habits
2176 from system to system, and because telling them what to do in
2177 the prompt is more user-friendly than expecting them to think of
2178 SIGINT. */
2179 /* Call readline, not gdb_readline, because GO32 readline handles control-C
2180 whereas control-C to gdb_readline will cause the user to get dumped
2181 out to DOS. */
b4f5539f 2182 ignore = gdb_readline_wrapper (cont_prompt);
c906108c
SS
2183
2184 if (annotation_level > 1)
a3f17187 2185 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
c906108c
SS
2186
2187 if (ignore)
2188 {
2189 char *p = ignore;
5d502164 2190
c906108c
SS
2191 while (*p == ' ' || *p == '\t')
2192 ++p;
2193 if (p[0] == 'q')
362646f5 2194 async_request_quit (0);
b8c9b27d 2195 xfree (ignore);
c906108c
SS
2196 }
2197 immediate_quit--;
2198
2199 /* Now we have to do this again, so that GDB will know that it doesn't
2200 need to save the ---Type <return>--- line at the top of the screen. */
2201 reinitialize_more_filter ();
2202
2203 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
2204}
2205
2206/* Reinitialize filter; ie. tell it to reset to original values. */
2207
2208void
fba45db2 2209reinitialize_more_filter (void)
c906108c
SS
2210{
2211 lines_printed = 0;
2212 chars_printed = 0;
2213}
2214
2215/* Indicate that if the next sequence of characters overflows the line,
2216 a newline should be inserted here rather than when it hits the end.
2217 If INDENT is non-null, it is a string to be printed to indent the
2218 wrapped part on the next line. INDENT must remain accessible until
2219 the next call to wrap_here() or until a newline is printed through
2220 fputs_filtered().
2221
2222 If the line is already overfull, we immediately print a newline and
2223 the indentation, and disable further wrapping.
2224
2225 If we don't know the width of lines, but we know the page height,
2226 we must not wrap words, but should still keep track of newlines
2227 that were explicitly printed.
2228
2229 INDENT should not contain tabs, as that will mess up the char count
2230 on the next line. FIXME.
2231
2232 This routine is guaranteed to force out any output which has been
2233 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
2234 used to force out output from the wrap_buffer. */
2235
2236void
fba45db2 2237wrap_here (char *indent)
c906108c
SS
2238{
2239 /* This should have been allocated, but be paranoid anyway. */
2240 if (!wrap_buffer)
e2e0b3e5 2241 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
c906108c
SS
2242
2243 if (wrap_buffer[0])
2244 {
2245 *wrap_pointer = '\0';
2246 fputs_unfiltered (wrap_buffer, gdb_stdout);
2247 }
2248 wrap_pointer = wrap_buffer;
2249 wrap_buffer[0] = '\0';
c5aa993b 2250 if (chars_per_line == UINT_MAX) /* No line overflow checking */
c906108c
SS
2251 {
2252 wrap_column = 0;
2253 }
2254 else if (chars_printed >= chars_per_line)
2255 {
2256 puts_filtered ("\n");
2257 if (indent != NULL)
2258 puts_filtered (indent);
2259 wrap_column = 0;
2260 }
2261 else
2262 {
2263 wrap_column = chars_printed;
2264 if (indent == NULL)
2265 wrap_indent = "";
2266 else
2267 wrap_indent = indent;
2268 }
2269}
2270
4a351cef
AF
2271/* Print input string to gdb_stdout, filtered, with wrap,
2272 arranging strings in columns of n chars. String can be
2273 right or left justified in the column. Never prints
2274 trailing spaces. String should never be longer than
2275 width. FIXME: this could be useful for the EXAMINE
2276 command, which currently doesn't tabulate very well */
2277
2278void
2279puts_filtered_tabular (char *string, int width, int right)
2280{
2281 int spaces = 0;
2282 int stringlen;
2283 char *spacebuf;
2284
2285 gdb_assert (chars_per_line > 0);
2286 if (chars_per_line == UINT_MAX)
2287 {
2288 fputs_filtered (string, gdb_stdout);
2289 fputs_filtered ("\n", gdb_stdout);
2290 return;
2291 }
2292
2293 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2294 fputs_filtered ("\n", gdb_stdout);
2295
2296 if (width >= chars_per_line)
2297 width = chars_per_line - 1;
2298
2299 stringlen = strlen (string);
2300
2301 if (chars_printed > 0)
2302 spaces = width - (chars_printed - 1) % width - 1;
2303 if (right)
2304 spaces += width - stringlen;
2305
2306 spacebuf = alloca (spaces + 1);
2307 spacebuf[spaces] = '\0';
2308 while (spaces--)
2309 spacebuf[spaces] = ' ';
2310
2311 fputs_filtered (spacebuf, gdb_stdout);
2312 fputs_filtered (string, gdb_stdout);
2313}
2314
2315
c906108c
SS
2316/* Ensure that whatever gets printed next, using the filtered output
2317 commands, starts at the beginning of the line. I.E. if there is
2318 any pending output for the current line, flush it and start a new
2319 line. Otherwise do nothing. */
2320
2321void
fba45db2 2322begin_line (void)
c906108c
SS
2323{
2324 if (chars_printed > 0)
2325 {
2326 puts_filtered ("\n");
2327 }
2328}
2329
ac9a91a7 2330
c906108c
SS
2331/* Like fputs but if FILTER is true, pause after every screenful.
2332
2333 Regardless of FILTER can wrap at points other than the final
2334 character of a line.
2335
2336 Unlike fputs, fputs_maybe_filtered does not return a value.
2337 It is OK for LINEBUFFER to be NULL, in which case just don't print
2338 anything.
2339
2340 Note that a longjmp to top level may occur in this routine (only if
2341 FILTER is true) (since prompt_for_continue may do so) so this
2342 routine should not be called when cleanups are not in place. */
2343
2344static void
fba45db2
KB
2345fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2346 int filter)
c906108c
SS
2347{
2348 const char *lineptr;
2349
2350 if (linebuffer == 0)
2351 return;
2352
2353 /* Don't do any filtering if it is disabled. */
390a8aca 2354 if (stream != gdb_stdout
c63a1f86
JK
2355 || ! pagination_enabled
2356 || ! input_from_terminal_p ()
390a8aca 2357 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
58dadb1b 2358 || top_level_interpreter () == NULL
390a8aca 2359 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
c906108c
SS
2360 {
2361 fputs_unfiltered (linebuffer, stream);
2362 return;
2363 }
2364
2365 /* Go through and output each character. Show line extension
2366 when this is necessary; prompt user for new page when this is
2367 necessary. */
c5aa993b 2368
c906108c
SS
2369 lineptr = linebuffer;
2370 while (*lineptr)
2371 {
2372 /* Possible new page. */
8731e58e 2373 if (filter && (lines_printed >= lines_per_page - 1))
c906108c
SS
2374 prompt_for_continue ();
2375
2376 while (*lineptr && *lineptr != '\n')
2377 {
2378 /* Print a single line. */
2379 if (*lineptr == '\t')
2380 {
2381 if (wrap_column)
2382 *wrap_pointer++ = '\t';
2383 else
2384 fputc_unfiltered ('\t', stream);
2385 /* Shifting right by 3 produces the number of tab stops
2386 we have already passed, and then adding one and
c5aa993b 2387 shifting left 3 advances to the next tab stop. */
c906108c
SS
2388 chars_printed = ((chars_printed >> 3) + 1) << 3;
2389 lineptr++;
2390 }
2391 else
2392 {
2393 if (wrap_column)
2394 *wrap_pointer++ = *lineptr;
2395 else
c5aa993b 2396 fputc_unfiltered (*lineptr, stream);
c906108c
SS
2397 chars_printed++;
2398 lineptr++;
2399 }
c5aa993b 2400
c906108c
SS
2401 if (chars_printed >= chars_per_line)
2402 {
2403 unsigned int save_chars = chars_printed;
2404
2405 chars_printed = 0;
2406 lines_printed++;
2407 /* If we aren't actually wrapping, don't output newline --
c5aa993b
JM
2408 if chars_per_line is right, we probably just overflowed
2409 anyway; if it's wrong, let us keep going. */
c906108c
SS
2410 if (wrap_column)
2411 fputc_unfiltered ('\n', stream);
2412
2413 /* Possible new page. */
2414 if (lines_printed >= lines_per_page - 1)
2415 prompt_for_continue ();
2416
2417 /* Now output indentation and wrapped string */
2418 if (wrap_column)
2419 {
2420 fputs_unfiltered (wrap_indent, stream);
8731e58e 2421 *wrap_pointer = '\0'; /* Null-terminate saved stuff */
c5aa993b 2422 fputs_unfiltered (wrap_buffer, stream); /* and eject it */
c906108c
SS
2423 /* FIXME, this strlen is what prevents wrap_indent from
2424 containing tabs. However, if we recurse to print it
2425 and count its chars, we risk trouble if wrap_indent is
2426 longer than (the user settable) chars_per_line.
2427 Note also that this can set chars_printed > chars_per_line
2428 if we are printing a long string. */
2429 chars_printed = strlen (wrap_indent)
c5aa993b 2430 + (save_chars - wrap_column);
c906108c
SS
2431 wrap_pointer = wrap_buffer; /* Reset buffer */
2432 wrap_buffer[0] = '\0';
c5aa993b
JM
2433 wrap_column = 0; /* And disable fancy wrap */
2434 }
c906108c
SS
2435 }
2436 }
2437
2438 if (*lineptr == '\n')
2439 {
2440 chars_printed = 0;
c5aa993b 2441 wrap_here ((char *) 0); /* Spit out chars, cancel further wraps */
c906108c
SS
2442 lines_printed++;
2443 fputc_unfiltered ('\n', stream);
2444 lineptr++;
2445 }
2446 }
2447}
2448
2449void
fba45db2 2450fputs_filtered (const char *linebuffer, struct ui_file *stream)
c906108c
SS
2451{
2452 fputs_maybe_filtered (linebuffer, stream, 1);
2453}
2454
2455int
fba45db2 2456putchar_unfiltered (int c)
c906108c 2457{
11cf8741 2458 char buf = c;
e0627e85 2459
d9fcf2fb 2460 ui_file_write (gdb_stdout, &buf, 1);
c906108c
SS
2461 return c;
2462}
2463
d1f4cff8
AC
2464/* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2465 May return nonlocally. */
2466
2467int
2468putchar_filtered (int c)
2469{
2470 return fputc_filtered (c, gdb_stdout);
2471}
2472
c906108c 2473int
fba45db2 2474fputc_unfiltered (int c, struct ui_file *stream)
c906108c 2475{
11cf8741 2476 char buf = c;
e0627e85 2477
d9fcf2fb 2478 ui_file_write (stream, &buf, 1);
c906108c
SS
2479 return c;
2480}
2481
2482int
fba45db2 2483fputc_filtered (int c, struct ui_file *stream)
c906108c
SS
2484{
2485 char buf[2];
2486
2487 buf[0] = c;
2488 buf[1] = 0;
2489 fputs_filtered (buf, stream);
2490 return c;
2491}
2492
2493/* puts_debug is like fputs_unfiltered, except it prints special
2494 characters in printable fashion. */
2495
2496void
fba45db2 2497puts_debug (char *prefix, char *string, char *suffix)
c906108c
SS
2498{
2499 int ch;
2500
2501 /* Print prefix and suffix after each line. */
2502 static int new_line = 1;
2503 static int return_p = 0;
2504 static char *prev_prefix = "";
2505 static char *prev_suffix = "";
2506
2507 if (*string == '\n')
2508 return_p = 0;
2509
2510 /* If the prefix is changing, print the previous suffix, a new line,
2511 and the new prefix. */
c5aa993b 2512 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
c906108c 2513 {
9846de1b
JM
2514 fputs_unfiltered (prev_suffix, gdb_stdlog);
2515 fputs_unfiltered ("\n", gdb_stdlog);
2516 fputs_unfiltered (prefix, gdb_stdlog);
c906108c
SS
2517 }
2518
2519 /* Print prefix if we printed a newline during the previous call. */
2520 if (new_line)
2521 {
2522 new_line = 0;
9846de1b 2523 fputs_unfiltered (prefix, gdb_stdlog);
c906108c
SS
2524 }
2525
2526 prev_prefix = prefix;
2527 prev_suffix = suffix;
2528
2529 /* Output characters in a printable format. */
2530 while ((ch = *string++) != '\0')
2531 {
2532 switch (ch)
c5aa993b 2533 {
c906108c
SS
2534 default:
2535 if (isprint (ch))
9846de1b 2536 fputc_unfiltered (ch, gdb_stdlog);
c906108c
SS
2537
2538 else
9846de1b 2539 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
c906108c
SS
2540 break;
2541
c5aa993b
JM
2542 case '\\':
2543 fputs_unfiltered ("\\\\", gdb_stdlog);
2544 break;
2545 case '\b':
2546 fputs_unfiltered ("\\b", gdb_stdlog);
2547 break;
2548 case '\f':
2549 fputs_unfiltered ("\\f", gdb_stdlog);
2550 break;
2551 case '\n':
2552 new_line = 1;
2553 fputs_unfiltered ("\\n", gdb_stdlog);
2554 break;
2555 case '\r':
2556 fputs_unfiltered ("\\r", gdb_stdlog);
2557 break;
2558 case '\t':
2559 fputs_unfiltered ("\\t", gdb_stdlog);
2560 break;
2561 case '\v':
2562 fputs_unfiltered ("\\v", gdb_stdlog);
2563 break;
2564 }
c906108c
SS
2565
2566 return_p = ch == '\r';
2567 }
2568
2569 /* Print suffix if we printed a newline. */
2570 if (new_line)
2571 {
9846de1b
JM
2572 fputs_unfiltered (suffix, gdb_stdlog);
2573 fputs_unfiltered ("\n", gdb_stdlog);
c906108c
SS
2574 }
2575}
2576
2577
2578/* Print a variable number of ARGS using format FORMAT. If this
2579 information is going to put the amount written (since the last call
2580 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2581 call prompt_for_continue to get the users permision to continue.
2582
2583 Unlike fprintf, this function does not return a value.
2584
2585 We implement three variants, vfprintf (takes a vararg list and stream),
2586 fprintf (takes a stream to write on), and printf (the usual).
2587
2588 Note also that a longjmp to top level may occur in this routine
2589 (since prompt_for_continue may do so) so this routine should not be
2590 called when cleanups are not in place. */
2591
2592static void
fba45db2
KB
2593vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2594 va_list args, int filter)
c906108c
SS
2595{
2596 char *linebuffer;
2597 struct cleanup *old_cleanups;
2598
e623b504 2599 linebuffer = xstrvprintf (format, args);
b8c9b27d 2600 old_cleanups = make_cleanup (xfree, linebuffer);
c906108c
SS
2601 fputs_maybe_filtered (linebuffer, stream, filter);
2602 do_cleanups (old_cleanups);
2603}
2604
2605
2606void
fba45db2 2607vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
c906108c
SS
2608{
2609 vfprintf_maybe_filtered (stream, format, args, 1);
2610}
2611
2612void
fba45db2 2613vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
c906108c
SS
2614{
2615 char *linebuffer;
2616 struct cleanup *old_cleanups;
2617
e623b504 2618 linebuffer = xstrvprintf (format, args);
b8c9b27d 2619 old_cleanups = make_cleanup (xfree, linebuffer);
75feb17d
DJ
2620 if (debug_timestamp && stream == gdb_stdlog)
2621 {
2622 struct timeval tm;
2623 char *timestamp;
6e5abd65 2624 int len, need_nl;
75feb17d
DJ
2625
2626 gettimeofday (&tm, NULL);
6e5abd65
PA
2627
2628 len = strlen (linebuffer);
2629 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2630
2631 timestamp = xstrprintf ("%ld:%ld %s%s",
2632 (long) tm.tv_sec, (long) tm.tv_usec,
2633 linebuffer,
2634 need_nl ? "\n": "");
75feb17d
DJ
2635 make_cleanup (xfree, timestamp);
2636 fputs_unfiltered (timestamp, stream);
2637 }
6e5abd65
PA
2638 else
2639 fputs_unfiltered (linebuffer, stream);
c906108c
SS
2640 do_cleanups (old_cleanups);
2641}
2642
2643void
fba45db2 2644vprintf_filtered (const char *format, va_list args)
c906108c
SS
2645{
2646 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2647}
2648
2649void
fba45db2 2650vprintf_unfiltered (const char *format, va_list args)
c906108c
SS
2651{
2652 vfprintf_unfiltered (gdb_stdout, format, args);
2653}
2654
c906108c 2655void
8731e58e 2656fprintf_filtered (struct ui_file *stream, const char *format, ...)
c906108c
SS
2657{
2658 va_list args;
e0627e85 2659
c906108c 2660 va_start (args, format);
c906108c
SS
2661 vfprintf_filtered (stream, format, args);
2662 va_end (args);
2663}
2664
c906108c 2665void
8731e58e 2666fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
c906108c
SS
2667{
2668 va_list args;
e0627e85 2669
c906108c 2670 va_start (args, format);
c906108c
SS
2671 vfprintf_unfiltered (stream, format, args);
2672 va_end (args);
2673}
2674
2675/* Like fprintf_filtered, but prints its result indented.
2676 Called as fprintfi_filtered (spaces, stream, format, ...); */
2677
c906108c 2678void
8731e58e
AC
2679fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2680 ...)
c906108c
SS
2681{
2682 va_list args;
e0627e85 2683
c906108c 2684 va_start (args, format);
c906108c
SS
2685 print_spaces_filtered (spaces, stream);
2686
2687 vfprintf_filtered (stream, format, args);
2688 va_end (args);
2689}
2690
2691
c906108c 2692void
8731e58e 2693printf_filtered (const char *format, ...)
c906108c
SS
2694{
2695 va_list args;
e0627e85 2696
c906108c 2697 va_start (args, format);
c906108c
SS
2698 vfprintf_filtered (gdb_stdout, format, args);
2699 va_end (args);
2700}
2701
2702
c906108c 2703void
8731e58e 2704printf_unfiltered (const char *format, ...)
c906108c
SS
2705{
2706 va_list args;
e0627e85 2707
c906108c 2708 va_start (args, format);
c906108c
SS
2709 vfprintf_unfiltered (gdb_stdout, format, args);
2710 va_end (args);
2711}
2712
2713/* Like printf_filtered, but prints it's result indented.
2714 Called as printfi_filtered (spaces, format, ...); */
2715
c906108c 2716void
8731e58e 2717printfi_filtered (int spaces, const char *format, ...)
c906108c
SS
2718{
2719 va_list args;
e0627e85 2720
c906108c 2721 va_start (args, format);
c906108c
SS
2722 print_spaces_filtered (spaces, gdb_stdout);
2723 vfprintf_filtered (gdb_stdout, format, args);
2724 va_end (args);
2725}
2726
2727/* Easy -- but watch out!
2728
2729 This routine is *not* a replacement for puts()! puts() appends a newline.
2730 This one doesn't, and had better not! */
2731
2732void
fba45db2 2733puts_filtered (const char *string)
c906108c
SS
2734{
2735 fputs_filtered (string, gdb_stdout);
2736}
2737
2738void
fba45db2 2739puts_unfiltered (const char *string)
c906108c
SS
2740{
2741 fputs_unfiltered (string, gdb_stdout);
2742}
2743
2744/* Return a pointer to N spaces and a null. The pointer is good
2745 until the next call to here. */
2746char *
fba45db2 2747n_spaces (int n)
c906108c 2748{
392a587b
JM
2749 char *t;
2750 static char *spaces = 0;
2751 static int max_spaces = -1;
c906108c
SS
2752
2753 if (n > max_spaces)
2754 {
2755 if (spaces)
b8c9b27d 2756 xfree (spaces);
c5aa993b
JM
2757 spaces = (char *) xmalloc (n + 1);
2758 for (t = spaces + n; t != spaces;)
c906108c
SS
2759 *--t = ' ';
2760 spaces[n] = '\0';
2761 max_spaces = n;
2762 }
2763
2764 return spaces + max_spaces - n;
2765}
2766
2767/* Print N spaces. */
2768void
fba45db2 2769print_spaces_filtered (int n, struct ui_file *stream)
c906108c
SS
2770{
2771 fputs_filtered (n_spaces (n), stream);
2772}
2773\f
4a351cef 2774/* C++/ObjC demangler stuff. */
c906108c 2775
389e51db
AC
2776/* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2777 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2778 If the name is not mangled, or the language for the name is unknown, or
2779 demangling is off, the name is printed in its "raw" form. */
c906108c
SS
2780
2781void
8731e58e
AC
2782fprintf_symbol_filtered (struct ui_file *stream, char *name,
2783 enum language lang, int arg_mode)
c906108c
SS
2784{
2785 char *demangled;
2786
2787 if (name != NULL)
2788 {
2789 /* If user wants to see raw output, no problem. */
2790 if (!demangle)
2791 {
2792 fputs_filtered (name, stream);
2793 }
2794 else
2795 {
9a3d7dfd 2796 demangled = language_demangle (language_def (lang), name, arg_mode);
c906108c
SS
2797 fputs_filtered (demangled ? demangled : name, stream);
2798 if (demangled != NULL)
2799 {
b8c9b27d 2800 xfree (demangled);
c906108c
SS
2801 }
2802 }
2803 }
2804}
2805
2806/* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2807 differences in whitespace. Returns 0 if they match, non-zero if they
2808 don't (slightly different than strcmp()'s range of return values).
c5aa993b 2809
c906108c
SS
2810 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2811 This "feature" is useful when searching for matching C++ function names
2812 (such as if the user types 'break FOO', where FOO is a mangled C++
2813 function). */
2814
2815int
fba45db2 2816strcmp_iw (const char *string1, const char *string2)
c906108c
SS
2817{
2818 while ((*string1 != '\0') && (*string2 != '\0'))
2819 {
2820 while (isspace (*string1))
2821 {
2822 string1++;
2823 }
2824 while (isspace (*string2))
2825 {
2826 string2++;
2827 }
2828 if (*string1 != *string2)
2829 {
2830 break;
2831 }
2832 if (*string1 != '\0')
2833 {
2834 string1++;
2835 string2++;
2836 }
2837 }
2838 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2839}
2de7ced7 2840
0fe19209
DC
2841/* This is like strcmp except that it ignores whitespace and treats
2842 '(' as the first non-NULL character in terms of ordering. Like
2843 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2844 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2845 according to that ordering.
2846
2847 If a list is sorted according to this function and if you want to
2848 find names in the list that match some fixed NAME according to
2849 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2850 where this function would put NAME.
2851
2852 Here are some examples of why using strcmp to sort is a bad idea:
2853
2854 Whitespace example:
2855
2856 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2857 we try to do a search for "foo<char*>", strcmp will locate this
2858 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2859 will start looking at strings beginning with "goo", and will never
2860 see the correct match of "foo<char *>".
2861
2862 Parenthesis example:
2863
2864 In practice, this is less like to be an issue, but I'll give it a
2865 shot. Let's assume that '$' is a legitimate character to occur in
2866 symbols. (Which may well even be the case on some systems.) Then
2867 say that the partial symbol table contains "foo$" and "foo(int)".
2868 strcmp will put them in this order, since '$' < '('. Now, if the
2869 user searches for "foo", then strcmp will sort "foo" before "foo$".
2870 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2871 "foo") is false, so it won't proceed to the actual match of
2872 "foo(int)" with "foo". */
2873
2874int
2875strcmp_iw_ordered (const char *string1, const char *string2)
2876{
2877 while ((*string1 != '\0') && (*string2 != '\0'))
2878 {
2879 while (isspace (*string1))
2880 {
2881 string1++;
2882 }
2883 while (isspace (*string2))
2884 {
2885 string2++;
2886 }
2887 if (*string1 != *string2)
2888 {
2889 break;
2890 }
2891 if (*string1 != '\0')
2892 {
2893 string1++;
2894 string2++;
2895 }
2896 }
2897
2898 switch (*string1)
2899 {
2900 /* Characters are non-equal unless they're both '\0'; we want to
2901 make sure we get the comparison right according to our
2902 comparison in the cases where one of them is '\0' or '('. */
2903 case '\0':
2904 if (*string2 == '\0')
2905 return 0;
2906 else
2907 return -1;
2908 case '(':
2909 if (*string2 == '\0')
2910 return 1;
2911 else
2912 return -1;
2913 default:
2914 if (*string2 == '(')
2915 return 1;
2916 else
2917 return *string1 - *string2;
2918 }
2919}
2920
2de7ced7
DJ
2921/* A simple comparison function with opposite semantics to strcmp. */
2922
2923int
2924streq (const char *lhs, const char *rhs)
2925{
2926 return !strcmp (lhs, rhs);
2927}
c906108c 2928\f
c5aa993b 2929
c906108c 2930/*
c5aa993b
JM
2931 ** subset_compare()
2932 ** Answer whether string_to_compare is a full or partial match to
2933 ** template_string. The partial match must be in sequence starting
2934 ** at index 0.
2935 */
c906108c 2936int
fba45db2 2937subset_compare (char *string_to_compare, char *template_string)
7a292a7a
SS
2938{
2939 int match;
e0627e85 2940
8731e58e
AC
2941 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2942 && strlen (string_to_compare) <= strlen (template_string))
2943 match =
2944 (strncmp
2945 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
7a292a7a
SS
2946 else
2947 match = 0;
2948 return match;
2949}
c906108c 2950
7a292a7a 2951static void
fba45db2 2952pagination_on_command (char *arg, int from_tty)
c906108c
SS
2953{
2954 pagination_enabled = 1;
2955}
2956
7a292a7a 2957static void
fba45db2 2958pagination_off_command (char *arg, int from_tty)
c906108c
SS
2959{
2960 pagination_enabled = 0;
2961}
75feb17d
DJ
2962
2963static void
2964show_debug_timestamp (struct ui_file *file, int from_tty,
2965 struct cmd_list_element *c, const char *value)
2966{
2967 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"), value);
2968}
c906108c 2969\f
c5aa993b 2970
c906108c 2971void
fba45db2 2972initialize_utils (void)
c906108c 2973{
35096d9d
AC
2974 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2975Set number of characters gdb thinks are in a line."), _("\
2976Show number of characters gdb thinks are in a line."), NULL,
2977 set_width_command,
920d2a44 2978 show_chars_per_line,
35096d9d
AC
2979 &setlist, &showlist);
2980
2981 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2982Set number of lines gdb thinks are in a page."), _("\
2983Show number of lines gdb thinks are in a page."), NULL,
2984 set_height_command,
920d2a44 2985 show_lines_per_page,
35096d9d 2986 &setlist, &showlist);
c5aa993b 2987
c906108c
SS
2988 init_page_info ();
2989
5bf193a2
AC
2990 add_setshow_boolean_cmd ("demangle", class_support, &demangle, _("\
2991Set demangling of encoded C++/ObjC names when displaying symbols."), _("\
2992Show demangling of encoded C++/ObjC names when displaying symbols."), NULL,
2993 NULL,
920d2a44 2994 show_demangle,
5bf193a2
AC
2995 &setprintlist, &showprintlist);
2996
2997 add_setshow_boolean_cmd ("pagination", class_support,
2998 &pagination_enabled, _("\
2999Set state of pagination."), _("\
3000Show state of pagination."), NULL,
3001 NULL,
920d2a44 3002 show_pagination_enabled,
5bf193a2 3003 &setlist, &showlist);
4261bedc 3004
c906108c
SS
3005 if (xdb_commands)
3006 {
c5aa993b 3007 add_com ("am", class_support, pagination_on_command,
1bedd215 3008 _("Enable pagination"));
c5aa993b 3009 add_com ("sm", class_support, pagination_off_command,
1bedd215 3010 _("Disable pagination"));
c906108c
SS
3011 }
3012
5bf193a2
AC
3013 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
3014 &sevenbit_strings, _("\
3015Set printing of 8-bit characters in strings as \\nnn."), _("\
3016Show printing of 8-bit characters in strings as \\nnn."), NULL,
3017 NULL,
920d2a44 3018 show_sevenbit_strings,
5bf193a2
AC
3019 &setprintlist, &showprintlist);
3020
3021 add_setshow_boolean_cmd ("asm-demangle", class_support, &asm_demangle, _("\
3022Set demangling of C++/ObjC names in disassembly listings."), _("\
3023Show demangling of C++/ObjC names in disassembly listings."), NULL,
3024 NULL,
920d2a44 3025 show_asm_demangle,
5bf193a2 3026 &setprintlist, &showprintlist);
75feb17d
DJ
3027
3028 add_setshow_boolean_cmd ("timestamp", class_maintenance,
3029 &debug_timestamp, _("\
3030Set timestamping of debugging messages."), _("\
3031Show timestamping of debugging messages."), _("\
3032When set, debugging messages will be marked with seconds and microseconds."),
3033 NULL,
3034 show_debug_timestamp,
3035 &setdebuglist, &showdebuglist);
c906108c
SS
3036}
3037
3038/* Machine specific function to handle SIGWINCH signal. */
3039
3040#ifdef SIGWINCH_HANDLER_BODY
c5aa993b 3041SIGWINCH_HANDLER_BODY
c906108c 3042#endif
5683e87a 3043/* print routines to handle variable size regs, etc. */
c906108c
SS
3044/* temporary storage using circular buffer */
3045#define NUMCELLS 16
0759e0bf 3046#define CELLSIZE 50
c5aa993b 3047static char *
fba45db2 3048get_cell (void)
c906108c
SS
3049{
3050 static char buf[NUMCELLS][CELLSIZE];
c5aa993b 3051 static int cell = 0;
e0627e85 3052
c5aa993b
JM
3053 if (++cell >= NUMCELLS)
3054 cell = 0;
c906108c
SS
3055 return buf[cell];
3056}
3057
66bf4b3a 3058const char *
5af949e3 3059paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
66bf4b3a
AC
3060{
3061 /* Truncate address to the size of a target address, avoiding shifts
3062 larger or equal than the width of a CORE_ADDR. The local
3063 variable ADDR_BIT stops the compiler reporting a shift overflow
3064 when it won't occur. */
3065 /* NOTE: This assumes that the significant address information is
3066 kept in the least significant bits of ADDR - the upper bits were
76e71323 3067 either zero or sign extended. Should gdbarch_address_to_pointer or
66bf4b3a
AC
3068 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
3069
5af949e3 3070 int addr_bit = gdbarch_addr_bit (gdbarch);
66bf4b3a
AC
3071
3072 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
3073 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
3074 return hex_string (addr);
3075}
3076
8cf46f62
MK
3077static char *
3078decimal2str (char *sign, ULONGEST addr, int width)
104c1213 3079{
8cf46f62 3080 /* Steal code from valprint.c:print_decimal(). Should this worry
104c1213
JM
3081 about the real size of addr as the above does? */
3082 unsigned long temp[3];
8cf46f62 3083 char *str = get_cell ();
104c1213 3084 int i = 0;
5d502164 3085
104c1213
JM
3086 do
3087 {
3088 temp[i] = addr % (1000 * 1000 * 1000);
3089 addr /= (1000 * 1000 * 1000);
3090 i++;
bb599908 3091 width -= 9;
104c1213
JM
3092 }
3093 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
8cf46f62 3094
bb599908
PH
3095 width += 9;
3096 if (width < 0)
3097 width = 0;
8cf46f62 3098
104c1213
JM
3099 switch (i)
3100 {
3101 case 1:
8cf46f62 3102 xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
104c1213
JM
3103 break;
3104 case 2:
8cf46f62
MK
3105 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
3106 temp[1], temp[0]);
104c1213
JM
3107 break;
3108 case 3:
8cf46f62
MK
3109 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
3110 temp[2], temp[1], temp[0]);
bb599908
PH
3111 break;
3112 default:
3113 internal_error (__FILE__, __LINE__,
e2e0b3e5 3114 _("failed internal consistency check"));
bb599908 3115 }
8cf46f62
MK
3116
3117 return str;
bb599908
PH
3118}
3119
8cf46f62
MK
3120static char *
3121octal2str (ULONGEST addr, int width)
bb599908
PH
3122{
3123 unsigned long temp[3];
8cf46f62 3124 char *str = get_cell ();
bb599908 3125 int i = 0;
5d502164 3126
bb599908
PH
3127 do
3128 {
3129 temp[i] = addr % (0100000 * 0100000);
3130 addr /= (0100000 * 0100000);
3131 i++;
3132 width -= 10;
3133 }
3134 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
8cf46f62 3135
bb599908
PH
3136 width += 10;
3137 if (width < 0)
3138 width = 0;
8cf46f62 3139
bb599908
PH
3140 switch (i)
3141 {
3142 case 1:
3143 if (temp[0] == 0)
8cf46f62 3144 xsnprintf (str, CELLSIZE, "%*o", width, 0);
bb599908 3145 else
8cf46f62 3146 xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
bb599908
PH
3147 break;
3148 case 2:
8cf46f62 3149 xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
bb599908
PH
3150 break;
3151 case 3:
8cf46f62
MK
3152 xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
3153 temp[2], temp[1], temp[0]);
104c1213
JM
3154 break;
3155 default:
8731e58e 3156 internal_error (__FILE__, __LINE__,
e2e0b3e5 3157 _("failed internal consistency check"));
104c1213 3158 }
8cf46f62
MK
3159
3160 return str;
104c1213
JM
3161}
3162
3163char *
623d3eb1 3164pulongest (ULONGEST u)
104c1213 3165{
623d3eb1 3166 return decimal2str ("", u, 0);
104c1213
JM
3167}
3168
3169char *
623d3eb1 3170plongest (LONGEST l)
104c1213 3171{
623d3eb1
DE
3172 if (l < 0)
3173 return decimal2str ("-", -l, 0);
104c1213 3174 else
623d3eb1 3175 return decimal2str ("", l, 0);
104c1213
JM
3176}
3177
8cf46f62 3178/* Eliminate warning from compiler on 32-bit systems. */
5683e87a
AC
3179static int thirty_two = 32;
3180
104c1213 3181char *
5683e87a 3182phex (ULONGEST l, int sizeof_l)
104c1213 3183{
45a1e866 3184 char *str;
8cf46f62 3185
5683e87a 3186 switch (sizeof_l)
104c1213
JM
3187 {
3188 case 8:
45a1e866 3189 str = get_cell ();
8cf46f62
MK
3190 xsnprintf (str, CELLSIZE, "%08lx%08lx",
3191 (unsigned long) (l >> thirty_two),
3192 (unsigned long) (l & 0xffffffff));
104c1213
JM
3193 break;
3194 case 4:
45a1e866 3195 str = get_cell ();
8cf46f62 3196 xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
104c1213
JM
3197 break;
3198 case 2:
45a1e866 3199 str = get_cell ();
8cf46f62 3200 xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
104c1213
JM
3201 break;
3202 default:
45a1e866 3203 str = phex (l, sizeof (l));
5683e87a 3204 break;
104c1213 3205 }
8cf46f62 3206
5683e87a 3207 return str;
104c1213
JM
3208}
3209
c5aa993b 3210char *
5683e87a 3211phex_nz (ULONGEST l, int sizeof_l)
c906108c 3212{
faf833ca 3213 char *str;
8cf46f62 3214
5683e87a 3215 switch (sizeof_l)
c906108c 3216 {
c5aa993b
JM
3217 case 8:
3218 {
5683e87a 3219 unsigned long high = (unsigned long) (l >> thirty_two);
5d502164 3220
faf833ca 3221 str = get_cell ();
c5aa993b 3222 if (high == 0)
8cf46f62
MK
3223 xsnprintf (str, CELLSIZE, "%lx",
3224 (unsigned long) (l & 0xffffffff));
c5aa993b 3225 else
8cf46f62
MK
3226 xsnprintf (str, CELLSIZE, "%lx%08lx", high,
3227 (unsigned long) (l & 0xffffffff));
c906108c 3228 break;
c5aa993b
JM
3229 }
3230 case 4:
faf833ca 3231 str = get_cell ();
8cf46f62 3232 xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
c5aa993b
JM
3233 break;
3234 case 2:
faf833ca 3235 str = get_cell ();
8cf46f62 3236 xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
c5aa993b
JM
3237 break;
3238 default:
faf833ca 3239 str = phex_nz (l, sizeof (l));
5683e87a 3240 break;
c906108c 3241 }
8cf46f62 3242
5683e87a 3243 return str;
c906108c 3244}
ac2e2ef7 3245
0759e0bf
AC
3246/* Converts a LONGEST to a C-format hexadecimal literal and stores it
3247 in a static string. Returns a pointer to this string. */
3248char *
3249hex_string (LONGEST num)
3250{
3251 char *result = get_cell ();
e0627e85 3252
8cf46f62 3253 xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
0759e0bf
AC
3254 return result;
3255}
3256
3257/* Converts a LONGEST number to a C-format hexadecimal literal and
3258 stores it in a static string. Returns a pointer to this string
3259 that is valid until the next call. The number is padded on the
3260 left with 0s to at least WIDTH characters. */
3261char *
3262hex_string_custom (LONGEST num, int width)
3263{
3264 char *result = get_cell ();
3265 char *result_end = result + CELLSIZE - 1;
3266 const char *hex = phex_nz (num, sizeof (num));
3267 int hex_len = strlen (hex);
3268
3269 if (hex_len > width)
3270 width = hex_len;
3271 if (width + 2 >= CELLSIZE)
3272 internal_error (__FILE__, __LINE__,
e2e0b3e5 3273 _("hex_string_custom: insufficient space to store result"));
0759e0bf
AC
3274
3275 strcpy (result_end - width - 2, "0x");
3276 memset (result_end - width, '0', width);
3277 strcpy (result_end - hex_len, hex);
3278 return result_end - width - 2;
3279}
ac2e2ef7 3280
bb599908
PH
3281/* Convert VAL to a numeral in the given radix. For
3282 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3283 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3284 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3285 * to use C format in all cases. If it is false, then 'x'
3286 * and 'o' formats do not include a prefix (0x or leading 0). */
3287
3288char *
3289int_string (LONGEST val, int radix, int is_signed, int width,
3290 int use_c_format)
3291{
3292 switch (radix)
3293 {
3294 case 16:
3295 {
3296 char *result;
5d502164 3297
bb599908
PH
3298 if (width == 0)
3299 result = hex_string (val);
3300 else
3301 result = hex_string_custom (val, width);
3302 if (! use_c_format)
3303 result += 2;
3304 return result;
3305 }
3306 case 10:
3307 {
bb599908 3308 if (is_signed && val < 0)
8cf46f62 3309 return decimal2str ("-", -val, width);
bb599908 3310 else
8cf46f62 3311 return decimal2str ("", val, width);
bb599908
PH
3312 }
3313 case 8:
3314 {
8cf46f62 3315 char *result = octal2str (val, width);
5d502164 3316
bb599908
PH
3317 if (use_c_format || val == 0)
3318 return result;
3319 else
3320 return result + 1;
3321 }
3322 default:
3323 internal_error (__FILE__, __LINE__,
e2e0b3e5 3324 _("failed internal consistency check"));
bb599908
PH
3325 }
3326}
3327
03dd37c3
AC
3328/* Convert a CORE_ADDR into a string. */
3329const char *
3330core_addr_to_string (const CORE_ADDR addr)
49b563f9
KS
3331{
3332 char *str = get_cell ();
e0627e85 3333
49b563f9
KS
3334 strcpy (str, "0x");
3335 strcat (str, phex (addr, sizeof (addr)));
3336 return str;
3337}
3338
3339const char *
3340core_addr_to_string_nz (const CORE_ADDR addr)
03dd37c3
AC
3341{
3342 char *str = get_cell ();
e0627e85 3343
03dd37c3
AC
3344 strcpy (str, "0x");
3345 strcat (str, phex_nz (addr, sizeof (addr)));
3346 return str;
3347}
3348
3349/* Convert a string back into a CORE_ADDR. */
3350CORE_ADDR
3351string_to_core_addr (const char *my_string)
3352{
3353 CORE_ADDR addr = 0;
9544c605 3354
03dd37c3
AC
3355 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3356 {
ced572fe 3357 /* Assume that it is in hex. */
03dd37c3 3358 int i;
5d502164 3359
03dd37c3
AC
3360 for (i = 2; my_string[i] != '\0'; i++)
3361 {
3362 if (isdigit (my_string[i]))
3363 addr = (my_string[i] - '0') + (addr * 16);
8731e58e 3364 else if (isxdigit (my_string[i]))
03dd37c3
AC
3365 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3366 else
63f06803 3367 error (_("invalid hex \"%s\""), my_string);
03dd37c3
AC
3368 }
3369 }
3370 else
3371 {
3372 /* Assume that it is in decimal. */
3373 int i;
5d502164 3374
03dd37c3
AC
3375 for (i = 0; my_string[i] != '\0'; i++)
3376 {
3377 if (isdigit (my_string[i]))
3378 addr = (my_string[i] - '0') + (addr * 10);
3379 else
63f06803 3380 error (_("invalid decimal \"%s\""), my_string);
03dd37c3
AC
3381 }
3382 }
9544c605 3383
03dd37c3
AC
3384 return addr;
3385}
58d370e0 3386
17ea7499
CES
3387const char *
3388host_address_to_string (const void *addr)
3389{
3390 char *str = get_cell ();
ea8992ce 3391
773698b5 3392 xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
17ea7499
CES
3393 return str;
3394}
3395
58d370e0
TT
3396char *
3397gdb_realpath (const char *filename)
3398{
70d35819
AC
3399 /* Method 1: The system has a compile time upper bound on a filename
3400 path. Use that and realpath() to canonicalize the name. This is
3401 the most common case. Note that, if there isn't a compile time
3402 upper bound, you want to avoid realpath() at all costs. */
a4db0f07 3403#if defined(HAVE_REALPATH)
70d35819 3404 {
a4db0f07 3405# if defined (PATH_MAX)
70d35819 3406 char buf[PATH_MAX];
a4db0f07
RH
3407# define USE_REALPATH
3408# elif defined (MAXPATHLEN)
70d35819 3409 char buf[MAXPATHLEN];
a4db0f07
RH
3410# define USE_REALPATH
3411# endif
70d35819 3412# if defined (USE_REALPATH)
82c0260e 3413 const char *rp = realpath (filename, buf);
5d502164 3414
70d35819
AC
3415 if (rp == NULL)
3416 rp = filename;
3417 return xstrdup (rp);
70d35819 3418# endif
6f88d630 3419 }
a4db0f07
RH
3420#endif /* HAVE_REALPATH */
3421
70d35819
AC
3422 /* Method 2: The host system (i.e., GNU) has the function
3423 canonicalize_file_name() which malloc's a chunk of memory and
3424 returns that, use that. */
3425#if defined(HAVE_CANONICALIZE_FILE_NAME)
3426 {
3427 char *rp = canonicalize_file_name (filename);
5d502164 3428
70d35819
AC
3429 if (rp == NULL)
3430 return xstrdup (filename);
3431 else
3432 return rp;
3433 }
58d370e0 3434#endif
70d35819 3435
6411e720
AC
3436 /* FIXME: cagney/2002-11-13:
3437
3438 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3439 to the problems described in in method 3, have modified their
3440 realpath() implementation so that it will allocate a buffer when
3441 NULL is passed in. Before this can be used, though, some sort of
3442 configure time test would need to be added. Otherwize the code
3443 will likely core dump. */
3444
70d35819
AC
3445 /* Method 3: Now we're getting desperate! The system doesn't have a
3446 compile time buffer size and no alternative function. Query the
3447 OS, using pathconf(), for the buffer limit. Care is needed
3448 though, some systems do not limit PATH_MAX (return -1 for
3449 pathconf()) making it impossible to pass a correctly sized buffer
3450 to realpath() (it could always overflow). On those systems, we
3451 skip this. */
3452#if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3453 {
3454 /* Find out the max path size. */
3455 long path_max = pathconf ("/", _PC_PATH_MAX);
5d502164 3456
70d35819
AC
3457 if (path_max > 0)
3458 {
3459 /* PATH_MAX is bounded. */
3460 char *buf = alloca (path_max);
3461 char *rp = realpath (filename, buf);
5d502164 3462
70d35819
AC
3463 return xstrdup (rp ? rp : filename);
3464 }
3465 }
3466#endif
3467
3468 /* This system is a lost cause, just dup the buffer. */
3469 return xstrdup (filename);
58d370e0 3470}
303c8ebd
JB
3471
3472/* Return a copy of FILENAME, with its directory prefix canonicalized
3473 by gdb_realpath. */
3474
3475char *
3476xfullpath (const char *filename)
3477{
3478 const char *base_name = lbasename (filename);
3479 char *dir_name;
3480 char *real_path;
3481 char *result;
3482
3483 /* Extract the basename of filename, and return immediately
3484 a copy of filename if it does not contain any directory prefix. */
3485 if (base_name == filename)
3486 return xstrdup (filename);
3487
3488 dir_name = alloca ((size_t) (base_name - filename + 2));
3489 /* Allocate enough space to store the dir_name + plus one extra
3490 character sometimes needed under Windows (see below), and
3491 then the closing \000 character */
3492 strncpy (dir_name, filename, base_name - filename);
3493 dir_name[base_name - filename] = '\000';
3494
3495#ifdef HAVE_DOS_BASED_FILE_SYSTEM
3496 /* We need to be careful when filename is of the form 'd:foo', which
3497 is equivalent of d:./foo, which is totally different from d:/foo. */
8731e58e 3498 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
303c8ebd
JB
3499 {
3500 dir_name[2] = '.';
3501 dir_name[3] = '\000';
3502 }
3503#endif
3504
3505 /* Canonicalize the directory prefix, and build the resulting
3506 filename. If the dirname realpath already contains an ending
3507 directory separator, avoid doubling it. */
3508 real_path = gdb_realpath (dir_name);
3509 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
c4f7c687 3510 result = concat (real_path, base_name, (char *) NULL);
303c8ebd 3511 else
c4f7c687 3512 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
303c8ebd
JB
3513
3514 xfree (real_path);
3515 return result;
3516}
5b5d99cf
JB
3517
3518
3519/* This is the 32-bit CRC function used by the GNU separate debug
3520 facility. An executable may contain a section named
3521 .gnu_debuglink, which holds the name of a separate executable file
3522 containing its debug info, and a checksum of that file's contents,
3523 computed using this function. */
3524unsigned long
3525gnu_debuglink_crc32 (unsigned long crc, unsigned char *buf, size_t len)
3526{
6e0a4fbc 3527 static const unsigned int crc32_table[256] = {
8731e58e
AC
3528 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
3529 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
3530 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
3531 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
3532 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
3533 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
3534 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
3535 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
3536 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
3537 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
3538 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
3539 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
3540 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
3541 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
3542 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
3543 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
3544 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
3545 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
3546 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
3547 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
3548 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
3549 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
3550 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
3551 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
3552 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
3553 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
3554 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
3555 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
3556 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
3557 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
3558 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
3559 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
3560 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
3561 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
3562 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
3563 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
3564 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
3565 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
3566 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
3567 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
3568 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
3569 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
3570 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
3571 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
3572 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
3573 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
3574 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
3575 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
3576 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
3577 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
3578 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
3579 0x2d02ef8d
3580 };
5b5d99cf
JB
3581 unsigned char *end;
3582
3583 crc = ~crc & 0xffffffff;
3584 for (end = buf + len; buf < end; ++buf)
3585 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
3586 return ~crc & 0xffffffff;;
3587}
5b03f266
AC
3588
3589ULONGEST
3590align_up (ULONGEST v, int n)
3591{
3592 /* Check that N is really a power of two. */
3593 gdb_assert (n && (n & (n-1)) == 0);
3594 return (v + n - 1) & -n;
3595}
3596
3597ULONGEST
3598align_down (ULONGEST v, int n)
3599{
3600 /* Check that N is really a power of two. */
3601 gdb_assert (n && (n & (n-1)) == 0);
3602 return (v & -n);
3603}
ae5a43e0
DJ
3604
3605/* Allocation function for the libiberty hash table which uses an
3606 obstack. The obstack is passed as DATA. */
3607
3608void *
3609hashtab_obstack_allocate (void *data, size_t size, size_t count)
3610{
3611 unsigned int total = size * count;
3612 void *ptr = obstack_alloc ((struct obstack *) data, total);
e0627e85 3613
ae5a43e0
DJ
3614 memset (ptr, 0, total);
3615 return ptr;
3616}
3617
3618/* Trivial deallocation function for the libiberty splay tree and hash
3619 table - don't deallocate anything. Rely on later deletion of the
3620 obstack. DATA will be the obstack, although it is not needed
3621 here. */
3622
3623void
3624dummy_obstack_deallocate (void *object, void *data)
3625{
3626 return;
3627}
253c8abb
DJ
3628
3629/* The bit offset of the highest byte in a ULONGEST, for overflow
3630 checking. */
3631
3632#define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3633
3634/* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3635 where 2 <= BASE <= 36. */
3636
3637static int
3638is_digit_in_base (unsigned char digit, int base)
3639{
3640 if (!isalnum (digit))
3641 return 0;
3642 if (base <= 10)
3643 return (isdigit (digit) && digit < base + '0');
3644 else
3645 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3646}
3647
3648static int
3649digit_to_int (unsigned char c)
3650{
3651 if (isdigit (c))
3652 return c - '0';
3653 else
3654 return tolower (c) - 'a' + 10;
3655}
3656
3657/* As for strtoul, but for ULONGEST results. */
3658
3659ULONGEST
3660strtoulst (const char *num, const char **trailer, int base)
3661{
3662 unsigned int high_part;
3663 ULONGEST result;
3664 int minus = 0;
3665 int i = 0;
3666
3667 /* Skip leading whitespace. */
3668 while (isspace (num[i]))
3669 i++;
3670
3671 /* Handle prefixes. */
3672 if (num[i] == '+')
3673 i++;
3674 else if (num[i] == '-')
3675 {
3676 minus = 1;
3677 i++;
3678 }
3679
3680 if (base == 0 || base == 16)
3681 {
3682 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3683 {
3684 i += 2;
3685 if (base == 0)
3686 base = 16;
3687 }
3688 }
3689
3690 if (base == 0 && num[i] == '0')
3691 base = 8;
3692
3693 if (base == 0)
3694 base = 10;
3695
3696 if (base < 2 || base > 36)
3697 {
3698 errno = EINVAL;
3699 return 0;
3700 }
3701
3702 result = high_part = 0;
3703 for (; is_digit_in_base (num[i], base); i += 1)
3704 {
3705 result = result * base + digit_to_int (num[i]);
3706 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3707 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3708 if (high_part > 0xff)
3709 {
3710 errno = ERANGE;
3711 result = ~ (ULONGEST) 0;
3712 high_part = 0;
3713 minus = 0;
3714 break;
3715 }
3716 }
3717
3718 if (trailer != NULL)
3719 *trailer = &num[i];
3720
3721 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3722 if (minus)
3723 return -result;
3724 else
3725 return result;
3726}
e1024ff1
DJ
3727
3728/* Simple, portable version of dirname that does not modify its
3729 argument. */
3730
3731char *
3732ldirname (const char *filename)
3733{
3734 const char *base = lbasename (filename);
3735 char *dirname;
3736
3737 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3738 --base;
3739
3740 if (base == filename)
3741 return NULL;
3742
3743 dirname = xmalloc (base - filename + 2);
3744 memcpy (dirname, filename, base - filename);
3745
3746 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3747 create "d:./bar" later instead of the (different) "d:/bar". */
3748 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3749 && !IS_DIR_SEPARATOR (filename[0]))
3750 dirname[base++ - filename] = '.';
3751
3752 dirname[base - filename] = '\0';
3753 return dirname;
3754}
d1a41061
PP
3755
3756/* Call libiberty's buildargv, and return the result.
3757 If buildargv fails due to out-of-memory, call nomem.
3758 Therefore, the returned value is guaranteed to be non-NULL,
3759 unless the parameter itself is NULL. */
3760
3761char **
3762gdb_buildargv (const char *s)
3763{
3764 char **argv = buildargv (s);
e0627e85 3765
d1a41061
PP
3766 if (s != NULL && argv == NULL)
3767 nomem (0);
3768 return argv;
3769}
3c16cced 3770
dc146f7c
VP
3771int
3772compare_positive_ints (const void *ap, const void *bp)
3773{
3774 /* Because we know we're comparing two ints which are positive,
3775 there's no danger of overflow here. */
3776 return * (int *) ap - * (int *) bp;
3777}
3778
d18b8b7a
HZ
3779#define AMBIGUOUS_MESS1 ".\nMatching formats:"
3780#define AMBIGUOUS_MESS2 ".\nUse \"set gnutarget format-name\" to specify the format."
3781
3782const char *
3783gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3784{
3785 char *ret, *retp;
3786 int ret_len;
3787 char **p;
3788
3789 /* Check if errmsg just need simple return. */
3790 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3791 return bfd_errmsg (error_tag);
3792
3793 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3794 + strlen (AMBIGUOUS_MESS2);
3795 for (p = matching; *p; p++)
3796 ret_len += strlen (*p) + 1;
3797 ret = xmalloc (ret_len + 1);
3798 retp = ret;
3799 make_cleanup (xfree, ret);
3800
3801 strcpy (retp, bfd_errmsg (error_tag));
3802 retp += strlen (retp);
3803
3804 strcpy (retp, AMBIGUOUS_MESS1);
3805 retp += strlen (retp);
3806
3807 for (p = matching; *p; p++)
3808 {
3809 sprintf (retp, " %s", *p);
3810 retp += strlen (retp);
3811 }
3812 xfree (matching);
3813
3814 strcpy (retp, AMBIGUOUS_MESS2);
3815
3816 return ret;
3817}
3818
74164c56
JK
3819/* Return ARGS parsed as a valid pid, or throw an error. */
3820
3821int
3822parse_pid_to_attach (char *args)
3823{
3824 unsigned long pid;
3825 char *dummy;
3826
3827 if (!args)
3828 error_no_arg (_("process-id to attach"));
3829
3830 dummy = args;
3831 pid = strtoul (args, &dummy, 0);
3832 /* Some targets don't set errno on errors, grrr! */
3833 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3834 error (_("Illegal process-id: %s."), args);
3835
3836 return pid;
3837}
3838
2c0b251b
PA
3839/* Provide a prototype to silence -Wmissing-prototypes. */
3840extern initialize_file_ftype _initialize_utils;
3841
3c16cced
PA
3842void
3843_initialize_utils (void)
3844{
3845 add_internal_problem_command (&internal_error_problem);
3846 add_internal_problem_command (&internal_warning_problem);
3847}
This page took 1.299514 seconds and 4 git commands to generate.