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