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