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