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