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